~bcsaller/juju-gui/update-reductions : revision 6

1

{

2

"project": {

3

"name": "YUI 3",

4

"description": "YUI 3 JavaScript Framework",

5

"version": "3.5.1",

6

"url": "http://yuilibrary.com/"

7

},

8

"files": {

9

"anim/js/anim-color.js": {

10

"name": "anim/js/anim-color.js",

11

"modules": {

12

"anim-color": 1

13

},

14

"classes": {},

15

"fors": {},

16

"namespaces": {}

17

},

18

"anim/js/anim-curve.js": {

19

"name": "anim/js/anim-curve.js",

20

"modules": {

21

"anim-curve": 1

22

},

23

"classes": {},

24

"fors": {

25

"Anim": 1

26

},

27

"namespaces": {}

28

},

29

"anim/js/anim-easing.js": {

30

"name": "anim/js/anim-easing.js",

31

"modules": {},

32

"classes": {

33

"Easing": 1

34

},

35

"fors": {

36

"Easing": 1

37

},

38

"namespaces": {}

39

},

40

"anim/js/anim-node-plugin.js": {

41

"name": "anim/js/anim-node-plugin.js",

42

"modules": {},

43

"classes": {

44

"Plugin.NodeFX": 1

45

},

46

"fors": {},

47

"namespaces": {}

48

},

49

"anim/js/anim-scroll.js": {

50

"name": "anim/js/anim-scroll.js",

51

"modules": {

52

"anim-scroll": 1

53

},

54

"classes": {},

55

"fors": {},

56

"namespaces": {}

57

},

58

"anim/js/anim-shape-transform.js": {

59

"name": "anim/js/anim-shape-transform.js",

60

"modules": {

61

"anim-shape-transform": 1

62

},

63

"classes": {},

64

"fors": {},

65

"namespaces": {}

66

},

67

"anim/js/anim-xy.js": {

68

"name": "anim/js/anim-xy.js",

69

"modules": {

70

"anim-xy": 1

71

},

72

"classes": {},

73

"fors": {},

74

"namespaces": {}

75

},

76

"anim/js/anim.js": {

77

"name": "anim/js/anim.js",

78

"modules": {

79

"anim": 1,

80

"anim-base": 1

81

},

82

"classes": {

83

"Anim": 1

84

},

85

"fors": {

86

"Anim": 1

87

},

88

"namespaces": {}

89

},

90

"app/js/app-extensions/app-transitions-native.js": {

91

"name": "app/js/app-extensions/app-transitions-native.js",

92

"modules": {

93

"app-transitions-native": 1

94

},

95

"classes": {

96

"App.TransitionsNative": 1

97

},

98

"fors": {},

99

"namespaces": {}

100

},

101

"app/js/app-extensions/app-transitions.js": {

102

"name": "app/js/app-extensions/app-transitions.js",

103

"modules": {

104

"app-transitions": 1

105

},

106

"classes": {

107

"App.Transitions": 1

108

},

109

"fors": {},

110

"namespaces": {}

111

},

112

"app/js/view-extensions/view-node-map.js": {

113

"name": "app/js/view-extensions/view-node-map.js",

114

"modules": {

115

"view-node-map": 1

116

},

117

"classes": {

118

"View.NodeMap": 1

119

},

120

"fors": {},

121

"namespaces": {}

122

},

123

"app/js/app-base.js": {

124

"name": "app/js/app-base.js",

125

"modules": {

126

"app": 1,

127

"app-base": 1

128

},

129

"classes": {

130

"App.Base": 1,

131

"App": 1

132

},

133

"fors": {},

134

"namespaces": {}

135

},

136

"app/js/model-list.js": {

137

"name": "app/js/model-list.js",

138

"modules": {

139

"model-list": 1

140

},

141

"classes": {

142

"ModelList": 1

143

},

144

"fors": {},

145

"namespaces": {}

146

},

147

"app/js/model.js": {

148

"name": "app/js/model.js",

149

"modules": {

150

"model": 1

151

},

152

"classes": {

153

"Model": 1

154

},

155

"fors": {},

156

"namespaces": {}

157

},

158

"app/js/router.js": {

159

"name": "app/js/router.js",

160

"modules": {

161

"router": 1

162

},

163

"classes": {

164

"Router": 1,

165

"Controller": 1

166

},

167

"fors": {},

168

"namespaces": {}

169

},

170

"app/js/view.js": {

171

"name": "app/js/view.js",

172

"modules": {

173

"view": 1

174

},

175

"classes": {

176

"View": 1

177

},

178

"fors": {},

179

"namespaces": {}

180

},

181

"arraysort/js/arraysort.js": {

182

"name": "arraysort/js/arraysort.js",

183

"modules": {

184

"arraysort": 1

185

},

186

"classes": {

187

"ArraySort": 1

188

},

189

"fors": {},

190

"namespaces": {}

191

},

192

"async-queue/js/async-queue.js": {

193

"name": "async-queue/js/async-queue.js",

194

"modules": {

195

"async-queue": 1

196

},

197

"classes": {

198

"AsyncQueue": 1

199

},

200

"fors": {},

201

"namespaces": {}

202

},

203

"attribute/js/Attribute.js": {

204

"name": "attribute/js/Attribute.js",

205

"modules": {

206

"attribute": 1,

207

"attribute-base": 1

208

},

209

"classes": {

210

"Attribute": 1

211

},

212

"fors": {},

213

"namespaces": {}

214

},

215

"attribute/js/AttributeCore.js": {

216

"name": "attribute/js/AttributeCore.js",

217

"modules": {

218

"attribute-core": 1

219

},

220

"classes": {

221

"AttributeCore": 1

222

},

223

"fors": {},

224

"namespaces": {}

225

},

226

"attribute/js/AttributeEvents.js": {

227

"name": "attribute/js/AttributeEvents.js",

228

"modules": {

229

"attribute-events": 1

230

},

231

"classes": {

232

"AttributeEvents": 1

233

},

234

"fors": {},

235

"namespaces": {}

236

},

237

"attribute/js/AttributeExtras.js": {

238

"name": "attribute/js/AttributeExtras.js",

239

"modules": {

240

"attribute-extras": 1

241

},

242

"classes": {

243

"AttributeExtras": 1

244

},

245

"fors": {},

246

"namespaces": {}

247

},

248

"attribute/js/ComplexAttribute.js": {

249

"name": "attribute/js/ComplexAttribute.js",

250

"modules": {

251

"attribute-complex": 1

252

},

253

"classes": {},

254

"fors": {

255

"Attribute": 1

256

},

257

"namespaces": {}

258

},

259

"attribute/js/State.js": {

260

"name": "attribute/js/State.js",

261

"modules": {},

262

"classes": {

263

"State": 1

264

},

265

"fors": {},

266

"namespaces": {}

267

},

268

"autocomplete/js/autocomplete-base.js": {

269

"name": "autocomplete/js/autocomplete-base.js",

270

"modules": {

271

"autocomplete": 1,

272

"autocomplete-base": 1

273

},

274

"classes": {

275

"AutoCompleteBase": 1

276

},

277

"fors": {},

278

"namespaces": {}

279

},

280

"autocomplete/js/autocomplete-filters-accentfold.js": {

281

"name": "autocomplete/js/autocomplete-filters-accentfold.js",

282

"modules": {

283

"autocomplete-filters-accentfold": 1

284

},

285

"classes": {},

286

"fors": {},

287

"namespaces": {}

288

},

289

"autocomplete/js/autocomplete-filters.js": {

290

"name": "autocomplete/js/autocomplete-filters.js",

291

"modules": {

292

"autocomplete-filters": 1

293

},

294

"classes": {

295

"AutoCompleteFilters": 1

296

},

297

"fors": {},

298

"namespaces": {}

299

},

300

"autocomplete/js/autocomplete-highlighters-accentfold.js": {

301

"name": "autocomplete/js/autocomplete-highlighters-accentfold.js",

302

"modules": {

303

"autocomplete-highlighters-accentfold": 1

304

},

305

"classes": {},

306

"fors": {},

307

"namespaces": {}

308

},

309

"autocomplete/js/autocomplete-highlighters.js": {

310

"name": "autocomplete/js/autocomplete-highlighters.js",

311

"modules": {

312

"autocomplete-highlighters": 1

313

},

314

"classes": {

315

"AutoCompleteHighlighters": 1

316

},

317

"fors": {},

318

"namespaces": {}

319

},

320

"autocomplete/js/autocomplete-list-keys.js": {

321

"name": "autocomplete/js/autocomplete-list-keys.js",

322

"modules": {

323

"autocomplete-list-keys": 1

324

},

325

"classes": {},

326

"fors": {

327

"AutoCompleteList": 1

328

},

329

"namespaces": {}

330

},

331

"autocomplete/js/autocomplete-list.js": {

332

"name": "autocomplete/js/autocomplete-list.js",

333

"modules": {

334

"autocomplete-list": 1

335

},

336

"classes": {

337

"AutoCompleteList": 1,

338

"AutoComplete": 1

339

},

340

"fors": {},

341

"namespaces": {}

342

},

343

"autocomplete/js/autocomplete-plugin.js": {

344

"name": "autocomplete/js/autocomplete-plugin.js",

345

"modules": {

346

"autocomplete-plugin": 1

347

},

348

"classes": {

349

"Plugin.AutoComplete": 1

350

},

351

"fors": {},

352

"namespaces": {}

353

},

354

"autocomplete/js/autocomplete-sources.js": {

355

"name": "autocomplete/js/autocomplete-sources.js",

356

"modules": {

357

"autocomplete-sources": 1

358

},

359

"classes": {},

360

"fors": {

361

"AutoCompleteBase": 1

362

},

363

"namespaces": {}

364

},

365

"base/js/Base.js": {

366

"name": "base/js/Base.js",

367

"modules": {

368

"base": 1,

369

"base-base": 1

370

},

371

"classes": {

372

"Base": 1

373

},

374

"fors": {},

375

"namespaces": {}

376

},

377

"base/js/BaseBuild.js": {

378

"name": "base/js/BaseBuild.js",

379

"modules": {

380

"base-build": 1

381

},

382

"classes": {},

383

"fors": {

384

"Base": 1

385

},

386

"namespaces": {}

387

},

388

"base/js/BaseCore.js": {

389

"name": "base/js/BaseCore.js",

390

"modules": {

391

"base-core": 1

392

},

393

"classes": {

394

"BaseCore": 1

395

},

396

"fors": {},

397

"namespaces": {}

398

},

399

"base/js/BasePluginHost.js": {

400

"name": "base/js/BasePluginHost.js",

401

"modules": {

402

"base-pluginhost": 1

403

},

404

"classes": {},

405

"fors": {

406

"Base": 1

407

},

408

"namespaces": {}

409

},

410

"button/js/button.js": {

411

"name": "button/js/button.js",

412

"modules": {

413

"button": 1

414

},

415

"classes": {

416

"Button": 1,

417

"ToggleButton": 1

418

},

419

"fors": {},

420

"namespaces": {}

421

},

422

"button/js/core.js": {

423

"name": "button/js/core.js",

424

"modules": {

425

"button-core": 1

426

},

427

"classes": {

428

"ButtonCore": 1

429

},

430

"fors": {},

431

"namespaces": {}

432

},

433

"button/js/group.js": {

434

"name": "button/js/group.js",

435

"modules": {

436

"button-group": 1

437

},

438

"classes": {

439

"ButtonGroup": 1

440

},

441

"fors": {},

442

"namespaces": {}

443

},

444

"button/js/plugin.js": {

445

"name": "button/js/plugin.js",

446

"modules": {

447

"button-plugin": 1

448

},

449

"classes": {

450

"ButtonPlugin": 1

451

},

452

"fors": {},

453

"namespaces": {}

454

},

455

"cache/js/cache-base.js": {

456

"name": "cache/js/cache-base.js",

457

"modules": {

458

"cache": 1,

459

"cache-base": 1

460

},

461

"classes": {

462

"Cache": 1

463

},

464

"fors": {},

465

"namespaces": {}

466

},

467

"cache/js/cache-offline.js": {

468

"name": "cache/js/cache-offline.js",

469

"modules": {

470

"cache-offline": 1

471

},

472

"classes": {

473

"CacheOffline": 1

474

},

475

"fors": {},

476

"namespaces": {}

477

},

478

"cache/js/cache-plugin.js": {

479

"name": "cache/js/cache-plugin.js",

480

"modules": {

481

"cache-plugin": 1

482

},

483

"classes": {

484

"Plugin.Cache": 1

485

},

486

"fors": {},

487

"namespaces": {}

488

},

489

"calendar/js/calendar-base.js": {

490

"name": "calendar/js/calendar-base.js",

491

"modules": {

492

"calendar-base": 1

493

},

494

"classes": {

495

"CalendarBase": 1

496

},

497

"fors": {},

498

"namespaces": {}

499

},

500

"calendar/js/calendar.js": {

501

"name": "calendar/js/calendar.js",

502

"modules": {

503

"calendar": 1

504

},

505

"classes": {

506

"Calendar": 1

507

},

508

"fors": {},

509

"namespaces": {}

510

},

511

"calendar/js/calendarnavigator.js": {

512

"name": "calendar/js/calendarnavigator.js",

513

"modules": {

514

"calendarnavigator": 1

515

},

516

"classes": {

517

"Plugin.CalendarNavigator": 1

518

},

519

"fors": {},

520

"namespaces": {

521

"Plugin": 1

522

}

523

},

524

"charts/js/AreaSeries.js": {

525

"name": "charts/js/AreaSeries.js",

526

"modules": {},

527

"classes": {

528

"AreaSeries": 1

529

},

530

"fors": {},

531

"namespaces": {}

532

},

533

"charts/js/AreaSplineSeries.js": {

534

"name": "charts/js/AreaSplineSeries.js",

535

"modules": {},

536

"classes": {

537

"AreaSplineSeries": 1

538

},

539

"fors": {},

540

"namespaces": {}

541

},

542

"charts/js/Axis.js": {

543

"name": "charts/js/Axis.js",

544

"modules": {},

545

"classes": {

546

"Axis": 1

547

},

548

"fors": {},

549

"namespaces": {}

550

},

551

"charts/js/AxisType.js": {

552

"name": "charts/js/AxisType.js",

553

"modules": {},

554

"classes": {

555

"AxisType": 1

556

},

557

"fors": {},

558

"namespaces": {}

559

},

560

"charts/js/BarSeries.js": {

561

"name": "charts/js/BarSeries.js",

562

"modules": {},

563

"classes": {

564

"BarSeries": 1

565

},

566

"fors": {},

567

"namespaces": {}

568

},

569

"charts/js/BottomAxisLayout.js": {

570

"name": "charts/js/BottomAxisLayout.js",

571

"modules": {},

572

"classes": {

573

"BottomAxisLayout": 1

574

},

575

"fors": {},

576

"namespaces": {}

577

},

578

"charts/js/CartesianChart.js": {

579

"name": "charts/js/CartesianChart.js",

580

"modules": {},

581

"classes": {

582

"CartesianChart": 1

583

},

584

"fors": {},

585

"namespaces": {}

586

},

587

"charts/js/CartesianChartLegend.js": {

588

"name": "charts/js/CartesianChartLegend.js",

589

"modules": {

590

"charts-legend": 1

591

},

592

"classes": {

593

"HorizontalLegendLayout": 1,

594

"VerticalLegendLayout": 1

595

},

596

"fors": {},

597

"namespaces": {}

598

},

599

"charts/js/CartesianSeries.js": {

600

"name": "charts/js/CartesianSeries.js",

601

"modules": {},

602

"classes": {

603

"CartesianSeries": 1

604

},

605

"fors": {},

606

"namespaces": {}

607

},

608

"charts/js/CategoryAxis.js": {

609

"name": "charts/js/CategoryAxis.js",

610

"modules": {},

611

"classes": {

612

"CategoryAxis": 1

613

},

614

"fors": {},

615

"namespaces": {}

616

},

617

"charts/js/Chart.js": {

618

"name": "charts/js/Chart.js",

619

"modules": {},

620

"classes": {

621

"Chart": 1

622

},

623

"fors": {},

624

"namespaces": {}

625

},

626

"charts/js/ChartBase.js": {

627

"name": "charts/js/ChartBase.js",

628

"modules": {},

629

"classes": {

630

"ChartBase": 1

631

},

632

"fors": {},

633

"namespaces": {}

634

},

635

"charts/js/ChartLegend.js": {

636

"name": "charts/js/ChartLegend.js",

637

"modules": {},

638

"classes": {

639

"ChartLegend": 1

640

},

641

"fors": {},

642

"namespaces": {}

643

},

644

"charts/js/CircleGroup.js": {

645

"name": "charts/js/CircleGroup.js",

646

"modules": {},

647

"classes": {

648

"GroupCircle": 1

649

},

650

"fors": {},

651

"namespaces": {}

652

},

653

"charts/js/ColumnSeries.js": {

654

"name": "charts/js/ColumnSeries.js",

655

"modules": {},

656

"classes": {

657

"ColumnSeries": 1

658

},

659

"fors": {},

660

"namespaces": {}

661

},

662

"charts/js/ComboSeries.js": {

663

"name": "charts/js/ComboSeries.js",

664

"modules": {},

665

"classes": {

666

"ComboSeries": 1

667

},

668

"fors": {},

669

"namespaces": {}

670

},

671

"charts/js/ComboSplineSeries.js": {

672

"name": "charts/js/ComboSplineSeries.js",

673

"modules": {},

674

"classes": {

675

"ComboSplineSeries": 1

676

},

677

"fors": {},

678

"namespaces": {}

679

},

680

"charts/js/CurveUtil.js": {

681

"name": "charts/js/CurveUtil.js",

682

"modules": {},

683

"classes": {

684

"CurveUtil": 1

685

},

686

"fors": {},

687

"namespaces": {}

688

},

689

"charts/js/DiamondGroup.js": {

690

"name": "charts/js/DiamondGroup.js",

691

"modules": {},

692

"classes": {

693

"GroupDiamond": 1

694

},

695

"fors": {},

696

"namespaces": {}

697

},

698

"charts/js/EllipseGroup.js": {

699

"name": "charts/js/EllipseGroup.js",

700

"modules": {},

701

"classes": {

702

"EllipseGroup": 1

703

},

704

"fors": {},

705

"namespaces": {}

706

},

707

"charts/js/Fills.js": {

708

"name": "charts/js/Fills.js",

709

"modules": {},

710

"classes": {

711

"Fills": 1

712

},

713

"fors": {},

714

"namespaces": {}

715

},

716

"charts/js/Graph.js": {

717

"name": "charts/js/Graph.js",

718

"modules": {},

719

"classes": {

720

"Graph": 1

721

},

722

"fors": {},

723

"namespaces": {}

724

},

725

"charts/js/Gridlines.js": {

726

"name": "charts/js/Gridlines.js",

727

"modules": {},

728

"classes": {

729

"Gridlines": 1

730

},

731

"fors": {},

732

"namespaces": {}

733

},

734

"charts/js/Histogram.js": {

735

"name": "charts/js/Histogram.js",

736

"modules": {},

737

"classes": {

738

"Histogram": 1

739

},

740

"fors": {},

741

"namespaces": {}

742

},

743

"charts/js/LeftAxisLayout.js": {

744

"name": "charts/js/LeftAxisLayout.js",

745

"modules": {},

746

"classes": {

747

"LeftAxisLayout": 1

748

},

749

"fors": {},

750

"namespaces": {}

751

},

752

"charts/js/LineSeries.js": {

753

"name": "charts/js/LineSeries.js",

754

"modules": {},

755

"classes": {

756

"LineSeries": 1

757

},

758

"fors": {},

759

"namespaces": {}

760

},

761

"charts/js/Lines.js": {

762

"name": "charts/js/Lines.js",

763

"modules": {},

764

"classes": {

765

"Lines": 1

766

},

767

"fors": {},

768

"namespaces": {}

769

},

770

"charts/js/MarkerSeries.js": {

771

"name": "charts/js/MarkerSeries.js",

772

"modules": {},

773

"classes": {

774

"MarkerSeries": 1

775

},

776

"fors": {},

777

"namespaces": {}

778

},

779

"charts/js/NumericAxis.js": {

780

"name": "charts/js/NumericAxis.js",

781

"modules": {},

782

"classes": {

783

"NumericAxis": 1

784

},

785

"fors": {},

786

"namespaces": {}

787

},

788

"charts/js/PieChart.js": {

789

"name": "charts/js/PieChart.js",

790

"modules": {},

791

"classes": {

792

"PieChart": 1

793

},

794

"fors": {},

795

"namespaces": {}

796

},

797

"charts/js/PieChartLegend.js": {

798

"name": "charts/js/PieChartLegend.js",

799

"modules": {},

800

"classes": {},

801

"fors": {},

802

"namespaces": {}

803

},

804

"charts/js/PieSeries.js": {

805

"name": "charts/js/PieSeries.js",

806

"modules": {},

807

"classes": {

808

"PieSeries": 1

809

},

810

"fors": {},

811

"namespaces": {}

812

},

813

"charts/js/Plots.js": {

814

"name": "charts/js/Plots.js",

815

"modules": {},

816

"classes": {

817

"Plots": 1

818

},

819

"fors": {},

820

"namespaces": {}

821

},

822

"charts/js/RectGroup.js": {

823

"name": "charts/js/RectGroup.js",

824

"modules": {},

825

"classes": {

826

"GroupRect": 1

827

},

828

"fors": {},

829

"namespaces": {}

830

},

831

"charts/js/Renderer.js": {

832

"name": "charts/js/Renderer.js",

833

"modules": {},

834

"classes": {

835

"Renderer": 1

836

},

837

"fors": {},

838

"namespaces": {}

839

},

840

"charts/js/RightAxisLayout.js": {

841

"name": "charts/js/RightAxisLayout.js",

842

"modules": {},

843

"classes": {

844

"RightAxisLayout": 1

845

},

846

"fors": {},

847

"namespaces": {}

848

},

849

"charts/js/ShapeGroup.js": {

850

"name": "charts/js/ShapeGroup.js",

851

"modules": {

852

"charts": 1

853

},

854

"classes": {

855

"ShapeGroup": 1

856

},

857

"fors": {},

858

"namespaces": {}

859

},

860

"charts/js/SplineSeries.js": {

861

"name": "charts/js/SplineSeries.js",

862

"modules": {},

863

"classes": {

864

"SplineSeries": 1

865

},

866

"fors": {},

867

"namespaces": {}

868

},

869

"charts/js/StackedAreaSeries.js": {

870

"name": "charts/js/StackedAreaSeries.js",

871

"modules": {},

872

"classes": {

873

"StackedAreaSeries": 1

874

},

875

"fors": {},

876

"namespaces": {}

877

},

878

"charts/js/StackedAreaSplineSeries.js": {

879

"name": "charts/js/StackedAreaSplineSeries.js",

880

"modules": {},

881

"classes": {

882

"StackedAreaSplineSeries": 1

883

},

884

"fors": {},

885

"namespaces": {}

886

},

887

"charts/js/StackedAxis.js": {

888

"name": "charts/js/StackedAxis.js",

889

"modules": {},

890

"classes": {

891

"StackedAxis": 1

892

},

893

"fors": {},

894

"namespaces": {}

895

},

896

"charts/js/StackedBarSeries.js": {

897

"name": "charts/js/StackedBarSeries.js",

898

"modules": {},

899

"classes": {

900

"StackedBarSeries": 1

901

},

902

"fors": {},

903

"namespaces": {}

904

},

905

"charts/js/StackedColumnSeries.js": {

906

"name": "charts/js/StackedColumnSeries.js",

907

"modules": {},

908

"classes": {

909

"StackedColumnSeries": 1

910

},

911

"fors": {},

912

"namespaces": {}

913

},

914

"charts/js/StackedComboSeries.js": {

915

"name": "charts/js/StackedComboSeries.js",

916

"modules": {},

917

"classes": {

918

"StackedComboSeries": 1

919

},

920

"fors": {},

921

"namespaces": {}

922

},

923

"charts/js/StackedComboSplineSeries.js": {

924

"name": "charts/js/StackedComboSplineSeries.js",

925

"modules": {},

926

"classes": {

927

"StackedComboSplineSeries": 1

928

},

929

"fors": {},

930

"namespaces": {}

931

},

932

"charts/js/StackedLineSeries.js": {

933

"name": "charts/js/StackedLineSeries.js",

934

"modules": {},

935

"classes": {

936

"StackedLineSeries": 1

937

},

938

"fors": {},

939

"namespaces": {}

940

},

941

"charts/js/StackedMarkerSeries.js": {

942

"name": "charts/js/StackedMarkerSeries.js",

943

"modules": {},

944

"classes": {

945

"StackedMarkerSeries": 1

946

},

947

"fors": {},

948

"namespaces": {}

949

},

950

"charts/js/StackedSplineSeries.js": {

951

"name": "charts/js/StackedSplineSeries.js",

952

"modules": {},

953

"classes": {

954

"StackedSplineSeries": 1

955

},

956

"fors": {},

957

"namespaces": {}

958

},

959

"charts/js/StackingUtil.js": {

960

"name": "charts/js/StackingUtil.js",

961

"modules": {},

962

"classes": {

963

"StackingUtil": 1

964

},

965

"fors": {},

966

"namespaces": {}

967

},

968

"charts/js/TimeAxis.js": {

969

"name": "charts/js/TimeAxis.js",

970

"modules": {},

971

"classes": {

972

"TimeAxis": 1

973

},

974

"fors": {},

975

"namespaces": {}

976

},

977

"charts/js/TopAxisLayout.js": {

978

"name": "charts/js/TopAxisLayout.js",

979

"modules": {},

980

"classes": {

981

"TopAxisLayout": 1

982

},

983

"fors": {},

984

"namespaces": {}

985

},

986

"classnamemanager/js/classnamemanager.js": {

987

"name": "classnamemanager/js/classnamemanager.js",

988

"modules": {

989

"classnamemanager": 1

990

},

991

"classes": {

992

"ClassNameManager": 1

993

},

994

"fors": {},

995

"namespaces": {}

996

},

997

"collection/js/array-extras.js": {

998

"name": "collection/js/array-extras.js",

999

"modules": {

1000

"array-extras": 1

1001

},

1002

"classes": {},

1003

"fors": {

1004

"Array": 1

1005

},

1006

"namespaces": {}

1007

},

1008

"collection/js/arraylist-add.js": {

1009

"name": "collection/js/arraylist-add.js",

1010

"modules": {

1011

"arraylist-add": 1

1012

},

1013

"classes": {},

1014

"fors": {

1015

"ArrayList": 1

1016

},

1017

"namespaces": {}

1018

},

1019

"collection/js/arraylist-filter.js": {

1020

"name": "collection/js/arraylist-filter.js",

1021

"modules": {

1022

"arraylist-filter": 1

1023

},

1024

"classes": {},

1025

"fors": {

1026

"ArrayList": 1

1027

},

1028

"namespaces": {}

1029

},

1030

"collection/js/arraylist.js": {

1031

"name": "collection/js/arraylist.js",

1032

"modules": {

1033

"arraylist": 1

1034

},

1035

"classes": {

1036

"ArrayList": 1

1037

},

1038

"fors": {},

1039

"namespaces": {}

1040

},

1041

"collection/js/invoke.js": {

1042

"name": "collection/js/invoke.js",

1043

"modules": {

1044

"array-invoke": 1

1045

},

1046

"classes": {},

1047

"fors": {

1048

"Array": 1

1049

},

1050

"namespaces": {}

1051

},

1052

"console-filters/js/console-filters.js": {

1053

"name": "console-filters/js/console-filters.js",

1054

"modules": {

1055

"console-filters": 1

1056

},

1057

"classes": {

1058

"Plugin.ConsoleFilters": 1

1059

},

1060

"fors": {},

1061

"namespaces": {

1062

"Plugin": 1

1063

}

1064

},

1065

"console/js/console.js": {

1066

"name": "console/js/console.js",

1067

"modules": {

1068

"console": 1

1069

},

1070

"classes": {

1071

"Console": 1

1072

},

1073

"fors": {},

1074

"namespaces": {}

1075

},

1076

"cookie/js/Cookie.js": {

1077

"name": "cookie/js/Cookie.js",

1078

"modules": {

1079

"cookie": 1

1080

},

1081

"classes": {

1082

"Cookie": 1

1083

},

1084

"fors": {},

1085

"namespaces": {}

1086

},

1087

"dataschema/js/dataschema-array.js": {

1088

"name": "dataschema/js/dataschema-array.js",

1089

"modules": {

1090

"dataschema-array": 1

1091

},

1092

"classes": {

1093

"DataSchema.Array": 1

1094

},

1095

"fors": {},

1096

"namespaces": {}

1097

},

1098

"dataschema/js/dataschema-base.js": {

1099

"name": "dataschema/js/dataschema-base.js",

1100

"modules": {

1101

"dataschema": 1,

1102

"dataschema-base": 1

1103

},

1104

"classes": {

1105

"DataSchema.Base": 1

1106

},

1107

"fors": {},

1108

"namespaces": {}

1109

},

1110

"dataschema/js/dataschema-json.js": {

1111

"name": "dataschema/js/dataschema-json.js",

1112

"modules": {

1113

"dataschema-json": 1

1114

},

1115

"classes": {

1116

"DataSchema.JSON": 1

1117

},

1118

"fors": {},

1119

"namespaces": {}

1120

},

1121

"dataschema/js/dataschema-text.js": {

1122

"name": "dataschema/js/dataschema-text.js",

1123

"modules": {

1124

"dataschema-text": 1

1125

},

1126

"classes": {

1127

"DataSchema.Text": 1

1128

},

1129

"fors": {},

1130

"namespaces": {}

1131

},

1132

"dataschema/js/dataschema-xml.js": {

1133

"name": "dataschema/js/dataschema-xml.js",

1134

"modules": {

1135

"dataschema-xml": 1

1136

},

1137

"classes": {

1138

"DataSchema.XML": 1

1139

},

1140

"fors": {},

1141

"namespaces": {}

1142

},

1143

"datasource/js/datasource-arrayschema.js": {

1144

"name": "datasource/js/datasource-arrayschema.js",

1145

"modules": {

1146

"datasource-arrayschema": 1

1147

},

1148

"classes": {

1149

"DataSourceArraySchema": 1

1150

},

1151

"fors": {},

1152

"namespaces": {}

1153

},

1154

"datasource/js/datasource-cache.js": {

1155

"name": "datasource/js/datasource-cache.js",

1156

"modules": {

1157

"datasource-cache": 1

1158

},

1159

"classes": {

1160

"DataSourceCacheExtension": 1,

1161

"DataSourceCache": 1

1162

},

1163

"fors": {},

1164

"namespaces": {}

1165

},

1166

"datasource/js/datasource-function.js": {

1167

"name": "datasource/js/datasource-function.js",

1168

"modules": {

1169

"datasource-function": 1

1170

},

1171

"classes": {

1172

"DataSource.Function": 1

1173

},

1174

"fors": {},

1175

"namespaces": {}

1176

},

1177

"datasource/js/datasource-get.js": {

1178

"name": "datasource/js/datasource-get.js",

1179

"modules": {

1180

"datasource-get": 1

1181

},

1182

"classes": {

1183

"DataSource.Get": 1

1184

},

1185

"fors": {},

1186

"namespaces": {}

1187

},

1188

"datasource/js/datasource-io.js": {

1189

"name": "datasource/js/datasource-io.js",

1190

"modules": {

1191

"datasource-io": 1

1192

},

1193

"classes": {

1194

"DataSource.IO": 1

1195

},

1196

"fors": {},

1197

"namespaces": {}

1198

},

1199

"datasource/js/datasource-jsonschema.js": {

1200

"name": "datasource/js/datasource-jsonschema.js",

1201

"modules": {

1202

"datasource-jsonschema": 1

1203

},

1204

"classes": {

1205

"DataSourceJSONSchema": 1

1206

},

1207

"fors": {},

1208

"namespaces": {}

1209

},

1210

"datasource/js/datasource-local.js": {

1211

"name": "datasource/js/datasource-local.js",

1212

"modules": {

1213

"datasource": 1,

1214

"datasource-local": 1

1215

},

1216

"classes": {

1217

"DataSource.Local": 1

1218

},

1219

"fors": {},

1220

"namespaces": {}

1221

},

1222

"datasource/js/datasource-polling.js": {

1223

"name": "datasource/js/datasource-polling.js",

1224

"modules": {

1225

"datasource-polling": 1

1226

},

1227

"classes": {

1228

"Pollable": 1

1229

},

1230

"fors": {},

1231

"namespaces": {}

1232

},

1233

"datasource/js/datasource-textschema.js": {

1234

"name": "datasource/js/datasource-textschema.js",

1235

"modules": {

1236

"datasource-textschema": 1

1237

},

1238

"classes": {

1239

"DataSourceTextSchema": 1

1240

},

1241

"fors": {},

1242

"namespaces": {}

1243

},

1244

"datasource/js/datasource-xmlschema.js": {

1245

"name": "datasource/js/datasource-xmlschema.js",

1246

"modules": {

1247

"datasource-xmlschema": 1

1248

},

1249

"classes": {

1250

"DataSourceXMLSchema": 1

1251

},

1252

"fors": {},

1253

"namespaces": {}

1254

},

1255

"datatable-deprecated/js/datatable-base.js": {

1256

"name": "datatable-deprecated/js/datatable-base.js",

1257

"modules": {

1258

"datatable-deprecated": 1,

1259

"datatable-base-deprecated": 1

1260

},

1261

"classes": {},

1262

"fors": {},

1263

"namespaces": {}

1264

},

1265

"datatable-deprecated/js/datatable-datasource.js": {

1266

"name": "datatable-deprecated/js/datatable-datasource.js",

1267

"modules": {

1268

"datatable-datasource-deprecated": 1

1269

},

1270

"classes": {},

1271

"fors": {},

1272

"namespaces": {}

1273

},

1274

"datatable-deprecated/js/datatable-scroll.js": {

1275

"name": "datatable-deprecated/js/datatable-scroll.js",

1276

"modules": {

1277

"datatable-scroll-deprecated": 1

1278

},

1279

"classes": {},

1280

"fors": {},

1281

"namespaces": {}

1282

},

1283

"datatable-deprecated/js/datatable-sort.js": {

1284

"name": "datatable-deprecated/js/datatable-sort.js",

1285

"modules": {

1286

"datatable-sort-deprecated": 1

1287

},

1288

"classes": {},

1289

"fors": {},

1290

"namespaces": {}

1291

},

1292

"datatable/js/base.js": {

1293

"name": "datatable/js/base.js",

1294

"modules": {

1295

"datatable": 1,

1296

"datatable-base": 1

1297

},

1298

"classes": {

1299

"DataTable": 1,

1300

"DataTable.Base": 1

1301

},

1302

"fors": {},

1303

"namespaces": {

1304

"DataTable": 1

1305

}

1306

},

1307

"datatable/js/body.js": {

1308

"name": "datatable/js/body.js",

1309

"modules": {

1310

"datatable-body": 1

1311

},

1312

"classes": {

1313

"DataTable.BodyView": 1

1314

},

1315

"fors": {},

1316

"namespaces": {

1317

"DataTable": 1

1318

}

1319

},

1320

"datatable/js/colwidths.js": {

1321

"name": "datatable/js/colwidths.js",

1322

"modules": {

1323

"datatable-column-widths": 1

1324

},

1325

"classes": {

1326

"DataTable.ColumnWidths": 1

1327

},

1328

"fors": {

1329

"DataTable": 1

1330

},

1331

"namespaces": {}

1332

},

1333

"datatable/js/core.js": {

1334

"name": "datatable/js/core.js",

1335

"modules": {

1336

"datatable-core": 1

1337

},

1338

"classes": {

1339

"DataTable.Core": 1

1340

},

1341

"fors": {

1342

"DataTable": 1

1343

},

1344

"namespaces": {}

1345

},

1346

"datatable/js/datatable-datasource.js": {

1347

"name": "datatable/js/datatable-datasource.js",

1348

"modules": {

1349

"datatable-datasource": 1

1350

},

1351

"classes": {

1352

"Plugin.DataTableDataSource": 1

1353

},

1354

"fors": {},

1355

"namespaces": {}

1356

},

1357

"datatable/js/head.js": {

1358

"name": "datatable/js/head.js",

1359

"modules": {

1360

"datatable-head": 1

1361

},

1362

"classes": {

1363

"DataTable.HeaderView": 1

1364

},

1365

"fors": {},

1366

"namespaces": {

1367

"DataTable": 1

1368

}

1369

},

1370

"datatable/js/message.js": {

1371

"name": "datatable/js/message.js",

1372

"modules": {

1373

"datatable-message": 1

1374

},

1375

"classes": {

1376

"DataTable.Message": 1

1377

},

1378

"fors": {

1379

"DataTable": 1

1380

},

1381

"namespaces": {}

1382

},

1383

"datatable/js/mutable.js": {

1384

"name": "datatable/js/mutable.js",

1385

"modules": {

1386

"datatable-mutable": 1

1387

},

1388

"classes": {

1389

"DataTable.Mutable": 1

1390

},

1391

"fors": {

1392

"DataTable": 1

1393

},

1394

"namespaces": {}

1395

},

1396

"datatable/js/scroll.js": {

1397

"name": "datatable/js/scroll.js",

1398

"modules": {

1399

"datatable-scroll": 1

1400

},

1401

"classes": {

1402

"DataTable.Scrollable": 1

1403

},

1404

"fors": {

1405

"DataTable": 1

1406

},

1407

"namespaces": {}

1408

},

1409

"datatable/js/sort.js": {

1410

"name": "datatable/js/sort.js",

1411

"modules": {

1412

"datatable-sort": 1

1413

},

1414

"classes": {

1415

"DataTable.Sortable": 1

1416

},

1417

"fors": {

1418

"DataTable": 1

1419

},

1420

"namespaces": {}

1421

},

1422

"datatype/js/datatype-date-format.js": {

1423

"name": "datatype/js/datatype-date-format.js",

1424

"modules": {

1425

"datatype": 1,

1426

"datatype-date": 1,

1427

"datatype-date-format": 1

1428

},

1429

"classes": {

1430

"DataType.Date": 1

1431

},

1432

"fors": {

1433

"DataType.Date": 1

1434

},

1435

"namespaces": {}

1436

},

1437

"datatype/js/datatype-date-locale.js": {

1438

"name": "datatype/js/datatype-date-locale.js",

1439

"modules": {},

1440

"classes": {

1441

"DataType.Date.Locale": 1

1442

},

1443

"fors": {},

1444

"namespaces": {}

1445

},

1446

"datatype/js/datatype-date-math.js": {

1447

"name": "datatype/js/datatype-date-math.js",

1448

"modules": {

1449

"datatype-date-math": 1

1450

},

1451

"classes": {},

1452

"fors": {

1453

"DataType.Date": 1

1454

},

1455

"namespaces": {}

1456

},

1457

"datatype/js/datatype-date-parse.js": {

1458

"name": "datatype/js/datatype-date-parse.js",

1459

"modules": {

1460

"datatype-date-parse": 1

1461

},

1462

"classes": {},

1463

"fors": {

1464

"DataType.Date": 1

1465

},

1466

"namespaces": {}

1467

},

1468

"datatype/js/datatype-number-format.js": {

1469

"name": "datatype/js/datatype-number-format.js",

1470

"modules": {

1471

"datatype-number": 1,

1472

"datatype-number-format": 1

1473

},

1474

"classes": {

1475

"DataType.Number": 1

1476

},

1477

"fors": {},

1478

"namespaces": {}

1479

},

1480

"datatype/js/datatype-number-parse.js": {

1481

"name": "datatype/js/datatype-number-parse.js",

1482

"modules": {

1483

"datatype-number-parse": 1

1484

},

1485

"classes": {},

1486

"fors": {

1487

"DataType.Number": 1

1488

},

1489

"namespaces": {}

1490

},

1491

"datatype/js/datatype-xml-format.js": {

1492

"name": "datatype/js/datatype-xml-format.js",

1493

"modules": {

1494

"datatype-xml-format": 1,

1495

"datatype-xml": 1

1496

},

1497

"classes": {

1498

"DataType.XML": 1

1499

},

1500

"fors": {},

1501

"namespaces": {}

1502

},

1503

"datatype/js/datatype-xml-parse.js": {

1504

"name": "datatype/js/datatype-xml-parse.js",

1505

"modules": {

1506

"datatype-xml-parse": 1

1507

},

1508

"classes": {},

1509

"fors": {

1510

"DataType.XML": 1

1511

},

1512

"namespaces": {}

1513

},

1514

"dd/js/constrain.js": {

1515

"name": "dd/js/constrain.js",

1516

"modules": {

1517

"dd": 1,

1518

"dd-constrain": 1

1519

},

1520

"classes": {

1521

"Plugin.DDConstrained": 1

1522

},

1523

"fors": {

1524

"DDM": 1,

1525

"DD.DDM": 1

1526

},

1527

"namespaces": {

1528

"Plugin": 1,

1529

"DD": 1

1530

}

1531

},

1532

"dd/js/dd-drop-plugin.js": {

1533

"name": "dd/js/dd-drop-plugin.js",

1534

"modules": {

1535

"dd-drop-plugin": 1

1536

},

1537

"classes": {

1538

"Plugin.Drop": 1

1539

},

1540

"fors": {},

1541

"namespaces": {

1542

"Plugin": 1

1543

}

1544

},

1545

"dd/js/dd-plugin.js": {

1546

"name": "dd/js/dd-plugin.js",

1547

"modules": {

1548

"dd-plugin": 1

1549

},

1550

"classes": {

1551

"Plugin.Drag": 1

1552

},

1553

"fors": {},

1554

"namespaces": {

1555

"Plugin": 1

1556

}

1557

},

1558

"dd/js/ddm-base.js": {

1559

"name": "dd/js/ddm-base.js",

1560

"modules": {

1561

"dd-ddm-base": 1

1562

},

1563

"classes": {

1564

"DD.DDM": 1

1565

},

1566

"fors": {},

1567

"namespaces": {

1568

"DD": 1

1569

}

1570

},

1571

"dd/js/ddm-drop.js": {

1572

"name": "dd/js/ddm-drop.js",

1573

"modules": {

1574

"dd-ddm-drop": 1

1575

},

1576

"classes": {},

1577

"fors": {

1578

"DD.DDM": 1

1579

},

1580

"namespaces": {

1581

"DD": 1

1582

}

1583

},

1584

"dd/js/ddm.js": {

1585

"name": "dd/js/ddm.js",

1586

"modules": {

1587

"dd-ddm": 1

1588

},

1589

"classes": {},

1590

"fors": {

1591

"DD.DDM": 1

1592

},

1593

"namespaces": {

1594

"DD": 1

1595

}

1596

},

1597

"dd/js/delegate.js": {

1598

"name": "dd/js/delegate.js",

1599

"modules": {

1600

"dd-delegate": 1

1601

},

1602

"classes": {

1603

"DD.Delegate": 1

1604

},

1605

"fors": {

1606

"DD.DDM": 1

1607

},

1608

"namespaces": {

1609

"DD": 1

1610

}

1611

},

1612

"dd/js/drag.js": {

1613

"name": "dd/js/drag.js",

1614

"modules": {

1615

"dd-drag": 1

1616

},

1617

"classes": {

1618

"DD.Drag": 1

1619

},

1620

"fors": {},

1621

"namespaces": {

1622

"DD": 1

1623

}

1624

},

1625

"dd/js/drop.js": {

1626

"name": "dd/js/drop.js",

1627

"modules": {

1628

"dd-drop": 1

1629

},

1630

"classes": {

1631

"DD.Drop": 1

1632

},

1633

"fors": {},

1634

"namespaces": {

1635

"DD": 1

1636

}

1637

},

1638

"dd/js/proxy.js": {

1639

"name": "dd/js/proxy.js",

1640

"modules": {

1641

"dd-proxy": 1

1642

},

1643

"classes": {

1644

"Plugin.DDProxy": 1

1645

},

1646

"fors": {

1647

"DD.DDM": 1

1648

},

1649

"namespaces": {

1650

"Plugin": 1,

1651

"DD": 1

1652

}

1653

},

1654

"dd/js/scroll.js": {

1655

"name": "dd/js/scroll.js",

1656

"modules": {

1657

"dd-scroll": 1

1658

},

1659

"classes": {

1660

"DD.Scroll": 1,

1661

"Plugin.DDWindowScroll": 1,

1662

"Plugin.DDNodeScroll": 1

1663

},

1664

"fors": {},

1665

"namespaces": {

1666

"DD": 1,

1667

"Plugin": 1

1668

}

1669

},

1670

"dial/js/Dial.js": {

1671

"name": "dial/js/Dial.js",

1672

"modules": {

1673

"dial": 1

1674

},

1675

"classes": {

1676

"Dial": 1

1677

},

1678

"fors": {},

1679

"namespaces": {}

1680

},

1681

"dom/js/dom-attrs.js": {

1682

"name": "dom/js/dom-attrs.js",

1683

"modules": {},

1684

"classes": {},

1685

"fors": {

1686

"DOM": 1

1687

},

1688

"namespaces": {}

1689

},

1690

"dom/js/dom-class.js": {

1691

"name": "dom/js/dom-class.js",

1692

"modules": {},

1693

"classes": {},

1694

"fors": {

1695

"DOM": 1

1696

},

1697

"namespaces": {}

1698

},

1699

"dom/js/dom-core.js": {

1700

"name": "dom/js/dom-core.js",

1701

"modules": {

1702

"dom": 1,

1703

"dom-base": 1

1704

},

1705

"classes": {

1706

"DOM": 1

1707

},

1708

"fors": {

1709

"DOM": 1

1710

},

1711

"namespaces": {}

1712

},

1713

"dom/js/dom-create.js": {

1714

"name": "dom/js/dom-create.js",

1715

"modules": {},

1716

"classes": {},

1717

"fors": {},

1718

"namespaces": {}

1719

},

1720

"dom/js/dom-region.js": {

1721

"name": "dom/js/dom-region.js",

1722

"modules": {},

1723

"classes": {},

1724

"fors": {

1725

"DOM": 1

1726

},

1727

"namespaces": {}

1728

},

1729

"dom/js/dom-screen.js": {

1730

"name": "dom/js/dom-screen.js",

1731

"modules": {

1732

"dom-screen": 1

1733

},

1734

"classes": {},

1735

"fors": {

1736

"DOM": 1

1737

},

1738

"namespaces": {}

1739

},

1740

"dom/js/dom-size.js": {

1741

"name": "dom/js/dom-size.js",

1742

"modules": {},

1743

"classes": {},

1744

"fors": {},

1745

"namespaces": {}

1746

},

1747

"dom/js/dom-style.js": {

1748

"name": "dom/js/dom-style.js",

1749

"modules": {

1750

"dom-style": 1

1751

},

1752

"classes": {},

1753

"fors": {

1754

"DOM": 1

1755

},

1756

"namespaces": {}

1757

},

1758

"dom/js/selector-css2.js": {

1759

"name": "dom/js/selector-css2.js",

1760

"modules": {

1761

"selector-css2": 1

1762

},

1763

"classes": {},

1764

"fors": {

1765

"Selector": 1

1766

},

1767

"namespaces": {}

1768

},

1769

"dom/js/selector-css3.js": {

1770

"name": "dom/js/selector-css3.js",

1771

"modules": {

1772

"selector-css3": 1

1773

},

1774

"classes": {},

1775

"fors": {

1776

"Selector": 1

1777

},

1778

"namespaces": {}

1779

},

1780

"dom/js/selector-native.js": {

1781

"name": "dom/js/selector-native.js",

1782

"modules": {

1783

"selector-native": 1

1784

},

1785

"classes": {

1786

"Selector": 1

1787

},

1788

"fors": {

1789

"Selector": 1

1790

},

1791

"namespaces": {}

1792

},

1793

"dump/js/dump.js": {

1794

"name": "dump/js/dump.js",

1795

"modules": {

1796

"dump": 1

1797

},

1798

"classes": {},

1799

"fors": {

1800

"YUI": 1

1801

},

1802

"namespaces": {}

1803

},

1804

"editor/js/createlink-base.js": {

1805

"name": "editor/js/createlink-base.js",

1806

"modules": {},

1807

"classes": {

1808

"Plugin.CreateLinkBase": 1

1809

},

1810

"fors": {

1811

"ExecCommand": 1

1812

},

1813

"namespaces": {}

1814

},

1815

"editor/js/editor-base.js": {

1816

"name": "editor/js/editor-base.js",

1817

"modules": {

1818

"editor": 1

1819

},

1820

"classes": {

1821

"EditorBase": 1

1822

},

1823

"fors": {},

1824

"namespaces": {}

1825

},

1826

"editor/js/editor-bidi.js": {

1827

"name": "editor/js/editor-bidi.js",

1828

"modules": {},

1829

"classes": {

1830

"Plugin.EditorBidi": 1

1831

},

1832

"fors": {

1833

"Plugin.ExecCommand": 1

1834

},

1835

"namespaces": {}

1836

},

1837

"editor/js/editor-br.js": {

1838

"name": "editor/js/editor-br.js",

1839

"modules": {},

1840

"classes": {

1841

"Plugin.EditorBR": 1

1842

},

1843

"fors": {},

1844

"namespaces": {}

1845

},

1846

"editor/js/editor-para-base.js": {

1847

"name": "editor/js/editor-para-base.js",

1848

"modules": {},

1849

"classes": {

1850

"Plugin.EditorParaBase": 1

1851

},

1852

"fors": {},

1853

"namespaces": {}

1854

},

1855

"editor/js/editor-para-ie.js": {

1856

"name": "editor/js/editor-para-ie.js",

1857

"modules": {},

1858

"classes": {

1859

"Plugin.EditorParaIE": 1

1860

},

1861

"fors": {},

1862

"namespaces": {}

1863

},

1864

"editor/js/editor-para.js": {

1865

"name": "editor/js/editor-para.js",

1866

"modules": {},

1867

"classes": {

1868

"Plugin.EditorPara": 1

1869

},

1870

"fors": {},

1871

"namespaces": {}

1872

},

1873

"editor/js/editor-selection.js": {

1874

"name": "editor/js/editor-selection.js",

1875

"modules": {},

1876

"classes": {

1877

"EditorSelection": 1

1878

},

1879

"fors": {},

1880

"namespaces": {}

1881

},

1882

"editor/js/editor-tab.js": {

1883

"name": "editor/js/editor-tab.js",

1884

"modules": {},

1885

"classes": {

1886

"Plugin.EditorTab": 1

1887

},

1888

"fors": {},

1889

"namespaces": {}

1890

},

1891

"editor/js/exec-command.js": {

1892

"name": "editor/js/exec-command.js",

1893

"modules": {},

1894

"classes": {

1895

"Plugin.ExecCommand": 1

1896

},

1897

"fors": {},

1898

"namespaces": {}

1899

},

1900

"editor/js/frame.js": {

1901

"name": "editor/js/frame.js",

1902

"modules": {},

1903

"classes": {

1904

"Frame": 1

1905

},

1906

"fors": {

1907

"Frame": 1

1908

},

1909

"namespaces": {}

1910

},

1911

"editor/js/lists.js": {

1912

"name": "editor/js/lists.js",

1913

"modules": {},

1914

"classes": {

1915

"Plugin.EditorLists": 1

1916

},

1917

"fors": {},

1918

"namespaces": {}

1919

},

1920

"escape/js/escape.js": {

1921

"name": "escape/js/escape.js",

1922

"modules": {

1923

"escape": 1

1924

},

1925

"classes": {

1926

"Escape": 1

1927

},

1928

"fors": {},

1929

"namespaces": {}

1930

},

1931

"event-custom/js/event-custom.js": {

1932

"name": "event-custom/js/event-custom.js",

1933

"modules": {

1934

"event-custom-base": 1

1935

},

1936

"classes": {

1937

"CustomEvent": 1

1938

},

1939

"fors": {},

1940

"namespaces": {}

1941

},

1942

"event-custom/js/event-do.js": {

1943

"name": "event-custom/js/event-do.js",

1944

"modules": {},

1945

"classes": {

1946

"Do": 1,

1947

"Do.Method": 1,

1948

"Do.AlterArgs": 1,

1949

"Do.AlterReturn": 1,

1950

"Do.Halt": 1,

1951

"Do.Prevent": 1,

1952

"Do.Error": 1

1953

},

1954

"fors": {},

1955

"namespaces": {}

1956

},

1957

"event-custom/js/event-facade.js": {

1958

"name": "event-custom/js/event-facade.js",

1959

"modules": {

1960

"event-custom-complex": 1

1961

},

1962

"classes": {

1963

"EventFacade": 1

1964

},

1965

"fors": {

1966

"CustomEvent": 1,

1967

"EventTarget": 1

1968

},

1969

"namespaces": {}

1970

},

1971

"event-custom/js/event-target.js": {

1972

"name": "event-custom/js/event-target.js",

1973

"modules": {},

1974

"classes": {

1975

"EventTarget": 1

1976

},

1977

"fors": {

1978

"YUI": 1

1979

},

1980

"namespaces": {}

1981

},

1982

"event-custom/js/event.js": {

1983

"name": "event-custom/js/event.js",

1984

"modules": {

1985

"event-custom": 1

1986

},

1987

"classes": {},

1988

"fors": {},

1989

"namespaces": {}

1990

},

1991

"event-custom/js/handle.js": {

1992

"name": "event-custom/js/handle.js",

1993

"modules": {},

1994

"classes": {

1995

"EventHandle": 1

1996

},

1997

"fors": {},

1998

"namespaces": {}

1999

},

2000

"event-custom/js/subscriber.js": {

2001

"name": "event-custom/js/subscriber.js",

2002

"modules": {},

2003

"classes": {

2004

"Subscriber": 1

2005

},

2006

"fors": {},

2007

"namespaces": {}

2008

},

2009

"event-gestures/js/Flick.js": {

2010

"name": "event-gestures/js/Flick.js",

2011

"modules": {

2012

"event-gestures": 1,

2013

"event-flick": 1

2014

},

2015

"classes": {},

2016

"fors": {

2017

"YUI": 1

2018

},

2019

"namespaces": {}

2020

},

2021

"event-gestures/js/Move.js": {

2022

"name": "event-gestures/js/Move.js",

2023

"modules": {

2024

"event-move": 1

2025

},

2026

"classes": {},

2027

"fors": {

2028

"YUI": 1

2029

},

2030

"namespaces": {}

2031

},

2032

"event-simulate/js/event-simulate.js": {

2033

"name": "event-simulate/js/event-simulate.js",

2034

"modules": {

2035

"event-simulate": 1

2036

},

2037

"classes": {},

2038

"fors": {

2039

"Event": 1

2040

},

2041

"namespaces": {}

2042

},

2043

"event-valuechange/js/event-valuechange.js": {

2044

"name": "event-valuechange/js/event-valuechange.js",

2045

"modules": {

2046

"event-valuechange": 1

2047

},

2048

"classes": {

2049

"ValueChange": 1

2050

},

2051

"fors": {

2052

"YUI": 1

2053

},

2054

"namespaces": {}

2055

},

2056

"event/js/available.js": {

2057

"name": "event/js/available.js",

2058

"modules": {

2059

"event-base": 1

2060

},

2061

"classes": {},

2062

"fors": {

2063

"YUI": 1

2064

},

2065

"namespaces": {}

2066

},

2067

"event/js/contextmenu.js": {

2068

"name": "event/js/contextmenu.js",

2069

"modules": {

2070

"event-contextmenu": 1

2071

},

2072

"classes": {},

2073

"fors": {},

2074

"namespaces": {}

2075

},

2076

"event/js/delegate.js": {

2077

"name": "event/js/delegate.js",

2078

"modules": {

2079

"event-delegate": 1

2080

},

2081

"classes": {},

2082

"fors": {

2083

"Event": 1,

2084

"YUI": 1

2085

},

2086

"namespaces": {}

2087

},

2088

"event/js/event-dom.js": {

2089

"name": "event/js/event-dom.js",

2090

"modules": {

2091

"event": 1

2092

},

2093

"classes": {

2094

"Event": 1

2095

},

2096

"fors": {},

2097

"namespaces": {}

2098

},

2099

"event/js/event-facade-dom-ie.js": {

2100

"name": "event/js/event-facade-dom-ie.js",

2101

"modules": {},

2102

"classes": {},

2103

"fors": {},

2104

"namespaces": {}

2105

},

2106

"event/js/event-facade-dom-touch.js": {

2107

"name": "event/js/event-facade-dom-touch.js",

2108

"modules": {

2109

"event-touch": 1

2110

},

2111

"classes": {},

2112

"fors": {

2113

"DOMEventFacade": 1

2114

},

2115

"namespaces": {}

2116

},

2117

"event/js/event-facade-dom.js": {

2118

"name": "event/js/event-facade-dom.js",

2119

"modules": {},

2120

"classes": {

2121

"DOMEventFacade": 1

2122

},

2123

"fors": {},

2124

"namespaces": {}

2125

},

2126

"event/js/event-ready.js": {

2127

"name": "event/js/event-ready.js",

2128

"modules": {},

2129

"classes": {},

2130

"fors": {

2131

"YUI": 1

2132

},

2133

"namespaces": {}

2134

},

2135

"event/js/focusblur.js": {

2136

"name": "event/js/focusblur.js",

2137

"modules": {

2138

"event-focus": 1

2139

},

2140

"classes": {},

2141

"fors": {},

2142

"namespaces": {}

2143

},

2144

"event/js/hover.js": {

2145

"name": "event/js/hover.js",

2146

"modules": {

2147

"event-hover": 1

2148

},

2149

"classes": {},

2150

"fors": {},

2151

"namespaces": {}

2152

},

2153

"event/js/key.js": {

2154

"name": "event/js/key.js",

2155

"modules": {

2156

"event-key": 1

2157

},

2158

"classes": {},

2159

"fors": {

2160

"YUI": 1

2161

},

2162

"namespaces": {}

2163

},

2164

"event/js/mouseentermouseleave.js": {

2165

"name": "event/js/mouseentermouseleave.js",

2166

"modules": {

2167

"event-mouseenter": 1

2168

},

2169

"classes": {},

2170

"fors": {},

2171

"namespaces": {}

2172

},

2173

"event/js/mousewheel.js": {

2174

"name": "event/js/mousewheel.js",

2175

"modules": {

2176

"event-mousewheel": 1

2177

},

2178

"classes": {},

2179

"fors": {

2180

"YUI": 1

2181

},

2182

"namespaces": {}

2183

},

2184

"event/js/outside.js": {

2185

"name": "event/js/outside.js",

2186

"modules": {

2187

"event-outside": 1

2188

},

2189

"classes": {},

2190

"fors": {

2191

"Event": 1

2192

},

2193

"namespaces": {}

2194

},

2195

"event/js/resize-window.js": {

2196

"name": "event/js/resize-window.js",

2197

"modules": {

2198

"event-resize": 1

2199

},

2200

"classes": {},

2201

"fors": {

2202

"YUI": 1

2203

},

2204

"namespaces": {}

2205

},

2206

"event/js/synthetic.js": {

2207

"name": "event/js/synthetic.js",

2208

"modules": {

2209

"event-synthetic": 1

2210

},

2211

"classes": {

2212

"SyntheticEvent.Notifier": 1,

2213

"SynthRegistry": 1,

2214

"SyntheticEvent": 1

2215

},

2216

"fors": {

2217

"Event": 1

2218

},

2219

"namespaces": {}

2220

},

2221

"file/js/file-flash.js": {

2222

"name": "file/js/file-flash.js",

2223

"modules": {

2224

"file-flash": 1

2225

},

2226

"classes": {

2227

"FileFlash": 1

2228

},

2229

"fors": {},

2230

"namespaces": {}

2231

},

2232

"file/js/file-html5.js": {

2233

"name": "file/js/file-html5.js",

2234

"modules": {

2235

"file-html5": 1

2236

},

2237

"classes": {

2238

"FileHTML5": 1

2239

},

2240

"fors": {},

2241

"namespaces": {}

2242

},

2243

"file/js/file.js": {

2244

"name": "file/js/file.js",

2245

"modules": {

2246

"file": 1

2247

},

2248

"classes": {

2249

"File": 1

2250

},

2251

"fors": {},

2252

"namespaces": {}

2253

},

2254

"get/js/get-nodejs.js": {

2255

"name": "get/js/get-nodejs.js",

2256

"modules": {

2257

"get-nodejs": 1

2258

},

2259

"classes": {

2260

"GetNodeJS": 1

2261

},

2262

"fors": {},

2263

"namespaces": {}

2264

},

2265

"get/js/get.js": {

2266

"name": "get/js/get.js",

2267

"modules": {

2268

"get": 1

2269

},

2270

"classes": {

2271

"Get": 1,

2272

"Get.Transaction": 1

2273

},

2274

"fors": {},

2275

"namespaces": {}

2276

},

2277

"graphics/js/CanvasCircle.js": {

2278

"name": "graphics/js/CanvasCircle.js",

2279

"modules": {},

2280

"classes": {

2281

"CanvasCircle": 1

2282

},

2283

"fors": {},

2284

"namespaces": {}

2285

},

2286

"graphics/js/CanvasDrawing.js": {

2287

"name": "graphics/js/CanvasDrawing.js",

2288

"modules": {},

2289

"classes": {

2290

"CanvasDrawing": 1

2291

},

2292

"fors": {},

2293

"namespaces": {}

2294

},

2295

"graphics/js/CanvasEllipse.js": {

2296

"name": "graphics/js/CanvasEllipse.js",

2297

"modules": {},

2298

"classes": {

2299

"CanvasEllipse": 1

2300

},

2301

"fors": {},

2302

"namespaces": {}

2303

},

2304

"graphics/js/CanvasGraphic.js": {

2305

"name": "graphics/js/CanvasGraphic.js",

2306

"modules": {},

2307

"classes": {

2308

"CanvasGraphic": 1

2309

},

2310

"fors": {},

2311

"namespaces": {}

2312

},

2313

"graphics/js/CanvasPath.js": {

2314

"name": "graphics/js/CanvasPath.js",

2315

"modules": {},

2316

"classes": {

2317

"CanvasPath": 1

2318

},

2319

"fors": {},

2320

"namespaces": {}

2321

},

2322

"graphics/js/CanvasPieSlice.js": {

2323

"name": "graphics/js/CanvasPieSlice.js",

2324

"modules": {},

2325

"classes": {

2326

"CanvasPieSlice": 1

2327

},

2328

"fors": {},

2329

"namespaces": {}

2330

},

2331

"graphics/js/CanvasRect.js": {

2332

"name": "graphics/js/CanvasRect.js",

2333

"modules": {},

2334

"classes": {

2335

"CanvasRect": 1

2336

},

2337

"fors": {},

2338

"namespaces": {}

2339

},

2340

"graphics/js/CanvasShape.js": {

2341

"name": "graphics/js/CanvasShape.js",

2342

"modules": {},

2343

"classes": {

2344

"CanvasShape": 1

2345

},

2346

"fors": {},

2347

"namespaces": {}

2348

},

2349

"graphics/js/GraphicBase.js": {

2350

"name": "graphics/js/GraphicBase.js",

2351

"modules": {

2352

"graphics": 1

2353

},

2354

"classes": {

2355

"AttributeLite": 1,

2356

"GraphicBase": 1,

2357

"Drawing": 1,

2358

"Shape": 1,

2359

"Circle": 1,

2360

"Ellipse": 1,

2361

"Rect": 1,

2362

"Path": 1,

2363

"Graphic": 1

2364

},

2365

"fors": {},

2366

"namespaces": {}

2367

},

2368

"graphics/js/SVGCircle.js": {

2369

"name": "graphics/js/SVGCircle.js",

2370

"modules": {},

2371

"classes": {

2372

"SVGCircle": 1

2373

},

2374

"fors": {},

2375

"namespaces": {}

2376

},

2377

"graphics/js/SVGDrawing.js": {

2378

"name": "graphics/js/SVGDrawing.js",

2379

"modules": {},

2380

"classes": {

2381

"SVGDrawing": 1

2382

},

2383

"fors": {},

2384

"namespaces": {}

2385

},

2386

"graphics/js/SVGEllipse.js": {

2387

"name": "graphics/js/SVGEllipse.js",

2388

"modules": {},

2389

"classes": {

2390

"SVGEllipse": 1

2391

},

2392

"fors": {},

2393

"namespaces": {}

2394

},

2395

"graphics/js/SVGGraphic.js": {

2396

"name": "graphics/js/SVGGraphic.js",

2397

"modules": {},

2398

"classes": {

2399

"SVGGraphic": 1

2400

},

2401

"fors": {},

2402

"namespaces": {}

2403

},

2404

"graphics/js/SVGPath.js": {

2405

"name": "graphics/js/SVGPath.js",

2406

"modules": {},

2407

"classes": {

2408

"SVGPath": 1

2409

},

2410

"fors": {},

2411

"namespaces": {}

2412

},

2413

"graphics/js/SVGPieSlice.js": {

2414

"name": "graphics/js/SVGPieSlice.js",

2415

"modules": {},

2416

"classes": {

2417

"SVGPieSlice": 1

2418

},

2419

"fors": {},

2420

"namespaces": {}

2421

},

2422

"graphics/js/SVGRect.js": {

2423

"name": "graphics/js/SVGRect.js",

2424

"modules": {},

2425

"classes": {

2426

"SVGRect": 1

2427

},

2428

"fors": {},

2429

"namespaces": {}

2430

},

2431

"graphics/js/SVGShape.js": {

2432

"name": "graphics/js/SVGShape.js",

2433

"modules": {},

2434

"classes": {

2435

"SVGShape": 1

2436

},

2437

"fors": {},

2438

"namespaces": {}

2439

},

2440

"graphics/js/VMLCircle.js": {

2441

"name": "graphics/js/VMLCircle.js",

2442

"modules": {},

2443

"classes": {

2444

"VMLCircle": 1

2445

},

2446

"fors": {},

2447

"namespaces": {}

2448

},

2449

"graphics/js/VMLDrawing.js": {

2450

"name": "graphics/js/VMLDrawing.js",

2451

"modules": {},

2452

"classes": {

2453

"VMLDrawing": 1

2454

},

2455

"fors": {},

2456

"namespaces": {}

2457

},

2458

"graphics/js/VMLEllipse.js": {

2459

"name": "graphics/js/VMLEllipse.js",

2460

"modules": {},

2461

"classes": {

2462

"VMLEllipse": 1

2463

},

2464

"fors": {},

2465

"namespaces": {}

2466

},

2467

"graphics/js/VMLGraphic.js": {

2468

"name": "graphics/js/VMLGraphic.js",

2469

"modules": {},

2470

"classes": {

2471

"VMLGraphic": 1

2472

},

2473

"fors": {},

2474

"namespaces": {}

2475

},

2476

"graphics/js/VMLPath.js": {

2477

"name": "graphics/js/VMLPath.js",

2478

"modules": {},

2479

"classes": {

2480

"VMLPath": 1

2481

},

2482

"fors": {},

2483

"namespaces": {}

2484

},

2485

"graphics/js/VMLPieSlice.js": {

2486

"name": "graphics/js/VMLPieSlice.js",

2487

"modules": {},

2488

"classes": {

2489

"VMLPieSlice": 1

2490

},

2491

"fors": {},

2492

"namespaces": {}

2493

},

2494

"graphics/js/VMLRect.js": {

2495

"name": "graphics/js/VMLRect.js",

2496

"modules": {},

2497

"classes": {

2498

"VMLRect": 1

2499

},

2500

"fors": {},

2501

"namespaces": {}

2502

},

2503

"graphics/js/VMLShape.js": {

2504

"name": "graphics/js/VMLShape.js",

2505

"modules": {},

2506

"classes": {

2507

"VMLShape": 1

2508

},

2509

"fors": {},

2510

"namespaces": {}

2511

},

2512

"handlebars/js/yui-handlebars-base-after.js": {

2513

"name": "handlebars/js/yui-handlebars-base-after.js",

2514

"modules": {

2515

"handlebars": 1,

2516

"handlebars-base": 1

2517

},

2518

"classes": {

2519

"Handlebars": 1

2520

},

2521

"fors": {},

2522

"namespaces": {}

2523

},

2524

"handlebars/js/yui-handlebars-compiler-after.js": {

2525

"name": "handlebars/js/yui-handlebars-compiler-after.js",

2526

"modules": {

2527

"handlebars-compiler": 1

2528

},

2529

"classes": {},

2530

"fors": {

2531

"Handlebars": 1

2532

},

2533

"namespaces": {}

2534

},

2535

"highlight/js/highlight-accentfold.js": {

2536

"name": "highlight/js/highlight-accentfold.js",

2537

"modules": {

2538

"highlight-accentfold": 1

2539

},

2540

"classes": {},

2541

"fors": {},

2542

"namespaces": {}

2543

},

2544

"highlight/js/highlight-base.js": {

2545

"name": "highlight/js/highlight-base.js",

2546

"modules": {

2547

"highlight-base": 1

2548

},

2549

"classes": {

2550

"Highlight": 1

2551

},

2552

"fors": {},

2553

"namespaces": {}

2554

},

2555

"history/js/history-base.js": {

2556

"name": "history/js/history-base.js",

2557

"modules": {

2558

"history": 1,

2559

"history-base": 1

2560

},

2561

"classes": {

2562

"HistoryBase": 1

2563

},

2564

"fors": {},

2565

"namespaces": {}

2566

},

2567

"history/js/history-hash-ie.js": {

2568

"name": "history/js/history-hash-ie.js",

2569

"modules": {

2570

"history-hash-ie": 1

2571

},

2572

"classes": {},

2573

"fors": {

2574

"HistoryHash": 1

2575

},

2576

"namespaces": {}

2577

},

2578

"history/js/history-hash.js": {

2579

"name": "history/js/history-hash.js",

2580

"modules": {

2581

"history-hash": 1

2582

},

2583

"classes": {

2584

"HistoryHash": 1

2585

},

2586

"fors": {

2587

"YUI": 1

2588

},

2589

"namespaces": {}

2590

},

2591

"history/js/history-html5.js": {

2592

"name": "history/js/history-html5.js",

2593

"modules": {

2594

"history-html5": 1

2595

},

2596

"classes": {

2597

"HistoryHTML5": 1

2598

},

2599

"fors": {

2600

"config": 1

2601

},

2602

"namespaces": {}

2603

},

2604

"imageloader/js/imageloader.js": {

2605

"name": "imageloader/js/imageloader.js",

2606

"modules": {

2607

"imageloader": 1

2608

},

2609

"classes": {

2610

"ImgLoadGroup": 1,

2611

"ImgLoadImgObj": 1

2612

},

2613

"fors": {},

2614

"namespaces": {}

2615

},

2616

"intl/js/Intl.js": {

2617

"name": "intl/js/Intl.js",

2618

"modules": {

2619

"intl": 1

2620

},

2621

"classes": {},

2622

"fors": {},

2623

"namespaces": {}

2624

},

2625

"io/js/io-base.js": {

2626

"name": "io/js/io-base.js",

2627

"modules": {

2628

"io-base": 1

2629

},

2630

"classes": {

2631

"IO": 1

2632

},

2633

"fors": {

2634

"IO": 1,

2635

"YUI": 1

2636

},

2637

"namespaces": {}

2638

},

2639

"io/js/io-form.js": {

2640

"name": "io/js/io-form.js",

2641

"modules": {

2642

"io-form": 1

2643

},

2644

"classes": {},

2645

"fors": {

2646

"IO": 1

2647

},

2648

"namespaces": {}

2649

},

2650

"io/js/io-nodejs.js": {

2651

"name": "io/js/io-nodejs.js",

2652

"modules": {},

2653

"classes": {},

2654

"fors": {},

2655

"namespaces": {}

2656

},

2657

"io/js/io-queue.js": {

2658

"name": "io/js/io-queue.js",

2659

"modules": {

2660

"io-queue": 1

2661

},

2662

"classes": {},

2663

"fors": {

2664

"IO": 1

2665

},

2666

"namespaces": {}

2667

},

2668

"io/js/io-upload-iframe.js": {

2669

"name": "io/js/io-upload-iframe.js",

2670

"modules": {

2671

"io-upload-iframe": 1

2672

},

2673

"classes": {},

2674

"fors": {

2675

"IO": 1

2676

},

2677

"namespaces": {}

2678

},

2679

"io/js/io-xdr.js": {

2680

"name": "io/js/io-xdr.js",

2681

"modules": {

2682

"io-xdr": 1

2683

},

2684

"classes": {},

2685

"fors": {

2686

"IO": 1

2687

},

2688

"namespaces": {}

2689

},

2690

"io/js/io.js": {

2691

"name": "io/js/io.js",

2692

"modules": {

2693

"io": 1

2694

},

2695

"classes": {},

2696

"fors": {},

2697

"namespaces": {}

2698

},

2699

"io/js/transports.js": {

2700

"name": "io/js/transports.js",

2701

"modules": {},

2702

"classes": {},

2703

"fors": {},

2704

"namespaces": {}

2705

},

2706

"json/js/parse.js": {

2707

"name": "json/js/parse.js",

2708

"modules": {

2709

"json": 1,

2710

"json-parse": 1

2711

},

2712

"classes": {

2713

"JSON": 1

2714

},

2715

"fors": {

2716

"JSON": 1

2717

},

2718

"namespaces": {}

2719

},

2720

"json/js/stringify.js": {

2721

"name": "json/js/stringify.js",

2722

"modules": {

2723

"json-stringify": 1

2724

},

2725

"classes": {},

2726

"fors": {

2727

"JSON": 1

2728

},

2729

"namespaces": {}

2730

},

2731

"jsonp/js/jsonp-url.js": {

2732

"name": "jsonp/js/jsonp-url.js",

2733

"modules": {

2734

"jsonp-url": 1

2735

},

2736

"classes": {},

2737

"fors": {

2738

"JSONPRequest": 1

2739

},

2740

"namespaces": {}

2741

},

2742

"jsonp/js/jsonp.js": {

2743

"name": "jsonp/js/jsonp.js",

2744

"modules": {

2745

"jsonp": 1

2746

},

2747

"classes": {

2748

"JSONPRequest": 1

2749

},

2750

"fors": {

2751

"YUI": 1

2752

},

2753

"namespaces": {}

2754

},

2755

"loader/js/loader.js": {

2756

"name": "loader/js/loader.js",

2757

"modules": {

2758

"loader": 1,

2759

"loader-base": 1

2760

},

2761

"classes": {

2762

"Loader": 1

2763

},

2764

"fors": {

2765

"YUI": 1

2766

},

2767

"namespaces": {}

2768

},

2769

"loader/js/meta.js": {

2770

"name": "loader/js/meta.js",

2771

"modules": {},

2772

"classes": {},

2773

"fors": {},

2774

"namespaces": {}

2775

},

2776

"loader/js/rollup.js": {

2777

"name": "loader/js/rollup.js",

2778

"modules": {

2779

"rollup": 1

2780

},

2781

"classes": {},

2782

"fors": {

2783

"Loader": 1

2784

},

2785

"namespaces": {}

2786

},

2787

"loader/js/yui3.js": {

2788

"name": "loader/js/yui3.js",

2789

"modules": {

2790

"yui3": 1

2791

},

2792

"classes": {},

2793

"fors": {},

2794

"namespaces": {}

2795

},

2796

"matrix/js/Matrix.js": {

2797

"name": "matrix/js/Matrix.js",

2798

"modules": {

2799

"matrix": 1

2800

},

2801

"classes": {

2802

"Matrix": 1

2803

},

2804

"fors": {},

2805

"namespaces": {}

2806

},

2807

"matrix/js/MatrixUtil.js": {

2808

"name": "matrix/js/MatrixUtil.js",

2809

"modules": {},

2810

"classes": {},

2811

"fors": {},

2812

"namespaces": {}

2813

},

2814

"node-flick/js/NodeFlick.js": {

2815

"name": "node-flick/js/NodeFlick.js",

2816

"modules": {

2817

"node-flick": 1

2818

},

2819

"classes": {

2820

"Plugin.Flick": 1

2821

},

2822

"fors": {},

2823

"namespaces": {

2824

"Plugin": 1

2825

}

2826

},

2827

"node-focusmanager/js/node-focusmanager.js": {

2828

"name": "node-focusmanager/js/node-focusmanager.js",

2829

"modules": {

2830

"node-focusmanager": 1

2831

},

2832

"classes": {

2833

"plugin.NodeFocusManager": 1

2834

},

2835

"fors": {},

2836

"namespaces": {

2837

"plugin": 1

2838

}

2839

},

2840

"node-menunav/js/node-menunav.js": {

2841

"name": "node-menunav/js/node-menunav.js",

2842

"modules": {

2843

"node-menunav": 1

2844

},

2845

"classes": {

2846

"plugin.NodeMenuNav": 1

2847

},

2848

"fors": {},

2849

"namespaces": {

2850

"plugin": 1

2851

}

2852

},

2853

"node/js/align-plugin.js": {

2854

"name": "node/js/align-plugin.js",

2855

"modules": {

2856

"align-plugin": 1

2857

},

2858

"classes": {

2859

"Plugin.Align": 1

2860

},

2861

"fors": {},

2862

"namespaces": {}

2863

},

2864

"node/js/node-attrs.js": {

2865

"name": "node/js/node-attrs.js",

2866

"modules": {

2867

"node-base": 1

2868

},

2869

"classes": {},

2870

"fors": {

2871

"Node": 1,

2872

"NodeList": 1

2873

},

2874

"namespaces": {}

2875

},

2876

"node/js/node-class.js": {

2877

"name": "node/js/node-class.js",

2878

"modules": {},

2879

"classes": {},

2880

"fors": {

2881

"Node": 1,

2882

"NodeList": 1

2883

},

2884

"namespaces": {}

2885

},

2886

"node/js/node-core.js": {

2887

"name": "node/js/node-core.js",

2888

"modules": {

2889

"node": 1,

2890

"node-core": 1

2891

},

2892

"classes": {

2893

"Node": 1

2894

},

2895

"fors": {

2896

"YUI": 1,

2897

"Node": 1

2898

},

2899

"namespaces": {}

2900

},

2901

"node/js/node-create.js": {

2902

"name": "node/js/node-create.js",

2903

"modules": {},

2904

"classes": {},

2905

"fors": {

2906

"Node": 1,

2907

"NodeList": 1

2908

},

2909

"namespaces": {}

2910

},

2911

"node/js/node-data.js": {

2912

"name": "node/js/node-data.js",

2913

"modules": {

2914

"node-data": 1

2915

},

2916

"classes": {},

2917

"fors": {},

2918

"namespaces": {}

2919

},

2920

"node/js/node-deprecated.js": {

2921

"name": "node/js/node-deprecated.js",

2922

"modules": {

2923

"node-deprecated": 1

2924

},

2925

"classes": {},

2926

"fors": {

2927

"YUI": 1,

2928

"Node": 1

2929

},

2930

"namespaces": {}

2931

},

2932

"node/js/node-event-delegate.js": {

2933

"name": "node/js/node-event-delegate.js",

2934

"modules": {

2935

"node-event-delegate": 1

2936

},

2937

"classes": {},

2938

"fors": {

2939

"Node": 1

2940

},

2941

"namespaces": {}

2942

},

2943

"node/js/node-event-html5.js": {

2944

"name": "node/js/node-event-html5.js",

2945

"modules": {

2946

"node-event-html5": 1

2947

},

2948

"classes": {},

2949

"fors": {},

2950

"namespaces": {}

2951

},

2952

"node/js/node-event-simulate.js": {

2953

"name": "node/js/node-event-simulate.js",

2954

"modules": {

2955

"node-event-simulate": 1

2956

},

2957

"classes": {},

2958

"fors": {

2959

"Node": 1

2960

},

2961

"namespaces": {}

2962

},

2963

"node/js/node-event.js": {

2964

"name": "node/js/node-event.js",

2965

"modules": {},

2966

"classes": {},

2967

"fors": {

2968

"Node": 1,

2969

"NodeList": 1

2970

},

2971

"namespaces": {}

2972

},

2973

"node/js/node-imports.js": {

2974

"name": "node/js/node-imports.js",

2975

"modules": {},

2976

"classes": {},

2977

"fors": {

2978

"Node": 1,

2979

"NodeList": 1

2980

},

2981

"namespaces": {}

2982

},

2983

"node/js/node-load.js": {

2984

"name": "node/js/node-load.js",

2985

"modules": {

2986

"node-load": 1

2987

},

2988

"classes": {},

2989

"fors": {

2990

"Node": 1

2991

},

2992

"namespaces": {}

2993

},

2994

"node/js/node-pluginhost.js": {

2995

"name": "node/js/node-pluginhost.js",

2996

"modules": {

2997

"node-pluginhost": 1

2998

},

2999

"classes": {},

3000

"fors": {

3001

"Node": 1

3002

},

3003

"namespaces": {}

3004

},

3005

"node/js/node-region.js": {

3006

"name": "node/js/node-region.js",

3007

"modules": {

3008

"node-screen": 1

3009

},

3010

"classes": {},

3011

"fors": {

3012

"Node": 1

3013

},

3014

"namespaces": {}

3015

},

3016

"node/js/node-screen.js": {

3017

"name": "node/js/node-screen.js",

3018

"modules": {},

3019

"classes": {},

3020

"fors": {

3021

"Node": 1

3022

},

3023

"namespaces": {}

3024

},

3025

"node/js/node-style.js": {

3026

"name": "node/js/node-style.js",

3027

"modules": {

3028

"node-style": 1

3029

},

3030

"classes": {},

3031

"fors": {

3032

"Node": 1,

3033

"NodeList": 1

3034

},

3035

"namespaces": {}

3036

},

3037

"node/js/node-view.js": {

3038

"name": "node/js/node-view.js",

3039

"modules": {},

3040

"classes": {},

3041

"fors": {

3042

"Node": 1,

3043

"NodeList": 1

3044

},

3045

"namespaces": {}

3046

},

3047

"node/js/nodelist-array.js": {

3048

"name": "node/js/nodelist-array.js",

3049

"modules": {},

3050

"classes": {},

3051

"fors": {

3052

"NodeList": 1

3053

},

3054

"namespaces": {}

3055

},

3056

"node/js/nodelist.js": {

3057

"name": "node/js/nodelist.js",

3058

"modules": {},

3059

"classes": {

3060

"NodeList": 1

3061

},

3062

"fors": {},

3063

"namespaces": {}

3064

},

3065

"node/js/shim-plugin.js": {

3066

"name": "node/js/shim-plugin.js",

3067

"modules": {

3068

"shim-plugin": 1

3069

},

3070

"classes": {

3071

"Plugin.Shim": 1

3072

},

3073

"fors": {},

3074

"namespaces": {}

3075

},

3076

"oop/js/oop.js": {

3077

"name": "oop/js/oop.js",

3078

"modules": {

3079

"oop": 1

3080

},

3081

"classes": {},

3082

"fors": {

3083

"YUI": 1

3084

},

3085

"namespaces": {}

3086

},

3087

"overlay/js/Overlay.js": {

3088

"name": "overlay/js/Overlay.js",

3089

"modules": {

3090

"overlay": 1

3091

},

3092

"classes": {

3093

"Overlay": 1

3094

},

3095

"fors": {},

3096

"namespaces": {}

3097

},

3098

"panel/js/panel.js": {

3099

"name": "panel/js/panel.js",

3100

"modules": {

3101

"panel": 1

3102

},

3103

"classes": {

3104

"Panel": 1

3105

},

3106

"fors": {},

3107

"namespaces": {}

3108

},

3109

"parallel/js/parallel.js": {

3110

"name": "parallel/js/parallel.js",

3111

"modules": {

3112

"parallel": 1

3113

},

3114

"classes": {

3115

"Parallel": 1

3116

},

3117

"fors": {},

3118

"namespaces": {}

3119

},

3120

"pjax/js/pjax-base.js": {

3121

"name": "pjax/js/pjax-base.js",

3122

"modules": {

3123

"pjax-base": 1

3124

},

3125

"classes": {

3126

"PjaxBase": 1

3127

},

3128

"fors": {},

3129

"namespaces": {}

3130

},

3131

"pjax/js/pjax-plugin.js": {

3132

"name": "pjax/js/pjax-plugin.js",

3133

"modules": {

3134

"pjax-plugin": 1

3135

},

3136

"classes": {

3137

"Plugin.Pjax": 1

3138

},

3139

"fors": {},

3140

"namespaces": {}

3141

},

3142

"pjax/js/pjax.js": {

3143

"name": "pjax/js/pjax.js",

3144

"modules": {

3145

"pjax": 1

3146

},

3147

"classes": {

3148

"Pjax": 1

3149

},

3150

"fors": {},

3151

"namespaces": {}

3152

},

3153

"plugin/js/plugin.js": {

3154

"name": "plugin/js/plugin.js",

3155

"modules": {

3156

"plugin": 1

3157

},

3158

"classes": {

3159

"Plugin.Base": 1

3160

},

3161

"fors": {},

3162

"namespaces": {}

3163

},

3164

"pluginhost/js/PluginHost.js": {

3165

"name": "pluginhost/js/PluginHost.js",

3166

"modules": {

3167

"pluginhost": 1,

3168

"pluginhost-base": 1

3169

},

3170

"classes": {

3171

"Plugin.Host": 1

3172

},

3173

"fors": {},

3174

"namespaces": {}

3175

},

3176

"pluginhost/js/PluginHostConfig.js": {

3177

"name": "pluginhost/js/PluginHostConfig.js",

3178

"modules": {

3179

"pluginhost-config": 1

3180

},

3181

"classes": {},

3182

"fors": {

3183

"Plugin.Host": 1

3184

},

3185

"namespaces": {}

3186

},

3187

"profiler/js/Profiler.js": {

3188

"name": "profiler/js/Profiler.js",

3189

"modules": {

3190

"profiler": 1

3191

},

3192

"classes": {

3193

"Profiler": 1

3194

},

3195

"fors": {},

3196

"namespaces": {}

3197

},

3198

"querystring/js/querystring-parse-simple.js": {

3199

"name": "querystring/js/querystring-parse-simple.js",

3200

"modules": {

3201

"querystring-parse-simple": 1,

3202

"querystring-parse": 1

3203

},

3204

"classes": {},

3205

"fors": {

3206

"QueryString": 1

3207

},

3208

"namespaces": {}

3209

},

3210

"querystring/js/querystring-parse.js": {

3211

"name": "querystring/js/querystring-parse.js",

3212

"modules": {

3213

"querystring": 1

3214

},

3215

"classes": {

3216

"QueryString": 1

3217

},

3218

"fors": {

3219

"QueryString": 1

3220

},

3221

"namespaces": {}

3222

},

3223

"querystring/js/querystring-stringify-simple.js": {

3224

"name": "querystring/js/querystring-stringify-simple.js",

3225

"modules": {

3226

"querystring-stringify-simple": 1

3227

},

3228

"classes": {},

3229

"fors": {

3230

"QueryString": 1

3231

},

3232

"namespaces": {}

3233

},

3234

"querystring/js/querystring-stringify.js": {

3235

"name": "querystring/js/querystring-stringify.js",

3236

"modules": {

3237

"querystring-stringify": 1

3238

},

3239

"classes": {},

3240

"fors": {

3241

"QueryString": 1

3242

},

3243

"namespaces": {}

3244

},

3245

"queue-promote/js/queue-promote.js": {

3246

"name": "queue-promote/js/queue-promote.js",

3247

"modules": {

3248

"queue-promote": 1

3249

},

3250

"classes": {},

3251

"fors": {

3252

"Queue": 1

3253

},

3254

"namespaces": {}

3255

},

3256

"recordset/js/record.js": {

3257

"name": "recordset/js/record.js",

3258

"modules": {},

3259

"classes": {

3260

"Record": 1

3261

},

3262

"fors": {},

3263

"namespaces": {}

3264

},

3265

"recordset/js/recordset-base.js": {

3266

"name": "recordset/js/recordset-base.js",

3267

"modules": {

3268

"recordset": 1,

3269

"recordset-base": 1

3270

},

3271

"classes": {

3272

"Recordset": 1

3273

},

3274

"fors": {},

3275

"namespaces": {}

3276

},

3277

"recordset/js/recordset-filter.js": {

3278

"name": "recordset/js/recordset-filter.js",

3279

"modules": {

3280

"recordset-filter": 1

3281

},

3282

"classes": {

3283

"RecordsetFilter": 1

3284

},

3285

"fors": {},

3286

"namespaces": {}

3287

},

3288

"recordset/js/recordset-indexer.js": {

3289

"name": "recordset/js/recordset-indexer.js",

3290

"modules": {

3291

"recordset-indexer": 1

3292

},

3293

"classes": {

3294

"RecordsetIndexer": 1

3295

},

3296

"fors": {},

3297

"namespaces": {}

3298

},

3299

"recordset/js/recordset-sort.js": {

3300

"name": "recordset/js/recordset-sort.js",

3301

"modules": {

3302

"recordset-sort": 1

3303

},

3304

"classes": {

3305

"RecordsetSort": 1

3306

},

3307

"fors": {},

3308

"namespaces": {}

3309

},

3310

"resize/js/resize-base.js": {

3311

"name": "resize/js/resize-base.js",

3312

"modules": {

3313

"resize": 1

3314

},

3315

"classes": {

3316

"Resize": 1

3317

},

3318

"fors": {},

3319

"namespaces": {}

3320

},

3321

"resize/js/resize-constrain.js": {

3322

"name": "resize/js/resize-constrain.js",

3323

"modules": {

3324

"resize-contrain": 1

3325

},

3326

"classes": {

3327

"Plugin.ResizeConstrained": 1

3328

},

3329

"fors": {},

3330

"namespaces": {

3331

"Plugin": 1

3332

}

3333

},

3334

"resize/js/resize-plugin.js": {

3335

"name": "resize/js/resize-plugin.js",

3336

"modules": {

3337

"resize-plugin": 1

3338

},

3339

"classes": {

3340

"Plugin.Resize": 1

3341

},

3342

"fors": {},

3343

"namespaces": {}

3344

},

3345

"resize/js/resize-proxy.js": {

3346

"name": "resize/js/resize-proxy.js",

3347

"modules": {},

3348

"classes": {

3349

"Plugin.ResizeProxy": 1

3350

},

3351

"fors": {},

3352

"namespaces": {

3353

"Plugin": 1

3354

}

3355

},

3356

"scrollview/js/ScrollViewBaseIE.js": {

3357

"name": "scrollview/js/ScrollViewBaseIE.js",

3358

"modules": {

3359

"scrollview-base-ie": 1

3360

},

3361

"classes": {},

3362

"fors": {

3363

"ScrollView": 1

3364

},

3365

"namespaces": {}

3366

},

3367

"scrollview/js/list-plugin.js": {

3368

"name": "scrollview/js/list-plugin.js",

3369

"modules": {

3370

"scrollview-list": 1

3371

},

3372

"classes": {

3373

"Plugin.ScrollViewList": 1

3374

},

3375

"fors": {},

3376

"namespaces": {

3377

"Plugin": 1

3378

}

3379

},

3380

"scrollview/js/paginator-plugin.js": {

3381

"name": "scrollview/js/paginator-plugin.js",

3382

"modules": {

3383

"scrollview-paginator": 1

3384

},

3385

"classes": {

3386

"Plugin.ScrollViewPaginator": 1

3387

},

3388

"fors": {},

3389

"namespaces": {

3390

"Plugin": 1

3391

}

3392

},

3393

"scrollview/js/scrollbars-plugin.js": {

3394

"name": "scrollview/js/scrollbars-plugin.js",

3395

"modules": {

3396

"scrollview-scrollbars": 1

3397

},

3398

"classes": {

3399

"Plugin.ScrollViewScrollbars": 1

3400

},

3401

"fors": {},

3402

"namespaces": {

3403

"Plugin": 1

3404

}

3405

},

3406

"scrollview/js/scrollview-base.js": {

3407

"name": "scrollview/js/scrollview-base.js",

3408

"modules": {

3409

"scrollview-base": 1

3410

},

3411

"classes": {

3412

"ScrollView": 1

3413

},

3414

"fors": {},

3415

"namespaces": {}

3416

},

3417

"scrollview/js/scrollview.js": {

3418

"name": "scrollview/js/scrollview.js",

3419

"modules": {

3420

"scrollview": 1

3421

},

3422

"classes": {},

3423

"fors": {},

3424

"namespaces": {}

3425

},

3426

"slider/js/clickable-rail.js": {

3427

"name": "slider/js/clickable-rail.js",

3428

"modules": {

3429

"clickable-rail": 1

3430

},

3431

"classes": {

3432

"ClickableRail": 1

3433

},

3434

"fors": {},

3435

"namespaces": {}

3436

},

3437

"slider/js/range-slider.js": {

3438

"name": "slider/js/range-slider.js",

3439

"modules": {

3440

"slider": 1,

3441

"range-slider": 1

3442

},

3443

"classes": {

3444

"Slider": 1

3445

},

3446

"fors": {},

3447

"namespaces": {}

3448

},

3449

"slider/js/slider-base.js": {

3450

"name": "slider/js/slider-base.js",

3451

"modules": {

3452

"slider-base": 1

3453

},

3454

"classes": {

3455

"SliderBase": 1

3456

},

3457

"fors": {},

3458

"namespaces": {}

3459

},

3460

"slider/js/value-range.js": {

3461

"name": "slider/js/value-range.js",

3462

"modules": {

3463

"slider-value-range": 1

3464

},

3465

"classes": {

3466

"SliderValueRange": 1

3467

},

3468

"fors": {},

3469

"namespaces": {}

3470

},

3471

"sortable/js/sortable-scroll.js": {

3472

"name": "sortable/js/sortable-scroll.js",

3473

"modules": {

3474

"sortable-scroll": 1

3475

},

3476

"classes": {

3477

"Plugin.SortScroll": 1

3478

},

3479

"fors": {},

3480

"namespaces": {

3481

"Plugin": 1

3482

}

3483

},

3484

"sortable/js/sortable.js": {

3485

"name": "sortable/js/sortable.js",

3486

"modules": {

3487

"sortable": 1

3488

},

3489

"classes": {

3490

"Sortable": 1

3491

},

3492

"fors": {},

3493

"namespaces": {}

3494

},

3495

"stylesheet/js/stylesheet.js": {

3496

"name": "stylesheet/js/stylesheet.js",

3497

"modules": {

3498

"stylesheet": 1

3499

},

3500

"classes": {

3501

"StyleSheet": 1

3502

},

3503

"fors": {},

3504

"namespaces": {}

3505

},

3506

"substitute/js/substitute.js": {

3507

"name": "substitute/js/substitute.js",

3508

"modules": {

3509

"substitute": 1

3510

},

3511

"classes": {

3512

"YUI~substitute": 1

3513

},

3514

"fors": {},

3515

"namespaces": {}

3516

},

3517

"swf/js/swf.js": {

3518

"name": "swf/js/swf.js",

3519

"modules": {

3520

"swf": 1

3521

},

3522

"classes": {

3523

"SWF": 1

3524

},

3525

"fors": {},

3526

"namespaces": {}

3527

},

3528

"swfdetect/js/swfdetect.js": {

3529

"name": "swfdetect/js/swfdetect.js",

3530

"modules": {

3531

"swfdetect": 1

3532

},

3533

"classes": {

3534

"SWFDetect": 1

3535

},

3536

"fors": {},

3537

"namespaces": {}

3538

},

3539

"tabview/js/tab.js": {

3540

"name": "tabview/js/tab.js",

3541

"modules": {},

3542

"classes": {

3543

"Tab": 1

3544

},

3545

"fors": {},

3546

"namespaces": {}

3547

},

3548

"tabview/js/tabview.js": {

3549

"name": "tabview/js/tabview.js",

3550

"modules": {

3551

"tabview": 1

3552

},

3553

"classes": {

3554

"TabView": 1

3555

},

3556

"fors": {},

3557

"namespaces": {}

3558

},

3559

"test-console/js/test-console.js": {

3560

"name": "test-console/js/test-console.js",

3561

"modules": {

3562

"test-console": 1

3563

},

3564

"classes": {

3565

"Test.Console": 1

3566

},

3567

"fors": {},

3568

"namespaces": {

3569

"Test": 1

3570

}

3571

},

3572

"test/js/ArrayAssert.js": {

3573

"name": "test/js/ArrayAssert.js",

3574

"modules": {},

3575

"classes": {

3576

"Test.ArrayAssert": 1

3577

},

3578

"fors": {},

3579

"namespaces": {

3580

"Test": 1

3581

}

3582

},

3583

"test/js/Assert.js": {

3584

"name": "test/js/Assert.js",

3585

"modules": {},

3586

"classes": {

3587

"Test.Assert": 1

3588

},

3589

"fors": {},

3590

"namespaces": {

3591

"Test": 1

3592

}

3593

},

3594

"test/js/AssertionError.js": {

3595

"name": "test/js/AssertionError.js",

3596

"modules": {},

3597

"classes": {

3598

"Test.AssertionError": 1

3599

},

3600

"fors": {},

3601

"namespaces": {

3602

"Test": 1

3603

}

3604

},

3605

"test/js/ComparisonFailure.js": {

3606

"name": "test/js/ComparisonFailure.js",

3607

"modules": {},

3608

"classes": {

3609

"Test.ComparisonFailure": 1

3610

},

3611

"fors": {},

3612

"namespaces": {

3613

"Test": 1

3614

}

3615

},

3616

"test/js/CoverageFormat.js": {

3617

"name": "test/js/CoverageFormat.js",

3618

"modules": {},

3619

"classes": {

3620

"Test.CoverageFormat": 1

3621

},

3622

"fors": {},

3623

"namespaces": {

3624

"Test": 1,

3625

"Test.CoverageFormat": 1

3626

}

3627

},

3628

"test/js/DateAssert.js": {

3629

"name": "test/js/DateAssert.js",

3630

"modules": {},

3631

"classes": {

3632

"Test.DateAssert": 1

3633

},

3634

"fors": {},

3635

"namespaces": {

3636

"Test": 1

3637

}

3638

},

3639

"test/js/EventTarget.js": {

3640

"name": "test/js/EventTarget.js",

3641

"modules": {},

3642

"classes": {

3643

"Test.EventTarget": 1

3644

},

3645

"fors": {},

3646

"namespaces": {

3647

"Test": 1

3648

}

3649

},

3650

"test/js/Mock.js": {

3651

"name": "test/js/Mock.js",

3652

"modules": {},

3653

"classes": {

3654

"Test.Mock": 1,

3655

"Test.Mock.Value": 1

3656

},

3657

"fors": {},

3658

"namespaces": {

3659

"Test": 1,

3660

"Test.Mock": 1

3661

}

3662

},

3663

"test/js/ObjectAssert.js": {

3664

"name": "test/js/ObjectAssert.js",

3665

"modules": {},

3666

"classes": {

3667

"Test.ObjectAssert": 1

3668

},

3669

"fors": {},

3670

"namespaces": {

3671

"Test": 1

3672

}

3673

},

3674

"test/js/Reporter.js": {

3675

"name": "test/js/Reporter.js",

3676

"modules": {},

3677

"classes": {

3678

"Test.Reporter": 1

3679

},

3680

"fors": {},

3681

"namespaces": {

3682

"Test": 1

3683

}

3684

},

3685

"test/js/Results.js": {

3686

"name": "test/js/Results.js",

3687

"modules": {},

3688

"classes": {

3689

"Test.Results": 1

3690

},

3691

"fors": {},

3692

"namespaces": {

3693

"Test": 1

3694

}

3695

},

3696

"test/js/ShouldError.js": {

3697

"name": "test/js/ShouldError.js",

3698

"modules": {},

3699

"classes": {

3700

"Test.ShouldError": 1

3701

},

3702

"fors": {},

3703

"namespaces": {

3704

"Test": 1

3705

}

3706

},

3707

"test/js/ShouldFail.js": {

3708

"name": "test/js/ShouldFail.js",

3709

"modules": {},

3710

"classes": {

3711

"Test.ShouldFail": 1

3712

},

3713

"fors": {},

3714

"namespaces": {

3715

"Test": 1

3716

}

3717

},

3718

"test/js/TestCase.js": {

3719

"name": "test/js/TestCase.js",

3720

"modules": {},

3721

"classes": {

3722

"Test.TestCase": 1

3723

},

3724

"fors": {},

3725

"namespaces": {

3726

"Test": 1

3727

}

3728

},

3729

"test/js/TestFormat.js": {

3730

"name": "test/js/TestFormat.js",

3731

"modules": {},

3732

"classes": {

3733

"Test.TestFormat": 1

3734

},

3735

"fors": {},

3736

"namespaces": {

3737

"Test": 1

3738

}

3739

},

3740

"test/js/TestRunner.js": {

3741

"name": "test/js/TestRunner.js",

3742

"modules": {},

3743

"classes": {

3744

"Test.TestRunner": 1,

3745

"Test.TestNode": 1,

3746

"Test.Runner": 1

3747

},

3748

"fors": {},

3749

"namespaces": {

3750

"Test": 1

3751

}

3752

},

3753

"test/js/TestSuite.js": {

3754

"name": "test/js/TestSuite.js",

3755

"modules": {},

3756

"classes": {

3757

"Test.TestSuite": 1

3758

},

3759

"fors": {},

3760

"namespaces": {

3761

"Test": 1

3762

}

3763

},

3764

"test/js/UnexpectedError.js": {

3765

"name": "test/js/UnexpectedError.js",

3766

"modules": {},

3767

"classes": {

3768

"Test.UnexpectedError": 1

3769

},

3770

"fors": {},

3771

"namespaces": {

3772

"Test": 1

3773

}

3774

},

3775

"test/js/UnexpectedValue.js": {

3776

"name": "test/js/UnexpectedValue.js",

3777

"modules": {},

3778

"classes": {

3779

"Test.UnexpectedValue": 1

3780

},

3781

"fors": {},

3782

"namespaces": {

3783

"Test": 1

3784

}

3785

},

3786

"test/js/Wait.js": {

3787

"name": "test/js/Wait.js",

3788

"modules": {},

3789

"classes": {

3790

"Test.Wait": 1

3791

},

3792

"fors": {},

3793

"namespaces": {

3794

"Test": 1

3795

}

3796

},

3797

"test/js/YTestWrapAfter.js": {

3798

"name": "test/js/YTestWrapAfter.js",

3799

"modules": {},

3800

"classes": {},

3801

"fors": {

3802

"YUI": 1

3803

},

3804

"namespaces": {}

3805

},

3806

"test/js/YUITest.js": {

3807

"name": "test/js/YUITest.js",

3808

"modules": {

3809

"test": 1

3810

},

3811

"classes": {},

3812

"fors": {},

3813

"namespaces": {}

3814

},

3815

"text/js/text-accentfold.js": {

3816

"name": "text/js/text-accentfold.js",

3817

"modules": {

3818

"text": 1,

3819

"text-accentfold": 1

3820

},

3821

"classes": {

3822

"Text.AccentFold": 1

3823

},

3824

"fors": {},

3825

"namespaces": {}

3826

},

3827

"text/js/text-wordbreak.js": {

3828

"name": "text/js/text-wordbreak.js",

3829

"modules": {

3830

"text-wordbreak": 1

3831

},

3832

"classes": {

3833

"Text.WordBreak": 1

3834

},

3835

"fors": {},

3836

"namespaces": {}

3837

},

3838

"transition/js/transition-native.js": {

3839

"name": "transition/js/transition-native.js",

3840

"modules": {

3841

"transition": 1

3842

},

3843

"classes": {

3844

"Transition": 1

3845

},

3846

"fors": {

3847

"Node": 1,

3848

"NodeList": 1

3849

},

3850

"namespaces": {}

3851

},

3852

"uploader-deprecated/js/uploader-deprecated.js": {

3853

"name": "uploader-deprecated/js/uploader-deprecated.js",

3854

"modules": {

3855

"uploader-deprecated": 1

3856

},

3857

"classes": {},

3858

"fors": {},

3859

"namespaces": {}

3860

},

3861

"uploader/js/uploader-flash.js": {

3862

"name": "uploader/js/uploader-flash.js",

3863

"modules": {

3864

"uploader-flash": 1

3865

},

3866

"classes": {

3867

"UploaderFlash": 1

3868

},

3869

"fors": {},

3870

"namespaces": {}

3871

},

3872

"uploader/js/uploader-html5.js": {

3873

"name": "uploader/js/uploader-html5.js",

3874

"modules": {

3875

"uploader-html5": 1

3876

},

3877

"classes": {

3878

"UploaderHTML5": 1

3879

},

3880

"fors": {},

3881

"namespaces": {}

3882

},

3883

"uploader/js/uploader-queue.js": {

3884

"name": "uploader/js/uploader-queue.js",

3885

"modules": {

3886

"uploader-queue": 1

3887

},

3888

"classes": {

3889

"Uploader.Queue": 1

3890

},

3891

"fors": {},

3892

"namespaces": {}

3893

},

3894

"uploader/js/uploader.js": {

3895

"name": "uploader/js/uploader.js",

3896

"modules": {

3897

"uploader": 1

3898

},

3899

"classes": {

3900

"Uploader": 1

3901

},

3902

"fors": {},

3903

"namespaces": {}

3904

},

3905

"widget-anim/js/WidgetAnim.js": {

3906

"name": "widget-anim/js/WidgetAnim.js",

3907

"modules": {

3908

"widget-anim": 1

3909

},

3910

"classes": {

3911

"Plugin.WidgetAnim": 1

3912

},

3913

"fors": {},

3914

"namespaces": {

3915

"Plugin": 1

3916

}

3917

},

3918

"widget-autohide/js/Widget-Autohide.js": {

3919

"name": "widget-autohide/js/Widget-Autohide.js",

3920

"modules": {

3921

"widget-autohide": 1

3922

},

3923

"classes": {

3924

"WidgetAutohide": 1

3925

},

3926

"fors": {},

3927

"namespaces": {}

3928

},

3929

"widget-buttons/js/widget-buttons.js": {

3930

"name": "widget-buttons/js/widget-buttons.js",

3931

"modules": {

3932

"widget-buttons": 1

3933

},

3934

"classes": {

3935

"WidgetButtons": 1

3936

},

3937

"fors": {},

3938

"namespaces": {}

3939

},

3940

"widget-child/js/Widget-Child.js": {

3941

"name": "widget-child/js/Widget-Child.js",

3942

"modules": {

3943

"widget-child": 1

3944

},

3945

"classes": {

3946

"WidgetChild": 1

3947

},

3948

"fors": {

3949

"Widget": 1

3950

},

3951

"namespaces": {}

3952

},

3953

"widget-modality/js/Widget-Modality.js": {

3954

"name": "widget-modality/js/Widget-Modality.js",

3955

"modules": {

3956

"widget-modality": 1

3957

},

3958

"classes": {

3959

"WidgetModality": 1

3960

},

3961

"fors": {},

3962

"namespaces": {}

3963

},

3964

"widget-parent/js/Widget-Parent.js": {

3965

"name": "widget-parent/js/Widget-Parent.js",

3966

"modules": {

3967

"widget-parent": 1

3968

},

3969

"classes": {

3970

"WidgetParent": 1

3971

},

3972

"fors": {},

3973

"namespaces": {}

3974

},

3975

"widget-position-align/js/Widget-PositionAlign.js": {

3976

"name": "widget-position-align/js/Widget-PositionAlign.js",

3977

"modules": {

3978

"widget-position-align": 1

3979

},

3980

"classes": {

3981

"WidgetPositionAlign": 1

3982

},

3983

"fors": {},

3984

"namespaces": {}

3985

},

3986

"widget-position-constrain/js/Widget-PositionConstrain.js": {

3987

"name": "widget-position-constrain/js/Widget-PositionConstrain.js",

3988

"modules": {

3989

"widget-position-constrain": 1

3990

},

3991

"classes": {

3992

"WidgetPositionConstrain": 1

3993

},

3994

"fors": {},

3995

"namespaces": {}

3996

},

3997

"widget-position/js/Widget-Position.js": {

3998

"name": "widget-position/js/Widget-Position.js",

3999

"modules": {

4000

"widget-position": 1

4001

},

4002

"classes": {

4003

"WidgetPosition": 1

4004

},

4005

"fors": {},

4006

"namespaces": {}

4007

},

4008

"widget-stack/js/Widget-Stack.js": {

4009

"name": "widget-stack/js/Widget-Stack.js",

4010

"modules": {

4011

"widget-stack": 1

4012

},

4013

"classes": {

4014

"WidgetStack": 1

4015

},

4016

"fors": {},

4017

"namespaces": {}

4018

},

4019

"widget-stdmod/js/Widget-StdMod.js": {

4020

"name": "widget-stdmod/js/Widget-StdMod.js",

4021

"modules": {

4022

"widget-stdmod": 1

4023

},

4024

"classes": {

4025

"WidgetStdMod": 1

4026

},

4027

"fors": {},

4028

"namespaces": {}

4029

},

4030

"widget/js/Widget.js": {

4031

"name": "widget/js/Widget.js",

4032

"modules": {

4033

"widget": 1,

4034

"widget-base": 1

4035

},

4036

"classes": {

4037

"Widget": 1

4038

},

4039

"fors": {},

4040

"namespaces": {}

4041

},

4042

"widget/js/WidgetBaseIE.js": {

4043

"name": "widget/js/WidgetBaseIE.js",

4044

"modules": {

4045

"widget-base-ie": 1

4046

},

4047

"classes": {},

4048

"fors": {},

4049

"namespaces": {}

4050

},

4051

"widget/js/WidgetHTMLParser.js": {

4052

"name": "widget/js/WidgetHTMLParser.js",

4053

"modules": {

4054

"widget-htmlparser": 1

4055

},

4056

"classes": {},

4057

"fors": {

4058

"Widget": 1

4059

},

4060

"namespaces": {}

4061

},

4062

"widget/js/WidgetLocale.js": {

4063

"name": "widget/js/WidgetLocale.js",

4064

"modules": {

4065

"widget-locale": 1

4066

},

4067

"classes": {},

4068

"fors": {},

4069

"namespaces": {}

4070

},

4071

"widget/js/WidgetSkin.js": {

4072

"name": "widget/js/WidgetSkin.js",

4073

"modules": {

4074

"widget-skin": 1

4075

},

4076

"classes": {},

4077

"fors": {

4078

"Widget": 1

4079

},

4080

"namespaces": {}

4081

},

4082

"widget/js/WidgetUIEvents.js": {

4083

"name": "widget/js/WidgetUIEvents.js",

4084

"modules": {

4085

"widget-uievents": 1

4086

},

4087

"classes": {},

4088

"fors": {

4089

"Widget": 1

4090

},

4091

"namespaces": {}

4092

},

4093

"yql/js/yql.js": {

4094

"name": "yql/js/yql.js",

4095

"modules": {

4096

"yql": 1

4097

},

4098

"classes": {

4099

"YQLRequest": 1,

4100

"YQL": 1

4101

},

4102

"fors": {},

4103

"namespaces": {}

4104

},

4105

"yui-throttle/js/throttle.js": {

4106

"name": "yui-throttle/js/throttle.js",

4107

"modules": {

4108

"yui-throttle": 1

4109

},

4110

"classes": {},

4111

"fors": {

4112

"YUI": 1

4113

},

4114

"namespaces": {}

4115

},

4116

"yui/js/_module.js": {

4117

"name": "yui/js/_module.js",

4118

"modules": {

4119

"yui-base": 1

4120

},

4121

"classes": {},

4122

"fors": {},

4123

"namespaces": {}

4124

},

4125

"yui/js/features.js": {

4126

"name": "yui/js/features.js",

4127

"modules": {

4128

"features": 1

4129

},

4130

"classes": {

4131

"Features": 1

4132

},

4133

"fors": {},

4134

"namespaces": {}

4135

},

4136

"yui/js/intl-base.js": {

4137

"name": "yui/js/intl-base.js",

4138

"modules": {},

4139

"classes": {

4140

"Intl": 1

4141

},

4142

"fors": {},

4143

"namespaces": {}

4144

},

4145

"yui/js/queue-base.js": {

4146

"name": "yui/js/queue-base.js",

4147

"modules": {},

4148

"classes": {

4149

"Queue": 1

4150

},

4151

"fors": {},

4152

"namespaces": {}

4153

},

4154

"yui/js/yui-array.js": {

4155

"name": "yui/js/yui-array.js",

4156

"modules": {},

4157

"classes": {

4158

"Array": 1

4159

},

4160

"fors": {},

4161

"namespaces": {}

4162

},

4163

"yui/js/yui-core.js": {

4164

"name": "yui/js/yui-core.js",

4165

"modules": {},

4166

"classes": {},

4167

"fors": {

4168

"YUI": 1

4169

},

4170

"namespaces": {}

4171

},

4172

"yui/js/yui-lang.js": {

4173

"name": "yui/js/yui-lang.js",

4174

"modules": {},

4175

"classes": {

4176

"Lang": 1

4177

},

4178

"fors": {},

4179

"namespaces": {}

4180

},

4181

"yui/js/yui-later.js": {

4182

"name": "yui/js/yui-later.js",

4183

"modules": {

4184

"yui-later": 1

4185

},

4186

"classes": {},

4187

"fors": {

4188

"YUI": 1

4189

},

4190

"namespaces": {}

4191

},

4192

"yui/js/yui-log.js": {

4193

"name": "yui/js/yui-log.js",

4194

"modules": {

4195

"yui-log": 1

4196

},

4197

"classes": {},

4198

"fors": {

4199

"YUI": 1

4200

},

4201

"namespaces": {}

4202

},

4203

"yui/js/yui-object.js": {

4204

"name": "yui/js/yui-object.js",

4205

"modules": {},

4206

"classes": {

4207

"Object": 1

4208

},

4209

"fors": {},

4210

"namespaces": {}

4211

},

4212

"yui/js/yui-ua.js": {

4213

"name": "yui/js/yui-ua.js",

4214

"modules": {},

4215

"classes": {

4216

"UA": 1

4217

},

4218

"fors": {},

4219

"namespaces": {}

4220

},

4221

"yui/js/yui.js": {

4222

"name": "yui/js/yui.js",

4223

"modules": {},

4224

"classes": {

4225

"YUI": 1,

4226

"config": 1

4227

},

4228

"fors": {},

4229

"namespaces": {}

4230

}

4231

},

4232

"modules": {

4233

"anim": {

4234

"name": "anim",

4235

"submodules": {

4236

"anim-color": 1,

4237

"anim-curve": 1,

4238

"anim-easing": 1,

4239

"anim-node-plugin": 1,

4240

"anim-scroll": 1,

4241

"anim-shape-transform": 1,

4242

"anim-xy": 1,

4243

"anim-base": 1

4244

},

4245

"classes": {

4246

"Anim": 1,

4247

"Easing": 1,

4248

"Plugin.NodeFX": 1

4249

},

4250

"fors": {

4251

"Anim": 1,

4252

"Easing": 1

4253

},

4254

"namespaces": {},

4255

"tag": "module",

4256

"file": "anim/js/anim-node-plugin.js",

4257

"line": 1,

4258

"description": "The Animation Utility provides an API for creating advanced transitions.",

4259

"extra": {

4260

"selleck": {

4261

"name": "anim",

4262

"displayName": "Anim",

4263

"description": "The Animation Utility allows properties to animate the transition between values.",

4264

"author": "msweeney",

4265

"tags": [

4266

"utility",

4267

"anim"

4268

],

4269

"use": [

4270

"anim"

4271

]

4272

}

4273

}

4274

},

4275

"anim-color": {

4276

"name": "anim-color",

4277

"submodules": {},

4278

"classes": {},

4279

"fors": {},

4280

"is_submodule": 1,

4281

"namespaces": {},

4282

"module": "anim",

4283

"namespace": "",

4284

"file": "anim/js/anim-color.js",

4285

"line": 1,

4286

"description": "Adds support for color properties in <code>to</code>\nand <code>from</code> attributes.",

4287

"extra": {

4288

"selleck": {

4289

"name": "anim",

4290

"displayName": "Anim",

4291

"description": "The Animation Utility allows properties to animate the transition between values.",

4292

"author": "msweeney",

4293

"tags": [

4294

"utility",

4295

"anim"

4296

],

4297

"use": [

4298

"anim"

4299

]

4300

}

4301

}

4302

},

4303

"anim-curve": {

4304

"name": "anim-curve",

4305

"submodules": {},

4306

"classes": {},

4307

"fors": {},

4308

"is_submodule": 1,

4309

"namespaces": {},

4310

"module": "anim",

4311

"namespace": "",

4312

"file": "anim/js/anim-curve.js",

4313

"line": 1,

4314

"description": "Adds support for the <code>curve</code> property for the <code>to</code> \nattribute. A curve is zero or more control points and an end point.",

4315

"extra": {

4316

"selleck": {

4317

"name": "anim",

4318

"displayName": "Anim",

4319

"description": "The Animation Utility allows properties to animate the transition between values.",

4320

"author": "msweeney",

4321

"tags": [

4322

"utility",

4323

"anim"

4324

],

4325

"use": [

4326

"anim"

4327

]

4328

}

4329

}

4330

},

4331

"anim-easing": {

4332

"name": "anim-easing",

4333

"submodules": {},

4334

"classes": {

4335

"Easing": 1

4336

},

4337

"fors": {},

4338

"is_submodule": 1,

4339

"namespaces": {},

4340

"module": "anim",

4341

"namespace": "",

4342

"description": "The easing module provides methods for customizing\nhow an animation behaves during each run.",

4343

"file": "anim/js/anim-easing.js",

4344

"line": 15

4345

},

4346

"anim-node-plugin": {

4347

"name": "anim-node-plugin",

4348

"submodules": {},

4349

"classes": {

4350

"Plugin.NodeFX": 1

4351

},

4352

"fors": {},

4353

"is_submodule": 1,

4354

"namespaces": {},

4355

"module": "anim",

4356

"namespace": "",

4357

"description": "Binds an Anim instance to a Node instance",

4358

"file": "anim/js/anim-node-plugin.js",

4359

"line": 1

4360

},

4361

"anim-scroll": {

4362

"name": "anim-scroll",

4363

"submodules": {},

4364

"classes": {},

4365

"fors": {},

4366

"is_submodule": 1,

4367

"namespaces": {},

4368

"module": "anim",

4369

"namespace": "",

4370

"file": "anim/js/anim-scroll.js",

4371

"line": 1,

4372

"description": "Adds support for the <code>scroll</code> property in <code>to</code>\nand <code>from</code> attributes.",

4373

"extra": {

4374

"selleck": {

4375

"name": "anim",

4376

"displayName": "Anim",

4377

"description": "The Animation Utility allows properties to animate the transition between values.",

4378

"author": "msweeney",

4379

"tags": [

4380

"utility",

4381

"anim"

4382

],

4383

"use": [

4384

"anim"

4385

]

4386

}

4387

}

4388

},

4389

"anim-shape-transform": {

4390

"name": "anim-shape-transform",

4391

"submodules": {},

4392

"classes": {},

4393

"fors": {},

4394

"is_submodule": 1,

4395

"namespaces": {},

4396

"module": "anim",

4397

"namespace": "",

4398

"file": "anim/js/anim-shape-transform.js",

4399

"line": 1,

4400

"description": "Adds support for the <code>transform</code> attribute of <code>Graphic</code>\n<code>Shape</code> instances.",

4401

"extra": {

4402

"selleck": {

4403

"name": "anim",

4404

"displayName": "Anim",

4405

"description": "The Animation Utility allows properties to animate the transition between values.",

4406

"author": "msweeney",

4407

"tags": [

4408

"utility",

4409

"anim"

4410

],

4411

"use": [

4412

"anim"

4413

]

4414

}

4415

}

4416

},

4417

"anim-xy": {

4418

"name": "anim-xy",

4419

"submodules": {},

4420

"classes": {},

4421

"fors": {},

4422

"is_submodule": 1,

4423

"namespaces": {},

4424

"module": "anim",

4425

"namespace": "",

4426

"file": "anim/js/anim-xy.js",

4427

"line": 1,

4428

"description": "Adds support for the <code>xy</code> property in <code>from</code> and \n<code>to</code> attributes.",

4429

"extra": {

4430

"selleck": {

4431

"name": "anim",

4432

"displayName": "Anim",

4433

"description": "The Animation Utility allows properties to animate the transition between values.",

4434

"author": "msweeney",

4435

"tags": [

4436

"utility",

4437

"anim"

4438

],

4439

"use": [

4440

"anim"

4441

]

4442

}

4443

}

4444

},

4445

"anim-base": {

4446

"name": "anim-base",

4447

"submodules": {},

4448

"classes": {

4449

"Anim": 1

4450

},

4451

"fors": {},

4452

"is_submodule": 1,

4453

"namespaces": {},

4454

"module": "anim",

4455

"namespace": "",

4456

"file": "anim/js/anim.js",

4457

"line": 13,

4458

"description": "Provides the base Anim class, for animating numeric properties.",

4459

"extra": {

4460

"selleck": {

4461

"name": "anim",

4462

"displayName": "Anim",

4463

"description": "The Animation Utility allows properties to animate the transition between values.",

4464

"author": "msweeney",

4465

"tags": [

4466

"utility",

4467

"anim"

4468

],

4469

"use": [

4470

"anim"

4471

]

4472

}

4473

}

4474

},

4475

"app": {

4476

"name": "app",

4477

"submodules": {

4478

"app-transitions-native": 1,

4479

"app-transitions": 1,

4480

"view-node-map": 1,

4481

"app-base": 1,

4482

"model-list": 1,

4483

"model": 1,

4484

"router": 1,

4485

"view": 1

4486

},

4487

"classes": {

4488

"App.TransitionsNative": 1,

4489

"App.Transitions": 1,

4490

"View.NodeMap": 1,

4491

"App.Base": 1,

4492

"App": 1,

4493

"ModelList": 1,

4494

"Model": 1,

4495

"Router": 1,

4496

"Controller": 1,

4497

"View": 1

4498

},

4499

"fors": {},

4500

"namespaces": {},

4501

"file": "app/js/view.js",

4502

"line": 11,

4503

"description": "The App Framework provides simple MVC-like building blocks (models, model lists,\nviews, and URL-based routing) for writing single-page JavaScript applications.",

4504

"tag": "main",

4505

"itemtype": "main",

4506

"since": "3.4.0"

4507

},

4508

"app-transitions-native": {

4509

"name": "app-transitions-native",

4510

"submodules": {},

4511

"classes": {

4512

"App.TransitionsNative": 1

4513

},

4514

"fors": {},

4515

"is_submodule": 1,

4516

"namespaces": {},

4517

"module": "app",

4518

"namespace": "",

4519

"file": "app/js/app-extensions/app-transitions-native.js",

4520

"line": 12,

4521

"description": "Provides the implementation of view transitions for `Y.App.Transitions` in\nbrowsers which support native CSS3 transitions.",

4522

"since": "3.5.0"

4523

},

4524

"app-transitions": {

4525

"name": "app-transitions",

4526

"submodules": {},

4527

"classes": {

4528

"App.Transitions": 1

4529

},

4530

"fors": {},

4531

"is_submodule": 1,

4532

"namespaces": {},

4533

"module": "app",

4534

"namespace": "",

4535

"file": "app/js/app-extensions/app-transitions.js",

4536

"line": 10,

4537

"description": "Provides view transitions for `Y.App` in browsers which support native CSS3\ntransitions.",

4538

"since": "3.5.0"

4539

},

4540

"view-node-map": {

4541

"name": "view-node-map",

4542

"submodules": {},

4543

"classes": {

4544

"View.NodeMap": 1

4545

},

4546

"fors": {},

4547

"is_submodule": 1,

4548

"namespaces": {},

4549

"module": "app",

4550

"namespace": "",

4551

"file": "app/js/view-extensions/view-node-map.js",

4552

"line": 14,

4553

"description": "View extension that adds a static `getByNode()` method that returns the nearest\nView instance associated with the given Node (similar to Widget's `getByNode()`\nmethod).",

4554

"since": "3.5.0"

4555

},

4556

"app-base": {

4557

"name": "app-base",

4558

"submodules": {},

4559

"classes": {

4560

"App.Base": 1,

4561

"App": 1

4562

},

4563

"fors": {},

4564

"is_submodule": 1,

4565

"namespaces": {},

4566

"module": "app",

4567

"namespace": "",

4568

"file": "app/js/app-base.js",

4569

"line": 1100,

4570

"description": "Provides a top-level application component which manages navigation and views.",

4571

"since": "3.5.0"

4572

},

4573

"model-list": {

4574

"name": "model-list",

4575

"submodules": {},

4576

"classes": {

4577

"ModelList": 1

4578

},

4579

"fors": {},

4580

"is_submodule": 1,

4581

"namespaces": {},

4582

"module": "app",

4583

"namespace": "",

4584

"file": "app/js/model-list.js",

4585

"line": 9,

4586

"description": "Provides an API for managing an ordered list of Model instances.",

4587

"since": "3.4.0"

4588

},

4589

"model": {

4590

"name": "model",

4591

"submodules": {},

4592

"classes": {

4593

"Model": 1

4594

},

4595

"fors": {},

4596

"is_submodule": 1,

4597

"namespaces": {},

4598

"module": "app",

4599

"namespace": "",

4600

"file": "app/js/model.js",

4601

"line": 10,

4602

"description": "Attribute-based data model with APIs for getting, setting, validating, and\nsyncing attribute values, as well as events for being notified of model changes.",

4603

"since": "3.4.0"

4604

},

4605

"router": {

4606

"name": "router",

4607

"submodules": {},

4608

"classes": {

4609

"Router": 1,

4610

"Controller": 1

4611

},

4612

"fors": {},

4613

"is_submodule": 1,

4614

"namespaces": {},

4615

"module": "app",

4616

"namespace": "",

4617

"file": "app/js/router.js",

4618

"line": 1057,

4619

"description": "Provides URL-based routing using HTML5 `pushState()` or the location hash.",

4620

"since": "3.4.0"

4621

},

4622

"view": {

4623

"name": "view",

4624

"submodules": {},

4625

"classes": {

4626

"View": 1

4627

},

4628

"fors": {},

4629

"is_submodule": 1,

4630

"namespaces": {},

4631

"module": "app",

4632

"namespace": "",

4633

"file": "app/js/view.js",

4634

"line": 11,

4635

"description": "Represents a logical piece of an application's user interface, and provides a\nlightweight, overridable API for rendering content and handling delegated DOM\nevents on a container element.",

4636

"since": "3.4.0"

4637

},

4638

"arraysort": {

4639

"name": "arraysort",

4640

"submodules": {},

4641

"classes": {

4642

"ArraySort": 1

4643

},

4644

"fors": {},

4645

"namespaces": {},

4646

"tag": "module",

4647

"file": "arraysort/js/arraysort.js",

4648

"line": 11,

4649

"description": "Provides a case-insenstive comparator which can be used for array sorting."

4650

},

4651

"async-queue": {

4652

"name": "async-queue",

4653

"submodules": {},

4654

"classes": {

4655

"AsyncQueue": 1

4656

},

4657

"fors": {},

4658

"namespaces": {},

4659

"tag": "module",

4660

"file": "async-queue/js/async-queue.js",

4661

"line": 11,

4662

"description": "AsyncQueue allows you create a chain of function callbacks executed\nvia setTimeout (or synchronously) that are guaranteed to run in order.\nItems in the queue can be promoted or removed. Start or resume the\nexecution chain with run(). pause() to temporarily delay execution, or\nstop() to halt and clear the queue.",

4663

"extra": {

4664

"selleck": {

4665

"name": "async-queue",

4666

"displayName": "AsyncQueue",

4667

"description": "Executes a queue of functions asynchronously.",

4668

"author": "lsmith",

4669

"tags": [

4670

"utility",

4671

"async-queue",

4672

"queue"

4673

],

4674

"use": [

4675

"async-queue"

4676

]

4677

}

4678

}

4679

},

4680

"attribute": {

4681

"name": "attribute",

4682

"submodules": {

4683

"attribute-base": 1,

4684

"attribute-core": 1,

4685

"attribute-events": 1,

4686

"attribute-extras": 1,

4687

"attribute-complex": 1

4688

},

4689

"classes": {

4690

"Attribute": 1,

4691

"AttributeCore": 1,

4692

"AttributeEvents": 1,

4693

"AttributeExtras": 1,

4694

"State": 1

4695

},

4696

"fors": {

4697

"Attribute": 1

4698

},

4699

"namespaces": {},

4700

"tag": "module",

4701

"file": "attribute/js/State.js",

4702

"line": 1,

4703

"description": "The attribute module provides an augmentable Attribute implementation, which \nadds configurable attributes and attribute change events to the class being \naugmented. It also provides a State class, which is used internally by Attribute,\nbut can also be used independently to provide a name/property/value data structure to\nstore state.",

4704

"extra": {

4705

"selleck": {

4706

"name": "attribute",

4707

"displayName": "Attribute",

4708

"description": "The Attribute utility allows you to add attributes to any class through an augmentable Attribute interface. The interface adds get and set methods to your class to retrieve and store attribute values, as well as support for change events that can be used to listen for changes in attribute values.",

4709

"author": "sdesai",

4710

"tags": [

4711

"attribute",

4712

"infrastructure"

4713

],

4714

"use": [

4715

"attribute"

4716

]

4717

}

4718

}

4719

},

4720

"attribute-base": {

4721

"name": "attribute-base",

4722

"submodules": {},

4723

"classes": {

4724

"Attribute": 1

4725

},

4726

"fors": {},

4727

"is_submodule": 1,

4728

"namespaces": {},

4729

"module": "attribute",

4730

"namespace": "",

4731

"file": "attribute/js/Attribute.js",

4732

"line": 19,

4733

"description": "The attribute-base submodule provides core attribute handling support, with everything\naside from complex attribute handling in the provider's constructor.",

4734

"extra": {

4735

"selleck": {

4736

"name": "attribute",

4737

"displayName": "Attribute",

4738

"description": "The Attribute utility allows you to add attributes to any class through an augmentable Attribute interface. The interface adds get and set methods to your class to retrieve and store attribute values, as well as support for change events that can be used to listen for changes in attribute values.",

4739

"author": "sdesai",

4740

"tags": [

4741

"attribute",

4742

"infrastructure"

4743

],

4744

"use": [

4745

"attribute"

4746

]

4747

}

4748

}

4749

},

4750

"attribute-core": {

4751

"name": "attribute-core",

4752

"submodules": {},

4753

"classes": {

4754

"AttributeCore": 1

4755

},

4756

"fors": {},

4757

"is_submodule": 1,

4758

"namespaces": {},

4759

"module": "attribute",

4760

"namespace": "",

4761

"file": "attribute/js/AttributeCore.js",

4762

"line": 45,

4763

"description": "The attribute-core submodule provides the lightest level of attribute handling support \nwithout Attribute change events, or lesser used methods such as reset(), modifyAttrs(),\nand removeAttr().",

4764

"extra": {

4765

"selleck": {

4766

"name": "attribute",

4767

"displayName": "Attribute",

4768

"description": "The Attribute utility allows you to add attributes to any class through an augmentable Attribute interface. The interface adds get and set methods to your class to retrieve and store attribute values, as well as support for change events that can be used to listen for changes in attribute values.",

4769

"author": "sdesai",

4770

"tags": [

4771

"attribute",

4772

"infrastructure"

4773

],

4774

"use": [

4775

"attribute"

4776

]

4777

}

4778

}

4779

},

4780

"attribute-events": {

4781

"name": "attribute-events",

4782

"submodules": {},

4783

"classes": {

4784

"AttributeEvents": 1

4785

},

4786

"fors": {},

4787

"is_submodule": 1,

4788

"namespaces": {},

4789

"module": "attribute",

4790

"namespace": "",

4791

"file": "attribute/js/AttributeEvents.js",

4792

"line": 24,

4793

"description": "The attribute-events submodule provides augmentable attribute change event support \nfor AttributeCore based implementations.",

4794

"extra": {

4795

"selleck": {

4796

"name": "attribute",

4797

"displayName": "Attribute",

4798

"description": "The Attribute utility allows you to add attributes to any class through an augmentable Attribute interface. The interface adds get and set methods to your class to retrieve and store attribute values, as well as support for change events that can be used to listen for changes in attribute values.",

4799

"author": "sdesai",

4800

"tags": [

4801

"attribute",

4802

"infrastructure"

4803

],

4804

"use": [

4805

"attribute"

4806

]

4807

}

4808

}

4809

},

4810

"attribute-extras": {

4811

"name": "attribute-extras",

4812

"submodules": {},

4813

"classes": {

4814

"AttributeExtras": 1

4815

},

4816

"fors": {},

4817

"is_submodule": 1,

4818

"namespaces": {},

4819

"module": "attribute",

4820

"namespace": "",

4821

"file": "attribute/js/AttributeExtras.js",

4822

"line": 29,

4823

"description": "The attribute-extras submodule provides less commonly used attribute methods, and can \nbe augmented/mixed into an implemention which used attribute-core.",

4824

"extra": {

4825

"selleck": {

4826

"name": "attribute",

4827

"displayName": "Attribute",

4828

"description": "The Attribute utility allows you to add attributes to any class through an augmentable Attribute interface. The interface adds get and set methods to your class to retrieve and store attribute values, as well as support for change events that can be used to listen for changes in attribute values.",

4829

"author": "sdesai",

4830

"tags": [

4831

"attribute",

4832

"infrastructure"

4833

],

4834

"use": [

4835

"attribute"

4836

]

4837

}

4838

}

4839

},

4840

"attribute-complex": {

4841

"name": "attribute-complex",

4842

"submodules": {},

4843

"classes": {},

4844

"fors": {},

4845

"is_submodule": 1,

4846

"namespaces": {},

4847

"module": "attribute",

4848

"namespace": "",

4849

"file": "attribute/js/ComplexAttribute.js",

4850

"line": 1,

4851

"description": "Adds support for attribute providers to handle complex attributes in the constructor",

4852

"extra": {

4853

"selleck": {

4854

"name": "attribute",

4855

"displayName": "Attribute",

4856

"description": "The Attribute utility allows you to add attributes to any class through an augmentable Attribute interface. The interface adds get and set methods to your class to retrieve and store attribute values, as well as support for change events that can be used to listen for changes in attribute values.",

4857

"author": "sdesai",

4858

"tags": [

4859

"attribute",

4860

"infrastructure"

4861

],

4862

"use": [

4863

"attribute"

4864

]

4865

}

4866

}

4867

},

4868

"autocomplete": {

4869

"name": "autocomplete",

4870

"submodules": {

4871

"autocomplete-base": 1,

4872

"autocomplete-filters-accentfold": 1,

4873

"autocomplete-filters": 1,

4874

"autocomplete-highlighters-accentfold": 1,

4875

"autocomplete-highlighters": 1,

4876

"autocomplete-list-keys": 1,

4877

"autocomplete-list": 1,

4878

"autocomplete-plugin": 1,

4879

"autocomplete-sources": 1

4880

},

4881

"classes": {

4882

"AutoCompleteBase": 1,

4883

"AutoCompleteFilters": 1,

4884

"AutoCompleteHighlighters": 1,

4885

"AutoCompleteList": 1,

4886

"AutoComplete": 1,

4887

"Plugin.AutoComplete": 1

4888

},

4889

"fors": {

4890

"AutoCompleteList": 1,

4891

"AutoCompleteBase": 1

4892

},

4893

"namespaces": {},

4894

"tag": "main",

4895

"file": "autocomplete/js/autocomplete-plugin.js",

4896

"line": 8,

4897

"description": "Provides automatic input completion or suggestions for text input fields and\ntextareas.",

4898

"itemtype": "main",

4899

"extra": {

4900

"selleck": {

4901

"name": "autocomplete",

4902

"displayName": "AutoComplete",

4903

"description": "Provides automatic input completion or suggestions for text input fields and textareas.",

4904

"author": "rgrove",

4905

"tags": [

4906

"widget",

4907

"autocomplete"

4908

],

4909

"use": [

4910

"autocomplete"

4911

]

4912

}

4913

}

4914

},

4915

"autocomplete-base": {

4916

"name": "autocomplete-base",

4917

"submodules": {},

4918

"classes": {

4919

"AutoCompleteBase": 1

4920

},

4921

"fors": {},

4922

"is_submodule": 1,

4923

"namespaces": {},

4924

"module": "autocomplete",

4925

"namespace": "",

4926

"file": "autocomplete/js/autocomplete-base.js",

4927

"line": 19,

4928

"description": "`Y.Base` extension that provides core autocomplete logic (but no UI\nimplementation) for a text input field or textarea. Must be mixed into a\n`Y.Base`-derived class to be useful.",

4929

"extra": {

4930

"selleck": {

4931

"name": "autocomplete",

4932

"displayName": "AutoComplete",

4933

"description": "Provides automatic input completion or suggestions for text input fields and textareas.",

4934

"author": "rgrove",

4935

"tags": [

4936

"widget",

4937

"autocomplete"

4938

],

4939

"use": [

4940

"autocomplete"

4941

]

4942

}

4943

}

4944

},

4945

"autocomplete-filters-accentfold": {

4946

"name": "autocomplete-filters-accentfold",

4947

"submodules": {},

4948

"classes": {},

4949

"fors": {},

4950

"is_submodule": 1,

4951

"namespaces": {},

4952

"module": "autocomplete",

4953

"namespace": "",

4954

"file": "autocomplete/js/autocomplete-filters-accentfold.js",

4955

"line": 1,

4956

"description": "Provides pre-built accent-folding result matching filters for AutoComplete.\n\nThese filters are similar to the ones provided by the `autocomplete-filters`\nmodule, but use accent-aware comparisons. For example, \"resume\" and \"résumé\"\nwill be considered equal when using the accent-folding filters.",

4957

"extra": {

4958

"selleck": {

4959

"name": "autocomplete",

4960

"displayName": "AutoComplete",

4961

"description": "Provides automatic input completion or suggestions for text input fields and textareas.",

4962

"author": "rgrove",

4963

"tags": [

4964

"widget",

4965

"autocomplete"

4966

],

4967

"use": [

4968

"autocomplete"

4969

]

4970

}

4971

}

4972

},

4973

"autocomplete-filters": {

4974

"name": "autocomplete-filters",

4975

"submodules": {},

4976

"classes": {

4977

"AutoCompleteFilters": 1

4978

},

4979

"fors": {},

4980

"is_submodule": 1,

4981

"namespaces": {},

4982

"module": "autocomplete",

4983

"namespace": "",

4984

"file": "autocomplete/js/autocomplete-filters.js",

4985

"line": 1,

4986

"description": "Provides pre-built result matching filters for AutoComplete.",

4987

"static": 1,

4988

"extra": {

4989

"selleck": {

4990

"name": "autocomplete",

4991

"displayName": "AutoComplete",

4992

"description": "Provides automatic input completion or suggestions for text input fields and textareas.",

4993

"author": "rgrove",

4994

"tags": [

4995

"widget",

4996

"autocomplete"

4997

],

4998

"use": [

4999

"autocomplete"

5000

]

5001

}

5002

}

5003

},

5004

"autocomplete-highlighters-accentfold": {

5005

"name": "autocomplete-highlighters-accentfold",

5006

"submodules": {},

5007

"classes": {},

5008

"fors": {},

5009

"is_submodule": 1,

5010

"namespaces": {},

5011

"module": "autocomplete",

5012

"namespace": "",

5013

"file": "autocomplete/js/autocomplete-highlighters-accentfold.js",

5014

"line": 1,

5015

"description": "Provides pre-built accent-folding result highlighters for AutoComplete.\n\nThese highlighters are similar to the ones provided by the `autocomplete-\nhighlighters` module, but use accent-aware comparisons. For example, \"resume\"\nand \"résumé\" will be considered equal when using the accent-folding\nhighlighters.",

5016

"extra": {

5017

"selleck": {

5018

"name": "autocomplete",

5019

"displayName": "AutoComplete",

5020

"description": "Provides automatic input completion or suggestions for text input fields and textareas.",

5021

"author": "rgrove",

5022

"tags": [

5023

"widget",

5024

"autocomplete"

5025

],

5026

"use": [

5027

"autocomplete"

5028

]

5029

}

5030

}

5031

},

5032

"autocomplete-highlighters": {

5033

"name": "autocomplete-highlighters",

5034

"submodules": {},

5035

"classes": {

5036

"AutoCompleteHighlighters": 1

5037

},

5038

"fors": {},

5039

"is_submodule": 1,

5040

"namespaces": {},

5041

"module": "autocomplete",

5042

"namespace": "",

5043

"file": "autocomplete/js/autocomplete-highlighters.js",

5044

"line": 1,

5045

"description": "Provides pre-built result highlighters for AutoComplete.",

5046

"static": 1,

5047

"extra": {

5048

"selleck": {

5049

"name": "autocomplete",

5050

"displayName": "AutoComplete",

5051

"description": "Provides automatic input completion or suggestions for text input fields and textareas.",

5052

"author": "rgrove",

5053

"tags": [

5054

"widget",

5055

"autocomplete"

5056

],

5057

"use": [

5058

"autocomplete"

5059

]

5060

}

5061

}

5062

},

5063

"autocomplete-list-keys": {

5064

"name": "autocomplete-list-keys",

5065

"submodules": {},

5066

"classes": {},

5067

"fors": {},

5068

"is_submodule": 1,

5069

"namespaces": {},

5070

"module": "autocomplete",

5071

"namespace": "",

5072

"file": "autocomplete/js/autocomplete-list-keys.js",

5073

"line": 1,

5074

"description": "Mixes keyboard support into AutoCompleteList. By default, this module is not\nloaded for iOS and Android devices.",

5075

"extra": {

5076

"selleck": {

5077

"name": "autocomplete",

5078

"displayName": "AutoComplete",

5079

"description": "Provides automatic input completion or suggestions for text input fields and textareas.",

5080

"author": "rgrove",

5081

"tags": [

5082

"widget",

5083

"autocomplete"

5084

],

5085

"use": [

5086

"autocomplete"

5087

]

5088

}

5089

}

5090

},

5091

"autocomplete-list": {

5092

"name": "autocomplete-list",

5093

"submodules": {},

5094

"classes": {

5095

"AutoCompleteList": 1,

5096

"AutoComplete": 1

5097

},

5098

"fors": {},

5099

"is_submodule": 1,

5100

"namespaces": {},

5101

"module": "autocomplete",

5102

"namespace": "",

5103

"file": "autocomplete/js/autocomplete-list.js",

5104

"line": 875,

5105

"description": "Traditional autocomplete dropdown list widget, just like Mom used to make.",

5106

"extra": {

5107

"selleck": {

5108

"name": "autocomplete",

5109

"displayName": "AutoComplete",

5110

"description": "Provides automatic input completion or suggestions for text input fields and textareas.",

5111

"author": "rgrove",

5112

"tags": [

5113

"widget",

5114

"autocomplete"

5115

],

5116

"use": [

5117

"autocomplete"

5118

]

5119

}

5120

}

5121

},

5122

"autocomplete-plugin": {

5123

"name": "autocomplete-plugin",

5124

"submodules": {},

5125

"classes": {

5126

"Plugin.AutoComplete": 1

5127

},

5128

"fors": {},

5129

"is_submodule": 1,

5130

"namespaces": {},

5131

"module": "autocomplete",

5132

"namespace": "",

5133

"file": "autocomplete/js/autocomplete-plugin.js",

5134

"line": 8,

5135

"description": "Binds an AutoCompleteList instance to a Node instance.",

5136

"extra": {

5137

"selleck": {

5138

"name": "autocomplete",

5139

"displayName": "AutoComplete",

5140

"description": "Provides automatic input completion or suggestions for text input fields and textareas.",

5141

"author": "rgrove",

5142

"tags": [

5143

"widget",

5144

"autocomplete"

5145

],

5146

"use": [

5147

"autocomplete"

5148

]

5149

}

5150

}

5151

},

5152

"autocomplete-sources": {

5153

"name": "autocomplete-sources",

5154

"submodules": {},

5155

"classes": {},

5156

"fors": {},

5157

"is_submodule": 1,

5158

"namespaces": {},

5159

"module": "autocomplete",

5160

"namespace": "",

5161

"file": "autocomplete/js/autocomplete-sources.js",

5162

"line": 1,

5163

"description": "Mixes support for JSONP and YQL result sources into AutoCompleteBase.",

5164

"extra": {

5165

"selleck": {

5166

"name": "autocomplete",

5167

"displayName": "AutoComplete",

5168

"description": "Provides automatic input completion or suggestions for text input fields and textareas.",

5169

"author": "rgrove",

5170

"tags": [

5171

"widget",

5172

"autocomplete"

5173

],

5174

"use": [

5175

"autocomplete"

5176

]

5177

}

5178

}

5179

},

5180

"base": {

5181

"name": "base",

5182

"submodules": {

5183

"base-base": 1,

5184

"base-build": 1,

5185

"base-core": 1,

5186

"base-pluginhost": 1

5187

},

5188

"classes": {

5189

"Base": 1,

5190

"BaseCore": 1

5191

},

5192

"fors": {

5193

"Base": 1

5194

},

5195

"namespaces": {},

5196

"tag": "module",

5197

"file": "base/js/BaseCore.js",

5198

"line": 42,

5199

"description": "The base module provides the Base class, which objects requiring attribute and custom event support can extend. \nThe module also provides two ways to reuse code - It augments Base with the Plugin.Host interface which provides \nplugin support and also provides the BaseCore.build method which provides a way to build custom classes using extensions.",

5200

"extra": {

5201

"selleck": {

5202

"name": "base",

5203

"displayName": "Base",

5204

"description": "Base is designed to be a low-level foundation class from which other attribute- and event target-based classes in the YUI library can be derived.",

5205

"author": "sdesai",

5206

"tags": [

5207

"base",

5208

"infrastructure"

5209

],

5210

"use": [

5211

"base"

5212

]

5213

}

5214

}

5215

},

5216

"base-base": {

5217

"name": "base-base",

5218

"submodules": {},

5219

"classes": {

5220

"Base": 1

5221

},

5222

"fors": {},

5223

"is_submodule": 1,

5224

"namespaces": {},

5225

"module": "base",

5226

"namespace": "",

5227

"file": "base/js/Base.js",

5228

"line": 44,

5229

"description": "The base-base submodule provides the Base class without the Plugin support, provided by Plugin.Host, \nand without the extension support provided by BaseCore.build.",

5230

"extra": {

5231

"selleck": {

5232

"name": "base",

5233

"displayName": "Base",

5234

"description": "Base is designed to be a low-level foundation class from which other attribute- and event target-based classes in the YUI library can be derived.",

5235

"author": "sdesai",

5236

"tags": [

5237

"base",

5238

"infrastructure"

5239

],

5240

"use": [

5241

"base"

5242

]

5243

}

5244

}

5245

},

5246

"base-build": {

5247

"name": "base-build",

5248

"submodules": {},

5249

"classes": {},

5250

"fors": {},

5251

"is_submodule": 1,

5252

"namespaces": {},

5253

"module": "base",

5254

"namespace": "",

5255

"file": "base/js/BaseBuild.js",

5256

"line": 1,

5257

"description": "The base-build submodule provides Base.build functionality, which\ncan be used to create custom classes, by aggregating extensions onto \na main class.",

5258

"extra": {

5259

"selleck": {

5260

"name": "base",

5261

"displayName": "Base",

5262

"description": "Base is designed to be a low-level foundation class from which other attribute- and event target-based classes in the YUI library can be derived.",

5263

"author": "sdesai",

5264

"tags": [

5265

"base",

5266

"infrastructure"

5267

],

5268

"use": [

5269

"base"

5270

]

5271

}

5272

}

5273

},

5274

"base-core": {

5275

"name": "base-core",

5276

"submodules": {},

5277

"classes": {

5278

"BaseCore": 1

5279

},

5280

"fors": {},

5281

"is_submodule": 1,

5282

"namespaces": {},

5283

"module": "base",

5284

"namespace": "",

5285

"file": "base/js/BaseCore.js",

5286

"line": 42,

5287

"description": "The base-core module provides the BaseCore class, the lightest version of Base, \nwhich provides Base's basic lifecycle management and ATTRS construction support, \nbut doesn't fire init/destroy or attribute change events. \n\nIt mixes in AttributeCore, which is the lightest version of Attribute",

5288

"extra": {

5289

"selleck": {

5290

"name": "base",

5291

"displayName": "Base",

5292

"description": "Base is designed to be a low-level foundation class from which other attribute- and event target-based classes in the YUI library can be derived.",

5293

"author": "sdesai",

5294

"tags": [

5295

"base",

5296

"infrastructure"

5297

],

5298

"use": [

5299

"base"

5300

]

5301

}

5302

}

5303

},

5304

"base-pluginhost": {

5305

"name": "base-pluginhost",

5306

"submodules": {},

5307

"classes": {},

5308

"fors": {},

5309

"is_submodule": 1,

5310

"namespaces": {},

5311

"module": "base",

5312

"namespace": "",

5313

"file": "base/js/BasePluginHost.js",

5314

"line": 1,

5315

"description": "The base-pluginhost submodule adds Plugin support to Base, by augmenting Base with \nPlugin.Host and setting up static (class level) Base.plug and Base.unplug methods.",

5316

"extra": {

5317

"selleck": {

5318

"name": "base",

5319

"displayName": "Base",

5320

"description": "Base is designed to be a low-level foundation class from which other attribute- and event target-based classes in the YUI library can be derived.",

5321

"author": "sdesai",

5322

"tags": [

5323

"base",

5324

"infrastructure"

5325

],

5326

"use": [

5327

"base"

5328

]

5329

}

5330

}

5331

},

5332

"button": {

5333

"name": "button",

5334

"submodules": {},

5335

"classes": {

5336

"Button": 1,

5337

"ToggleButton": 1

5338

},

5339

"fors": {},

5340

"namespaces": {},

5341

"tag": "module",

5342

"file": "button/js/button.js",

5343

"line": 142,

5344

"description": "A Button Widget",

5345

"since": "3.5.0",

5346

"extra": {

5347

"selleck": {

5348

"name": "button",

5349

"displayName": "Button",

5350

"description": "YUI's Button component is a mixed-module approach to providing a simple-to-use button that normalizes and enhances the Web browser's default button component.",

5351

"author": "drgath",

5352

"tags": [

5353

"widget",

5354

"button",

5355

"beta"

5356

],

5357

"use": [

5358

"button"

5359

]

5360

}

5361

}

5362

},

5363

"button-core": {

5364

"name": "button-core",

5365

"submodules": {},

5366

"classes": {

5367

"ButtonCore": 1

5368

},

5369

"fors": {},

5370

"namespaces": {},

5371

"tag": "module",

5372

"file": "button/js/core.js",

5373

"line": 10,

5374

"description": "Provides an interface for working with button-like DOM nodes",

5375

"since": "3.5.0",

5376

"extra": {

5377

"selleck": {

5378

"name": "button",

5379

"displayName": "Button",

5380

"description": "YUI's Button component is a mixed-module approach to providing a simple-to-use button that normalizes and enhances the Web browser's default button component.",

5381

"author": "drgath",

5382

"tags": [

5383

"widget",

5384

"button",

5385

"beta"

5386

],

5387

"use": [

5388

"button"

5389

]

5390

}

5391

}

5392

},

5393

"button-group": {

5394

"name": "button-group",

5395

"submodules": {},

5396

"classes": {

5397

"ButtonGroup": 1

5398

},

5399

"fors": {},

5400

"namespaces": {},

5401

"tag": "module",

5402

"file": "button/js/group.js",

5403

"line": 13,

5404

"description": "A Widget to create groups of buttons",

5405

"since": "3.5.0",

5406

"extra": {

5407

"selleck": {

5408

"name": "button",

5409

"displayName": "Button",

5410

"description": "YUI's Button component is a mixed-module approach to providing a simple-to-use button that normalizes and enhances the Web browser's default button component.",

5411

"author": "drgath",

5412

"tags": [

5413

"widget",

5414

"button",

5415

"beta"

5416

],

5417

"use": [

5418

"button"

5419

]

5420

}

5421

}

5422

},

5423

"button-plugin": {

5424

"name": "button-plugin",

5425

"submodules": {},

5426

"classes": {

5427

"ButtonPlugin": 1

5428

},

5429

"fors": {},

5430

"namespaces": {},

5431

"tag": "module",

5432

"file": "button/js/plugin.js",

5433

"line": 8,

5434

"description": "A Button Plugin",

5435

"since": "3.5.0",

5436

"extra": {

5437

"selleck": {

5438

"name": "button",

5439

"displayName": "Button",

5440

"description": "YUI's Button component is a mixed-module approach to providing a simple-to-use button that normalizes and enhances the Web browser's default button component.",

5441

"author": "drgath",

5442

"tags": [

5443

"widget",

5444

"button",

5445

"beta"

5446

],

5447

"use": [

5448

"button"

5449

]

5450

}

5451

}

5452

},

5453

"cache": {

5454

"name": "cache",

5455

"submodules": {

5456

"cache-base": 1,

5457

"cache-offline": 1,

5458

"cache-plugin": 1

5459

},

5460

"classes": {

5461

"Cache": 1,

5462

"CacheOffline": 1,

5463

"Plugin.Cache": 1

5464

},

5465

"fors": {},

5466

"namespaces": {},

5467

"tag": "module",

5468

"file": "cache/js/cache-plugin.js",

5469

"line": 8,

5470

"description": "The Cache utility provides a common configurable interface for components to\ncache and retrieve data from a local JavaScript struct.",

5471

"itemtype": "main",

5472

"extra": {

5473

"selleck": {

5474

"name": "cache",

5475

"displayName": "Cache",

5476

"description": "Provides a basic caching mechanism for storing key/value pairs in local JavaScript memory. As a subclass of Plugin, it is designed to seamlessly integrate with other components (such as DataSource).",

5477

"author": [

5478

"ericf"

5479

],

5480

"tags": [

5481

"utility",

5482

"cache"

5483

],

5484

"use": [

5485

"cache"

5486

]

5487

}

5488

}

5489

},

5490

"cache-base": {

5491

"name": "cache-base",

5492

"submodules": {},

5493

"classes": {

5494

"Cache": 1

5495

},

5496

"fors": {},

5497

"is_submodule": 1,

5498

"namespaces": {},

5499

"module": "cache",

5500

"namespace": "",

5501

"file": "cache/js/cache-base.js",

5502

"line": 17,

5503

"description": "Provides the base class for the YUI Cache utility.",

5504

"extra": {

5505

"selleck": {

5506

"name": "cache",

5507

"displayName": "Cache",

5508

"description": "Provides a basic caching mechanism for storing key/value pairs in local JavaScript memory. As a subclass of Plugin, it is designed to seamlessly integrate with other components (such as DataSource).",

5509

"author": [

5510

"ericf"

5511

],

5512

"tags": [

5513

"utility",

5514

"cache"

5515

],

5516

"use": [

5517

"cache"

5518

]

5519

}

5520

}

5521

},

5522

"cache-offline": {

5523

"name": "cache-offline",

5524

"submodules": {},

5525

"classes": {

5526

"CacheOffline": 1

5527

},

5528

"fors": {},

5529

"is_submodule": 1,

5530

"namespaces": {},

5531

"module": "cache",

5532

"namespace": "",

5533

"file": "cache/js/cache-offline.js",

5534

"line": 8,

5535

"description": "Provides a Cache subclass which uses HTML5 `localStorage` for persistence.",

5536

"extra": {

5537

"selleck": {

5538

"name": "cache",

5539

"displayName": "Cache",

5540

"description": "Provides a basic caching mechanism for storing key/value pairs in local JavaScript memory. As a subclass of Plugin, it is designed to seamlessly integrate with other components (such as DataSource).",

5541

"author": [

5542

"ericf"

5543

],

5544

"tags": [

5545

"utility",

5546

"cache"

5547

],

5548

"use": [

5549

"cache"

5550

]

5551

}

5552

}

5553

},

5554

"cache-plugin": {

5555

"name": "cache-plugin",

5556

"submodules": {},

5557

"classes": {

5558

"Plugin.Cache": 1

5559

},

5560

"fors": {},

5561

"is_submodule": 1,

5562

"namespaces": {},

5563

"module": "cache",

5564

"namespace": "",

5565

"file": "cache/js/cache-plugin.js",

5566

"line": 8,

5567

"description": "Provides support to use Cache as a Plugin to a Base-based class.",

5568

"extra": {

5569

"selleck": {

5570

"name": "cache",

5571

"displayName": "Cache",

5572

"description": "Provides a basic caching mechanism for storing key/value pairs in local JavaScript memory. As a subclass of Plugin, it is designed to seamlessly integrate with other components (such as DataSource).",

5573

"author": [

5574

"ericf"

5575

],

5576

"tags": [

5577

"utility",

5578

"cache"

5579

],

5580

"use": [

5581

"cache"

5582

]

5583

}

5584

}

5585

},

5586

"calendar": {

5587

"name": "calendar",

5588

"submodules": {

5589

"calendar-base": 1

5590

},

5591

"classes": {

5592

"CalendarBase": 1,

5593

"Calendar": 1

5594

},

5595

"fors": {},

5596

"namespaces": {},

5597

"tag": "module",

5598

"file": "calendar/js/calendar.js",

5599

"line": 32,

5600

"description": "The Calendar component is a UI widget that allows users\nto view dates in a two-dimensional month grid, as well as\nto select one or more dates, or ranges of dates. Calendar\nis generated dynamically and relies on the developer to\nprovide for a progressive enhancement alternative.",

5601

"extra": {

5602

"selleck": {

5603

"name": "calendar",

5604

"displayName": "Calendar",

5605

"description": "Provides an interactive visual representation of a range of dates in one or more month grids",

5606

"author": "allenr",

5607

"tags": [

5608

"beta",

5609

"widget",

5610

"calendar"

5611

],

5612

"use": [

5613

"calendar"

5614

]

5615

}

5616

}

5617

},

5618

"calendar-base": {

5619

"name": "calendar-base",

5620

"submodules": {},

5621

"classes": {

5622

"CalendarBase": 1

5623

},

5624

"fors": {},

5625

"is_submodule": 1,

5626

"namespaces": {},

5627

"module": "calendar",

5628

"namespace": "",

5629

"file": "calendar/js/calendar-base.js",

5630

"line": 43,

5631

"description": "The CalendarBase submodule is a basic UI calendar view that displays\na range of dates in a two-dimensional month grid, with one or more\nmonths visible at a single time. CalendarBase supports custom date\nrendering, multiple calendar panes, and selection.",

5632

"extra": {

5633

"selleck": {

5634

"name": "calendar",

5635

"displayName": "Calendar",

5636

"description": "Provides an interactive visual representation of a range of dates in one or more month grids",

5637

"author": "allenr",

5638

"tags": [

5639

"beta",

5640

"widget",

5641

"calendar"

5642

],

5643

"use": [

5644

"calendar"

5645

]

5646

}

5647

}

5648

},

5649

"calendarnavigator": {

5650

"name": "calendarnavigator",

5651

"submodules": {},

5652

"classes": {

5653

"Plugin.CalendarNavigator": 1

5654

},

5655

"fors": {},

5656

"namespaces": {

5657

"Plugin": 1

5658

},

5659

"tag": "module",

5660

"file": "calendar/js/calendarnavigator.js",

5661

"line": 20,

5662

"description": "Provides a plugin which adds navigation controls to Calendar.",

5663

"extra": {

5664

"selleck": {

5665

"name": "calendar",

5666

"displayName": "Calendar",

5667

"description": "Provides an interactive visual representation of a range of dates in one or more month grids",

5668

"author": "allenr",

5669

"tags": [

5670

"beta",

5671

"widget",

5672

"calendar"

5673

],

5674

"use": [

5675

"calendar"

5676

]

5677

}

5678

}

5679

},

5680

"charts": {

5681

"name": "charts",

5682

"submodules": {

5683

"charts-legend": 1

5684

},

5685

"classes": {

5686

"AreaSeries": 1,

5687

"AreaSplineSeries": 1,

5688

"Axis": 1,

5689

"AxisType": 1,

5690

"BarSeries": 1,

5691

"BottomAxisLayout": 1,

5692

"CartesianChart": 1,

5693

"HorizontalLegendLayout": 1,

5694

"VerticalLegendLayout": 1,

5695

"CartesianSeries": 1,

5696

"CategoryAxis": 1,

5697

"Chart": 1,

5698

"ChartBase": 1,

5699

"ChartLegend": 1,

5700

"ColumnSeries": 1,

5701

"ComboSeries": 1,

5702

"ComboSplineSeries": 1,

5703

"CurveUtil": 1,

5704

"Fills": 1,

5705

"Graph": 1,

5706

"Gridlines": 1,

5707

"Histogram": 1,

5708

"LeftAxisLayout": 1,

5709

"LineSeries": 1,

5710

"Lines": 1,

5711

"MarkerSeries": 1,

5712

"NumericAxis": 1,

5713

"PieChart": 1,

5714

"PieSeries": 1,

5715

"Plots": 1,

5716

"Renderer": 1,

5717

"RightAxisLayout": 1,

5718

"SplineSeries": 1,

5719

"StackedAreaSeries": 1,

5720

"StackedAreaSplineSeries": 1,

5721

"StackedAxis": 1,

5722

"StackedBarSeries": 1,

5723

"StackedColumnSeries": 1,

5724

"StackedComboSeries": 1,

5725

"StackedComboSplineSeries": 1,

5726

"StackedLineSeries": 1,

5727

"StackedMarkerSeries": 1,

5728

"StackedSplineSeries": 1,

5729

"StackingUtil": 1,

5730

"TimeAxis": 1,

5731

"TopAxisLayout": 1

5732

},

5733

"fors": {},

5734

"namespaces": {},

5735

"tag": "main",

5736

"file": "charts/js/TopAxisLayout.js",

5737

"line": 1,

5738

"description": "The Charts widget provides an api for displaying data\ngraphically.",

5739

"extends": "CartesianSeries",

5740

"uses": [

5741

"Fills"

5742

],

5743

"is_constructor": 1,

5744

"params": [

5745

{

5746

"name": "config",

5747

"description": "(optional) Configuration parameters for the Chart.",

5748

"type": "Object"

5749

}

5750

],

5751

"itemtype": "main",

5752

"extra": {

5753

"selleck": {

5754

"name": "charts",

5755

"displayName": "Charts",

5756

"description": "The charts module provides a JavaScript API for visualizing data in a variety of formats accross all A-grade browsers.",

5757

"author": "tripp",

5758

"tags": [

5759

"widget",

5760

"charts",

5761

"beta"

5762

],

5763

"use": [

5764

"charts"

5765

]

5766

}

5767

}

5768

},

5769

"charts-legend": {

5770

"name": "charts-legend",

5771

"submodules": {},

5772

"classes": {

5773

"HorizontalLegendLayout": 1,

5774

"VerticalLegendLayout": 1,

5775

"ChartLegend": 1

5776

},

5777

"fors": {},

5778

"is_submodule": 1,

5779

"namespaces": {},

5780

"module": "charts",

5781

"namespace": "",

5782

"file": "charts/js/ChartLegend.js",

5783

"line": 1,

5784

"description": "Adds legend functionality to charts.",

5785

"extra": {

5786

"selleck": {

5787

"name": "charts",

5788

"displayName": "Charts",

5789

"description": "The charts module provides a JavaScript API for visualizing data in a variety of formats accross all A-grade browsers.",

5790

"author": "tripp",

5791

"tags": [

5792

"widget",

5793

"charts",

5794

"beta"

5795

],

5796

"use": [

5797

"charts"

5798

]

5799

}

5800

}

5801

},

5802

"graphics": {

5803

"name": "graphics",

5804

"submodules": {},

5805

"classes": {

5806

"GroupCircle": 1,

5807

"GroupDiamond": 1,

5808

"EllipseGroup": 1,

5809

"GroupRect": 1,

5810

"ShapeGroup": 1,

5811

"CanvasCircle": 1,

5812

"CanvasDrawing": 1,

5813

"CanvasEllipse": 1,

5814

"CanvasGraphic": 1,

5815

"CanvasPath": 1,

5816

"CanvasPieSlice": 1,

5817

"CanvasRect": 1,

5818

"CanvasShape": 1,

5819

"AttributeLite": 1,

5820

"GraphicBase": 1,

5821

"Drawing": 1,

5822

"Shape": 1,

5823

"Circle": 1,

5824

"Ellipse": 1,

5825

"Rect": 1,

5826

"Path": 1,

5827

"Graphic": 1,

5828

"SVGCircle": 1,

5829

"SVGDrawing": 1,

5830

"SVGEllipse": 1,

5831

"SVGGraphic": 1,

5832

"SVGPath": 1,

5833

"SVGPieSlice": 1,

5834

"SVGRect": 1,

5835

"SVGShape": 1,

5836

"VMLCircle": 1,

5837

"VMLDrawing": 1,

5838

"VMLEllipse": 1,

5839

"VMLGraphic": 1,

5840

"VMLPath": 1,

5841

"VMLPieSlice": 1,

5842

"VMLRect": 1,

5843

"VMLShape": 1

5844

},

5845

"fors": {},

5846

"namespaces": {},

5847

"tag": "main",

5848

"file": "graphics/js/VMLShape.js",

5849

"line": 1,

5850

"description": "The `Graphics` module provides a JavaScript API for creating shapes in a variety of formats across \n a <a href=\"http://developer.yahoo.com/yui/articles/gbs\">browser test baseline</a>. \n Based on device and browser capabilities, `Graphics` leverages <a href=\"http://www.w3.org/TR/SVG/\">SVG</a>, \n <a href=\"http://www.w3.org/TR/html5/the-canvas-element.html\">Canvas</a> and <a href=\"http://www.w3.org/TR/NOTE-VML\">VML</a> \n to render its graphical elements.\n\n The `Graphics` module features a <a href=\"../classes/Graphic.html\">`Graphic`</a> class that allows you to easily create and manage shapes. \n Currently, a <a href=\"../classes/Graphic.html\">`Graphic`</a> instance can be used to create predifined shapes and free-form polygons with fill \n and stroke properties. \n\n The `Graphics` module normalizes an API through the use of alias and implementation classes that share\n interfaces. Each alias class points to an appropriate implementation class dependent on the browser's \n capabilities. There should rarely, if ever, be a need to interact directly with an implementation class.\n\n Below is a list of available classes. \n <ul>\n <li><a href=\"../classes/Graphic.html\">`Graphic`</a>\n <li><a href=\"../classes/Shape.html\">`Shape`</a>\n <li><a href=\"../classes/Circle.html\">`Circle`</a>\n <li><a href=\"../classes/Ellipse.html\">`Ellipse`</a>\n <li><a href=\"../classes/Rect.html\">`Rect`</a>\n <li><a href=\"../classes/Path.html\">`Path`</a>\n </ul>\n You can also extend the `Shape` class to create your own custom shape classes.",

5851

"is_constructor": 1,

5852

"extends": "CanvasShape",

5853

"itemtype": "main",

5854

"params": [

5855

{

5856

"name": "cfg",

5857

"description": "(optional) Attribute configs",

5858

"type": "Object"

5859

}

5860

],

5861

"extra": {

5862

"selleck": {

5863

"name": "graphics",

5864

"displayName": "Graphics",

5865

"description": "The Graphics module provides a JavaScript API for creating shapes in a variety of formats across all A-grade browsers.",

5866

"author": "tripp",

5867

"tags": [

5868

"utility",

5869

"graphics",

5870

"beta"

5871

],

5872

"use": [

5873

"graphics"

5874

],

5875

"pages": {

5876

"graphics-path-tool-example": {

5877

"layout": "graphics-path-tool-example"

5878

},

5879

"graphics-path-tool": {

5880

"displayName": "Graphics: Path Drawing Tool",

5881

"hideTableOfContents": true

5882

},

5883

"graphics-radial-tool": {

5884

"displayName": "Graphics: Radial Gradient Tool",

5885

"hideTableOfContents": true

5886

}

5887

}

5888

}

5889

}

5890

},

5891

"classnamemanager": {

5892

"name": "classnamemanager",

5893

"submodules": {},

5894

"classes": {

5895

"ClassNameManager": 1

5896

},

5897

"fors": {},

5898

"namespaces": {},

5899

"tag": "module",

5900

"file": "classnamemanager/js/classnamemanager.js",

5901

"line": 7,

5902

"description": "Contains a singleton (ClassNameManager) that enables easy creation and caching of \nprefixed class names."

5903

},

5904

"collection": {

5905

"name": "collection",

5906

"submodules": {

5907

"array-extras": 1,

5908

"arraylist-add": 1,

5909

"arraylist-filter": 1,

5910

"arraylist": 1,

5911

"array-invoke": 1

5912

},

5913

"classes": {

5914

"ArrayList": 1

5915

},

5916

"fors": {

5917

"Array": 1,

5918

"ArrayList": 1

5919

},

5920

"namespaces": {},

5921

"file": "collection/js/arraylist.js",

5922

"line": 11

5923

},

5924

"array-extras": {

5925

"name": "array-extras",

5926

"submodules": {},

5927

"classes": {},

5928

"fors": {},

5929

"is_submodule": 1,

5930

"namespaces": {},

5931

"module": "collection",

5932

"namespace": "",

5933

"file": "collection/js/array-extras.js",

5934

"line": 1,

5935

"description": "Adds additional utility methods to the `Y.Array` class."

5936

},

5937

"arraylist-add": {

5938

"name": "arraylist-add",

5939

"submodules": {},

5940

"classes": {},

5941

"fors": {},

5942

"is_submodule": 1,

5943

"namespaces": {},

5944

"module": "collection",

5945

"namespace": "",

5946

"file": "collection/js/arraylist-add.js",

5947

"line": 1,

5948

"description": "Collection utilities beyond what is provided in the YUI core",

5949

"deprecated": true,

5950

"deprecationMessage": "Use ModelList or a custom ArrayList subclass"

5951

},

5952

"arraylist-filter": {

5953

"name": "arraylist-filter",

5954

"submodules": {},

5955

"classes": {},

5956

"fors": {},

5957

"is_submodule": 1,

5958

"namespaces": {},

5959

"module": "collection",

5960

"namespace": "",

5961

"file": "collection/js/arraylist-filter.js",

5962

"line": 1,

5963

"description": "Collection utilities beyond what is provided in the YUI core",

5964

"deprecated": true,

5965

"deprecationMessage": "Use ModelList or a custom subclass implementation"

5966

},

5967

"arraylist": {

5968

"name": "arraylist",

5969

"submodules": {},

5970

"classes": {

5971

"ArrayList": 1

5972

},

5973

"fors": {},

5974

"is_submodule": 1,

5975

"namespaces": {},

5976

"module": "collection",

5977

"namespace": "",

5978

"file": "collection/js/arraylist.js",

5979

"line": 11,

5980

"description": "Collection utilities beyond what is provided in the YUI core"

5981

},

5982

"array-invoke": {

5983

"name": "array-invoke",

5984

"submodules": {},

5985

"classes": {},

5986

"fors": {},

5987

"is_submodule": 1,

5988

"namespaces": {},

5989

"module": "collection",

5990

"namespace": "",

5991

"file": "collection/js/invoke.js",

5992

"line": 1

5993

},

5994

"console-filters": {

5995

"name": "console-filters",

5996

"submodules": {},

5997

"classes": {

5998

"Plugin.ConsoleFilters": 1

5999

},

6000

"fors": {},

6001

"namespaces": {

6002

"Plugin": 1

6003

},

6004

"tag": "module",

6005

"file": "console-filters/js/console-filters.js",

6006

"line": 1,

6007

"description": "Provides Plugin.ConsoleFilters plugin class.\n\nThis plugin adds the ability to control which Console entries display by filtering on category and source. Two groups of checkboxes are added to the Console footer, one for categories and the other for sources. Only those messages that match a checked category or source are displayed.",

6008

"extra": {

6009

"selleck": {

6010

"name": "console-filters",

6011

"displayName": "ConsoleFilters Plugin",

6012

"description": "The Console Filters plugin adds log message filtering controls to the Console UI",

6013

"author": [

6014

"dgathright"

6015

],

6016

"tags": [

6017

"beta",

6018

"devtool",

6019

"plugin",

6020

"console",

6021

"console-filters",

6022

"filter",

6023

"log"

6024

],

6025

"use": [

6026

"console-filters"

6027

]

6028

}

6029

}

6030

},

6031

"console": {

6032

"name": "console",

6033

"submodules": {},

6034

"classes": {

6035

"Console": 1

6036

},

6037

"fors": {},

6038

"namespaces": {},

6039

"tag": "module",

6040

"file": "console/js/console.js",

6041

"line": 1,

6042

"description": "Console creates a visualization for messages logged through calls to a YUI\ninstance's <code>Y.log( message, category, source )</code> method. The\ndebug versions of YUI modules will include logging statements to offer some\ninsight into the steps executed during that module's operation. Including\nlog statements in your code will cause those messages to also appear in the\nConsole. Use Console to aid in developing your page or application.\n\nEntry categories "info", "warn", and "error"\nare also referred to as the log level, and entries are filtered against the\nconfigured logLevel.",

6043

"extends": "Widget",

6044

"params": [

6045

{

6046

"name": "conf",

6047

"description": "Configuration object (see Configuration attributes)",

6048

"type": "Object"

6049

}

6050

],

6051

"is_constructor": 1,

6052

"extra": {

6053

"selleck": {

6054

"name": "console",

6055

"displayName": "Console",

6056

"description": "Message logging UI. Typically used as a development tool.",

6057

"author": [

6058

"dgathright"

6059

],

6060

"tags": [

6061

"devtool",

6062

"console",

6063

"development"

6064

],

6065

"use": [

6066

"console"

6067

]

6068

}

6069

}

6070

},

6071

"cookie": {

6072

"name": "cookie",

6073

"submodules": {},

6074

"classes": {

6075

"Cookie": 1

6076

},

6077

"fors": {},

6078

"namespaces": {},

6079

"tag": "module",

6080

"file": "cookie/js/Cookie.js",

6081

"line": 47,

6082

"description": "Utilities for cookie management",

6083

"extra": {

6084

"selleck": {

6085

"name": "cookie",

6086

"displayName": "Cookie Utility",

6087

"description": "Provides a simple API for interacting with cookies, including the creation and manipulation of subcookies.",

6088

"author": "nzakas",

6089

"tags": [

6090

"utility",

6091

"cookie",

6092

"cookies"

6093

],

6094

"use": [

6095

"cookie"

6096

]

6097

}

6098

}

6099

},

6100

"dataschema": {

6101

"name": "dataschema",

6102

"submodules": {

6103

"dataschema-array": 1,

6104

"dataschema-base": 1,

6105

"dataschema-json": 1,

6106

"dataschema-text": 1,

6107

"dataschema-xml": 1

6108

},

6109

"classes": {

6110

"DataSchema.Array": 1,

6111

"DataSchema.Base": 1,

6112

"DataSchema.JSON": 1,

6113

"DataSchema.Text": 1,

6114

"DataSchema.XML": 1

6115

},

6116

"fors": {},

6117

"namespaces": {},

6118

"tag": "main",

6119

"file": "dataschema/js/dataschema-xml.js",

6120

"line": 8,

6121

"description": "The DataSchema utility provides a common configurable interface for widgets to\napply a given schema to a variety of data.",

6122

"itemtype": "main",

6123

"extra": {

6124

"selleck": {

6125

"name": "dataschema",

6126

"displayName": "DataSchema",

6127

"description": "Applies a given schema against data of arbitrary formats, normalizing input such as JSON, XML, or delimited text into a JavaScript object with known properties. The value of the DataSchema Utility is in its ability to translate data from a variety of sources into a consistent format for consumption by components in a predictable manner.",

6128

"author": [

6129

"lsmith",

6130

"ericf"

6131

],

6132

"tags": [

6133

"utility",

6134

"dataschema"

6135

],

6136

"use": [

6137

"dataschema"

6138

]

6139

}

6140

}

6141

},

6142

"dataschema-array": {

6143

"name": "dataschema-array",

6144

"submodules": {},

6145

"classes": {

6146

"DataSchema.Array": 1

6147

},

6148

"fors": {},

6149

"is_submodule": 1,

6150

"namespaces": {},

6151

"module": "dataschema",

6152

"namespace": "",

6153

"file": "dataschema/js/dataschema-array.js",

6154

"line": 9,

6155

"description": "Provides a DataSchema implementation which can be used to work with data\nstored in arrays.",

6156

"extra": {

6157

"selleck": {

6158

"name": "dataschema",

6159

"displayName": "DataSchema",

6160

"description": "Applies a given schema against data of arbitrary formats, normalizing input such as JSON, XML, or delimited text into a JavaScript object with known properties. The value of the DataSchema Utility is in its ability to translate data from a variety of sources into a consistent format for consumption by components in a predictable manner.",

6161

"author": [

6162

"lsmith",

6163

"ericf"

6164

],

6165

"tags": [

6166

"utility",

6167

"dataschema"

6168

],

6169

"use": [

6170

"dataschema"

6171

]

6172

}

6173

}

6174

},

6175

"dataschema-base": {

6176

"name": "dataschema-base",

6177

"submodules": {},

6178

"classes": {

6179

"DataSchema.Base": 1

6180

},

6181

"fors": {},

6182

"is_submodule": 1,

6183

"namespaces": {},

6184

"module": "dataschema",

6185

"namespace": "",

6186

"file": "dataschema/js/dataschema-base.js",

6187

"line": 19,

6188

"description": "Provides the base DataSchema implementation, which can be extended to \ncreate DataSchemas for specific data formats, such XML, JSON, text and\narrays.",

6189

"extra": {

6190

"selleck": {

6191

"name": "dataschema",

6192

"displayName": "DataSchema",

6193

"description": "Applies a given schema against data of arbitrary formats, normalizing input such as JSON, XML, or delimited text into a JavaScript object with known properties. The value of the DataSchema Utility is in its ability to translate data from a variety of sources into a consistent format for consumption by components in a predictable manner.",

6194

"author": [

6195

"lsmith",

6196

"ericf"

6197

],

6198

"tags": [

6199

"utility",

6200

"dataschema"

6201

],

6202

"use": [

6203

"dataschema"

6204

]

6205

}

6206

}

6207

},

6208

"dataschema-json": {

6209

"name": "dataschema-json",

6210

"submodules": {},

6211

"classes": {

6212

"DataSchema.JSON": 1

6213

},

6214

"fors": {},

6215

"is_submodule": 1,

6216

"namespaces": {},

6217

"module": "dataschema",

6218

"namespace": "",

6219

"file": "dataschema/js/dataschema-json.js",

6220

"line": 8,

6221

"description": "Provides a DataSchema implementation which can be used to work with JSON data.",

6222

"extra": {

6223

"selleck": {

6224

"name": "dataschema",

6225

"displayName": "DataSchema",

6226

"description": "Applies a given schema against data of arbitrary formats, normalizing input such as JSON, XML, or delimited text into a JavaScript object with known properties. The value of the DataSchema Utility is in its ability to translate data from a variety of sources into a consistent format for consumption by components in a predictable manner.",

6227

"author": [

6228

"lsmith",

6229

"ericf"

6230

],

6231

"tags": [

6232

"utility",

6233

"dataschema"

6234

],

6235

"use": [

6236

"dataschema"

6237

]

6238

}

6239

}

6240

},

6241

"dataschema-text": {

6242

"name": "dataschema-text",

6243

"submodules": {},

6244

"classes": {

6245

"DataSchema.Text": 1

6246

},

6247

"fors": {},

6248

"is_submodule": 1,

6249

"namespaces": {},

6250

"module": "dataschema",

6251

"namespace": "",

6252

"file": "dataschema/js/dataschema-text.js",

6253

"line": 9,

6254

"description": "Provides a DataSchema implementation which can be used to work with\ndelimited text data.",

6255

"extra": {

6256

"selleck": {

6257

"name": "dataschema",

6258

"displayName": "DataSchema",

6259

"description": "Applies a given schema against data of arbitrary formats, normalizing input such as JSON, XML, or delimited text into a JavaScript object with known properties. The value of the DataSchema Utility is in its ability to translate data from a variety of sources into a consistent format for consumption by components in a predictable manner.",

6260

"author": [

6261

"lsmith",

6262

"ericf"

6263

],

6264

"tags": [

6265

"utility",

6266

"dataschema"

6267

],

6268

"use": [

6269

"dataschema"

6270

]

6271

}

6272

}

6273

},

6274

"dataschema-xml": {

6275

"name": "dataschema-xml",

6276

"submodules": {},

6277

"classes": {

6278

"DataSchema.XML": 1

6279

},

6280

"fors": {},

6281

"is_submodule": 1,

6282

"namespaces": {},

6283

"module": "dataschema",

6284

"namespace": "",

6285

"file": "dataschema/js/dataschema-xml.js",

6286

"line": 8,

6287

"description": "Provides a DataSchema implementation which can be used to work with XML data.",

6288

"extra": {

6289

"selleck": {

6290

"name": "dataschema",

6291

"displayName": "DataSchema",

6292

"description": "Applies a given schema against data of arbitrary formats, normalizing input such as JSON, XML, or delimited text into a JavaScript object with known properties. The value of the DataSchema Utility is in its ability to translate data from a variety of sources into a consistent format for consumption by components in a predictable manner.",

6293

"author": [

6294

"lsmith",

6295

"ericf"

6296

],

6297

"tags": [

6298

"utility",

6299

"dataschema"

6300

],

6301

"use": [

6302

"dataschema"

6303

]

6304

}

6305

}

6306

},

6307

"datasource": {

6308

"name": "datasource",

6309

"submodules": {

6310

"datasource-arrayschema": 1,

6311

"datasource-cache": 1,

6312

"datasource-function": 1,

6313

"datasource-get": 1,

6314

"datasource-io": 1,

6315

"datasource-jsonschema": 1,

6316

"datasource-local": 1,

6317

"datasource-polling": 1,

6318

"datasource-textschema": 1,

6319

"datasource-xmlschema": 1

6320

},

6321

"classes": {

6322

"DataSourceArraySchema": 1,

6323

"DataSourceCacheExtension": 1,

6324

"DataSourceCache": 1,

6325

"DataSource.Function": 1,

6326

"DataSource.Get": 1,

6327

"DataSource.IO": 1,

6328

"DataSourceJSONSchema": 1,

6329

"DataSource.Local": 1,

6330

"Pollable": 1,

6331

"DataSourceTextSchema": 1,

6332

"DataSourceXMLSchema": 1

6333

},

6334

"fors": {},

6335

"namespaces": {},

6336

"tag": "main",

6337

"file": "datasource/js/datasource-xmlschema.js",

6338

"line": 8,

6339

"description": "The DataSource utility provides a common configurable interface for widgets to\naccess a variety of data, from JavaScript arrays to online database servers.",

6340

"itemtype": "main",

6341

"extra": {

6342

"selleck": {

6343

"name": "datasource",

6344

"displayName": "DataSource",

6345

"description": "The DataSource Utility provides a common configurable interface for other components to fetch tabular data from a variety of local or remote sources.",

6346

"author": [

6347

"lsmith",

6348

"ericf"

6349

],

6350

"use": [

6351

"datasource"

6352

],

6353

"tags": [

6354

"utility",

6355

"datasource"

6356

]

6357

}

6358

}

6359

},

6360

"datasource-arrayschema": {

6361

"name": "datasource-arrayschema",

6362

"submodules": {},

6363

"classes": {

6364

"DataSourceArraySchema": 1

6365

},

6366

"fors": {},

6367

"is_submodule": 1,

6368

"namespaces": {},

6369

"module": "datasource",

6370

"namespace": "",

6371

"file": "datasource/js/datasource-arrayschema.js",

6372

"line": 8,

6373

"description": "Extends DataSource with schema-parsing on array data.",

6374

"extra": {

6375

"selleck": {

6376

"name": "datasource",

6377

"displayName": "DataSource",

6378

"description": "The DataSource Utility provides a common configurable interface for other components to fetch tabular data from a variety of local or remote sources.",

6379

"author": [

6380

"lsmith",

6381

"ericf"

6382

],

6383

"use": [

6384

"datasource"

6385

],

6386

"tags": [

6387

"utility",

6388

"datasource"

6389

]

6390

}

6391

}

6392

},

6393

"datasource-cache": {

6394

"name": "datasource-cache",

6395

"submodules": {},

6396

"classes": {

6397

"DataSourceCacheExtension": 1,

6398

"DataSourceCache": 1

6399

},

6400

"fors": {},

6401

"is_submodule": 1,

6402

"namespaces": {},

6403

"module": "datasource",

6404

"namespace": "",

6405

"file": "datasource/js/datasource-cache.js",

6406

"line": 121,

6407

"description": "Plugs DataSource with caching functionality.",

6408

"extra": {

6409

"selleck": {

6410

"name": "datasource",

6411

"displayName": "DataSource",

6412

"description": "The DataSource Utility provides a common configurable interface for other components to fetch tabular data from a variety of local or remote sources.",

6413

"author": [

6414

"lsmith",

6415

"ericf"

6416

],

6417

"use": [

6418

"datasource"

6419

],

6420

"tags": [

6421

"utility",

6422

"datasource"

6423

]

6424

}

6425

}

6426

},

6427

"datasource-function": {

6428

"name": "datasource-function",

6429

"submodules": {},

6430

"classes": {

6431

"DataSource.Function": 1

6432

},

6433

"fors": {},

6434

"is_submodule": 1,

6435

"namespaces": {},

6436

"module": "datasource",

6437

"namespace": "",

6438

"file": "datasource/js/datasource-function.js",

6439

"line": 8,

6440

"description": "Provides a DataSource implementation which can be used to retrieve data from a custom function.",

6441

"extra": {

6442

"selleck": {

6443

"name": "datasource",

6444

"displayName": "DataSource",

6445

"description": "The DataSource Utility provides a common configurable interface for other components to fetch tabular data from a variety of local or remote sources.",

6446

"author": [

6447

"lsmith",

6448

"ericf"

6449

],

6450

"use": [

6451

"datasource"

6452

],

6453

"tags": [

6454

"utility",

6455

"datasource"

6456

]

6457

}

6458

}

6459

},

6460

"datasource-get": {

6461

"name": "datasource-get",

6462

"submodules": {},

6463

"classes": {

6464

"DataSource.Get": 1

6465

},

6466

"fors": {},

6467

"is_submodule": 1,

6468

"namespaces": {},

6469

"module": "datasource",

6470

"namespace": "",

6471

"file": "datasource/js/datasource-get.js",

6472

"line": 8,

6473

"description": "Provides a DataSource implementation which can be used to retrieve data via the Get Utility.",

6474

"extra": {

6475

"selleck": {

6476

"name": "datasource",

6477

"displayName": "DataSource",

6478

"description": "The DataSource Utility provides a common configurable interface for other components to fetch tabular data from a variety of local or remote sources.",

6479

"author": [

6480

"lsmith",

6481

"ericf"

6482

],

6483

"use": [

6484

"datasource"

6485

],

6486

"tags": [

6487

"utility",

6488

"datasource"

6489

]

6490

}

6491

}

6492

},

6493

"datasource-io": {

6494

"name": "datasource-io",

6495

"submodules": {},

6496

"classes": {

6497

"DataSource.IO": 1

6498

},

6499

"fors": {},

6500

"is_submodule": 1,

6501

"namespaces": {},

6502

"module": "datasource",

6503

"namespace": "",

6504

"file": "datasource/js/datasource-io.js",

6505

"line": 8,

6506

"description": "Provides a DataSource implementation which can be used to retrieve data via the IO Utility.",

6507

"extra": {

6508

"selleck": {

6509

"name": "datasource",

6510

"displayName": "DataSource",

6511

"description": "The DataSource Utility provides a common configurable interface for other components to fetch tabular data from a variety of local or remote sources.",

6512

"author": [

6513

"lsmith",

6514

"ericf"

6515

],

6516

"use": [

6517

"datasource"

6518

],

6519

"tags": [

6520

"utility",

6521

"datasource"

6522

]

6523

}

6524

}

6525

},

6526

"datasource-jsonschema": {

6527

"name": "datasource-jsonschema",

6528

"submodules": {},

6529

"classes": {

6530

"DataSourceJSONSchema": 1

6531

},

6532

"fors": {},

6533

"is_submodule": 1,

6534

"namespaces": {},

6535

"module": "datasource",

6536

"namespace": "",

6537

"file": "datasource/js/datasource-jsonschema.js",

6538

"line": 8,

6539

"description": "Extends DataSource with schema-parsing on JSON data.",

6540

"extra": {

6541

"selleck": {

6542

"name": "datasource",

6543

"displayName": "DataSource",

6544

"description": "The DataSource Utility provides a common configurable interface for other components to fetch tabular data from a variety of local or remote sources.",

6545

"author": [

6546

"lsmith",

6547

"ericf"

6548

],

6549

"use": [

6550

"datasource"

6551

],

6552

"tags": [

6553

"utility",

6554

"datasource"

6555

]

6556

}

6557

}

6558

},

6559

"datasource-local": {

6560

"name": "datasource-local",

6561

"submodules": {},

6562

"classes": {

6563

"DataSource.Local": 1

6564

},

6565

"fors": {},

6566

"is_submodule": 1,

6567

"namespaces": {},

6568

"module": "datasource",

6569

"namespace": "",

6570

"file": "datasource/js/datasource-local.js",

6571

"line": 18,

6572

"description": "Provides the base DataSource implementation, which can be extended to\ncreate DataSources for specific data protocols, such as the IO Utility, the\nGet Utility, or custom functions.",

6573

"extra": {

6574

"selleck": {

6575

"name": "datasource",

6576

"displayName": "DataSource",

6577

"description": "The DataSource Utility provides a common configurable interface for other components to fetch tabular data from a variety of local or remote sources.",

6578

"author": [

6579

"lsmith",

6580

"ericf"

6581

],

6582

"use": [

6583

"datasource"

6584

],

6585

"tags": [

6586

"utility",

6587

"datasource"

6588

]

6589

}

6590

}

6591

},

6592

"datasource-polling": {

6593

"name": "datasource-polling",

6594

"submodules": {},

6595

"classes": {

6596

"Pollable": 1

6597

},

6598

"fors": {},

6599

"is_submodule": 1,

6600

"namespaces": {},

6601

"module": "datasource",

6602

"namespace": "",

6603

"file": "datasource/js/datasource-polling.js",

6604

"line": 8,

6605

"description": "Extends DataSource with polling functionality.",

6606

"extra": {

6607

"selleck": {

6608

"name": "datasource",

6609

"displayName": "DataSource",

6610

"description": "The DataSource Utility provides a common configurable interface for other components to fetch tabular data from a variety of local or remote sources.",

6611

"author": [

6612

"lsmith",

6613

"ericf"

6614

],

6615

"use": [

6616

"datasource"

6617

],

6618

"tags": [

6619

"utility",

6620

"datasource"

6621

]

6622

}

6623

}

6624

},

6625

"datasource-textschema": {

6626

"name": "datasource-textschema",

6627

"submodules": {},

6628

"classes": {

6629

"DataSourceTextSchema": 1

6630

},

6631

"fors": {},

6632

"is_submodule": 1,

6633

"namespaces": {},

6634

"module": "datasource",

6635

"namespace": "",

6636

"file": "datasource/js/datasource-textschema.js",

6637

"line": 8,

6638

"description": "Extends DataSource with schema-parsing on text data.",

6639

"extra": {

6640

"selleck": {

6641

"name": "datasource",

6642

"displayName": "DataSource",

6643

"description": "The DataSource Utility provides a common configurable interface for other components to fetch tabular data from a variety of local or remote sources.",

6644

"author": [

6645

"lsmith",

6646

"ericf"

6647

],

6648

"use": [

6649

"datasource"

6650

],

6651

"tags": [

6652

"utility",

6653

"datasource"

6654

]

6655

}

6656

}

6657

},

6658

"datasource-xmlschema": {

6659

"name": "datasource-xmlschema",

6660

"submodules": {},

6661

"classes": {

6662

"DataSourceXMLSchema": 1

6663

},

6664

"fors": {},

6665

"is_submodule": 1,

6666

"namespaces": {},

6667

"module": "datasource",

6668

"namespace": "",

6669

"file": "datasource/js/datasource-xmlschema.js",

6670

"line": 8,

6671

"description": "Extends DataSource with schema-parsing on XML data.",

6672

"extra": {

6673

"selleck": {

6674

"name": "datasource",

6675

"displayName": "DataSource",

6676

"description": "The DataSource Utility provides a common configurable interface for other components to fetch tabular data from a variety of local or remote sources.",

6677

"author": [

6678

"lsmith",

6679

"ericf"

6680

],

6681

"use": [

6682

"datasource"

6683

],

6684

"tags": [

6685

"utility",

6686

"datasource"

6687

]

6688

}

6689

}

6690

},

6691

"datatable-deprecated": {

6692

"name": "datatable-deprecated",

6693

"submodules": {

6694

"datatable-base-deprecated": 1,

6695

"datatable-datasource-deprecated": 1,

6696

"datatable-scroll-deprecated": 1,

6697

"datatable-sort-deprecated": 1

6698

},

6699

"classes": {},

6700

"fors": {},

6701

"namespaces": {},

6702

"tag": "main",

6703

"file": "datatable-deprecated/js/datatable-base.js",

6704

"line": 4,

6705

"description": "The DataTable widget provides a progressively enhanced DHTML control for\ndisplaying tabular data across A-grade browsers.\n\nDEPRECATED. As of YUI 3.5.0, DataTable has been rebuilt. This module\ncorresponds to the 3.4.1 version of DataTable and will be removed from the\nlibrary in a future version.\n\nSee http://yuilibrary.com/yui/docs/migration.html for help upgrading to the\nlatest version.\n\nFor complete API docs for the classes in this and other deprecated\nDataTable-related modules, refer to the static API doc files in the 3.4.1\ndownload at http://yui.zenfs.com/releases/yui3/yui_3.4.1.zip",

6706

"itemtype": "main",

6707

"extra": {

6708

"selleck": {

6709

"name": "datatable-deprecated",

6710

"displayName": "DataTable (deprecated version)",

6711

"description": "The DataTable widget displays screen-reader accessible tabular data on a web page. Plugins add functionality such as sorting and scrolling. This component exists for backward compatibility with YUI 3.4.1. Please use the updated datatable module and components.",

6712

"author": [

6713

"jenny",

6714

"lsmith"

6715

],

6716

"use": [

6717

"datatable-deprecated"

6718

],

6719

"tags": [

6720

"beta",

6721

"widget",

6722

"datatable",

6723

"deprecated"

6724

]

6725

}

6726

}

6727

},

6728

"datatable-base-deprecated": {

6729

"name": "datatable-base-deprecated",

6730

"submodules": {},

6731

"classes": {},

6732

"fors": {},

6733

"is_submodule": 1,

6734

"namespaces": {},

6735

"module": "datatable-deprecated",

6736

"namespace": "",

6737

"file": "datatable-deprecated/js/datatable-base.js",

6738

"line": 24,

6739

"description": "Provides the base DataTable implementation, which can be extended to add\nadditional functionality, such as sorting or scrolling.\n\nDEPRECATED. As of YUI 3.5.0, DataTable has been rebuilt. This module\ncorresponds to the 3.4.1 version of DataTable and will be removed from the\nlibrary in a future version.\n\nSee http://yuilibrary.com/yui/docs/migration.html for help upgrading to the\nlatest version.\n\nFor complete API docs for the classes in this and other deprecated\nDataTable-related modules, refer to the static API doc files in the 3.4.1\ndownload at http://yui.zenfs.com/releases/yui3/yui_3.4.1.zip",

6740

"deprecated": true,

6741

"extra": {

6742

"selleck": {

6743

"name": "datatable-deprecated",

6744

"displayName": "DataTable (deprecated version)",

6745

"description": "The DataTable widget displays screen-reader accessible tabular data on a web page. Plugins add functionality such as sorting and scrolling. This component exists for backward compatibility with YUI 3.4.1. Please use the updated datatable module and components.",

6746

"author": [

6747

"jenny",

6748

"lsmith"

6749

],

6750

"use": [

6751

"datatable-deprecated"

6752

],

6753

"tags": [

6754

"beta",

6755

"widget",

6756

"datatable",

6757

"deprecated"

6758

]

6759

}

6760

}

6761

},

6762

"datatable-datasource-deprecated": {

6763

"name": "datatable-datasource-deprecated",

6764

"submodules": {},

6765

"classes": {},

6766

"fors": {},

6767

"is_submodule": 1,

6768

"namespaces": {},

6769

"module": "datatable-deprecated",

6770

"namespace": "",

6771

"file": "datatable-deprecated/js/datatable-datasource.js",

6772

"line": 4,

6773

"description": "Plugs DataTable with DataSource integration.\n\nDEPRECATED. As of YUI 3.5.0, DataTable has been rebuilt. This module\nis designed to work with `datatable-base-deprecated` (effectively the 3.4.1\nversion of DataTable) and will be removed from the library in a future version.\n\nSee http://yuilibrary.com/yui/docs/migration.html for help upgrading to the\nlatest version.\n\nFor complete API docs for the classes in this and other deprecated\nDataTable-related modules, refer to the static API doc files in the 3.4.1\ndownload at http://yui.zenfs.com/releases/yui3/yui_3.4.1.zip",

6774

"deprecated": true,

6775

"extra": {

6776

"selleck": {

6777

"name": "datatable-deprecated",

6778

"displayName": "DataTable (deprecated version)",

6779

"description": "The DataTable widget displays screen-reader accessible tabular data on a web page. Plugins add functionality such as sorting and scrolling. This component exists for backward compatibility with YUI 3.4.1. Please use the updated datatable module and components.",

6780

"author": [

6781

"jenny",

6782

"lsmith"

6783

],

6784

"use": [

6785

"datatable-deprecated"

6786

],

6787

"tags": [

6788

"beta",

6789

"widget",

6790

"datatable",

6791

"deprecated"

6792

]

6793

}

6794

}

6795

},

6796

"datatable-scroll-deprecated": {

6797

"name": "datatable-scroll-deprecated",

6798

"submodules": {},

6799

"classes": {},

6800

"fors": {},

6801

"is_submodule": 1,

6802

"namespaces": {},

6803

"module": "datatable-deprecated",

6804

"namespace": "",

6805

"file": "datatable-deprecated/js/datatable-scroll.js",

6806

"line": 4,

6807

"description": "Extends DataTable base to enable x,y, and xy scrolling.\n\nDEPRECATED. As of YUI 3.5.0, DataTable has been rebuilt. This module\nis designed to work with `datatable-base-deprecated` (effectively the 3.4.1\nversion of DataTable) and will be removed from the library in a future version.\n\nSee http://yuilibrary.com/yui/docs/migration.html for help upgrading to the\nlatest version.\n\nFor complete API docs for the classes in this and other deprecated\nDataTable-related modules, refer to the static API doc files in the 3.4.1\ndownload at http://yui.zenfs.com/releases/yui3/yui_3.4.1.zip",

6808

"deprecated": true,

6809

"extra": {

6810

"selleck": {

6811

"name": "datatable-deprecated",

6812

"displayName": "DataTable (deprecated version)",

6813

"description": "The DataTable widget displays screen-reader accessible tabular data on a web page. Plugins add functionality such as sorting and scrolling. This component exists for backward compatibility with YUI 3.4.1. Please use the updated datatable module and components.",

6814

"author": [

6815

"jenny",

6816

"lsmith"

6817

],

6818

"use": [

6819

"datatable-deprecated"

6820

],

6821

"tags": [

6822

"beta",

6823

"widget",

6824

"datatable",

6825

"deprecated"

6826

]

6827

}

6828

}

6829

},

6830

"datatable-sort-deprecated": {

6831

"name": "datatable-sort-deprecated",

6832

"submodules": {},

6833

"classes": {},

6834

"fors": {},

6835

"is_submodule": 1,

6836

"namespaces": {},

6837

"module": "datatable-deprecated",

6838

"namespace": "",

6839

"file": "datatable-deprecated/js/datatable-sort.js",

6840

"line": 4,

6841

"description": "Plugs DataTable with sorting functionality.\n\nDEPRECATED. As of YUI 3.5.0, DataTable has been rebuilt. This module\nis designed to work with `datatable-base-deprecated` (effectively the 3.4.1\nversion of DataTable) and will be removed from the library in a future version.\n\nSee http://yuilibrary.com/yui/docs/migration.html for help upgrading to the\nlatest version.\n\nFor complete API docs for the classes in this and other deprecated\nDataTable-related modules, refer to the static API doc files in the 3.4.1\ndownload at http://yui.zenfs.com/releases/yui3/yui_3.4.1.zip",

6842

"deprecated": true,

6843

"extra": {

6844

"selleck": {

6845

"name": "datatable-deprecated",

6846

"displayName": "DataTable (deprecated version)",

6847

"description": "The DataTable widget displays screen-reader accessible tabular data on a web page. Plugins add functionality such as sorting and scrolling. This component exists for backward compatibility with YUI 3.4.1. Please use the updated datatable module and components.",

6848

"author": [

6849

"jenny",

6850

"lsmith"

6851

],

6852

"use": [

6853

"datatable-deprecated"

6854

],

6855

"tags": [

6856

"beta",

6857

"widget",

6858

"datatable",

6859

"deprecated"

6860

]

6861

}

6862

}

6863

},

6864

"datatable": {

6865

"name": "datatable",

6866

"submodules": {

6867

"datatable-base": 1,

6868

"datatable-body": 1,

6869

"datatable-column-widths": 1,

6870

"datatable-core": 1,

6871

"datatable-datasource": 1,

6872

"datatable-head": 1,

6873

"datatable-message": 1,

6874

"datatable-mutable": 1,

6875

"datatable-sort": 1

6876

},

6877

"classes": {

6878

"DataTable": 1,

6879

"DataTable.Base": 1,

6880

"DataTable.BodyView": 1,

6881

"DataTable.ColumnWidths": 1,

6882

"DataTable.Core": 1,

6883

"Plugin.DataTableDataSource": 1,

6884

"DataTable.HeaderView": 1,

6885

"DataTable.Message": 1,

6886

"DataTable.Mutable": 1,

6887

"DataTable.Sortable": 1

6888

},

6889

"fors": {

6890

"DataTable": 1

6891

},

6892

"namespaces": {

6893

"DataTable": 1

6894

},

6895

"file": "datatable/js/sort.js",

6896

"line": 26,

6897

"description": "A Widget for displaying tabular data. The base implementation of DataTable\nprovides the ability to dynamically generate an HTML table from a set of column\nconfigurations and row data.\n\nTwo classes are included in the `datatable-base` module: `Y.DataTable` and\n`Y.DataTable.Base`.",

6898

"tag": "main",

6899

"itemtype": "main",

6900

"extra": {

6901

"selleck": {

6902

"name": "datatable",

6903

"displayName": "DataTable",

6904

"description": "The DataTable widget displays screen-reader accessible tabular data on a web page. Class extensions add functionality such as sorting and scrolling.",

6905

"author": [

6906

"lsmith"

6907

],

6908

"use": [

6909

"datatable"

6910

],

6911

"tags": [

6912

"beta",

6913

"widget",

6914

"datatable"

6915

],

6916

"pages": {

6917

"migration": {

6918

"displayName": "3.5.0+ Migration Guide"

6919

}

6920

}

6921

}

6922

}

6923

},

6924

"datatable-base": {

6925

"name": "datatable-base",

6926

"submodules": {},

6927

"classes": {

6928

"DataTable": 1,

6929

"DataTable.Base": 1

6930

},

6931

"fors": {},

6932

"is_submodule": 1,

6933

"namespaces": {

6934

"DataTable": 1

6935

},

6936

"module": "datatable",

6937

"namespace": "",

6938

"file": "datatable/js/base.js",

6939

"line": 168,

6940

"description": "A Widget for displaying tabular data. The base implementation of DataTable\nprovides the ability to dynamically generate an HTML table from a set of column\nconfigurations and row data.\n\nTwo classes are included in the `datatable-base` module: `Y.DataTable` and\n`Y.DataTable.Base`.",

6941

"tag": "main",

6942

"itemtype": "main",

6943

"since": "3.5.0",

6944

"extra": {

6945

"selleck": {

6946

"name": "datatable",

6947

"displayName": "DataTable",

6948

"description": "The DataTable widget displays screen-reader accessible tabular data on a web page. Class extensions add functionality such as sorting and scrolling.",

6949

"author": [

6950

"lsmith"

6951

],

6952

"use": [

6953

"datatable"

6954

],

6955

"tags": [

6956

"beta",

6957

"widget",

6958

"datatable"

6959

],

6960

"pages": {

6961

"migration": {

6962

"displayName": "3.5.0+ Migration Guide"

6963

}

6964

}

6965

}

6966

}

6967

},

6968

"datatable-body": {

6969

"name": "datatable-body",

6970

"submodules": {},

6971

"classes": {

6972

"DataTable.BodyView": 1

6973

},

6974

"fors": {},

6975

"is_submodule": 1,

6976

"namespaces": {

6977

"DataTable": 1

6978

},

6979

"module": "datatable",

6980

"namespace": "",

6981

"file": "datatable/js/body.js",

6982

"line": 22,

6983

"description": "View class responsible for rendering the `<tbody>` section of a table. Used as\nthe default `bodyView` for `Y.DataTable.Base` and `Y.DataTable` classes.",

6984

"since": "3.5.0",

6985

"extra": {

6986

"selleck": {

6987

"name": "datatable",

6988

"displayName": "DataTable",

6989

"description": "The DataTable widget displays screen-reader accessible tabular data on a web page. Class extensions add functionality such as sorting and scrolling.",

6990

"author": [

6991

"lsmith"

6992

],

6993

"use": [

6994

"datatable"

6995

],

6996

"tags": [

6997

"beta",

6998

"widget",

6999

"datatable"

7000

],

7001

"pages": {

7002

"migration": {

7003

"displayName": "3.5.0+ Migration Guide"

7004

}

7005

}

7006

}

7007

}

7008

},

7009

"datatable-column-widths": {

7010

"name": "datatable-column-widths",

7011

"submodules": {},

7012

"classes": {

7013

"DataTable.ColumnWidths": 1

7014

},

7015

"fors": {},

7016

"is_submodule": 1,

7017

"namespaces": {},

7018

"module": "datatable",

7019

"namespace": "",

7020

"file": "datatable/js/colwidths.js",

7021

"line": 45,

7022

"description": "Adds basic, programmatic column width support to DataTable via column\nconfiguration property `width` and method `table.setColumnWidth(id, width);`.",

7023

"since": "3.5.0",

7024

"extra": {

7025

"selleck": {

7026

"name": "datatable",

7027

"displayName": "DataTable",

7028

"description": "The DataTable widget displays screen-reader accessible tabular data on a web page. Class extensions add functionality such as sorting and scrolling.",

7029

"author": [

7030

"lsmith"

7031

],

7032

"use": [

7033

"datatable"

7034

],

7035

"tags": [

7036

"beta",

7037

"widget",

7038

"datatable"

7039

],

7040

"pages": {

7041

"migration": {

7042

"displayName": "3.5.0+ Migration Guide"

7043

}

7044

}

7045

}

7046

}

7047

},

7048

"datatable-core": {

7049

"name": "datatable-core",

7050

"submodules": {},

7051

"classes": {

7052

"DataTable.Core": 1

7053

},

7054

"fors": {},

7055

"is_submodule": 1,

7056

"namespaces": {},

7057

"module": "datatable",

7058

"namespace": "",

7059

"file": "datatable/js/core.js",

7060

"line": 38,

7061

"description": "The core implementation of the `DataTable` and `DataTable.Base` Widgets.",

7062

"since": "3.5.0",

7063

"extra": {

7064

"selleck": {

7065

"name": "datatable",

7066

"displayName": "DataTable",

7067

"description": "The DataTable widget displays screen-reader accessible tabular data on a web page. Class extensions add functionality such as sorting and scrolling.",

7068

"author": [

7069

"lsmith"

7070

],

7071

"use": [

7072

"datatable"

7073

],

7074

"tags": [

7075

"beta",

7076

"widget",

7077

"datatable"

7078

],

7079

"pages": {

7080

"migration": {

7081

"displayName": "3.5.0+ Migration Guide"

7082

}

7083

}

7084

}

7085

}

7086

},

7087

"datatable-datasource": {

7088

"name": "datatable-datasource",

7089

"submodules": {},

7090

"classes": {

7091

"Plugin.DataTableDataSource": 1

7092

},

7093

"fors": {},

7094

"is_submodule": 1,

7095

"namespaces": {},

7096

"module": "datatable",

7097

"namespace": "",

7098

"file": "datatable/js/datatable-datasource.js",

7099

"line": 8,

7100

"description": "Plugs DataTable with DataSource integration.",

7101

"extra": {

7102

"selleck": {

7103

"name": "datatable",

7104

"displayName": "DataTable",

7105

"description": "The DataTable widget displays screen-reader accessible tabular data on a web page. Class extensions add functionality such as sorting and scrolling.",

7106

"author": [

7107

"lsmith"

7108

],

7109

"use": [

7110

"datatable"

7111

],

7112

"tags": [

7113

"beta",

7114

"widget",

7115

"datatable"

7116

],

7117

"pages": {

7118

"migration": {

7119

"displayName": "3.5.0+ Migration Guide"

7120

}

7121

}

7122

}

7123

}

7124

},

7125

"datatable-head": {

7126

"name": "datatable-head",

7127

"submodules": {},

7128

"classes": {

7129

"DataTable.HeaderView": 1

7130

},

7131

"fors": {},

7132

"is_submodule": 1,

7133

"namespaces": {

7134

"DataTable": 1

7135

},

7136

"module": "datatable",

7137

"namespace": "",

7138

"file": "datatable/js/head.js",

7139

"line": 17,

7140

"description": "View class responsible for rendering the `<thead>` section of a table. Used as\nthe default `headerView` for `Y.DataTable.Base` and `Y.DataTable` classes.",

7141

"since": "3.5.0",

7142

"extra": {

7143

"selleck": {

7144

"name": "datatable",

7145

"displayName": "DataTable",

7146

"description": "The DataTable widget displays screen-reader accessible tabular data on a web page. Class extensions add functionality such as sorting and scrolling.",

7147

"author": [

7148

"lsmith"

7149

],

7150

"use": [

7151

"datatable"

7152

],

7153

"tags": [

7154

"beta",

7155

"widget",

7156

"datatable"

7157

],

7158

"pages": {

7159

"migration": {

7160

"displayName": "3.5.0+ Migration Guide"

7161

}

7162

}

7163

}

7164

}

7165

},

7166

"datatable-message": {

7167

"name": "datatable-message",

7168

"submodules": {},

7169

"classes": {

7170

"DataTable.Message": 1

7171

},

7172

"fors": {},

7173

"is_submodule": 1,

7174

"namespaces": {},

7175

"module": "datatable",

7176

"namespace": "",

7177

"file": "datatable/js/message.js",

7178

"line": 12,

7179

"description": "Adds support for a message container to appear in the table. This can be used\nto indicate loading progress, lack of records, or any other communication\nneeded.",

7180

"since": "3.5.0",

7181

"extra": {

7182

"selleck": {

7183

"name": "datatable",

7184

"displayName": "DataTable",

7185

"description": "The DataTable widget displays screen-reader accessible tabular data on a web page. Class extensions add functionality such as sorting and scrolling.",

7186

"author": [

7187

"lsmith"

7188

],

7189

"use": [

7190

"datatable"

7191

],

7192

"tags": [

7193

"beta",

7194

"widget",

7195

"datatable"

7196

],

7197

"pages": {

7198

"migration": {

7199

"displayName": "3.5.0+ Migration Guide"

7200

}

7201

}

7202

}

7203

}

7204

},

7205

"datatable-mutable": {

7206

"name": "datatable-mutable",

7207

"submodules": {},

7208

"classes": {

7209

"DataTable.Mutable": 1

7210

},

7211

"fors": {},

7212

"is_submodule": 1,

7213

"namespaces": {},

7214

"module": "datatable",

7215

"namespace": "",

7216

"file": "datatable/js/mutable.js",

7217

"line": 17,

7218

"description": "Adds mutation convenience methods such as `table.addRow(data)` to `Y.DataTable`. (or other built class).",

7219

"since": "3.5.0",

7220

"extra": {

7221

"selleck": {

7222

"name": "datatable",

7223

"displayName": "DataTable",

7224

"description": "The DataTable widget displays screen-reader accessible tabular data on a web page. Class extensions add functionality such as sorting and scrolling.",

7225

"author": [

7226

"lsmith"

7227

],

7228

"use": [

7229

"datatable"

7230

],

7231

"tags": [

7232

"beta",

7233

"widget",

7234

"datatable"

7235

],

7236

"pages": {

7237

"migration": {

7238

"displayName": "3.5.0+ Migration Guide"

7239

}

7240

}

7241

}

7242

}

7243

},

7244

"datatable-scroll": {

7245

"name": "datatable-scroll",

7246

"submodules": {},

7247

"classes": {

7248

"DataTable.Scrollable": 1

7249

},

7250

"fors": {

7251

"DataTable": 1

7252

},

7253

"namespaces": {},

7254

"tag": "module",

7255

"file": "datatable/js/scroll.js",

7256

"line": 21,

7257

"description": "Adds the ability to make the table rows scrollable while preserving the header\nplacement.",

7258

"since": "3.5.0",

7259

"extra": {

7260

"selleck": {

7261

"name": "datatable",

7262

"displayName": "DataTable",

7263

"description": "The DataTable widget displays screen-reader accessible tabular data on a web page. Class extensions add functionality such as sorting and scrolling.",

7264

"author": [

7265

"lsmith"

7266

],

7267

"use": [

7268

"datatable"

7269

],

7270

"tags": [

7271

"beta",

7272

"widget",

7273

"datatable"

7274

],

7275

"pages": {

7276

"migration": {

7277

"displayName": "3.5.0+ Migration Guide"

7278

}

7279

}

7280

}

7281

}

7282

},

7283

"datatable-sort": {

7284

"name": "datatable-sort",

7285

"submodules": {},

7286

"classes": {

7287

"DataTable.Sortable": 1

7288

},

7289

"fors": {},

7290

"is_submodule": 1,

7291

"namespaces": {},

7292

"module": "datatable",

7293

"namespace": "",

7294

"file": "datatable/js/sort.js",

7295

"line": 26,

7296

"description": "Adds support for sorting the table data by API methods `table.sort(...)` or\n`table.toggleSort(...)` or by clicking on column headers in the rendered UI.",

7297

"since": "3.5.0",

7298

"extra": {

7299

"selleck": {

7300

"name": "datatable",

7301

"displayName": "DataTable",

7302

"description": "The DataTable widget displays screen-reader accessible tabular data on a web page. Class extensions add functionality such as sorting and scrolling.",

7303

"author": [

7304

"lsmith"

7305

],

7306

"use": [

7307

"datatable"

7308

],

7309

"tags": [

7310

"beta",

7311

"widget",

7312

"datatable"

7313

],

7314

"pages": {

7315

"migration": {

7316

"displayName": "3.5.0+ Migration Guide"

7317

}

7318

}

7319

}

7320

}

7321

},

7322

"datatype": {

7323

"name": "datatype",

7324

"submodules": {

7325

"datatype-date": 1,

7326

"datatype-date-format": 1,

7327

"datatype-date-math": 1,

7328

"datatype-date-parse": 1,

7329

"datatype-number": 1,

7330

"datatype-number-format": 1,

7331

"datatype-number-parse": 1,

7332

"datatype-xml-format": 1,

7333

"datatype-xml": 1,

7334

"datatype-xml-parse": 1

7335

},

7336

"classes": {

7337

"DataType.Date": 1,

7338

"DataType.Date.Locale": 1,

7339

"DataType.Number": 1,

7340

"DataType.XML": 1

7341

},

7342

"fors": {

7343

"DataType.Date": 1,

7344

"DataType.Number": 1,

7345

"DataType.XML": 1

7346

},

7347

"namespaces": {},

7348

"tag": "main",

7349

"file": "datatype/js/datatype-xml-format.js",

7350

"line": 15,

7351

"description": "The DataType Utility provides type-conversion and string-formatting\nconvenience methods for various JavaScript object types.",

7352

"itemtype": "main",

7353

"extra": {

7354

"selleck": {

7355

"name": "datatype",

7356

"displayName": "DataType",

7357

"description": "The DataType Utility provides a functionality to parse data into known JavaScript entities, such as numbers, dates, and XML documents, as well as convert such entities into formatted strings.",

7358

"author": [

7359

"allenrabinovich"

7360

],

7361

"use": [

7362

"datatype"

7363

],

7364

"tags": [

7365

"utility",

7366

"datatype"

7367

]

7368

}

7369

}

7370

},

7371

"datatype-date": {

7372

"name": "datatype-date",

7373

"submodules": {},

7374

"classes": {},

7375

"fors": {},

7376

"is_submodule": 1,

7377

"namespaces": {},

7378

"module": "datatype",

7379

"namespace": "",

7380

"file": "datatype/js/datatype-date-format.js",

7381

"line": 9,

7382

"description": "Date submodule.",

7383

"extra": {

7384

"selleck": {

7385

"name": "datatype",

7386

"displayName": "DataType",

7387

"description": "The DataType Utility provides a functionality to parse data into known JavaScript entities, such as numbers, dates, and XML documents, as well as convert such entities into formatted strings.",

7388

"author": [

7389

"allenrabinovich"

7390

],

7391

"use": [

7392

"datatype"

7393

],

7394

"tags": [

7395

"utility",

7396

"datatype"

7397

]

7398

}

7399

}

7400

},

7401

"datatype-date-format": {

7402

"name": "datatype-date-format",

7403

"submodules": {},

7404

"classes": {

7405

"DataType.Date": 1

7406

},

7407

"fors": {},

7408

"is_submodule": 1,

7409

"namespaces": {},

7410

"module": "datatype",

7411

"namespace": "",

7412

"file": "datatype/js/datatype-date-format.js",

7413

"line": 26,

7414

"description": "Format date submodule implements strftime formatters for javascript based on the\nOpen Group specification defined at\nhttp://www.opengroup.org/onlinepubs/007908799/xsh/strftime.html\nThis implementation does not include modified conversion specifiers (i.e., Ex and Ox)",

7415

"extra": {

7416

"selleck": {

7417

"name": "datatype",

7418

"displayName": "DataType",

7419

"description": "The DataType Utility provides a functionality to parse data into known JavaScript entities, such as numbers, dates, and XML documents, as well as convert such entities into formatted strings.",

7420

"author": [

7421

"allenrabinovich"

7422

],

7423

"use": [

7424

"datatype"

7425

],

7426

"tags": [

7427

"utility",

7428

"datatype"

7429

]

7430

}

7431

}

7432

},

7433

"datatype-date-math": {

7434

"name": "datatype-date-math",

7435

"submodules": {},

7436

"classes": {},

7437

"fors": {},

7438

"is_submodule": 1,

7439

"namespaces": {},

7440

"module": "datatype",

7441

"namespace": "",

7442

"file": "datatype/js/datatype-date-math.js",

7443

"line": 1,

7444

"description": "Datatype Date Math submodule.",

7445

"extra": {

7446

"selleck": {

7447

"name": "datatype",

7448

"displayName": "DataType",

7449

"description": "The DataType Utility provides a functionality to parse data into known JavaScript entities, such as numbers, dates, and XML documents, as well as convert such entities into formatted strings.",

7450

"author": [

7451

"allenrabinovich"

7452

],

7453

"use": [

7454

"datatype"

7455

],

7456

"tags": [

7457

"utility",

7458

"datatype"

7459

]

7460

}

7461

}

7462

},

7463

"datatype-date-parse": {

7464

"name": "datatype-date-parse",

7465

"submodules": {},

7466

"classes": {},

7467

"fors": {},

7468

"is_submodule": 1,

7469

"namespaces": {},

7470

"module": "datatype",

7471

"namespace": "",

7472

"file": "datatype/js/datatype-date-parse.js",

7473

"line": 1,

7474

"description": "Parse number submodule.",

7475

"extra": {

7476

"selleck": {

7477

"name": "datatype",

7478

"displayName": "DataType",

7479

"description": "The DataType Utility provides a functionality to parse data into known JavaScript entities, such as numbers, dates, and XML documents, as well as convert such entities into formatted strings.",

7480

"author": [

7481

"allenrabinovich"

7482

],

7483

"use": [

7484

"datatype"

7485

],

7486

"tags": [

7487

"utility",

7488

"datatype"

7489

]

7490

}

7491

}

7492

},

7493

"datatype-number": {

7494

"name": "datatype-number",

7495

"submodules": {},

7496

"classes": {},

7497

"fors": {},

7498

"is_submodule": 1,

7499

"namespaces": {},

7500

"module": "datatype",

7501

"namespace": "",

7502

"file": "datatype/js/datatype-number-format.js",

7503

"line": 1,

7504

"description": "Number submodule.",

7505

"extra": {

7506

"selleck": {

7507

"name": "datatype",

7508

"displayName": "DataType",

7509

"description": "The DataType Utility provides a functionality to parse data into known JavaScript entities, such as numbers, dates, and XML documents, as well as convert such entities into formatted strings.",

7510

"author": [

7511

"allenrabinovich"

7512

],

7513

"use": [

7514

"datatype"

7515

],

7516

"tags": [

7517

"utility",

7518

"datatype"

7519

]

7520

}

7521

}

7522

},

7523

"datatype-number-format": {

7524

"name": "datatype-number-format",

7525

"submodules": {},

7526

"classes": {

7527

"DataType.Number": 1

7528

},

7529

"fors": {},

7530

"is_submodule": 1,

7531

"namespaces": {},

7532

"module": "datatype",

7533

"namespace": "",

7534

"file": "datatype/js/datatype-number-format.js",

7535

"line": 15,

7536

"description": "Format number submodule.",

7537

"extra": {

7538

"selleck": {

7539

"name": "datatype",

7540

"displayName": "DataType",

7541

"description": "The DataType Utility provides a functionality to parse data into known JavaScript entities, such as numbers, dates, and XML documents, as well as convert such entities into formatted strings.",

7542

"author": [

7543

"allenrabinovich"

7544

],

7545

"use": [

7546

"datatype"

7547

],

7548

"tags": [

7549

"utility",

7550

"datatype"

7551

]

7552

}

7553

}

7554

},

7555

"datatype-number-parse": {

7556

"name": "datatype-number-parse",

7557

"submodules": {},

7558

"classes": {},

7559

"fors": {},

7560

"is_submodule": 1,

7561

"namespaces": {},

7562

"module": "datatype",

7563

"namespace": "",

7564

"file": "datatype/js/datatype-number-parse.js",

7565

"line": 1,

7566

"description": "Parse number submodule.",

7567

"extra": {

7568

"selleck": {

7569

"name": "datatype",

7570

"displayName": "DataType",

7571

"description": "The DataType Utility provides a functionality to parse data into known JavaScript entities, such as numbers, dates, and XML documents, as well as convert such entities into formatted strings.",

7572

"author": [

7573

"allenrabinovich"

7574

],

7575

"use": [

7576

"datatype"

7577

],

7578

"tags": [

7579

"utility",

7580

"datatype"

7581

]

7582

}

7583

}

7584

},

7585

"datatype-xml-format": {

7586

"name": "datatype-xml-format",

7587

"submodules": {},

7588

"classes": {},

7589

"fors": {},

7590

"is_submodule": 1,

7591

"namespaces": {},

7592

"module": "datatype",

7593

"namespace": "",

7594

"file": "datatype/js/datatype-xml-format.js",

7595

"line": 1,

7596

"description": "Format XML submodule.",

7597

"extra": {

7598

"selleck": {

7599

"name": "datatype",

7600

"displayName": "DataType",

7601

"description": "The DataType Utility provides a functionality to parse data into known JavaScript entities, such as numbers, dates, and XML documents, as well as convert such entities into formatted strings.",

7602

"author": [

7603

"allenrabinovich"

7604

],

7605

"use": [

7606

"datatype"

7607

],

7608

"tags": [

7609

"utility",

7610

"datatype"

7611

]

7612

}

7613

}

7614

},

7615

"datatype-xml": {

7616

"name": "datatype-xml",

7617

"submodules": {},

7618

"classes": {

7619

"DataType.XML": 1

7620

},

7621

"fors": {},

7622

"is_submodule": 1,

7623

"namespaces": {},

7624

"module": "datatype",

7625

"namespace": "",

7626

"file": "datatype/js/datatype-xml-format.js",

7627

"line": 15,

7628

"description": "XML submodule.",

7629

"extra": {

7630

"selleck": {

7631

"name": "datatype",

7632

"displayName": "DataType",

7633

"description": "The DataType Utility provides a functionality to parse data into known JavaScript entities, such as numbers, dates, and XML documents, as well as convert such entities into formatted strings.",

7634

"author": [

7635

"allenrabinovich"

7636

],

7637

"use": [

7638

"datatype"

7639

],

7640

"tags": [

7641

"utility",

7642

"datatype"

7643

]

7644

}

7645

}

7646

},

7647

"datatype-xml-parse": {

7648

"name": "datatype-xml-parse",

7649

"submodules": {},

7650

"classes": {},

7651

"fors": {},

7652

"is_submodule": 1,

7653

"namespaces": {},

7654

"module": "datatype",

7655

"namespace": "",

7656

"file": "datatype/js/datatype-xml-parse.js",

7657

"line": 1,

7658

"description": "Parse XML submodule.",

7659

"extra": {

7660

"selleck": {

7661

"name": "datatype",

7662

"displayName": "DataType",

7663

"description": "The DataType Utility provides a functionality to parse data into known JavaScript entities, such as numbers, dates, and XML documents, as well as convert such entities into formatted strings.",

7664

"author": [

7665

"allenrabinovich"

7666

],

7667

"use": [

7668

"datatype"

7669

],

7670

"tags": [

7671

"utility",

7672

"datatype"

7673

]

7674

}

7675

}

7676

},

7677

"dd": {

7678

"name": "dd",

7679

"submodules": {

7680

"dd-constrain": 1,

7681

"dd-drop-plugin": 1,

7682

"dd-plugin": 1,

7683

"dd-ddm-base": 1,

7684

"dd-ddm-drop": 1,

7685

"dd-ddm": 1,

7686

"dd-delegate": 1,

7687

"dd-drag": 1,

7688

"dd-drop": 1,

7689

"dd-proxy": 1,

7690

"dd-scroll": 1

7691

},

7692

"classes": {

7693

"Plugin.DDConstrained": 1,

7694

"DD.DDM": 1,

7695

"Plugin.Drop": 1,

7696

"Plugin.Drag": 1,

7697

"DD.Delegate": 1,

7698

"DD.Drag": 1,

7699

"DD.Drop": 1,

7700

"Plugin.DDProxy": 1,

7701

"DD.Scroll": 1,

7702

"Plugin.DDWindowScroll": 1,

7703

"Plugin.DDNodeScroll": 1

7704

},

7705

"fors": {

7706

"DDM": 1,

7707

"DD.DDM": 1

7708

},

7709

"namespaces": {

7710

"Plugin": 1,

7711

"DD": 1

7712

},

7713

"file": "dd/js/scroll.js",

7714

"line": 362,

7715

"description": "The Drag & Drop Utility allows you to create a draggable interface efficiently, buffering you from browser-level abnormalities and enabling you to focus on the interesting logic surrounding your particular implementation. This component enables you to create a variety of standard draggable objects with just a few lines of code and then, using its extensive API, add your own specific implementation logic.",

7716

"tag": "main",

7717

"itemtype": "main",

7718

"extra": {

7719

"selleck": {

7720

"name": "dd",

7721

"displayName": "Drag and Drop",

7722

"description": "The Drag and Drop Utility allows you to create a draggable interface efficiently, buffering you from browser-level abnormalities and enabling you to focus on the interesting logic surrounding your particular implementation. This component enables you to create a variety of standard draggable objects with just a few lines of code and then, using its extensive API, add your own specific implementation logic.",

7723

"author": "davglass",

7724

"tags": [

7725

"utility",

7726

"mobile",

7727

"dd",

7728

"dragdrop",

7729

"drag drop",

7730

"drag"

7731

],

7732

"use": [

7733

"dd"

7734

],

7735

"pages": {

7736

"anim-drop-example": {

7737

"displayName": "Animated Drop Targets",

7738

"layout": "anim-drop-example"

7739

},

7740

"photo-browser-example": {

7741

"displayName": "Photo Browser",

7742

"layout": "photo-browser-example"

7743

},

7744

"portal-example": {

7745

"displayName": "Portal Example",

7746

"layout": "portal-example"

7747

}

7748

}

7749

}

7750

}

7751

},

7752

"dd-constrain": {

7753

"name": "dd-constrain",

7754

"submodules": {},

7755

"classes": {

7756

"Plugin.DDConstrained": 1

7757

},

7758

"fors": {},

7759

"is_submodule": 1,

7760

"namespaces": {

7761

"Plugin": 1,

7762

"DD": 1

7763

},

7764

"module": "dd",

7765

"namespace": "",

7766

"file": "dd/js/constrain.js",

7767

"line": 8,

7768

"description": "The Drag & Drop Utility allows you to create a draggable interface efficiently, buffering you from browser-level abnormalities and enabling you to focus on the interesting logic surrounding your particular implementation. This component enables you to create a variety of standard draggable objects with just a few lines of code and then, using its extensive API, add your own specific implementation logic.",

7769

"tag": "main",

7770

"itemtype": "main",

7771

"extra": {

7772

"selleck": {

7773

"name": "dd",

7774

"displayName": "Drag and Drop",

7775

"description": "The Drag and Drop Utility allows you to create a draggable interface efficiently, buffering you from browser-level abnormalities and enabling you to focus on the interesting logic surrounding your particular implementation. This component enables you to create a variety of standard draggable objects with just a few lines of code and then, using its extensive API, add your own specific implementation logic.",

7776

"author": "davglass",

7777

"tags": [

7778

"utility",

7779

"mobile",

7780

"dd",

7781

"dragdrop",

7782

"drag drop",

7783

"drag"

7784

],

7785

"use": [

7786

"dd"

7787

],

7788

"pages": {

7789

"anim-drop-example": {

7790

"displayName": "Animated Drop Targets",

7791

"layout": "anim-drop-example"

7792

},

7793

"photo-browser-example": {

7794

"displayName": "Photo Browser",

7795

"layout": "photo-browser-example"

7796

},

7797

"portal-example": {

7798

"displayName": "Portal Example",

7799

"layout": "portal-example"

7800

}

7801

}

7802

}

7803

}

7804

},

7805

"dd-drop-plugin": {

7806

"name": "dd-drop-plugin",

7807

"submodules": {},

7808

"classes": {

7809

"Plugin.Drop": 1

7810

},

7811

"fors": {},

7812

"is_submodule": 1,

7813

"namespaces": {

7814

"Plugin": 1

7815

},

7816

"module": "dd",

7817

"namespace": "",

7818

"file": "dd/js/dd-drop-plugin.js",

7819

"line": 7,

7820

"description": "Simple Drop plugin that can be attached to a Node via the plug method.",

7821

"extra": {

7822

"selleck": {

7823

"name": "dd",

7824

"displayName": "Drag and Drop",

7825

"description": "The Drag and Drop Utility allows you to create a draggable interface efficiently, buffering you from browser-level abnormalities and enabling you to focus on the interesting logic surrounding your particular implementation. This component enables you to create a variety of standard draggable objects with just a few lines of code and then, using its extensive API, add your own specific implementation logic.",

7826

"author": "davglass",

7827

"tags": [

7828

"utility",

7829

"mobile",

7830

"dd",

7831

"dragdrop",

7832

"drag drop",

7833

"drag"

7834

],

7835

"use": [

7836

"dd"

7837

],

7838

"pages": {

7839

"anim-drop-example": {

7840

"displayName": "Animated Drop Targets",

7841

"layout": "anim-drop-example"

7842

},

7843

"photo-browser-example": {

7844

"displayName": "Photo Browser",

7845

"layout": "photo-browser-example"

7846

},

7847

"portal-example": {

7848

"displayName": "Portal Example",

7849

"layout": "portal-example"

7850

}

7851

}

7852

}

7853

}

7854

},

7855

"dd-plugin": {

7856

"name": "dd-plugin",

7857

"submodules": {},

7858

"classes": {

7859

"Plugin.Drag": 1

7860

},

7861

"fors": {},

7862

"is_submodule": 1,

7863

"namespaces": {

7864

"Plugin": 1

7865

},

7866

"module": "dd",

7867

"namespace": "",

7868

"file": "dd/js/dd-plugin.js",

7869

"line": 8,

7870

"description": "Simple Drag plugin that can be attached to a Node or Widget via the plug method.",

7871

"extra": {

7872

"selleck": {

7873

"name": "dd",

7874

"displayName": "Drag and Drop",

7875

"description": "The Drag and Drop Utility allows you to create a draggable interface efficiently, buffering you from browser-level abnormalities and enabling you to focus on the interesting logic surrounding your particular implementation. This component enables you to create a variety of standard draggable objects with just a few lines of code and then, using its extensive API, add your own specific implementation logic.",

7876

"author": "davglass",

7877

"tags": [

7878

"utility",

7879

"mobile",

7880

"dd",

7881

"dragdrop",

7882

"drag drop",

7883

"drag"

7884

],

7885

"use": [

7886

"dd"

7887

],

7888

"pages": {

7889

"anim-drop-example": {

7890

"displayName": "Animated Drop Targets",

7891

"layout": "anim-drop-example"

7892

},

7893

"photo-browser-example": {

7894

"displayName": "Photo Browser",

7895

"layout": "photo-browser-example"

7896

},

7897

"portal-example": {

7898

"displayName": "Portal Example",

7899

"layout": "portal-example"

7900

}

7901

}

7902

}

7903

}

7904

},

7905

"dd-ddm-base": {

7906

"name": "dd-ddm-base",

7907

"submodules": {},

7908

"classes": {

7909

"DD.DDM": 1

7910

},

7911

"fors": {},

7912

"is_submodule": 1,

7913

"namespaces": {

7914

"DD": 1

7915

},

7916

"module": "dd",

7917

"namespace": "",

7918

"file": "dd/js/ddm-base.js",

7919

"line": 7,

7920

"description": "Provides the base Drag Drop Manger required for making a Node draggable.",

7921

"extra": {

7922

"selleck": {

7923

"name": "dd",

7924

"displayName": "Drag and Drop",

7925

"description": "The Drag and Drop Utility allows you to create a draggable interface efficiently, buffering you from browser-level abnormalities and enabling you to focus on the interesting logic surrounding your particular implementation. This component enables you to create a variety of standard draggable objects with just a few lines of code and then, using its extensive API, add your own specific implementation logic.",

7926

"author": "davglass",

7927

"tags": [

7928

"utility",

7929

"mobile",

7930

"dd",

7931

"dragdrop",

7932

"drag drop",

7933

"drag"

7934

],

7935

"use": [

7936

"dd"

7937

],

7938

"pages": {

7939

"anim-drop-example": {

7940

"displayName": "Animated Drop Targets",

7941

"layout": "anim-drop-example"

7942

},

7943

"photo-browser-example": {

7944

"displayName": "Photo Browser",

7945

"layout": "photo-browser-example"

7946

},

7947

"portal-example": {

7948

"displayName": "Portal Example",

7949

"layout": "portal-example"

7950

}

7951

}

7952

}

7953

}

7954

},

7955

"dd-ddm-drop": {

7956

"name": "dd-ddm-drop",

7957

"submodules": {},

7958

"classes": {},

7959

"fors": {},

7960

"is_submodule": 1,

7961

"namespaces": {

7962

"DD": 1

7963

},

7964

"module": "dd",

7965

"namespace": "",

7966

"file": "dd/js/ddm-drop.js",

7967

"line": 2,

7968

"description": "Extends the dd-ddm Class to add support for the placement of Drop Target shims inside the viewport shim. It also handles all Drop Target related events and interactions.",

7969

"extra": {

7970

"selleck": {

7971

"name": "dd",

7972

"displayName": "Drag and Drop",

7973

"description": "The Drag and Drop Utility allows you to create a draggable interface efficiently, buffering you from browser-level abnormalities and enabling you to focus on the interesting logic surrounding your particular implementation. This component enables you to create a variety of standard draggable objects with just a few lines of code and then, using its extensive API, add your own specific implementation logic.",

7974

"author": "davglass",

7975

"tags": [

7976

"utility",

7977

"mobile",

7978

"dd",

7979

"dragdrop",

7980

"drag drop",

7981

"drag"

7982

],

7983

"use": [

7984

"dd"

7985

],

7986

"pages": {

7987

"anim-drop-example": {

7988

"displayName": "Animated Drop Targets",

7989

"layout": "anim-drop-example"

7990

},

7991

"photo-browser-example": {

7992

"displayName": "Photo Browser",

7993

"layout": "photo-browser-example"

7994

},

7995

"portal-example": {

7996

"displayName": "Portal Example",

7997

"layout": "portal-example"

7998

}

7999

}

8000

}

8001

}

8002

},

8003

"dd-ddm": {

8004

"name": "dd-ddm",

8005

"submodules": {},

8006

"classes": {},

8007

"fors": {},

8008

"is_submodule": 1,

8009

"namespaces": {

8010

"DD": 1

8011

},

8012

"module": "dd",

8013

"namespace": "",

8014

"file": "dd/js/ddm.js",

8015

"line": 2,

8016

"description": "Extends the dd-ddm-base Class to add support for the viewport shim to allow a draggable node to drag to be dragged over an iframe or any other node that traps mousemove events.\nIt is also required to have Drop Targets enabled, as the viewport shim will contain the shims for the Drop Targets.",

8017

"extra": {

8018

"selleck": {

8019

"name": "dd",

8020

"displayName": "Drag and Drop",

8021

"description": "The Drag and Drop Utility allows you to create a draggable interface efficiently, buffering you from browser-level abnormalities and enabling you to focus on the interesting logic surrounding your particular implementation. This component enables you to create a variety of standard draggable objects with just a few lines of code and then, using its extensive API, add your own specific implementation logic.",

8022

"author": "davglass",

8023

"tags": [

8024

"utility",

8025

"mobile",

8026

"dd",

8027

"dragdrop",

8028

"drag drop",

8029

"drag"

8030

],

8031

"use": [

8032

"dd"

8033

],

8034

"pages": {

8035

"anim-drop-example": {

8036

"displayName": "Animated Drop Targets",

8037

"layout": "anim-drop-example"

8038

},

8039

"photo-browser-example": {

8040

"displayName": "Photo Browser",

8041

"layout": "photo-browser-example"

8042

},

8043

"portal-example": {

8044

"displayName": "Portal Example",

8045

"layout": "portal-example"

8046

}

8047

}

8048

}

8049

}

8050

},

8051

"dd-delegate": {

8052

"name": "dd-delegate",

8053

"submodules": {},

8054

"classes": {

8055

"DD.Delegate": 1

8056

},

8057

"fors": {},

8058

"is_submodule": 1,

8059

"namespaces": {

8060

"DD": 1

8061

},

8062

"module": "dd",

8063

"namespace": "",

8064

"file": "dd/js/delegate.js",

8065

"line": 7,

8066

"description": "Provides the ability to drag multiple nodes under a container element using only one Y.DD.Drag instance as a delegate.",

8067

"extra": {

8068

"selleck": {

8069

"name": "dd",

8070

"displayName": "Drag and Drop",

8071

"description": "The Drag and Drop Utility allows you to create a draggable interface efficiently, buffering you from browser-level abnormalities and enabling you to focus on the interesting logic surrounding your particular implementation. This component enables you to create a variety of standard draggable objects with just a few lines of code and then, using its extensive API, add your own specific implementation logic.",

8072

"author": "davglass",

8073

"tags": [

8074

"utility",

8075

"mobile",

8076

"dd",

8077

"dragdrop",

8078

"drag drop",

8079

"drag"

8080

],

8081

"use": [

8082

"dd"

8083

],

8084

"pages": {

8085

"anim-drop-example": {

8086

"displayName": "Animated Drop Targets",

8087

"layout": "anim-drop-example"

8088

},

8089

"photo-browser-example": {

8090

"displayName": "Photo Browser",

8091

"layout": "photo-browser-example"

8092

},

8093

"portal-example": {

8094

"displayName": "Portal Example",

8095

"layout": "portal-example"

8096

}

8097

}

8098

}

8099

}

8100

},

8101

"dd-drag": {

8102

"name": "dd-drag",

8103

"submodules": {},

8104

"classes": {

8105

"DD.Drag": 1

8106

},

8107

"fors": {},

8108

"is_submodule": 1,

8109

"namespaces": {

8110

"DD": 1

8111

},

8112

"module": "dd",

8113

"namespace": "",

8114

"file": "dd/js/drag.js",

8115

"line": 7,

8116

"description": "Provides the ability to drag a Node.",

8117

"extra": {

8118

"selleck": {

8119

"name": "dd",

8120

"displayName": "Drag and Drop",

8121

"description": "The Drag and Drop Utility allows you to create a draggable interface efficiently, buffering you from browser-level abnormalities and enabling you to focus on the interesting logic surrounding your particular implementation. This component enables you to create a variety of standard draggable objects with just a few lines of code and then, using its extensive API, add your own specific implementation logic.",

8122

"author": "davglass",

8123

"tags": [

8124

"utility",

8125

"mobile",

8126

"dd",

8127

"dragdrop",

8128

"drag drop",

8129

"drag"

8130

],

8131

"use": [

8132

"dd"

8133

],

8134

"pages": {

8135

"anim-drop-example": {

8136

"displayName": "Animated Drop Targets",

8137

"layout": "anim-drop-example"

8138

},

8139

"photo-browser-example": {

8140

"displayName": "Photo Browser",

8141

"layout": "photo-browser-example"

8142

},

8143

"portal-example": {

8144

"displayName": "Portal Example",

8145

"layout": "portal-example"

8146

}

8147

}

8148

}

8149

}

8150

},

8151

"dd-drop": {

8152

"name": "dd-drop",

8153

"submodules": {},

8154

"classes": {

8155

"DD.Drop": 1

8156

},

8157

"fors": {},

8158

"is_submodule": 1,

8159

"namespaces": {

8160

"DD": 1

8161

},

8162

"module": "dd",

8163

"namespace": "",

8164

"file": "dd/js/drop.js",

8165

"line": 7,

8166

"description": "Provides the ability to create a Drop Target.",

8167

"extra": {

8168

"selleck": {

8169

"name": "dd",

8170

"displayName": "Drag and Drop",

8171

"description": "The Drag and Drop Utility allows you to create a draggable interface efficiently, buffering you from browser-level abnormalities and enabling you to focus on the interesting logic surrounding your particular implementation. This component enables you to create a variety of standard draggable objects with just a few lines of code and then, using its extensive API, add your own specific implementation logic.",

8172

"author": "davglass",

8173

"tags": [

8174

"utility",

8175

"mobile",

8176

"dd",

8177

"dragdrop",

8178

"drag drop",

8179

"drag"

8180

],

8181

"use": [

8182

"dd"

8183

],

8184

"pages": {

8185

"anim-drop-example": {

8186

"displayName": "Animated Drop Targets",

8187

"layout": "anim-drop-example"

8188

},

8189

"photo-browser-example": {

8190

"displayName": "Photo Browser",

8191

"layout": "photo-browser-example"

8192

},

8193

"portal-example": {

8194

"displayName": "Portal Example",

8195

"layout": "portal-example"

8196

}

8197

}

8198

}

8199

}

8200

},

8201

"dd-proxy": {

8202

"name": "dd-proxy",

8203

"submodules": {},

8204

"classes": {

8205

"Plugin.DDProxy": 1

8206

},

8207

"fors": {},

8208

"is_submodule": 1,

8209

"namespaces": {

8210

"Plugin": 1,

8211

"DD": 1

8212

},

8213

"module": "dd",

8214

"namespace": "",

8215

"file": "dd/js/proxy.js",

8216

"line": 7,

8217

"description": "Plugin for dd-drag for creating a proxy drag node, instead of dragging the original node.",

8218

"extra": {

8219

"selleck": {

8220

"name": "dd",

8221

"displayName": "Drag and Drop",

8222

"description": "The Drag and Drop Utility allows you to create a draggable interface efficiently, buffering you from browser-level abnormalities and enabling you to focus on the interesting logic surrounding your particular implementation. This component enables you to create a variety of standard draggable objects with just a few lines of code and then, using its extensive API, add your own specific implementation logic.",

8223

"author": "davglass",

8224

"tags": [

8225

"utility",

8226

"mobile",

8227

"dd",

8228

"dragdrop",

8229

"drag drop",

8230

"drag"

8231

],

8232

"use": [

8233

"dd"

8234

],

8235

"pages": {

8236

"anim-drop-example": {

8237

"displayName": "Animated Drop Targets",

8238

"layout": "anim-drop-example"

8239

},

8240

"photo-browser-example": {

8241

"displayName": "Photo Browser",

8242

"layout": "photo-browser-example"

8243

},

8244

"portal-example": {

8245

"displayName": "Portal Example",

8246

"layout": "portal-example"

8247

}

8248

}

8249

}

8250

}

8251

},

8252

"dd-scroll": {

8253

"name": "dd-scroll",

8254

"submodules": {},

8255

"classes": {

8256

"DD.Scroll": 1,

8257

"Plugin.DDWindowScroll": 1,

8258

"Plugin.DDNodeScroll": 1

8259

},

8260

"fors": {},

8261

"is_submodule": 1,

8262

"namespaces": {

8263

"DD": 1,

8264

"Plugin": 1

8265

},

8266

"module": "dd",

8267

"namespace": "",

8268

"file": "dd/js/scroll.js",

8269

"line": 362,

8270

"description": "Base scroller class used to create the Plugin.DDNodeScroll and Plugin.DDWinScroll.\nThis class should not be called on it's own, it's designed to be a plugin.",

8271

"extra": {

8272

"selleck": {

8273

"name": "dd",

8274

"displayName": "Drag and Drop",

8275

"description": "The Drag and Drop Utility allows you to create a draggable interface efficiently, buffering you from browser-level abnormalities and enabling you to focus on the interesting logic surrounding your particular implementation. This component enables you to create a variety of standard draggable objects with just a few lines of code and then, using its extensive API, add your own specific implementation logic.",

8276

"author": "davglass",

8277

"tags": [

8278

"utility",

8279

"mobile",

8280

"dd",

8281

"dragdrop",

8282

"drag drop",

8283

"drag"

8284

],

8285

"use": [

8286

"dd"

8287

],

8288

"pages": {

8289

"anim-drop-example": {

8290

"displayName": "Animated Drop Targets",

8291

"layout": "anim-drop-example"

8292

},

8293

"photo-browser-example": {

8294

"displayName": "Photo Browser",

8295

"layout": "photo-browser-example"

8296

},

8297

"portal-example": {

8298

"displayName": "Portal Example",

8299

"layout": "portal-example"

8300

}

8301

}

8302

}

8303

}

8304

},

8305

"dial": {

8306

"name": "dial",

8307

"submodules": {},

8308

"classes": {

8309

"Dial": 1

8310

},

8311

"fors": {

8312

"DOM": 1

8313

},

8314

"namespaces": {},

8315

"tag": "module",

8316

"file": "dial/js/Dial.js",

8317

"line": 18,

8318

"description": "Create a circular dial value range input visualized as a draggable handle on a\nbackground element.",

8319

"extra": {

8320

"selleck": {

8321

"name": "dial",

8322

"displayName": "Dial",

8323

"description": "The Dial widget is a circular value input control.",

8324

"author": "jconniff",

8325

"tags": [

8326

"widget",

8327

"beta",

8328

"dial",

8329

"round",

8330

"knob",

8331

"gauge",

8332

"wheel"

8333

],

8334

"use": [

8335

"dial"

8336

],

8337

"dialPathAssets": "http://yuilibrary.com/yui/docs/assets/dial"

8338

}

8339

}

8340

},

8341

"dom": {

8342

"name": "dom",

8343

"submodules": {

8344

"dom-base": 1,

8345

"dom-screen": 1,

8346

"dom-style": 1,

8347

"selector-css2": 1,

8348

"selector-css3": 1,

8349

"selector-native": 1

8350

},

8351

"classes": {

8352

"DOM": 1,

8353

"Selector": 1

8354

},

8355

"fors": {

8356

"DOM": 1,

8357

"Selector": 1

8358

},

8359

"namespaces": {},

8360

"tag": "main",

8361

"file": "dom/js/selector-native.js",

8362

"line": 9,

8363

"description": "The DOM utility provides a cross-browser abtraction layer\nnormalizing DOM tasks, and adds extra helper functionality\nfor other common tasks.",

8364

"itemtype": "main"

8365

},

8366

"dom-base": {

8367

"name": "dom-base",

8368

"submodules": {},

8369

"classes": {

8370

"DOM": 1

8371

},

8372

"fors": {},

8373

"is_submodule": 1,

8374

"namespaces": {},

8375

"module": "dom",

8376

"namespace": "",

8377

"file": "dom/js/dom-core.js",

8378

"line": 25,

8379

"description": "The DOM utility provides a cross-browser abtraction layer\nnormalizing DOM tasks, and adds extra helper functionality\nfor other common tasks.",

8380

"tag": "main",

8381

"itemtype": "main"

8382

},

8383

"dom-screen": {

8384

"name": "dom-screen",

8385

"submodules": {},

8386

"classes": {},

8387

"fors": {},

8388

"is_submodule": 1,

8389

"namespaces": {},

8390

"module": "dom",

8391

"namespace": "",

8392

"file": "dom/js/dom-screen.js",

8393

"line": 3,

8394

"description": "Adds position and region management functionality to DOM."

8395

},

8396

"dom-style": {

8397

"name": "dom-style",

8398

"submodules": {},

8399

"classes": {},

8400

"fors": {},

8401

"is_submodule": 1,

8402

"namespaces": {},

8403

"module": "dom",

8404

"namespace": "",

8405

"file": "dom/js/dom-style.js",

8406

"line": 2,

8407

"description": "Add style management functionality to DOM."

8408

},

8409

"selector-css2": {

8410

"name": "selector-css2",

8411

"submodules": {},

8412

"classes": {},

8413

"fors": {},

8414

"is_submodule": 1,

8415

"namespaces": {},

8416

"module": "dom",

8417

"namespace": "",

8418

"file": "dom/js/selector-css2.js",

8419

"line": 1,

8420

"description": "The selector module provides helper methods allowing CSS2 Selectors to be used with DOM elements."

8421

},

8422

"selector-css3": {

8423

"name": "selector-css3",

8424

"submodules": {},

8425

"classes": {},

8426

"fors": {},

8427

"is_submodule": 1,

8428

"namespaces": {},

8429

"module": "dom",

8430

"namespace": "",

8431

"file": "dom/js/selector-css3.js",

8432

"line": 1,

8433

"description": "The selector css3 module provides support for css3 selectors."

8434

},

8435

"selector-native": {

8436

"name": "selector-native",

8437

"submodules": {},

8438

"classes": {

8439

"Selector": 1

8440

},

8441

"fors": {},

8442

"is_submodule": 1,

8443

"namespaces": {},

8444

"module": "dom",

8445

"namespace": "",

8446

"file": "dom/js/selector-native.js",

8447

"line": 9,

8448

"description": "The selector-native module provides support for native querySelector"

8449

},

8450

"dump": {

8451

"name": "dump",

8452

"submodules": {},

8453

"classes": {},

8454

"fors": {

8455

"YUI": 1

8456

},

8457

"namespaces": {},

8458

"tag": "module",

8459

"file": "dump/js/dump.js",

8460

"line": 1,

8461

"description": "Returns a simple string representation of the object or array.\nOther types of objects will be returned unprocessed. Arrays\nare expected to be indexed. Use object notation for\nassociative arrays.\n\nIf included, the dump method is added to the YUI instance."

8462

},

8463

"createlink-base": {

8464

"name": "createlink-base",

8465

"submodules": {},

8466

"classes": {

8467

"Plugin.CreateLinkBase": 1

8468

},

8469

"fors": {},

8470

"is_submodule": 1,

8471

"namespaces": {},

8472

"module": "editor",

8473

"namespace": "",

8474

"description": "Adds prompt style link creation. Adds an override for the <a href=\"Plugin.ExecCommand.html#method_COMMANDS.createlink\">createlink execCommand</a>.",

8475

"file": "editor/js/createlink-base.js",

8476

"line": 2

8477

},

8478

"editor": {

8479

"name": "editor",

8480

"submodules": {

8481

"createlink-base": 1,

8482

"editor-base": 1,

8483

"editor-bidi": 1,

8484

"editor-br": 1,

8485

"editor-para-base": 1,

8486

"editor-para-ie": 1,

8487

"editor-para": 1,

8488

"selection": 1,

8489

"editor-tab": 1,

8490

"exec-command": 1,

8491

"frame": 1,

8492

"editor-lists": 1

8493

},

8494

"classes": {

8495

"Plugin.CreateLinkBase": 1,

8496

"ExecCommand": 1,

8497

"EditorBase": 1,

8498

"Plugin.EditorBidi": 1,

8499

"Plugin.ExecCommand": 1,

8500

"Plugin.EditorBR": 1,

8501

"Plugin.EditorParaBase": 1,

8502

"Plugin.EditorParaIE": 1,

8503

"Plugin.EditorPara": 1,

8504

"EditorSelection": 1,

8505

"Plugin.EditorTab": 1,

8506

"Frame": 1,

8507

"Plugin.EditorLists": 1

8508

},

8509

"fors": {

8510

"ExecCommand": 1,

8511

"Plugin.ExecCommand": 1,

8512

"Frame": 1

8513

},

8514

"namespaces": {},

8515

"file": "editor/js/lists.js",

8516

"line": 2,

8517

"description": "Base class for Editor. Handles the business logic of Editor, no GUI involved only utility methods and events.\n\n var editor = new Y.EditorBase({\n content: 'Foo'\n });\n editor.render('#demo');",

8518

"extends": "Base",

8519

"tag": "main",

8520

"itemtype": "main",

8521

"extra": {

8522

"selleck": {

8523

"name": "editor",

8524

"displayName": "Rich Text Editor",

8525

"description": "The Rich Text Editor is a UI control that allows for the rich formatting of text content, including common structural treatments like lists, formatting treatments like bold and italic text.",

8526

"author": "davglass",

8527

"tags": [

8528

"utility",

8529

"beta",

8530

"editor",

8531

"api",

8532

"iframe",

8533

"frame",

8534

"html",

8535

"markup"

8536

],

8537

"use": [

8538

"editor"

8539

]

8540

}

8541

}

8542

},

8543

"editor-base": {

8544

"name": "editor-base",

8545

"submodules": {},

8546

"classes": {

8547

"EditorBase": 1

8548

},

8549

"fors": {},

8550

"is_submodule": 1,

8551

"namespaces": {},

8552

"module": "editor",

8553

"namespace": "",

8554

"description": "Base class for Editor. Handles the business logic of Editor, no GUI involved only utility methods and events.\n\n var editor = new Y.EditorBase({\n content: 'Foo'\n });\n editor.render('#demo');",

8555

"file": "editor/js/editor-base.js",

8556

"line": 2

8557

},

8558

"editor-bidi": {

8559

"name": "editor-bidi",

8560

"submodules": {},

8561

"classes": {

8562

"Plugin.EditorBidi": 1

8563

},

8564

"fors": {},

8565

"is_submodule": 1,

8566

"namespaces": {},

8567

"module": "editor",

8568

"namespace": "",

8569

"description": "Plugin for Editor to support BiDirectional (bidi) text operations.",

8570

"file": "editor/js/editor-bidi.js",

8571

"line": 2

8572

},

8573

"editor-br": {

8574

"name": "editor-br",

8575

"submodules": {},

8576

"classes": {

8577

"Plugin.EditorBR": 1

8578

},

8579

"fors": {},

8580

"is_submodule": 1,

8581

"namespaces": {},

8582

"module": "editor",

8583

"namespace": "",

8584

"description": "Plugin for Editor to normalize BR's.",

8585

"file": "editor/js/editor-br.js",

8586

"line": 3

8587

},

8588

"editor-para-base": {

8589

"name": "editor-para-base",

8590

"submodules": {},

8591

"classes": {

8592

"Plugin.EditorParaBase": 1

8593

},

8594

"fors": {},

8595

"is_submodule": 1,

8596

"namespaces": {},

8597

"module": "editor",

8598

"namespace": "",

8599

"description": "Base Plugin for Editor to paragraph auto wrapping and correction.",

8600

"file": "editor/js/editor-para-base.js",

8601

"line": 2

8602

},

8603

"editor-para-ie": {

8604

"name": "editor-para-ie",

8605

"submodules": {},

8606

"classes": {

8607

"Plugin.EditorParaIE": 1

8608

},

8609

"fors": {},

8610

"is_submodule": 1,

8611

"namespaces": {},

8612

"module": "editor",

8613

"namespace": "",

8614

"description": "Extends EditorParaBase with IE support",

8615

"file": "editor/js/editor-para-ie.js",

8616

"line": 2

8617

},

8618

"editor-para": {

8619

"name": "editor-para",

8620

"submodules": {},

8621

"classes": {

8622

"Plugin.EditorPara": 1

8623

},

8624

"fors": {},

8625

"is_submodule": 1,

8626

"namespaces": {},

8627

"module": "editor",

8628

"namespace": "",

8629

"description": "Plugin for Editor to paragraph auto wrapping and correction.",

8630

"file": "editor/js/editor-para.js",

8631

"line": 2

8632

},

8633

"selection": {

8634

"name": "selection",

8635

"submodules": {},

8636

"classes": {

8637

"EditorSelection": 1

8638

},

8639

"fors": {},

8640

"is_submodule": 1,

8641

"namespaces": {},

8642

"module": "editor",

8643

"namespace": "",

8644

"description": "Wraps some common Selection/Range functionality into a simple object",

8645

"file": "editor/js/editor-selection.js",

8646

"line": 1

8647

},

8648

"editor-tab": {

8649

"name": "editor-tab",

8650

"submodules": {},

8651

"classes": {

8652

"Plugin.EditorTab": 1

8653

},

8654

"fors": {},

8655

"is_submodule": 1,

8656

"namespaces": {},

8657

"module": "editor",

8658

"namespace": "",

8659

"description": "Handles tab and shift-tab indent/outdent support.",

8660

"file": "editor/js/editor-tab.js",

8661

"line": 2

8662

},

8663

"exec-command": {

8664

"name": "exec-command",

8665

"submodules": {},

8666

"classes": {

8667

"Plugin.ExecCommand": 1

8668

},

8669

"fors": {},

8670

"is_submodule": 1,

8671

"namespaces": {},

8672

"module": "editor",

8673

"namespace": "",

8674

"description": "Plugin for the frame module to handle execCommands for Editor",

8675

"file": "editor/js/exec-command.js",

8676

"line": 2

8677

},

8678

"frame": {

8679

"name": "frame",

8680

"submodules": {},

8681

"classes": {

8682

"Frame": 1

8683

},

8684

"fors": {},

8685

"is_submodule": 1,

8686

"namespaces": {},

8687

"module": "editor",

8688

"namespace": "",

8689

"description": "Creates a wrapper around an iframe. It loads the content either from a local\nfile or from script and creates a local YUI instance bound to that new window and document.",

8690

"file": "editor/js/frame.js",

8691

"line": 2

8692

},

8693

"editor-lists": {

8694

"name": "editor-lists",

8695

"submodules": {},

8696

"classes": {

8697

"Plugin.EditorLists": 1

8698

},

8699

"fors": {},

8700

"is_submodule": 1,

8701

"namespaces": {},

8702

"module": "editor",

8703

"namespace": "",

8704

"description": "Handles list manipulation inside the Editor. Adds keyboard manipulation and execCommand support. Adds overrides for the <a href=\"Plugin.ExecCommand.html#method_COMMANDS.insertorderedlist\">insertorderedlist</a> and <a href=\"Plugin.ExecCommand.html#method_COMMANDS.insertunorderedlist\">insertunorderedlist</a> execCommands.",

8705

"file": "editor/js/lists.js",

8706

"line": 2

8707

},

8708

"escape": {

8709

"name": "escape",

8710

"submodules": {},

8711

"classes": {

8712

"Escape": 1

8713

},

8714

"fors": {},

8715

"namespaces": {},

8716

"tag": "module",

8717

"file": "escape/js/escape.js",

8718

"line": 1,

8719

"description": "Provides utility methods for escaping strings.",

8720

"static": 1,

8721

"since": "3.3.0"

8722

},

8723

"event-custom": {

8724

"name": "event-custom",

8725

"submodules": {

8726

"event-custom-base": 1,

8727

"event-custom-complex": 1

8728

},

8729

"classes": {

8730

"CustomEvent": 1,

8731

"Do": 1,

8732

"Do.Method": 1,

8733

"Do.AlterArgs": 1,

8734

"Do.AlterReturn": 1,

8735

"Do.Halt": 1,

8736

"Do.Prevent": 1,

8737

"Do.Error": 1,

8738

"EventFacade": 1,

8739

"EventTarget": 1,

8740

"EventHandle": 1,

8741

"Subscriber": 1

8742

},

8743

"fors": {

8744

"CustomEvent": 1,

8745

"EventTarget": 1,

8746

"YUI": 1

8747

},

8748

"namespaces": {},

8749

"tag": "module",

8750

"file": "event-custom/js/subscriber.js",

8751

"line": 1,

8752

"description": "Custom event engine, DOM event listener abstraction layer, synthetic DOM\nevents.",

8753

"extra": {

8754

"selleck": {

8755

"name": "event-custom",

8756

"displayName": "EventTarget",

8757

"description": "EventTarget is a core extension class that provides APIs for publishing, firing, and subscribing to custom events",

8758

"author": [

8759

"lsmith",

8760

"sdesai"

8761

],

8762

"use": [

8763

"event-custom"

8764

],

8765

"tags": [

8766

"infrastructure",

8767

"custom event",

8768

"event target"

8769

],

8770

"pages": {}

8771

}

8772

}

8773

},

8774

"event-custom-base": {

8775

"name": "event-custom-base",

8776

"submodules": {},

8777

"classes": {

8778

"CustomEvent": 1,

8779

"Do": 1,

8780

"Do.Method": 1,

8781

"Do.AlterArgs": 1,

8782

"Do.AlterReturn": 1,

8783

"Do.Halt": 1,

8784

"Do.Prevent": 1,

8785

"Do.Error": 1,

8786

"EventTarget": 1

8787

},

8788

"fors": {},

8789

"is_submodule": 1,

8790

"namespaces": {},

8791

"module": "event-custom",

8792

"namespace": "",

8793

"file": "event-custom/js/event-target.js",

8794

"line": 9,

8795

"description": "Custom event engine, DOM event listener abstraction layer, synthetic DOM\nevents.",

8796

"extra": {

8797

"selleck": {

8798

"name": "event-custom",

8799

"displayName": "EventTarget",

8800

"description": "EventTarget is a core extension class that provides APIs for publishing, firing, and subscribing to custom events",

8801

"author": [

8802

"lsmith",

8803

"sdesai"

8804

],

8805

"use": [

8806

"event-custom"

8807

],

8808

"tags": [

8809

"infrastructure",

8810

"custom event",

8811

"event target"

8812

],

8813

"pages": {}

8814

}

8815

}

8816

},

8817

"event-custom-complex": {

8818

"name": "event-custom-complex",

8819

"submodules": {},

8820

"classes": {

8821

"EventFacade": 1

8822

},

8823

"fors": {},

8824

"is_submodule": 1,

8825

"namespaces": {},

8826

"module": "event-custom",

8827

"namespace": "",

8828

"file": "event-custom/js/event-facade.js",

8829

"line": 15,

8830

"description": "Adds event facades, preventable default behavior, and bubbling.\nevents.",

8831

"extra": {

8832

"selleck": {

8833

"name": "event-custom",

8834

"displayName": "EventTarget",

8835

"description": "EventTarget is a core extension class that provides APIs for publishing, firing, and subscribing to custom events",

8836

"author": [

8837

"lsmith",

8838

"sdesai"

8839

],

8840

"use": [

8841

"event-custom"

8842

],

8843

"tags": [

8844

"infrastructure",

8845

"custom event",

8846

"event target"

8847

],

8848

"pages": {}

8849

}

8850

}

8851

},

8852

"event-gestures": {

8853

"name": "event-gestures",

8854

"submodules": {

8855

"event-flick": 1,

8856

"event-move": 1

8857

},

8858

"classes": {},

8859

"fors": {

8860

"YUI": 1

8861

},

8862

"namespaces": {},

8863

"tag": "module",

8864

"file": "event-gestures/js/Flick.js",

8865

"line": 1,

8866

"description": "The gestures module provides gesture events such as \"flick\", which normalize user interactions\nacross touch and mouse or pointer based input devices. This layer can be used by application developers\nto build input device agnostic components which behave the same in response to either touch or mouse based \ninteraction.\n\nDocumentation for events added by this module can be found in the event document for the <a href=\"YUI.html#events\">YUI</a> global."

8867

},

8868

"event-flick": {

8869

"name": "event-flick",

8870

"submodules": {},

8871

"classes": {},

8872

"fors": {},

8873

"is_submodule": 1,

8874

"namespaces": {},

8875

"module": "event-gestures",

8876

"namespace": "",

8877

"file": "event-gestures/js/Flick.js",

8878

"line": 12,

8879

"description": "Adds support for a \"flick\" event, which is fired at the end of a touch or mouse based flick gesture, and provides \nvelocity of the flick, along with distance and time information."

8880

},

8881

"event-move": {

8882

"name": "event-move",

8883

"submodules": {},

8884

"classes": {},

8885

"fors": {},

8886

"is_submodule": 1,

8887

"namespaces": {},

8888

"module": "event-gestures",

8889

"namespace": "",

8890

"file": "event-gestures/js/Move.js",

8891

"line": 1,

8892

"description": "Adds lower level support for \"gesturemovestart\", \"gesturemove\" and \"gesturemoveend\" events, which can be used to create drag/drop\ninteractions which work across touch and mouse input devices. They correspond to \"touchstart\", \"touchmove\" and \"touchend\" on a touch input\ndevice, and \"mousedown\", \"mousemove\", \"mouseup\" on a mouse based input device."

8893

},

8894

"event-simulate": {

8895

"name": "event-simulate",

8896

"submodules": {},

8897

"classes": {},

8898

"fors": {

8899

"Event": 1

8900

},

8901

"namespaces": {},

8902

"tag": "module",

8903

"file": "event-simulate/js/event-simulate.js",

8904

"line": 2,

8905

"description": "Simulate user interaction by generating native DOM events.",

8906

"requires": [

8907

"event"

8908

]

8909

},

8910

"event-valuechange": {

8911

"name": "event-valuechange",

8912

"submodules": {},

8913

"classes": {

8914

"ValueChange": 1

8915

},

8916

"fors": {

8917

"YUI": 1

8918

},

8919

"namespaces": {},

8920

"tag": "module",

8921

"file": "event-valuechange/js/event-valuechange.js",

8922

"line": 18,

8923

"description": "Adds a synthetic `valueChange` event that fires when the `value` property of an\n`<input>` or `<textarea>` node changes as a result of a keystroke, mouse\noperation, or input method editor (IME) input event.\n\nUsage:\n\n YUI().use('event-valuechange', function (Y) {\n Y.one('#my-input').on('valueChange', function (e) {\n Y.log('previous value: ' + e.prevVal);\n Y.log('new value: ' + e.newVal);\n });\n });"

8924

},

8925

"event": {

8926

"name": "event",

8927

"submodules": {

8928

"event-base": 1,

8929

"event-delegate": 1,

8930

"event-focus": 1,

8931

"event-hover": 1,

8932

"event-key": 1,

8933

"event-mouseenter": 1,

8934

"event-mousewheel": 1,

8935

"event-outside": 1,

8936

"event-resize": 1,

8937

"event-synthetic": 1

8938

},

8939

"classes": {

8940

"Event": 1,

8941

"DOMEventFacade": 1,

8942

"SyntheticEvent.Notifier": 1,

8943

"SynthRegistry": 1,

8944

"SyntheticEvent": 1

8945

},

8946

"fors": {

8947

"YUI": 1,

8948

"Event": 1

8949

},

8950

"namespaces": {},

8951

"file": "event/js/synthetic.js",

8952

"line": 193,

8953

"description": "The event utility provides functions to add and remove event listeners,\nevent cleansing. It also tries to automatically remove listeners it\nregisters during the unload event.",

8954

"tag": "main",

8955

"itemtype": "main",

8956

"extra": {

8957

"selleck": {

8958

"name": "event",

8959

"displayName": "Event",

8960

"description": "The Event system provides APIs for subscribing to and working with DOM events",

8961

"author": [

8962

"lsmith",

8963

"sdesai"

8964

],

8965

"use": [

8966

"event"

8967

],

8968

"tags": [

8969

"core",

8970

"event",

8971

"dom"

8972

],

8973

"pages": {

8974

"delegation": {

8975

"displayName": "Intro to Event Delegation"

8976

},

8977

"domready": {

8978

"displayName": "DOM Lifecycle Events"

8979

},

8980

"focus": {

8981

"displayName": "The focus and blur Event Fix"

8982

},

8983

"key": {

8984

"displayName": "The key Event"

8985

},

8986

"mouseenter": {

8987

"displayName": "The mouseenter, mouseleave, and hover Events"

8988

},

8989

"mousewheel": {

8990

"displayName": "The mousewheel Event"

8991

},

8992

"outside": {

8993

"displayName": "Outside Events"

8994

},

8995

"simulate": {

8996

"displayName": "Simulating DOM Events"

8997

},

8998

"synths": {

8999

"displayName": "Creating Synthetic Events"

9000

},

9001

"touch": {

9002

"displayName": "Touch Events and Abstractions"

9003

},

9004

"valuechange": {

9005

"displayName": "The valuechange Event"

9006

},

9007

"windowresize": {

9008

"displayName": "The windowresize Event"

9009

},

9010

"contextmenu": {

9011

"displayName": "The contextmenu Event Fix"

9012

},

9013

"swipe-example-content": {

9014

"displayName": "Supporting a Swipe Left Gesture",

9015

"layout": "empty-layout"

9016

}

9017

}

9018

}

9019

}

9020

},

9021

"event-base": {

9022

"name": "event-base",

9023

"submodules": {},

9024

"classes": {

9025

"Event": 1,

9026

"DOMEventFacade": 1

9027

},

9028

"fors": {},

9029

"is_submodule": 1,

9030

"namespaces": {},

9031

"module": "event",

9032

"namespace": "",

9033

"file": "event/js/event-facade-dom.js",

9034

"line": 8,

9035

"description": "DOM event listener abstraction layer",

9036

"tag": "main",

9037

"itemtype": "main",

9038

"extra": {

9039

"selleck": {

9040

"name": "event",

9041

"displayName": "Event",

9042

"description": "The Event system provides APIs for subscribing to and working with DOM events",

9043

"author": [

9044

"lsmith",

9045

"sdesai"

9046

],

9047

"use": [

9048

"event"

9049

],

9050

"tags": [

9051

"core",

9052

"event",

9053

"dom"

9054

],

9055

"pages": {

9056

"delegation": {

9057

"displayName": "Intro to Event Delegation"

9058

},

9059

"domready": {

9060

"displayName": "DOM Lifecycle Events"

9061

},

9062

"focus": {

9063

"displayName": "The focus and blur Event Fix"

9064

},

9065

"key": {

9066

"displayName": "The key Event"

9067

},

9068

"mouseenter": {

9069

"displayName": "The mouseenter, mouseleave, and hover Events"

9070

},

9071

"mousewheel": {

9072

"displayName": "The mousewheel Event"

9073

},

9074

"outside": {

9075

"displayName": "Outside Events"

9076

},

9077

"simulate": {

9078

"displayName": "Simulating DOM Events"

9079

},

9080

"synths": {

9081

"displayName": "Creating Synthetic Events"

9082

},

9083

"touch": {

9084

"displayName": "Touch Events and Abstractions"

9085

},

9086

"valuechange": {

9087

"displayName": "The valuechange Event"

9088

},

9089

"windowresize": {

9090

"displayName": "The windowresize Event"

9091

},

9092

"contextmenu": {

9093

"displayName": "The contextmenu Event Fix"

9094

},

9095

"swipe-example-content": {

9096

"displayName": "Supporting a Swipe Left Gesture",

9097

"layout": "empty-layout"

9098

}

9099

}

9100

}

9101

}

9102

},

9103

"event-contextmenu": {

9104

"name": "event-contextmenu",

9105

"submodules": {},

9106

"classes": {},

9107

"fors": {},

9108

"namespaces": {},

9109

"tag": "module",

9110

"file": "event/js/contextmenu.js",

9111

"line": 1,

9112

"description": "Provides extended keyboard support for the \"contextmenu\" event such that:\n<ul>\n<li>The browser's default context menu is suppressed regardless of how the event is triggered.</li>\n<li>On Windows the \"contextmenu\" event is fired consistently regardless of whether the user pressed the Menu key or Shift + F10.</li>\n<li>When the \"contextmenu\" event is fired via the keyboard, the pageX, pageY, clientX and clientY properties reference the center of the event target. This makes it easy for \"contextmenu\" event listeners to position an overlay in response to the event by not having to worry about special handling of the x and y coordinates based on the device that fired the event.</li>\n<li>For Webkit and Gecko on the Mac it enables the use of the Shift + Control + Option + M keyboard shortcut to fire the \"contextmenu\" event, which (by default) is only available when VoiceOver (the screen reader on the Mac) is enabled.</li>\n<li>For Opera on the Mac it ensures the \"contextmenu\" event is fired when the user presses Shift + Command + M (Opera's context menu keyboard shortcut).</li>\n</ul>",

9113

"requires": [

9114

"event"

9115

],

9116

"extra": {

9117

"selleck": {

9118

"name": "event",

9119

"displayName": "Event",

9120

"description": "The Event system provides APIs for subscribing to and working with DOM events",

9121

"author": [

9122

"lsmith",

9123

"sdesai"

9124

],

9125

"use": [

9126

"event"

9127

],

9128

"tags": [

9129

"core",

9130

"event",

9131

"dom"

9132

],

9133

"pages": {

9134

"delegation": {

9135

"displayName": "Intro to Event Delegation"

9136

},

9137

"domready": {

9138

"displayName": "DOM Lifecycle Events"

9139

},

9140

"focus": {

9141

"displayName": "The focus and blur Event Fix"

9142

},

9143

"key": {

9144

"displayName": "The key Event"

9145

},

9146

"mouseenter": {

9147

"displayName": "The mouseenter, mouseleave, and hover Events"

9148

},

9149

"mousewheel": {

9150

"displayName": "The mousewheel Event"

9151

},

9152

"outside": {

9153

"displayName": "Outside Events"

9154

},

9155

"simulate": {

9156

"displayName": "Simulating DOM Events"

9157

},

9158

"synths": {

9159

"displayName": "Creating Synthetic Events"

9160

},

9161

"touch": {

9162

"displayName": "Touch Events and Abstractions"

9163

},

9164

"valuechange": {

9165

"displayName": "The valuechange Event"

9166

},

9167

"windowresize": {

9168

"displayName": "The windowresize Event"

9169

},

9170

"contextmenu": {

9171

"displayName": "The contextmenu Event Fix"

9172

},

9173

"swipe-example-content": {

9174

"displayName": "Supporting a Swipe Left Gesture",

9175

"layout": "empty-layout"

9176

}

9177

}

9178

}

9179

}

9180

},

9181

"event-delegate": {

9182

"name": "event-delegate",

9183

"submodules": {},

9184

"classes": {},

9185

"fors": {},

9186

"is_submodule": 1,

9187

"namespaces": {},

9188

"module": "event",

9189

"namespace": "",

9190

"file": "event/js/delegate.js",

9191

"line": 1,

9192

"description": "Adds event delegation support to the library.",

9193

"extra": {

9194

"selleck": {

9195

"name": "event",

9196

"displayName": "Event",

9197

"description": "The Event system provides APIs for subscribing to and working with DOM events",

9198

"author": [

9199

"lsmith",

9200

"sdesai"

9201

],

9202

"use": [

9203

"event"

9204

],

9205

"tags": [

9206

"core",

9207

"event",

9208

"dom"

9209

],

9210

"pages": {

9211

"delegation": {

9212

"displayName": "Intro to Event Delegation"

9213

},

9214

"domready": {

9215

"displayName": "DOM Lifecycle Events"

9216

},

9217

"focus": {

9218

"displayName": "The focus and blur Event Fix"

9219

},

9220

"key": {

9221

"displayName": "The key Event"

9222

},

9223

"mouseenter": {

9224

"displayName": "The mouseenter, mouseleave, and hover Events"

9225

},

9226

"mousewheel": {

9227

"displayName": "The mousewheel Event"

9228

},

9229

"outside": {

9230

"displayName": "Outside Events"

9231

},

9232

"simulate": {

9233

"displayName": "Simulating DOM Events"

9234

},

9235

"synths": {

9236

"displayName": "Creating Synthetic Events"

9237

},

9238

"touch": {

9239

"displayName": "Touch Events and Abstractions"

9240

},

9241

"valuechange": {

9242

"displayName": "The valuechange Event"

9243

},

9244

"windowresize": {

9245

"displayName": "The windowresize Event"

9246

},

9247

"contextmenu": {

9248

"displayName": "The contextmenu Event Fix"

9249

},

9250

"swipe-example-content": {

9251

"displayName": "Supporting a Swipe Left Gesture",

9252

"layout": "empty-layout"

9253

}

9254

}

9255

}

9256

}

9257

},

9258

"event-touch": {

9259

"name": "event-touch",

9260

"submodules": {},

9261

"classes": {},

9262

"fors": {

9263

"DOMEventFacade": 1

9264

},

9265

"namespaces": {},

9266

"tag": "module",

9267

"file": "event/js/event-facade-dom-touch.js",

9268

"line": 1,

9269

"description": "Adds touch event facade normalization properties (touches, changedTouches, targetTouches etc.) to the DOM event facade",

9270

"extra": {

9271

"selleck": {

9272

"name": "event",

9273

"displayName": "Event",

9274

"description": "The Event system provides APIs for subscribing to and working with DOM events",

9275

"author": [

9276

"lsmith",

9277

"sdesai"

9278

],

9279

"use": [

9280

"event"

9281

],

9282

"tags": [

9283

"core",

9284

"event",

9285

"dom"

9286

],

9287

"pages": {

9288

"delegation": {

9289

"displayName": "Intro to Event Delegation"

9290

},

9291

"domready": {

9292

"displayName": "DOM Lifecycle Events"

9293

},

9294

"focus": {

9295

"displayName": "The focus and blur Event Fix"

9296

},

9297

"key": {

9298

"displayName": "The key Event"

9299

},

9300

"mouseenter": {

9301

"displayName": "The mouseenter, mouseleave, and hover Events"

9302

},

9303

"mousewheel": {

9304

"displayName": "The mousewheel Event"

9305

},

9306

"outside": {

9307

"displayName": "Outside Events"

9308

},

9309

"simulate": {

9310

"displayName": "Simulating DOM Events"

9311

},

9312

"synths": {

9313

"displayName": "Creating Synthetic Events"

9314

},

9315

"touch": {

9316

"displayName": "Touch Events and Abstractions"

9317

},

9318

"valuechange": {

9319

"displayName": "The valuechange Event"

9320

},

9321

"windowresize": {

9322

"displayName": "The windowresize Event"

9323

},

9324

"contextmenu": {

9325

"displayName": "The contextmenu Event Fix"

9326

},

9327

"swipe-example-content": {

9328

"displayName": "Supporting a Swipe Left Gesture",

9329

"layout": "empty-layout"

9330

}

9331

}

9332

}

9333

}

9334

},

9335

"event-focus": {

9336

"name": "event-focus",

9337

"submodules": {},

9338

"classes": {},

9339

"fors": {},

9340

"is_submodule": 1,

9341

"namespaces": {},

9342

"module": "event",

9343

"namespace": "",

9344

"file": "event/js/focusblur.js",

9345

"line": 1,

9346

"description": "Adds bubbling and delegation support to DOM events focus and blur.",

9347

"extra": {

9348

"selleck": {

9349

"name": "event",

9350

"displayName": "Event",

9351

"description": "The Event system provides APIs for subscribing to and working with DOM events",

9352

"author": [

9353

"lsmith",

9354

"sdesai"

9355

],

9356

"use": [

9357

"event"

9358

],

9359

"tags": [

9360

"core",

9361

"event",

9362

"dom"

9363

],

9364

"pages": {

9365

"delegation": {

9366

"displayName": "Intro to Event Delegation"

9367

},

9368

"domready": {

9369

"displayName": "DOM Lifecycle Events"

9370

},

9371

"focus": {

9372

"displayName": "The focus and blur Event Fix"

9373

},

9374

"key": {

9375

"displayName": "The key Event"

9376

},

9377

"mouseenter": {

9378

"displayName": "The mouseenter, mouseleave, and hover Events"

9379

},

9380

"mousewheel": {

9381

"displayName": "The mousewheel Event"

9382

},

9383

"outside": {

9384

"displayName": "Outside Events"

9385

},

9386

"simulate": {

9387

"displayName": "Simulating DOM Events"

9388

},

9389

"synths": {

9390

"displayName": "Creating Synthetic Events"

9391

},

9392

"touch": {

9393

"displayName": "Touch Events and Abstractions"

9394

},

9395

"valuechange": {

9396

"displayName": "The valuechange Event"

9397

},

9398

"windowresize": {

9399

"displayName": "The windowresize Event"

9400

},

9401

"contextmenu": {

9402

"displayName": "The contextmenu Event Fix"

9403

},

9404

"swipe-example-content": {

9405

"displayName": "Supporting a Swipe Left Gesture",

9406

"layout": "empty-layout"

9407

}

9408

}

9409

}

9410

}

9411

},

9412

"event-hover": {

9413

"name": "event-hover",

9414

"submodules": {},

9415

"classes": {},

9416

"fors": {},

9417

"is_submodule": 1,

9418

"namespaces": {},

9419

"module": "event",

9420

"namespace": "",

9421

"file": "event/js/hover.js",

9422

"line": 1,

9423

"description": "Adds support for a \"hover\" event. The event provides a convenience wrapper\nfor subscribing separately to mouseenter and mouseleave. The signature for\nsubscribing to the event is\n\n<pre><code>node.on(\"hover\", overFn, outFn);\nnode.delegate(\"hover\", overFn, outFn, \".filterSelector\");\nY.on(\"hover\", overFn, outFn, \".targetSelector\");\nY.delegate(\"hover\", overFn, outFn, \"#container\", \".filterSelector\");\n</code></pre>\n\nAdditionally, for compatibility with a more typical subscription\nsignature, the following are also supported:\n\n<pre><code>Y.on(\"hover\", overFn, \".targetSelector\", outFn);\nY.delegate(\"hover\", overFn, \"#container\", outFn, \".filterSelector\");\n</code></pre>",

9424

"extra": {

9425

"selleck": {

9426

"name": "event",

9427

"displayName": "Event",

9428

"description": "The Event system provides APIs for subscribing to and working with DOM events",

9429

"author": [

9430

"lsmith",

9431

"sdesai"

9432

],

9433

"use": [

9434

"event"

9435

],

9436

"tags": [

9437

"core",

9438

"event",

9439

"dom"

9440

],

9441

"pages": {

9442

"delegation": {

9443

"displayName": "Intro to Event Delegation"

9444

},

9445

"domready": {

9446

"displayName": "DOM Lifecycle Events"

9447

},

9448

"focus": {

9449

"displayName": "The focus and blur Event Fix"

9450

},

9451

"key": {

9452

"displayName": "The key Event"

9453

},

9454

"mouseenter": {

9455

"displayName": "The mouseenter, mouseleave, and hover Events"

9456

},

9457

"mousewheel": {

9458

"displayName": "The mousewheel Event"

9459

},

9460

"outside": {

9461

"displayName": "Outside Events"

9462

},

9463

"simulate": {

9464

"displayName": "Simulating DOM Events"

9465

},

9466

"synths": {

9467

"displayName": "Creating Synthetic Events"

9468

},

9469

"touch": {

9470

"displayName": "Touch Events and Abstractions"

9471

},

9472

"valuechange": {

9473

"displayName": "The valuechange Event"

9474

},

9475

"windowresize": {

9476

"displayName": "The windowresize Event"

9477

},

9478

"contextmenu": {

9479

"displayName": "The contextmenu Event Fix"

9480

},

9481

"swipe-example-content": {

9482

"displayName": "Supporting a Swipe Left Gesture",

9483

"layout": "empty-layout"

9484

}

9485

}

9486

}

9487

}

9488

},

9489

"event-key": {

9490

"name": "event-key",

9491

"submodules": {},

9492

"classes": {},

9493

"fors": {},

9494

"is_submodule": 1,

9495

"namespaces": {},

9496

"module": "event",

9497

"namespace": "",

9498

"file": "event/js/key.js",

9499

"line": 1,

9500

"description": "Functionality to listen for one or more specific key combinations.",

9501

"extra": {

9502

"selleck": {

9503

"name": "event",

9504

"displayName": "Event",

9505

"description": "The Event system provides APIs for subscribing to and working with DOM events",

9506

"author": [

9507

"lsmith",

9508

"sdesai"

9509

],

9510

"use": [

9511

"event"

9512

],

9513

"tags": [

9514

"core",

9515

"event",

9516

"dom"

9517

],

9518

"pages": {

9519

"delegation": {

9520

"displayName": "Intro to Event Delegation"

9521

},

9522

"domready": {

9523

"displayName": "DOM Lifecycle Events"

9524

},

9525

"focus": {

9526

"displayName": "The focus and blur Event Fix"

9527

},

9528

"key": {

9529

"displayName": "The key Event"

9530

},

9531

"mouseenter": {

9532

"displayName": "The mouseenter, mouseleave, and hover Events"

9533

},

9534

"mousewheel": {

9535

"displayName": "The mousewheel Event"

9536

},

9537

"outside": {

9538

"displayName": "Outside Events"

9539

},

9540

"simulate": {

9541

"displayName": "Simulating DOM Events"

9542

},

9543

"synths": {

9544

"displayName": "Creating Synthetic Events"

9545

},

9546

"touch": {

9547

"displayName": "Touch Events and Abstractions"

9548

},

9549

"valuechange": {

9550

"displayName": "The valuechange Event"

9551

},

9552

"windowresize": {

9553

"displayName": "The windowresize Event"

9554

},

9555

"contextmenu": {

9556

"displayName": "The contextmenu Event Fix"

9557

},

9558

"swipe-example-content": {

9559

"displayName": "Supporting a Swipe Left Gesture",

9560

"layout": "empty-layout"

9561

}

9562

}

9563

}

9564

}

9565

},

9566

"event-mouseenter": {

9567

"name": "event-mouseenter",

9568

"submodules": {},

9569

"classes": {},

9570

"fors": {},

9571

"is_submodule": 1,

9572

"namespaces": {},

9573

"module": "event",

9574

"namespace": "",

9575

"file": "event/js/mouseentermouseleave.js",

9576

"line": 1,

9577

"description": "Adds subscription and delegation support for mouseenter and mouseleave\nevents. Unlike mouseover and mouseout, these events aren't fired from child\nelements of a subscribed node.\n\nThis avoids receiving three mouseover notifications from a setup like\n\n<pre><code>div#container > p > a[href]</code></pre>\n\nwhere\n\n<pre><code>Y.one('#container').on('mouseover', callback)</code></pre>\n\nWhen the mouse moves over the link, one mouseover event is fired from\n#container, then when the mouse moves over the p, another mouseover event is\nfired and bubbles to #container, causing a second notification, and finally\nwhen the mouse moves over the link, a third mouseover event is fired and\nbubbles to #container for a third notification.\n\nBy contrast, using mouseenter instead of mouseover, the callback would be\nexecuted only once when the mouse moves over #container.",

9578

"extra": {

9579

"selleck": {

9580

"name": "event",

9581

"displayName": "Event",

9582

"description": "The Event system provides APIs for subscribing to and working with DOM events",

9583

"author": [

9584

"lsmith",

9585

"sdesai"

9586

],

9587

"use": [

9588

"event"

9589

],

9590

"tags": [

9591

"core",

9592

"event",

9593

"dom"

9594

],

9595

"pages": {

9596

"delegation": {

9597

"displayName": "Intro to Event Delegation"

9598

},

9599

"domready": {

9600

"displayName": "DOM Lifecycle Events"

9601

},

9602

"focus": {

9603

"displayName": "The focus and blur Event Fix"

9604

},

9605

"key": {

9606

"displayName": "The key Event"

9607

},

9608

"mouseenter": {

9609

"displayName": "The mouseenter, mouseleave, and hover Events"

9610

},

9611

"mousewheel": {

9612

"displayName": "The mousewheel Event"

9613

},

9614

"outside": {

9615

"displayName": "Outside Events"

9616

},

9617

"simulate": {

9618

"displayName": "Simulating DOM Events"

9619

},

9620

"synths": {

9621

"displayName": "Creating Synthetic Events"

9622

},

9623

"touch": {

9624

"displayName": "Touch Events and Abstractions"

9625

},

9626

"valuechange": {

9627

"displayName": "The valuechange Event"

9628

},

9629

"windowresize": {

9630

"displayName": "The windowresize Event"

9631

},

9632

"contextmenu": {

9633

"displayName": "The contextmenu Event Fix"

9634

},

9635

"swipe-example-content": {

9636

"displayName": "Supporting a Swipe Left Gesture",

9637

"layout": "empty-layout"

9638

}

9639

}

9640

}

9641

}

9642

},

9643

"event-mousewheel": {

9644

"name": "event-mousewheel",

9645

"submodules": {},

9646

"classes": {},

9647

"fors": {},

9648

"is_submodule": 1,

9649

"namespaces": {},

9650

"module": "event",

9651

"namespace": "",

9652

"file": "event/js/mousewheel.js",

9653

"line": 1,

9654

"description": "Adds mousewheel event support",

9655

"extra": {

9656

"selleck": {

9657

"name": "event",

9658

"displayName": "Event",

9659

"description": "The Event system provides APIs for subscribing to and working with DOM events",

9660

"author": [

9661

"lsmith",

9662

"sdesai"

9663

],

9664

"use": [

9665

"event"

9666

],

9667

"tags": [

9668

"core",

9669

"event",

9670

"dom"

9671

],

9672

"pages": {

9673

"delegation": {

9674

"displayName": "Intro to Event Delegation"

9675

},

9676

"domready": {

9677

"displayName": "DOM Lifecycle Events"

9678

},

9679

"focus": {

9680

"displayName": "The focus and blur Event Fix"

9681

},

9682

"key": {

9683

"displayName": "The key Event"

9684

},

9685

"mouseenter": {

9686

"displayName": "The mouseenter, mouseleave, and hover Events"

9687

},

9688

"mousewheel": {

9689

"displayName": "The mousewheel Event"

9690

},

9691

"outside": {

9692

"displayName": "Outside Events"

9693

},

9694

"simulate": {

9695

"displayName": "Simulating DOM Events"

9696

},

9697

"synths": {

9698

"displayName": "Creating Synthetic Events"

9699

},

9700

"touch": {

9701

"displayName": "Touch Events and Abstractions"

9702

},

9703

"valuechange": {

9704

"displayName": "The valuechange Event"

9705

},

9706

"windowresize": {

9707

"displayName": "The windowresize Event"

9708

},

9709

"contextmenu": {

9710

"displayName": "The contextmenu Event Fix"

9711

},

9712

"swipe-example-content": {

9713

"displayName": "Supporting a Swipe Left Gesture",

9714

"layout": "empty-layout"

9715

}

9716

}

9717

}

9718

}

9719

},

9720

"event-outside": {

9721

"name": "event-outside",

9722

"submodules": {},

9723

"classes": {},

9724

"fors": {},

9725

"is_submodule": 1,

9726

"namespaces": {},

9727

"module": "event",

9728

"namespace": "",

9729

"file": "event/js/outside.js",

9730

"line": 1,

9731

"description": "Outside events are synthetic DOM events that fire when a corresponding native\nor synthetic DOM event occurs outside a bound element.\n\nThe following outside events are pre-defined by this module:\n<ul>\n <li>blur</li>\n <li>change</li>\n <li>click</li>\n <li>dblclick</li>\n <li>focus</li>\n <li>keydown</li>\n <li>keypress</li>\n <li>keyup</li>\n <li>mousedown</li>\n <li>mousemove</li>\n <li>mouseout</li>\n <li>mouseover</li>\n <li>mouseup</li>\n <li>select</li>\n <li>submit</li>\n</ul>\n\nDefine new outside events with\n<code>Y.Event.defineOutside(eventType);</code>.\nBy default, the created synthetic event name will be the name of the event\nwith \"outside\" appended (e.g. \"click\" becomes \"clickoutside\"). If you want\na different name for the created Event, pass it as a second argument like so:\n<code>Y.Event.defineOutside(eventType, \"yonderclick\")</code>.\n\nThis module was contributed by Brett Stimmerman, promoted from his\ngallery-outside-events module at\nhttp://yuilibrary.com/gallery/show/outside-events",

9732

"author": "brettstimmerman",

9733

"since": "3.4.0",

9734

"extra": {

9735

"selleck": {

9736

"name": "event",

9737

"displayName": "Event",

9738

"description": "The Event system provides APIs for subscribing to and working with DOM events",

9739

"author": [

9740

"lsmith",

9741

"sdesai"

9742

],

9743

"use": [

9744

"event"

9745

],

9746

"tags": [

9747

"core",

9748

"event",

9749

"dom"

9750

],

9751

"pages": {

9752

"delegation": {

9753

"displayName": "Intro to Event Delegation"

9754

},

9755

"domready": {

9756

"displayName": "DOM Lifecycle Events"

9757

},

9758

"focus": {

9759

"displayName": "The focus and blur Event Fix"

9760

},

9761

"key": {

9762

"displayName": "The key Event"

9763

},

9764

"mouseenter": {

9765

"displayName": "The mouseenter, mouseleave, and hover Events"

9766

},

9767

"mousewheel": {

9768

"displayName": "The mousewheel Event"

9769

},

9770

"outside": {

9771

"displayName": "Outside Events"

9772

},

9773

"simulate": {

9774

"displayName": "Simulating DOM Events"

9775

},

9776

"synths": {

9777

"displayName": "Creating Synthetic Events"

9778

},

9779

"touch": {

9780

"displayName": "Touch Events and Abstractions"

9781

},

9782

"valuechange": {

9783

"displayName": "The valuechange Event"

9784

},

9785

"windowresize": {

9786

"displayName": "The windowresize Event"

9787

},

9788

"contextmenu": {

9789

"displayName": "The contextmenu Event Fix"

9790

},

9791

"swipe-example-content": {

9792

"displayName": "Supporting a Swipe Left Gesture",

9793

"layout": "empty-layout"

9794

}

9795

}

9796

}

9797

}

9798

},

9799

"event-resize": {

9800

"name": "event-resize",

9801

"submodules": {},

9802

"classes": {},

9803

"fors": {},

9804

"is_submodule": 1,

9805

"namespaces": {},

9806

"module": "event",

9807

"namespace": "",

9808

"file": "event/js/resize-window.js",

9809

"line": 1,

9810

"description": "Adds a window resize event that has its behavior normalized to fire at the\nend of the resize rather than constantly during the resize.",

9811

"extra": {

9812

"selleck": {

9813

"name": "event",

9814

"displayName": "Event",

9815

"description": "The Event system provides APIs for subscribing to and working with DOM events",

9816

"author": [

9817

"lsmith",

9818

"sdesai"

9819

],

9820

"use": [

9821

"event"

9822

],

9823

"tags": [

9824

"core",

9825

"event",

9826

"dom"

9827

],

9828

"pages": {

9829

"delegation": {

9830

"displayName": "Intro to Event Delegation"

9831

},

9832

"domready": {

9833

"displayName": "DOM Lifecycle Events"

9834

},

9835

"focus": {

9836

"displayName": "The focus and blur Event Fix"

9837

},

9838

"key": {

9839

"displayName": "The key Event"

9840

},

9841

"mouseenter": {

9842

"displayName": "The mouseenter, mouseleave, and hover Events"

9843

},

9844

"mousewheel": {

9845

"displayName": "The mousewheel Event"

9846

},

9847

"outside": {

9848

"displayName": "Outside Events"

9849

},

9850

"simulate": {

9851

"displayName": "Simulating DOM Events"

9852

},

9853

"synths": {

9854

"displayName": "Creating Synthetic Events"

9855

},

9856

"touch": {

9857

"displayName": "Touch Events and Abstractions"

9858

},

9859

"valuechange": {

9860

"displayName": "The valuechange Event"

9861

},

9862

"windowresize": {

9863

"displayName": "The windowresize Event"

9864

},

9865

"contextmenu": {

9866

"displayName": "The contextmenu Event Fix"

9867

},

9868

"swipe-example-content": {

9869

"displayName": "Supporting a Swipe Left Gesture",

9870

"layout": "empty-layout"

9871

}

9872

}

9873

}

9874

}

9875

},

9876

"event-synthetic": {

9877

"name": "event-synthetic",

9878

"submodules": {},

9879

"classes": {

9880

"SyntheticEvent.Notifier": 1,

9881

"SynthRegistry": 1,

9882

"SyntheticEvent": 1

9883

},

9884

"fors": {},

9885

"is_submodule": 1,

9886

"namespaces": {},

9887

"module": "event",

9888

"namespace": "",

9889

"file": "event/js/synthetic.js",

9890

"line": 193,

9891

"description": "Define new DOM events that can be subscribed to from Nodes.",

9892

"extra": {

9893

"selleck": {

9894

"name": "event",

9895

"displayName": "Event",

9896

"description": "The Event system provides APIs for subscribing to and working with DOM events",

9897

"author": [

9898

"lsmith",

9899

"sdesai"

9900

],

9901

"use": [

9902

"event"

9903

],

9904

"tags": [

9905

"core",

9906

"event",

9907

"dom"

9908

],

9909

"pages": {

9910

"delegation": {

9911

"displayName": "Intro to Event Delegation"

9912

},

9913

"domready": {

9914

"displayName": "DOM Lifecycle Events"

9915

},

9916

"focus": {

9917

"displayName": "The focus and blur Event Fix"

9918

},

9919

"key": {

9920

"displayName": "The key Event"

9921

},

9922

"mouseenter": {

9923

"displayName": "The mouseenter, mouseleave, and hover Events"

9924

},

9925

"mousewheel": {

9926

"displayName": "The mousewheel Event"

9927

},

9928

"outside": {

9929

"displayName": "Outside Events"

9930

},

9931

"simulate": {

9932

"displayName": "Simulating DOM Events"

9933

},

9934

"synths": {

9935

"displayName": "Creating Synthetic Events"

9936

},

9937

"touch": {

9938

"displayName": "Touch Events and Abstractions"

9939

},

9940

"valuechange": {

9941

"displayName": "The valuechange Event"

9942

},

9943

"windowresize": {

9944

"displayName": "The windowresize Event"

9945

},

9946

"contextmenu": {

9947

"displayName": "The contextmenu Event Fix"

9948

},

9949

"swipe-example-content": {

9950

"displayName": "Supporting a Swipe Left Gesture",

9951

"layout": "empty-layout"

9952

}

9953

}

9954

}

9955

}

9956

},

9957

"file-flash": {

9958

"name": "file-flash",

9959

"submodules": {},

9960

"classes": {

9961

"FileFlash": 1

9962

},

9963

"fors": {},

9964

"namespaces": {},

9965

"tag": "module",

9966

"file": "file/js/file-flash.js",

9967

"line": 6,

9968

"description": "The FileFlash class provides a wrapper for a file pointer stored in Flash. The File wrapper \nalso implements the mechanics for uploading a file and tracking its progress."

9969

},

9970

"file-html5": {

9971

"name": "file-html5",

9972

"submodules": {},

9973

"classes": {

9974

"FileHTML5": 1

9975

},

9976

"fors": {},

9977

"namespaces": {},

9978

"tag": "module",

9979

"file": "file/js/file-html5.js",

9980

"line": 7,

9981

"description": "The FileHTML5 class provides a wrapper for a file pointer in an HTML5 The File wrapper \nalso implements the mechanics for uploading a file and tracking its progress."

9982

},

9983

"file": {

9984

"name": "file",

9985

"submodules": {},

9986

"classes": {

9987

"File": 1

9988

},

9989

"fors": {},

9990

"namespaces": {},

9991

"tag": "main",

9992

"file": "file/js/file.js",

9993

"line": 10,

9994

"description": "The File class provides a wrapper for a file pointer, either through an HTML5 \nimplementation or as a reference to a file pointer stored in Flash. The File wrapper \nalso implements the mechanics for uploading a file and tracking its progress.",

9995

"itemtype": "main"

9996

},

9997

"get-nodejs": {

9998

"name": "get-nodejs",

9999

"submodules": {},

10000

"classes": {

10001

"GetNodeJS": 1

10002

},

10003

"fors": {},

10004

"namespaces": {},

10005

"tag": "module",

10006

"file": "get/js/get-nodejs.js",

10007

"line": 1,

10008

"description": "NodeJS specific Get module used to load remote resources. It contains the same signature as the default Get module so there is no code change needed.",

10009

"extra": {

10010

"selleck": {

10011

"name": "get",

10012

"displayName": "Get",

10013

"description": "Asynchronous JavaScript and CSS file loader.",

10014

"author": [

10015

"rgrove"

10016

],

10017

"tags": [

10018

"utility",

10019

"get",

10020

"script",

10021

"loader"

10022

],

10023

"use": [

10024

"get"

10025

]

10026

}

10027

}

10028

},

10029

"get": {

10030

"name": "get",

10031

"submodules": {},

10032

"classes": {

10033

"Get": 1,

10034

"Get.Transaction": 1

10035

},

10036

"fors": {},

10037

"namespaces": {},

10038

"tag": "module",

10039

"file": "get/js/get.js",

10040

"line": 718,

10041

"description": "Provides dynamic loading of remote JavaScript and CSS resources.",

10042

"static": 1,

10043

"extra": {

10044

"selleck": {

10045

"name": "get",

10046

"displayName": "Get",

10047

"description": "Asynchronous JavaScript and CSS file loader.",

10048

"author": [

10049

"rgrove"

10050

],

10051

"tags": [

10052

"utility",

10053

"get",

10054

"script",

10055

"loader"

10056

],

10057

"use": [

10058

"get"

10059

]

10060

}

10061

}

10062

},

10063

"handlebars": {

10064

"name": "handlebars",

10065

"submodules": {

10066

"handlebars-base": 1,

10067

"handlebars-compiler": 1

10068

},

10069

"classes": {

10070

"Handlebars": 1

10071

},

10072

"fors": {

10073

"Handlebars": 1

10074

},

10075

"namespaces": {},

10076

"tag": "main",

10077

"file": "handlebars/js/yui-handlebars-base-after.js",

10078

"line": 23,

10079

"description": "Handlebars is a simple template language inspired by Mustache.\n\nThis is a YUI port of the original Handlebars project, which can be found at\n<https://github.com/wycats/handlebars.js>.",

10080

"itemtype": "main",

10081

"extra": {

10082

"selleck": {

10083

"name": "handlebars",

10084

"displayName": "Handlebars",

10085

"description": "A simple template language inspired by Mustache.",

10086

"author": [

10087

"rgrove"

10088

],

10089

"tags": [

10090

"utility",

10091

"beta",

10092

"handlebars",

10093

"template",

10094

"templating",

10095

"mustache",

10096

"view"

10097

],

10098

"use": [

10099

"handlebars"

10100

]

10101

}

10102

}

10103

},

10104

"handlebars-base": {

10105

"name": "handlebars-base",

10106

"submodules": {},

10107

"classes": {

10108

"Handlebars": 1

10109

},

10110

"fors": {},

10111

"is_submodule": 1,

10112

"namespaces": {},

10113

"module": "handlebars",

10114

"namespace": "",

10115

"file": "handlebars/js/yui-handlebars-base-after.js",

10116

"line": 23,

10117

"description": "Provides basic Handlebars template rendering functionality. Use this module when\nyou only need to render pre-compiled templates.",

10118

"extra": {

10119

"selleck": {

10120

"name": "handlebars",

10121

"displayName": "Handlebars",

10122

"description": "A simple template language inspired by Mustache.",

10123

"author": [

10124

"rgrove"

10125

],

10126

"tags": [

10127

"utility",

10128

"beta",

10129

"handlebars",

10130

"template",

10131

"templating",

10132

"mustache",

10133

"view"

10134

],

10135

"use": [

10136

"handlebars"

10137

]

10138

}

10139

}

10140

},

10141

"handlebars-compiler": {

10142

"name": "handlebars-compiler",

10143

"submodules": {},

10144

"classes": {},

10145

"fors": {},

10146

"is_submodule": 1,

10147

"namespaces": {},

10148

"module": "handlebars",

10149

"namespace": "",

10150

"file": "handlebars/js/yui-handlebars-compiler-after.js",

10151

"line": 4,

10152

"description": "Handlebars parser and compiler. Use this module when you need to compile\nHandlebars templates.",

10153

"extra": {

10154

"selleck": {

10155

"name": "handlebars",

10156

"displayName": "Handlebars",

10157

"description": "A simple template language inspired by Mustache.",

10158

"author": [

10159

"rgrove"

10160

],

10161

"tags": [

10162

"utility",

10163

"beta",

10164

"handlebars",

10165

"template",

10166

"templating",

10167

"mustache",

10168

"view"

10169

],

10170

"use": [

10171

"handlebars"

10172

]

10173

}

10174

}

10175

},

10176

"highlight": {

10177

"name": "highlight",

10178

"submodules": {

10179

"highlight-accentfold": 1,

10180

"highlight-base": 1

10181

},

10182

"classes": {

10183

"Highlight": 1

10184

},

10185

"fors": {},

10186

"namespaces": {},

10187

"file": "highlight/js/highlight-base.js",

10188

"line": 11

10189

},

10190

"highlight-accentfold": {

10191

"name": "highlight-accentfold",

10192

"submodules": {},

10193

"classes": {},

10194

"fors": {},

10195

"is_submodule": 1,

10196

"namespaces": {},

10197

"module": "highlight",

10198

"namespace": "",

10199

"file": "highlight/js/highlight-accentfold.js",

10200

"line": 1,

10201

"description": "Adds accent-folding highlighters to `Y.Highlight`."

10202

},

10203

"highlight-base": {

10204

"name": "highlight-base",

10205

"submodules": {},

10206

"classes": {

10207

"Highlight": 1

10208

},

10209

"fors": {},

10210

"is_submodule": 1,

10211

"namespaces": {},

10212

"module": "highlight",

10213

"namespace": "",

10214

"file": "highlight/js/highlight-base.js",

10215

"line": 11,

10216

"description": "Provides methods for highlighting strings within other strings by wrapping\nthem in HTML.",

10217

"tag": "main",

10218

"itemtype": "main",

10219

"since": "3.3.0"

10220

},

10221

"history": {

10222

"name": "history",

10223

"submodules": {

10224

"history-base": 1,

10225

"history-hash-ie": 1,

10226

"history-hash": 1,

10227

"history-html5": 1

10228

},

10229

"classes": {

10230

"HistoryBase": 1,

10231

"HistoryHash": 1,

10232

"HistoryHTML5": 1

10233

},

10234

"fors": {

10235

"HistoryHash": 1,

10236

"YUI": 1,

10237

"config": 1

10238

},

10239

"namespaces": {},

10240

"tag": "main",

10241

"file": "history/js/history-html5.js",

10242

"line": 9,

10243

"description": "Provides browser history management functionality using a simple\nadd/replace/get paradigm. This can be used to ensure that the browser's back\nand forward buttons work as the user expects and to provide bookmarkable URLs\nthat return the user to the current application state, even in an Ajax\napplication that doesn't perform full-page refreshes.",

10244

"itemtype": "main",

10245

"extra": {

10246

"selleck": {

10247

"name": "history",

10248

"displayName": "History",

10249

"description": "Provides browser history management functionality using a simple add/get/replace paradigm.",

10250

"author": "rgrove",

10251

"tags": [

10252

"utility",

10253

"history",

10254

"html5",

10255

"hashchange",

10256

"pushstate"

10257

],

10258

"use": [

10259

"history"

10260

]

10261

}

10262

}

10263

},

10264

"history-base": {

10265

"name": "history-base",

10266

"submodules": {},

10267

"classes": {

10268

"HistoryBase": 1

10269

},

10270

"fors": {},

10271

"is_submodule": 1,

10272

"namespaces": {},

10273

"module": "history",

10274

"namespace": "",

10275

"file": "history/js/history-base.js",

10276

"line": 13,

10277

"description": "Provides global state management backed by an object, but with no browser\nhistory integration. For actual browser history integration and back/forward\nsupport, use the history-html5 or history-hash modules.",

10278

"uses": [

10279

"EventTarget"

10280

],

10281

"is_constructor": 1,

10282

"params": [

10283

{

10284

"name": "config",

10285

"description": "(optional) configuration object, which may contain\n zero or more of the following properties:\n\n<dl>\n <dt>force (Boolean)</dt>\n <dd>\n If `true`, a `history:change` event will be fired whenever the URL\n changes, even if there is no associated state change. Default is `false`.\n </dd>\n\n <dt>initialState (Object)</dt>\n <dd>\n Initial state to set, as an object hash of key/value pairs. This will be\n merged into the current global state.\n </dd>\n</dl>",

10286

"type": "Object"

10287

}

10288

],

10289

"extra": {

10290

"selleck": {

10291

"name": "history",

10292

"displayName": "History",

10293

"description": "Provides browser history management functionality using a simple add/get/replace paradigm.",

10294

"author": "rgrove",

10295

"tags": [

10296

"utility",

10297

"history",

10298

"html5",

10299

"hashchange",

10300

"pushstate"

10301

],

10302

"use": [

10303

"history"

10304

]

10305

}

10306

}

10307

},

10308

"history-hash-ie": {

10309

"name": "history-hash-ie",

10310

"submodules": {},

10311

"classes": {},

10312

"fors": {},

10313

"is_submodule": 1,

10314

"namespaces": {},

10315

"module": "history",

10316

"namespace": "",

10317

"file": "history/js/history-hash-ie.js",

10318

"line": 1,

10319

"description": "Improves IE6/7 support in history-hash by using a hidden iframe to create\nentries in IE's browser history. This module is only needed if IE6/7 support\nis necessary; it's not needed for any other browser.",

10320

"since": "3.2.0",

10321

"extra": {

10322

"selleck": {

10323

"name": "history",

10324

"displayName": "History",

10325

"description": "Provides browser history management functionality using a simple add/get/replace paradigm.",

10326

"author": "rgrove",

10327

"tags": [

10328

"utility",

10329

"history",

10330

"html5",

10331

"hashchange",

10332

"pushstate"

10333

],

10334

"use": [

10335

"history"

10336

]

10337

}

10338

}

10339

},

10340

"history-hash": {

10341

"name": "history-hash",

10342

"submodules": {},

10343

"classes": {

10344

"HistoryHash": 1

10345

},

10346

"fors": {},

10347

"is_submodule": 1,

10348

"namespaces": {},

10349

"module": "history",

10350

"namespace": "",

10351

"file": "history/js/history-hash.js",

10352

"line": 1,

10353

"description": "Provides browser history management backed by\n<code>window.location.hash</code>, as well as convenience methods for working\nwith the location hash and a synthetic <code>hashchange</code> event that\nnormalizes differences across browsers.",

10354

"since": "3.2.0",

10355

"extends": "HistoryBase",

10356

"is_constructor": 1,

10357

"params": [

10358

{

10359

"name": "config",

10360

"description": "(optional) Configuration object. See the HistoryBase\n documentation for details.",

10361

"type": "Object"

10362

}

10363

],

10364

"extra": {

10365

"selleck": {

10366

"name": "history",

10367

"displayName": "History",

10368

"description": "Provides browser history management functionality using a simple add/get/replace paradigm.",

10369

"author": "rgrove",

10370

"tags": [

10371

"utility",

10372

"history",

10373

"html5",

10374

"hashchange",

10375

"pushstate"

10376

],

10377

"use": [

10378

"history"

10379

]

10380

}

10381

}

10382

},

10383

"history-html5": {

10384

"name": "history-html5",

10385

"submodules": {},

10386

"classes": {

10387

"HistoryHTML5": 1

10388

},

10389

"fors": {},

10390

"is_submodule": 1,

10391

"namespaces": {},

10392

"module": "history",

10393

"namespace": "",

10394

"file": "history/js/history-html5.js",

10395

"line": 9,

10396

"description": "Provides browser history management using the HTML5 history API.",

10397

"since": "3.2.0",

10398

"extra": {

10399

"selleck": {

10400

"name": "history",

10401

"displayName": "History",

10402

"description": "Provides browser history management functionality using a simple add/get/replace paradigm.",

10403

"author": "rgrove",

10404

"tags": [

10405

"utility",

10406

"history",

10407

"html5",

10408

"hashchange",

10409

"pushstate"

10410

],

10411

"use": [

10412

"history"

10413

]

10414

}

10415

}

10416

},

10417

"imageloader": {

10418

"name": "imageloader",

10419

"submodules": {},

10420

"classes": {

10421

"ImgLoadGroup": 1,

10422

"ImgLoadImgObj": 1

10423

},

10424

"fors": {},

10425

"namespaces": {},

10426

"tag": "module",

10427

"file": "imageloader/js/imageloader.js",

10428

"line": 418,

10429

"description": "The ImageLoader Utility is a framework to dynamically load images according to certain triggers,\nenabling faster load times and a more responsive UI.",

10430

"extra": {

10431

"selleck": {

10432

"name": "imageloader",

10433

"displayName": "ImageLoader",

10434

"description": "The ImageLoader Utility provides a mechanism to delay the loading of specfic images on a page. This allows you to, for example, defer the loading of images which are out of the browser viewport until the user begins to scroll, or to defer the loading of images in a carousel until the user mouses over the carousel's navigation controls.",

10435

"author": "",

10436

"tags": [

10437

"utility",

10438

"image",

10439

"loader",

10440

"performance"

10441

],

10442

"use": [

10443

"imageloader"

10444

]

10445

}

10446

}

10447

},

10448

"intl": {

10449

"name": "intl",

10450

"submodules": {},

10451

"classes": {},

10452

"fors": {},

10453

"namespaces": {},

10454

"tag": "module",

10455

"file": "intl/js/Intl.js",

10456

"line": 7,

10457

"description": "Provides utilities to support the management of localized resources (strings and formatting patterns).",

10458

"extra": {

10459

"selleck": {

10460

"name": "intl",

10461

"displayName": "Internationalization",

10462

"description": "The Internationalization utility supports the management of localized resources such as strings and formatting patterns.",

10463

"author": "sdesai",

10464

"tags": [

10465

"intl",

10466

"utility"

10467

],

10468

"use": [

10469

"intl"

10470

],

10471

"apiPath": "/classes/Intl.html"

10472

}

10473

}

10474

},

10475

"io-base": {

10476

"name": "io-base",

10477

"submodules": {},

10478

"classes": {

10479

"IO": 1

10480

},

10481

"fors": {

10482

"IO": 1,

10483

"YUI": 1

10484

},

10485

"namespaces": {},

10486

"tag": "main",

10487

"file": "io/js/io-base.js",

10488

"line": 17,

10489

"description": "Base IO functionality. Provides basic XHR transport support.",

10490

"itemtype": "main",

10491

"extra": {

10492

"selleck": {

10493

"name": "io",

10494

"displayName": "IO Utility",

10495

"description": "HTTP utility for making same-origin and cross-domain requests",

10496

"author": "tsha",

10497

"tags": [

10498

"utility"

10499

],

10500

"use": [

10501

"io"

10502

]

10503

}

10504

}

10505

},

10506

"io": {

10507

"name": "io",

10508

"submodules": {

10509

"io-form": 1,

10510

"io-queue": 1,

10511

"io-upload-iframe": 1,

10512

"io-xdr": 1

10513

},

10514

"classes": {},

10515

"fors": {

10516

"IO": 1

10517

},

10518

"namespaces": {},

10519

"tag": "main",

10520

"file": "io/js/io.js",

10521

"line": 1,

10522

"description": "The IO class is a utility that brokers HTTP requests through a simplified\ninterface. Specifically, it allows JavaScript to make HTTP requests to\na resource without a page reload. The underlying transport for making\nsame-domain requests is the XMLHttpRequest object. IO can also use\nFlash, if specified as a transport, for cross-domain requests.\n\n Y.io('/some/url', {\n on: {\n success: function(id, e) {\n Y.log(e.responseText);\n }\n }\n });",

10523

"itemtype": "main",

10524

"extra": {

10525

"selleck": {

10526

"name": "io",

10527

"displayName": "IO Utility",

10528

"description": "HTTP utility for making same-origin and cross-domain requests",

10529

"author": "tsha",

10530

"tags": [

10531

"utility"

10532

],

10533

"use": [

10534

"io"

10535

]

10536

}

10537

}

10538

},

10539

"io-form": {

10540

"name": "io-form",

10541

"submodules": {},

10542

"classes": {},

10543

"fors": {},

10544

"is_submodule": 1,

10545

"namespaces": {},

10546

"module": "io",

10547

"namespace": "",

10548

"file": "io/js/io-form.js",

10549

"line": 1,

10550

"description": "Extends IO to enable HTML form data serialization, when specified\nin the transaction's configuration object.",

10551

"extra": {

10552

"selleck": {

10553

"name": "io",

10554

"displayName": "IO Utility",

10555

"description": "HTTP utility for making same-origin and cross-domain requests",

10556

"author": "tsha",

10557

"tags": [

10558

"utility"

10559

],

10560

"use": [

10561

"io"

10562

]

10563

}

10564

}

10565

},

10566

"io-queue": {

10567

"name": "io-queue",

10568

"submodules": {},

10569

"classes": {},

10570

"fors": {},

10571

"is_submodule": 1,

10572

"namespaces": {},

10573

"module": "io",

10574

"namespace": "",

10575

"file": "io/js/io-queue.js",

10576

"line": 1,

10577

"description": "Extends IO to implement Queue for synchronous\ntransaction processing.",

10578

"extra": {

10579

"selleck": {

10580

"name": "io",

10581

"displayName": "IO Utility",

10582

"description": "HTTP utility for making same-origin and cross-domain requests",

10583

"author": "tsha",

10584

"tags": [

10585

"utility"

10586

],

10587

"use": [

10588

"io"

10589

]

10590

}

10591

}

10592

},

10593

"io-upload-iframe": {

10594

"name": "io-upload-iframe",

10595

"submodules": {},

10596

"classes": {},

10597

"fors": {},

10598

"is_submodule": 1,

10599

"namespaces": {},

10600

"module": "io",

10601

"namespace": "",

10602

"file": "io/js/io-upload-iframe.js",

10603

"line": 1,

10604

"description": "Extends the IO to enable file uploads, with HTML forms \nusing an iframe as the transport medium.",

10605

"extra": {

10606

"selleck": {

10607

"name": "io",

10608

"displayName": "IO Utility",

10609

"description": "HTTP utility for making same-origin and cross-domain requests",

10610

"author": "tsha",

10611

"tags": [

10612

"utility"

10613

],

10614

"use": [

10615

"io"

10616

]

10617

}

10618

}

10619

},

10620

"io-xdr": {

10621

"name": "io-xdr",

10622

"submodules": {},

10623

"classes": {},

10624

"fors": {},

10625

"is_submodule": 1,

10626

"namespaces": {},

10627

"module": "io",

10628

"namespace": "",

10629

"file": "io/js/io-xdr.js",

10630

"line": 1,

10631

"description": "Extends IO to provide an alternate, Flash transport, for making\ncross-domain requests.",

10632

"extra": {

10633

"selleck": {

10634

"name": "io",

10635

"displayName": "IO Utility",

10636

"description": "HTTP utility for making same-origin and cross-domain requests",

10637

"author": "tsha",

10638

"tags": [

10639

"utility"

10640

],

10641

"use": [

10642

"io"

10643

]

10644

}

10645

}

10646

},

10647

"json": {

10648

"name": "json",

10649

"submodules": {

10650

"json-parse": 1,

10651

"json-stringify": 1

10652

},

10653

"classes": {

10654

"JSON": 1

10655

},

10656

"fors": {

10657

"JSON": 1

10658

},

10659

"namespaces": {},

10660

"tag": "main",

10661

"file": "json/js/parse.js",

10662

"line": 1,

10663

"description": "The JSON module adds support for serializing JavaScript objects into\nJSON strings and parsing JavaScript objects from strings in JSON format.\n\nThe JSON namespace is added to your YUI instance including static methods\nY.JSON.parse(..) and Y.JSON.stringify(..).\n\nThe functionality and method signatures follow the ECMAScript 5\nspecification. In browsers with native JSON support, the native\nimplementation is used.\n\nThe <code>json</code> module is a rollup of <code>json-parse</code> and\n<code>json-stringify</code>.\n\nAs their names suggest, <code>json-parse</code> adds support for parsing\nJSON data (Y.JSON.parse) and <code>json-stringify</code> for serializing\nJavaScript data into JSON strings (Y.JSON.stringify). You may choose to\ninclude either of the submodules individually if you don't need the\ncomplementary functionality, or include the rollup for both.",

10664

"itemtype": "main",

10665

"extra": {

10666

"selleck": {

10667

"name": "json",

10668

"displayName": "JSON",

10669

"description": "The JSON module provides methods for transforming data between native JavaScript objects and their JSON string equivalent.",

10670

"author": "lsmith",

10671

"use": [

10672

"json-parse",

10673

"json-stringify"

10674

],

10675

"tags": [

10676

"utility",

10677

"json"

10678

]

10679

}

10680

}

10681

},

10682

"json-parse": {

10683

"name": "json-parse",

10684

"submodules": {},

10685

"classes": {

10686

"JSON": 1

10687

},

10688

"fors": {},

10689

"is_submodule": 1,

10690

"namespaces": {},

10691

"module": "json",

10692

"namespace": "",

10693

"file": "json/js/parse.js",

10694

"line": 1,

10695

"description": "Provides Y.JSON.parse method to accept JSON strings and return native\nJavaScript objects.",

10696

"static": 1,

10697

"extra": {

10698

"selleck": {

10699

"name": "json",

10700

"displayName": "JSON",

10701

"description": "The JSON module provides methods for transforming data between native JavaScript objects and their JSON string equivalent.",

10702

"author": "lsmith",

10703

"use": [

10704

"json-parse",

10705

"json-stringify"

10706

],

10707

"tags": [

10708

"utility",

10709

"json"

10710

]

10711

}

10712

}

10713

},

10714

"json-stringify": {

10715

"name": "json-stringify",

10716

"submodules": {},

10717

"classes": {},

10718

"fors": {},

10719

"is_submodule": 1,

10720

"namespaces": {},

10721

"module": "json",

10722

"namespace": "",

10723

"file": "json/js/stringify.js",

10724

"line": 1,

10725

"description": "Provides Y.JSON.stringify method for converting objects to JSON strings.",

10726

"static": 1,

10727

"extra": {

10728

"selleck": {

10729

"name": "json",

10730

"displayName": "JSON",

10731

"description": "The JSON module provides methods for transforming data between native JavaScript objects and their JSON string equivalent.",

10732

"author": "lsmith",

10733

"use": [

10734

"json-parse",

10735

"json-stringify"

10736

],

10737

"tags": [

10738

"utility",

10739

"json"

10740

]

10741

}

10742

}

10743

},

10744

"jsonp": {

10745

"name": "jsonp",

10746

"submodules": {

10747

"jsonp-url": 1

10748

},

10749

"classes": {

10750

"JSONPRequest": 1

10751

},

10752

"fors": {

10753

"JSONPRequest": 1,

10754

"YUI": 1

10755

},

10756

"namespaces": {},

10757

"tag": "module",

10758

"file": "jsonp/js/jsonp.js",

10759

"line": 3,

10760

"description": "Provides a JSONPRequest class for repeated JSONP calls, and a convenience\nmethod Y.jsonp(url, callback) to instantiate and send a JSONP request.\n\nBoth the constructor as well as the convenience function take two\nparameters: a url string and a callback.\n\nThe url provided must include the placeholder string\n"{callback}" which will be replaced by a dynamically\ngenerated routing function to pass the data to your callback function.\nAn example url might look like\n"http://example.com/service?callback={callback}".\n\nThe second parameter can be a callback function that accepts the JSON\npayload as its argument, or a configuration object supporting the keys:\n<ul>\n <li>on - map of callback subscribers\n <ul>\n <li>success - function handler for successful transmission</li>\n <li>failure - function handler for failed transmission</li>\n <li>timeout - function handler for transactions that timeout</li>\n </ul>\n </li>\n <li>format - override function for inserting the proxy name in the url</li>\n <li>timeout - the number of milliseconds to wait before giving up</li>\n <li>context - becomes <code>this</code> in the callbacks</li>\n <li>args - array of subsequent parameters to pass to the callbacks</li>\n <li>allowCache - use the same proxy name for all requests? (boolean)</li>\n</ul>",

10761

"is_constructor": 1,

10762

"params": [

10763

{

10764

"name": "url",

10765

"description": "the url of the JSONP service",

10766

"type": "String"

10767

},

10768

{

10769

"name": "callback",

10770

"description": "the default callback configuration or\n success handler",

10771

"type": "Object|Function"

10772

}

10773

],

10774

"extra": {

10775

"selleck": {

10776

"name": "jsonp",

10777

"displayName": "JSONP",

10778

"description": "JSONP provides a JSONPRequest object for reusable cross-domain requests to web services that support JSONP output and a Y.jsonp(..) method to instantiate and send a JSONPRequest.",

10779

"author": "lsmith",

10780

"use": [

10781

"jsonp",

10782

"jsonp-url"

10783

],

10784

"tags": [

10785

"utility",

10786

"jsonp"

10787

]

10788

}

10789

}

10790

},

10791

"jsonp-url": {

10792

"name": "jsonp-url",

10793

"submodules": {},

10794

"classes": {

10795

"JSONPRequest": 1

10796

},

10797

"fors": {},

10798

"is_submodule": 1,

10799

"namespaces": {},

10800

"module": "jsonp",

10801

"namespace": "",

10802

"file": "jsonp/js/jsonp.js",

10803

"line": 3,

10804

"description": "Adds support for parsing complex callback identifiers from the jsonp url.\nThis includes callback=foo[1]bar.baz[\"goo\"] as well as referencing methods\nin the YUI instance.",

10805

"extra": {

10806

"selleck": {

10807

"name": "jsonp",

10808

"displayName": "JSONP",

10809

"description": "JSONP provides a JSONPRequest object for reusable cross-domain requests to web services that support JSONP output and a Y.jsonp(..) method to instantiate and send a JSONPRequest.",

10810

"author": "lsmith",

10811

"use": [

10812

"jsonp",

10813

"jsonp-url"

10814

],

10815

"tags": [

10816

"utility",

10817

"jsonp"

10818

]

10819

}

10820

}

10821

},

10822

"loader": {

10823

"name": "loader",

10824

"submodules": {

10825

"loader-base": 1,

10826

"rollup": 1,

10827

"yui3": 1

10828

},

10829

"classes": {

10830

"Loader": 1

10831

},

10832

"fors": {

10833

"YUI": 1,

10834

"Loader": 1

10835

},

10836

"namespaces": {},

10837

"file": "loader/js/loader.js",

10838

"line": 52,

10839

"description": "Loader dynamically loads script and css files. It includes the dependency\ninformation for the version of the library in use, and will automatically pull in\ndependencies for the modules requested. It can also load the\nfiles from the Yahoo! CDN, and it can utilize the combo service provided on\nthis network to reduce the number of http connections required to download\nYUI files.",

10840

"tag": "main",

10841

"itemtype": "main"

10842

},

10843

"loader-base": {

10844

"name": "loader-base",

10845

"submodules": {},

10846

"classes": {

10847

"Loader": 1

10848

},

10849

"fors": {},

10850

"is_submodule": 1,

10851

"namespaces": {},

10852

"module": "loader",

10853

"namespace": "",

10854

"file": "loader/js/loader.js",

10855

"line": 52,

10856

"description": "Loader dynamically loads script and css files. It includes the dependency\ninformation for the version of the library in use, and will automatically pull in\ndependencies for the modules requested. It can also load the\nfiles from the Yahoo! CDN, and it can utilize the combo service provided on\nthis network to reduce the number of http connections required to download\nYUI files.",

10857

"tag": "main",

10858

"itemtype": "main"

10859

},

10860

"rollup": {

10861

"name": "rollup",

10862

"submodules": {},

10863

"classes": {},

10864

"fors": {},

10865

"is_submodule": 1,

10866

"namespaces": {},

10867

"module": "loader",

10868

"namespace": "",

10869

"file": "loader/js/rollup.js",

10870

"line": 1,

10871

"description": "Optional automatic rollup logic for reducing http connections\nwhen not using a combo service."

10872

},

10873

"yui3": {

10874

"name": "yui3",

10875

"submodules": {},

10876

"classes": {},

10877

"fors": {},

10878

"is_submodule": 1,

10879

"namespaces": {},

10880

"module": "loader",

10881

"namespace": "",

10882

"file": "loader/js/yui3.js",

10883

"line": 3,

10884

"description": "YUI 3 module metadata"

10885

},

10886

"matrix": {

10887

"name": "matrix",

10888

"submodules": {},

10889

"classes": {

10890

"Matrix": 1

10891

},

10892

"fors": {},

10893

"namespaces": {},

10894

"tag": "module",

10895

"file": "matrix/js/Matrix.js",

10896

"line": 1,

10897

"description": "Matrix is a class that allows for the manipulation of a transform matrix.\nThis class is a work in progress."

10898

},

10899

"node-flick": {

10900

"name": "node-flick",

10901

"submodules": {},

10902

"classes": {

10903

"Plugin.Flick": 1

10904

},

10905

"fors": {},

10906

"namespaces": {

10907

"Plugin": 1

10908

},

10909

"tag": "module",

10910

"file": "node-flick/js/NodeFlick.js",

10911

"line": 31,

10912

"description": "Provide a simple Flick plugin, which can be used along with the \"flick\" gesture event, to \nanimate the motion of the host node in response to a (mouse or touch) flick gesture. \n\nThe current implementation is designed to move the node, relative to the bounds of a parent node and is suitable\nfor scroll/carousel type implementations. Future versions will remove that constraint, to allow open ended movement within\nthe document."

10913

},

10914

"node-focusmanager": {

10915

"name": "node-focusmanager",

10916

"submodules": {},

10917

"classes": {

10918

"plugin.NodeFocusManager": 1

10919

},

10920

"fors": {},

10921

"namespaces": {

10922

"plugin": 1

10923

},

10924

"tag": "module",

10925

"file": "node-focusmanager/js/node-focusmanager.js",

10926

"line": 67,

10927

"description": "The Focus Manager Node Plugin makes it easy to manage focus among\na Node's descendants. Primarily intended to help with widget development,\nthe Focus Manager Node Plugin can be used to improve the keyboard\naccessibility of widgets.\n\n\nWhen designing widgets that manage a set of descendant controls (i.e. buttons\nin a toolbar, tabs in a tablist, menuitems in a menu, etc.) it is important to\nlimit the number of descendants in the browser's default tab flow. The fewer\nnumber of descendants in the default tab flow, the easier it is for keyboard\nusers to navigate between widgets by pressing the tab key. When a widget has\nfocus it should provide a set of shortcut keys (typically the arrow keys)\nto move focus among its descendants.\n\n\n\nTo this end, the Focus Manager Node Plugin makes it easy to define a Node's\nfocusable descendants, define which descendant should be in the default tab\nflow, and define the keys that move focus among each descendant.\nAdditionally, as the CSS\n<a href=\"http://www.w3.org/TR/CSS21/selector.html#x38\"><code>:focus</code></a>\npseudo class is not supported on all elements in all\n<a href=\"http://developer.yahoo.com/yui/articles/gbs/\">A-Grade browsers</a>,\nthe Focus Manager Node Plugin provides an easy, cross-browser means of\nstyling focus.\n",

10928

"extra": {

10929

"selleck": {

10930

"name": "node-focusmanager",

10931

"displayName": "FocusManager Node Plugin",

10932

"description": "Makes it easy to define a Node's focusable descendants, define which descendant should be in the default tab flow, and define the keys that move focus among each descendant.",

10933

"author": [

10934

"kloots",

10935

"rgrove"

10936

],

10937

"tags": [

10938

"utility",

10939

"node",

10940

"plugin",

10941

"focus",

10942

"keyboard",

10943

"navigation",

10944

"beta"

10945

],

10946

"use": [

10947

"node-focusmanager"

10948

]

10949

}

10950

}

10951

},

10952

"node-menunav": {

10953

"name": "node-menunav",

10954

"submodules": {},

10955

"classes": {

10956

"plugin.NodeMenuNav": 1

10957

},

10958

"fors": {},

10959

"namespaces": {

10960

"plugin": 1

10961

},

10962

"tag": "module",

10963

"file": "node-menunav/js/node-menunav.js",

10964

"line": 344,

10965

"description": "The MenuNav Node Plugin makes it easy to transform existing list-based \nmarkup into traditional, drop down navigational menus that are both accessible \nand easy to customize, and only require a small set of dependencies.\n\n\nTo use the MenuNav Node Plugin, simply pass a reference to the plugin to a \nNode instance's <code>plug</code> method.\n\n\n<code>\n<script type=\"text/javascript\"> \n \n\t\t//\tCall the \"use\" method, passing in \"node-menunav\". This will \n\t\t//\tload the script and CSS for the MenuNav Node Plugin and all of \n\t\t//\tthe required dependencies. \n \n\t\tYUI().use(\"node-menunav\", function(Y) { \n \n\t\t\t//\tUse the \"contentready\" event to initialize the menu when \n\t\t\t//\tthe subtree of element representing the root menu \n\t\t\t//\t(<div id=\"menu-1\">) is ready to be scripted. \n \n\t\t\tY.on(\"contentready\", function () { \n \n\t\t\t\t//\tThe scope of the callback will be a Node instance \n\t\t\t\t//\trepresenting the root menu (<div id=\"menu-1\">). \n\t\t\t\t//\tTherefore, since \"this\" represents a Node instance, it \n\t\t\t\t//\tis possible to just call \"this.plug\" passing in a \n\t\t\t\t//\treference to the MenuNav Node Plugin. \n \n\t\t\t\tthis.plug(Y.Plugin.NodeMenuNav); \n \n\t\t\t}, \"#menu-1\"); \n \t\t\n\t\t}); \n \t\n\t</script> \n</code>\n\n\nThe MenuNav Node Plugin has several configuration properties that can be \nset via an object literal that is passed as a second argument to a Node \ninstance's <code>plug</code> method.\n\n\n\n<code>\n<script type=\"text/javascript\"> \n \n\t\t//\tCall the \"use\" method, passing in \"node-menunav\". This will \n\t\t//\tload the script and CSS for the MenuNav Node Plugin and all of \n\t\t//\tthe required dependencies. \n \n\t\tYUI().use(\"node-menunav\", function(Y) { \n \n\t\t\t//\tUse the \"contentready\" event to initialize the menu when \n\t\t\t//\tthe subtree of element representing the root menu \n\t\t\t//\t(<div id=\"menu-1\">) is ready to be scripted. \n \n\t\t\tY.on(\"contentready\", function () { \n \n\t\t\t\t//\tThe scope of the callback will be a Node instance \n\t\t\t\t//\trepresenting the root menu (<div id=\"menu-1\">). \n\t\t\t\t//\tTherefore, since \"this\" represents a Node instance, it \n\t\t\t\t//\tis possible to just call \"this.plug\" passing in a \n\t\t\t\t//\treference to the MenuNav Node Plugin. \n \n\t\t\t\tthis.plug(Y.Plugin.NodeMenuNav, { mouseOutHideDelay: 1000 });\n \n\t\t\t}, \"#menu-1\"); \n \t\t\n\t\t}); \n \t\n\t</script> \n</code>\n",

10966

"extra": {

10967

"selleck": {

10968

"name": "node-menunav",

10969

"displayName": "MenuNav Node Plugin",

10970

"description": "Easily transform a list into an accessible and customizable drop-down menu.",

10971

"author": [

10972

"kloots",

10973

"rgrove"

10974

],

10975

"tags": [

10976

"widget",

10977

"plugin",

10978

"beta",

10979

"menu",

10980

"menunav",

10981

"node",

10982

"dropdown"

10983

],

10984

"use": [

10985

"node-menunav"

10986

],

10987

"pages": {

10988

"menunav-leftnav-example": {

10989

"displayName": "MenuNav: Basic Left Nav Example",

10990

"layout": "menunav-example"

10991

},

10992

"node-menunav-2-example": {

10993

"displayName": "MenuNav: Basic Top Nav Example",

10994

"layout": "menunav-example"

10995

},

10996

"node-menunav-3-example": {

10997

"displayName": "MenuNav: Menu Button Top Nav Example",

10998

"layout": "menunav-example"

10999

},

11000

"node-menunav-4-example": {

11001

"displayName": "MenuNav: Split Button Top Nav Example",

11002

"layout": "menunav-example"

11003

},

11004

"node-menunav-5-example": {

11005

"displayName": "MenuNav: Left Nav with Submenus with Shadows Example",

11006

"layout": "menunav-example"

11007

},

11008

"node-menunav-6-example": {

11009

"displayName": "MenuNav: Left Nav With Submenus With Rounded Corners Example",

11010

"layout": "menunav-example"

11011

},

11012

"node-menunav-7-example": {

11013

"displayName": "MenuNav: Skinning Menus Created Using the MenuNav Node Plugin Example",

11014

"layout": "menunav-example"

11015

}

11016

}

11017

}

11018

}

11019

},

11020

"align-plugin": {

11021

"name": "align-plugin",

11022

"submodules": {},

11023

"classes": {

11024

"Plugin.Align": 1

11025

},

11026

"fors": {},

11027

"namespaces": {},

11028

"tag": "module",

11029

"file": "node/js/align-plugin.js",

11030

"line": 11,

11031

"description": "Provides advanced positioning support for Node via a Plugin\nfor centering and alignment.",

11032

"extra": {

11033

"selleck": {

11034

"name": "node",

11035

"displayName": "Node",

11036

"description": "Provides a wrapper for working with DOM nodes.",

11037

"author": "msweeney",

11038

"tags": [

11039

"core",

11040

"dom",

11041

"node"

11042

],

11043

"use": [

11044

"node"

11045

]

11046

}

11047

}

11048

},

11049

"node": {

11050

"name": "node",

11051

"submodules": {

11052

"node-base": 1,

11053

"node-core": 1,

11054

"node-data": 1,

11055

"node-deprecated": 1,

11056

"node-event-delegate": 1,

11057

"node-event-html5": 1,

11058

"node-event-simulate": 1,

11059

"node-load": 1,

11060

"node-pluginhost": 1,

11061

"node-screen": 1,

11062

"node-style": 1

11063

},

11064

"classes": {

11065

"Node": 1,

11066

"NodeList": 1

11067

},

11068

"fors": {

11069

"Node": 1,

11070

"NodeList": 1,

11071

"YUI": 1

11072

},

11073

"namespaces": {},

11074

"file": "node/js/nodelist.js",

11075

"line": 7,

11076

"description": "The Node Utility provides a DOM-like interface for interacting with DOM nodes.",

11077

"tag": "main",

11078

"itemtype": "main",

11079

"extra": {

11080

"selleck": {

11081

"name": "node",

11082

"displayName": "Node",

11083

"description": "Provides a wrapper for working with DOM nodes.",

11084

"author": "msweeney",

11085

"tags": [

11086

"core",

11087

"dom",

11088

"node"

11089

],

11090

"use": [

11091

"node"

11092

]

11093

}

11094

}

11095

},

11096

"node-base": {

11097

"name": "node-base",

11098

"submodules": {},

11099

"classes": {},

11100

"fors": {},

11101

"is_submodule": 1,

11102

"namespaces": {},

11103

"module": "node",

11104

"namespace": "",

11105

"file": "node/js/node-attrs.js",

11106

"line": 1,

11107

"extra": {

11108

"selleck": {

11109

"name": "node",

11110

"displayName": "Node",

11111

"description": "Provides a wrapper for working with DOM nodes.",

11112

"author": "msweeney",

11113

"tags": [

11114

"core",

11115

"dom",

11116

"node"

11117

],

11118

"use": [

11119

"node"

11120

]

11121

}

11122

}

11123

},

11124

"node-core": {

11125

"name": "node-core",

11126

"submodules": {},

11127

"classes": {

11128

"Node": 1,

11129

"NodeList": 1

11130

},

11131

"fors": {},

11132

"is_submodule": 1,

11133

"namespaces": {},

11134

"module": "node",

11135

"namespace": "",

11136

"file": "node/js/nodelist.js",

11137

"line": 7,

11138

"description": "The Node Utility provides a DOM-like interface for interacting with DOM nodes.",

11139

"tag": "main",

11140

"itemtype": "main",

11141

"extra": {

11142

"selleck": {

11143

"name": "node",

11144

"displayName": "Node",

11145

"description": "Provides a wrapper for working with DOM nodes.",

11146

"author": "msweeney",

11147

"tags": [

11148

"core",

11149

"dom",

11150

"node"

11151

],

11152

"use": [

11153

"node"

11154

]

11155

}

11156

}

11157

},

11158

"node-data": {

11159

"name": "node-data",

11160

"submodules": {},

11161

"classes": {},

11162

"fors": {},

11163

"is_submodule": 1,

11164

"namespaces": {},

11165

"module": "node",

11166

"namespace": "",

11167

"file": "node/js/node-data.js",

11168

"line": 1,

11169

"description": "Provides methods for managing custom Node data.",

11170

"tag": "main",

11171

"itemtype": "main",

11172

"extra": {

11173

"selleck": {

11174

"name": "node",

11175

"displayName": "Node",

11176

"description": "Provides a wrapper for working with DOM nodes.",

11177

"author": "msweeney",

11178

"tags": [

11179

"core",

11180

"dom",

11181

"node"

11182

],

11183

"use": [

11184

"node"

11185

]

11186

}

11187

}

11188

},

11189

"node-deprecated": {

11190

"name": "node-deprecated",

11191

"submodules": {},

11192

"classes": {},

11193

"fors": {},

11194

"is_submodule": 1,

11195

"namespaces": {},

11196

"module": "node",

11197

"namespace": "",

11198

"file": "node/js/node-deprecated.js",

11199

"line": 1,

11200

"deprecated": true,

11201

"extra": {

11202

"selleck": {

11203

"name": "node",

11204

"displayName": "Node",

11205

"description": "Provides a wrapper for working with DOM nodes.",

11206

"author": "msweeney",

11207

"tags": [

11208

"core",

11209

"dom",

11210

"node"

11211

],

11212

"use": [

11213

"node"

11214

]

11215

}

11216

}

11217

},

11218

"node-event-delegate": {

11219

"name": "node-event-delegate",

11220

"submodules": {},

11221

"classes": {},

11222

"fors": {},

11223

"is_submodule": 1,

11224

"namespaces": {},

11225

"module": "node",

11226

"namespace": "",

11227

"file": "node/js/node-event-delegate.js",

11228

"line": 1,

11229

"description": "Functionality to make the node a delegated event container",

11230

"extra": {

11231

"selleck": {

11232

"name": "node",

11233

"displayName": "Node",

11234

"description": "Provides a wrapper for working with DOM nodes.",

11235

"author": "msweeney",

11236

"tags": [

11237

"core",

11238

"dom",

11239

"node"

11240

],

11241

"use": [

11242

"node"

11243

]

11244

}

11245

}

11246

},

11247

"node-event-html5": {

11248

"name": "node-event-html5",

11249

"submodules": {},

11250

"classes": {},

11251

"fors": {},

11252

"is_submodule": 1,

11253

"namespaces": {},

11254

"module": "node",

11255

"namespace": "",

11256

"file": "node/js/node-event-html5.js",

11257

"line": 1,

11258

"description": "Adds HTML5 event support to Node.",

11259

"extra": {

11260

"selleck": {

11261

"name": "node",

11262

"displayName": "Node",

11263

"description": "Provides a wrapper for working with DOM nodes.",

11264

"author": "msweeney",

11265

"tags": [

11266

"core",

11267

"dom",

11268

"node"

11269

],

11270

"use": [

11271

"node"

11272

]

11273

}

11274

}

11275

},

11276

"node-event-simulate": {

11277

"name": "node-event-simulate",

11278

"submodules": {},

11279

"classes": {},

11280

"fors": {},

11281

"is_submodule": 1,

11282

"namespaces": {},

11283

"module": "node",

11284

"namespace": "",

11285

"file": "node/js/node-event-simulate.js",

11286

"line": 1,

11287

"description": "Adds functionality to simulate events.",

11288

"extra": {

11289

"selleck": {

11290

"name": "node",

11291

"displayName": "Node",

11292

"description": "Provides a wrapper for working with DOM nodes.",

11293

"author": "msweeney",

11294

"tags": [

11295

"core",

11296

"dom",

11297

"node"

11298

],

11299

"use": [

11300

"node"

11301

]

11302

}

11303

}

11304

},

11305

"node-load": {

11306

"name": "node-load",

11307

"submodules": {},

11308

"classes": {},

11309

"fors": {},

11310

"is_submodule": 1,

11311

"namespaces": {},

11312

"module": "node",

11313

"namespace": "",

11314

"file": "node/js/node-load.js",

11315

"line": 1,

11316

"description": "Extended Node interface with a basic IO API.",

11317

"extra": {

11318

"selleck": {

11319

"name": "node",

11320

"displayName": "Node",

11321

"description": "Provides a wrapper for working with DOM nodes.",

11322

"author": "msweeney",

11323

"tags": [

11324

"core",

11325

"dom",

11326

"node"

11327

],

11328

"use": [

11329

"node"

11330

]

11331

}

11332

}

11333

},

11334

"node-pluginhost": {

11335

"name": "node-pluginhost",

11336

"submodules": {},

11337

"classes": {},

11338

"fors": {},

11339

"is_submodule": 1,

11340

"namespaces": {},

11341

"module": "node",

11342

"namespace": "",

11343

"file": "node/js/node-pluginhost.js",

11344

"line": 1,

11345

"extra": {

11346

"selleck": {

11347

"name": "node",

11348

"displayName": "Node",

11349

"description": "Provides a wrapper for working with DOM nodes.",

11350

"author": "msweeney",

11351

"tags": [

11352

"core",

11353

"dom",

11354

"node"

11355

],

11356

"use": [

11357

"node"

11358

]

11359

}

11360

}

11361

},

11362

"node-screen": {

11363

"name": "node-screen",

11364

"submodules": {},

11365

"classes": {},

11366

"fors": {},

11367

"is_submodule": 1,

11368

"namespaces": {},

11369

"module": "node",

11370

"namespace": "",

11371

"file": "node/js/node-region.js",

11372

"line": 1,

11373

"description": "Extended Node interface for managing regions and screen positioning.\nAdds support for positioning elements and normalizes window size and scroll detection.",

11374

"extra": {

11375

"selleck": {

11376

"name": "node",

11377

"displayName": "Node",

11378

"description": "Provides a wrapper for working with DOM nodes.",

11379

"author": "msweeney",

11380

"tags": [

11381

"core",

11382

"dom",

11383

"node"

11384

],

11385

"use": [

11386

"node"

11387

]

11388

}

11389

}

11390

},

11391

"node-style": {

11392

"name": "node-style",

11393

"submodules": {},

11394

"classes": {},

11395

"fors": {},

11396

"is_submodule": 1,

11397

"namespaces": {},

11398

"module": "node",

11399

"namespace": "",

11400

"file": "node/js/node-style.js",

11401

"line": 2,

11402

"description": "Extended Node interface for managing node styles.",

11403

"extra": {

11404

"selleck": {

11405

"name": "node",

11406

"displayName": "Node",

11407

"description": "Provides a wrapper for working with DOM nodes.",

11408

"author": "msweeney",

11409

"tags": [

11410

"core",

11411

"dom",

11412

"node"

11413

],

11414

"use": [

11415

"node"

11416

]

11417

}

11418

}

11419

},

11420

"shim-plugin": {

11421

"name": "shim-plugin",

11422

"submodules": {},

11423

"classes": {

11424

"Plugin.Shim": 1

11425

},

11426

"fors": {},

11427

"namespaces": {},

11428

"tag": "module",

11429

"file": "node/js/shim-plugin.js",

11430

"line": 7,

11431

"description": "Provides shimming support for Node via a Plugin.\nThis fixes SELECT bleedthrough for IE6 & Mac scrollbars",

11432

"extra": {

11433

"selleck": {

11434

"name": "node",

11435

"displayName": "Node",

11436

"description": "Provides a wrapper for working with DOM nodes.",

11437

"author": "msweeney",

11438

"tags": [

11439

"core",

11440

"dom",

11441

"node"

11442

],

11443

"use": [

11444

"node"

11445

]

11446

}

11447

}

11448

},

11449

"oop": {

11450

"name": "oop",

11451

"submodules": {},

11452

"classes": {},

11453

"fors": {

11454

"YUI": 1

11455

},

11456

"namespaces": {},

11457

"tag": "module",

11458

"file": "oop/js/oop.js",

11459

"line": 1,

11460

"description": "Adds object inheritance and manipulation utilities to the YUI instance. This\nmodule is required by most YUI components."

11461

},

11462

"overlay": {

11463

"name": "overlay",

11464

"submodules": {},

11465

"classes": {

11466

"Overlay": 1

11467

},

11468

"fors": {},

11469

"namespaces": {},

11470

"tag": "module",

11471

"file": "overlay/js/Overlay.js",

11472

"line": 9,

11473

"description": "Provides a basic Overlay widget, with Standard Module content support. The Overlay widget\nprovides Page XY positioning support, alignment and centering support along with basic \nstackable support (z-index and shimming).",

11474

"extra": {

11475

"selleck": {

11476

"name": "overlay",

11477

"displayName": "Overlay",

11478

"description": "Overlay is a positionable and stackable widget, which also provides support for the standard module format layout, with a header, body and footer section.",

11479

"author": "sdesai",

11480

"tags": [

11481

"overlay",

11482

"widget",

11483

"beta"

11484

],

11485

"use": [

11486

"overlay"

11487

]

11488

}

11489

}

11490

},

11491

"panel": {

11492

"name": "panel",

11493

"submodules": {},

11494

"classes": {

11495

"Panel": 1

11496

},

11497

"fors": {},

11498

"namespaces": {},

11499

"tag": "module",

11500

"file": "panel/js/panel.js",

11501

"line": 14,

11502

"description": "Provides a Panel widget, a widget that mimics the functionality of a regular OS\nwindow. Comes with Standard Module support, XY Positioning, Alignment Support,\nStack (z-index) support, modality, auto-focus and auto-hide functionality, and\nheader/footer button support.",

11503

"extra": {

11504

"selleck": {

11505

"name": "panel",

11506

"displayName": "Panel",

11507

"description": "The Panel is a UI Control that is meant to behave similarly to an OS window. The Panel control extends the functionality of Overlay, adding support for modality, close/dismiss buttons, autohiding and autofocus. Plugins to make it draggable and resizable are supported as well. Panel includes a pre-defined stylesheet to support default look and feel characteristics.",

11508

"author": [

11509

"ericf",

11510

"tilomitra"

11511

],

11512

"tags": [

11513

"widget",

11514

"beta",

11515

"panel",

11516

"extension"

11517

],

11518

"use": [

11519

"panel"

11520

],

11521

"pages": {

11522

"panel-form-example": {

11523

"displayName": "Using a panel to show a modal form",

11524

"layout": "panel-example"

11525

},

11526

"panel-animate-example": {

11527

"displayName": "Creating an animated panel using transitions",

11528

"layout": "panel-example"

11529

}

11530

}

11531

}

11532

}

11533

},

11534

"parallel": {

11535

"name": "parallel",

11536

"submodules": {},

11537

"classes": {

11538

"Parallel": 1

11539

},

11540

"fors": {},

11541

"namespaces": {},

11542

"tag": "main",

11543

"file": "parallel/js/parallel.js",

11544

"line": 8,

11545

"description": "A concurrent parallel processor to help in running several async functions.",

11546

"itemtype": "main"

11547

},

11548

"pjax": {

11549

"name": "pjax",

11550

"submodules": {

11551

"pjax-base": 1,

11552

"pjax-plugin": 1

11553

},

11554

"classes": {

11555

"PjaxBase": 1,

11556

"Plugin.Pjax": 1,

11557

"Pjax": 1

11558

},

11559

"fors": {},

11560

"namespaces": {},

11561

"tag": "module",

11562

"file": "pjax/js/pjax.js",

11563

"line": 12,

11564

"description": "Provides seamless, gracefully degrading Pjax (pushState + Ajax) functionality,\nwhich makes it easy to progressively enhance standard links on the page so that\nthey can be loaded normally in old browsers, or via Ajax (with HTML5 history\nsupport) in newer browsers.",

11565

"itemtype": "main",

11566

"since": "3.5.0",

11567

"extra": {

11568

"selleck": {

11569

"name": "pjax",

11570

"displayName": "Pjax",

11571

"description": "Provides seamless, gracefully degrading pjax (pushState + Ajax) functionality.",

11572

"author": [

11573

"rgrove",

11574

"ericf"

11575

],

11576

"tags": [

11577

"utility",

11578

"beta",

11579

"pjax",

11580

"pushstate",

11581

"ajax",

11582

"history",

11583

"plugin",

11584

"html5"

11585

],

11586

"use": [

11587

"pjax"

11588

]

11589

}

11590

}

11591

},

11592

"pjax-base": {

11593

"name": "pjax-base",

11594

"submodules": {},

11595

"classes": {

11596

"PjaxBase": 1

11597

},

11598

"fors": {},

11599

"is_submodule": 1,

11600

"namespaces": {},

11601

"module": "pjax",

11602

"namespace": "",

11603

"file": "pjax/js/pjax-base.js",

11604

"line": 45,

11605

"description": "`Y.Router` extension that provides the core plumbing for enhanced navigation\nimplemented using the pjax technique (HTML5 pushState + Ajax).",

11606

"since": "3.5.0",

11607

"extra": {

11608

"selleck": {

11609

"name": "pjax",

11610

"displayName": "Pjax",

11611

"description": "Provides seamless, gracefully degrading pjax (pushState + Ajax) functionality.",

11612

"author": [

11613

"rgrove",

11614

"ericf"

11615

],

11616

"tags": [

11617

"utility",

11618

"beta",

11619

"pjax",

11620

"pushstate",

11621

"ajax",

11622

"history",

11623

"plugin",

11624

"html5"

11625

],

11626

"use": [

11627

"pjax"

11628

]

11629

}

11630

}

11631

},

11632

"pjax-plugin": {

11633

"name": "pjax-plugin",

11634

"submodules": {},

11635

"classes": {

11636

"Plugin.Pjax": 1

11637

},

11638

"fors": {},

11639

"is_submodule": 1,

11640

"namespaces": {},

11641

"module": "pjax",

11642

"namespace": "",

11643

"file": "pjax/js/pjax-plugin.js",

11644

"line": 9,

11645

"description": "Node plugin that provides seamless, gracefully degrading pjax functionality.",

11646

"since": "3.5.0",

11647

"extra": {

11648

"selleck": {

11649

"name": "pjax",

11650

"displayName": "Pjax",

11651

"description": "Provides seamless, gracefully degrading pjax (pushState + Ajax) functionality.",

11652

"author": [

11653

"rgrove",

11654

"ericf"

11655

],

11656

"tags": [

11657

"utility",

11658

"beta",

11659

"pjax",

11660

"pushstate",

11661

"ajax",

11662

"history",

11663

"plugin",

11664

"html5"

11665

],

11666

"use": [

11667

"pjax"

11668

]

11669

}

11670

}

11671

},

11672

"plugin": {

11673

"name": "plugin",

11674

"submodules": {},

11675

"classes": {

11676

"Plugin.Base": 1

11677

},

11678

"fors": {},

11679

"namespaces": {},

11680

"tag": "module",

11681

"file": "plugin/js/plugin.js",

11682

"line": 7,

11683

"description": "Provides the base Plugin class, which plugin developers should extend, when creating custom plugins",

11684

"extra": {

11685

"selleck": {

11686

"name": "plugin",

11687

"displayName": "Plugin",

11688

"description": "Plugins allow you to unobtrusively add functionality to objects (referred to as the \"host\" object), generally nodes and widgets.",

11689

"author": "sdesai",

11690

"tags": [

11691

"plugin",

11692

"infrastructure"

11693

],

11694

"use": [

11695

"plugin"

11696

]

11697

}

11698

}

11699

},

11700

"pluginhost": {

11701

"name": "pluginhost",

11702

"submodules": {},

11703

"classes": {},

11704

"fors": {},

11705

"namespaces": {},

11706

"tag": "module",

11707

"file": "pluginhost/js/PluginHost.js",

11708

"line": 1,

11709

"description": "Provides the augmentable PluginHost interface, which can be added to any class."

11710

},

11711

"pluginhost-base": {

11712

"name": "pluginhost-base",

11713

"submodules": {

11714

"pluginhost-config": 1

11715

},

11716

"classes": {

11717

"Plugin.Host": 1

11718

},

11719

"fors": {

11720

"Plugin.Host": 1

11721

},

11722

"namespaces": {},

11723

"tag": "module",

11724

"file": "pluginhost/js/PluginHost.js",

11725

"line": 11,

11726

"description": "Provides the augmentable PluginHost interface, which can be added to any class."

11727

},

11728

"pluginhost-config": {

11729

"name": "pluginhost-config",

11730

"submodules": {},

11731

"classes": {},

11732

"fors": {},

11733

"is_submodule": 1,

11734

"namespaces": {},

11735

"module": "pluginhost-base",

11736

"namespace": "",

11737

"file": "pluginhost/js/PluginHostConfig.js",

11738

"line": 1,

11739

"description": "Adds pluginhost constructor configuration and static configuration support"

11740

},

11741

"profiler": {

11742

"name": "profiler",

11743

"submodules": {},

11744

"classes": {

11745

"Profiler": 1

11746

},

11747

"fors": {},

11748

"namespaces": {},

11749

"tag": "module",

11750

"file": "profiler/js/Profiler.js",

11751

"line": 82,

11752

"description": "The YUI JavaScript profiler.",

11753

"extra": {

11754

"selleck": {

11755

"name": "profiler",

11756

"displayName": "Profiler",

11757

"description": "The YUI Profiler is a simple JavaScript code profiler suitable for reviewing the performance of most JavaScript applications.",

11758

"author": [

11759

"nzakas"

11760

],

11761

"tags": [

11762

"devtool",

11763

"profile",

11764

"performance"

11765

],

11766

"use": [

11767

"profiler"

11768

]

11769

}

11770

}

11771

},

11772

"querystring": {

11773

"name": "querystring",

11774

"submodules": {

11775

"querystring-parse-simple": 1,

11776

"querystring-parse": 1,

11777

"querystring-stringify-simple": 1,

11778

"querystring-stringify": 1

11779

},

11780

"classes": {

11781

"QueryString": 1

11782

},

11783

"fors": {

11784

"QueryString": 1

11785

},

11786

"namespaces": {},

11787

"tag": "main",

11788

"file": "querystring/js/querystring-parse.js",

11789

"line": 20,

11790

"description": "The QueryString module adds support for serializing JavaScript objects into\nquery strings and parsing JavaScript objects from query strings format.\n\nThe QueryString namespace is added to your YUI instance including static methods\n`Y.QueryString.parse(..)` and `Y.QueryString.stringify(..)`.\n\nThe `querystring` module is a alias for `querystring-parse` and\n`querystring-stringify`.\n\nAs their names suggest, `querystring-parse` adds support for parsing\nQuery String data (`Y.QueryString.parse`) and `querystring-stringify` for serializing\nJavaScript data into Query Strings (`Y.QueryString.stringify`). You may choose to\ninclude either of the submodules individually if you don't need the\ncomplementary functionality, or include the rollup for both.",

11791

"itemtype": "main"

11792

},

11793

"querystring-parse-simple": {

11794

"name": "querystring-parse-simple",

11795

"submodules": {},

11796

"classes": {},

11797

"fors": {},

11798

"is_submodule": 1,

11799

"namespaces": {},

11800

"module": "querystring",

11801

"namespace": "",

11802

"file": "querystring/js/querystring-parse-simple.js",

11803

"line": 7,

11804

"description": "Provides Y.QueryString.stringify method for converting objects to Query Strings.\nThis is a simpler implementation than the full querystring-stringify.\nBecause some things may require basic query string escaping functionality,\nthis module provides the bare minimum functionality (decoding a hash of simple values),\nwithout the additional support for arrays, objects, and so on.\nThis provides a friendly way to deserialize basic query strings, without necessitating\na lot of code for simple use-cases.",

11805

"static": 1

11806

},

11807

"querystring-parse": {

11808

"name": "querystring-parse",

11809

"submodules": {},

11810

"classes": {},

11811

"fors": {},

11812

"is_submodule": 1,

11813

"namespaces": {},

11814

"module": "querystring",

11815

"namespace": "",

11816

"file": "querystring/js/querystring-parse-simple.js",

11817

"line": 24,

11818

"description": "Provides Y.QueryString.parse method to accept Query Strings and return native\nJavaScript objects.",

11819

"itemtype": "method",

11820

"params": [

11821

{

11822

"name": "qs",

11823

"description": "Querystring to be parsed into an object.",

11824

"type": "String"

11825

},

11826

{

11827

"name": "sep",

11828

"description": "(optional) Character that should join param k=v pairs together. Default: \"&\"",

11829

"type": "String"

11830

},

11831

{

11832

"name": "eq",

11833

"description": "(optional) Character that should join keys to their values. Default: \"=\"",

11834

"type": "String"

11835

}

11836

],

11837

"access": "public",

11838

"tagname": "",

11839

"static": 1

11840

},

11841

"querystring-stringify-simple": {

11842

"name": "querystring-stringify-simple",

11843

"submodules": {},

11844

"classes": {},

11845

"fors": {},

11846

"is_submodule": 1,

11847

"namespaces": {},

11848

"module": "querystring",

11849

"namespace": "",

11850

"file": "querystring/js/querystring-stringify-simple.js",

11851

"line": 2,

11852

"description": "Provides Y.QueryString.stringify method for converting objects to Query Strings.\nThis is a subset implementation of the full querystring-stringify.\nThis module provides the bare minimum functionality (encoding a hash of simple values),\nwithout the additional support for nested data structures. Every key-value pair is\nencoded by encodeURIComponent.\nThis module provides a minimalistic way for io to handle single-level objects\nas transaction data.",

11853

"static": 1,

11854

"itemtype": "method",

11855

"access": "public",

11856

"tagname": "",

11857

"params": [

11858

{

11859

"name": "obj",

11860

"description": "A single-level object to convert to a querystring.",

11861

"type": "Object"

11862

},

11863

{

11864

"name": "cfg",

11865

"description": "(optional) Configuration object. In the simple\n module, only the arrayKey setting is\n supported. When set to true, the key of an\n array will have the '[]' notation appended\n to the key;.",

11866

"type": "Object"

11867

}

11868

]

11869

},

11870

"querystring-stringify": {

11871

"name": "querystring-stringify",

11872

"submodules": {},

11873

"classes": {

11874

"QueryString": 1

11875

},

11876

"fors": {},

11877

"is_submodule": 1,

11878

"namespaces": {},

11879

"module": "querystring",

11880

"namespace": "",

11881

"file": "querystring/js/querystring-parse.js",

11882

"line": 20,

11883

"description": "Provides Y.QueryString.stringify method for converting objects to Query Strings.",

11884

"static": 1

11885

},

11886

"queue-promote": {

11887

"name": "queue-promote",

11888

"submodules": {},

11889

"classes": {

11890

"Record": 1

11891

},

11892

"fors": {

11893

"Queue": 1

11894

},

11895

"namespaces": {},

11896

"tag": "module",

11897

"file": "recordset/js/record.js",

11898

"line": 1,

11899

"description": "Adds methods promote, remove, and indexOf to Queue instances."

11900

},

11901

"recordset": {

11902

"name": "recordset",

11903

"submodules": {

11904

"recordset-base": 1,

11905

"recordset-filter": 1,

11906

"recordset-indexer": 1,

11907

"recordset-sort": 1

11908

},

11909

"classes": {

11910

"Recordset": 1,

11911

"RecordsetFilter": 1,

11912

"RecordsetIndexer": 1,

11913

"RecordsetSort": 1

11914

},

11915

"fors": {},

11916

"namespaces": {},

11917

"file": "recordset/js/recordset-sort.js",

11918

"line": 10,

11919

"description": "The Recordset utility provides a standard way for dealing with\na collection of similar objects.",

11920

"tag": "main",

11921

"itemtype": "main",

11922

"extra": {

11923

"selleck": {

11924

"name": "recordset",

11925

"displayName": "Recordset",

11926

"description": "The recordset utility allows the storage and retrieval of objects (known as records). It extends the capabilities of the Arraylist module, to allow for filtering, sorting and indexing by hash tables.",

11927

"author": [

11928

"lsmith",

11929

"ericf"

11930

],

11931

"use": [

11932

"recordset"

11933

],

11934

"tags": [

11935

"utility",

11936

"recordset"

11937

]

11938

}

11939

}

11940

},

11941

"recordset-base": {

11942

"name": "recordset-base",

11943

"submodules": {},

11944

"classes": {

11945

"Recordset": 1

11946

},

11947

"fors": {},

11948

"is_submodule": 1,

11949

"namespaces": {},

11950

"module": "recordset",

11951

"namespace": "",

11952

"file": "recordset/js/recordset-base.js",

11953

"line": 13,

11954

"description": "The Recordset utility provides a standard way for dealing with\na collection of similar objects.",

11955

"tag": "main",

11956

"itemtype": "main",

11957

"extra": {

11958

"selleck": {

11959

"name": "recordset",

11960

"displayName": "Recordset",

11961

"description": "The recordset utility allows the storage and retrieval of objects (known as records). It extends the capabilities of the Arraylist module, to allow for filtering, sorting and indexing by hash tables.",

11962

"author": [

11963

"lsmith",

11964

"ericf"

11965

],

11966

"use": [

11967

"recordset"

11968

],

11969

"tags": [

11970

"utility",

11971

"recordset"

11972

]

11973

}

11974

}

11975

},

11976

"recordset-filter": {

11977

"name": "recordset-filter",

11978

"submodules": {},

11979

"classes": {

11980

"RecordsetFilter": 1

11981

},

11982

"fors": {},

11983

"is_submodule": 1,

11984

"namespaces": {},

11985

"module": "recordset",

11986

"namespace": "",

11987

"file": "recordset/js/recordset-filter.js",

11988

"line": 13,

11989

"description": "Plugin that provides the ability to filter through a recordset.\nUses the filter methods available on Y.Array (see arrayextras submodule) to filter the recordset.",

11990

"extra": {

11991

"selleck": {

11992

"name": "recordset",

11993

"displayName": "Recordset",

11994

"description": "The recordset utility allows the storage and retrieval of objects (known as records). It extends the capabilities of the Arraylist module, to allow for filtering, sorting and indexing by hash tables.",

11995

"author": [

11996

"lsmith",

11997

"ericf"

11998

],

11999

"use": [

12000

"recordset"

12001

],

12002

"tags": [

12003

"utility",

12004

"recordset"

12005

]

12006

}

12007

}

12008

},

12009

"recordset-indexer": {

12010

"name": "recordset-indexer",

12011

"submodules": {},

12012

"classes": {

12013

"RecordsetIndexer": 1

12014

},

12015

"fors": {},

12016

"is_submodule": 1,

12017

"namespaces": {},

12018

"module": "recordset",

12019

"namespace": "",

12020

"file": "recordset/js/recordset-indexer.js",

12021

"line": 6,

12022

"description": "Provides the ability to store multiple custom hash tables referencing records in the recordset.",

12023

"extra": {

12024

"selleck": {

12025

"name": "recordset",

12026

"displayName": "Recordset",

12027

"description": "The recordset utility allows the storage and retrieval of objects (known as records). It extends the capabilities of the Arraylist module, to allow for filtering, sorting and indexing by hash tables.",

12028

"author": [

12029

"lsmith",

12030

"ericf"

12031

],

12032

"use": [

12033

"recordset"

12034

],

12035

"tags": [

12036

"utility",

12037

"recordset"

12038

]

12039

}

12040

}

12041

},

12042

"recordset-sort": {

12043

"name": "recordset-sort",

12044

"submodules": {},

12045

"classes": {

12046

"RecordsetSort": 1

12047

},

12048

"fors": {},

12049

"is_submodule": 1,

12050

"namespaces": {},

12051

"module": "recordset",

12052

"namespace": "",

12053

"file": "recordset/js/recordset-sort.js",

12054

"line": 10,

12055

"description": "Adds default and custom sorting functionality to the Recordset utility",

12056

"extra": {

12057

"selleck": {

12058

"name": "recordset",

12059

"displayName": "Recordset",

12060

"description": "The recordset utility allows the storage and retrieval of objects (known as records). It extends the capabilities of the Arraylist module, to allow for filtering, sorting and indexing by hash tables.",

12061

"author": [

12062

"lsmith",

12063

"ericf"

12064

],

12065

"use": [

12066

"recordset"

12067

],

12068

"tags": [

12069

"utility",

12070

"recordset"

12071

]

12072

}

12073

}

12074

},

12075

"resize": {

12076

"name": "resize",

12077

"submodules": {

12078

"resize-contrain": 1,

12079

"resize-plugin": 1,

12080

"resize-proxy": 1

12081

},

12082

"classes": {

12083

"Resize": 1,

12084

"Plugin.ResizeConstrained": 1,

12085

"Plugin.Resize": 1,

12086

"Plugin.ResizeProxy": 1

12087

},

12088

"fors": {},

12089

"namespaces": {

12090

"Plugin": 1

12091

},

12092

"tag": "main",

12093

"file": "resize/js/resize-proxy.js",

12094

"line": 17,

12095

"description": "The Resize Utility allows you to make an HTML element resizable.",

12096

"itemtype": "main",

12097

"extra": {

12098

"selleck": {

12099

"name": "resize",

12100

"displayName": "Resize",

12101

"description": "The Resize Utility allows you to make an HTML element resizable.",

12102

"author": [

12103

"davglass",

12104

"eduardo.lundgren"

12105

],

12106

"tags": [

12107

"utility",

12108

"resize"

12109

],

12110

"use": [

12111

"resize",

12112

"resize-plugin"

12113

]

12114

}

12115

}

12116

},

12117

"resize-contrain": {

12118

"name": "resize-contrain",

12119

"submodules": {},

12120

"classes": {

12121

"Plugin.ResizeConstrained": 1

12122

},

12123

"fors": {},

12124

"is_submodule": 1,

12125

"namespaces": {

12126

"Plugin": 1

12127

},

12128

"module": "resize",

12129

"namespace": "",

12130

"file": "resize/js/resize-constrain.js",

12131

"line": 43,

12132

"description": "A Resize plugin that will attempt to constrain the resize node to the boundaries.",

12133

"params": [

12134

{

12135

"name": "config",

12136

"description": "Object literal specifying widget configuration properties.",

12137

"type": "Object"

12138

}

12139

],

12140

"is_constructor": 1,

12141

"extends": "Plugin.Base",

12142

"extra": {

12143

"selleck": {

12144

"name": "resize",

12145

"displayName": "Resize",

12146

"description": "The Resize Utility allows you to make an HTML element resizable.",

12147

"author": [

12148

"davglass",

12149

"eduardo.lundgren"

12150

],

12151

"tags": [

12152

"utility",

12153

"resize"

12154

],

12155

"use": [

12156

"resize",

12157

"resize-plugin"

12158

]

12159

}

12160

}

12161

},

12162

"resize-plugin": {

12163

"name": "resize-plugin",

12164

"submodules": {},

12165

"classes": {

12166

"Plugin.Resize": 1

12167

},

12168

"fors": {},

12169

"is_submodule": 1,

12170

"namespaces": {},

12171

"module": "resize",

12172

"namespace": "",

12173

"file": "resize/js/resize-plugin.js",

12174

"line": 1,

12175

"description": "The Resize Plugin allows you to make a Node or a Widget resizable. It supports all the functionality of\nthe standalone Resize utility. Additionally, resizing a widget updates the widget's height,width and x,y\nattributes, if they exist.\n\n\n var overlay = new Y.Overlay({\n width: \"200px\",\n srcNode: \"#overlay\",\n visible: false,\n align: {node:\".example\", points:[\"tc\", \"bc\"]}\n });\n overlay.plug(Y.Plugin.Resize);",

12176

"extends": "Resize",

12177

"is_constructor": 1,

12178

"extra": {

12179

"selleck": {

12180

"name": "resize",

12181

"displayName": "Resize",

12182

"description": "The Resize Utility allows you to make an HTML element resizable.",

12183

"author": [

12184

"davglass",

12185

"eduardo.lundgren"

12186

],

12187

"tags": [

12188

"utility",

12189

"resize"

12190

],

12191

"use": [

12192

"resize",

12193

"resize-plugin"

12194

]

12195

}

12196

}

12197

},

12198

"resize-proxy": {

12199

"name": "resize-proxy",

12200

"submodules": {},

12201

"classes": {

12202

"Plugin.ResizeProxy": 1

12203

},

12204

"fors": {},

12205

"is_submodule": 1,

12206

"namespaces": {

12207

"Plugin": 1

12208

},

12209

"module": "resize",

12210

"namespace": "",

12211

"description": "Adds a `proxyNode` attribute and resizes it instead of the actual node. __very similar to DDProxy__\n\n var resize = new Y.Resize({\n //Selector of the node to resize\n node: '#demo'\n });\n resize.plug(Y.Plugin.ResizeProxy);",

12212

"file": "resize/js/resize-proxy.js",

12213

"line": 17

12214

},

12215

"scrollview-base-ie": {

12216

"name": "scrollview-base-ie",

12217

"submodules": {},

12218

"classes": {},

12219

"fors": {

12220

"ScrollView": 1

12221

},

12222

"namespaces": {},

12223

"tag": "module",

12224

"file": "scrollview/js/ScrollViewBaseIE.js",

12225

"line": 1,

12226

"description": "IE specific support for the scrollview-base module.",

12227

"extra": {

12228

"selleck": {

12229

"name": "scrollview",

12230

"displayName": "ScrollView",

12231

"description": "ScrollView provides a scrollable content widget with flick velocity based inertia for both touch and mouse.",

12232

"author": "sdesai",

12233

"tags": [

12234

"scrollview",

12235

"widget",

12236

"beta"

12237

],

12238

"use": [

12239

"scrollview"

12240

],

12241

"pages": {

12242

"scrollview-base-example": {

12243

"displayName": "ScrollView: Basic ScrollView Without a Scroll Indicator",

12244

"layout": "scrollview-vertical-example"

12245

},

12246

"scrollview-example": {

12247

"displayName": "ScrollView: ScrollView with Scroll Indicator and Link Suppression Behavior",

12248

"layout": "scrollview-vertical-example"

12249

},

12250

"scrollview-horiz-example": {

12251

"displayName": "ScrollView: Horizontal ScrollView",

12252

"layout": "scrollview-horizontal-example"

12253

},

12254

"scrollview-paging-example": {

12255

"displayName": "ScrollView: ScrollView with Pagination",

12256

"layout": "scrollview-horizontal-example"

12257

}

12258

}

12259

}

12260

}

12261

},

12262

"scrollview-list": {

12263

"name": "scrollview-list",

12264

"submodules": {},

12265

"classes": {

12266

"Plugin.ScrollViewList": 1

12267

},

12268

"fors": {},

12269

"namespaces": {

12270

"Plugin": 1

12271

},

12272

"tag": "module",

12273

"file": "scrollview/js/list-plugin.js",

12274

"line": 15,

12275

"description": "Provides a plugin, which adds support for a scroll indicator to ScrollView instances",

12276

"extra": {

12277

"selleck": {

12278

"name": "scrollview",

12279

"displayName": "ScrollView",

12280

"description": "ScrollView provides a scrollable content widget with flick velocity based inertia for both touch and mouse.",

12281

"author": "sdesai",

12282

"tags": [

12283

"scrollview",

12284

"widget",

12285

"beta"

12286

],

12287

"use": [

12288

"scrollview"

12289

],

12290

"pages": {

12291

"scrollview-base-example": {

12292

"displayName": "ScrollView: Basic ScrollView Without a Scroll Indicator",

12293

"layout": "scrollview-vertical-example"

12294

},

12295

"scrollview-example": {

12296

"displayName": "ScrollView: ScrollView with Scroll Indicator and Link Suppression Behavior",

12297

"layout": "scrollview-vertical-example"

12298

},

12299

"scrollview-horiz-example": {

12300

"displayName": "ScrollView: Horizontal ScrollView",

12301

"layout": "scrollview-horizontal-example"

12302

},

12303

"scrollview-paging-example": {

12304

"displayName": "ScrollView: ScrollView with Pagination",

12305

"layout": "scrollview-horizontal-example"

12306

}

12307

}

12308

}

12309

}

12310

},

12311

"scrollview-paginator": {

12312

"name": "scrollview-paginator",

12313

"submodules": {},

12314

"classes": {

12315

"Plugin.ScrollViewPaginator": 1

12316

},

12317

"fors": {},

12318

"namespaces": {

12319

"Plugin": 1

12320

},

12321

"tag": "module",

12322

"file": "scrollview/js/paginator-plugin.js",

12323

"line": 17,

12324

"description": "Provides a plugin, which adds pagination support to ScrollView instances",

12325

"extra": {

12326

"selleck": {

12327

"name": "scrollview",

12328

"displayName": "ScrollView",

12329

"description": "ScrollView provides a scrollable content widget with flick velocity based inertia for both touch and mouse.",

12330

"author": "sdesai",

12331

"tags": [

12332

"scrollview",

12333

"widget",

12334

"beta"

12335

],

12336

"use": [

12337

"scrollview"

12338

],

12339

"pages": {

12340

"scrollview-base-example": {

12341

"displayName": "ScrollView: Basic ScrollView Without a Scroll Indicator",

12342

"layout": "scrollview-vertical-example"

12343

},

12344

"scrollview-example": {

12345

"displayName": "ScrollView: ScrollView with Scroll Indicator and Link Suppression Behavior",

12346

"layout": "scrollview-vertical-example"

12347

},

12348

"scrollview-horiz-example": {

12349

"displayName": "ScrollView: Horizontal ScrollView",

12350

"layout": "scrollview-horizontal-example"

12351

},

12352

"scrollview-paging-example": {

12353

"displayName": "ScrollView: ScrollView with Pagination",

12354

"layout": "scrollview-horizontal-example"

12355

}

12356

}

12357

}

12358

}

12359

},

12360

"scrollview-scrollbars": {

12361

"name": "scrollview-scrollbars",

12362

"submodules": {},

12363

"classes": {

12364

"Plugin.ScrollViewScrollbars": 1

12365

},

12366

"fors": {},

12367

"namespaces": {

12368

"Plugin": 1

12369

},

12370

"tag": "module",

12371

"file": "scrollview/js/scrollbars-plugin.js",

12372

"line": 46,

12373

"description": "Provides a plugin, which adds support for a scroll indicator to ScrollView instances",

12374

"extra": {

12375

"selleck": {

12376

"name": "scrollview",

12377

"displayName": "ScrollView",

12378

"description": "ScrollView provides a scrollable content widget with flick velocity based inertia for both touch and mouse.",

12379

"author": "sdesai",

12380

"tags": [

12381

"scrollview",

12382

"widget",

12383

"beta"

12384

],

12385

"use": [

12386

"scrollview"

12387

],

12388

"pages": {

12389

"scrollview-base-example": {

12390

"displayName": "ScrollView: Basic ScrollView Without a Scroll Indicator",

12391

"layout": "scrollview-vertical-example"

12392

},

12393

"scrollview-example": {

12394

"displayName": "ScrollView: ScrollView with Scroll Indicator and Link Suppression Behavior",

12395

"layout": "scrollview-vertical-example"

12396

},

12397

"scrollview-horiz-example": {

12398

"displayName": "ScrollView: Horizontal ScrollView",

12399

"layout": "scrollview-horizontal-example"

12400

},

12401

"scrollview-paging-example": {

12402

"displayName": "ScrollView: ScrollView with Pagination",

12403

"layout": "scrollview-horizontal-example"

12404

}

12405

}

12406

}

12407

}

12408

},

12409

"scrollview-base": {

12410

"name": "scrollview-base",

12411

"submodules": {},

12412

"classes": {

12413

"ScrollView": 1

12414

},

12415

"fors": {},

12416

"namespaces": {},

12417

"tag": "module",

12418

"file": "scrollview/js/scrollview-base.js",

12419

"line": 52,

12420

"description": "The scrollview-base module provides a basic ScrollView Widget, without scrollbar indicators",

12421

"extra": {

12422

"selleck": {

12423

"name": "scrollview",

12424

"displayName": "ScrollView",

12425

"description": "ScrollView provides a scrollable content widget with flick velocity based inertia for both touch and mouse.",

12426

"author": "sdesai",

12427

"tags": [

12428

"scrollview",

12429

"widget",

12430

"beta"

12431

],

12432

"use": [

12433

"scrollview"

12434

],

12435

"pages": {

12436

"scrollview-base-example": {

12437

"displayName": "ScrollView: Basic ScrollView Without a Scroll Indicator",

12438

"layout": "scrollview-vertical-example"

12439

},

12440

"scrollview-example": {

12441

"displayName": "ScrollView: ScrollView with Scroll Indicator and Link Suppression Behavior",

12442

"layout": "scrollview-vertical-example"

12443

},

12444

"scrollview-horiz-example": {

12445

"displayName": "ScrollView: Horizontal ScrollView",

12446

"layout": "scrollview-horizontal-example"

12447

},

12448

"scrollview-paging-example": {

12449

"displayName": "ScrollView: ScrollView with Pagination",

12450

"layout": "scrollview-horizontal-example"

12451

}

12452

}

12453

}

12454

}

12455

},

12456

"scrollview": {

12457

"name": "scrollview",

12458

"submodules": {},

12459

"classes": {},

12460

"fors": {},

12461

"namespaces": {},

12462

"tag": "module",

12463

"file": "scrollview/js/scrollview.js",

12464

"line": 1,

12465

"description": "\nThe scrollview module does not add any new classes. It simply plugs the ScrollViewScrollbars plugin into the \nbase ScrollView class implementation provided by the scrollview-base module, so that all scrollview instances \nhave scrollbars enabled.\n\n\n<ul>\n <li><a href=\"../classes/ScrollView.html\">ScrollView API documentation</a></li>\n <li><a href=\"scrollview-base.html\">scrollview-base Module documentation</a></li>\n</ul>",

12466

"extra": {

12467

"selleck": {

12468

"name": "scrollview",

12469

"displayName": "ScrollView",

12470

"description": "ScrollView provides a scrollable content widget with flick velocity based inertia for both touch and mouse.",

12471

"author": "sdesai",

12472

"tags": [

12473

"scrollview",

12474

"widget",

12475

"beta"

12476

],

12477

"use": [

12478

"scrollview"

12479

],

12480

"pages": {

12481

"scrollview-base-example": {

12482

"displayName": "ScrollView: Basic ScrollView Without a Scroll Indicator",

12483

"layout": "scrollview-vertical-example"

12484

},

12485

"scrollview-example": {

12486

"displayName": "ScrollView: ScrollView with Scroll Indicator and Link Suppression Behavior",

12487

"layout": "scrollview-vertical-example"

12488

},

12489

"scrollview-horiz-example": {

12490

"displayName": "ScrollView: Horizontal ScrollView",

12491

"layout": "scrollview-horizontal-example"

12492

},

12493

"scrollview-paging-example": {

12494

"displayName": "ScrollView: ScrollView with Pagination",

12495

"layout": "scrollview-horizontal-example"

12496

}

12497

}

12498

}

12499

}

12500

},

12501

"slider": {

12502

"name": "slider",

12503

"submodules": {

12504

"clickable-rail": 1,

12505

"range-slider": 1,

12506

"slider-base": 1,

12507

"slider-value-range": 1

12508

},

12509

"classes": {

12510

"ClickableRail": 1,

12511

"Slider": 1,

12512

"SliderBase": 1,

12513

"SliderValueRange": 1

12514

},

12515

"fors": {},

12516

"namespaces": {},

12517

"file": "slider/js/value-range.js",

12518

"line": 19,

12519

"description": "Create a sliding value range input visualized as a draggable thumb on a\nbackground rail element.",

12520

"tag": "main",

12521

"itemtype": "main",

12522

"extra": {

12523

"selleck": {

12524

"name": "slider",

12525

"displayName": "Slider",

12526

"description": "The Slider widget is a UI control that enables the user to adjust values in a finite range along a horizontal or vertical axis.",

12527

"author": "lsmith",

12528

"tags": [

12529

"widget",

12530

"slider"

12531

],

12532

"use": [

12533

"slider"

12534

]

12535

}

12536

}

12537

},

12538

"clickable-rail": {

12539

"name": "clickable-rail",

12540

"submodules": {},

12541

"classes": {

12542

"ClickableRail": 1

12543

},

12544

"fors": {},

12545

"is_submodule": 1,

12546

"namespaces": {},

12547

"module": "slider",

12548

"namespace": "",

12549

"file": "slider/js/clickable-rail.js",

12550

"line": 9,

12551

"description": "Adds support for mouse interaction with the Slider rail triggering thumb\nmovement.",

12552

"extra": {

12553

"selleck": {

12554

"name": "slider",

12555

"displayName": "Slider",

12556

"description": "The Slider widget is a UI control that enables the user to adjust values in a finite range along a horizontal or vertical axis.",

12557

"author": "lsmith",

12558

"tags": [

12559

"widget",

12560

"slider"

12561

],

12562

"use": [

12563

"slider"

12564

]

12565

}

12566

}

12567

},

12568

"range-slider": {

12569

"name": "range-slider",

12570

"submodules": {},

12571

"classes": {

12572

"Slider": 1

12573

},

12574

"fors": {},

12575

"is_submodule": 1,

12576

"namespaces": {},

12577

"module": "slider",

12578

"namespace": "",

12579

"file": "slider/js/range-slider.js",

12580

"line": 10,

12581

"description": "Create a sliding value range input visualized as a draggable thumb on a\nbackground rail element.",

12582

"tag": "main",

12583

"itemtype": "main",

12584

"extra": {

12585

"selleck": {

12586

"name": "slider",

12587

"displayName": "Slider",

12588

"description": "The Slider widget is a UI control that enables the user to adjust values in a finite range along a horizontal or vertical axis.",

12589

"author": "lsmith",

12590

"tags": [

12591

"widget",

12592

"slider"

12593

],

12594

"use": [

12595

"slider"

12596

]

12597

}

12598

}

12599

},

12600

"slider-base": {

12601

"name": "slider-base",

12602

"submodules": {},

12603

"classes": {

12604

"SliderBase": 1

12605

},

12606

"fors": {},

12607

"is_submodule": 1,

12608

"namespaces": {},

12609

"module": "slider",

12610

"namespace": "",

12611

"file": "slider/js/slider-base.js",

12612

"line": 11,

12613

"description": "Create a sliding value range input visualized as a draggable thumb on a\nbackground element.",

12614

"extra": {

12615

"selleck": {

12616

"name": "slider",

12617

"displayName": "Slider",

12618

"description": "The Slider widget is a UI control that enables the user to adjust values in a finite range along a horizontal or vertical axis.",

12619

"author": "lsmith",

12620

"tags": [

12621

"widget",

12622

"slider"

12623

],

12624

"use": [

12625

"slider"

12626

]

12627

}

12628

}

12629

},

12630

"slider-value-range": {

12631

"name": "slider-value-range",

12632

"submodules": {},

12633

"classes": {

12634

"SliderValueRange": 1

12635

},

12636

"fors": {},

12637

"is_submodule": 1,

12638

"namespaces": {},

12639

"module": "slider",

12640

"namespace": "",

12641

"file": "slider/js/value-range.js",

12642

"line": 19,

12643

"description": "Adds value support for Slider as a range of integers between a configured\nminimum and maximum value. For use with <code>Y.Base.build(..)</code> to\nadd the plumbing to <code>Y.SliderBase</code>.",

12644

"extra": {

12645

"selleck": {

12646

"name": "slider",

12647

"displayName": "Slider",

12648

"description": "The Slider widget is a UI control that enables the user to adjust values in a finite range along a horizontal or vertical axis.",

12649

"author": "lsmith",

12650

"tags": [

12651

"widget",

12652

"slider"

12653

],

12654

"use": [

12655

"slider"

12656

]

12657

}

12658

}

12659

},

12660

"sortable": {

12661

"name": "sortable",

12662

"submodules": {

12663

"sortable-scroll": 1

12664

},

12665

"classes": {

12666

"Plugin.SortScroll": 1,

12667

"Sortable": 1

12668

},

12669

"fors": {},

12670

"namespaces": {

12671

"Plugin": 1

12672

},

12673

"tag": "module",

12674

"file": "sortable/js/sortable.js",

12675

"line": 6,

12676

"description": "The class allows you to create a Drag & Drop reordered list.",

12677

"extra": {

12678

"selleck": {

12679

"name": "sortable",

12680

"displayName": "Sortable",

12681

"description": "The Sortable utility provides support for the creation of a sortable list as well as the ability to join lists in various ways.",

12682

"author": "davglass",

12683

"tags": [

12684

"utility",

12685

"beta",

12686

"sort",

12687

"lists"

12688

],

12689

"use": [

12690

"sortable"

12691

]

12692

}

12693

}

12694

},

12695

"sortable-scroll": {

12696

"name": "sortable-scroll",

12697

"submodules": {},

12698

"classes": {

12699

"Plugin.SortScroll": 1

12700

},

12701

"fors": {},

12702

"is_submodule": 1,

12703

"namespaces": {

12704

"Plugin": 1

12705

},

12706

"module": "sortable",

12707

"namespace": "",

12708

"file": "sortable/js/sortable-scroll.js",

12709

"line": 7,

12710

"description": "Plugin for sortable to handle scrolling lists.",

12711

"extra": {

12712

"selleck": {

12713

"name": "sortable",

12714

"displayName": "Sortable",

12715

"description": "The Sortable utility provides support for the creation of a sortable list as well as the ability to join lists in various ways.",

12716

"author": "davglass",

12717

"tags": [

12718

"utility",

12719

"beta",

12720

"sort",

12721

"lists"

12722

],

12723

"use": [

12724

"sortable"

12725

]

12726

}

12727

}

12728

},

12729

"stylesheet": {

12730

"name": "stylesheet",

12731

"submodules": {},

12732

"classes": {

12733

"StyleSheet": 1

12734

},

12735

"fors": {},

12736

"namespaces": {},

12737

"tag": "module",

12738

"file": "stylesheet/js/stylesheet.js",

12739

"line": 69,

12740

"description": "The StyleSheet component is a module for creating and modifying CSS\nstylesheets.",

12741

"extra": {

12742

"selleck": {

12743

"name": "stylesheet",

12744

"displayName": "StyleSheet",

12745

"description": "StyleSheet addresses the need to apply style or style changes to multiple elements without incurring the cost of a page reflow for each element.",

12746

"author": "lsmith",

12747

"tags": [

12748

"utility",

12749

"stylesheet"

12750

],

12751

"use": [

12752

"stylesheet"

12753

],

12754

"pages": {

12755

"stylesheet-theme-example": {

12756

"displayName": "Adjusting a Page Theme on the Fly",

12757

"layout": "stylesheet-example"

12758

}

12759

}

12760

}

12761

}

12762

},

12763

"substitute": {

12764

"name": "substitute",

12765

"submodules": {},

12766

"classes": {

12767

"YUI~substitute": 1

12768

},

12769

"fors": {},

12770

"namespaces": {},

12771

"tag": "module",

12772

"file": "substitute/js/substitute.js",

12773

"line": 11,

12774

"description": "String variable substitution and string formatting.\nIf included, the substitute method is added to the YUI instance."

12775

},

12776

"swf": {

12777

"name": "swf",

12778

"submodules": {},

12779

"classes": {

12780

"SWF": 1

12781

},

12782

"fors": {},

12783

"namespaces": {},

12784

"tag": "module",

12785

"file": "swf/js/swf.js",

12786

"line": 29,

12787

"description": "Embed a Flash applications in a standard manner and communicate with it\nvia External Interface.",

12788

"title": "SWF Utility",

12789

"requires": [

12790

"event-custom",

12791

"node",

12792

"swfdetect"

12793

],

12794

"extra": {

12795

"selleck": {

12796

"name": "swf",

12797

"displayName": "SWF Utility",

12798

"description": "Provides a standardized method for embedding Adobe Flash player in web pages",

12799

"author": "allenrabinovich",

12800

"tags": [

12801

"utility",

12802

"swf"

12803

],

12804

"use": [

12805

"swf"

12806

]

12807

}

12808

}

12809

},

12810

"swfdetect": {

12811

"name": "swfdetect",

12812

"submodules": {},

12813

"classes": {

12814

"SWFDetect": 1,

12815

"Tab": 1

12816

},

12817

"fors": {},

12818

"namespaces": {},

12819

"tag": "module",

12820

"file": "tabview/js/tab.js",

12821

"line": 6,

12822

"description": "Utility for Flash version detection"

12823

},

12824

"tabview": {

12825

"name": "tabview",

12826

"submodules": {},

12827

"classes": {

12828

"TabView": 1

12829

},

12830

"fors": {},

12831

"namespaces": {},

12832

"tag": "module",

12833

"file": "tabview/js/tabview.js",

12834

"line": 12,

12835

"description": "The TabView module",

12836

"extra": {

12837

"selleck": {

12838

"name": "tabview",

12839

"displayName": "TabView",

12840

"description": "The TabView widget is a UI control that enables the user to switch between content panels.",

12841

"author": "msweeney",

12842

"tags": [

12843

"widget",

12844

"tabview"

12845

],

12846

"use": [

12847

"tabview"

12848

]

12849

}

12850

}

12851

},

12852

"test-console": {

12853

"name": "test-console",

12854

"submodules": {},

12855

"classes": {

12856

"Test.Console": 1

12857

},

12858

"fors": {},

12859

"namespaces": {

12860

"Test": 1

12861

},

12862

"tag": "module",

12863

"file": "test-console/js/test-console.js",

12864

"line": 1,

12865

"description": "Provides a specialized log console widget that's pre-configured to display YUI\nTest output with no extra configuration.",

12866

"example": [

12867

"\n\n <div id=\"log\" class=\"yui3-skin-sam\"></div>\n\n <script>\n YUI().use('test-console', function (Y) {\n // ... set up your test cases here ...\n\n // Render the console inside the #log div, then run the tests.\n new Y.Test.Console().render('#log');\n Y.Test.Runner.run();\n });\n </script>"

12868

],

12869

"extends": "Console",

12870

"is_constructor": 1,

12871

"params": [

12872

{

12873

"name": "config",

12874

"description": "Config attributes.",

12875

"type": "Object",

12876

"optional": true,

12877

"props": [

12878

{

12879

"name": "filters",

12880

"description": "Category filter configuration.",

12881

"type": "Object",

12882

"optional": true

12883

}

12884

]

12885

}

12886

],

12887

"since": "3.5.0",

12888

"extra": {

12889

"selleck": {

12890

"name": "test-console",

12891

"displayName": "Test Console",

12892

"description": "An attractive pre-packaged console widget for displaying YUI Test output.",

12893

"author": [

12894

"rgrove"

12895

],

12896

"tags": [

12897

"devtool",

12898

"test",

12899

"yuitest",

12900

"console"

12901

],

12902

"use": [

12903

"test-console"

12904

]

12905

}

12906

}

12907

},

12908

"test": {

12909

"name": "test",

12910

"submodules": {},

12911

"classes": {

12912

"Test.ArrayAssert": 1,

12913

"Test.Assert": 1,

12914

"Test.AssertionError": 1,

12915

"Test.ComparisonFailure": 1,

12916

"Test.CoverageFormat": 1,

12917

"Test.DateAssert": 1,

12918

"Test.EventTarget": 1,

12919

"Test.Mock": 1,

12920

"Test.Mock.Value": 1,

12921

"Test.ObjectAssert": 1,

12922

"Test.Reporter": 1,

12923

"Test.Results": 1,

12924

"Test.ShouldError": 1,

12925

"Test.ShouldFail": 1,

12926

"Test.TestCase": 1,

12927

"Test.TestFormat": 1,

12928

"Test.TestRunner": 1,

12929

"Test.TestNode": 1,

12930

"Test.Runner": 1,

12931

"Test.TestSuite": 1,

12932

"Test.UnexpectedError": 1,

12933

"Test.UnexpectedValue": 1,

12934

"Test.Wait": 1

12935

},

12936

"fors": {

12937

"YUI": 1

12938

},

12939

"namespaces": {

12940

"Test": 1,

12941

"Test.CoverageFormat": 1,

12942

"Test.Mock": 1

12943

},

12944

"tag": "main",

12945

"file": "test/js/Wait.js",

12946

"line": 2,

12947

"description": "YUI Test Framework",

12948

"static": 1,

12949

"params": [

12950

{

12951

"name": "message",

12952

"description": "The message to display when the error occurs.",

12953

"type": "String"

12954

}

12955

],

12956

"is_constructor": 1,

12957

"extends": "AssertionError",

12958

"access": "private",

12959

"tagname": "",

12960

"itemtype": "main",

12961

"extra": {

12962

"selleck": {

12963

"name": "test",

12964

"displayName": "Test",

12965

"description": "A JavaScript testing framework with a comprehensive assertion syntax. Suitable for testing YUI-based code, but designed to support test-driven development across any JavaScript project, regardless of whether YUI is involved.",

12966

"author": [

12967

"nzakas"

12968

],

12969

"tags": [

12970

"devtool",

12971

"test",

12972

"testing",

12973

"unit",

12974

"tdd"

12975

],

12976

"use": [

12977

"test"

12978

]

12979

}

12980

}

12981

},

12982

"text": {

12983

"name": "text",

12984

"submodules": {

12985

"text-accentfold": 1,

12986

"text-wordbreak": 1

12987

},

12988

"classes": {

12989

"Text.AccentFold": 1,

12990

"Text.WordBreak": 1

12991

},

12992

"fors": {},

12993

"namespaces": {},

12994

"tag": "module",

12995

"file": "text/js/text-wordbreak.js",

12996

"line": 9,

12997

"description": "Text utilities.",

12998

"since": "3.3.0"

12999

},

13000

"text-accentfold": {

13001

"name": "text-accentfold",

13002

"submodules": {},

13003

"classes": {

13004

"Text.AccentFold": 1

13005

},

13006

"fors": {},

13007

"is_submodule": 1,

13008

"namespaces": {},

13009

"module": "text",

13010

"namespace": "",

13011

"file": "text/js/text-accentfold.js",

13012

"line": 16,

13013

"description": "Provides a basic accent folding implementation that converts common accented\nletters (like \"á\") to their non-accented forms (like \"a\")."

13014

},

13015

"text-wordbreak": {

13016

"name": "text-wordbreak",

13017

"submodules": {},

13018

"classes": {

13019

"Text.WordBreak": 1

13020

},

13021

"fors": {},

13022

"is_submodule": 1,

13023

"namespaces": {},

13024

"module": "text",

13025

"namespace": "",

13026

"file": "text/js/text-wordbreak.js",

13027

"line": 9,

13028

"description": "Provides utility methods for splitting strings on word breaks and determining\nwhether a character index represents a word boundary."

13029

},

13030

"transition": {

13031

"name": "transition",

13032

"submodules": {},

13033

"classes": {

13034

"Transition": 1

13035

},

13036

"fors": {

13037

"Node": 1,

13038

"NodeList": 1

13039

},

13040

"namespaces": {},

13041

"tag": "module",

13042

"file": "transition/js/transition-native.js",

13043

"line": 35,

13044

"description": "Provides the transition method for Node.\nTransition has no API of its own, but adds the transition method to Node.",

13045

"requires": [

13046

"node-style"

13047

],

13048

"extra": {

13049

"selleck": {

13050

"name": "transition",

13051

"displayName": "Transition",

13052

"description": "Transition adds the ability to animate Node style properties. It is modeled after the CSS Transition specification, and leverages native CSS Transition implementations when possible.",

13053

"author": "msweeney",

13054

"tags": [

13055

"utility",

13056

"transition",

13057

"beta"

13058

],

13059

"use": [

13060

"transition"

13061

]

13062

}

13063

}

13064

},

13065

"uploader-deprecated": {

13066

"name": "uploader-deprecated",

13067

"submodules": {},

13068

"classes": {},

13069

"fors": {},

13070

"namespaces": {},

13071

"tag": "module",

13072

"file": "uploader-deprecated/js/uploader-deprecated.js",

13073

"line": 1,

13074

"description": "Attention: this is the 3.4.1 `uploader` module has been deprecated in favor of a new \nuploader with an HTML5 layer. Please refer to the new Uploader User Guide for migration \ninformation.\n\nThis module uses Flash player transport to upload files to the server, with support for \nfile filtering, multiple file uploads and progress monitoring.",

13075

"deprecated": true,

13076

"extra": {

13077

"selleck": {

13078

"name": "uploader-deprecated",

13079

"displayName": "Uploader (deprecated version)",

13080

"description": "Provides file-upload functionality that goes beyond the native browser-based methods (multiple file upload, progress tracking, etc.)",

13081

"author": "allenrabinovich",

13082

"tags": [

13083

"utility",

13084

"beta",

13085

"uploader"

13086

],

13087

"use": [

13088

"uploader-deprecated"

13089

]

13090

}

13091

}

13092

},

13093

"uploader-flash": {

13094

"name": "uploader-flash",

13095

"submodules": {},

13096

"classes": {

13097

"UploaderFlash": 1

13098

},

13099

"fors": {},

13100

"namespaces": {},

13101

"tag": "module",

13102

"file": "uploader/js/uploader-flash.js",

13103

"line": 19,

13104

"description": "This module provides a UI for file selection and multiple file upload capability using\nFlash as a transport engine.\nThe supported features include: automatic upload queue management, upload progress\ntracking, file filtering, server response retrieval and error reporting.",

13105

"extra": {

13106

"selleck": {

13107

"name": "uploader",

13108

"displayName": "Uploader",

13109

"description": "Provides file-upload functionality that goes beyond the native browser-based methods (multiple file upload, progress tracking, etc.)",

13110

"author": "allenrabinovich",

13111

"tags": [

13112

"utility",

13113

"beta",

13114

"uploader"

13115

],

13116

"use": [

13117

"uploader"

13118

]

13119

}

13120

}

13121

},

13122

"uploader-html5": {

13123

"name": "uploader-html5",

13124

"submodules": {},

13125

"classes": {

13126

"UploaderHTML5": 1

13127

},

13128

"fors": {},

13129

"namespaces": {},

13130

"tag": "module",

13131

"file": "uploader/js/uploader-html5.js",

13132

"line": 15,

13133

"description": "This module provides a UI for file selection and multiple file upload capability using\nHTML5 XMLHTTPRequest Level 2 as a transport engine.\nThe supported features include: automatic upload queue management, upload progress\ntracking, drag-and-drop support, server response retrieval and error reporting.",

13134

"extra": {

13135

"selleck": {

13136

"name": "uploader",

13137

"displayName": "Uploader",

13138

"description": "Provides file-upload functionality that goes beyond the native browser-based methods (multiple file upload, progress tracking, etc.)",

13139

"author": "allenrabinovich",

13140

"tags": [

13141

"utility",

13142

"beta",

13143

"uploader"

13144

],

13145

"use": [

13146

"uploader"

13147

]

13148

}

13149

}

13150

},

13151

"uploader-queue": {

13152

"name": "uploader-queue",

13153

"submodules": {},

13154

"classes": {

13155

"Uploader.Queue": 1

13156

},

13157

"fors": {},

13158

"namespaces": {},

13159

"tag": "module",

13160

"file": "uploader/js/uploader-queue.js",

13161

"line": 19,

13162

"description": "The class manages a queue of files that should be uploaded to the server.\nIt initializes the required number of uploads, tracks them as they progress,\nand automatically advances to the next upload when a preceding one has completed.",

13163

"extra": {

13164

"selleck": {

13165

"name": "uploader",

13166

"displayName": "Uploader",

13167

"description": "Provides file-upload functionality that goes beyond the native browser-based methods (multiple file upload, progress tracking, etc.)",

13168

"author": "allenrabinovich",

13169

"tags": [

13170

"utility",

13171

"beta",

13172

"uploader"

13173

],

13174

"use": [

13175

"uploader"

13176

]

13177

}

13178

}

13179

},

13180

"uploader": {

13181

"name": "uploader",

13182

"submodules": {},

13183

"classes": {

13184

"Uploader": 1

13185

},

13186

"fors": {},

13187

"namespaces": {},

13188

"tag": "main",

13189

"file": "uploader/js/uploader.js",

13190

"line": 11,

13191

"description": "Provides UI for selecting multiple files and functionality for \nuploading multiple files to the server with support for either\nhtml5 or Flash transport mechanisms, automatic queue management,\nupload progress monitoring, and error events.",

13192

"itemtype": "main",

13193

"extra": {

13194

"selleck": {

13195

"name": "uploader",

13196

"displayName": "Uploader",

13197

"description": "Provides file-upload functionality that goes beyond the native browser-based methods (multiple file upload, progress tracking, etc.)",

13198

"author": "allenrabinovich",

13199

"tags": [

13200

"utility",

13201

"beta",

13202

"uploader"

13203

],

13204

"use": [

13205

"uploader"

13206

]

13207

}

13208

}

13209

},

13210

"widget-anim": {

13211

"name": "widget-anim",

13212

"submodules": {},

13213

"classes": {

13214

"Plugin.WidgetAnim": 1

13215

},

13216

"fors": {},

13217

"namespaces": {

13218

"Plugin": 1

13219

},

13220

"tag": "module",

13221

"file": "widget-anim/js/WidgetAnim.js",

13222

"line": 29,

13223

"description": "Provides a plugin which can be used to animate widget visibility changes."

13224

},

13225

"widget-autohide": {

13226

"name": "widget-autohide",

13227

"submodules": {},

13228

"classes": {

13229

"WidgetAutohide": 1

13230

},

13231

"fors": {},

13232

"namespaces": {},

13233

"tag": "module",

13234

"file": "widget-autohide/js/Widget-Autohide.js",

13235

"line": 27,

13236

"description": "A widget-level extension that provides ability to hide widget when\ncertain events occur.",

13237

"author": "eferraiuolo, tilomitra",

13238

"since": "3.4.0"

13239

},

13240

"widget-buttons": {

13241

"name": "widget-buttons",

13242

"submodules": {},

13243

"classes": {

13244

"WidgetButtons": 1

13245

},

13246

"fors": {},

13247

"namespaces": {},

13248

"tag": "module",

13249

"file": "widget-buttons/js/widget-buttons.js",

13250

"line": 29,

13251

"description": "Provides header/body/footer button support for Widgets that use the\n`WidgetStdMod` extension.",

13252

"since": "3.4.0"

13253

},

13254

"widget-child": {

13255

"name": "widget-child",

13256

"submodules": {},

13257

"classes": {

13258

"WidgetChild": 1

13259

},

13260

"fors": {

13261

"Widget": 1

13262

},

13263

"namespaces": {},

13264

"tag": "module",

13265

"file": "widget-child/js/Widget-Child.js",

13266

"line": 9,

13267

"description": "Extension enabling a Widget to be a child of another Widget."

13268

},

13269

"widget-modality": {

13270

"name": "widget-modality",

13271

"submodules": {},

13272

"classes": {

13273

"WidgetModality": 1

13274

},

13275

"fors": {},

13276

"namespaces": {},

13277

"tag": "module",

13278

"file": "widget-modality/js/Widget-Modality.js",

13279

"line": 48,

13280

"description": "Provides modality support for Widgets, though an extension"

13281

},

13282

"widget-parent": {

13283

"name": "widget-parent",

13284

"submodules": {},

13285

"classes": {

13286

"WidgetParent": 1

13287

},

13288

"fors": {},

13289

"namespaces": {},

13290

"tag": "module",

13291

"file": "widget-parent/js/Widget-Parent.js",

13292

"line": 11,

13293

"description": "Extension enabling a Widget to be a parent of another Widget."

13294

},

13295

"widget-position-align": {

13296

"name": "widget-position-align",

13297

"submodules": {},

13298

"classes": {

13299

"WidgetPositionAlign": 1

13300

},

13301

"fors": {},

13302

"namespaces": {},

13303

"tag": "module",

13304

"file": "widget-position-align/js/Widget-PositionAlign.js",

13305

"line": 24,

13306

"description": "Provides extended/advanced XY positioning support for Widgets, through an\nextension.\n\nIt builds on top of the `widget-position` module, to provide alignment and\ncentering support. Future releases aim to add constrained and fixed positioning\nsupport."

13307

},

13308

"widget-position-constrain": {

13309

"name": "widget-position-constrain",

13310

"submodules": {},

13311

"classes": {

13312

"WidgetPositionConstrain": 1

13313

},

13314

"fors": {},

13315

"namespaces": {},

13316

"tag": "module",

13317

"file": "widget-position-constrain/js/Widget-PositionConstrain.js",

13318

"line": 30,

13319

"description": "Provides constrained xy positioning support for Widgets, through an extension.\n\nIt builds on top of the widget-position module, to provide constrained positioning support."

13320

},

13321

"widget-position": {

13322

"name": "widget-position",

13323

"submodules": {},

13324

"classes": {

13325

"WidgetPosition": 1

13326

},

13327

"fors": {},

13328

"namespaces": {},

13329

"tag": "module",

13330

"file": "widget-position/js/Widget-Position.js",

13331

"line": 24,

13332

"description": "Provides basic XY positioning support for Widgets, though an extension"

13333

},

13334

"widget-stack": {

13335

"name": "widget-stack",

13336

"submodules": {},

13337

"classes": {

13338

"WidgetStack": 1

13339

},

13340

"fors": {},

13341

"namespaces": {},

13342

"tag": "module",

13343

"file": "widget-stack/js/Widget-Stack.js",

13344

"line": 46,

13345

"description": "Provides stackable (z-index) support for Widgets through an extension."

13346

},

13347

"widget-stdmod": {

13348

"name": "widget-stdmod",

13349

"submodules": {},

13350

"classes": {

13351

"WidgetStdMod": 1

13352

},

13353

"fors": {},

13354

"namespaces": {},

13355

"tag": "module",

13356

"file": "widget-stdmod/js/Widget-StdMod.js",

13357

"line": 49,

13358

"description": "Provides standard module support for Widgets through an extension."

13359

},

13360

"widget": {

13361

"name": "widget",

13362

"submodules": {

13363

"widget-base": 1,

13364

"widget-htmlparser": 1,

13365

"widget-skin": 1,

13366

"widget-uievents": 1

13367

},

13368

"classes": {

13369

"Widget": 1

13370

},

13371

"fors": {

13372

"Widget": 1

13373

},

13374

"namespaces": {},

13375

"tag": "main",

13376

"file": "widget/js/Widget.js",

13377

"line": 68,

13378

"description": "Provides the base Widget class, with HTML Parser support",

13379

"itemtype": "main",

13380

"extra": {

13381

"selleck": {

13382

"name": "widget",

13383

"displayName": "Widget",

13384

"description": "Widget is the foundation class from which all YUI 3 widgets are derived.",

13385

"author": "sdesai",

13386

"tags": [

13387

"infrastructure"

13388

],

13389

"use": [

13390

"widget"

13391

]

13392

}

13393

}

13394

},

13395

"widget-base": {

13396

"name": "widget-base",

13397

"submodules": {},

13398

"classes": {

13399

"Widget": 1

13400

},

13401

"fors": {},

13402

"is_submodule": 1,

13403

"namespaces": {},

13404

"module": "widget",

13405

"namespace": "",

13406

"file": "widget/js/Widget.js",

13407

"line": 68,

13408

"description": "Provides the base Widget class",

13409

"extra": {

13410

"selleck": {

13411

"name": "widget",

13412

"displayName": "Widget",

13413

"description": "Widget is the foundation class from which all YUI 3 widgets are derived.",

13414

"author": "sdesai",

13415

"tags": [

13416

"infrastructure"

13417

],

13418

"use": [

13419

"widget"

13420

]

13421

}

13422

}

13423

},

13424

"widget-base-ie": {

13425

"name": "widget-base-ie",

13426

"submodules": {},

13427

"classes": {},

13428

"fors": {},

13429

"namespaces": {},

13430

"tag": "module",

13431

"file": "widget/js/WidgetBaseIE.js",

13432

"line": 1,

13433

"description": "IE specific support for the widget-base module.",

13434

"extra": {

13435

"selleck": {

13436

"name": "widget",

13437

"displayName": "Widget",

13438

"description": "Widget is the foundation class from which all YUI 3 widgets are derived.",

13439

"author": "sdesai",

13440

"tags": [

13441

"infrastructure"

13442

],

13443

"use": [

13444

"widget"

13445

]

13446

}

13447

}

13448

},

13449

"widget-htmlparser": {

13450

"name": "widget-htmlparser",

13451

"submodules": {},

13452

"classes": {},

13453

"fors": {},

13454

"is_submodule": 1,

13455

"namespaces": {},

13456

"module": "widget",

13457

"namespace": "",

13458

"file": "widget/js/WidgetHTMLParser.js",

13459

"line": 1,

13460

"description": "Adds HTML Parser support to the base Widget class",

13461

"extra": {

13462

"selleck": {

13463

"name": "widget",

13464

"displayName": "Widget",

13465

"description": "Widget is the foundation class from which all YUI 3 widgets are derived.",

13466

"author": "sdesai",

13467

"tags": [

13468

"infrastructure"

13469

],

13470

"use": [

13471

"widget"

13472

]

13473

}

13474

}

13475

},

13476

"widget-locale": {

13477

"name": "widget-locale",

13478

"submodules": {},

13479

"classes": {},

13480

"fors": {},

13481

"namespaces": {},

13482

"tag": "module",

13483

"file": "widget/js/WidgetLocale.js",

13484

"line": 1,

13485

"description": "Provides string support for widget with BCP 47 language tag lookup. This module has been deprecated. It's replaced by the \"intl\" module which provides generic internationalization and BCP 47 language tag support with externalization.",

13486

"deprecated": true,

13487

"deprecationMessage": "This module has been deprecated. It's replaced by the \"intl\" module which provides generic internationalization and BCP 47 language tag support with externalization.",

13488

"extra": {

13489

"selleck": {

13490

"name": "widget",

13491

"displayName": "Widget",

13492

"description": "Widget is the foundation class from which all YUI 3 widgets are derived.",

13493

"author": "sdesai",

13494

"tags": [

13495

"infrastructure"

13496

],

13497

"use": [

13498

"widget"

13499

]

13500

}

13501

}

13502

},

13503

"widget-skin": {

13504

"name": "widget-skin",

13505

"submodules": {},

13506

"classes": {},

13507

"fors": {},

13508

"is_submodule": 1,

13509

"namespaces": {},

13510

"module": "widget",

13511

"namespace": "",

13512

"file": "widget/js/WidgetSkin.js",

13513

"line": 1,

13514

"description": "Provides skin related utlility methods.",

13515

"extra": {

13516

"selleck": {

13517

"name": "widget",

13518

"displayName": "Widget",

13519

"description": "Widget is the foundation class from which all YUI 3 widgets are derived.",

13520

"author": "sdesai",

13521

"tags": [

13522

"infrastructure"

13523

],

13524

"use": [

13525

"widget"

13526

]

13527

}

13528

}

13529

},

13530

"widget-uievents": {

13531

"name": "widget-uievents",

13532

"submodules": {},

13533

"classes": {},

13534

"fors": {},

13535

"is_submodule": 1,

13536

"namespaces": {},

13537

"module": "widget",

13538

"namespace": "",

13539

"file": "widget/js/WidgetUIEvents.js",

13540

"line": 1,

13541

"description": "Support for Widget UI Events (Custom Events fired by the widget, which wrap the underlying DOM events - e.g. widget:click, widget:mousedown)",

13542

"extra": {

13543

"selleck": {

13544

"name": "widget",

13545

"displayName": "Widget",

13546

"description": "Widget is the foundation class from which all YUI 3 widgets are derived.",

13547

"author": "sdesai",

13548

"tags": [

13549

"infrastructure"

13550

],

13551

"use": [

13552

"widget"

13553

]

13554

}

13555

}

13556

},

13557

"yql": {

13558

"name": "yql",

13559

"submodules": {},

13560

"classes": {

13561

"YQLRequest": 1,

13562

"YQL": 1

13563

},

13564

"fors": {},

13565

"namespaces": {},

13566

"tag": "module",

13567

"file": "yql/js/yql.js",

13568

"line": 122,

13569

"description": "This class adds a sugar class to allow access to YQL (http://developer.yahoo.com/yql/).",

13570

"extra": {

13571

"selleck": {

13572

"name": "yql",

13573

"displayName": "YQL Query",

13574

"description": "YQL provides developers the ablity to access and shape data across the Internet using one language rather than learn multiple APIs.",

13575

"author": "davglass",

13576

"tags": [

13577

"utility",

13578

"data",

13579

"api",

13580

"json",

13581

"webservice"

13582

],

13583

"use": [

13584

"yql"

13585

]

13586

}

13587

}

13588

},

13589

"yui": {

13590

"name": "yui",

13591

"submodules": {

13592

"yui-throttle": 1,

13593

"yui-base": 1,

13594

"yui-later": 1,

13595

"yui-log": 1

13596

},

13597

"classes": {

13598

"Array": 1,

13599

"YUI": 1,

13600

"config": 1,

13601

"Queue": 1,

13602

"Lang": 1,

13603

"Object": 1,

13604

"UA": 1

13605

},

13606

"fors": {

13607

"YUI": 1

13608

},

13609

"namespaces": {},

13610

"file": "yui/js/yui-ua.js",

13611

"line": 9

13612

},

13613

"yui-throttle": {

13614

"name": "yui-throttle",

13615

"submodules": {},

13616

"classes": {},

13617

"fors": {},

13618

"is_submodule": 1,

13619

"namespaces": {},

13620

"module": "yui",

13621

"namespace": "",

13622

"file": "yui-throttle/js/throttle.js",

13623

"line": 1,

13624

"description": "Throttles a call to a method based on the time between calls. This method is attached\nto the `Y` object and is <a href=\"../classes/YUI.html#method_throttle\">documented there</a>.\n\n var fn = Y.throttle(function() {\n counter++;\n });\n\n for (i; i< 35000; i++) {\n out++;\n fn();\n }"

13625

},

13626

"yui-base": {

13627

"name": "yui-base",

13628

"submodules": {},

13629

"classes": {

13630

"Array": 1,

13631

"YUI": 1,

13632

"config": 1,

13633

"Queue": 1,

13634

"Lang": 1,

13635

"Object": 1,

13636

"UA": 1

13637

},

13638

"fors": {},

13639

"is_submodule": 1,

13640

"namespaces": {},

13641

"module": "yui",

13642

"namespace": "",

13643

"file": "yui/js/yui-ua.js",

13644

"line": 9,

13645

"description": "The YUI module contains the components required for building the\nYUI seed file. This includes the script loading mechanism, a\nsimple queue, and the core utilities for the library.",

13646

"extra": {

13647

"selleck": {

13648

"name": "yui",

13649

"displayName": "YUI Global Object",

13650

"description": "The YUI module is the single core dependency for all YUI 3 implementations. It must be included on all pages that use YUI — and it is the only dependency required to start writing YUI code. The YUI module contains loader functionality and a dependency calculator, allowing it to serve as a `seed` for your implementation. You provide the YUI module list you're using and the code that makes use of those modules; YUI will fetch all necessary components in a single, optimized HTTP request before executing your dependent code. While you may use some of the script- and CSS-loading facilities of the YUI module in your own implementation, this module's core purpose is to serve as a small seed from which complex, highly modular implementations can grow.",

13651

"author": [

13652

"davglass",

13653

"rgrove"

13654

],

13655

"tags": [

13656

"core"

13657

],

13658

"pages": {

13659

"nodejs": {

13660

"displayName": "YUI on Node.js",

13661

"examples": [

13662

{

13663

"name": "nodejs-dom",

13664

"displayName": "YUI, Node.js and DOM",

13665

"description": "Using YUI with a DOM in Node.js",

13666

"modules": [

13667

"yui"

13668

],

13669

"tags": [

13670

"yui",

13671

"core",

13672

"nodejs",

13673

"dom",

13674

"jsdom"

13675

]

13676

},

13677

{

13678

"name": "nodejs-package",

13679

"displayName": "Packaging a YUI script with npm",

13680

"description": "Packaging a YUI script with npm",

13681

"modules": [

13682

"yui"

13683

],

13684

"tags": [

13685

"yui",

13686

"core",

13687

"nodejs",

13688

"npm",

13689

"packaging"

13690

]

13691

},

13692

{

13693

"name": "nodejs-io",

13694

"displayName": "Using Y.io in Node.js",

13695

"description": "Using Y.io in Node.js",

13696

"modules": [

13697

"yui",

13698

"io"

13699

],

13700

"tags": [

13701

"yui",

13702

"core",

13703

"nodejs",

13704

"io"

13705

]

13706

}

13707

]

13708

},

13709

"create": {

13710

"displayName": "Creating YUI Modules"

13711

},

13712

"modules": {

13713

"displayName": "YUI Modules List",

13714

"hideTableOfContents": true,

13715

"hideExamples": true

13716

},

13717

"loader": {

13718

"displayName": "YUI Loader"

13719

},

13720

"lang": {

13721

"displayName": "Y.Lang"

13722

}

13723

}

13724

}

13725

}

13726

},

13727

"features": {

13728

"name": "features",

13729

"submodules": {},

13730

"classes": {

13731

"Intl": 1,

13732

"Features": 1

13733

},

13734

"fors": {},

13735

"namespaces": {},

13736

"tag": "module",

13737

"file": "yui/js/features.js",

13738

"line": 8,

13739

"description": "Contains the core of YUI's feature test architecture.",

13740

"extra": {

13741

"selleck": {

13742

"name": "yui",

13743

"displayName": "YUI Global Object",

13744

"description": "The YUI module is the single core dependency for all YUI 3 implementations. It must be included on all pages that use YUI — and it is the only dependency required to start writing YUI code. The YUI module contains loader functionality and a dependency calculator, allowing it to serve as a `seed` for your implementation. You provide the YUI module list you're using and the code that makes use of those modules; YUI will fetch all necessary components in a single, optimized HTTP request before executing your dependent code. While you may use some of the script- and CSS-loading facilities of the YUI module in your own implementation, this module's core purpose is to serve as a small seed from which complex, highly modular implementations can grow.",

13745

"author": [

13746

"davglass",

13747

"rgrove"

13748

],

13749

"tags": [

13750

"core"

13751

],

13752

"pages": {

13753

"nodejs": {

13754

"displayName": "YUI on Node.js",

13755

"examples": [

13756

{

13757

"name": "nodejs-dom",

13758

"displayName": "YUI, Node.js and DOM",

13759

"description": "Using YUI with a DOM in Node.js",

13760

"modules": [

13761

"yui"

13762

],

13763

"tags": [

13764

"yui",

13765

"core",

13766

"nodejs",

13767

"dom",

13768

"jsdom"

13769

]

13770

},

13771

{

13772

"name": "nodejs-package",

13773

"displayName": "Packaging a YUI script with npm",

13774

"description": "Packaging a YUI script with npm",

13775

"modules": [

13776

"yui"

13777

],

13778

"tags": [

13779

"yui",

13780

"core",

13781

"nodejs",

13782

"npm",

13783

"packaging"

13784

]

13785

},

13786

{

13787

"name": "nodejs-io",

13788

"displayName": "Using Y.io in Node.js",

13789

"description": "Using Y.io in Node.js",

13790

"modules": [

13791

"yui",

13792

"io"

13793

],

13794

"tags": [

13795

"yui",

13796

"core",

13797

"nodejs",

13798

"io"

13799

]

13800

}

13801

]

13802

},

13803

"create": {

13804

"displayName": "Creating YUI Modules"

13805

},

13806

"modules": {

13807

"displayName": "YUI Modules List",

13808

"hideTableOfContents": true,

13809

"hideExamples": true

13810

},

13811

"loader": {

13812

"displayName": "YUI Loader"

13813

},

13814

"lang": {

13815

"displayName": "Y.Lang"

13816

}

13817

}

13818

}

13819

}

13820

},

13821

"yui-later": {

13822

"name": "yui-later",

13823

"submodules": {},

13824

"classes": {},

13825

"fors": {},

13826

"is_submodule": 1,

13827

"namespaces": {},

13828

"module": "yui",

13829

"namespace": "",

13830

"file": "yui/js/yui-later.js",

13831

"line": 1,

13832

"description": "Provides a setTimeout/setInterval wrapper. This module is a `core` YUI module, <a href=\"../classes/YUI.html#method_later\">it's documentation is located under the YUI class</a>.",

13833

"extra": {

13834

"selleck": {

13835

"name": "yui",

13836

"displayName": "YUI Global Object",

13837

"description": "The YUI module is the single core dependency for all YUI 3 implementations. It must be included on all pages that use YUI — and it is the only dependency required to start writing YUI code. The YUI module contains loader functionality and a dependency calculator, allowing it to serve as a `seed` for your implementation. You provide the YUI module list you're using and the code that makes use of those modules; YUI will fetch all necessary components in a single, optimized HTTP request before executing your dependent code. While you may use some of the script- and CSS-loading facilities of the YUI module in your own implementation, this module's core purpose is to serve as a small seed from which complex, highly modular implementations can grow.",

13838

"author": [

13839

"davglass",

13840

"rgrove"

13841

],

13842

"tags": [

13843

"core"

13844

],

13845

"pages": {

13846

"nodejs": {

13847

"displayName": "YUI on Node.js",

13848

"examples": [

13849

{

13850

"name": "nodejs-dom",

13851

"displayName": "YUI, Node.js and DOM",

13852

"description": "Using YUI with a DOM in Node.js",

13853

"modules": [

13854

"yui"

13855

],

13856

"tags": [

13857

"yui",

13858

"core",

13859

"nodejs",

13860

"dom",

13861

"jsdom"

13862

]

13863

},

13864

{

13865

"name": "nodejs-package",

13866

"displayName": "Packaging a YUI script with npm",

13867

"description": "Packaging a YUI script with npm",

13868

"modules": [

13869

"yui"

13870

],

13871

"tags": [

13872

"yui",

13873

"core",

13874

"nodejs",

13875

"npm",

13876

"packaging"

13877

]

13878

},

13879

{

13880

"name": "nodejs-io",

13881

"displayName": "Using Y.io in Node.js",

13882

"description": "Using Y.io in Node.js",

13883

"modules": [

13884

"yui",

13885

"io"

13886

],

13887

"tags": [

13888

"yui",

13889

"core",

13890

"nodejs",

13891

"io"

13892

]

13893

}

13894

]

13895

},

13896

"create": {

13897

"displayName": "Creating YUI Modules"

13898

},

13899

"modules": {

13900

"displayName": "YUI Modules List",

13901

"hideTableOfContents": true,

13902

"hideExamples": true

13903

},

13904

"loader": {

13905

"displayName": "YUI Loader"

13906

},

13907

"lang": {

13908

"displayName": "Y.Lang"

13909

}

13910

}

13911

}

13912

}

13913

},

13914

"yui-log": {

13915

"name": "yui-log",

13916

"submodules": {},

13917

"classes": {},

13918

"fors": {},

13919

"is_submodule": 1,

13920

"namespaces": {},

13921

"module": "yui",

13922

"namespace": "",

13923

"file": "yui/js/yui-log.js",

13924

"line": 1,

13925

"description": "Provides console log capability and exposes a custom event for\nconsole implementations. This module is a `core` YUI module, <a href=\"../classes/YUI.html#method_log\">it's documentation is located under the YUI class</a>.",

13926

"extra": {

13927

"selleck": {

13928

"name": "yui",

13929

"displayName": "YUI Global Object",

13930

"description": "The YUI module is the single core dependency for all YUI 3 implementations. It must be included on all pages that use YUI — and it is the only dependency required to start writing YUI code. The YUI module contains loader functionality and a dependency calculator, allowing it to serve as a `seed` for your implementation. You provide the YUI module list you're using and the code that makes use of those modules; YUI will fetch all necessary components in a single, optimized HTTP request before executing your dependent code. While you may use some of the script- and CSS-loading facilities of the YUI module in your own implementation, this module's core purpose is to serve as a small seed from which complex, highly modular implementations can grow.",

13931

"author": [

13932

"davglass",

13933

"rgrove"

13934

],

13935

"tags": [

13936

"core"

13937

],

13938

"pages": {

13939

"nodejs": {

13940

"displayName": "YUI on Node.js",

13941

"examples": [

13942

{

13943

"name": "nodejs-dom",

13944

"displayName": "YUI, Node.js and DOM",

13945

"description": "Using YUI with a DOM in Node.js",

13946

"modules": [

13947

"yui"

13948

],

13949

"tags": [

13950

"yui",

13951

"core",

13952

"nodejs",

13953

"dom",

13954

"jsdom"

13955

]

13956

},

13957

{

13958

"name": "nodejs-package",

13959

"displayName": "Packaging a YUI script with npm",

13960

"description": "Packaging a YUI script with npm",

13961

"modules": [

13962

"yui"

13963

],

13964

"tags": [

13965

"yui",

13966

"core",

13967

"nodejs",

13968

"npm",

13969

"packaging"

13970

]

13971

},

13972

{

13973

"name": "nodejs-io",

13974

"displayName": "Using Y.io in Node.js",

13975

"description": "Using Y.io in Node.js",

13976

"modules": [

13977

"yui",

13978

"io"

13979

],

13980

"tags": [

13981

"yui",

13982

"core",

13983

"nodejs",

13984

"io"

13985

]

13986

}

13987

]

13988

},

13989

"create": {

13990

"displayName": "Creating YUI Modules"

13991

},

13992

"modules": {

13993

"displayName": "YUI Modules List",

13994

"hideTableOfContents": true,

13995

"hideExamples": true

13996

},

13997

"loader": {

13998

"displayName": "YUI Loader"

13999

},

14000

"lang": {

14001

"displayName": "Y.Lang"

14002

}

14003

}

14004

}

14005

}

14006

}

14007

},

14008

"classes": {

14009

"Anim": {

14010

"name": "Anim",

14011

"shortname": "Anim",

14012

"classitems": [],

14013

"plugins": [],

14014

"extensions": [],

14015

"plugin_for": [],

14016

"extension_for": [],

14017

"module": "anim",

14018

"submodule": "anim-base",

14019

"namespace": "",

14020

"file": "anim/js/anim.js",

14021

"line": 13,

14022

"description": "A class for constructing animation instances.",

14023

"is_constructor": 1,

14024

"extends": "Base"

14025

},

14026

"Easing": {

14027

"name": "Easing",

14028

"shortname": "Easing",

14029

"classitems": [],

14030

"plugins": [],

14031

"extensions": [],

14032

"plugin_for": [],

14033

"extension_for": [],

14034

"module": "anim",

14035

"namespace": "",

14036

"file": "anim/js/anim-easing.js",

14037

"line": 15,

14038

"description": "The easing module provides methods for customizing\nhow an animation behaves during each run.",

14039

"submodule": "anim-easing"

14040

},

14041

"Plugin.NodeFX": {

14042

"name": "Plugin.NodeFX",

14043

"shortname": "Plugin.NodeFX",

14044

"classitems": [],

14045

"plugins": [],

14046

"extensions": [],

14047

"plugin_for": [],

14048

"extension_for": [],

14049

"module": "anim",

14050

"namespace": "",

14051

"file": "anim/js/anim-node-plugin.js",

14052

"line": 1,

14053

"description": "Binds an Anim instance to a Node instance",

14054

"submodule": "anim-node-plugin",

14055

"extends": "Base"

14056

},

14057

"App.TransitionsNative": {

14058

"name": "App.TransitionsNative",

14059

"shortname": "App.TransitionsNative",

14060

"classitems": [],

14061

"plugins": [],

14062

"extensions": [],

14063

"plugin_for": [],

14064

"extension_for": [

14065

"App.Transitions"

14066

],

14067

"module": "app",

14068

"submodule": "app-transitions-native",

14069

"namespace": "",

14070

"file": "app/js/app-extensions/app-transitions-native.js",

14071

"line": 12,

14072

"description": "Provides the implementation of view transitions for `Y.App.Transitions` in\nbrowsers which support native CSS3 transitions.\n\nWhen this module is used, `Y.App.TransitionsNative` will automatically mix\nitself in to `Y.App`.",

14073

"since": "3.5.0"

14074

},

14075

"App.Transitions": {

14076

"name": "App.Transitions",

14077

"shortname": "App.Transitions",

14078

"classitems": [],

14079

"plugins": [],

14080

"extensions": [],

14081

"plugin_for": [],

14082

"extension_for": [

14083

"App"

14084

],

14085

"module": "app",

14086

"submodule": "app-transitions",

14087

"namespace": "",

14088

"file": "app/js/app-extensions/app-transitions.js",

14089

"line": 10,

14090

"description": "Provides view transitions for `Y.App` in browsers which support native CSS3\ntransitions.\n\nView transitions provide an nice way to move from one \"page\" to the next that is\nboth pleasant to the user and helps to communicate a hierarchy between sections\nof an application.\n\nWhen this module is used, it will automatically mix itself in to `Y.App` and\ntransition between `activeView` changes using the following effects:\n\n * **`fade`**: Cross-fades between the old an new active views.\n\n * **`slideLeft`**: The old and new active views are positioned next to each\n other and both slide to the left.\n\n * **`slideRight`**: The old and new active views are positioned next to each\n other and both slide to the right.\n\n**Note:** Transitions are an opt-in feature and are enabled via an app's\n`transitions` attribute.",

14091

"uses": [

14092

"App.TransitionsNative"

14093

],

14094

"since": "3.5.0"

14095

},

14096

"View.NodeMap": {

14097

"name": "View.NodeMap",

14098

"shortname": "View.NodeMap",

14099

"classitems": [],

14100

"plugins": [],

14101

"extensions": [],

14102

"plugin_for": [],

14103

"extension_for": [

14104

"View"

14105

],

14106

"module": "app",

14107

"submodule": "view-node-map",

14108

"namespace": "",

14109

"file": "app/js/view-extensions/view-node-map.js",

14110

"line": 14,

14111

"description": "View extension that adds a static `getByNode()` method that returns the nearest\nView instance associated with the given Node (similar to Widget's `getByNode()`\nmethod).\n\nNote that it's important to call `destroy()` on a View instance using this\nextension when you plan to stop using it. This ensures that all internal\nreferences to that View are cleared to prevent memory leaks.",

14112

"since": "3.5.0"

14113

},

14114

"App.Base": {

14115

"name": "App.Base",

14116

"shortname": "App.Base",

14117

"classitems": [],

14118

"plugins": [],

14119

"extensions": [],

14120

"plugin_for": [],

14121

"extension_for": [],

14122

"module": "app",

14123

"submodule": "app-base",

14124

"namespace": "",

14125

"file": "app/js/app-base.js",

14126

"line": 51,

14127

"description": "Provides a top-level application component which manages navigation and views.\n\nThis gives you a foundation and structure on which to build your application; it\ncombines robust URL navigation with powerful routing and flexible view\nmanagement.",

14128

"params": [

14129

{

14130

"name": "config",

14131

"description": "The following are configuration properties that can be\n specified _in addition_ to default attribute values and the non-attribute\n properties provided by `Y.Base`:",

14132

"type": "Object",

14133

"optional": true,

14134

"props": [

14135

{

14136

"name": "views",

14137

"description": "Hash of view-name to metadata used to\n declaratively describe an application's views and their relationship with\n the app and other views. The views specified here will override any defaults\n provided by the `views` object on the `prototype`.",

14138

"type": "Object",

14139

"optional": true

14140

}

14141

]

14142

}

14143

],

14144

"is_constructor": 1,

14145

"extends": "Base",

14146

"uses": [

14147

"View",

14148

"Router",

14149

"PjaxBase"

14150

],

14151

"since": "3.5.0"

14152

},

14153

"App": {

14154

"name": "App",

14155

"shortname": "App",

14156

"classitems": [],

14157

"plugins": [],

14158

"extensions": [],

14159

"plugin_for": [],

14160

"extension_for": [],

14161

"module": "app",

14162

"submodule": "app-base",

14163

"namespace": "",

14164

"file": "app/js/app-base.js",

14165

"line": 1100,

14166

"description": "Provides a top-level application component which manages navigation and views.\n\nThis gives you a foundation and structure on which to build your application; it\ncombines robust URL navigation with powerful routing and flexible view\nmanagement.\n\n`Y.App` is both a namespace and constructor function. The `Y.App` class is\nspecial in that any `Y.App` class extensions that are included in the YUI\ninstance will be **auto-mixed** on to the `Y.App` class. Consider this example:\n\n YUI().use('app-base', 'app-transitions', function (Y) {\n // This will create two YUI Apps, `basicApp` will not have transitions,\n // but `fancyApp` will have transitions support included and turn it on.\n var basicApp = new Y.App.Base(),\n fancyApp = new Y.App({transitions: true});\n });",

14167

"params": [

14168

{

14169

"name": "config",

14170

"description": "The following are configuration properties that can be\n specified _in addition_ to default attribute values and the non-attribute\n properties provided by `Y.Base`:",

14171

"type": "Object",

14172

"optional": true,

14173

"props": [

14174

{

14175

"name": "views",

14176

"description": "Hash of view-name to metadata used to\n declaratively describe an application's views and their relationship with\n the app and other views. The views specified here will override any defaults\n provided by the `views` object on the `prototype`.",

14177

"type": "Object",

14178

"optional": true

14179

}

14180

]

14181

}

14182

],

14183

"is_constructor": 1,

14184

"extends": "App.Base",

14185

"uses": [

14186

"App.Transitions"

14187

],

14188

"since": "3.5.0"

14189

},

14190

"ModelList": {

14191

"name": "ModelList",

14192

"shortname": "ModelList",

14193

"classitems": [],

14194

"plugins": [],

14195

"extensions": [],

14196

"plugin_for": [],

14197

"extension_for": [],

14198

"module": "app",

14199

"submodule": "model-list",

14200

"namespace": "",

14201

"file": "app/js/model-list.js",

14202

"line": 9,

14203

"description": "Provides an API for managing an ordered list of Model instances.\n\nIn addition to providing convenient `add`, `create`, `reset`, and `remove`\nmethods for managing the models in the list, ModelLists are also bubble targets\nfor events on the model instances they contain. This means, for example, that\nyou can add several models to a list, and then subscribe to the `*:change` event\non the list to be notified whenever any model in the list changes.\n\nModelLists also maintain sort order efficiently as models are added and removed,\nbased on a custom `comparator` function you may define (if no comparator is\ndefined, models are sorted in insertion order).",

14204

"extends": "Base",

14205

"uses": [

14206

"ArrayList"

14207

],

14208

"is_constructor": 1,

14209

"since": "3.4.0"

14210

},

14211

"Model": {

14212

"name": "Model",

14213

"shortname": "Model",

14214

"classitems": [],

14215

"plugins": [],

14216

"extensions": [],

14217

"plugin_for": [],

14218

"extension_for": [],

14219

"module": "app",

14220

"submodule": "model",

14221

"namespace": "",

14222

"file": "app/js/model.js",

14223

"line": 10,

14224

"description": "Attribute-based data model with APIs for getting, setting, validating, and\nsyncing attribute values, as well as events for being notified of model changes.\n\nIn most cases, you'll want to create your own subclass of `Y.Model` and\ncustomize it to meet your needs. In particular, the `sync()` and `validate()`\nmethods are meant to be overridden by custom implementations. You may also want\nto override the `parse()` method to parse non-generic server responses.",

14225

"is_constructor": 1,

14226

"extends": "Base",

14227

"since": "3.4.0"

14228

},

14229

"Router": {

14230

"name": "Router",

14231

"shortname": "Router",

14232

"classitems": [],

14233

"plugins": [],

14234

"extensions": [],

14235

"plugin_for": [],

14236

"extension_for": [

14237

"App.Base"

14238

],

14239

"module": "app",

14240

"submodule": "router",

14241

"namespace": "",

14242

"file": "app/js/router.js",

14243

"line": 34,

14244

"description": "Provides URL-based routing using HTML5 `pushState()` or the location hash.\n\nThis makes it easy to wire up route handlers for different application states\nwhile providing full back/forward navigation support and bookmarkable, shareable\nURLs.",

14245

"params": [

14246

{

14247

"name": "config",

14248

"description": "Config properties.",

14249

"type": "Object",

14250

"optional": true,

14251

"props": [

14252

{

14253

"name": "html5",

14254

"description": "Overrides the default capability detection\n and forces this router to use (`true`) or not use (`false`) HTML5\n history.",

14255

"type": "Boolean",

14256

"optional": true

14257

},

14258

{

14259

"name": "root",

14260

"description": "Root path from which all routes should be\n evaluated.",

14261

"type": "String",

14262

"optional": true,

14263

"optdefault": "''"

14264

},

14265

{

14266

"name": "routes",

14267

"description": "Array of route definition objects.",

14268

"type": "Array",

14269

"optional": true,

14270

"optdefault": "["

14271

}

14272

]

14273

}

14274

],

14275

"is_constructor": 1,

14276

"extends": "Base",

14277

"since": "3.4.0"

14278

},

14279

"Controller": {

14280

"name": "Controller",

14281

"shortname": "Controller",

14282

"classitems": [],

14283

"plugins": [],

14284

"extensions": [],

14285

"plugin_for": [],

14286

"extension_for": [],

14287

"module": "app",

14288

"submodule": "router",

14289

"namespace": "",

14290

"file": "app/js/router.js",

14291

"line": 1057,

14292

"description": "The `Controller` class was deprecated in YUI 3.5.0 and is now an alias for the\n`Router` class. Use that class instead. This alias will be removed in a future\nversion of YUI.",

14293

"is_constructor": 1,

14294

"extends": "Base",

14295

"deprecated": true,

14296

"deprecationMessage": "Use `Router` instead.",

14297

"see": [

14298

"Router"

14299

]

14300

},

14301

"View": {

14302

"name": "View",

14303

"shortname": "View",

14304

"classitems": [],

14305

"plugins": [],

14306

"extensions": [],

14307

"plugin_for": [],

14308

"extension_for": [

14309

"App.Base"

14310

],

14311

"module": "app",

14312

"submodule": "view",

14313

"namespace": "",

14314

"file": "app/js/view.js",

14315

"line": 11,

14316

"description": "Represents a logical piece of an application's user interface, and provides a\nlightweight, overridable API for rendering content and handling delegated DOM\nevents on a container element.\n\nThe View class imposes little structure and provides only minimal functionality\nof its own: it's basically just an overridable API interface that helps you\nimplement custom views.\n\nAs of YUI 3.5.0, View allows ad-hoc attributes to be specified at instantiation\ntime, so you don't need to subclass `Y.View` to add custom attributes. Just pass\nthem to the constructor:\n\n var view = new Y.View({foo: 'bar'});\n view.get('foo'); // => \"bar\"",

14317

"is_constructor": 1,

14318

"extends": "Base",

14319

"since": "3.4.0"

14320

},

14321

"ArraySort": {

14322

"name": "ArraySort",

14323

"shortname": "ArraySort",

14324

"classitems": [],

14325

"plugins": [],

14326

"extensions": [],

14327

"plugin_for": [],

14328

"extension_for": [],

14329

"module": "arraysort",

14330

"namespace": "",

14331

"file": "arraysort/js/arraysort.js",

14332

"line": 11,

14333

"description": "Provides a case-insenstive comparator which can be used for array sorting."

14334

},

14335

"AsyncQueue": {

14336

"name": "AsyncQueue",

14337

"shortname": "AsyncQueue",

14338

"classitems": [],

14339

"plugins": [],

14340

"extensions": [],

14341

"plugin_for": [],

14342

"extension_for": [],

14343

"module": "async-queue",

14344

"namespace": "",

14345

"file": "async-queue/js/async-queue.js",

14346

"line": 11,

14347

"description": "A specialized queue class that supports scheduling callbacks to execute\nsequentially, iteratively, even asynchronously.\n\nCallbacks can be function refs or objects with the following keys. Only\nthe <code>fn</code> key is required.\n\n<ul>\n<li><code>fn</code> -- The callback function</li>\n<li><code>context</code> -- The execution context for the callbackFn.</li>\n<li><code>args</code> -- Arguments to pass to callbackFn.</li>\n<li><code>timeout</code> -- Millisecond delay before executing callbackFn.\n (Applies to each iterative execution of callback)</li>\n<li><code>iterations</code> -- Number of times to repeat the callback.\n<li><code>until</code> -- Repeat the callback until this function returns\n true. This setting trumps iterations.</li>\n<li><code>autoContinue</code> -- Set to false to prevent the AsyncQueue from\n executing the next callback in the Queue after\n the callback completes.</li>\n<li><code>id</code> -- Name that can be used to get, promote, get the\n indexOf, or delete this callback.</li>\n</ul>",

14348

"extends": "EventTarget",

14349

"is_constructor": 1,

14350

"params": [

14351

{

14352

"name": "callback",

14353

"description": "0..n callbacks to seed the queue",

14354

"type": "Function|Object",

14355

"multiple": true

14356

}

14357

]

14358

},

14359

"Attribute": {

14360

"name": "Attribute",

14361

"shortname": "Attribute",

14362

"classitems": [],

14363

"plugins": [],

14364

"extensions": [],

14365

"plugin_for": [],

14366

"extension_for": [

14367

"Base"

14368

],

14369

"module": "attribute",

14370

"submodule": "attribute-base",

14371

"namespace": "",

14372

"file": "attribute/js/Attribute.js",

14373

"line": 19,

14374

"description": "\nAttribute provides configurable attribute support along with attribute change events. It is designed to be \naugmented on to a host class, and provides the host with the ability to configure attributes to store and retrieve state, \nalong with attribute change events.\n\nFor example, attributes added to the host can be configured:\n<ul>\n <li>As read only.</li>\n <li>As write once.</li>\n <li>With a setter function, which can be used to manipulate\n values passed to Attribute's <a href=\"#method_set\">set</a> method, before they are stored.</li>\n <li>With a getter function, which can be used to manipulate stored values,\n before they are returned by Attribute's <a href=\"#method_get\">get</a> method.</li>\n <li>With a validator function, to validate values before they are stored.</li>\n</ul>\n\nSee the <a href=\"#method_addAttr\">addAttr</a> method, for the complete set of configuration\noptions available for attributes.\n\nNOTE: Most implementations will be better off extending the <a href=\"Base.html\">Base</a> class, \ninstead of augmenting Attribute directly. Base augments Attribute and will handle the initial configuration \nof attributes for derived classes, accounting for values passed into the constructor.",

14375

"params": [

14376

{

14377

"name": "attrs",

14378

"description": "The attributes to add during construction (passed through to <a href=\"#method_addAttrs\">addAttrs</a>). These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor.",

14379

"type": "Object"

14380

},

14381

{

14382

"name": "values",

14383

"description": "The initial attribute values to apply (passed through to <a href=\"#method_addAttrs\">addAttrs</a>). These are not merged/cloned. The caller is responsible for isolating user provided values if required.",

14384

"type": "Object"

14385

},

14386

{

14387

"name": "lazy",

14388

"description": "Whether or not to add attributes lazily (passed through to <a href=\"#method_addAttrs\">addAttrs</a>).",

14389

"type": "Boolean"

14390

}

14391

],

14392

"uses": [

14393

"AttributeCore",

14394

"AttributeEvents",

14395

"EventTarget",

14396

"AttributeExtras"

14397

]

14398

},

14399

"AttributeCore": {

14400

"name": "AttributeCore",

14401

"shortname": "AttributeCore",

14402

"classitems": [],

14403

"plugins": [],

14404

"extensions": [],

14405

"plugin_for": [],

14406

"extension_for": [

14407

"Attribute",

14408

"Base",

14409

"BaseCore"

14410

],

14411

"module": "attribute",

14412

"submodule": "attribute-core",

14413

"namespace": "",

14414

"file": "attribute/js/AttributeCore.js",

14415

"line": 45,

14416

"description": "\nAttributeCore provides the lightest level of configurable attribute support. It is designed to be \naugmented on to a host class, and provides the host with the ability to configure \nattributes to store and retrieve state, but without support for attribute change events.\n\nFor example, attributes added to the host can be configured:\n<ul>\n <li>As read only.</li>\n <li>As write once.</li>\n <li>With a setter function, which can be used to manipulate\n values passed to Attribute's <a href=\"#method_set\">set</a> method, before they are stored.</li>\n <li>With a getter function, which can be used to manipulate stored values,\n before they are returned by Attribute's <a href=\"#method_get\">get</a> method.</li>\n <li>With a validator function, to validate values before they are stored.</li>\n</ul>\n\nSee the <a href=\"#method_addAttr\">addAttr</a> method, for the complete set of configuration\noptions available for attributes.\n\nObject/Classes based on AttributeCore can augment <a href=\"AttributeEvents.html\">AttributeEvents</a> \n(with true for overwrite) and <a href=\"AttributeExtras.html\">AttributeExtras</a> to add attribute event and \nadditional, less commonly used attribute methods, such as `modifyAttr`, `removeAttr` and `reset`.",

14417

"params": [

14418

{

14419

"name": "attrs",

14420

"description": "The attributes to add during construction (passed through to <a href=\"#method_addAttrs\">addAttrs</a>). These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor.",

14421

"type": "Object"

14422

},

14423

{

14424

"name": "values",

14425

"description": "The initial attribute values to apply (passed through to <a href=\"#method_addAttrs\">addAttrs</a>). These are not merged/cloned. The caller is responsible for isolating user provided values if required.",

14426

"type": "Object"

14427

},

14428

{

14429

"name": "lazy",

14430

"description": "Whether or not to add attributes lazily (passed through to <a href=\"#method_addAttrs\">addAttrs</a>).",

14431

"type": "Boolean"

14432

}

14433

]

14434

},

14435

"AttributeEvents": {

14436

"name": "AttributeEvents",

14437

"shortname": "AttributeEvents",

14438

"classitems": [],

14439

"plugins": [],

14440

"extensions": [],

14441

"plugin_for": [],

14442

"extension_for": [

14443

"Attribute",

14444

"Base"

14445

],

14446

"module": "attribute",

14447

"submodule": "attribute-events",

14448

"namespace": "",

14449

"file": "attribute/js/AttributeEvents.js",

14450

"line": 24,

14451

"description": "Provides an augmentable implementation of attribute change events for \nAttributeCore.",

14452

"uses": [

14453

"EventTarget"

14454

]

14455

},

14456

"AttributeExtras": {

14457

"name": "AttributeExtras",

14458

"shortname": "AttributeExtras",

14459

"classitems": [],

14460

"plugins": [],

14461

"extensions": [],

14462

"plugin_for": [],

14463

"extension_for": [

14464

"Attribute",

14465

"Base"

14466

],

14467

"module": "attribute",

14468

"submodule": "attribute-extras",

14469

"namespace": "",

14470

"file": "attribute/js/AttributeExtras.js",

14471

"line": 29,

14472

"description": "A augmentable implementation for AttributeCore, providing less frequently used \nmethods for Attribute management such as modifyAttrs(), removeAttr and reset()"

14473

},

14474

"State": {

14475

"name": "State",

14476

"shortname": "State",

14477

"classitems": [],

14478

"plugins": [],

14479

"extensions": [],

14480

"plugin_for": [],

14481

"extension_for": [],

14482

"module": "attribute",

14483

"namespace": "",

14484

"file": "attribute/js/State.js",

14485

"line": 1,

14486

"description": "The State class maintains state for a collection of named items, with \na varying number of properties defined.\n\nIt avoids the need to create a separate class for the item, and separate instances \nof these classes for each item, by storing the state in a 2 level hash table, \nimproving performance when the number of items is likely to be large.",

14487

"is_constructor": 1

14488

},

14489

"AutoCompleteBase": {

14490

"name": "AutoCompleteBase",

14491

"shortname": "AutoCompleteBase",

14492

"classitems": [],

14493

"plugins": [],

14494

"extensions": [],

14495

"plugin_for": [],

14496

"extension_for": [

14497

"AutoCompleteList"

14498

],

14499

"module": "autocomplete",

14500

"submodule": "autocomplete-base",

14501

"namespace": "",

14502

"file": "autocomplete/js/autocomplete-base.js",

14503

"line": 19,

14504

"description": "Extension that provides core autocomplete logic (but no UI implementation) for a\ntext input field or textarea.\n\nThe `AutoCompleteBase` class provides events and attributes that abstract away\ncore autocomplete logic and configuration, but does not provide a widget\nimplementation or suggestion UI. For a prepackaged autocomplete widget, see\n`AutoCompleteList`.\n\nThis extension cannot be instantiated directly, since it doesn't provide an\nactual implementation. It's intended to be mixed into a `Y.Base`-based class or\nwidget.\n\n`Y.Widget`-based example:\n\n YUI().use('autocomplete-base', 'widget', function (Y) {\n var MyAC = Y.Base.create('myAC', Y.Widget, [Y.AutoCompleteBase], {\n // Custom prototype methods and properties.\n }, {\n // Custom static methods and properties.\n });\n\n // Custom implementation code.\n });\n\n`Y.Base`-based example:\n\n YUI().use('autocomplete-base', function (Y) {\n var MyAC = Y.Base.create('myAC', Y.Base, [Y.AutoCompleteBase], {\n initializer: function () {\n this._bindUIACBase();\n this._syncUIACBase();\n },\n\n // Custom prototype methods and properties.\n }, {\n // Custom static methods and properties.\n });\n\n // Custom implementation code.\n });"

14505

},

14506

"AutoCompleteFilters": {

14507

"name": "AutoCompleteFilters",

14508

"shortname": "AutoCompleteFilters",

14509

"classitems": [],

14510

"plugins": [],

14511

"extensions": [],

14512

"plugin_for": [],

14513

"extension_for": [],

14514

"module": "autocomplete",

14515

"submodule": "autocomplete-filters",

14516

"namespace": "",

14517

"file": "autocomplete/js/autocomplete-filters.js",

14518

"line": 1,

14519

"static": 1,

14520

"description": "Provides pre-built result matching filters for AutoComplete."

14521

},

14522

"AutoCompleteHighlighters": {

14523

"name": "AutoCompleteHighlighters",

14524

"shortname": "AutoCompleteHighlighters",

14525

"classitems": [],

14526

"plugins": [],

14527

"extensions": [],

14528

"plugin_for": [],

14529

"extension_for": [],

14530

"module": "autocomplete",

14531

"submodule": "autocomplete-highlighters",

14532

"namespace": "",

14533

"file": "autocomplete/js/autocomplete-highlighters.js",

14534

"line": 1,

14535

"static": 1,

14536

"description": "Provides pre-built result highlighters for AutoComplete."

14537

},

14538

"AutoCompleteList": {

14539

"name": "AutoCompleteList",

14540

"shortname": "AutoCompleteList",

14541

"classitems": [],

14542

"plugins": [],

14543

"extensions": [],

14544

"plugin_for": [],

14545

"extension_for": [],

14546

"module": "autocomplete",

14547

"submodule": "autocomplete-list",

14548

"namespace": "",

14549

"file": "autocomplete/js/autocomplete-list.js",

14550

"line": 8,

14551

"description": "Traditional autocomplete dropdown list widget, just like Mom used to make.",

14552

"extends": "Widget",

14553

"uses": [

14554

"AutoCompleteBase",

14555

"WidgetPosition",

14556

"WidgetPositionAlign"

14557

],

14558

"is_constructor": 1,

14559

"params": [

14560

{

14561

"name": "config",

14562

"description": "Configuration object.",

14563

"type": "Object"

14564

}

14565

]

14566

},

14567

"AutoComplete": {

14568

"name": "AutoComplete",

14569

"shortname": "AutoComplete",

14570

"classitems": [],

14571

"plugins": [],

14572

"extensions": [],

14573

"plugin_for": [],

14574

"extension_for": [],

14575

"module": "autocomplete",

14576

"submodule": "autocomplete-list",

14577

"namespace": "",

14578

"file": "autocomplete/js/autocomplete-list.js",

14579

"line": 875,

14580

"description": "Alias for <a href=\"AutoCompleteList.html\">`AutoCompleteList`</a>. See that class\nfor API docs."

14581

},

14582

"Plugin.AutoComplete": {

14583

"name": "Plugin.AutoComplete",

14584

"shortname": "Plugin.AutoComplete",

14585

"classitems": [],

14586

"plugins": [],

14587

"extensions": [],

14588

"plugin_for": [],

14589

"extension_for": [],

14590

"module": "autocomplete",

14591

"submodule": "autocomplete-plugin",

14592

"namespace": "",

14593

"file": "autocomplete/js/autocomplete-plugin.js",

14594

"line": 8,

14595

"description": "Binds an AutoCompleteList instance to a Node instance.",

14596

"example": [

14597

"\n\n Y.one('#my-input').plug(Y.Plugin.AutoComplete, {\n source: 'select * from search.suggest where query=\"{query}\"'\n });\n\n // You can now access the AutoCompleteList instance at Y.one('#my-input').ac"

14598

],

14599

"extends": "AutoCompleteList"

14600

},

14601

"Base": {

14602

"name": "Base",

14603

"shortname": "Base",

14604

"classitems": [],

14605

"plugins": [],

14606

"extensions": [],

14607

"plugin_for": [],

14608

"extension_for": [],

14609

"module": "base",

14610

"submodule": "base-base",

14611

"namespace": "",

14612

"file": "base/js/Base.js",

14613

"line": 44,

14614

"description": "\nA base class which objects requiring attributes and custom event support can \nextend. Base also handles the chaining of initializer and destructor methods across \nthe hierarchy as part of object construction and destruction. Additionally, attributes configured \nthrough the static <a href=\"#property_Base.ATTRS\">ATTRS</a> property for each class \nin the hierarchy will be initialized by Base.\n\n\n\nThe static <a href=\"#property_Base.NAME\">NAME</a> property of each class extending \nfrom Base will be used as the identifier for the class, and is used by Base to prefix \nall events fired by instances of that class.\n",

14615

"is_constructor": 1,

14616

"uses": [

14617

"BaseCore",

14618

"Attribute",

14619

"AttributeCore",

14620

"AttributeEvents",

14621

"AttributeExtras",

14622

"EventTarget"

14623

],

14624

"params": [

14625

{

14626

"name": "config",

14627

"description": "Object with configuration property name/value pairs. The object can be \nused to provide default values for the objects published attributes.\n\n\nThe config object can also contain the following non-attribute properties, providing a convenient \nway to configure events listeners and plugins for the instance, as part of the constructor call:\n\n\n<dl>\n <dt>on</dt>\n <dd>An event name to listener function map, to register event listeners for the \"on\" moment of the event. A constructor convenience property for the <a href=\"Base.html#method_on\">on</a> method.</dd>\n <dt>after</dt>\n <dd>An event name to listener function map, to register event listeners for the \"after\" moment of the event. A constructor convenience property for the <a href=\"Base.html#method_after\">after</a> method.</dd>\n <dt>bubbleTargets</dt>\n <dd>An object, or array of objects, to register as bubble targets for bubbled events fired by this instance. A constructor convenience property for the <a href=\"EventTarget.html#method_addTarget\">addTarget</a> method.</dd>\n <dt>plugins</dt>\n <dd>A plugin, or array of plugins to be plugged into the instance (see PluginHost's plug method for signature details). A constructor convenience property for the <a href=\"Plugin.Host.html#method_plug\">plug</a> method.</dd>\n</dl>",

14628

"type": "Object"

14629

}

14630

]

14631

},

14632

"BaseCore": {

14633

"name": "BaseCore",

14634

"shortname": "BaseCore",

14635

"classitems": [],

14636

"plugins": [],

14637

"extensions": [],

14638

"plugin_for": [],

14639

"extension_for": [

14640

"Base"

14641

],

14642

"module": "base",

14643

"submodule": "base-core",

14644

"namespace": "",

14645

"file": "base/js/BaseCore.js",

14646

"line": 42,

14647

"description": "The BaseCore class, is the lightest version of Base, and provides Base's \nbasic lifecycle management and ATTRS construction support, but doesn't \nfire init/destroy or attribute change events.\n\nBaseCore also handles the chaining of initializer and destructor methods across \nthe hierarchy as part of object construction and destruction. Additionally, attributes \nconfigured through the static <a href=\"#property_BaseCore.ATTRS\">ATTRS</a> \nproperty for each class in the hierarchy will be initialized by BaseCore.\n\nClasses which require attribute support, but don't intend to use/expose attribute \nchange events can extend BaseCore instead of Base for optimal kweight and \nruntime performance.",

14648

"is_constructor": 1,

14649

"uses": [

14650

"AttributeCore"

14651

],

14652

"params": [

14653

{

14654

"name": "cfg",

14655

"description": "Object with configuration property name/value pairs. \nThe object can be used to provide initial values for the objects published \nattributes.",

14656

"type": "Object"

14657

}

14658

]

14659

},

14660

"Button": {

14661

"name": "Button",

14662

"shortname": "Button",

14663

"classitems": [],

14664

"plugins": [],

14665

"extensions": [],

14666

"plugin_for": [],

14667

"extension_for": [],

14668

"module": "button",

14669

"namespace": "",

14670

"file": "button/js/button.js",

14671

"line": 12,

14672

"description": "Creates a Button",

14673

"extends": "Widget",

14674

"params": [

14675

{

14676

"name": "config",

14677

"description": "Configuration object",

14678

"type": "Object"

14679

}

14680

],

14681

"is_constructor": 1

14682

},

14683

"ToggleButton": {

14684

"name": "ToggleButton",

14685

"shortname": "ToggleButton",

14686

"classitems": [],

14687

"plugins": [],

14688

"extensions": [],

14689

"plugin_for": [],

14690

"extension_for": [],

14691

"module": "button",

14692

"namespace": "",

14693

"file": "button/js/button.js",

14694

"line": 142,

14695

"description": "Creates a ToggleButton",

14696

"extends": "Button",

14697

"params": [

14698

{

14699

"name": "config",

14700

"description": "Configuration object",

14701

"type": "Object"

14702

}

14703

],

14704

"is_constructor": 1

14705

},

14706

"ButtonCore": {

14707

"name": "ButtonCore",

14708

"shortname": "ButtonCore",

14709

"classitems": [],

14710

"plugins": [],

14711

"extensions": [],

14712

"plugin_for": [],

14713

"extension_for": [],

14714

"module": "button-core",

14715

"namespace": "",

14716

"file": "button/js/core.js",

14717

"line": 10,

14718

"description": "Creates a button",

14719

"params": [

14720

{

14721

"name": "config",

14722

"description": "Configuration object",

14723

"type": "Object"

14724

}

14725

],

14726

"is_constructor": 1

14727

},

14728

"ButtonGroup": {

14729

"name": "ButtonGroup",

14730

"shortname": "ButtonGroup",

14731

"classitems": [],

14732

"plugins": [],

14733

"extensions": [],

14734

"plugin_for": [],

14735

"extension_for": [],

14736

"module": "button-group",

14737

"namespace": "",

14738

"file": "button/js/group.js",

14739

"line": 13,

14740

"description": "Creates a ButtonGroup",

14741

"extends": "Widget",

14742

"params": [

14743

{

14744

"name": "config",

14745

"description": "Configuration object",

14746

"type": "Object"

14747

}

14748

],

14749

"is_constructor": 1

14750

},

14751

"ButtonPlugin": {

14752

"name": "ButtonPlugin",

14753

"shortname": "ButtonPlugin",

14754

"classitems": [],

14755

"plugins": [],

14756

"extensions": [],

14757

"plugin_for": [],

14758

"extension_for": [],

14759

"module": "button-plugin",

14760

"namespace": "",

14761

"file": "button/js/plugin.js",

14762

"line": 8,

14763

"params": [

14764

{

14765

"name": "config",

14766

"description": "Configuration object",

14767

"type": "Object"

14768

}

14769

],

14770

"is_constructor": 1

14771

},

14772

"Cache": {

14773

"name": "Cache",

14774

"shortname": "Cache",

14775

"classitems": [],

14776

"plugins": [],

14777

"extensions": [],

14778

"plugin_for": [],

14779

"extension_for": [],

14780

"module": "cache",

14781

"submodule": "cache-base",

14782

"namespace": "",

14783

"file": "cache/js/cache-base.js",

14784

"line": 17,

14785

"description": "Base class for the YUI Cache utility.",

14786

"extends": "Base",

14787

"is_constructor": 1

14788

},

14789

"CacheOffline": {

14790

"name": "CacheOffline",

14791

"shortname": "CacheOffline",

14792

"classitems": [],

14793

"plugins": [],

14794

"extensions": [],

14795

"plugin_for": [],

14796

"extension_for": [],

14797

"module": "cache",

14798

"submodule": "cache-offline",

14799

"namespace": "",

14800

"file": "cache/js/cache-offline.js",

14801

"line": 8,

14802

"description": "Extends Cache utility with offline functionality.",

14803

"extends": "Cache",

14804

"is_constructor": 1

14805

},

14806

"Plugin.Cache": {

14807

"name": "Plugin.Cache",

14808

"shortname": "Plugin.Cache",

14809

"classitems": [],

14810

"plugins": [],

14811

"extensions": [],

14812

"plugin_for": [],

14813

"extension_for": [],

14814

"module": "cache",

14815

"submodule": "cache-plugin",

14816

"namespace": "",

14817

"file": "cache/js/cache-plugin.js",

14818

"line": 8,

14819

"description": "Plugin.Cache adds pluginizability to Cache.",

14820

"extends": "Cache",

14821

"uses": [

14822

"Plugin.Base"

14823

]

14824

},

14825

"CalendarBase": {

14826

"name": "CalendarBase",

14827

"shortname": "CalendarBase",

14828

"classitems": [],

14829

"plugins": [],

14830

"extensions": [],

14831

"plugin_for": [],

14832

"extension_for": [],

14833

"module": "calendar",

14834

"submodule": "calendar-base",

14835

"namespace": "",

14836

"file": "calendar/js/calendar-base.js",

14837

"line": 43,

14838

"description": "month range of dates, rendered as a grid with date and\nweekday labels.",

14839

"extends": "Widget",

14840

"params": [

14841

{

14842

"name": "config",

14843

"description": "Configuration object (see Configuration \nattributes)",

14844

"type": "Object"

14845

}

14846

],

14847

"is_constructor": 1

14848

},

14849

"Calendar": {

14850

"name": "Calendar",

14851

"shortname": "Calendar",

14852

"classitems": [],

14853

"plugins": [],

14854

"extensions": [],

14855

"plugin_for": [],

14856

"extension_for": [],

14857

"module": "calendar",

14858

"namespace": "",

14859

"file": "calendar/js/calendar.js",

14860

"line": 32,

14861

"description": "month range of dates, rendered as a grid with date and\nweekday labels.",

14862

"extends": "CalendarBase",

14863

"params": [

14864

{

14865

"name": "config",

14866

"description": "Configuration object (see Configuration attributes)",

14867

"type": "Object"

14868

}

14869

],

14870

"is_constructor": 1

14871

},

14872

"Plugin.CalendarNavigator": {

14873

"name": "Plugin.CalendarNavigator",

14874

"shortname": "Plugin.CalendarNavigator",

14875

"classitems": [],

14876

"plugins": [],

14877

"extensions": [],

14878

"plugin_for": [],

14879

"extension_for": [],

14880

"module": "calendarnavigator",

14881

"namespace": "Plugin",

14882

"file": "calendar/js/calendarnavigator.js",

14883

"line": 20,

14884

"description": "A plugin class which adds navigation controls to Calendar.",

14885

"extends": "Plugin.Base"

14886

},

14887

"AreaSeries": {

14888

"name": "AreaSeries",

14889

"shortname": "AreaSeries",

14890

"classitems": [],

14891

"plugins": [],

14892

"extensions": [],

14893

"plugin_for": [],

14894

"extension_for": [],

14895

"module": "charts",

14896

"namespace": "",

14897

"file": "charts/js/AreaSeries.js",

14898

"line": 1,

14899

"description": "The AreaSeries class renders quantitative data on a graph by creating a fill between 0\nand the relevant data points."

14900

},

14901

"AreaSplineSeries": {

14902

"name": "AreaSplineSeries",

14903

"shortname": "AreaSplineSeries",

14904

"classitems": [],

14905

"plugins": [],

14906

"extensions": [],

14907

"plugin_for": [],

14908

"extension_for": [],

14909

"module": "charts",

14910

"namespace": "",

14911

"file": "charts/js/AreaSplineSeries.js",

14912

"line": 1,

14913

"description": "AreaSplineSeries renders an area graph with data points connected by a curve."

14914

},

14915

"Axis": {

14916

"name": "Axis",

14917

"shortname": "Axis",

14918

"classitems": [],

14919

"plugins": [],

14920

"extensions": [],

14921

"plugin_for": [],

14922

"extension_for": [],

14923

"module": "charts",

14924

"namespace": "",

14925

"file": "charts/js/Axis.js",

14926

"line": 1,

14927

"description": "The Axis class. Generates axes for a chart."

14928

},

14929

"AxisType": {

14930

"name": "AxisType",

14931

"shortname": "AxisType",

14932

"classitems": [],

14933

"plugins": [],

14934

"extensions": [],

14935

"plugin_for": [],

14936

"extension_for": [],

14937

"module": "charts",

14938

"namespace": "",

14939

"file": "charts/js/AxisType.js",

14940

"line": 1,

14941

"description": "AxisType is an abstract class that manages the data for an axis."

14942

},

14943

"BarSeries": {

14944

"name": "BarSeries",

14945

"shortname": "BarSeries",

14946

"classitems": [],

14947

"plugins": [],

14948

"extensions": [],

14949

"plugin_for": [],

14950

"extension_for": [],

14951

"module": "charts",

14952

"namespace": "",

14953

"file": "charts/js/BarSeries.js",

14954

"line": 1,

14955

"description": "The BarSeries class renders bars positioned vertically along a category or time axis. The bars'\nlengths are proportional to the values they represent along a horizontal axis.\nand the relevant data points."

14956

},

14957

"BottomAxisLayout": {

14958

"name": "BottomAxisLayout",

14959

"shortname": "BottomAxisLayout",

14960

"classitems": [],

14961

"plugins": [],

14962

"extensions": [],

14963

"plugin_for": [],

14964

"extension_for": [],

14965

"module": "charts",

14966

"namespace": "",

14967

"file": "charts/js/BottomAxisLayout.js",

14968

"line": 1,

14969

"description": "Contains algorithms for rendering a bottom axis."

14970

},

14971

"CartesianChart": {

14972

"name": "CartesianChart",

14973

"shortname": "CartesianChart",

14974

"classitems": [],

14975

"plugins": [],

14976

"extensions": [],

14977

"plugin_for": [],

14978

"extension_for": [],

14979

"module": "charts",

14980

"namespace": "",

14981

"file": "charts/js/CartesianChart.js",

14982

"line": 1,

14983

"description": "The CartesianChart class creates a chart with horizontal and vertical axes."

14984

},

14985

"HorizontalLegendLayout": {

14986

"name": "HorizontalLegendLayout",

14987

"shortname": "HorizontalLegendLayout",

14988

"classitems": [],

14989

"plugins": [],

14990

"extensions": [],

14991

"plugin_for": [],

14992

"extension_for": [],

14993

"module": "charts",

14994

"submodule": "charts-legend",

14995

"namespace": "",

14996

"file": "charts/js/CartesianChartLegend.js",

14997

"line": 48,

14998

"description": "Contains methods for displaying items horizontally in a legend."

14999

},

15000

"VerticalLegendLayout": {

15001

"name": "VerticalLegendLayout",

15002

"shortname": "VerticalLegendLayout",

15003

"classitems": [],

15004

"plugins": [],

15005

"extensions": [],

15006

"plugin_for": [],

15007

"extension_for": [],

15008

"module": "charts",

15009

"submodule": "charts-legend",

15010

"namespace": "",

15011

"file": "charts/js/CartesianChartLegend.js",

15012

"line": 207,

15013

"description": "Contains methods for displaying items vertically in a legend."

15014

},

15015

"CartesianSeries": {

15016

"name": "CartesianSeries",

15017

"shortname": "CartesianSeries",

15018

"classitems": [],

15019

"plugins": [],

15020

"extensions": [],

15021

"plugin_for": [],

15022

"extension_for": [],

15023

"module": "charts",

15024

"namespace": "",

15025

"file": "charts/js/CartesianSeries.js",

15026

"line": 1,

15027

"description": "The CartesianSeries class creates a chart with horizontal and vertical axes."

15028

},

15029

"CategoryAxis": {

15030

"name": "CategoryAxis",

15031

"shortname": "CategoryAxis",

15032

"classitems": [],

15033

"plugins": [],

15034

"extensions": [],

15035

"plugin_for": [],

15036

"extension_for": [],

15037

"module": "charts",

15038

"namespace": "",

15039

"file": "charts/js/CategoryAxis.js",

15040

"line": 1,

15041

"description": "CategoryAxis manages category data on an axis."

15042

},

15043

"Chart": {

15044

"name": "Chart",

15045

"shortname": "Chart",

15046

"classitems": [],

15047

"plugins": [],

15048

"extensions": [],

15049

"plugin_for": [],

15050

"extension_for": [],

15051

"module": "charts",

15052

"namespace": "",

15053

"file": "charts/js/Chart.js",

15054

"line": 1,

15055

"description": "The Chart class is the basic application used to create a chart."

15056

},

15057

"ChartBase": {

15058

"name": "ChartBase",

15059

"shortname": "ChartBase",

15060

"classitems": [],

15061

"plugins": [],

15062

"extensions": [],

15063

"plugin_for": [],

15064

"extension_for": [],

15065

"module": "charts",

15066

"namespace": "",

15067

"file": "charts/js/ChartBase.js",

15068

"line": 1,

15069

"description": "The ChartBase class is an abstract class used to create charts."

15070

},

15071

"ChartLegend": {

15072

"name": "ChartLegend",

15073

"shortname": "ChartLegend",

15074

"classitems": [],

15075

"plugins": [],

15076

"extensions": [],

15077

"plugin_for": [],

15078

"extension_for": [],

15079

"module": "charts",

15080

"namespace": "",

15081

"file": "charts/js/ChartLegend.js",

15082

"line": 1,

15083

"description": "ChartLegend provides a legend for a chart.",

15084

"submodule": "charts-legend",

15085

"extends": "Widget"

15086

},

15087

"GroupCircle": {

15088

"name": "GroupCircle",

15089

"shortname": "GroupCircle",

15090

"classitems": [],

15091

"plugins": [],

15092

"extensions": [],

15093

"plugin_for": [],

15094

"extension_for": [],

15095

"module": "graphics",

15096

"namespace": "",

15097

"file": "charts/js/CircleGroup.js",

15098

"line": 1,

15099

"description": "Abstract class for creating groups of circles with the same styles and dimensions."

15100

},

15101

"ColumnSeries": {

15102

"name": "ColumnSeries",

15103

"shortname": "ColumnSeries",

15104

"classitems": [],

15105

"plugins": [],

15106

"extensions": [],

15107

"plugin_for": [],

15108

"extension_for": [],

15109

"module": "charts",

15110

"namespace": "",

15111

"file": "charts/js/ColumnSeries.js",

15112

"line": 1,

15113

"description": "The ColumnSeries class renders columns positioned horizontally along a category or time axis. The columns'\nlengths are proportional to the values they represent along a vertical axis.\nand the relevant data points."

15114

},

15115

"ComboSeries": {

15116

"name": "ComboSeries",

15117

"shortname": "ComboSeries",

15118

"classitems": [],

15119

"plugins": [],

15120

"extensions": [],

15121

"plugin_for": [],

15122

"extension_for": [],

15123

"module": "charts",

15124

"namespace": "",

15125

"file": "charts/js/ComboSeries.js",

15126

"line": 1,

15127

"description": "The ComboSeries class renders a combination of lines, plots and area fills in a single series. Each\nseries type has a corresponding boolean attribute indicating if it is rendered. By default, lines and plots \nare rendered and area is not."

15128

},

15129

"ComboSplineSeries": {

15130

"name": "ComboSplineSeries",

15131

"shortname": "ComboSplineSeries",

15132

"classitems": [],

15133

"plugins": [],

15134

"extensions": [],

15135

"plugin_for": [],

15136

"extension_for": [],

15137

"module": "charts",

15138

"namespace": "",

15139

"file": "charts/js/ComboSplineSeries.js",

15140

"line": 1,

15141

"description": "The ComboSplineSeries class renders a combination of splines, plots and areaspline fills in a single series. Each\nseries type has a corresponding boolean attribute indicating if it is rendered. By default, splines and plots \nare rendered and areaspline is not."

15142

},

15143

"CurveUtil": {

15144

"name": "CurveUtil",

15145

"shortname": "CurveUtil",

15146

"classitems": [],

15147

"plugins": [],

15148

"extensions": [],

15149

"plugin_for": [],

15150

"extension_for": [],

15151

"module": "charts",

15152

"namespace": "",

15153

"file": "charts/js/CurveUtil.js",

15154

"line": 1,

15155

"description": "Utility class used for calculating curve points."

15156

},

15157

"GroupDiamond": {

15158

"name": "GroupDiamond",

15159

"shortname": "GroupDiamond",

15160

"classitems": [],

15161

"plugins": [],

15162

"extensions": [],

15163

"plugin_for": [],

15164

"extension_for": [],

15165

"module": "graphics",

15166

"namespace": "",

15167

"file": "charts/js/DiamondGroup.js",

15168

"line": 1,

15169

"description": "Abstract class for creating groups of diamonds with the same styles and dimensions."

15170

},

15171

"EllipseGroup": {

15172

"name": "EllipseGroup",

15173

"shortname": "EllipseGroup",

15174

"classitems": [],

15175

"plugins": [],

15176

"extensions": [],

15177

"plugin_for": [],

15178

"extension_for": [],

15179

"module": "graphics",

15180

"namespace": "",

15181

"file": "charts/js/EllipseGroup.js",

15182

"line": 1,

15183

"description": "Abstract class for creating groups of diamonds with the same styles and dimensions."

15184

},

15185

"Fills": {

15186

"name": "Fills",

15187

"shortname": "Fills",

15188

"classitems": [],

15189

"plugins": [],

15190

"extensions": [],

15191

"plugin_for": [],

15192

"extension_for": [],

15193

"module": "charts",

15194

"namespace": "",

15195

"file": "charts/js/Fills.js",

15196

"line": 1,

15197

"description": "Utility class used for drawing area fills."

15198

},

15199

"Graph": {

15200

"name": "Graph",

15201

"shortname": "Graph",

15202

"classitems": [],

15203

"plugins": [],

15204

"extensions": [],

15205

"plugin_for": [],

15206

"extension_for": [],

15207

"module": "charts",

15208

"namespace": "",

15209

"file": "charts/js/Graph.js",

15210

"line": 1,

15211

"description": "Graph manages and contains series instances for a `CartesianChart`\ninstance."

15212

},

15213

"Gridlines": {

15214

"name": "Gridlines",

15215

"shortname": "Gridlines",

15216

"classitems": [],

15217

"plugins": [],

15218

"extensions": [],

15219

"plugin_for": [],

15220

"extension_for": [],

15221

"module": "charts",

15222

"namespace": "",

15223

"file": "charts/js/Gridlines.js",

15224

"line": 1,

15225

"description": "Gridlines draws gridlines on a Graph."

15226

},

15227

"Histogram": {

15228

"name": "Histogram",

15229

"shortname": "Histogram",

15230

"classitems": [],

15231

"plugins": [],

15232

"extensions": [],

15233

"plugin_for": [],

15234

"extension_for": [],

15235

"module": "charts",

15236

"namespace": "",

15237

"file": "charts/js/Histogram.js",

15238

"line": 1,

15239

"description": "Histogram is the base class for Column and Bar series."

15240

},

15241

"LeftAxisLayout": {

15242

"name": "LeftAxisLayout",

15243

"shortname": "LeftAxisLayout",

15244

"classitems": [],

15245

"plugins": [],

15246

"extensions": [],

15247

"plugin_for": [],

15248

"extension_for": [],

15249

"module": "charts",

15250

"namespace": "",

15251

"file": "charts/js/LeftAxisLayout.js",

15252

"line": 1,

15253

"description": "Algorithmic strategy for rendering a left axis."

15254

},

15255

"LineSeries": {

15256

"name": "LineSeries",

15257

"shortname": "LineSeries",

15258

"classitems": [],

15259

"plugins": [],

15260

"extensions": [],

15261

"plugin_for": [],

15262

"extension_for": [],

15263

"module": "charts",

15264

"namespace": "",

15265

"file": "charts/js/LineSeries.js",

15266

"line": 1,

15267

"description": "The LineSeries class renders quantitative data on a graph by connecting relevant data points."

15268

},

15269

"Lines": {

15270

"name": "Lines",

15271

"shortname": "Lines",

15272

"classitems": [],

15273

"plugins": [],

15274

"extensions": [],

15275

"plugin_for": [],

15276

"extension_for": [],

15277

"module": "charts",

15278

"namespace": "",

15279

"file": "charts/js/Lines.js",

15280

"line": 1,

15281

"description": "Utility class used for drawing lines."

15282

},

15283

"MarkerSeries": {

15284

"name": "MarkerSeries",

15285

"shortname": "MarkerSeries",

15286

"classitems": [],

15287

"plugins": [],

15288

"extensions": [],

15289

"plugin_for": [],

15290

"extension_for": [],

15291

"module": "charts",

15292

"namespace": "",

15293

"file": "charts/js/MarkerSeries.js",

15294

"line": 1,

15295

"description": "The MarkerSeries class renders quantitative data by plotting relevant data points \non a graph."

15296

},

15297

"NumericAxis": {

15298

"name": "NumericAxis",

15299

"shortname": "NumericAxis",

15300

"classitems": [],

15301

"plugins": [],

15302

"extensions": [],

15303

"plugin_for": [],

15304

"extension_for": [],

15305

"module": "charts",

15306

"namespace": "",

15307

"file": "charts/js/NumericAxis.js",

15308

"line": 1,

15309

"description": "NumericAxis manages numeric data on an axis."

15310

},

15311

"PieChart": {

15312

"name": "PieChart",

15313

"shortname": "PieChart",

15314

"classitems": [],

15315

"plugins": [],

15316

"extensions": [],

15317

"plugin_for": [],

15318

"extension_for": [],

15319

"module": "charts",

15320

"namespace": "",

15321

"file": "charts/js/PieChart.js",

15322

"line": 1,

15323

"description": "The PieChart class creates a pie chart"

15324

},

15325

"PieSeries": {

15326

"name": "PieSeries",

15327

"shortname": "PieSeries",

15328

"classitems": [],

15329

"plugins": [],

15330

"extensions": [],

15331

"plugin_for": [],

15332

"extension_for": [],

15333

"module": "charts",

15334

"namespace": "",

15335

"file": "charts/js/PieSeries.js",

15336

"line": 1,

15337

"description": "PieSeries visualizes data as a circular chart divided into wedges which represent data as a \npercentage of a whole."

15338

},

15339

"Plots": {

15340

"name": "Plots",

15341

"shortname": "Plots",

15342

"classitems": [],

15343

"plugins": [],

15344

"extensions": [],

15345

"plugin_for": [],

15346

"extension_for": [],

15347

"module": "charts",

15348

"namespace": "",

15349

"file": "charts/js/Plots.js",

15350

"line": 1,

15351

"description": "Utility class used for drawing markers."

15352

},

15353

"GroupRect": {

15354

"name": "GroupRect",

15355

"shortname": "GroupRect",

15356

"classitems": [],

15357

"plugins": [],

15358

"extensions": [],

15359

"plugin_for": [],

15360

"extension_for": [],

15361

"module": "graphics",

15362

"namespace": "",

15363

"file": "charts/js/RectGroup.js",

15364

"line": 1,

15365

"description": "Abstract class for creating groups of rects with the same styles and dimensions."

15366

},

15367

"Renderer": {

15368

"name": "Renderer",

15369

"shortname": "Renderer",

15370

"classitems": [],

15371

"plugins": [],

15372

"extensions": [],

15373

"plugin_for": [],

15374

"extension_for": [],

15375

"module": "charts",

15376

"namespace": "",

15377

"file": "charts/js/Renderer.js",

15378

"line": 1,

15379

"description": "The Renderer class is a base class for chart components that use the `styles`\nattribute."

15380

},

15381

"RightAxisLayout": {

15382

"name": "RightAxisLayout",

15383

"shortname": "RightAxisLayout",

15384

"classitems": [],

15385

"plugins": [],

15386

"extensions": [],

15387

"plugin_for": [],

15388

"extension_for": [],

15389

"module": "charts",

15390

"namespace": "",

15391

"file": "charts/js/RightAxisLayout.js",

15392

"line": 1,

15393

"description": "RightAxisLayout contains algorithms for rendering a right axis."

15394

},

15395

"ShapeGroup": {

15396

"name": "ShapeGroup",

15397

"shortname": "ShapeGroup",

15398

"classitems": [],

15399

"plugins": [],

15400

"extensions": [],

15401

"plugin_for": [],

15402

"extension_for": [],

15403

"module": "graphics",

15404

"namespace": "",

15405

"file": "charts/js/ShapeGroup.js",

15406

"line": 25,

15407

"description": "Abstract class for creating groups of shapes with the same styles and dimensions."

15408

},

15409

"SplineSeries": {

15410

"name": "SplineSeries",

15411

"shortname": "SplineSeries",

15412

"classitems": [],

15413

"plugins": [],

15414

"extensions": [],

15415

"plugin_for": [],

15416

"extension_for": [],

15417

"module": "charts",

15418

"namespace": "",

15419

"file": "charts/js/SplineSeries.js",

15420

"line": 1,

15421

"description": "SplineSeries renders a graph with data points connected by a curve."

15422

},

15423

"StackedAreaSeries": {

15424

"name": "StackedAreaSeries",

15425

"shortname": "StackedAreaSeries",

15426

"classitems": [],

15427

"plugins": [],

15428

"extensions": [],

15429

"plugin_for": [],

15430

"extension_for": [],

15431

"module": "charts",

15432

"namespace": "",

15433

"file": "charts/js/StackedAreaSeries.js",

15434

"line": 1,

15435

"description": "StackedAreaSeries area fills to display data showing its contribution to a whole."

15436

},

15437

"StackedAreaSplineSeries": {

15438

"name": "StackedAreaSplineSeries",

15439

"shortname": "StackedAreaSplineSeries",

15440

"classitems": [],

15441

"plugins": [],

15442

"extensions": [],

15443

"plugin_for": [],

15444

"extension_for": [],

15445

"module": "charts",

15446

"namespace": "",

15447

"file": "charts/js/StackedAreaSplineSeries.js",

15448

"line": 1,

15449

"description": "StackedAreaSplineSeries creates a stacked area chart with points data points connected by a curve."

15450

},

15451

"StackedAxis": {

15452

"name": "StackedAxis",

15453

"shortname": "StackedAxis",

15454

"classitems": [],

15455

"plugins": [],

15456

"extensions": [],

15457

"plugin_for": [],

15458

"extension_for": [],

15459

"module": "charts",

15460

"namespace": "",

15461

"file": "charts/js/StackedAxis.js",

15462

"line": 1,

15463

"description": "StackedAxis manages stacked numeric data on an axis."

15464

},

15465

"StackedBarSeries": {

15466

"name": "StackedBarSeries",

15467

"shortname": "StackedBarSeries",

15468

"classitems": [],

15469

"plugins": [],

15470

"extensions": [],

15471

"plugin_for": [],

15472

"extension_for": [],

15473

"module": "charts",

15474

"namespace": "",

15475

"file": "charts/js/StackedBarSeries.js",

15476

"line": 1,

15477

"description": "The StackedBarSeries renders bar chart in which series are stacked horizontally to show\ntheir contribution to the cumulative total."

15478

},

15479

"StackedColumnSeries": {

15480

"name": "StackedColumnSeries",

15481

"shortname": "StackedColumnSeries",

15482

"classitems": [],

15483

"plugins": [],

15484

"extensions": [],

15485

"plugin_for": [],

15486

"extension_for": [],

15487

"module": "charts",

15488

"namespace": "",

15489

"file": "charts/js/StackedColumnSeries.js",

15490

"line": 1,

15491

"description": "The StackedColumnSeries renders column chart in which series are stacked vertically to show\ntheir contribution to the cumulative total."

15492

},

15493

"StackedComboSeries": {

15494

"name": "StackedComboSeries",

15495

"shortname": "StackedComboSeries",

15496

"classitems": [],

15497

"plugins": [],

15498

"extensions": [],

15499

"plugin_for": [],

15500

"extension_for": [],

15501

"module": "charts",

15502

"namespace": "",

15503

"file": "charts/js/StackedComboSeries.js",

15504

"line": 1,

15505

"description": "The StackedComboSeries class renders a combination of lines, plots and area fills in a single series. Series\nare stacked along the value axis to indicate each series contribution to a cumulative total. Each\nseries type has a corresponding boolean attribute indicating if it is rendered. By default, all three types are\nrendered."

15506

},

15507

"StackedComboSplineSeries": {

15508

"name": "StackedComboSplineSeries",

15509

"shortname": "StackedComboSplineSeries",

15510

"classitems": [],

15511

"plugins": [],

15512

"extensions": [],

15513

"plugin_for": [],

15514

"extension_for": [],

15515

"module": "charts",

15516

"namespace": "",

15517

"file": "charts/js/StackedComboSplineSeries.js",

15518

"line": 1,

15519

"description": "The StackedComboSplineSeries class renders a combination of splines, plots and areaspline fills in a single series. Series\nare stacked along the value axis to indicate each series contribution to a cumulative total. Each\nseries type has a corresponding boolean attribute indicating if it is rendered. By default, all three types are\nrendered."

15520

},

15521

"StackedLineSeries": {

15522

"name": "StackedLineSeries",

15523

"shortname": "StackedLineSeries",

15524

"classitems": [],

15525

"plugins": [],

15526

"extensions": [],

15527

"plugin_for": [],

15528

"extension_for": [],

15529

"module": "charts",

15530

"namespace": "",

15531

"file": "charts/js/StackedLineSeries.js",

15532

"line": 1,

15533

"description": "StackedLineSeries creates line graphs in which the different series are stacked along a value axis\nto indicate their contribution to a cumulative total."

15534

},

15535

"StackedMarkerSeries": {

15536

"name": "StackedMarkerSeries",

15537

"shortname": "StackedMarkerSeries",

15538

"classitems": [],

15539

"plugins": [],

15540

"extensions": [],

15541

"plugin_for": [],

15542

"extension_for": [],

15543

"module": "charts",

15544

"namespace": "",

15545

"file": "charts/js/StackedMarkerSeries.js",

15546

"line": 1,

15547

"description": "StackedMarkerSeries plots markers with different series stacked along the value axis to indicate each\nseries' contribution to a cumulative total."

15548

},

15549

"StackedSplineSeries": {

15550

"name": "StackedSplineSeries",

15551

"shortname": "StackedSplineSeries",

15552

"classitems": [],

15553

"plugins": [],

15554

"extensions": [],

15555

"plugin_for": [],

15556

"extension_for": [],

15557

"module": "charts",

15558

"namespace": "",

15559

"file": "charts/js/StackedSplineSeries.js",

15560

"line": 1,

15561

"description": "StackedSplineSeries creates spline graphs in which the different series are stacked along a value axis\nto indicate their contribution to a cumulative total."

15562

},

15563

"StackingUtil": {

15564

"name": "StackingUtil",

15565

"shortname": "StackingUtil",

15566

"classitems": [],

15567

"plugins": [],

15568

"extensions": [],

15569

"plugin_for": [],

15570

"extension_for": [],

15571

"module": "charts",

15572

"namespace": "",

15573

"file": "charts/js/StackingUtil.js",

15574

"line": 1,

15575

"description": "Utility class used for creating stacked series."

15576

},

15577

"TimeAxis": {

15578

"name": "TimeAxis",

15579

"shortname": "TimeAxis",

15580

"classitems": [],

15581

"plugins": [],

15582

"extensions": [],

15583

"plugin_for": [],

15584

"extension_for": [],

15585

"module": "charts",

15586

"namespace": "",

15587

"file": "charts/js/TimeAxis.js",

15588

"line": 1,

15589

"description": "TimeAxis manages time data on an axis."

15590

},

15591

"TopAxisLayout": {

15592

"name": "TopAxisLayout",

15593

"shortname": "TopAxisLayout",

15594

"classitems": [],

15595

"plugins": [],

15596

"extensions": [],

15597

"plugin_for": [],

15598

"extension_for": [],

15599

"module": "charts",

15600

"namespace": "",

15601

"file": "charts/js/TopAxisLayout.js",

15602

"line": 1,

15603

"description": "Contains algorithms for rendering a top axis."

15604

},

15605

"ClassNameManager": {

15606

"name": "ClassNameManager",

15607

"shortname": "ClassNameManager",

15608

"classitems": [],

15609

"plugins": [],

15610

"extensions": [],

15611

"plugin_for": [],

15612

"extension_for": [],

15613

"module": "classnamemanager",

15614

"namespace": "",

15615

"file": "classnamemanager/js/classnamemanager.js",

15616

"line": 7,

15617

"description": "A singleton class providing: \n\n<ul>\n <li>Easy creation of prefixed class names</li>\n <li>Caching of previously created class names for improved performance.</li>\n</ul>",

15618

"static": 1

15619

},

15620

"Array": {

15621

"name": "Array",

15622

"shortname": "Array",

15623

"classitems": [],

15624

"plugins": [],

15625

"extensions": [],

15626

"plugin_for": [],

15627

"extension_for": [],

15628

"module": "yui",

15629

"submodule": "yui-base",

15630

"namespace": "",

15631

"file": "yui/js/yui-array.js",

15632

"line": 11,

15633

"description": "Provides utility methods for working with arrays. Additional array helpers can\nbe found in the `collection` and `array-extras` modules.\n\n`Y.Array(thing)` returns a native array created from _thing_. Depending on\n_thing_'s type, one of the following will happen:\n\n * Arrays are returned unmodified unless a non-zero _startIndex_ is\n specified.\n * Array-like collections (see `Array.test()`) are converted to arrays.\n * For everything else, a new array is created with _thing_ as the sole\n item.\n\nNote: elements that are also collections, such as `<form>` and `<select>`\nelements, are not automatically converted to arrays. To force a conversion,\npass `true` as the value of the _force_ parameter.",

15634

"is_constructor": 1,

15635

"params": [

15636

{

15637

"name": "thing",

15638

"description": "The thing to arrayify.",

15639

"type": "Any"

15640

},

15641

{

15642

"name": "startIndex",

15643

"description": "If non-zero and _thing_ is an array or array-like\n collection, a subset of items starting at the specified index will be\n returned.",

15644

"type": "Number",

15645

"optional": true,

15646

"optdefault": "0"

15647

},

15648

{

15649

"name": "force",

15650

"description": "If `true`, _thing_ will be treated as an\n array-like collection no matter what.",

15651

"type": "Boolean",

15652

"optional": true,

15653

"optdefault": "false"

15654

}

15655

],

15656

"return": {

15657

"description": "A native array created from _thing_, according to the rules\n described above.",

15658

"type": "Array"

15659

}

15660

},

15661

"ArrayList": {

15662

"name": "ArrayList",

15663

"shortname": "ArrayList",

15664

"classitems": [],

15665

"plugins": [],

15666

"extensions": [],

15667

"plugin_for": [],

15668

"extension_for": [

15669

"ModelList",

15670

"Recordset",

15671

"WidgetParent"

15672

],

15673

"module": "collection",

15674

"submodule": "arraylist",

15675

"namespace": "",

15676

"file": "collection/js/arraylist.js",

15677

"line": 11,

15678

"description": "Generic ArrayList class for managing lists of items and iterating operations\nover them. The targeted use for this class is for augmentation onto a\nclass that is responsible for managing multiple instances of another class\n(e.g. NodeList for Nodes). The recommended use is to augment your class with\nArrayList, then use ArrayList.addMethod to mirror the API of the constituent\nitems on the list's API.\n\nThe default implementation creates immutable lists, but mutability can be\nprovided via the arraylist-add submodule or by implementing mutation methods\ndirectly on the augmented class's prototype.",

15679

"is_constructor": 1,

15680

"params": [

15681

{

15682

"name": "items",

15683

"description": "array of items this list will be responsible for",

15684

"type": "Array"

15685

}

15686

]

15687

},

15688

"Plugin.ConsoleFilters": {

15689

"name": "Plugin.ConsoleFilters",

15690

"shortname": "Plugin.ConsoleFilters",

15691

"classitems": [],

15692

"plugins": [],

15693

"extensions": [],

15694

"plugin_for": [],

15695

"extension_for": [],

15696

"module": "console-filters",

15697

"namespace": "Plugin",

15698

"file": "console-filters/js/console-filters.js",

15699

"line": 1,

15700

"description": "Provides Plugin.ConsoleFilters plugin class.\n\nThis plugin adds the ability to control which Console entries display by filtering on category and source. Two groups of checkboxes are added to the Console footer, one for categories and the other for sources. Only those messages that match a checked category or source are displayed."

15701

},

15702

"Console": {

15703

"name": "Console",

15704

"shortname": "Console",

15705

"classitems": [],

15706

"plugins": [],

15707

"extensions": [],

15708

"plugin_for": [],

15709

"extension_for": [],

15710

"module": "console",

15711

"namespace": "",

15712

"file": "console/js/console.js",

15713

"line": 1,

15714

"description": "Console creates a visualization for messages logged through calls to a YUI\ninstance's <code>Y.log( message, category, source )</code> method. The\ndebug versions of YUI modules will include logging statements to offer some\ninsight into the steps executed during that module's operation. Including\nlog statements in your code will cause those messages to also appear in the\nConsole. Use Console to aid in developing your page or application.\n\nEntry categories "info", "warn", and "error"\nare also referred to as the log level, and entries are filtered against the\nconfigured logLevel."

15715

},

15716

"Cookie": {

15717

"name": "Cookie",

15718

"shortname": "Cookie",

15719

"classitems": [],

15720

"plugins": [],

15721

"extensions": [],

15722

"plugin_for": [],

15723

"extension_for": [],

15724

"module": "cookie",

15725

"namespace": "",

15726

"file": "cookie/js/Cookie.js",

15727

"line": 47,

15728

"description": "Cookie utility.",

15729

"static": 1

15730

},

15731

"DataSchema.Array": {

15732

"name": "DataSchema.Array",

15733

"shortname": "DataSchema.Array",

15734

"classitems": [],

15735

"plugins": [],

15736

"extensions": [],

15737

"plugin_for": [],

15738

"extension_for": [],

15739

"module": "dataschema",

15740

"submodule": "dataschema-array",

15741

"namespace": "",

15742

"file": "dataschema/js/dataschema-array.js",

15743

"line": 9,

15744

"description": "Provides a DataSchema implementation which can be used to work with data\nstored in arrays.\n\nSee the `apply` method below for usage.",

15745

"extends": "DataSchema.Base",

15746

"static": 1

15747

},

15748

"DataSchema.Base": {

15749

"name": "DataSchema.Base",

15750

"shortname": "DataSchema.Base",

15751

"classitems": [],

15752

"plugins": [],

15753

"extensions": [],

15754

"plugin_for": [],

15755

"extension_for": [],

15756

"module": "dataschema",

15757

"submodule": "dataschema-base",

15758

"namespace": "",

15759

"file": "dataschema/js/dataschema-base.js",

15760

"line": 19,

15761

"description": "Base class for the YUI DataSchema Utility.",

15762

"static": 1

15763

},

15764

"DataSchema.JSON": {

15765

"name": "DataSchema.JSON",

15766

"shortname": "DataSchema.JSON",

15767

"classitems": [],

15768

"plugins": [],

15769

"extensions": [],

15770

"plugin_for": [],

15771

"extension_for": [],

15772

"module": "dataschema",

15773

"submodule": "dataschema-json",

15774

"namespace": "",

15775

"file": "dataschema/js/dataschema-json.js",

15776

"line": 8,

15777

"description": "Provides a DataSchema implementation which can be used to work with JSON data.\n\nSee the `apply` method for usage.",

15778

"extends": "DataSchema.Base",

15779

"static": 1

15780

},

15781

"DataSchema.Text": {

15782

"name": "DataSchema.Text",

15783

"shortname": "DataSchema.Text",

15784

"classitems": [],

15785

"plugins": [],

15786

"extensions": [],

15787

"plugin_for": [],

15788

"extension_for": [],

15789

"module": "dataschema",

15790

"submodule": "dataschema-text",

15791

"namespace": "",

15792

"file": "dataschema/js/dataschema-text.js",

15793

"line": 9,

15794

"description": "Provides a DataSchema implementation which can be used to work with\ndelimited text data.\n\nSee the `apply` method for usage.",

15795

"extends": "DataSchema.Base",

15796

"static": 1

15797

},

15798

"DataSchema.XML": {

15799

"name": "DataSchema.XML",

15800

"shortname": "DataSchema.XML",

15801

"classitems": [],

15802

"plugins": [],

15803

"extensions": [],

15804

"plugin_for": [],

15805

"extension_for": [],

15806

"module": "dataschema",

15807

"submodule": "dataschema-xml",

15808

"namespace": "",

15809

"file": "dataschema/js/dataschema-xml.js",

15810

"line": 8,

15811

"description": "Provides a DataSchema implementation which can be used to work with XML data.\n\nSee the `apply` method for usage.",

15812

"extends": "DataSchema.Base",

15813

"static": 1

15814

},

15815

"DataSourceArraySchema": {

15816

"name": "DataSourceArraySchema",

15817

"shortname": "DataSourceArraySchema",

15818

"classitems": [],

15819

"plugins": [],

15820

"extensions": [],

15821

"plugin_for": [],

15822

"extension_for": [],

15823

"module": "datasource",

15824

"submodule": "datasource-arrayschema",

15825

"namespace": "",

15826

"file": "datasource/js/datasource-arrayschema.js",

15827

"line": 8,

15828

"description": "Adds schema-parsing to the DataSource Utility.",

15829

"extends": "Plugin.Base"

15830

},

15831

"DataSourceCacheExtension": {

15832

"name": "DataSourceCacheExtension",

15833

"shortname": "DataSourceCacheExtension",

15834

"classitems": [],

15835

"plugins": [],

15836

"extensions": [],

15837

"plugin_for": [],

15838

"extension_for": [],

15839

"module": "datasource",

15840

"submodule": "datasource-cache",

15841

"namespace": "",

15842

"file": "datasource/js/datasource-cache.js",

15843

"line": 8,

15844

"description": "DataSourceCache extension binds Cache to DataSource."

15845

},

15846

"DataSourceCache": {

15847

"name": "DataSourceCache",

15848

"shortname": "DataSourceCache",

15849

"classitems": [],

15850

"plugins": [],

15851

"extensions": [],

15852

"plugin_for": [],

15853

"extension_for": [],

15854

"module": "datasource",

15855

"submodule": "datasource-cache",

15856

"namespace": "",

15857

"file": "datasource/js/datasource-cache.js",

15858

"line": 121,

15859

"description": "DataSource plugin adds cache functionality.",

15860

"extends": "Cache",

15861

"uses": [

15862

"Plugin.Base",

15863

"DataSourceCachePlugin"

15864

]

15865

},

15866

"DataSource.Function": {

15867

"name": "DataSource.Function",

15868

"shortname": "DataSource.Function",

15869

"classitems": [],

15870

"plugins": [],

15871

"extensions": [],

15872

"plugin_for": [],

15873

"extension_for": [],

15874

"module": "datasource",

15875

"submodule": "datasource-function",

15876

"namespace": "",

15877

"file": "datasource/js/datasource-function.js",

15878

"line": 8,

15879

"description": "Function subclass for the DataSource Utility.",

15880

"extends": "DataSource.Local",

15881

"is_constructor": 1

15882

},

15883

"DataSource.Get": {

15884

"name": "DataSource.Get",

15885

"shortname": "DataSource.Get",

15886

"classitems": [],

15887

"plugins": [],

15888

"extensions": [],

15889

"plugin_for": [],

15890

"extension_for": [],

15891

"module": "datasource",

15892

"submodule": "datasource-get",

15893

"namespace": "",

15894

"file": "datasource/js/datasource-get.js",

15895

"line": 8,

15896

"description": "Get Utility subclass for the DataSource Utility.",

15897

"extends": "DataSource.Local",

15898

"is_constructor": 1

15899

},

15900

"DataSource.IO": {

15901

"name": "DataSource.IO",

15902

"shortname": "DataSource.IO",

15903

"classitems": [],

15904

"plugins": [],

15905

"extensions": [],

15906

"plugin_for": [],

15907

"extension_for": [],

15908

"module": "datasource",

15909

"submodule": "datasource-io",

15910

"namespace": "",

15911

"file": "datasource/js/datasource-io.js",

15912

"line": 8,

15913

"description": "IO subclass for the DataSource Utility.",

15914

"extends": "DataSource.Local",

15915

"is_constructor": 1

15916

},

15917

"DataSourceJSONSchema": {

15918

"name": "DataSourceJSONSchema",

15919

"shortname": "DataSourceJSONSchema",

15920

"classitems": [],

15921

"plugins": [],

15922

"extensions": [],

15923

"plugin_for": [],

15924

"extension_for": [],

15925

"module": "datasource",

15926

"submodule": "datasource-jsonschema",

15927

"namespace": "",

15928

"file": "datasource/js/datasource-jsonschema.js",

15929

"line": 8,

15930

"description": "Adds schema-parsing to the DataSource Utility.",

15931

"extends": "Plugin.Base"

15932

},

15933

"DataSource.Local": {

15934

"name": "DataSource.Local",

15935

"shortname": "DataSource.Local",

15936

"classitems": [],

15937

"plugins": [],

15938

"extensions": [],

15939

"plugin_for": [],

15940

"extension_for": [],

15941

"module": "datasource",

15942

"submodule": "datasource-local",

15943

"namespace": "",

15944

"file": "datasource/js/datasource-local.js",

15945

"line": 18,

15946

"description": "Base class for the DataSource Utility.",

15947

"extends": "Base",

15948

"is_constructor": 1

15949

},

15950

"Pollable": {

15951

"name": "Pollable",

15952

"shortname": "Pollable",

15953

"classitems": [],

15954

"plugins": [],

15955

"extensions": [],

15956

"plugin_for": [],

15957

"extension_for": [],

15958

"module": "datasource",

15959

"submodule": "datasource-polling",

15960

"namespace": "",

15961

"file": "datasource/js/datasource-polling.js",

15962

"line": 8,

15963

"description": "Adds polling to the DataSource Utility.",

15964

"extends": "DataSource.Local"

15965

},

15966

"DataSourceTextSchema": {

15967

"name": "DataSourceTextSchema",

15968

"shortname": "DataSourceTextSchema",

15969

"classitems": [],

15970

"plugins": [],

15971

"extensions": [],

15972

"plugin_for": [],

15973

"extension_for": [],

15974

"module": "datasource",

15975

"submodule": "datasource-textschema",

15976

"namespace": "",

15977

"file": "datasource/js/datasource-textschema.js",

15978

"line": 8,

15979

"description": "Adds schema-parsing to the DataSource Utility.",

15980

"extends": "Plugin.Base"

15981

},

15982

"DataSourceXMLSchema": {

15983

"name": "DataSourceXMLSchema",

15984

"shortname": "DataSourceXMLSchema",

15985

"classitems": [],

15986

"plugins": [],

15987

"extensions": [],

15988

"plugin_for": [],

15989

"extension_for": [],

15990

"module": "datasource",

15991

"submodule": "datasource-xmlschema",

15992

"namespace": "",

15993

"file": "datasource/js/datasource-xmlschema.js",

15994

"line": 8,

15995

"description": "Adds schema-parsing to the DataSource Utility.",

15996

"extends": "Plugin.Base"

15997

},

15998

"DataTable": {

15999

"name": "DataTable",

16000

"shortname": "DataTable",

16001

"classitems": [],

16002

"plugins": [],

16003

"extensions": [],

16004

"plugin_for": [],

16005

"extension_for": [],

16006

"module": "datatable",

16007

"submodule": "datatable-base",

16008

"namespace": "",

16009

"file": "datatable/js/base.js",

16010

"line": 16,

16011

"description": "A Widget for displaying tabular data. Before feature modules are `use()`d,\nthis class is functionally equivalent to DataTable.Base. However, feature\nmodules can modify this class in non-destructive ways, expanding the API and\nfunctionality.\n\nThis is the primary DataTable class. Out of the box, it provides the ability\nto dynamically generate an HTML table from a set of column configurations and\nrow data. But feature module inclusion can add table sorting, pagintaion,\nhighlighting, selection, and more.\n\n<pre><code>\n// The functionality of this table would require additional modules be use()d,\n// but the feature APIs are aggregated onto Y.DataTable.\n// (Snippet is for illustration. Not all features are available today.)\nvar table = new Y.DataTable({\n columns: [\n { type: 'checkbox', defaultChecked: true },\n { key: 'firstName', sortable: true, resizable: true },\n { key: 'lastName', sortable: true },\n { key: 'role', formatter: toRoleName }\n ],\n data: {\n source: 'http://myserver.com/service/json',\n type: 'json',\n schema: {\n resultListLocator: 'results.users',\n fields: [\n 'username',\n 'firstName',\n 'lastName',\n { key: 'role', type: 'number' }\n ]\n }\n },\n recordType: UserModel,\n pagedData: {\n location: 'footer',\n pageSizes: [20, 50, 'all'],\n rowsPerPage: 20,\n pageLinks: 5\n },\n editable: true\n});\n</code></pre>\n\n### Column Configuration\n\nThe column configurations are set in the form of an array of objects, where\neach object corresponds to a column. For columns populated directly from the\nrow data, a 'key' property is required to bind the column to that property or\nattribute in the row data.\n\nNot all columns need to relate to row data, nor do all properties or attributes\nof the row data need to have a corresponding column. However, only those\ncolumns included in the `columns` configuration attribute will be rendered.\n\nOther column configuration properties are supported by the configured\n`headerView`, `bodyView`, `footerView` classes as well as any features added by\nplugins or class extensions. See the description of DataTable.HeaderView,\nDataTable.BodyView, and other DataTable feature classes to see what column\nproperties they support.\n\nSome examples of column configurations would be:\n\n<pre><code>\n// Basic\nvar columns = [{ key: 'firstName' }, { key: 'lastName' }, { key: 'age' }];\n\n// For columns without any additional configuration, strings can be used\nvar columns = ['firstName', 'lastName', 'age'];\n\n// Multi-row column headers (see DataTable.HeaderView for details)\nvar columns = [\n {\n label: 'Name',\n children: [\n { key: 'firstName' },\n { key: 'lastName' }\n ]\n },\n 'age' // mixing and matching objects and strings is ok\n];\n\n// Including columns that are not related 1:1 to row data fields/attributes\n// (See DataTable.BodyView for details)\nvar columns = [\n {\n label: 'Name', // Needed for the column header\n formatter: function (o) {\n // Fill the column cells with data from firstName and lastName\n if (o.data.age > 55) {\n o.className += ' senior';\n }\n return o.data.lastName + ', ' + o.data.firstName;\n }\n },\n 'age'\n];\n\n// Columns that include feature configurations (for illustration; not all\n// features are available today).\nvar columns = [\n { type: 'checkbox', defaultChecked: true },\n { key: 'firstName', sortable: true, resizable: true, min-width: '300px' },\n { key: 'lastName', sortable: true, resizable: true, min-width: '300px' },\n { key: 'age', emptyCellValue: 'unknown' }\n];\n</code></pre>\n\n### Row Data Configuration\n\nThe `data` configuration attribute is responsible for housing the data objects that will be rendered as rows. You can provide this information in two ways by default:\n\n1. An array of simple objects with key:value pairs\n2. A ModelList of Base-based class instances (presumably Model subclass\n instances)\n\nIf an array of objects is passed, it will be translated into a ModelList filled\nwith instances of the class provided to the `recordType` attribute. This\nattribute can also create a custom Model subclass from an array of field names\nor an object of attribute configurations. If no `recordType` is provided, one\nwill be created for you from available information (see `_initRecordType`).\nProviding either your own ModelList instance for `data`, or at least Model\nclass for `recordType`, is the best way to control client-server\nsynchronization when modifying data on the client side.\n\nThe ModelList instance that manages the table's data is available in the `data`\nproperty on the DataTable instance.\n\n\n### Rendering\n\nTable rendering is a collaborative process between the DataTable and its\nconfigured `headerView`, `bodyView`, and `footerView`. The DataTable renders\nthe `<table>` and `<caption>`, but the contents of the table are delegated to\ninstances of the classes provided to the `headerView`, `bodyView`, and\n`footerView` attributes. If any of these attributes is unset, that portion of\nthe table won't be rendered.\n\nDataTable.Base assigns the default `headerView` to `Y.DataTable.HeaderView` and\nthe default `bodyView` to `Y.DataTable.BodyView`, though either can be\noverridden for custom rendering. No default `footerView` is assigned. See\nthose classes for more details about how they operate.",

16012

"extends": "DataTable.Base",

16013

"since": "3.5.0"

16014

},

16015

"DataTable.Base": {

16016

"name": "DataTable.Base",

16017

"shortname": "DataTable.Base",

16018

"classitems": [],

16019

"plugins": [],

16020

"extensions": [],

16021

"plugin_for": [],

16022

"extension_for": [],

16023

"module": "datatable",

16024

"submodule": "datatable-base",

16025

"namespace": "DataTable",

16026

"file": "datatable/js/base.js",

16027

"line": 168,

16028

"description": "The baseline implementation of a DataTable. This class should be used\nprimarily as a superclass for a custom DataTable with a specific set of\nfeatures. Because features can be composed onto `Y.DataTable`, custom\nsubclasses of DataTable.Base will remain unmodified when new feature modules\nare loaded.\n\nExample usage might look like this:\n\n<pre><code>\n// Custom subclass with only sorting and mutability added. If other datatable\n// feature modules are loaded, this class will not be affected.\nvar MyTableClass = Y.Base.create('table', Y.DataTable.Base,\n [ Y.DataTable.Sort, Y.DataTable.Mutable ]);\n\nvar table = new MyTableClass({\n columns: ['firstName', 'lastName', 'age'],\n data: [\n { firstName: 'Frank', lastName: 'Zappa', age: 71 },\n { firstName: 'Frank', lastName: 'Lloyd Wright', age: 144 },\n { firstName: 'Albert', lastName: 'Einstein', age: 132 },\n ...\n ]\n});\n\ntable.render('#over-there');\n\n// DataTable.Base can be instantiated if a featureless table is needed.\nvar table = new Y.DataTable.Base({\n columns: ['firstName', 'lastName', 'age'],\n data: [\n { firstName: 'Frank', lastName: 'Zappa', age: 71 },\n { firstName: 'Frank', lastName: 'Lloyd Wright', age: 144 },\n { firstName: 'Albert', lastName: 'Einstein', age: 132 },\n ...\n ]\n});\n\ntable.render('#in-here');\n</code></pre>\n\nDataTable.Base is built from DataTable.Core, and sets the default `headerView`\nto `Y.DataTable.HeaderView` and default `bodyView` to `Y.DataTable.BodyView`.",

16029

"extends": "Widget",

16030

"uses": [

16031

"DataTable.Core"

16032

],

16033

"since": "3.5.0"

16034

},

16035

"DataTable.BodyView": {

16036

"name": "DataTable.BodyView",

16037

"shortname": "DataTable.BodyView",

16038

"classitems": [],

16039

"plugins": [],

16040

"extensions": [],

16041

"plugin_for": [],

16042

"extension_for": [],

16043

"module": "datatable",

16044

"submodule": "datatable-body",

16045

"namespace": "DataTable",

16046

"file": "datatable/js/body.js",

16047

"line": 22,

16048

"description": "View class responsible for rendering the `<tbody>` section of a table. Used as\nthe default `bodyView` for `Y.DataTable.Base` and `Y.DataTable` classes.\n\nTranslates the provided `modelList` into a rendered `<tbody>` based on the data\nin the constituent Models, altered or ammended by any special column\nconfigurations.\n\nThe `columns` configuration, passed to the constructor, determines which\ncolumns will be rendered.\n\nThe rendering process involves constructing an HTML template for a complete row\nof data, built by concatenating a customized copy of the instance's\n`CELL_TEMPLATE` into the `ROW_TEMPLATE` once for each column. This template is\nthen populated with values from each Model in the `modelList`, aggregating a\ncomplete HTML string of all row and column data. A `<tbody>` Node is then created from the markup and any column `nodeFormatter`s are applied.\n\nSupported properties of the column objects include:\n\n * `key` - Used to link a column to an attribute in a Model.\n * `name` - Used for columns that don't relate to an attribute in the Model\n (`formatter` or `nodeFormatter` only) if the implementer wants a\n predictable name to refer to in their CSS.\n * `cellTemplate` - Overrides the instance's `CELL_TEMPLATE` for cells in this\n column only.\n * `formatter` - Used to customize or override the content value from the\n Model. These do not have access to the cell or row Nodes and should\n return string (HTML) content.\n * `nodeFormatter` - Used to provide content for a cell as well as perform any\n custom modifications on the cell or row Node that could not be performed by\n `formatter`s. Should be used sparingly for better performance.\n * `emptyCellValue` - String (HTML) value to use if the Model data for a\n column, or the content generated by a `formatter`, is the empty string,\n `null`, or `undefined`.\n * `allowHTML` - Set to `true` if a column value, `formatter`, or\n `emptyCellValue` can contain HTML. This defaults to `false` to protect\n against XSS.\n * `className` - Space delimited CSS classes to add to all `<td>`s in a column.\n\nColumn `formatter`s are passed an object (`o`) with the following properties:\n\n * `value` - The current value of the column's associated attribute, if any.\n * `data` - An object map of Model keys to their current values.\n * `record` - The Model instance.\n * `column` - The column configuration object for the current column.\n * `className` - Initially empty string to allow `formatter`s to add CSS \n classes to the cell's `<td>`.\n * `rowIndex` - The zero-based row number.\n * `rowClass` - Initially empty string to allow `formatter`s to add CSS\n classes to the cell's containing row `<tr>`.\n\nThey may return a value or update `o.value` to assign specific HTML content. A\nreturned value has higher precedence.\n\nColumn `nodeFormatter`s are passed an object (`o`) with the following\nproperties:\n\n * `value` - The current value of the column's associated attribute, if any.\n * `td` - The `<td>` Node instance.\n * `cell` - The `<div>` liner Node instance if present, otherwise, the `<td>`.\n When adding content to the cell, prefer appending into this property.\n * `data` - An object map of Model keys to their current values.\n * `record` - The Model instance.\n * `column` - The column configuration object for the current column.\n * `rowIndex` - The zero-based row number.\n\nThey are expected to inject content into the cell's Node directly, including\nany \"empty\" cell content. Each `nodeFormatter` will have access through the\nNode API to all cells and rows in the `<tbody>`, but not to the `<table>`, as\nit will not be attached yet.\n\nIf a `nodeFormatter` returns `false`, the `o.td` and `o.cell` Nodes will be\n`destroy()`ed to remove them from the Node cache and free up memory. The DOM\nelements will remain as will any content added to them. _It is highly\nadvisable to always return `false` from your `nodeFormatter`s_.",

16049

"extends": "View",

16050

"since": "3.5.0"

16051

},

16052

"DataTable.ColumnWidths": {

16053

"name": "DataTable.ColumnWidths",

16054

"shortname": "DataTable.ColumnWidths",

16055

"classitems": [],

16056

"plugins": [],

16057

"extensions": [],

16058

"plugin_for": [],

16059

"extension_for": [],

16060

"module": "datatable",

16061

"submodule": "datatable-column-widths",

16062

"namespace": "",

16063

"file": "datatable/js/colwidths.js",

16064

"line": 45,

16065

"description": "_API docs for this extension are included in the DataTable class._\n\nAdds basic, programmatic column width support to DataTable. Note, this does not\nadd support for truncated columns. Due to the way HTML tables render, column\nwidth is more like a \"recommended width\". Column content wider than the\nassigned width will cause the column to expand, despite the configured width.\nSimilarly if the table is too narrow to fit the column with the configured\ncolumn width, the column width will be reduced.\n\nTo set a column width, either add a `width` value to the column configuration\nor call the `setColumnWidth(id, width)` method.\n\nNote, assigning column widths is possible without this module, as each cell is\ndecorated with a class appropriate for that column which you can statically\ntarget in your site's CSS.\n\nTo achieve absolute column widths, with content truncation, you can either:\n\n1. Use this module, configure *all* columns to have `width`s, then add\n `table-layout: fixed;` to your CSS for the appropriate `<table>`, or\n2. Wrap the contents of all cells in the column with a `<div>` (using a\n `cellTemplate` or `formatter`), assign the div's style `width`, then assign\n the column `width` or add a CSS `width` to the column class created by\n DataTable.\n\n<pre><code>.yui3-datatable .yui3-datatable-col-foo {\n padding: 0;\n width: 125px;\n}\n.yui3-datatable .yui3-datatable-col-foo .yui3-datatable-liner {\n overflow: hidden;\n padding: 4px 10px;\n width: 125px;\n}\n</pre></code>\n\n<pre><code>var table = new Y.DataTable({\n columns: [\n {\n key: 'foo',\n cellTemplate:\n '<td class=\"{className}\">' +\n '<div class=\"yui3-datatable-liner\">{content}</div>' +\n '</td>'\n },\n ...\n ],\n ...\n});\n</code></pre>\n\nTo add a liner to all columns, either provide a custom `bodyView` to the\nDataTable constructor or update the default `bodyView`'s `CELL_TEMPLATE` like\nso:\n\n<pre><code>table.on('renderBody', function (e) {\n e.view.CELL_TEMPLATE = e.view.CELL_TEMPLATE.replace(/\\{content\\}/,\n '<div class=\"yui3-datatable-liner\">{content}</div>');\n});\n</code></pre>\n\nKeep in mind that DataTable skins apply cell `padding`, so assign your CSS\n`width`s accordingly or override the `padding` style for that column's `<td>`s\nto 0, and add `padding` to the liner `<div>`'s styles as shown above.",

16066

"since": "3.5.0"

16067

},

16068

"DataTable.Core": {

16069

"name": "DataTable.Core",

16070

"shortname": "DataTable.Core",

16071

"classitems": [],

16072

"plugins": [],

16073

"extensions": [],

16074

"plugin_for": [],

16075

"extension_for": [

16076

"DataTable.Base"

16077

],

16078

"module": "datatable",

16079

"submodule": "datatable-core",

16080

"namespace": "",

16081

"file": "datatable/js/core.js",

16082

"line": 38,

16083

"description": "_API docs for this extension are included in the DataTable class._\n\nClass extension providing the core API and structure for the DataTable Widget.\n\nUse this class extension with Widget or another Base-based superclass to create\nthe basic DataTable API and composing class structure.\n\nNotable about this architecture is that rendering and UI event management for\nthe header, body, and footer of the table are deferred to configurable classes\nin the `headerView`, `bodyView`, and `footerView` attributes. In this extension\nthey have no default values, requiring implementers to supply their own classes\nto render the table content.",

16084

"since": "3.5.0"

16085

},

16086

"Plugin.DataTableDataSource": {

16087

"name": "Plugin.DataTableDataSource",

16088

"shortname": "Plugin.DataTableDataSource",

16089

"classitems": [],

16090

"plugins": [],

16091

"extensions": [],

16092

"plugin_for": [],

16093

"extension_for": [],

16094

"module": "datatable",

16095

"submodule": "datatable-datasource",

16096

"namespace": "",

16097

"file": "datatable/js/datatable-datasource.js",

16098

"line": 8,

16099

"description": "Adds DataSource integration to DataTable.",

16100

"extends": "Plugin.Base"

16101

},

16102

"DataTable.HeaderView": {

16103

"name": "DataTable.HeaderView",

16104

"shortname": "DataTable.HeaderView",

16105

"classitems": [],

16106

"plugins": [],

16107

"extensions": [],

16108

"plugin_for": [],

16109

"extension_for": [],

16110

"module": "datatable",

16111

"submodule": "datatable-head",

16112

"namespace": "DataTable",

16113

"file": "datatable/js/head.js",

16114

"line": 17,

16115

"description": "View class responsible for rendering the `<thead>` section of a table. Used as\nthe default `headerView` for `Y.DataTable.Base` and `Y.DataTable` classes.\n\nTranslates the provided array of column configuration objects into a rendered\n`<thead>` based on the data in those objects.\n \n\nThe structure of the column data is expected to be a single array of objects,\nwhere each object corresponds to a `<th>`. Those objects may contain a\n`children` property containing a similarly structured array to indicate the\nnested cells should be grouped under the parent column's colspan in a separate\nrow of header cells. E.g.\n\n<pre><code>\nnew Y.DataTable.HeaderView({\n container: tableNode,\n columns: [\n { key: 'id' }, // no nesting\n { key: 'name', children: [\n { key: 'firstName', label: 'First' },\n { key: 'lastName', label: 'Last' } ] }\n ]\n}).render();\n</code></pre>\n\nThis would translate to the following visualization:\n\n<pre>\n---------------------\n| | name |\n| |---------------\n| id | First | Last |\n---------------------\n</pre>\n\nSupported properties of the column objects include:\n\n * `label` - The HTML content of the header cell.\n * `key` - If `label` is not specified, the `key` is used for content.\n * `children` - Array of columns to appear below this column in the next\n row.\n * `headerTemplate` - Overrides the instance's `CELL_TEMPLATE` for cells in this\n column only.\n * `abbr` - The content of the 'abbr' attribute of the `<th>`\n * `className` - Adds this string of CSS classes to the column header\n\nThrough the life of instantiation and rendering, the column objects will have\nthe following properties added to them:\n\n * `id` - (Defaulted by DataTable) The id to assign the rendered column\n * `_colspan` - To supply the `<th>` attribute\n * `_rowspan` - To supply the `<th>` attribute\n * `_parent` - (Added by DataTable) If the column is a child of another\n column, this points to its parent column\n\nThe column object is also used to provide values for {placeholder} tokens in the\ninstance's `CELL_TEMPLATE`, so you can modify the template and include other\ncolumn object properties to populate them.",

16116

"extends": "View",

16117

"since": "3.5.0"

16118

},

16119

"DataTable.Message": {

16120

"name": "DataTable.Message",

16121

"shortname": "DataTable.Message",

16122

"classitems": [],

16123

"plugins": [],

16124

"extensions": [],

16125

"plugin_for": [],

16126

"extension_for": [],

16127

"module": "datatable",

16128

"submodule": "datatable-message",

16129

"namespace": "",

16130

"file": "datatable/js/message.js",

16131

"line": 12,

16132

"description": "_API docs for this extension are included in the DataTable class._\n\nAdds support for a message container to appear in the table. This can be used\nto indicate loading progress, lack of records, or any other communication\nneeded.\n\nFeatures added to `Y.DataTable`, and made available for custom classes at\n`Y.DataTable.Message`.",

16133

"since": "3.5.0"

16134

},

16135

"DataTable.Mutable": {

16136

"name": "DataTable.Mutable",

16137

"shortname": "DataTable.Mutable",

16138

"classitems": [],

16139

"plugins": [],

16140

"extensions": [],

16141

"plugin_for": [],

16142

"extension_for": [],

16143

"module": "datatable",

16144

"submodule": "datatable-mutable",

16145

"namespace": "",

16146

"file": "datatable/js/mutable.js",

16147

"line": 17,

16148

"description": "_API docs for this extension are included in the DataTable class._\n\nClass extension to add mutation convenience methods to `Y.DataTable` (or other\nbuilt class).\n\nColumn mutation methods are paired with new custom events:\n\n * addColumn\n * removeColumn\n * modifyColumn\n * moveColumn\n\nRow mutation events are bubbled from the DataTable's `data` ModelList through\nthe DataTable instance.",

16149

"since": "3.5.0"

16150

},

16151

"DataTable.Scrollable": {

16152

"name": "DataTable.Scrollable",

16153

"shortname": "DataTable.Scrollable",

16154

"classitems": [],

16155

"plugins": [],

16156

"extensions": [],

16157

"plugin_for": [],

16158

"extension_for": [],

16159

"module": "datatable-scroll",

16160

"namespace": "",

16161

"file": "datatable/js/scroll.js",

16162

"line": 21,

16163

"description": "_API docs for this extension are included in the DataTable class._\n\nAdds the ability to make the table rows scrollable while preserving the header\nplacement.\n\nThere are two types of scrolling, horizontal (x) and vertical (y). Horizontal\nscrolling is achieved by wrapping the entire table in a scrollable container.\nVertical scrolling is achieved by splitting the table headers and data into two\nseparate tables, the latter of which is wrapped in a vertically scrolling\ncontainer. In this case, column widths of header cells and data cells are kept\nin sync programmatically.\n\nSince the split table synchronization can be costly at runtime, the split is only done if the data in the table stretches beyond the configured `height` value.\n\nTo activate or deactivate scrolling, set the `scrollable` attribute to one of\nthe following values:\n\n * `false` - (default) Scrolling is disabled.\n * `true` or 'xy' - If `height` is set, vertical scrolling will be activated, if\n `width` is set, horizontal scrolling will be activated.\n * 'x' - Activate horizontal scrolling only. Requires the `width` attribute is\n also set.\n * 'y' - Activate vertical scrolling only. Requires the `height` attribute is\n also set.",

16164

"since": "3.5.0"

16165

},

16166

"DataTable.Sortable": {

16167

"name": "DataTable.Sortable",

16168

"shortname": "DataTable.Sortable",

16169

"classitems": [],

16170

"plugins": [],

16171

"extensions": [],

16172

"plugin_for": [],

16173

"extension_for": [],

16174

"module": "datatable",

16175

"submodule": "datatable-sort",

16176

"namespace": "",

16177

"file": "datatable/js/sort.js",

16178

"line": 26,

16179

"description": "_API docs for this extension are included in the DataTable class._\n\nThis DataTable class extension adds support for sorting the table data by API\nmethods `table.sort(...)` or `table.toggleSort(...)` or by clicking on column\nheaders in the rendered UI.\n\nSorting by the API is enabled automatically when this module is `use()`d. To\nenable UI triggered sorting, set the DataTable's `sortable` attribute to\n`true`.\n\n<pre><code>\nvar table = new Y.DataTable({\n columns: [ 'id', 'username', 'name', 'birthdate' ],\n data: [ ... ],\n sortable: true\n});\n\ntable.render('#table');\n</code></pre>\n\nSetting `sortable` to `true` will enable UI sorting for all columns. To enable\nUI sorting for certain columns only, set `sortable` to an array of column keys,\nor just add `sortable: true` to the respective column configuration objects.\nThis uses the default setting of `sortable: auto` for the DataTable instance.\n\n<pre><code>\nvar table = new Y.DataTable({\n columns: [\n 'id',\n { key: 'username', sortable: true },\n { key: 'name', sortable: true },\n { key: 'birthdate', sortable: true }\n ],\n data: [ ... ]\n // sortable: 'auto' is the default\n});\n\n// OR\nvar table = new Y.DataTable({\n columns: [ 'id', 'username', 'name', 'birthdate' ],\n data: [ ... ],\n sortable: [ 'username', 'name', 'birthdate' ]\n});\n</code></pre>\n\nTo disable UI sorting for all columns, set `sortable` to `false`. This still\npermits sorting via the API methods.\n\nAs new records are inserted into the table's `data` ModelList, they will be inserted at the correct index to preserve the sort order.\n\nThe current sort order is stored in the `sortBy` attribute. Assigning this value at instantiation will automatically sort your data.\n\nSorting is done by a simple value comparison using < and > on the field\nvalue. If you need custom sorting, add a sort function in the column's\n`sortFn` property. Columns whose content is generated by formatters, but don't\nrelate to a single `key`, require a `sortFn` to be sortable.\n\n<pre><code>\nfunction nameSort(a, b, desc) {\n var aa = a.get('lastName') + a.get('firstName'),\n bb = a.get('lastName') + b.get('firstName'),\n order = (aa > bb) ? 1 : -(aa < bb);\n \n return desc ? -order : order;\n}\n\nvar table = new Y.DataTable({\n columns: [ 'id', 'username', { key: name, sortFn: nameSort }, 'birthdate' ],\n data: [ ... ],\n sortable: [ 'username', 'name', 'birthdate' ]\n});\n</code></pre>\n\nSee the user guide for more details.",

16180

"since": "3.5.0"

16181

},

16182

"DataType.Date": {

16183

"name": "DataType.Date",

16184

"shortname": "DataType.Date",

16185

"classitems": [],

16186

"plugins": [],

16187

"extensions": [],

16188

"plugin_for": [],

16189

"extension_for": [],

16190

"module": "datatype",

16191

"submodule": "datatype-date-format",

16192

"namespace": "",

16193

"file": "datatype/js/datatype-date-format.js",

16194

"line": 26,

16195

"description": "DataType.Date provides a set of utility functions to operate against Date objects.",

16196

"static": 1

16197

},

16198

"DataType.Date.Locale": {

16199

"name": "DataType.Date.Locale",

16200

"shortname": "DataType.Date.Locale",

16201

"classitems": [],

16202

"plugins": [],

16203

"extensions": [],

16204

"plugin_for": [],

16205

"extension_for": [],

16206

"module": "datatype",

16207

"namespace": "",

16208

"file": "datatype/js/datatype-date-locale.js",

16209

"line": 5,

16210

"description": "The Date.Locale class is a container for all localised date strings\nused by Y.DataType.Date. It is used internally, but may be extended\nto provide new date localisations.\n\nTo create your own Locale, follow these steps:\n<ol>\n <li>Find an existing locale that matches closely with your needs</li>\n <li>Use this as your base class. Use Y.DataType.Date.Locale[\"en\"] if nothing\n matches.</li>\n <li>Create your own class as an extension of the base class using\n Y.merge, and add your own localisations where needed.</li>\n</ol>\nSee the Y.DataType.Date.Locale[\"en-US\"] and Y.DataType.Date.Locale[\"en-GB\"]\nclasses which extend Y.DataType.Date.Locale[\"en\"].\n\nFor example, to implement locales for French french and Canadian french,\nwe would do the following:\n<ol>\n <li>For French french, we have no existing similar locale, so use\n Y.DataType.Date.Locale[\"en\"] as the base, and extend it:\n <pre>\n Y.DataType.Date.Locale[\"fr\"] = Y.merge(Y.DataType.Date.Locale[\"en\"], {\n a: [\"dim\", \"lun\", \"mar\", \"mer\", \"jeu\", \"ven\", \"sam\"],\n A: [\"dimanche\", \"lundi\", \"mardi\", \"mercredi\", \"jeudi\", \"vendredi\", \"samedi\"],\n b: [\"jan\", \"fév\", \"mar\", \"avr\", \"mai\", \"jun\", \"jui\", \"aoû\", \"sep\", \"oct\", \"nov\", \"déc\"],\n B: [\"janvier\", \"février\", \"mars\", \"avril\", \"mai\", \"juin\", \"juillet\", \"août\", \"septembre\", \"octobre\", \"novembre\", \"décembre\"],\n c: \"%a %d %b %Y %T %Z\",\n p: [\"\", \"\"],\n P: [\"\", \"\"],\n x: \"%d.%m.%Y\",\n X: \"%T\"\n });\n </pre>\n </li>\n <li>For Canadian french, we start with French french and change the meaning of \\%x:\n <pre>\n Y.DataType.Date.Locale[\"fr-CA\"] = Y.merge(Y.DataType.Date.Locale[\"fr\"], {\n x: \"%Y-%m-%d\"\n });\n </pre>\n </li>\n</ol>\n\nWith that, you can use your new locales:\n<pre>\n var d = new Date(\"2008/04/22\");\n Y.DataType.Date.format(d, { format: \"%A, %d %B == %x\", locale: \"fr\" });\n</pre>\nwill return:\n<pre>\n mardi, 22 avril == 22.04.2008\n</pre>\nAnd\n<pre>\n Y.DataType.Date.format(d, {format: \"%A, %d %B == %x\", locale: \"fr-CA\" });\n</pre>\nWill return:\n<pre>\n mardi, 22 avril == 2008-04-22\n</pre>",

16211

"requires": [

16212

"oop"

16213

],

16214

"static": 1,

16215

"deprecated": true,

16216

"deprecationMessage": "- use Y.config.lang to request one of many built-in languages instead."

16217

},

16218

"DataType.Number": {

16219

"name": "DataType.Number",

16220

"shortname": "DataType.Number",

16221

"classitems": [],

16222

"plugins": [],

16223

"extensions": [],

16224

"plugin_for": [],

16225

"extension_for": [],

16226

"module": "datatype",

16227

"submodule": "datatype-number-format",

16228

"namespace": "",

16229

"file": "datatype/js/datatype-number-format.js",

16230

"line": 15,

16231

"description": "DataType.Number provides a set of utility functions to operate against Number objects.",

16232

"static": 1

16233

},

16234

"DataType.XML": {

16235

"name": "DataType.XML",

16236

"shortname": "DataType.XML",

16237

"classitems": [],

16238

"plugins": [],

16239

"extensions": [],

16240

"plugin_for": [],

16241

"extension_for": [],

16242

"module": "datatype",

16243

"submodule": "datatype-xml",

16244

"namespace": "",

16245

"file": "datatype/js/datatype-xml-format.js",

16246

"line": 15,

16247

"description": "DataType.XML provides a set of utility functions to operate against XML documents.",

16248

"static": 1

16249

},

16250

"Plugin.DDConstrained": {

16251

"name": "Plugin.DDConstrained",

16252

"shortname": "Plugin.DDConstrained",

16253

"classitems": [],

16254

"plugins": [],

16255

"extensions": [],

16256

"plugin_for": [],

16257

"extension_for": [],

16258

"module": "dd",

16259

"submodule": "dd-constrain",

16260

"namespace": "Plugin",

16261

"file": "dd/js/constrain.js",

16262

"line": 8,

16263

"description": "Plugin for the dd-drag module to add the constraining methods to it. It supports constraining to a node or viewport. It supports tick based moves and XY axis constraints.",

16264

"extends": "Base",

16265

"is_constructor": 1

16266

},

16267

"DD.DDM": {

16268

"name": "DD.DDM",

16269

"shortname": "DDM",

16270

"classitems": [],

16271

"plugins": [],

16272

"extensions": [],

16273

"plugin_for": [],

16274

"extension_for": [],

16275

"module": "dd",

16276

"submodule": "dd-ddm-base",

16277

"namespace": "DD",

16278

"file": "dd/js/ddm-base.js",

16279

"line": 7,

16280

"description": "Provides the base Drag Drop Manger required for making a Node draggable.",

16281

"extends": "Base",

16282

"is_constructor": 1

16283

},

16284

"Plugin.Drop": {

16285

"name": "Plugin.Drop",

16286

"shortname": "Plugin.Drop",

16287

"classitems": [],

16288

"plugins": [],

16289

"extensions": [],

16290

"plugin_for": [],

16291

"extension_for": [],

16292

"module": "dd",

16293

"submodule": "dd-drop-plugin",

16294

"namespace": "Plugin",

16295

"file": "dd/js/dd-drop-plugin.js",

16296

"line": 7,

16297

"description": "Simple Drop plugin that can be attached to a Node via the plug method.",

16298

"extends": "DD.Drop",

16299

"is_constructor": 1

16300

},

16301

"Plugin.Drag": {

16302

"name": "Plugin.Drag",

16303

"shortname": "Plugin.Drag",

16304

"classitems": [],

16305

"plugins": [],

16306

"extensions": [],

16307

"plugin_for": [],

16308

"extension_for": [],

16309

"module": "dd",

16310

"submodule": "dd-plugin",

16311

"namespace": "Plugin",

16312

"file": "dd/js/dd-plugin.js",

16313

"line": 8,

16314

"description": "Simple Drag plugin that can be attached to a Node or Widget via the plug method.",

16315

"extends": "DD.Drag",

16316

"is_constructor": 1

16317

},

16318

"DD.Delegate": {

16319

"name": "DD.Delegate",

16320

"shortname": "DD.Delegate",

16321

"classitems": [],

16322

"plugins": [],

16323

"extensions": [],

16324

"plugin_for": [],

16325

"extension_for": [],

16326

"module": "dd",

16327

"submodule": "dd-delegate",

16328

"namespace": "DD",

16329

"file": "dd/js/delegate.js",

16330

"line": 7,

16331

"description": "Provides the ability to drag multiple nodes under a container element using only one Y.DD.Drag instance as a delegate.",

16332

"extends": "Base",

16333

"is_constructor": 1

16334

},

16335

"DD.Drag": {

16336

"name": "DD.Drag",

16337

"shortname": "DD.Drag",

16338

"classitems": [],

16339

"plugins": [],

16340

"extensions": [],

16341

"plugin_for": [],

16342

"extension_for": [],

16343

"module": "dd",

16344

"submodule": "dd-drag",

16345

"namespace": "DD",

16346

"file": "dd/js/drag.js",

16347

"line": 7,

16348

"description": "Provides the ability to drag a Node.",

16349

"extends": "Base",

16350

"is_constructor": 1

16351

},

16352

"DD.Drop": {

16353

"name": "DD.Drop",

16354

"shortname": "DD.Drop",

16355

"classitems": [],

16356

"plugins": [],

16357

"extensions": [],

16358

"plugin_for": [],

16359

"extension_for": [],

16360

"module": "dd",

16361

"submodule": "dd-drop",

16362

"namespace": "DD",

16363

"file": "dd/js/drop.js",

16364

"line": 7,

16365

"description": "Provides the ability to create a Drop Target.",

16366

"extends": "Base",

16367

"is_constructor": 1

16368

},

16369

"Plugin.DDProxy": {

16370

"name": "Plugin.DDProxy",

16371

"shortname": "Plugin.DDProxy",

16372

"classitems": [],

16373

"plugins": [],

16374

"extensions": [],

16375

"plugin_for": [],

16376

"extension_for": [],

16377

"module": "dd",

16378

"submodule": "dd-proxy",

16379

"namespace": "Plugin",

16380

"file": "dd/js/proxy.js",

16381

"line": 7,

16382

"description": "Plugin for dd-drag for creating a proxy drag node, instead of dragging the original node.",

16383

"extends": "Base",

16384

"is_constructor": 1

16385

},

16386

"DD.Scroll": {

16387

"name": "DD.Scroll",

16388

"shortname": "DD.Scroll",

16389

"classitems": [],

16390

"plugins": [],

16391

"extensions": [],

16392

"plugin_for": [],

16393

"extension_for": [],

16394

"module": "dd",

16395

"submodule": "dd-scroll",

16396

"namespace": "DD",

16397

"file": "dd/js/scroll.js",

16398

"line": 8,

16399

"description": "Base scroller class used to create the Plugin.DDNodeScroll and Plugin.DDWinScroll.\nThis class should not be called on it's own, it's designed to be a plugin.",

16400

"extends": "Base",

16401

"is_constructor": 1

16402

},

16403

"Plugin.DDWindowScroll": {

16404

"name": "Plugin.DDWindowScroll",

16405

"shortname": "Plugin.DDWindowScroll",

16406

"classitems": [],

16407

"plugins": [],

16408

"extensions": [],

16409

"plugin_for": [],

16410

"extension_for": [],

16411

"module": "dd",

16412

"submodule": "dd-scroll",

16413

"namespace": "Plugin",

16414

"file": "dd/js/scroll.js",

16415

"line": 317,

16416

"description": "Extends the Scroll class to make the window scroll while dragging.",

16417

"extends": "Scroll",

16418

"is_constructor": 1

16419

},

16420

"Plugin.DDNodeScroll": {

16421

"name": "Plugin.DDNodeScroll",

16422

"shortname": "Plugin.DDNodeScroll",

16423

"classitems": [],

16424

"plugins": [],

16425

"extensions": [],

16426

"plugin_for": [],

16427

"extension_for": [],

16428

"module": "dd",

16429

"submodule": "dd-scroll",

16430

"namespace": "Plugin",

16431

"file": "dd/js/scroll.js",

16432

"line": 362,

16433

"description": "Extends the Scroll class to make a parent node scroll while dragging.",

16434

"extends": "Scroll",

16435

"is_constructor": 1

16436

},

16437

"Dial": {

16438

"name": "Dial",

16439

"shortname": "Dial",

16440

"classitems": [],

16441

"plugins": [],

16442

"extensions": [],

16443

"plugin_for": [],

16444

"extension_for": [],

16445

"module": "dial",

16446

"namespace": "",

16447

"file": "dial/js/Dial.js",

16448

"line": 18,

16449

"description": "Create a dial to represent an input control capable of representing a\nseries of intermediate states based on the position of the Dial's handle.\nThese states are typically aligned to a value algorithm whereby the angle of the handle's\nposition corresponds to a given value.",

16450

"extends": "Widget",

16451

"params": [

16452

{

16453

"name": "config",

16454

"description": "Configuration object",

16455

"type": "Object"

16456

}

16457

],

16458

"is_constructor": 1

16459

},

16460

"DOM": {

16461

"name": "DOM",

16462

"shortname": "DOM",

16463

"classitems": [],

16464

"plugins": [],

16465

"extensions": [],

16466

"plugin_for": [],

16467

"extension_for": [],

16468

"module": "dom",

16469

"namespace": "",

16470

"file": "dom/js/dom-core.js",

16471

"line": 25,

16472

"description": "Provides DOM helper methods.",

16473

"submodule": "dom-base"

16474

},

16475

"Selector": {

16476

"name": "Selector",

16477

"shortname": "Selector",

16478

"classitems": [],

16479

"plugins": [],

16480

"extensions": [],

16481

"plugin_for": [],

16482

"extension_for": [],

16483

"module": "dom",

16484

"submodule": "selector-native",

16485

"namespace": "",

16486

"file": "dom/js/selector-native.js",

16487

"line": 9,

16488

"description": "Provides support for using CSS selectors to query the DOM",

16489

"static": 1

16490

},

16491

"YUI": {

16492

"name": "YUI",

16493

"shortname": "YUI",

16494

"classitems": [],

16495

"plugins": [],

16496

"extensions": [],

16497

"plugin_for": [],

16498

"extension_for": [],

16499

"module": "yui",

16500

"namespace": "",

16501

"file": "yui/js/yui.js",

16502

"line": 13,

16503

"description": "The YUI global namespace object. If YUI is already defined, the\nexisting YUI object will not be overwritten so that defined\nnamespaces are preserved. It is the constructor for the object\nthe end user interacts with. As indicated below, each instance\nhas full custom event support, but only if the event system\nis available. This is a self-instantiable factory function. You\ncan invoke it directly like this:\n\n YUI().use('*', function(Y) {\n // ready\n });\n\nBut it also works like this:\n\n var Y = YUI();\n\nConfiguring the YUI object:\n\n YUI({\n debug: true,\n combine: false\n }).use('node', function(Y) {\n //Node is ready to use\n });\n\nSee the API docs for the <a href=\"config.html\">Config</a> class\nfor the complete list of supported configuration properties accepted\nby the YUI constuctor.",

16504

"submodule": "yui-base",

16505

"is_constructor": 1,

16506

"global": "",

16507

"uses": [

16508

"EventTarget"

16509

],

16510

"params": [

16511

{

16512

"name": "o",

16513

"description": "0..n optional configuration objects. these values\nare store in Y.config. See <a href=\"config.html\">Config</a> for the list of supported\nproperties.",

16514

"type": "Object",

16515

"optional": true,

16516

"multiple": true

16517

}

16518

]

16519

},

16520

"Plugin.CreateLinkBase": {

16521

"name": "Plugin.CreateLinkBase",

16522

"shortname": "Plugin.CreateLinkBase",

16523

"classitems": [],

16524

"plugins": [],

16525

"extensions": [],

16526

"plugin_for": [],

16527

"extension_for": [],

16528

"module": "editor",

16529

"namespace": "",

16530

"file": "editor/js/createlink-base.js",

16531

"line": 2,

16532

"description": "Adds prompt style link creation. Adds an override for the <a href=\"Plugin.ExecCommand.html#method_COMMANDS.createlink\">createlink execCommand</a>.",

16533

"submodule": "createlink-base",

16534

"static": 1

16535

},

16536

"ExecCommand": {

16537

"name": "ExecCommand",

16538

"shortname": "ExecCommand",

16539

"classitems": [],

16540

"plugins": [],

16541

"extensions": [],

16542

"plugin_for": [],

16543

"extension_for": [],

16544

"module": "editor",

16545

"namespace": ""

16546

},

16547

"EditorBase": {

16548

"name": "EditorBase",

16549

"shortname": "EditorBase",

16550

"classitems": [],

16551

"plugins": [],

16552

"extensions": [],

16553

"plugin_for": [],

16554

"extension_for": [],

16555

"module": "editor",

16556

"namespace": "",

16557

"file": "editor/js/editor-base.js",

16558

"line": 2,

16559

"description": "Base class for Editor. Handles the business logic of Editor, no GUI involved only utility methods and events.\n\n var editor = new Y.EditorBase({\n content: 'Foo'\n });\n editor.render('#demo');",

16560

"submodule": "editor-base",

16561

"extends": "Base",

16562

"mainName": "editor",

16563

"tag": "main",

16564

"itemtype": "main",

16565

"_main": true,

16566

"is_constructor": 1

16567

},

16568

"Plugin.EditorBidi": {

16569

"name": "Plugin.EditorBidi",

16570

"shortname": "Plugin.EditorBidi",

16571

"classitems": [],

16572

"plugins": [],

16573

"extensions": [],

16574

"plugin_for": [],

16575

"extension_for": [],

16576

"module": "editor",

16577

"namespace": "",

16578

"file": "editor/js/editor-bidi.js",

16579

"line": 2,

16580

"description": "Plugin for Editor to support BiDirectional (bidi) text operations.",

16581

"submodule": "editor-bidi",

16582

"extends": "Base",

16583

"is_constructor": 1

16584

},

16585

"Plugin.ExecCommand": {

16586

"name": "Plugin.ExecCommand",

16587

"shortname": "Plugin.ExecCommand",

16588

"classitems": [],

16589

"plugins": [],

16590

"extensions": [],

16591

"plugin_for": [],

16592

"extension_for": [],

16593

"module": "editor",

16594

"submodule": "exec-command",

16595

"namespace": "",

16596

"file": "editor/js/exec-command.js",

16597

"line": 2,

16598

"description": "Plugin for the frame module to handle execCommands for Editor",

16599

"extends": "Base",

16600

"is_constructor": 1

16601

},

16602

"Plugin.EditorBR": {

16603

"name": "Plugin.EditorBR",

16604

"shortname": "Plugin.EditorBR",

16605

"classitems": [],

16606

"plugins": [],

16607

"extensions": [],

16608

"plugin_for": [],

16609

"extension_for": [],

16610

"module": "editor",

16611

"namespace": "",

16612

"file": "editor/js/editor-br.js",

16613

"line": 3,

16614

"description": "Plugin for Editor to normalize BR's.",

16615

"submodule": "editor-br",

16616

"extends": "Base",

16617

"is_constructor": 1

16618

},

16619

"Plugin.EditorParaBase": {

16620

"name": "Plugin.EditorParaBase",

16621

"shortname": "Plugin.EditorParaBase",

16622

"classitems": [],

16623

"plugins": [],

16624

"extensions": [],

16625

"plugin_for": [],

16626

"extension_for": [],

16627

"module": "editor",

16628

"namespace": "",

16629

"file": "editor/js/editor-para-base.js",

16630

"line": 2,

16631

"description": "Base Plugin for Editor to paragraph auto wrapping and correction.",

16632

"submodule": "editor-para-base",

16633

"extends": "Base",

16634

"is_constructor": 1

16635

},

16636

"Plugin.EditorParaIE": {

16637

"name": "Plugin.EditorParaIE",

16638

"shortname": "Plugin.EditorParaIE",

16639

"classitems": [],

16640

"plugins": [],

16641

"extensions": [],

16642

"plugin_for": [],

16643

"extension_for": [],

16644

"module": "editor",

16645

"namespace": "",

16646

"file": "editor/js/editor-para-ie.js",

16647

"line": 2,

16648

"description": "Extends EditorParaBase with IE support",

16649

"submodule": "editor-para-ie",

16650

"extends": "Plugin.EditorParaBase",

16651

"is_constructor": 1

16652

},

16653

"Plugin.EditorPara": {

16654

"name": "Plugin.EditorPara",

16655

"shortname": "Plugin.EditorPara",

16656

"classitems": [],

16657

"plugins": [],

16658

"extensions": [],

16659

"plugin_for": [],

16660

"extension_for": [],

16661

"module": "editor",

16662

"namespace": "",

16663

"file": "editor/js/editor-para.js",

16664

"line": 2,

16665

"description": "Plugin for Editor to paragraph auto wrapping and correction.",

16666

"submodule": "editor-para",

16667

"extends": "Plugin.EditorParaBase",

16668

"is_constructor": 1

16669

},

16670

"EditorSelection": {

16671

"name": "EditorSelection",

16672

"shortname": "EditorSelection",

16673

"classitems": [],

16674

"plugins": [],

16675

"extensions": [],

16676

"plugin_for": [],

16677

"extension_for": [],

16678

"module": "editor",

16679

"namespace": "",

16680

"file": "editor/js/editor-selection.js",

16681

"line": 1,

16682

"description": "Wraps some common Selection/Range functionality into a simple object",

16683

"submodule": "selection",

16684

"is_constructor": 1

16685

},

16686

"Plugin.EditorTab": {

16687

"name": "Plugin.EditorTab",

16688

"shortname": "Plugin.EditorTab",

16689

"classitems": [],

16690

"plugins": [],

16691

"extensions": [],

16692

"plugin_for": [],

16693

"extension_for": [],

16694

"module": "editor",

16695

"namespace": "",

16696

"file": "editor/js/editor-tab.js",

16697

"line": 2,

16698

"description": "Handles tab and shift-tab indent/outdent support.",

16699

"submodule": "editor-tab",

16700

"is_constructor": 1,

16701

"extends": "Base"

16702

},

16703

"Frame": {

16704

"name": "Frame",

16705

"shortname": "Frame",

16706

"classitems": [],

16707

"plugins": [],

16708

"extensions": [],

16709

"plugin_for": [],

16710

"extension_for": [],

16711

"module": "editor",

16712

"namespace": "",

16713

"file": "editor/js/frame.js",

16714

"line": 2,

16715

"description": "Creates a wrapper around an iframe. It loads the content either from a local\nfile or from script and creates a local YUI instance bound to that new window and document.",

16716

"submodule": "frame",

16717

"extends": "Base",

16718

"is_constructor": 1

16719

},

16720

"Plugin.EditorLists": {

16721

"name": "Plugin.EditorLists",

16722

"shortname": "Plugin.EditorLists",

16723

"classitems": [],

16724

"plugins": [],

16725

"extensions": [],

16726

"plugin_for": [],

16727

"extension_for": [],

16728

"module": "editor",

16729

"namespace": "",

16730

"file": "editor/js/lists.js",

16731

"line": 2,

16732

"description": "Handles list manipulation inside the Editor. Adds keyboard manipulation and execCommand support. Adds overrides for the <a href=\"Plugin.ExecCommand.html#method_COMMANDS.insertorderedlist\">insertorderedlist</a> and <a href=\"Plugin.ExecCommand.html#method_COMMANDS.insertunorderedlist\">insertunorderedlist</a> execCommands.",

16733

"submodule": "editor-lists",

16734

"is_constructor": 1,

16735

"extends": "Base"

16736

},

16737

"Escape": {

16738

"name": "Escape",

16739

"shortname": "Escape",

16740

"classitems": [],

16741

"plugins": [],

16742

"extensions": [],

16743

"plugin_for": [],

16744

"extension_for": [],

16745

"module": "escape",

16746

"namespace": "",

16747

"file": "escape/js/escape.js",

16748

"line": 1,

16749

"description": "Provides utility methods for escaping strings."

16750

},

16751

"CustomEvent": {

16752

"name": "CustomEvent",

16753

"shortname": "CustomEvent",

16754

"classitems": [],

16755

"plugins": [],

16756

"extensions": [],

16757

"plugin_for": [],

16758

"extension_for": [],

16759

"module": "event-custom",

16760

"submodule": "event-custom-base",

16761

"namespace": "",

16762

"file": "event-custom/js/event-custom.js",

16763

"line": 38,

16764

"description": "The CustomEvent class lets you define events for your application\nthat can be subscribed to by one or more independent component.",

16765

"params": [

16766

{

16767

"name": "type",

16768

"description": "The type of event, which is passed to the callback\nwhen the event fires.",

16769

"type": "String"

16770

},

16771

{

16772

"name": "o",

16773

"description": "configuration object.",

16774

"type": "Object"

16775

}

16776

],

16777

"is_constructor": 1

16778

},

16779

"Do": {

16780

"name": "Do",

16781

"shortname": "Do",

16782

"classitems": [],

16783

"plugins": [],

16784

"extensions": [],

16785

"plugin_for": [],

16786

"extension_for": [],

16787

"module": "event-custom",

16788

"submodule": "event-custom-base",

16789

"namespace": "",

16790

"file": "event-custom/js/event-do.js",

16791

"line": 9,

16792

"description": "Allows for the insertion of methods that are executed before or after\na specified method",

16793

"static": 1

16794

},

16795

"Do.Method": {

16796

"name": "Do.Method",

16797

"shortname": "Do.Method",

16798

"classitems": [],

16799

"plugins": [],

16800

"extensions": [],

16801

"plugin_for": [],

16802

"extension_for": [],

16803

"module": "event-custom",

16804

"submodule": "event-custom-base",

16805

"namespace": "",

16806

"file": "event-custom/js/event-do.js",

16807

"line": 195,

16808

"description": "Wrapper for a displaced method with aop enabled",

16809

"is_constructor": 1,

16810

"params": [

16811

{

16812

"name": "obj",

16813

"description": "The object to operate on"

16814

},

16815

{

16816

"name": "sFn",

16817

"description": "The name of the method to displace"

16818

}

16819

]

16820

},

16821

"Do.AlterArgs": {

16822

"name": "Do.AlterArgs",

16823

"shortname": "Do.AlterArgs",

16824

"classitems": [],

16825

"plugins": [],

16826

"extensions": [],

16827

"plugin_for": [],

16828

"extension_for": [],

16829

"module": "event-custom",

16830

"submodule": "event-custom-base",

16831

"namespace": "",

16832

"file": "event-custom/js/event-do.js",

16833

"line": 309,

16834

"description": "Return an AlterArgs object when you want to change the arguments that\nwere passed into the function. Useful for Do.before subscribers. An\nexample would be a service that scrubs out illegal characters prior to\nexecuting the core business logic.",

16835

"is_constructor": 1,

16836

"params": [

16837

{

16838

"name": "msg",

16839

"description": "(optional) Explanation of the altered return value",

16840

"type": "String"

16841

},

16842

{

16843

"name": "newArgs",

16844

"description": "Call parameters to be used for the original method\n instead of the arguments originally passed in.",

16845

"type": "Array"

16846

}

16847

]

16848

},

16849

"Do.AlterReturn": {

16850

"name": "Do.AlterReturn",

16851

"shortname": "Do.AlterReturn",

16852

"classitems": [],

16853

"plugins": [],

16854

"extensions": [],

16855

"plugin_for": [],

16856

"extension_for": [],

16857

"module": "event-custom",

16858

"submodule": "event-custom-base",

16859

"namespace": "",

16860

"file": "event-custom/js/event-do.js",

16861

"line": 325,

16862

"description": "Return an AlterReturn object when you want to change the result returned\nfrom the core method to the caller. Useful for Do.after subscribers.",

16863

"is_constructor": 1,

16864

"params": [

16865

{

16866

"name": "msg",

16867

"description": "(optional) Explanation of the altered return value",

16868

"type": "String"

16869

},

16870

{

16871

"name": "newRetVal",

16872

"description": "Return value passed to code that invoked the wrapped\n function.",

16873

"type": "Any"

16874

}

16875

]

16876

},

16877

"Do.Halt": {

16878

"name": "Do.Halt",

16879

"shortname": "Do.Halt",

16880

"classitems": [],

16881

"plugins": [],

16882

"extensions": [],

16883

"plugin_for": [],

16884

"extension_for": [],

16885

"module": "event-custom",

16886

"submodule": "event-custom-base",

16887

"namespace": "",

16888

"file": "event-custom/js/event-do.js",

16889

"line": 339,

16890

"description": "Return a Halt object when you want to terminate the execution\nof all subsequent subscribers as well as the wrapped method\nif it has not exectued yet. Useful for Do.before subscribers.",

16891

"is_constructor": 1,

16892

"params": [

16893

{

16894

"name": "msg",

16895

"description": "(optional) Explanation of why the termination was done",

16896

"type": "String"

16897

},

16898

{

16899

"name": "retVal",

16900

"description": "Return value passed to code that invoked the wrapped\n function.",

16901

"type": "Any"

16902

}

16903

]

16904

},

16905

"Do.Prevent": {

16906

"name": "Do.Prevent",

16907

"shortname": "Do.Prevent",

16908

"classitems": [],

16909

"plugins": [],

16910

"extensions": [],

16911

"plugin_for": [],

16912

"extension_for": [],

16913

"module": "event-custom",

16914

"submodule": "event-custom-base",

16915

"namespace": "",

16916

"file": "event-custom/js/event-do.js",

16917

"line": 354,

16918

"description": "Return a Prevent object when you want to prevent the wrapped function\nfrom executing, but want the remaining listeners to execute. Useful\nfor Do.before subscribers.",

16919

"is_constructor": 1,

16920

"params": [

16921

{

16922

"name": "msg",

16923

"description": "(optional) Explanation of why the termination was done",

16924

"type": "String"

16925

}

16926

]

16927

},

16928

"Do.Error": {

16929

"name": "Do.Error",

16930

"shortname": "Do.Error",

16931

"classitems": [],

16932

"plugins": [],

16933

"extensions": [],

16934

"plugin_for": [],

16935

"extension_for": [],

16936

"module": "event-custom",

16937

"submodule": "event-custom-base",

16938

"namespace": "",

16939

"file": "event-custom/js/event-do.js",

16940

"line": 366,

16941

"description": "Return an Error object when you want to terminate the execution\nof all subsequent method calls.",

16942

"is_constructor": 1,

16943

"params": [

16944

{

16945

"name": "msg",

16946

"description": "(optional) Explanation of the altered return value",

16947

"type": "String"

16948

},

16949

{

16950

"name": "retVal",

16951

"description": "Return value passed to code that invoked the wrapped\n function.",

16952

"type": "Any"

16953

}

16954

],

16955

"deprecated": true,

16956

"deprecationMessage": "use Y.Do.Halt or Y.Do.Prevent"

16957

},

16958

"EventFacade": {

16959

"name": "EventFacade",

16960

"shortname": "EventFacade",

16961

"classitems": [],

16962

"plugins": [],

16963

"extensions": [],

16964

"plugin_for": [],

16965

"extension_for": [],

16966

"module": "event-custom",

16967

"submodule": "event-custom-complex",

16968

"namespace": "",

16969

"file": "event-custom/js/event-facade.js",

16970

"line": 15,

16971

"description": "Wraps and protects a custom event for use when emitFacade is set to true.\nRequires the event-custom-complex module",

16972

"params": [

16973

{

16974

"name": "e",

16975

"description": "the custom event",

16976

"type": "Event"

16977

},

16978

{

16979

"name": "currentTarget",

16980

"description": "the element the listener was attached to",

16981

"type": "HTMLElement"

16982

}

16983

]

16984

},

16985

"EventTarget": {

16986

"name": "EventTarget",

16987

"shortname": "EventTarget",

16988

"classitems": [],

16989

"plugins": [],

16990

"extensions": [],

16991

"plugin_for": [],

16992

"extension_for": [

16993

"Attribute",

16994

"AttributeEvents",

16995

"Base",

16996

"YUI",

16997

"Intl",

16998

"Node"

16999

],

17000

"module": "event-custom",

17001

"submodule": "event-custom-base",

17002

"namespace": "",

17003

"file": "event-custom/js/event-target.js",

17004

"line": 9,

17005

"description": "EventTarget provides the implementation for any object to\npublish, subscribe and fire to custom events, and also\nalows other EventTargets to target the object with events\nsourced from the other object.\nEventTarget is designed to be used with Y.augment to wrap\nEventCustom in an interface that allows events to be listened to\nand fired by name. This makes it possible for implementing code to\nsubscribe to an event that either has not been created yet, or will\nnot be created at all.",

17006

"params": [

17007

{

17008

"name": "opts",

17009

"description": "a configuration object"

17010

}

17011

],

17012

"itemtype": "config",

17013

"type": "Boolean"

17014

},

17015

"EventHandle": {

17016

"name": "EventHandle",

17017

"shortname": "EventHandle",

17018

"classitems": [],

17019

"plugins": [],

17020

"extensions": [],

17021

"plugin_for": [],

17022

"extension_for": [],

17023

"module": "event-custom",

17024

"namespace": "",

17025

"file": "event-custom/js/handle.js",

17026

"line": 1,

17027

"description": "Return value from all subscribe operations",

17028

"is_constructor": 1,

17029

"params": [

17030

{

17031

"name": "evt",

17032

"description": "the custom event.",

17033

"type": "CustomEvent"

17034

},

17035

{

17036

"name": "sub",

17037

"description": "the subscriber.",

17038

"type": "Subscriber"

17039

}

17040

]

17041

},

17042

"Subscriber": {

17043

"name": "Subscriber",

17044

"shortname": "Subscriber",

17045

"classitems": [],

17046

"plugins": [],

17047

"extensions": [],

17048

"plugin_for": [],

17049

"extension_for": [],

17050

"module": "event-custom",

17051

"namespace": "",

17052

"file": "event-custom/js/subscriber.js",

17053

"line": 1,

17054

"description": "Stores the subscriber information to be used when the event fires.",

17055

"params": [

17056

{

17057

"name": "fn",

17058

"description": "The wrapped function to execute.",

17059

"type": "Function"

17060

},

17061

{

17062

"name": "context",

17063

"description": "The value of the keyword 'this' in the listener.",

17064

"type": "Object"

17065

},

17066

{

17067

"name": "args",

17068

"description": "0..n additional arguments to supply the listener.",

17069

"type": "Array",

17070

"multiple": true

17071

}

17072

],

17073

"is_constructor": 1

17074

},

17075

"Event": {

17076

"name": "Event",

17077

"shortname": "Event",

17078

"classitems": [],

17079

"plugins": [],

17080

"extensions": [],

17081

"plugin_for": [],

17082

"extension_for": [],

17083

"module": "event",

17084

"namespace": "",

17085

"file": "event/js/event-dom.js",

17086

"line": 11,

17087

"description": "The event utility provides functions to add and remove event listeners,\nevent cleansing. It also tries to automatically remove listeners it\nregisters during the unload event.",

17088

"submodule": "event-base",

17089

"static": 1

17090

},

17091

"ValueChange": {

17092

"name": "ValueChange",

17093

"shortname": "ValueChange",

17094

"classitems": [],

17095

"plugins": [],

17096

"extensions": [],

17097

"plugin_for": [],

17098

"extension_for": [],

17099

"module": "event-valuechange",

17100

"namespace": "",

17101

"file": "event-valuechange/js/event-valuechange.js",

17102

"line": 18,

17103

"description": "Provides the implementation for the synthetic `valueChange` event. This class\nisn't meant to be used directly, but is public to make monkeypatching possible.\n\nUsage:\n\n YUI().use('event-valuechange', function (Y) {\n Y.one('#my-input').on('valueChange', function (e) {\n Y.log('previous value: ' + e.prevVal);\n Y.log('new value: ' + e.newVal);\n });\n });",

17104

"static": 1

17105

},

17106

"DOMEventFacade": {

17107

"name": "DOMEventFacade",

17108

"shortname": "DOMEventFacade",

17109

"classitems": [],

17110

"plugins": [],

17111

"extensions": [],

17112

"plugin_for": [],

17113

"extension_for": [],

17114

"module": "event",

17115

"namespace": "",

17116

"file": "event/js/event-facade-dom.js",

17117

"line": 8,

17118

"description": "Wraps a DOM event, properties requiring browser abstraction are\nfixed here. Provids a security layer when required.",

17119

"submodule": "event-base",

17120

"params": [

17121

{

17122

"name": "ev",

17123

"description": "the DOM event",

17124

"type": "Event"

17125

},

17126

{

17127

"name": "currentTarget",

17128

"description": "the element the listener was attached to",

17129

"type": "HTMLElement"

17130

},

17131

{

17132

"name": "wrapper",

17133

"description": "the custom event wrapper for this DOM event",

17134

"type": "Event.Custom"

17135

}

17136

]

17137

},

17138

"SyntheticEvent.Notifier": {

17139

"name": "SyntheticEvent.Notifier",

17140

"shortname": "SyntheticEvent.Notifier",

17141

"classitems": [],

17142

"plugins": [],

17143

"extensions": [],

17144

"plugin_for": [],

17145

"extension_for": [],

17146

"module": "event",

17147

"submodule": "event-synthetic",

17148

"namespace": "",

17149

"file": "event/js/synthetic.js",

17150

"line": 16,

17151

"description": "The triggering mechanism used by SyntheticEvents.\n\nImplementers should not instantiate these directly. Use the Notifier\nprovided to the event's implemented <code>on(node, sub, notifier)</code> or\n<code>delegate(node, sub, notifier, filter)</code> methods.",

17152

"is_constructor": 1,

17153

"params": [

17154

{

17155

"name": "handle",

17156

"description": "the detach handle for the subscription to an\n internal custom event used to execute the callback passed to\n on(..) or delegate(..)",

17157

"type": "EventHandle"

17158

},

17159

{

17160

"name": "emitFacade",

17161

"description": "take steps to ensure the first arg received by\n the subscription callback is an event facade",

17162

"type": "Boolean"

17163

}

17164

],

17165

"access": "private",

17166

"tagname": "",

17167

"since": "3.2.0"

17168

},

17169

"SynthRegistry": {

17170

"name": "SynthRegistry",

17171

"shortname": "SynthRegistry",

17172

"classitems": [],

17173

"plugins": [],

17174

"extensions": [],

17175

"plugin_for": [],

17176

"extension_for": [],

17177

"module": "event",

17178

"submodule": "event-synthetic",

17179

"namespace": "",

17180

"file": "event/js/synthetic.js",

17181

"line": 104,

17182

"description": "Manager object for synthetic event subscriptions to aggregate multiple synths on the same node without colliding with actual DOM subscription entries in the global map of DOM subscriptions. Also facilitates proper cleanup on page unload.",

17183

"is_constructor": 1,

17184

"params": [

17185

{

17186

"name": "el",

17187

"description": "the DOM element",

17188

"type": "HTMLElement"

17189

},

17190

{

17191

"name": "yuid",

17192

"description": "the yuid stamp for the element",

17193

"type": "String"

17194

},

17195

{

17196

"name": "key",

17197

"description": "the generated id token used to identify an event type +\n element in the global DOM subscription map.",

17198

"type": "String"

17199

}

17200

],

17201

"access": "private",

17202

"tagname": ""

17203

},

17204

"SyntheticEvent": {

17205

"name": "SyntheticEvent",

17206

"shortname": "SyntheticEvent",

17207

"classitems": [],

17208

"plugins": [],

17209

"extensions": [],

17210

"plugin_for": [],

17211

"extension_for": [],

17212

"module": "event",

17213

"submodule": "event-synthetic",

17214

"namespace": "",

17215

"file": "event/js/synthetic.js",

17216

"line": 193,

17217

"description": "Wrapper class for the integration of new events into the YUI event\ninfrastructure. Don't instantiate this object directly, use\n<code>Y.Event.define(type, config)</code>. See that method for details.\n\nProperties that MAY or SHOULD be specified in the configuration are noted\nbelow and in the description of <code>Y.Event.define</code>.",

17218

"is_constructor": 1,

17219

"params": [

17220

{

17221

"name": "cfg",

17222

"description": "Implementation pieces and configuration",

17223

"type": "Object"

17224

}

17225

],

17226

"since": "3.1.0",

17227

"in": "event-synthetic"

17228

},

17229

"FileFlash": {

17230

"name": "FileFlash",

17231

"shortname": "FileFlash",

17232

"classitems": [],

17233

"plugins": [],

17234

"extensions": [],

17235

"plugin_for": [],

17236

"extension_for": [],

17237

"module": "file-flash",

17238

"namespace": "",

17239

"file": "file/js/file-flash.js",

17240

"line": 6,

17241

"description": "The class provides a wrapper for a file pointer in Flash.",

17242

"extends": "Base",

17243

"is_constructor": 1,

17244

"params": [

17245

{

17246

"name": "config",

17247

"description": "Configuration object.",

17248

"type": "Object"

17249

}

17250

]

17251

},

17252

"FileHTML5": {

17253

"name": "FileHTML5",

17254

"shortname": "FileHTML5",

17255

"classitems": [],

17256

"plugins": [],

17257

"extensions": [],

17258

"plugin_for": [],

17259

"extension_for": [],

17260

"module": "file-html5",

17261

"namespace": "",

17262

"file": "file/js/file-html5.js",

17263

"line": 7,

17264

"description": "The class provides a wrapper for a file pointer.",

17265

"extends": "Base",

17266

"is_constructor": 1,

17267

"params": [

17268

{

17269

"name": "config",

17270

"description": "Configuration object.",

17271

"type": "Object"

17272

}

17273

]

17274

},

17275

"File": {

17276

"name": "File",

17277

"shortname": "File",

17278

"classitems": [],

17279

"plugins": [],

17280

"extensions": [],

17281

"plugin_for": [],

17282

"extension_for": [],

17283

"module": "file",

17284

"namespace": "",

17285

"file": "file/js/file.js",

17286

"line": 10,

17287

"description": "`Y.File` serves as an alias for either <a href=\"FileFlash.html\">`Y.FileFlash`</a>\nor <a href=\"FileHTML5.html\">`Y.FileHTML5`</a>, depending on the feature set available\nin a specific browser."

17288

},

17289

"GetNodeJS": {

17290

"name": "GetNodeJS",

17291

"shortname": "GetNodeJS",

17292

"classitems": [],

17293

"plugins": [],

17294

"extensions": [],

17295

"plugin_for": [],

17296

"extension_for": [],

17297

"module": "get-nodejs",

17298

"namespace": "",

17299

"file": "get/js/get-nodejs.js",

17300

"line": 1,

17301

"description": "NodeJS specific Get module used to load remote resources. It contains the same signature as the default Get module so there is no code change needed."

17302

},

17303

"Get": {

17304

"name": "Get",

17305

"shortname": "Get",

17306

"classitems": [],

17307

"plugins": [],

17308

"extensions": [],

17309

"plugin_for": [],

17310

"extension_for": [],

17311

"module": "get",

17312

"namespace": "",

17313

"file": "get/js/get.js",

17314

"line": 3,

17315

"description": "Provides dynamic loading of remote JavaScript and CSS resources."

17316

},

17317

"Get.Transaction": {

17318

"name": "Get.Transaction",

17319

"shortname": "Get.Transaction",

17320

"classitems": [],

17321

"plugins": [],

17322

"extensions": [],

17323

"plugin_for": [],

17324

"extension_for": [],

17325

"module": "get",

17326

"namespace": "",

17327

"file": "get/js/get.js",

17328

"line": 718,

17329

"description": "Represents a Get transaction, which may contain requests for one or more JS or\nCSS files.\n\nThis class should not be instantiated manually. Instances will be created and\nreturned as needed by Y.Get's `css()`, `js()`, and `load()` methods.",

17330

"is_constructor": 1,

17331

"since": "3.5.0"

17332

},

17333

"CanvasCircle": {

17334

"name": "CanvasCircle",

17335

"shortname": "CanvasCircle",

17336

"classitems": [],

17337

"plugins": [],

17338

"extensions": [],

17339

"plugin_for": [],

17340

"extension_for": [],

17341

"module": "graphics",

17342

"namespace": "",

17343

"file": "graphics/js/CanvasCircle.js",

17344

"line": 1,

17345

"description": "<a href=\"http://www.w3.org/TR/html5/the-canvas-element.html\">Canvas</a> implementation of the <a href=\"Circle.html\">`Circle`</a> class. \n`CanvasCircle` is not intended to be used directly. Instead, use the <a href=\"Circle.html\">`Circle`</a> class. \nIf the browser lacks <a href=\"http://www.w3.org/TR/SVG/\">SVG</a> capabilities but has \n<a href=\"http://www.w3.org/TR/html5/the-canvas-element.html\">Canvas</a> capabilities, the <a href=\"Circle.html\">`Circle`</a> \nclass will point to the `CanvasCircle` class."

17346

},

17347

"CanvasDrawing": {

17348

"name": "CanvasDrawing",

17349

"shortname": "CanvasDrawing",

17350

"classitems": [],

17351

"plugins": [],

17352

"extensions": [],

17353

"plugin_for": [],

17354

"extension_for": [],

17355

"module": "graphics",

17356

"namespace": "",

17357

"file": "graphics/js/CanvasDrawing.js",

17358

"line": 19,

17359

"description": "<a href=\"http://www.w3.org/TR/html5/the-canvas-element.html\">Canvas</a> implementation of the <a href=\"Drawing.html\">`Drawing`</a> class. \n`CanvasDrawing` is not intended to be used directly. Instead, use the <a href=\"Drawing.html\">`Drawing`</a> class. \nIf the browser lacks <a href=\"http://www.w3.org/TR/SVG/\">SVG</a> capabilities but has \n<a href=\"http://www.w3.org/TR/html5/the-canvas-element.html\">Canvas</a> capabilities, the <a href=\"Drawing.html\">`Drawing`</a> \nclass will point to the `CanvasDrawing` class."

17360

},

17361

"CanvasEllipse": {

17362

"name": "CanvasEllipse",

17363

"shortname": "CanvasEllipse",

17364

"classitems": [],

17365

"plugins": [],

17366

"extensions": [],

17367

"plugin_for": [],

17368

"extension_for": [],

17369

"module": "graphics",

17370

"namespace": "",

17371

"file": "graphics/js/CanvasEllipse.js",

17372

"line": 1,

17373

"description": "<a href=\"http://www.w3.org/TR/html5/the-canvas-element.html\">Canvas</a> implementation of the <a href=\"Ellipse.html\">`Ellipse`</a> class. \n`CanvasEllipse` is not intended to be used directly. Instead, use the <a href=\"Ellipse.html\">`Ellipse`</a> class. \nIf the browser lacks <a href=\"http://www.w3.org/TR/SVG/\">SVG</a> capabilities but has \n<a href=\"http://www.w3.org/TR/html5/the-canvas-element.html\">Canvas</a> capabilities, the <a href=\"Ellipse.html\">`Ellipse`</a> \nclass will point to the `CanvasEllipse` class."

17374

},

17375

"CanvasGraphic": {

17376

"name": "CanvasGraphic",

17377

"shortname": "CanvasGraphic",

17378

"classitems": [],

17379

"plugins": [],

17380

"extensions": [],

17381

"plugin_for": [],

17382

"extension_for": [],

17383

"module": "graphics",

17384

"namespace": "",

17385

"file": "graphics/js/CanvasGraphic.js",

17386

"line": 1,

17387

"description": "<a href=\"http://www.w3.org/TR/html5/the-canvas-element.html\">Canvas</a> implementation of the `Graphic` class. \n`CanvasGraphic` is not intended to be used directly. Instead, use the <a href=\"Graphic.html\">`Graphic`</a> class. \nIf the browser lacks <a href=\"http://www.w3.org/TR/SVG/\">SVG</a> capabilities but has \n<a href=\"http://www.w3.org/TR/html5/the-canvas-element.html\">Canvas</a> capabilities, the <a href=\"Graphic.html\">`Graphic`</a> \nclass will point to the `CanvasGraphic` class."

17388

},

17389

"CanvasPath": {

17390

"name": "CanvasPath",

17391

"shortname": "CanvasPath",

17392

"classitems": [],

17393

"plugins": [],

17394

"extensions": [],

17395

"plugin_for": [],

17396

"extension_for": [],

17397

"module": "graphics",

17398

"namespace": "",

17399

"file": "graphics/js/CanvasPath.js",

17400

"line": 1,

17401

"description": "<a href=\"http://www.w3.org/TR/html5/the-canvas-element.html\">Canvas</a> implementation of the <a href=\"Path.html\">`Path`</a> class. \n`CanvasPath` is not intended to be used directly. Instead, use the <a href=\"Path.html\">`Path`</a> class. \nIf the browser lacks <a href=\"http://www.w3.org/TR/SVG/\">SVG</a> capabilities but has \n<a href=\"http://www.w3.org/TR/html5/the-canvas-element.html\">Canvas</a> capabilities, the <a href=\"Path.html\">`Path`</a> \nclass will point to the `CanvasPath` class."

17402

},

17403

"CanvasPieSlice": {

17404

"name": "CanvasPieSlice",

17405

"shortname": "CanvasPieSlice",

17406

"classitems": [],

17407

"plugins": [],

17408

"extensions": [],

17409

"plugin_for": [],

17410

"extension_for": [],

17411

"module": "graphics",

17412

"namespace": "",

17413

"file": "graphics/js/CanvasPieSlice.js",

17414

"line": 1,

17415

"description": "Draws pie slices"

17416

},

17417

"CanvasRect": {

17418

"name": "CanvasRect",

17419

"shortname": "CanvasRect",

17420

"classitems": [],

17421

"plugins": [],

17422

"extensions": [],

17423

"plugin_for": [],

17424

"extension_for": [],

17425

"module": "graphics",

17426

"namespace": "",

17427

"file": "graphics/js/CanvasRect.js",

17428

"line": 1,

17429

"description": "<a href=\"http://www.w3.org/TR/html5/the-canvas-element.html\">Canvas</a> implementation of the <a href=\"Rect.html\">`Rect`</a> class. \n`CanvasRect` is not intended to be used directly. Instead, use the <a href=\"Rect.html\">`Rect`</a> class. \nIf the browser lacks <a href=\"http://www.w3.org/TR/SVG/\">SVG</a> capabilities but has \n<a href=\"http://www.w3.org/TR/html5/the-canvas-element.html\">Canvas</a> capabilities, the <a href=\"Rect.html\">`Rect`</a> \nclass will point to the `CanvasRect` class."

17430

},

17431

"CanvasShape": {

17432

"name": "CanvasShape",

17433

"shortname": "CanvasShape",

17434

"classitems": [],

17435

"plugins": [],

17436

"extensions": [],

17437

"plugin_for": [],

17438

"extension_for": [],

17439

"module": "graphics",

17440

"namespace": "",

17441

"file": "graphics/js/CanvasShape.js",

17442

"line": 1,

17443

"description": "<a href=\"http://www.w3.org/TR/html5/the-canvas-element.html\">Canvas</a> implementation of the <a href=\"Shape.html\">`Shape`</a> class. \n`CanvasShape` is not intended to be used directly. Instead, use the <a href=\"Shape.html\">`Shape`</a> class. \nIf the browser lacks <a href=\"http://www.w3.org/TR/SVG/\">SVG</a> capabilities but has \n<a href=\"http://www.w3.org/TR/html5/the-canvas-element.html\">Canvas</a> capabilities, the <a href=\"Shape.html\">`Shape`</a> \nclass will point to the `CanvasShape` class."

17444

},

17445

"AttributeLite": {

17446

"name": "AttributeLite",

17447

"shortname": "AttributeLite",

17448

"classitems": [],

17449

"plugins": [],

17450

"extensions": [],

17451

"plugin_for": [],

17452

"extension_for": [],

17453

"module": "graphics",

17454

"namespace": "",

17455

"file": "graphics/js/GraphicBase.js",

17456

"line": 41,

17457

"description": "AttributeLite provides Attribute-like getters and setters for shape classes in the Graphics module. It provides a get/set API without the event infastructure.\nThis class is temporary and a work in progress.",

17458

"is_constructor": 1

17459

},

17460

"GraphicBase": {

17461

"name": "GraphicBase",

17462

"shortname": "GraphicBase",

17463

"classitems": [],

17464

"plugins": [],

17465

"extensions": [],

17466

"plugin_for": [],

17467

"extension_for": [],

17468

"module": "graphics",

17469

"namespace": "",

17470

"file": "graphics/js/GraphicBase.js",

17471

"line": 225,

17472

"description": "GraphicBase serves as the base class for the graphic layer. It serves the same purpose as\nBase but uses a lightweight getter/setter class instead of Attribute.\nThis class is temporary and a work in progress.",

17473

"is_constructor": 1,

17474

"params": [

17475

{

17476

"name": "cfg",

17477

"description": "Key value pairs for attributes",

17478

"type": "Object"

17479

}

17480

]

17481

},

17482

"Drawing": {

17483

"name": "Drawing",

17484

"shortname": "Drawing",

17485

"classitems": [],

17486

"plugins": [],

17487

"extensions": [],

17488

"plugin_for": [],

17489

"extension_for": [

17490

"Path"

17491

],

17492

"module": "graphics",

17493

"namespace": "",

17494

"file": "graphics/js/GraphicBase.js",

17495

"line": 282,

17496

"description": "`Drawing` provides a set of drawing methods used by `Path` and custom shape classes. \n`Drawing` has the following implementations based on browser capability.\n <ul>\n <li><a href=\"SVGDrawing.html\">`SVGDrawing`</a></li>\n <li><a href=\"VMLDrawing.html\">`VMLDrawing`</a></li>\n <li><a href=\"CanvasDrawing.html\">`CanvasDrawing`</a></li>\n </ul>",

17497

"is_constructor": 1

17498

},

17499

"Shape": {

17500

"name": "Shape",

17501

"shortname": "Shape",

17502

"classitems": [],

17503

"plugins": [],

17504

"extensions": [],

17505

"plugin_for": [],

17506

"extension_for": [],

17507

"module": "graphics",

17508

"namespace": "",

17509

"file": "graphics/js/GraphicBase.js",

17510

"line": 358,

17511

"description": "Base class for creating shapes.\n`Shape` is an abstract class and is not meant to be used directly. The following classes extend\n`Shape`.\n\n<ul>\n <li><a href=\"Circle.html\">`Circle`</a></li>\n <li><a href=\"Ellipse.html\">`Ellipse`</a></li>\n <li><a href=\"Rect.html\">`Rect`</a></li>\n <li><a href=\"Path.html\">`Path`</a></li>\n</ul>\n\n `Shape` can also be extended to create custom shape classes.\n\n `Shape` has the following implementations based on browser capability.\n<ul>\n <li><a href=\"SVGShape.html\">`SVGShape`</a></li>\n <li><a href=\"VMLShape.html\">`VMLShape`</a></li>\n <li><a href=\"CanvasShape.html\">`CanvasShape`</a></li>\n</ul>\n\n It is not necessary to interact with these classes directly. `Shape` will point to the appropriate implemention.",

17512

"is_constructor": 1,

17513

"params": [

17514

{

17515

"name": "cfg",

17516

"description": "(optional) Attribute configs",

17517

"type": "Object"

17518

}

17519

]

17520

},

17521

"Circle": {

17522

"name": "Circle",

17523

"shortname": "Circle",

17524

"classitems": [],

17525

"plugins": [],

17526

"extensions": [],

17527

"plugin_for": [],

17528

"extension_for": [],

17529

"module": "graphics",

17530

"namespace": "",

17531

"file": "graphics/js/GraphicBase.js",

17532

"line": 673,

17533

"description": "Creates circle shape with editable attributes. \n`Circle` instances can be created using the <a href=\"Graphic.html#method_addShape\">`addShape`</a> method of the <a href=\"Graphic.html\">`Graphic`</a> class. \nThe method's `cfg` argument contains a `type` attribute. Assigning \"circle\" or `Y.Circle` to this attribute will create a `Circle` instance. Required attributes\nfor instantiating a `Circle` are `type` and `radius`. Optional attributes include:\n <ul>\n <li><a href=\"#attr_fill\">fill</a></li>\n <li><a href=\"#attr_id\">id</a></li>\n <li><a href=\"#attr_stroke\">stroke</a></li>\n <li><a href=\"#attr_transform\">transform</a></li>\n <li><a href=\"#attr_transformOrigin\">transformOrigin</a></li>\n <li><a href=\"#attr_visible\">visible</a></li>\n <li><a href=\"#attr_x\">x</a></li>\n <li><a href=\"#attr_y\">y</a></li>\n </ul>\n\nThe below code creates a circle by defining the `type` attribute as \"circle\":\n\n var myCircle = myGraphic.addShape({\n type: \"circle\",\n radius: 10,\n fill: {\n color: \"#9aa\"\n },\n stroke: {\n weight: 1,\n color: \"#000\"\n }\n });\n\nBelow, this same circle is created by defining the `type` attribute with a class reference:\n\n var myCircle = myGraphic.addShape({\n type: Y.Circle,\n radius: 10,\n fill: {\n color: \"#9aa\"\n },\n stroke: {\n weight: 1,\n color: \"#000\"\n }\n });\n\n`Circle` has the following implementations based on browser capability.\n <ul>\n <li><a href=\"SVGCircle.html\">`SVGCircle`</a></li>\n <li><a href=\"VMLCircle.html\">`VMLCircle`</a></li>\n <li><a href=\"CanvasCircle.html\">`CanvasCircle`</a></li>\n </ul>\n\nIt is not necessary to interact with these classes directly. `Circle` will point to the appropriate implemention.",

17534

"extends": "Shape",

17535

"is_constructor": 1

17536

},

17537

"Ellipse": {

17538

"name": "Ellipse",

17539

"shortname": "Ellipse",

17540

"classitems": [],

17541

"plugins": [],

17542

"extensions": [],

17543

"plugin_for": [],

17544

"extension_for": [],

17545

"module": "graphics",

17546

"namespace": "",

17547

"file": "graphics/js/GraphicBase.js",

17548

"line": 736,

17549

"description": "Creates an ellipse shape with editable attributes.\n`Ellipse` instances can be created using the <a href=\"Graphic.html#method_addShape\">`addShape`</a> method of the <a href=\"Graphic.html\">`Graphic`</a> class. \nThe method's `cfg` argument contains a `type` attribute. Assigning \"ellipse\" or `Y.Ellipse` to this attribute will create a `Ellipse` instance. Required attributes\nfor instantiating a `Ellipse` are `type`, `width` and `height`. Optional attributes include:\n <ul>\n <li><a href=\"#attr_fill\">fill</a></li>\n <li><a href=\"#attr_id\">id</a></li>\n <li><a href=\"#attr_stroke\">stroke</a></li>\n <li><a href=\"#attr_transform\">transform</a></li>\n <li><a href=\"#attr_transformOrigin\">transformOrigin</a></li>\n <li><a href=\"#attr_visible\">visible</a></li>\n <li><a href=\"#attr_x\">x</a></li>\n <li><a href=\"#attr_y\">y</a></li>\n </ul>\n\nThe below code creates an ellipse by defining the `type` attribute as \"ellipse\":\n\n var myEllipse = myGraphic.addShape({\n type: \"ellipse\",\n width: 20,\n height: 10,\n fill: {\n color: \"#9aa\"\n },\n stroke: {\n weight: 1,\n color: \"#000\"\n }\n });\n\nBelow, the same ellipse is created by defining the `type` attribute with a class reference:\n\n var myEllipse = myGraphic.addShape({\n type: Y.Ellipse,\n width: 20,\n height: 10,\n fill: {\n color: \"#9aa\"\n },\n stroke: {\n weight: 1,\n color: \"#000\"\n }\n });\n\n`Ellipse` has the following implementations based on browser capability.\n <ul>\n <li><a href=\"SVGEllipse.html\">`SVGEllipse`</a></li>\n <li><a href=\"VMLEllipse.html\">`VMLEllipse`</a></li>\n <li><a href=\"CanvasEllipse.html\">`CanvasEllipse`</a></li>\n </ul>\n\nIt is not necessary to interact with these classes directly. `Ellipse` will point to the appropriate implemention.",

17550

"extends": "Shape",

17551

"is_constructor": 1

17552

},

17553

"Rect": {

17554

"name": "Rect",

17555

"shortname": "Rect",

17556

"classitems": [],

17557

"plugins": [],

17558

"extensions": [],

17559

"plugin_for": [],

17560

"extension_for": [],

17561

"module": "graphics",

17562

"namespace": "",

17563

"file": "graphics/js/GraphicBase.js",

17564

"line": 795,

17565

"description": "Creates an rectangle shape with editable attributes.\n`Rect` instances can be created using the <a href=\"Graphic.html#method_addShape\">`addShape`</a> method of the <a href=\"Graphic.html\">`Graphic`</a> \nclass. The method's `cfg` argument contains a `type` attribute. Assigning \"rect\" or `Y.Rect` to this attribute will create a `Rect` instance. \nRequired attributes for instantiating a `Rect` are `type`, `width` and `height`. Optional attributes include:\n <ul>\n <li><a href=\"#attr_fill\">fill</a></li>\n <li><a href=\"#attr_id\">id</a></li>\n <li><a href=\"#attr_stroke\">stroke</a></li>\n <li><a href=\"#attr_transform\">transform</a></li>\n <li><a href=\"#attr_transformOrigin\">transformOrigin</a></li>\n <li><a href=\"#attr_visible\">visible</a></li>\n <li><a href=\"#attr_x\">x</a></li>\n <li><a href=\"#attr_y\">y</a></li>\n </ul>\n\nThe below code creates a rectangle by defining the `type` attribute as \"rect\":\n\n var myRect = myGraphic.addShape({\n type: \"rect\",\n width: 20,\n height: 10,\n fill: {\n color: \"#9aa\"\n },\n stroke: {\n weight: 1,\n color: \"#000\"\n }\n });\n\nBelow, the same rectangle is created by defining the `type` attribute with a class reference:\n\n var myRect = myGraphic.addShape({\n type: Y.Rect,\n width: 20,\n height: 10,\n fill: {\n color: \"#9aa\"\n },\n stroke: {\n weight: 1,\n color: \"#000\"\n }\n });\n\n`Rect` has the following implementations based on browser capability.\n <ul>\n <li><a href=\"SVGRect.html\">`SVGRect`</a></li>\n <li><a href=\"VMLRect.html\">`VMLRect`</a></li>\n <li><a href=\"CanvasRect.html\">`CanvasRect`</a></li>\n </ul>\n\nIt is not necessary to interact with these classes directly. `Rect` will point to the appropriate implemention.",

17566

"extends": "Shape",

17567

"is_constructor": 1

17568

},

17569

"Path": {

17570

"name": "Path",

17571

"shortname": "Path",

17572

"classitems": [],

17573

"plugins": [],

17574

"extensions": [],

17575

"plugin_for": [],

17576

"extension_for": [],

17577

"module": "graphics",

17578

"namespace": "",

17579

"file": "graphics/js/GraphicBase.js",

17580

"line": 854,

17581

"description": "The `Path` class creates a shape through the use of drawing methods. The `Path` class has the following drawing methods available:\n <ul>\n <li><a href=\"#method_clear\">`clear`</a></li>\n <li><a href=\"#method_curveTo\">`curveTo`</a></li>\n <li><a href=\"#method_drawRect\">`drawRect`</a></li>\n <li><a href=\"#method_drawRoundRect\">`drawRoundRect`</a></li>\n <li><a href=\"#method_end\">`end`</a></li>\n <li><a href=\"#method_lineTo\">`lineTo`</a></li>\n <li><a href=\"#method_moveTo\">`moveTo`</a></li>\n <li><a href=\"#method_quadraticCurveTo\">`quadraticCurveTo`</a></li>\n </ul>\n\n Like other shapes, `Path` elements are created using the <a href=\"Graphic.html#method_addShape\">`addShape`</a> method of the <a href=\"Graphic.html\">`Graphic`</a> \n class. The method's `cfg` argument contains a `type` attribute. Assigning \"path\" or `Y.Path` to this attribute will create a `Path` instance.\n After instantiation, a series of drawing operations must be performed in order to render a shape. The below code instantiates a path element by defining the `type` \n attribute as \"path\":\n\n var myPath = myGraphic.addShape({\n type: \"path\",\n fill: {\n color: \"#9aa\"\n },\n stroke: {\n weight: 1,\n color: \"#000\"\n }\n });\n\nBelow a `Path` element with the same properties is instantiated by defining the `type` attribute with a class reference:\n\n var myPath = myGraphic.addShape({\n type: Y.Path,\n fill: {\n color: \"#9aa\"\n },\n stroke: {\n weight: 1,\n color: \"#000\"\n }\n });\n\nAfter instantiation, a shape or segment needs to be drawn for an element to render. After all draw operations are performed, the <a href=\"#method_end\">`end`</a>\nmethod will render the shape. The code below will draw a triangle:\n\n myPath.moveTo(35, 5);\n myPath.lineTo(65, 65);\n myPath.lineTo(5, 65);\n myPath.lineTo(35, 5);\n myPath.end();\n\n`Path` has the following implementations based on browser capability.\n <ul>\n <li><a href=\"SVGPath.html\">`SVGPath`</a></li>\n <li><a href=\"VMLPath.html\">`VMLPath`</a></li>\n <li><a href=\"CanvasPath.html\">`CanvasPath`</a></li>\n </ul> \nIt is not necessary to interact with these classes directly. `Path` will point to the appropriate implemention.",

17582

"extends": "Shape",

17583

"uses": [

17584

"Drawing"

17585

],

17586

"is_constructor": 1

17587

},

17588

"Graphic": {

17589

"name": "Graphic",

17590

"shortname": "Graphic",

17591

"classitems": [],

17592

"plugins": [],

17593

"extensions": [],

17594

"plugin_for": [],

17595

"extension_for": [],

17596

"module": "graphics",

17597

"namespace": "",

17598

"file": "graphics/js/GraphicBase.js",

17599

"line": 925,

17600

"description": "`Graphic` acts a factory and container for shapes. You need at least one `Graphic` instance to create shapes for your application. \nThe code block below creates a `Graphic` instance and appends it to an HTMLElement with the id 'mygraphiccontainer'.\n \n var myGraphic = new Y.Graphic({render:\"#mygraphiccontainer\"});\n\nAlternatively, you can add a `Graphic` instance to the DOM using the <a href=\"#method_render\">`render`</a> method.\n var myGraphic = new Y.Graphic();\n myGraphic.render(\"#mygraphiccontainer\");\n\n`Graphic` has the following implementations based on browser capability.\n <ul>\n <li><a href=\"SVGGraphic.html\">`SVGGraphic`</a></li>\n <li><a href=\"VMLGraphic.html\">`VMLGraphic`</a></li>\n <li><a href=\"CanvasGraphic.html\">`CanvasGraphic`</a></li>\n </ul>\n\nIt is not necessary to interact with these classes directly. `Graphic` will point to the appropriate implemention.",

17601

"is_constructor": 1

17602

},

17603

"SVGCircle": {

17604

"name": "SVGCircle",

17605

"shortname": "SVGCircle",

17606

"classitems": [],

17607

"plugins": [],

17608

"extensions": [],

17609

"plugin_for": [],

17610

"extension_for": [],

17611

"module": "graphics",

17612

"namespace": "",

17613

"file": "graphics/js/SVGCircle.js",

17614

"line": 1,

17615

"description": "<a href=\"http://www.w3.org/TR/SVG/\">SVG</a> implementation of the <a href=\"Circle.html\">`Circle`</a> class. \n`SVGCircle` is not intended to be used directly. Instead, use the <a href=\"Circle.html\">`Circle`</a> class. \nIf the browser has <a href=\"http://www.w3.org/TR/SVG/\">SVG</a> capabilities, the <a href=\"Circle.html\">`Circle`</a> \nclass will point to the `SVGCircle` class."

17616

},

17617

"SVGDrawing": {

17618

"name": "SVGDrawing",

17619

"shortname": "SVGDrawing",

17620

"classitems": [],

17621

"plugins": [],

17622

"extensions": [],

17623

"plugin_for": [],

17624

"extension_for": [],

17625

"module": "graphics",

17626

"namespace": "",

17627

"file": "graphics/js/SVGDrawing.js",

17628

"line": 15,

17629

"description": "<a href=\"http://www.w3.org/TR/SVG/\">SVG</a> implementation of the <a href=\"Drawing.html\">`Drawing`</a> class. \n`SVGDrawing` is not intended to be used directly. Instead, use the <a href=\"Drawing.html\">`Drawing`</a> class. \nIf the browser has <a href=\"http://www.w3.org/TR/SVG/\">SVG</a> capabilities, the <a href=\"Drawing.html\">`Drawing`</a> \nclass will point to the `SVGDrawing` class."

17630

},

17631

"SVGEllipse": {

17632

"name": "SVGEllipse",

17633

"shortname": "SVGEllipse",

17634

"classitems": [],

17635

"plugins": [],

17636

"extensions": [],

17637

"plugin_for": [],

17638

"extension_for": [],

17639

"module": "graphics",

17640

"namespace": "",

17641

"file": "graphics/js/SVGEllipse.js",

17642

"line": 1,

17643

"description": "<a href=\"http://www.w3.org/TR/SVG/\">SVG</a> implementation of the <a href=\"Ellipse.html\">`Ellipse`</a> class. \n`SVGEllipse` is not intended to be used directly. Instead, use the <a href=\"Ellipse.html\">`Ellipse`</a> class. \nIf the browser has <a href=\"http://www.w3.org/TR/SVG/\">SVG</a> capabilities, the <a href=\"Ellipse.html\">`Ellipse`</a> \nclass will point to the `SVGEllipse` class."

17644

},

17645

"SVGGraphic": {

17646

"name": "SVGGraphic",

17647

"shortname": "SVGGraphic",

17648

"classitems": [],

17649

"plugins": [],

17650

"extensions": [],

17651

"plugin_for": [],

17652

"extension_for": [],

17653

"module": "graphics",

17654

"namespace": "",

17655

"file": "graphics/js/SVGGraphic.js",

17656

"line": 1,

17657

"description": "<a href=\"http://www.w3.org/TR/SVG/\">SVG</a> implementation of the <a href=\"Graphic.html\">`Graphic`</a> class. \n`SVGGraphic` is not intended to be used directly. Instead, use the <a href=\"Graphic.html\">`Graphic`</a> class. \nIf the browser has <a href=\"http://www.w3.org/TR/SVG/\">SVG</a> capabilities, the <a href=\"Graphic.html\">`Graphic`</a> \nclass will point to the `SVGGraphic` class."

17658

},

17659

"SVGPath": {

17660

"name": "SVGPath",

17661

"shortname": "SVGPath",

17662

"classitems": [],

17663

"plugins": [],

17664

"extensions": [],

17665

"plugin_for": [],

17666

"extension_for": [],

17667

"module": "graphics",

17668

"namespace": "",

17669

"file": "graphics/js/SVGPath.js",

17670

"line": 1,

17671

"description": "<a href=\"http://www.w3.org/TR/SVG/\">SVG</a> implementation of the <a href=\"Path.html\">`Path`</a> class. \n`SVGPath` is not intended to be used directly. Instead, use the <a href=\"Path.html\">`Path`</a> class. \nIf the browser has <a href=\"http://www.w3.org/TR/SVG/\">SVG</a> capabilities, the <a href=\"Path.html\">`Path`</a> \nclass will point to the `SVGPath` class."

17672

},

17673

"SVGPieSlice": {

17674

"name": "SVGPieSlice",

17675

"shortname": "SVGPieSlice",

17676

"classitems": [],

17677

"plugins": [],

17678

"extensions": [],

17679

"plugin_for": [],

17680

"extension_for": [],

17681

"module": "graphics",

17682

"namespace": "",

17683

"file": "graphics/js/SVGPieSlice.js",

17684

"line": 1,

17685

"description": "Draws pie slices"

17686

},

17687

"SVGRect": {

17688

"name": "SVGRect",

17689

"shortname": "SVGRect",

17690

"classitems": [],

17691

"plugins": [],

17692

"extensions": [],

17693

"plugin_for": [],

17694

"extension_for": [],

17695

"module": "graphics",

17696

"namespace": "",

17697

"file": "graphics/js/SVGRect.js",

17698

"line": 1,

17699

"description": "<a href=\"http://www.w3.org/TR/SVG/\">SVG</a> implementation of the <a href=\"Rect.html\">`Rect`</a> class. \n`SVGRect` is not intended to be used directly. Instead, use the <a href=\"Rect.html\">`Rect`</a> class. \nIf the browser has <a href=\"http://www.w3.org/TR/SVG/\">SVG</a> capabilities, the <a href=\"Rect.html\">`Rect`</a> \nclass will point to the `SVGRect` class."

17700

},

17701

"SVGShape": {

17702

"name": "SVGShape",

17703

"shortname": "SVGShape",

17704

"classitems": [],

17705

"plugins": [],

17706

"extensions": [],

17707

"plugin_for": [],

17708

"extension_for": [],

17709

"module": "graphics",

17710

"namespace": "",

17711

"file": "graphics/js/SVGShape.js",

17712

"line": 1,

17713

"description": "<a href=\"http://www.w3.org/TR/SVG/\">SVG</a> implementation of the <a href=\"Shape.html\">`Shape`</a> class. \n`SVGShape` is not intended to be used directly. Instead, use the <a href=\"Shape.html\">`Shape`</a> class. \nIf the browser has <a href=\"http://www.w3.org/TR/SVG/\">SVG</a> capabilities, the <a href=\"Shape.html\">`Shape`</a> \nclass will point to the `SVGShape` class."

17714

},

17715

"VMLCircle": {

17716

"name": "VMLCircle",

17717

"shortname": "VMLCircle",

17718

"classitems": [],

17719

"plugins": [],

17720

"extensions": [],

17721

"plugin_for": [],

17722

"extension_for": [],

17723

"module": "graphics",

17724

"namespace": "",

17725

"file": "graphics/js/VMLCircle.js",

17726

"line": 1,

17727

"description": "<a href=\"http://www.w3.org/TR/NOTE-VML\">VML</a> implementation of the <a href=\"Circle.html\">`Circle`</a> class. \n`VMLCircle` is not intended to be used directly. Instead, use the <a href=\"Circle.html\">`Circle`</a> class. \nIf the browser lacks <a href=\"http://www.w3.org/TR/SVG/\">SVG</a> and <a href=\"http://www.w3.org/TR/html5/the-canvas-element.html\">Canvas</a> \ncapabilities, the <a href=\"Circle.html\">`Circle`</a> class will point to the `VMLCircle` class."

17728

},

17729

"VMLDrawing": {

17730

"name": "VMLDrawing",

17731

"shortname": "VMLDrawing",

17732

"classitems": [],

17733

"plugins": [],

17734

"extensions": [],

17735

"plugin_for": [],

17736

"extension_for": [],

17737

"module": "graphics",

17738

"namespace": "",

17739

"file": "graphics/js/VMLDrawing.js",

17740

"line": 19,

17741

"description": "<a href=\"http://www.w3.org/TR/NOTE-VML\">VML</a> implementation of the <a href=\"Drawing.html\">`Drawing`</a> class. \n`VMLDrawing` is not intended to be used directly. Instead, use the <a href=\"Drawing.html\">`Drawing`</a> class. \nIf the browser lacks <a href=\"http://www.w3.org/TR/SVG/\">SVG</a> and <a href=\"http://www.w3.org/TR/html5/the-canvas-element.html\">Canvas</a> \ncapabilities, the <a href=\"Drawing.html\">`Drawing`</a> class will point to the `VMLDrawing` class."

17742

},

17743

"VMLEllipse": {

17744

"name": "VMLEllipse",

17745

"shortname": "VMLEllipse",

17746

"classitems": [],

17747

"plugins": [],

17748

"extensions": [],

17749

"plugin_for": [],

17750

"extension_for": [],

17751

"module": "graphics",

17752

"namespace": "",

17753

"file": "graphics/js/VMLEllipse.js",

17754

"line": 1,

17755

"description": "<a href=\"http://www.w3.org/TR/NOTE-VML\">VML</a> implementation of the <a href=\"Ellipse.html\">`Ellipse`</a> class. \n`VMLEllipse` is not intended to be used directly. Instead, use the <a href=\"Ellipse.html\">`Ellipse`</a> class. \nIf the browser lacks <a href=\"http://www.w3.org/TR/SVG/\">SVG</a> and <a href=\"http://www.w3.org/TR/html5/the-canvas-element.html\">Canvas</a> \ncapabilities, the <a href=\"Ellipse.html\">`Ellipse`</a> class will point to the `VMLEllipse` class."

17756

},

17757

"VMLGraphic": {

17758

"name": "VMLGraphic",

17759

"shortname": "VMLGraphic",

17760

"classitems": [],

17761

"plugins": [],

17762

"extensions": [],

17763

"plugin_for": [],

17764

"extension_for": [],

17765

"module": "graphics",

17766

"namespace": "",

17767

"file": "graphics/js/VMLGraphic.js",

17768

"line": 1,

17769

"description": "<a href=\"http://www.w3.org/TR/NOTE-VML\">VML</a> implementation of the <a href=\"Graphic.html\">`Graphic`</a> class. \n`VMLGraphic` is not intended to be used directly. Instead, use the <a href=\"Graphic.html\">`Graphic`</a> class. \nIf the browser lacks <a href=\"http://www.w3.org/TR/SVG/\">SVG</a> and <a href=\"http://www.w3.org/TR/html5/the-canvas-element.html\">Canvas</a> \ncapabilities, the <a href=\"Graphic.html\">`Graphic`</a> class will point to the `VMLGraphic` class."

17770

},

17771

"VMLPath": {

17772

"name": "VMLPath",

17773

"shortname": "VMLPath",

17774

"classitems": [],

17775

"plugins": [],

17776

"extensions": [],

17777

"plugin_for": [],

17778

"extension_for": [],

17779

"module": "graphics",

17780

"namespace": "",

17781

"file": "graphics/js/VMLPath.js",

17782

"line": 1,

17783

"description": "<a href=\"http://www.w3.org/TR/NOTE-VML\">VML</a> implementation of the <a href=\"Path.html\">`Path`</a> class. \n`VMLPath` is not intended to be used directly. Instead, use the <a href=\"Path.html\">`Path`</a> class. \nIf the browser lacks <a href=\"http://www.w3.org/TR/SVG/\">SVG</a> and <a href=\"http://www.w3.org/TR/html5/the-canvas-element.html\">Canvas</a> \ncapabilities, the <a href=\"Path.html\">`Path`</a> class will point to the `VMLPath` class."

17784

},

17785

"VMLPieSlice": {

17786

"name": "VMLPieSlice",

17787

"shortname": "VMLPieSlice",

17788

"classitems": [],

17789

"plugins": [],

17790

"extensions": [],

17791

"plugin_for": [],

17792

"extension_for": [],

17793

"module": "graphics",

17794

"namespace": "",

17795

"file": "graphics/js/VMLPieSlice.js",

17796

"line": 1,

17797

"description": "Draws pie slices"

17798

},

17799

"VMLRect": {

17800

"name": "VMLRect",

17801

"shortname": "VMLRect",

17802

"classitems": [],

17803

"plugins": [],

17804

"extensions": [],

17805

"plugin_for": [],

17806

"extension_for": [],

17807

"module": "graphics",

17808

"namespace": "",

17809

"file": "graphics/js/VMLRect.js",

17810

"line": 1,

17811

"description": "<a href=\"http://www.w3.org/TR/NOTE-VML\">VML</a> implementation of the <a href=\"Rect.html\">`Rect`</a> class. \n`VMLRect` is not intended to be used directly. Instead, use the <a href=\"Rect.html\">`Rect`</a> class. \nIf the browser lacks <a href=\"http://www.w3.org/TR/SVG/\">SVG</a> and <a href=\"http://www.w3.org/TR/html5/the-canvas-element.html\">Canvas</a> \ncapabilities, the <a href=\"Rect.html\">`Rect`</a> class will point to the `VMLRect` class."

17812

},

17813

"VMLShape": {

17814

"name": "VMLShape",

17815

"shortname": "VMLShape",

17816

"classitems": [],

17817

"plugins": [],

17818

"extensions": [],

17819

"plugin_for": [],

17820

"extension_for": [],

17821

"module": "graphics",

17822

"namespace": "",

17823

"file": "graphics/js/VMLShape.js",

17824

"line": 1,

17825

"description": "<a href=\"http://www.w3.org/TR/NOTE-VML\">VML</a> implementation of the <a href=\"Shape.html\">`Shape`</a> class. \n`VMLShape` is not intended to be used directly. Instead, use the <a href=\"Shape.html\">`Shape`</a> class. \nIf the browser lacks <a href=\"http://www.w3.org/TR/SVG/\">SVG</a> and <a href=\"http://www.w3.org/TR/html5/the-canvas-element.html\">Canvas</a> \ncapabilities, the <a href=\"Shape.html\">`Shape`</a> class will point to the `VMLShape` class."

17826

},

17827

"Handlebars": {

17828

"name": "Handlebars",

17829

"shortname": "Handlebars",

17830

"classitems": [],

17831

"plugins": [],

17832

"extensions": [],

17833

"plugin_for": [],

17834

"extension_for": [],

17835

"module": "handlebars",

17836

"submodule": "handlebars-base",

17837

"namespace": "",

17838

"file": "handlebars/js/yui-handlebars-base-after.js",

17839

"line": 23,

17840

"description": "Handlebars is a simple template language inspired by Mustache.\n\nThis is a YUI port of the original Handlebars project, which can be found at\n<https://github.com/wycats/handlebars.js>.",

17841

"since": "3.5.0"

17842

},

17843

"Highlight": {

17844

"name": "Highlight",

17845

"shortname": "Highlight",

17846

"classitems": [],

17847

"plugins": [],

17848

"extensions": [],

17849

"plugin_for": [],

17850

"extension_for": [],

17851

"module": "highlight",

17852

"submodule": "highlight-base",

17853

"namespace": "",

17854

"file": "highlight/js/highlight-base.js",

17855

"line": 11,

17856

"static": 1,

17857

"description": "Provides methods for highlighting strings within other strings by wrapping\nthem in HTML.\n\nThe highlight methods first escape any special HTML characters in the input\nstrings and then highlight the appropriate substrings by wrapping them in a\n`` element. The `` element is used rather than\n`` in accordance with HTML5's definition of `` as being purely\npresentational, which is exactly what highlighting is."

17858

},

17859

"HistoryBase": {

17860

"name": "HistoryBase",

17861

"shortname": "HistoryBase",

17862

"classitems": [],

17863

"plugins": [],

17864

"extensions": [],

17865

"plugin_for": [],

17866

"extension_for": [],

17867

"module": "history",

17868

"submodule": "history-base",

17869

"namespace": "",

17870

"file": "history/js/history-base.js",

17871

"line": 13,

17872

"description": "Provides global state management backed by an object, but with no browser\nhistory integration. For actual browser history integration and back/forward\nsupport, use the history-html5 or history-hash modules."

17873

},

17874

"HistoryHash": {

17875

"name": "HistoryHash",

17876

"shortname": "HistoryHash",

17877

"classitems": [],

17878

"plugins": [],

17879

"extensions": [],

17880

"plugin_for": [],

17881

"extension_for": [],

17882

"module": "history",

17883

"submodule": "history-hash",

17884

"namespace": "",

17885

"file": "history/js/history-hash.js",

17886

"line": 1,

17887

"description": "Provides browser history management backed by\n<code>window.location.hash</code>, as well as convenience methods for working\nwith the location hash and a synthetic <code>hashchange</code> event that\nnormalizes differences across browsers.",

17888

"since": "3.2.0"

17889

},

17890

"HistoryHTML5": {

17891

"name": "HistoryHTML5",

17892

"shortname": "HistoryHTML5",

17893

"classitems": [],

17894

"plugins": [],

17895

"extensions": [],

17896

"plugin_for": [],

17897

"extension_for": [],

17898

"module": "history",

17899

"submodule": "history-html5",

17900

"namespace": "",

17901

"file": "history/js/history-html5.js",

17902

"line": 9,

17903

"description": "\nProvides browser history management using the HTML5 history API.\n\n\n\nWhen calling the <code>add()</code>, <code>addValue()</code>,\n<code>replace()</code>, or <code>replaceValue()</code> methods on\n<code>HistoryHTML5</code>, the following additional options are supported:\n\n\n<dl>\n <dt>title (String)</dt>\n <dd>\n Title to use for the new history entry. Browsers will typically display\n this title to the user in the detailed history window or in a dropdown\n menu attached to the back/forward buttons. If not specified, the title\n of the current document will be used.\n </dd>\n\n <dt>url (String)</dt>\n <dd>\n URL to display to the user for the new history entry. This URL will be\n visible in the browser's address bar and will be the bookmarked URL if\n the user bookmarks the page. It may be a relative path (\"foo/bar\"), an\n absolute path (\"/foo/bar\"), or a full URL (\"http://example.com/foo/bar\").\n If you specify a full URL, the origin must be the same as the \n origin of the current page, or an error will occur. If no URL is\n specified, the current URL will not be changed.\n </dd>\n</dl>",

17904

"extends": "HistoryBase",

17905

"is_constructor": 1,

17906

"params": [

17907

{

17908

"name": "config",

17909

"description": "(optional) Configuration object.",

17910

"type": "Object"

17911

}

17912

]

17913

},

17914

"config": {

17915

"name": "config",

17916

"shortname": "config",

17917

"classitems": [],

17918

"plugins": [],

17919

"extensions": [],

17920

"plugin_for": [],

17921

"extension_for": [],

17922

"module": "yui",

17923

"submodule": "yui-base",

17924

"namespace": "",

17925

"file": "yui/js/yui.js",

17926

"line": 1316,

17927

"description": "The config object contains all of the configuration options for\nthe `YUI` instance. This object is supplied by the implementer\nwhen instantiating a `YUI` instance. Some properties have default\nvalues if they are not supplied by the implementer. This should\nnot be updated directly because some values are cached. Use\n`applyConfig()` to update the config object on a YUI instance that\nhas already been configured.",

17928

"static": 1

17929

},

17930

"ImgLoadGroup": {

17931

"name": "ImgLoadGroup",

17932

"shortname": "ImgLoadGroup",

17933

"classitems": [],

17934

"plugins": [],

17935

"extensions": [],

17936

"plugin_for": [],

17937

"extension_for": [],

17938

"module": "imageloader",

17939

"namespace": "",

17940

"file": "imageloader/js/imageloader.js",

17941

"line": 9,

17942

"description": "A group for images. A group can have one time limit and a series of triggers. Thus the images belonging to this group must share these constraints.",

17943

"extends": "Base",

17944

"is_constructor": 1

17945

},

17946

"ImgLoadImgObj": {

17947

"name": "ImgLoadImgObj",

17948

"shortname": "ImgLoadImgObj",

17949

"classitems": [],

17950

"plugins": [],

17951

"extensions": [],

17952

"plugin_for": [],

17953

"extension_for": [],

17954

"module": "imageloader",

17955

"namespace": "",

17956

"file": "imageloader/js/imageloader.js",

17957

"line": 418,

17958

"description": "Image objects to be registered with the groups",

17959

"extends": "Base",

17960

"is_constructor": 1

17961

},

17962

"Intl": {

17963

"name": "Intl",

17964

"shortname": "Intl",

17965

"classitems": [],

17966

"plugins": [],

17967

"extensions": [],

17968

"plugin_for": [],

17969

"extension_for": [],

17970

"module": "features",

17971

"namespace": "",

17972

"file": "yui/js/intl-base.js",

17973

"line": 1,

17974

"description": "The Intl utility provides a central location for managing sets of\nlocalized resources (strings and formatting patterns).",

17975

"uses": [

17976

"EventTarget"

17977

],

17978

"static": 1

17979

},

17980

"IO": {

17981

"name": "IO",

17982

"shortname": "IO",

17983

"classitems": [],

17984

"plugins": [],

17985

"extensions": [],

17986

"plugin_for": [],

17987

"extension_for": [],

17988

"module": "io-base",

17989

"namespace": "",

17990

"file": "io/js/io-base.js",

17991

"line": 17,

17992

"description": "The IO class is a utility that brokers HTTP requests through a simplified\ninterface. Specifically, it allows JavaScript to make HTTP requests to\na resource without a page reload. The underlying transport for making\nsame-domain requests is the XMLHttpRequest object. IO can also use\nFlash, if specified as a transport, for cross-domain requests.",

17993

"is_constructor": 1,

17994

"params": [

17995

{

17996

"name": "config",

17997

"description": "Object of EventTarget's publish method configurations\n used to configure IO's events.",

17998

"type": "Object"

17999

}

18000

]

18001

},

18002

"JSON": {

18003

"name": "JSON",

18004

"shortname": "JSON",

18005

"classitems": [],

18006

"plugins": [],

18007

"extensions": [],

18008

"plugin_for": [],

18009

"extension_for": [],

18010

"module": "json",

18011

"namespace": "",

18012

"file": "json/js/parse.js",

18013

"line": 1,

18014

"description": "The JSON module adds support for serializing JavaScript objects into\nJSON strings and parsing JavaScript objects from strings in JSON format.\n\nThe JSON namespace is added to your YUI instance including static methods\nY.JSON.parse(..) and Y.JSON.stringify(..).\n\nThe functionality and method signatures follow the ECMAScript 5\nspecification. In browsers with native JSON support, the native\nimplementation is used.\n\nThe <code>json</code> module is a rollup of <code>json-parse</code> and\n<code>json-stringify</code>.\n\nAs their names suggest, <code>json-parse</code> adds support for parsing\nJSON data (Y.JSON.parse) and <code>json-stringify</code> for serializing\nJavaScript data into JSON strings (Y.JSON.stringify). You may choose to\ninclude either of the submodules individually if you don't need the\ncomplementary functionality, or include the rollup for both.",

18015

"mainName": "json",

18016

"tag": "main",

18017

"itemtype": "main",

18018

"_main": true,

18019

"submodule": "json-parse"

18020

},

18021

"JSONPRequest": {

18022

"name": "JSONPRequest",

18023

"shortname": "JSONPRequest",

18024

"classitems": [],

18025

"plugins": [],

18026

"extensions": [],

18027

"plugin_for": [],

18028

"extension_for": [],

18029

"module": "jsonp",

18030

"submodule": "jsonp-url",

18031

"namespace": "",

18032

"file": "jsonp/js/jsonp.js",

18033

"line": 3,

18034

"description": "Provides a JSONPRequest class for repeated JSONP calls, and a convenience\nmethod Y.jsonp(url, callback) to instantiate and send a JSONP request.\n\nBoth the constructor as well as the convenience function take two\nparameters: a url string and a callback.\n\nThe url provided must include the placeholder string\n"{callback}" which will be replaced by a dynamically\ngenerated routing function to pass the data to your callback function.\nAn example url might look like\n"http://example.com/service?callback={callback}".\n\nThe second parameter can be a callback function that accepts the JSON\npayload as its argument, or a configuration object supporting the keys:\n<ul>\n <li>on - map of callback subscribers\n <ul>\n <li>success - function handler for successful transmission</li>\n <li>failure - function handler for failed transmission</li>\n <li>timeout - function handler for transactions that timeout</li>\n </ul>\n </li>\n <li>format - override function for inserting the proxy name in the url</li>\n <li>timeout - the number of milliseconds to wait before giving up</li>\n <li>context - becomes <code>this</code> in the callbacks</li>\n <li>args - array of subsequent parameters to pass to the callbacks</li>\n <li>allowCache - use the same proxy name for all requests? (boolean)</li>\n</ul>"

18035

},

18036

"Loader": {

18037

"name": "Loader",

18038

"shortname": "Loader",

18039

"classitems": [],

18040

"plugins": [],

18041

"extensions": [],

18042

"plugin_for": [],

18043

"extension_for": [],

18044

"module": "loader",

18045

"submodule": "loader-base",

18046

"namespace": "",

18047

"file": "loader/js/loader.js",

18048

"line": 52,

18049

"description": "Loader dynamically loads script and css files. It includes the dependency\ninfo for the version of the library in use, and will automatically pull in\ndependencies for the modules requested. It can load the\nfiles from the Yahoo! CDN, and it can utilize the combo service provided on\nthis network to reduce the number of http connections required to download\nYUI files. You can also specify an external, custom combo service to host\nyour modules as well.\n\n var Y = YUI();\n var loader = new Y.Loader({\n filter: 'debug',\n base: '../../',\n root: 'build/',\n combine: true,\n require: ['node', 'dd', 'console']\n });\n var out = loader.resolve(true);",

18050

"is_constructor": 1,

18051

"params": [

18052

{

18053

"name": "config",

18054

"description": "an optional set of configuration options.",

18055

"type": "Object",

18056

"props": [

18057

{

18058

"name": "base",

18059

"description": "The base dir which to fetch this module from",

18060

"type": "String"

18061

},

18062

{

18063

"name": "comboBase",

18064

"description": "The Combo service base path. Ex: `http://yui.yahooapis.com/combo?`",

18065

"type": "String"

18066

},

18067

{

18068

"name": "root",

18069

"description": "The root path to prepend to module names for the combo service. Ex: `2.5.2/build/`",

18070

"type": "String"

18071

},

18072

{

18073

"name": "filter",

18074

"description": "A filter to apply to result urls. <a href=\"#property_filter\">See filter property</a>",

18075

"type": "String|Object"

18076

},

18077

{

18078

"name": "filters",

18079

"description": "Per-component filter specification. If specified for a given component, this overrides the filter config.",

18080

"type": "Object"

18081

},

18082

{

18083

"name": "combine",

18084

"description": "Use a combo service to reduce the number of http connections required to load your dependencies",

18085

"type": "Boolean"

18086

},

18087

{

18088

"name": "ignore:",

18089

"description": "A list of modules that should never be dynamically loaded",

18090

"type": "Array"

18091

},

18092

{

18093

"name": "force",

18094

"description": "A list of modules that should always be loaded when required, even if already present on the page",

18095

"type": "Array"

18096

},

18097

{

18098

"name": "insertBefore",

18099

"description": "Node or id for a node that should be used as the insertion point for new nodes",

18100

"type": "HTMLElement|String"

18101

},

18102

{

18103

"name": "jsAttributes",

18104

"description": "Object literal containing attributes to add to script nodes",

18105

"type": "Object"

18106

},

18107

{

18108

"name": "cssAttributes",

18109

"description": "Object literal containing attributes to add to link nodes",

18110

"type": "Object"

18111

},

18112

{

18113

"name": "timeout",

18114

"description": "The number of milliseconds before a timeout occurs when dynamically loading nodes. If not set, there is no timeout",

18115

"type": "Number"

18116

},

18117

{

18118

"name": "context",

18119

"description": "Execution context for all callbacks",

18120

"type": "Object"

18121

},

18122

{

18123

"name": "onSuccess",

18124

"description": "Callback for the 'success' event",

18125

"type": "Function"

18126

},

18127

{

18128

"name": "onFailure",

18129

"description": "Callback for the 'failure' event",

18130

"type": "Function"

18131

},

18132

{

18133

"name": "onCSS",

18134

"description": "Callback for the 'CSSComplete' event. When loading YUI components with CSS the CSS is loaded first, then the script. This provides a moment you can tie into to improve the presentation of the page while the script is loading.",

18135

"type": "Function"

18136

},

18137

{

18138

"name": "onTimeout",

18139

"description": "Callback for the 'timeout' event",

18140

"type": "Function"

18141

},

18142

{

18143

"name": "onProgress",

18144

"description": "Callback executed each time a script or css file is loaded",

18145

"type": "Function"

18146

},

18147

{

18148

"name": "modules",

18149

"description": "A list of module definitions. See <a href=\"#method_addModule\">Loader.addModule</a> for the supported module metadata",

18150

"type": "Object"

18151

},

18152

{

18153

"name": "groups",

18154

"description": "A list of group definitions. Each group can contain specific definitions for `base`, `comboBase`, `combine`, and accepts a list of `modules`.",

18155

"type": "Object"

18156

},

18157

{

18158

"name": "2in3",

18159

"description": "The version of the YUI 2 in 3 wrapper to use. The intrinsic support for YUI 2 modules in YUI 3 relies on versions of the YUI 2 components inside YUI 3 module wrappers. These wrappers change over time to accomodate the issues that arise from running YUI 2 in a YUI 3 sandbox.",

18160

"type": "String"

18161

},

18162

{

18163

"name": "yui2",

18164

"description": "When using the 2in3 project, you can select the version of YUI 2 to use. Valid values are `2.2.2`, `2.3.1`, `2.4.1`, `2.5.2`, `2.6.0`, `2.7.0`, `2.8.0`, `2.8.1` and `2.9.0` [default] -- plus all versions of YUI 2 going forward.",

18165

"type": "String"

18166

}

18167

]

18168

}

18169

]

18170

},

18171

"Matrix": {

18172

"name": "Matrix",

18173

"shortname": "Matrix",

18174

"classitems": [],

18175

"plugins": [],

18176

"extensions": [],

18177

"plugin_for": [],

18178

"extension_for": [],

18179

"module": "matrix",

18180

"namespace": "",

18181

"file": "matrix/js/Matrix.js",

18182

"line": 1,

18183

"description": "Matrix is a class that allows for the manipulation of a transform matrix.\nThis class is a work in progress.",

18184

"is_constructor": 1

18185

},

18186

"Plugin.Flick": {

18187

"name": "Plugin.Flick",

18188

"shortname": "Plugin.Flick",

18189

"classitems": [],

18190

"plugins": [],

18191

"extensions": [],

18192

"plugin_for": [],

18193

"extension_for": [],

18194

"module": "node-flick",

18195

"namespace": "Plugin",

18196

"file": "node-flick/js/NodeFlick.js",

18197

"line": 31,

18198

"description": "A plugin class which can be used to animate the motion of a node, in response to a flick gesture.",

18199

"params": [

18200

{

18201

"name": "config",

18202

"description": "The initial attribute values for the plugin",

18203

"type": "Object"

18204

}

18205

]

18206

},

18207

"plugin.NodeFocusManager": {

18208

"name": "plugin.NodeFocusManager",

18209

"shortname": "plugin.NodeFocusManager",

18210

"classitems": [],

18211

"plugins": [],

18212

"extensions": [],

18213

"plugin_for": [],

18214

"extension_for": [],

18215

"module": "node-focusmanager",

18216

"namespace": "plugin",

18217

"file": "node-focusmanager/js/node-focusmanager.js",

18218

"line": 67,

18219

"description": "The NodeFocusManager class is a plugin for a Node instance. The class is used\nvia the <a href=\"Node.html#method_plug\"><code>plug</code></a> method of Node\nand should not be instantiated directly."

18220

},

18221

"plugin.NodeMenuNav": {

18222

"name": "plugin.NodeMenuNav",

18223

"shortname": "plugin.NodeMenuNav",

18224

"classitems": [],

18225

"plugins": [],

18226

"extensions": [],

18227

"plugin_for": [],

18228

"extension_for": [],

18229

"module": "node-menunav",

18230

"namespace": "plugin",

18231

"file": "node-menunav/js/node-menunav.js",

18232

"line": 344,

18233

"description": "The NodeMenuNav class is a plugin for a Node instance. The class is used via \nthe <a href=\"Node.html#method_plug\"><code>plug</code></a> method of Node and \nshould not be instantiated directly."

18234

},

18235

"Plugin.Align": {

18236

"name": "Plugin.Align",

18237

"shortname": "Plugin.Align",

18238

"classitems": [],

18239

"plugins": [],

18240

"extensions": [],

18241

"plugin_for": [],

18242

"extension_for": [],

18243

"module": "align-plugin",

18244

"namespace": "",

18245

"file": "node/js/align-plugin.js",

18246

"line": 11,

18247

"description": "Node plugin which can be used to align a node with another node,\nregion, or the viewport.",

18248

"params": [

18249

{

18250

"name": "User",

18251

"description": "configuration object",

18252

"type": "Object"

18253

}

18254

]

18255

},

18256

"Node": {

18257

"name": "Node",

18258

"shortname": "Node",

18259

"classitems": [],

18260

"plugins": [],

18261

"extensions": [],

18262

"plugin_for": [],

18263

"extension_for": [],

18264

"module": "node",

18265

"submodule": "node-core",

18266

"namespace": "",

18267

"file": "node/js/node-core.js",

18268

"line": 8,

18269

"description": "The Node class provides a wrapper for manipulating DOM Nodes.\nNode properties can be accessed via the set/get methods.\nUse `Y.one()` to retrieve Node instances.\n\nNOTE: Node properties are accessed using\nthe <code>set</code> and <code>get</code> methods.",

18270

"is_constructor": 1,

18271

"params": [

18272

{

18273

"name": "node",

18274

"description": "the DOM node to be mapped to the Node instance.",

18275

"type": "DOMNode"

18276

}

18277

],

18278

"uses": [

18279

"EventTarget"

18280

]

18281

},

18282

"NodeList": {

18283

"name": "NodeList",

18284

"shortname": "NodeList",

18285

"classitems": [],

18286

"plugins": [],

18287

"extensions": [],

18288

"plugin_for": [],

18289

"extension_for": [],

18290

"module": "node",

18291

"submodule": "node-core",

18292

"namespace": "",

18293

"file": "node/js/nodelist.js",

18294

"line": 7,

18295

"description": "The NodeList class provides a wrapper for manipulating DOM NodeLists.\nNodeList properties can be accessed via the set/get methods.\nUse Y.all() to retrieve NodeList instances.",

18296

"is_constructor": 1

18297

},

18298

"Plugin.Shim": {

18299

"name": "Plugin.Shim",

18300

"shortname": "Plugin.Shim",

18301

"classitems": [],

18302

"plugins": [],

18303

"extensions": [],

18304

"plugin_for": [],

18305

"extension_for": [],

18306

"module": "shim-plugin",

18307

"namespace": "",

18308

"file": "node/js/shim-plugin.js",

18309

"line": 7,

18310

"description": "Node plugin which can be used to add shim support.",

18311

"params": [

18312

{

18313

"name": "User",

18314

"description": "configuration object",

18315

"type": "Object"

18316

}

18317

]

18318

},

18319

"Overlay": {

18320

"name": "Overlay",

18321

"shortname": "Overlay",

18322

"classitems": [],

18323

"plugins": [],

18324

"extensions": [],

18325

"plugin_for": [],

18326

"extension_for": [],

18327

"module": "overlay",

18328

"namespace": "",

18329

"file": "overlay/js/Overlay.js",

18330

"line": 9,

18331

"description": "A basic Overlay Widget, which can be positioned based on Page XY co-ordinates and is stackable (z-index support).\nIt also provides alignment and centering support and uses a standard module format for it's content, with header,\nbody and footer section support.",

18332

"is_constructor": 1,

18333

"extends": "Widget",

18334

"uses": [

18335

"WidgetStdMod",

18336

"WidgetPosition",

18337

"WidgetStack",

18338

"WidgetPositionAlign",

18339

"WidgetPositionConstrain"

18340

],

18341

"params": [

18342

{

18343

"name": "object",

18344

"description": "The user configuration for the instance.",

18345

"type": "Object"

18346

}

18347

]

18348

},

18349

"Panel": {

18350

"name": "Panel",

18351

"shortname": "Panel",

18352

"classitems": [],

18353

"plugins": [],

18354

"extensions": [],

18355

"plugin_for": [],

18356

"extension_for": [],

18357

"module": "panel",

18358

"namespace": "",

18359

"file": "panel/js/panel.js",

18360

"line": 14,

18361

"description": "A basic Panel Widget, which can be positioned based on Page XY co-ordinates and\nis stackable (z-index support). It also provides alignment and centering support\nand uses a standard module format for it's content, with header, body and footer\nsection support. It can be made modal, and has functionality to hide and focus\non different events. The header and footer sections can be modified to allow for\nbutton support.",

18362

"is_constructor": 1,

18363

"extends": "Widget",

18364

"uses": [

18365

"WidgetAutohide",

18366

"WidgetButtons",

18367

"WidgetModality",

18368

"WidgetPosition",

18369

"WidgetPositionAlign",

18370

"WidgetPositionConstrain",

18371

"WidgetStack",

18372

"WidgetStdMod"

18373

],

18374

"since": "3.4.0"

18375

},

18376

"Parallel": {

18377

"name": "Parallel",

18378

"shortname": "Parallel",

18379

"classitems": [],

18380

"plugins": [],

18381

"extensions": [],

18382

"plugin_for": [],

18383

"extension_for": [],

18384

"module": "parallel",

18385

"namespace": "",

18386

"file": "parallel/js/parallel.js",

18387

"line": 8,

18388

"description": "A concurrent parallel processor to help in running several async functions.\n\n var stack = new Y.Parallel();\n\n for (var i = 0; i < 15; i++) {\n Y.io('./api/json/' + i, {\n on: {\n success: stack.add(function() {\n Y.log('Done!');\n })\n }\n });\n }\n\n stack.done(function() {\n Y.log('All IO requests complete!');\n });",

18389

"params": [

18390

{

18391

"name": "o",

18392

"description": "A config object",

18393

"type": "Object",

18394

"props": [

18395

{

18396

"name": "context",

18397

"description": "The execution context of the callback to done",

18398

"type": "Object",

18399

"optional": true,

18400

"optdefault": "Y"

18401

}

18402

]

18403

}

18404

]

18405

},

18406

"PjaxBase": {

18407

"name": "PjaxBase",

18408

"shortname": "PjaxBase",

18409

"classitems": [],

18410

"plugins": [],

18411

"extensions": [],

18412

"plugin_for": [],

18413

"extension_for": [

18414

"Router",

18415

"App.Base",

18416

"Pjax"

18417

],

18418

"module": "pjax",

18419

"submodule": "pjax-base",

18420

"namespace": "",

18421

"file": "pjax/js/pjax-base.js",

18422

"line": 45,

18423

"description": "`Y.Router` extension that provides the core plumbing for enhanced navigation\nimplemented using the pjax technique (HTML5 `pushState` + Ajax).\n\nThis makes it easy to enhance the navigation between the URLs of an application\nin HTML5 history capable browsers by delegating to the router to fulfill the\n\"request\" and seamlessly falling-back to using standard full-page reloads in\nolder, less-capable browsers.\n\nThe `PjaxBase` class isn't useful on its own, but can be mixed into a\n`Router`-based class to add Pjax functionality to that Router. For a pre-made\nstandalone Pjax router, see the `Pjax` class.\n\n var MyRouter = Y.Base.create('myRouter', Y.Router, [Y.PjaxBase], {\n // ...\n });",

18424

"since": "3.5.0"

18425

},

18426

"Plugin.Pjax": {

18427

"name": "Plugin.Pjax",

18428

"shortname": "Plugin.Pjax",

18429

"classitems": [],

18430

"plugins": [],

18431

"extensions": [],

18432

"plugin_for": [],

18433

"extension_for": [],

18434

"module": "pjax",

18435

"submodule": "pjax-plugin",

18436

"namespace": "",

18437

"file": "pjax/js/pjax-plugin.js",

18438

"line": 9,

18439

"description": "Node plugin that provides seamless, gracefully degrading pjax functionality.",

18440

"extends": "Pjax",

18441

"since": "3.5.0"

18442

},

18443

"Pjax": {

18444

"name": "Pjax",

18445

"shortname": "Pjax",

18446

"classitems": [],

18447

"plugins": [],

18448

"extensions": [],

18449

"plugin_for": [],

18450

"extension_for": [],

18451

"module": "pjax",

18452

"namespace": "",

18453

"file": "pjax/js/pjax.js",

18454

"line": 12,

18455

"description": "Provides seamless, gracefully degrading Pjax (pushState + Ajax) functionality,\nwhich makes it easy to progressively enhance standard links on the page so that\nthey can be loaded normally in old browsers, or via Ajax (with HTML5 history\nsupport) in newer browsers.",

18456

"extends": "Router",

18457

"uses": [

18458

"PjaxBase"

18459

],

18460

"is_constructor": 1,

18461

"params": [

18462

{

18463

"name": "config",

18464

"description": "Config attributes.",

18465

"type": "Object",

18466

"optional": true

18467

}

18468

],

18469

"since": "3.5.0"

18470

},

18471

"Plugin.Base": {

18472

"name": "Plugin.Base",

18473

"shortname": "Plugin.Base",

18474

"classitems": [],

18475

"plugins": [],

18476

"extensions": [],

18477

"plugin_for": [],

18478

"extension_for": [

18479

"Plugin.Cache",

18480

"DataSourceCache"

18481

],

18482

"module": "plugin",

18483

"namespace": "",

18484

"file": "plugin/js/plugin.js",

18485

"line": 7,

18486

"description": "The base class for all Plugin instances.",

18487

"extends": "Base",

18488

"params": [

18489

{

18490

"name": "config",

18491

"description": "Configuration object with property name/value pairs.",

18492

"type": "Object"

18493

}

18494

]

18495

},

18496

"Plugin.Host": {

18497

"name": "Plugin.Host",

18498

"shortname": "Plugin.Host",

18499

"classitems": [],

18500

"plugins": [],

18501

"extensions": [],

18502

"plugin_for": [],

18503

"extension_for": [],

18504

"module": "pluginhost-base",

18505

"namespace": "",

18506

"file": "pluginhost/js/PluginHost.js",

18507

"line": 11,

18508

"description": "\nAn augmentable class, which provides the augmented class with the ability to host plugins.\nIt adds <a href=\"#method_plug\">plug</a> and <a href=\"#method_unplug\">unplug</a> methods to the augmented class, which can \nbe used to add or remove plugins from instances of the class.\n\n\nPlugins can also be added through the constructor configuration object passed to the host class' constructor using\nthe \"plugins\" property. Supported values for the \"plugins\" property are those defined by the <a href=\"#method_plug\">plug</a> method. \n\nFor example the following code would add the AnimPlugin and IOPlugin to Overlay (the plugin host):\n<xmp>\nvar o = new Overlay({plugins: [ AnimPlugin, {fn:IOPlugin, cfg:{section:\"header\"}}]});\n</xmp>\n\n\nPlug.Host's protected <a href=\"#method_initPlugins\">_initPlugins</a> and <a href=\"#method_destroyPlugins\">_destroyPlugins</a> \nmethods should be invoked by the host class at the appropriate point in the host's lifecyle. \n"

18509

},

18510

"Profiler": {

18511

"name": "Profiler",

18512

"shortname": "Profiler",

18513

"classitems": [],

18514

"plugins": [],

18515

"extensions": [],

18516

"plugin_for": [],

18517

"extension_for": [],

18518

"module": "profiler",

18519

"namespace": "",

18520

"file": "profiler/js/Profiler.js",

18521

"line": 82,

18522

"description": "Profiles functions in JavaScript.",

18523

"static": 1

18524

},

18525

"QueryString": {

18526

"name": "QueryString",

18527

"shortname": "QueryString",

18528

"classitems": [],

18529

"plugins": [],

18530

"extensions": [],

18531

"plugin_for": [],

18532

"extension_for": [],

18533

"module": "querystring",

18534

"submodule": "querystring-stringify",

18535

"namespace": "",

18536

"file": "querystring/js/querystring-parse.js",

18537

"line": 20,

18538

"description": "The QueryString module adds support for serializing JavaScript objects into\nquery strings and parsing JavaScript objects from query strings format.",

18539

"static": 1

18540

},

18541

"Queue": {

18542

"name": "Queue",

18543

"shortname": "Queue",

18544

"classitems": [],

18545

"plugins": [],

18546

"extensions": [],

18547

"plugin_for": [],

18548

"extension_for": [],

18549

"module": "yui",

18550

"namespace": "",

18551

"file": "yui/js/queue-base.js",

18552

"line": 9,

18553

"description": "A simple FIFO queue. Items are added to the Queue with add(1..n items) and\nremoved using next().",

18554

"submodule": "yui-base",

18555

"is_constructor": 1,

18556

"params": [

18557

{

18558

"name": "item",

18559

"description": "0..n items to seed the queue.",

18560

"type": "MIXED",

18561

"multiple": true

18562

}

18563

]

18564

},

18565

"Record": {

18566

"name": "Record",

18567

"shortname": "Record",

18568

"classitems": [],

18569

"plugins": [],

18570

"extensions": [],

18571

"plugin_for": [],

18572

"extension_for": [],

18573

"module": "queue-promote",

18574

"namespace": "",

18575

"file": "recordset/js/record.js",

18576

"line": 1,

18577

"description": "Provides a wrapper around a standard javascript object. Can be inserted into a Recordset instance."

18578

},

18579

"Recordset": {

18580

"name": "Recordset",

18581

"shortname": "Recordset",

18582

"classitems": [],

18583

"plugins": [],

18584

"extensions": [],

18585

"plugin_for": [],

18586

"extension_for": [],

18587

"module": "recordset",

18588

"submodule": "recordset-base",

18589

"namespace": "",

18590

"file": "recordset/js/recordset-base.js",

18591

"line": 13,

18592

"description": "The Recordset utility provides a standard way for dealing with\na collection of similar objects.\n\nProvides the base Recordset implementation, which can be extended to add\nadditional functionality, such as custom indexing. sorting, and filtering.",

18593

"extends": "Base",

18594

"uses": [

18595

"ArrayList"

18596

],

18597

"params": [

18598

{

18599

"name": "config",

18600

"description": "Configuration object with initial attribute values",

18601

"type": "Object"

18602

}

18603

],

18604

"is_constructor": 1

18605

},

18606

"RecordsetFilter": {

18607

"name": "RecordsetFilter",

18608

"shortname": "RecordsetFilter",

18609

"classitems": [],

18610

"plugins": [],

18611

"extensions": [],

18612

"plugin_for": [],

18613

"extension_for": [],

18614

"module": "recordset",

18615

"submodule": "recordset-filter",

18616

"namespace": "",

18617

"file": "recordset/js/recordset-filter.js",

18618

"line": 13,

18619

"description": "Plugin that provides the ability to filter through a recordset.\nUses the filter methods available on Y.Array (see arrayextras submodule) to filter the recordset."

18620

},

18621

"RecordsetIndexer": {

18622

"name": "RecordsetIndexer",

18623

"shortname": "RecordsetIndexer",

18624

"classitems": [],

18625

"plugins": [],

18626

"extensions": [],

18627

"plugin_for": [],

18628

"extension_for": [],

18629

"module": "recordset",

18630

"submodule": "recordset-indexer",

18631

"namespace": "",

18632

"file": "recordset/js/recordset-indexer.js",

18633

"line": 6,

18634

"description": "Plugin that provides the ability to store multiple custom hash tables referencing records in the recordset.\nThis utility does not support any collision handling. New hash table entries with a used key overwrite older ones."

18635

},

18636

"RecordsetSort": {

18637

"name": "RecordsetSort",

18638

"shortname": "RecordsetSort",

18639

"classitems": [],

18640

"plugins": [],

18641

"extensions": [],

18642

"plugin_for": [],

18643

"extension_for": [],

18644

"module": "recordset",

18645

"submodule": "recordset-sort",

18646

"namespace": "",

18647

"file": "recordset/js/recordset-sort.js",

18648

"line": 10,

18649

"description": "Plugin that adds default and custom sorting functionality to the Recordset utility"

18650

},

18651

"Resize": {

18652

"name": "Resize",

18653

"shortname": "Resize",

18654

"classitems": [],

18655

"plugins": [],

18656

"extensions": [],

18657

"plugin_for": [],

18658

"extension_for": [],

18659

"module": "resize",

18660

"namespace": "",

18661

"file": "resize/js/resize-base.js",

18662

"line": 129,

18663

"description": "A base class for Resize, providing:\n\n * Basic Lifecycle (initializer, renderUI, bindUI, syncUI, destructor)\n * Applies drag handles to an element to make it resizable\n * Here is the list of valid resize handles:\n `[ 't', 'tr', 'r', 'br', 'b', 'bl', 'l', 'tl' ]`. You can\n read this list as top, top-right, right, bottom-right, bottom,\n bottom-left, left, top-left.\n * The drag handles are inserted into the element and positioned\n absolute. Some elements, such as a textarea or image, don't support\n children. To overcome that, set wrap:true in your config and the\n element willbe wrapped for you automatically.\n\nQuick Example:\n\n var instance = new Y.Resize({\n node: '#resize1',\n preserveRatio: true,\n wrap: true,\n maxHeight: 170,\n maxWidth: 400,\n handles: 't, tr, r, br, b, bl, l, tl'\n });\n\nCheck the list of <a href=\"Resize.html#configattributes\">Configuration Attributes</a> available for\nResize.",

18664

"params": [

18665

{

18666

"name": "config",

18667

"description": "Object literal specifying widget configuration properties.",

18668

"type": "Object"

18669

}

18670

],

18671

"is_constructor": 1,

18672

"extends": "Base"

18673

},

18674

"Plugin.ResizeConstrained": {

18675

"name": "Plugin.ResizeConstrained",

18676

"shortname": "Plugin.ResizeConstrained",

18677

"classitems": [],

18678

"plugins": [],

18679

"extensions": [],

18680

"plugin_for": [],

18681

"extension_for": [],

18682

"module": "resize",

18683

"submodule": "resize-contrain",

18684

"namespace": "Plugin",

18685

"file": "resize/js/resize-constrain.js",

18686

"line": 43,

18687

"description": "A Resize plugin that will attempt to constrain the resize node to the boundaries."

18688

},

18689

"Plugin.Resize": {

18690

"name": "Plugin.Resize",

18691

"shortname": "Plugin.Resize",

18692

"classitems": [],

18693

"plugins": [],

18694

"extensions": [],

18695

"plugin_for": [],

18696

"extension_for": [],

18697

"module": "resize",

18698

"submodule": "resize-plugin",

18699

"namespace": "",

18700

"file": "resize/js/resize-plugin.js",

18701

"line": 1,

18702

"description": "The Resize Plugin allows you to make a Node or a Widget resizable. It supports all the functionality of\nthe standalone Resize utility. Additionally, resizing a widget updates the widget's height,width and x,y\nattributes, if they exist.\n\n\n var overlay = new Y.Overlay({\n width: \"200px\",\n srcNode: \"#overlay\",\n visible: false,\n align: {node:\".example\", points:[\"tc\", \"bc\"]}\n });\n overlay.plug(Y.Plugin.Resize);",

18703

"extends": "Resize"

18704

},

18705

"Plugin.ResizeProxy": {

18706

"name": "Plugin.ResizeProxy",

18707

"shortname": "Plugin.ResizeProxy",

18708

"classitems": [],

18709

"plugins": [],

18710

"extensions": [],

18711

"plugin_for": [],

18712

"extension_for": [],

18713

"module": "resize",

18714

"namespace": "Plugin",

18715

"file": "resize/js/resize-proxy.js",

18716

"line": 17,

18717

"description": "Adds a `proxyNode` attribute and resizes it instead of the actual node. __very similar to DDProxy__\n\n var resize = new Y.Resize({\n //Selector of the node to resize\n node: '#demo'\n });\n resize.plug(Y.Plugin.ResizeProxy);",

18718

"submodule": "resize-proxy",

18719

"is_constructor": 1,

18720

"extends": "Plugin.Base"

18721

},

18722

"ScrollView": {

18723

"name": "ScrollView",

18724

"shortname": "ScrollView",

18725

"classitems": [],

18726

"plugins": [],

18727

"extensions": [],

18728

"plugin_for": [],

18729

"extension_for": [],

18730

"module": "scrollview-base",

18731

"namespace": "",

18732

"file": "scrollview/js/scrollview-base.js",

18733

"line": 52,

18734

"description": "ScrollView provides a scrollable widget, supporting flick gestures, across both touch and mouse based devices.",

18735

"params": [

18736

{

18737

"name": "config",

18738

"description": "Object literal with initial attribute values",

18739

"type": "Object"

18740

}

18741

],

18742

"extends": "Widget",

18743

"is_constructor": 1

18744

},

18745

"Plugin.ScrollViewList": {

18746

"name": "Plugin.ScrollViewList",

18747

"shortname": "Plugin.ScrollViewList",

18748

"classitems": [],

18749

"plugins": [],

18750

"extensions": [],

18751

"plugin_for": [],

18752

"extension_for": [],

18753

"module": "scrollview-list",

18754

"namespace": "Plugin",

18755

"file": "scrollview/js/list-plugin.js",

18756

"line": 15,

18757

"description": "ScrollView plugin that adds class names to immediate descendant \"<li>\" to \nallow for easier styling through CSS",

18758

"extends": "Plugin.Base",

18759

"is_constructor": 1

18760

},

18761

"Plugin.ScrollViewPaginator": {

18762

"name": "Plugin.ScrollViewPaginator",

18763

"shortname": "Plugin.ScrollViewPaginator",

18764

"classitems": [],

18765

"plugins": [],

18766

"extensions": [],

18767

"plugin_for": [],

18768

"extension_for": [],

18769

"module": "scrollview-paginator",

18770

"namespace": "Plugin",

18771

"file": "scrollview/js/paginator-plugin.js",

18772

"line": 17,

18773

"description": "Scrollview plugin that adds support for paging",

18774

"extends": "Plugin.Base",

18775

"is_constructor": 1

18776

},

18777

"Plugin.ScrollViewScrollbars": {

18778

"name": "Plugin.ScrollViewScrollbars",

18779

"shortname": "Plugin.ScrollViewScrollbars",

18780

"classitems": [],

18781

"plugins": [],

18782

"extensions": [],

18783

"plugin_for": [],

18784

"extension_for": [],

18785

"module": "scrollview-scrollbars",

18786

"namespace": "Plugin",

18787

"file": "scrollview/js/scrollbars-plugin.js",

18788

"line": 46,

18789

"description": "ScrollView plugin that adds scroll indicators to ScrollView instances",

18790

"extends": "Plugin.Base",

18791

"is_constructor": 1

18792

},

18793

"ClickableRail": {

18794

"name": "ClickableRail",

18795

"shortname": "ClickableRail",

18796

"classitems": [],

18797

"plugins": [],

18798

"extensions": [],

18799

"plugin_for": [],

18800

"extension_for": [

18801

"Slider"

18802

],

18803

"module": "slider",

18804

"submodule": "clickable-rail",

18805

"namespace": "",

18806

"file": "slider/js/clickable-rail.js",

18807

"line": 9,

18808

"description": "Slider extension that allows clicking on the Slider's rail element,\ntriggering the thumb to align with the location of the click."

18809

},

18810

"Slider": {

18811

"name": "Slider",

18812

"shortname": "Slider",

18813

"classitems": [],

18814

"plugins": [],

18815

"extensions": [],

18816

"plugin_for": [],

18817

"extension_for": [],

18818

"module": "slider",

18819

"submodule": "range-slider",

18820

"namespace": "",

18821

"file": "slider/js/range-slider.js",

18822

"line": 10,

18823

"description": "Create a slider to represent an integer value between a given minimum and\nmaximum. Sliders may be aligned vertically or horizontally, based on the\n<code>axis</code> configuration.",

18824

"is_constructor": 1,

18825

"extends": "SliderBase",

18826

"uses": [

18827

"SliderValueRange",

18828

"ClickableRail"

18829

],

18830

"params": [

18831

{

18832

"name": "config",

18833

"description": "Configuration object",

18834

"type": "Object"

18835

}

18836

]

18837

},

18838

"SliderBase": {

18839

"name": "SliderBase",

18840

"shortname": "SliderBase",

18841

"classitems": [],

18842

"plugins": [],

18843

"extensions": [],

18844

"plugin_for": [],

18845

"extension_for": [],

18846

"module": "slider",

18847

"submodule": "slider-base",

18848

"namespace": "",

18849

"file": "slider/js/slider-base.js",

18850

"line": 11,

18851

"description": "Create a slider to represent an input control capable of representing a\nseries of intermediate states based on the position of the slider's thumb.\nThese states are typically aligned to a value algorithm whereby the thumb\nposition corresponds to a given value. Sliders may be oriented vertically or\nhorizontally, based on the <code>axis</code> configuration.",

18852

"extends": "Widget",

18853

"params": [

18854

{

18855

"name": "config",

18856

"description": "Configuration object",

18857

"type": "Object"

18858

}

18859

],

18860

"is_constructor": 1

18861

},

18862

"SliderValueRange": {

18863

"name": "SliderValueRange",

18864

"shortname": "SliderValueRange",

18865

"classitems": [],

18866

"plugins": [],

18867

"extensions": [],

18868

"plugin_for": [],

18869

"extension_for": [

18870

"Slider"

18871

],

18872

"module": "slider",

18873

"submodule": "slider-value-range",

18874

"namespace": "",

18875

"file": "slider/js/value-range.js",

18876

"line": 19,

18877

"description": "One class of value algorithm that can be built onto SliderBase. By default,\nvalues range between 0 and 100, but you can configure these on the\nbuilt Slider class by setting the <code>min</code> and <code>max</code>\nconfigurations. Set the initial value (will cause the thumb to move to the\nappropriate location on the rail) in configuration as well if appropriate."

18878

},

18879

"Plugin.SortScroll": {

18880

"name": "Plugin.SortScroll",

18881

"shortname": "Plugin.SortScroll",

18882

"classitems": [],

18883

"plugins": [],

18884

"extensions": [],

18885

"plugin_for": [],

18886

"extension_for": [],

18887

"module": "sortable",

18888

"submodule": "sortable-scroll",

18889

"namespace": "Plugin",

18890

"file": "sortable/js/sortable-scroll.js",

18891

"line": 7,

18892

"description": "Plugin for sortable to handle scrolling lists.",

18893

"extends": "Base",

18894

"is_constructor": 1

18895

},

18896

"Sortable": {

18897

"name": "Sortable",

18898

"shortname": "Sortable",

18899

"classitems": [],

18900

"plugins": [],

18901

"extensions": [],

18902

"plugin_for": [],

18903

"extension_for": [],

18904

"module": "sortable",

18905

"namespace": "",

18906

"file": "sortable/js/sortable.js",

18907

"line": 6,

18908

"description": "The class allows you to create a Drag & Drop reordered list.",

18909

"extends": "Base",

18910

"is_constructor": 1

18911

},

18912

"StyleSheet": {

18913

"name": "StyleSheet",

18914

"shortname": "StyleSheet",

18915

"classitems": [],

18916

"plugins": [],

18917

"extensions": [],

18918

"plugin_for": [],

18919

"extension_for": [],

18920

"module": "stylesheet",

18921

"namespace": "",

18922

"file": "stylesheet/js/stylesheet.js",

18923

"line": 69,

18924

"description": "Create an instance of StyleSheet to encapsulate a css stylesheet.\nThe constructor can be called using function or constructor syntax.\n<pre><code>var sheet = Y.StyleSheet(..);</pre></code>\nor\n<pre><code>var sheet = new Y.StyleSheet(..);</pre></code>\n\nThe first parameter passed can be any of the following things:\n<ul>\n <li>The desired string name to register a new empty sheet</li>\n <li>The string name of an existing StyleSheet instance</li>\n <li>The unique guid generated for an existing StyleSheet instance</li>\n <li>The id of an existing <code><link></code> or <code><style></code> node</li>\n <li>The node reference for an existing <code><link></code> or <code><style></code> node</li>\n <li>The Y.Node instance wrapping an existing <code><link></code> or <code><style></code> node</li>\n <li>A chunk of css text to create a new stylesheet from</li>\n</ul>\n\nIf a string is passed, StyleSheet will first look in its static name\nregistry for an existing sheet, then in the DOM for an element with that id.\nIf neither are found and the string contains the { character, it will be\nused as a the initial cssText for a new StyleSheet. Otherwise, a new empty\nStyleSheet is created, assigned the string value as a name, and registered\nstatically by that name.\n\nThe optional second parameter is a string name to register the sheet as.\nThis param is largely useful when providing a node id/ref or chunk of css\ntext to create a populated instance.",

18925

"is_constructor": 1,

18926

"params": [

18927

{

18928

"name": "seed",

18929

"description": "a style or link node, its id, or a\n name or guid of a StyleSheet, or a string of css text",

18930

"type": "String|HTMLElement|Node"

18931

},

18932

{

18933

"name": "name",

18934

"description": "(optional) name to register instance for future static\n access",

18935

"type": "String"

18936

}

18937

]

18938

},

18939

"YUI~substitute": {

18940

"name": "YUI~substitute",

18941

"shortname": "YUI~substitute",

18942

"classitems": [],

18943

"plugins": [],

18944

"extensions": [],

18945

"plugin_for": [],

18946

"extension_for": [],

18947

"module": "substitute",

18948

"namespace": "",

18949

"file": "substitute/js/substitute.js",

18950

"line": 11,

18951

"description": "The following methods are added to the YUI instance"

18952

},

18953

"SWF": {

18954

"name": "SWF",

18955

"shortname": "SWF",

18956

"classitems": [],

18957

"plugins": [],

18958

"extensions": [],

18959

"plugin_for": [],

18960

"extension_for": [],

18961

"module": "swf",

18962

"namespace": "",

18963

"file": "swf/js/swf.js",

18964

"line": 29,

18965

"description": "Creates the SWF instance and keeps the configuration data",

18966

"uses": [

18967

"Y.Event.Target"

18968

],

18969

"is_constructor": 1,

18970

"params": [

18971

{

18972

"name": "id",

18973

"description": "The id of the element, or the element itself that the SWF will be inserted into.\n The width and height of the SWF will be set to the width and height of this container element.",

18974

"type": "String|HTMLElement"

18975

},

18976

{

18977

"name": "swfURL",

18978

"description": "The URL of the SWF to be embedded into the page.",

18979

"type": "String"

18980

},

18981

{

18982

"name": "p_oAttributes",

18983

"description": "(optional) Configuration parameters for the Flash application and values for Flashvars\n to be passed to the SWF. The p_oAttributes object allows the following additional properties:\n <dl>\n <dt>version : String</dt>\n <dd>The minimum version of Flash required on the user's machine.</dd>\n <dt>fixedAttributes : Object</dt>\n <dd>An object literal containing one or more of the following String keys and their values: <code>align,\n allowFullScreen, allowNetworking, allowScriptAccess, base, bgcolor, menu, name, quality, salign, scale,\n tabindex, wmode.</code> event from the thumb</dd>\n </dl>",

18984

"type": "Object"

18985

}

18986

]

18987

},

18988

"SWFDetect": {

18989

"name": "SWFDetect",

18990

"shortname": "SWFDetect",

18991

"classitems": [],

18992

"plugins": [],

18993

"extensions": [],

18994

"plugin_for": [],

18995

"extension_for": [],

18996

"module": "swfdetect",

18997

"namespace": "",

18998

"file": "swfdetect/js/swfdetect.js",

18999

"line": 63,

19000

"description": "month range of dates, rendered as a grid with date and\nweekday labels.",

19001

"is_constructor": 1

19002

},

19003

"Tab": {

19004

"name": "Tab",

19005

"shortname": "Tab",

19006

"classitems": [],

19007

"plugins": [],

19008

"extensions": [],

19009

"plugin_for": [],

19010

"extension_for": [],

19011

"module": "swfdetect",

19012

"namespace": "",

19013

"file": "tabview/js/tab.js",

19014

"line": 6,

19015

"description": "Provides Tab instances for use with TabView",

19016

"params": [

19017

{

19018

"name": "config",

19019

"description": "Object literal specifying tabview configuration properties.",

19020

"type": "Object"

19021

}

19022

],

19023

"is_constructor": 1,

19024

"extends": "Widget",

19025

"uses": [

19026

"WidgetChild"

19027

]

19028

},

19029

"TabView": {

19030

"name": "TabView",

19031

"shortname": "TabView",

19032

"classitems": [],

19033

"plugins": [],

19034

"extensions": [],

19035

"plugin_for": [],

19036

"extension_for": [],

19037

"module": "tabview",

19038

"namespace": "",

19039

"file": "tabview/js/tabview.js",

19040

"line": 12,

19041

"description": "Provides a tabbed widget interface",

19042

"params": [

19043

{

19044

"name": "config",

19045

"description": "Object literal specifying tabview configuration properties.",

19046

"type": "Object"

19047

}

19048

],

19049

"is_constructor": 1,

19050

"extends": "Widget",

19051

"uses": [

19052

"WidgetParent"

19053

]

19054

},

19055

"Test.Console": {

19056

"name": "Test.Console",

19057

"shortname": "Test.Console",

19058

"classitems": [],

19059

"plugins": [],

19060

"extensions": [],

19061

"plugin_for": [],

19062

"extension_for": [],

19063

"module": "test-console",

19064

"namespace": "Test",

19065

"file": "test-console/js/test-console.js",

19066

"line": 1,

19067

"description": "Provides a specialized log console widget that's pre-configured to display YUI\nTest output with no extra configuration.",

19068

"example": [

19069

"\n\n <div id=\"log\" class=\"yui3-skin-sam\"></div>\n\n <script>\n YUI().use('test-console', function (Y) {\n // ... set up your test cases here ...\n\n // Render the console inside the #log div, then run the tests.\n new Y.Test.Console().render('#log');\n Y.Test.Runner.run();\n });\n </script>"

19070

]

19071

},

19072

"Test.ArrayAssert": {

19073

"name": "Test.ArrayAssert",

19074

"shortname": "Test.ArrayAssert",

19075

"classitems": [],

19076

"plugins": [],

19077

"extensions": [],

19078

"plugin_for": [],

19079

"extension_for": [],

19080

"module": "test",

19081

"namespace": "Test",

19082

"file": "test/js/ArrayAssert.js",

19083

"line": 2,

19084

"description": "The ArrayAssert object provides functions to test JavaScript array objects\nfor a variety of cases."

19085

},

19086

"Test.Assert": {

19087

"name": "Test.Assert",

19088

"shortname": "Test.Assert",

19089

"classitems": [],

19090

"plugins": [],

19091

"extensions": [],

19092

"plugin_for": [],

19093

"extension_for": [],

19094

"module": "test",

19095

"namespace": "Test",

19096

"file": "test/js/Assert.js",

19097

"line": 2,

19098

"description": "The Assert object provides functions to test JavaScript values against\nknown and expected results. Whenever a comparison (assertion) fails,\nan error is thrown."

19099

},

19100

"Test.AssertionError": {

19101

"name": "Test.AssertionError",

19102

"shortname": "Test.AssertionError",

19103

"classitems": [],

19104

"plugins": [],

19105

"extensions": [],

19106

"plugin_for": [],

19107

"extension_for": [],

19108

"module": "test",

19109

"namespace": "Test",

19110

"file": "test/js/AssertionError.js",

19111

"line": 1,

19112

"description": "Error is thrown whenever an assertion fails. It provides methods\nto more easily get at error information and also provides a base class\nfrom which more specific assertion errors can be derived.",

19113

"params": [

19114

{

19115

"name": "message",

19116

"description": "The message to display when the error occurs.",

19117

"type": "String"

19118

}

19119

]

19120

},

19121

"Test.ComparisonFailure": {

19122

"name": "Test.ComparisonFailure",

19123

"shortname": "Test.ComparisonFailure",

19124

"classitems": [],

19125

"plugins": [],

19126

"extensions": [],

19127

"plugin_for": [],

19128

"extension_for": [],

19129

"module": "test",

19130

"namespace": "Test",

19131

"file": "test/js/ComparisonFailure.js",

19132

"line": 1,

19133

"description": "ComparisonFailure is subclass of Error that is thrown whenever\na comparison between two values fails. It provides mechanisms to retrieve\nboth the expected and actual value.",

19134

"params": [

19135

{

19136

"name": "message",

19137

"description": "The message to display when the error occurs.",

19138

"type": "String"

19139

},

19140

{

19141

"name": "expected",

19142

"description": "The expected value.",

19143

"type": "Object"

19144

},

19145

{

19146

"name": "actual",

19147

"description": "The actual value that caused the assertion to fail.",

19148

"type": "Object"

19149

}

19150

],

19151

"extends": "AssertionError"

19152

},

19153

"Test.CoverageFormat": {

19154

"name": "Test.CoverageFormat",

19155

"shortname": "Test.CoverageFormat",

19156

"classitems": [],

19157

"plugins": [],

19158

"extensions": [],

19159

"plugin_for": [],

19160

"extension_for": [],

19161

"module": "test",

19162

"namespace": "Test.CoverageFormat",

19163

"file": "test/js/CoverageFormat.js",

19164

"line": 1,

19165

"description": "An object object containing coverage result formatting methods."

19166

},

19167

"Test.DateAssert": {

19168

"name": "Test.DateAssert",

19169

"shortname": "Test.DateAssert",

19170

"classitems": [],

19171

"plugins": [],

19172

"extensions": [],

19173

"plugin_for": [],

19174

"extension_for": [],

19175

"module": "test",

19176

"namespace": "Test",

19177

"file": "test/js/DateAssert.js",

19178

"line": 3,

19179

"description": "The DateAssert object provides functions to test JavaScript Date objects\nfor a variety of cases."

19180

},

19181

"Test.EventTarget": {

19182

"name": "Test.EventTarget",

19183

"shortname": "Test.EventTarget",

19184

"classitems": [],

19185

"plugins": [],

19186

"extensions": [],

19187

"plugin_for": [],

19188

"extension_for": [],

19189

"module": "test",

19190

"namespace": "Test",

19191

"file": "test/js/EventTarget.js",

19192

"line": 2,

19193

"description": "Simple custom event implementation."

19194

},

19195

"Test.Mock": {

19196

"name": "Test.Mock",

19197

"shortname": "Test.Mock",

19198

"classitems": [],

19199

"plugins": [],

19200

"extensions": [],

19201

"plugin_for": [],

19202

"extension_for": [],

19203

"module": "test",

19204

"namespace": "Test.Mock",

19205

"file": "test/js/Mock.js",

19206

"line": 1,

19207

"description": "Creates a new mock object."

19208

},

19209

"Test.Mock.Value": {

19210

"name": "Test.Mock.Value",

19211

"shortname": "Test.Mock.Value",

19212

"classitems": [],

19213

"plugins": [],

19214

"extensions": [],

19215

"plugin_for": [],

19216

"extension_for": [],

19217

"module": "test",

19218

"namespace": "Test.Mock",

19219

"file": "test/js/Mock.js",

19220

"line": 155,

19221

"description": "Creates a new value matcher.",

19222

"params": [

19223

{

19224

"name": "method",

19225

"description": "The function to call on the value.",

19226

"type": "Function"

19227

},

19228

{

19229

"name": "originalArgs",

19230

"description": "(Optional) Array of arguments to pass to the method.",

19231

"type": "Array"

19232

},

19233

{

19234

"name": "message",

19235

"description": "(Optional) Message to display in case of failure.",

19236

"type": "String"

19237

}

19238

]

19239

},

19240

"Test.ObjectAssert": {

19241

"name": "Test.ObjectAssert",

19242

"shortname": "Test.ObjectAssert",

19243

"classitems": [],

19244

"plugins": [],

19245

"extensions": [],

19246

"plugin_for": [],

19247

"extension_for": [],

19248

"module": "test",

19249

"namespace": "Test",

19250

"file": "test/js/ObjectAssert.js",

19251

"line": 2,

19252

"description": "The ObjectAssert object provides functions to test JavaScript objects\nfor a variety of cases."

19253

},

19254

"Test.Reporter": {

19255

"name": "Test.Reporter",

19256

"shortname": "Test.Reporter",

19257

"classitems": [],

19258

"plugins": [],

19259

"extensions": [],

19260

"plugin_for": [],

19261

"extension_for": [],

19262

"module": "test",

19263

"namespace": "Test",

19264

"file": "test/js/Reporter.js",

19265

"line": 2,

19266

"description": "An object capable of sending test results to a server.",

19267

"params": [

19268

{

19269

"name": "url",

19270

"description": "The URL to submit the results to.",

19271

"type": "String"

19272

},

19273

{

19274

"name": "format",

19275

"description": "(Optiona) A function that outputs the results in a specific format.\n Default is YUITest.TestFormat.XML.",

19276

"type": "Function"

19277

}

19278

],

19279

"is_constructor": 1

19280

},

19281

"Test.Results": {

19282

"name": "Test.Results",

19283

"shortname": "Test.Results",

19284

"classitems": [],

19285

"plugins": [],

19286

"extensions": [],

19287

"plugin_for": [],

19288

"extension_for": [],

19289

"module": "test",

19290

"namespace": "Test",

19291

"file": "test/js/Results.js",

19292

"line": 1,

19293

"description": "Convenience type for storing and aggregating\ntest result information.",

19294

"access": "private",

19295

"tagname": ""

19296

},

19297

"Test.ShouldError": {

19298

"name": "Test.ShouldError",

19299

"shortname": "Test.ShouldError",

19300

"classitems": [],

19301

"plugins": [],

19302

"extensions": [],

19303

"plugin_for": [],

19304

"extension_for": [],

19305

"module": "test",

19306

"namespace": "Test",

19307

"file": "test/js/ShouldError.js",

19308

"line": 1,

19309

"description": "ShouldError is subclass of Error that is thrown whenever\na test is expected to throw an error but doesn't.",

19310

"params": [

19311

{

19312

"name": "message",

19313

"description": "The message to display when the error occurs.",

19314

"type": "String"

19315

}

19316

],

19317

"extends": "AssertionError"

19318

},

19319

"Test.ShouldFail": {

19320

"name": "Test.ShouldFail",

19321

"shortname": "Test.ShouldFail",

19322

"classitems": [],

19323

"plugins": [],

19324

"extensions": [],

19325

"plugin_for": [],

19326

"extension_for": [],

19327

"module": "test",

19328

"namespace": "Test",

19329

"file": "test/js/ShouldFail.js",

19330

"line": 1,

19331

"description": "ShouldFail is subclass of AssertionError that is thrown whenever\na test was expected to fail but did not.",

19332

"params": [

19333

{

19334

"name": "message",

19335

"description": "The message to display when the error occurs.",

19336

"type": "String"

19337

}

19338

],

19339

"extends": "YUITest.AssertionError"

19340

},

19341

"Test.TestCase": {

19342

"name": "Test.TestCase",

19343

"shortname": "Test.TestCase",

19344

"classitems": [],

19345

"plugins": [],

19346

"extensions": [],

19347

"plugin_for": [],

19348

"extension_for": [],

19349

"module": "test",

19350

"namespace": "Test",

19351

"file": "test/js/TestCase.js",

19352

"line": 1,

19353

"description": "Test case containing various tests to run.",

19354

"params": [

19355

{

19356

"name": "template",

19357

"description": "An object containing any number of test methods, other methods,\n an optional name, and anything else the test case needs."

19358

}

19359

]

19360

},

19361

"Test.TestFormat": {

19362

"name": "Test.TestFormat",

19363

"shortname": "Test.TestFormat",

19364

"classitems": [],

19365

"plugins": [],

19366

"extensions": [],

19367

"plugin_for": [],

19368

"extension_for": [],

19369

"module": "test",

19370

"namespace": "Test",

19371

"file": "test/js/TestFormat.js",

19372

"line": 1,

19373

"description": "An object object containing test result formatting methods."

19374

},

19375

"Test.TestRunner": {

19376

"name": "Test.TestRunner",

19377

"shortname": "Test.TestRunner",

19378

"classitems": [],

19379

"plugins": [],

19380

"extensions": [],

19381

"plugin_for": [],

19382

"extension_for": [],

19383

"module": "test",

19384

"namespace": "Test",

19385

"file": "test/js/TestRunner.js",

19386

"line": 2,

19387

"description": "Runs test suites and test cases, providing events to allowing for the\ninterpretation of test results."

19388

},

19389

"Test.TestNode": {

19390

"name": "Test.TestNode",

19391

"shortname": "TestNode",

19392

"classitems": [],

19393

"plugins": [],

19394

"extensions": [],

19395

"plugin_for": [],

19396

"extension_for": [],

19397

"module": "test",

19398

"namespace": "Test",

19399

"file": "test/js/TestRunner.js",

19400

"line": 34,

19401

"description": "A node in the test tree structure. May represent a TestSuite, TestCase, or\ntest function.",

19402

"params": [

19403

{

19404

"name": "testObject",

19405

"description": "A TestSuite, TestCase, or the name of a test function.",

19406

"type": "Variant"

19407

}

19408

]

19409

},

19410

"Test.Runner": {

19411

"name": "Test.Runner",

19412

"shortname": "Test.Runner",

19413

"classitems": [],

19414

"plugins": [],

19415

"extensions": [],

19416

"plugin_for": [],

19417

"extension_for": [],

19418

"module": "test",

19419

"namespace": "Test",

19420

"file": "test/js/TestRunner.js",

19421

"line": 120,

19422

"description": "Runs test suites and test cases, providing events to allowing for the\ninterpretation of test results."

19423

},

19424

"Test.TestSuite": {

19425

"name": "Test.TestSuite",

19426

"shortname": "Test.TestSuite",

19427

"classitems": [],

19428

"plugins": [],

19429

"extensions": [],

19430

"plugin_for": [],

19431

"extension_for": [],

19432

"module": "test",

19433

"namespace": "Test",

19434

"file": "test/js/TestSuite.js",

19435

"line": 3,

19436

"description": "A test suite that can contain a collection of TestCase and TestSuite objects.",

19437

"params": [

19438

{

19439

"name": "data",

19440

"description": "The name of the test suite or an object containing\n a name property as well as setUp and tearDown methods.",

19441

"type": "String||Object"

19442

}

19443

]

19444

},

19445

"Test.UnexpectedError": {

19446

"name": "Test.UnexpectedError",

19447

"shortname": "Test.UnexpectedError",

19448

"classitems": [],

19449

"plugins": [],

19450

"extensions": [],

19451

"plugin_for": [],

19452

"extension_for": [],

19453

"module": "test",

19454

"namespace": "Test",

19455

"file": "test/js/UnexpectedError.js",

19456

"line": 1,

19457

"description": "UnexpectedError is subclass of AssertionError that is thrown whenever\nan error occurs within the course of a test and the test was not expected\nto throw an error.",

19458

"params": [

19459

{

19460

"name": "cause",

19461

"description": "The unexpected error that caused this error to be \n thrown.",

19462

"type": "Error"

19463

}

19464

],

19465

"extends": "YUITest.AssertionError"

19466

},

19467

"Test.UnexpectedValue": {

19468

"name": "Test.UnexpectedValue",

19469

"shortname": "Test.UnexpectedValue",

19470

"classitems": [],

19471

"plugins": [],

19472

"extensions": [],

19473

"plugin_for": [],

19474

"extension_for": [],

19475

"module": "test",

19476

"namespace": "Test",

19477

"file": "test/js/UnexpectedValue.js",

19478

"line": 1,

19479

"description": "UnexpectedValue is subclass of Error that is thrown whenever\na value was unexpected in its scope. This typically means that a test\nwas performed to determine that a value was *not* equal to a certain\nvalue.",

19480

"params": [

19481

{

19482

"name": "message",

19483

"description": "The message to display when the error occurs.",

19484

"type": "String"

19485

},

19486

{

19487

"name": "unexpected",

19488

"description": "The unexpected value.",

19489

"type": "Object"

19490

}

19491

],

19492

"extends": "AssertionError"

19493

},

19494

"Test.Wait": {

19495

"name": "Test.Wait",

19496

"shortname": "Test.Wait",

19497

"classitems": [],

19498

"plugins": [],

19499

"extensions": [],

19500

"plugin_for": [],

19501

"extension_for": [],

19502

"module": "test",

19503

"namespace": "Test",

19504

"file": "test/js/Wait.js",

19505

"line": 2,

19506

"description": "Represents a stoppage in test execution to wait for an amount of time before\ncontinuing.",

19507

"params": [

19508

{

19509

"name": "segment",

19510

"description": "A function to run when the wait is over.",

19511

"type": "Function"

19512

},

19513

{

19514

"name": "delay",

19515

"description": "The number of milliseconds to wait before running the code.",

19516

"type": "Int"

19517

}

19518

]

19519

},

19520

"Text.AccentFold": {

19521

"name": "Text.AccentFold",

19522

"shortname": "Text.AccentFold",

19523

"classitems": [],

19524

"plugins": [],

19525

"extensions": [],

19526

"plugin_for": [],

19527

"extension_for": [],

19528

"module": "text",

19529

"submodule": "text-accentfold",

19530

"namespace": "",

19531

"file": "text/js/text-accentfold.js",

19532

"line": 16,

19533

"description": "\nProvides a basic accent folding implementation that converts common accented\nletters (like \"á\") to their non-accented forms (like \"a\").\n\n\n\nThis implementation is not comprehensive, and should only be used as a last\nresort when accent folding can't be done on the server. A comprehensive\naccent folding implementation would require much more character data to be\nsent to the browser, resulting in a significant performance penalty. This\nimplementation strives for a compromise between usefulness and performance.\n\n\n\nAccent folding is a destructive operation that can't be reversed, and may\nchange or destroy the actual meaning of the text depending on the language.\nIt should not be used on strings that will later be displayed to a user,\nunless this is done with the understanding that linguistic meaning may be\nlost and that you may in fact confuse or insult the user by doing so.\n\n\n\nWhen used for matching, accent folding is likely to produce erroneous matches\nfor languages in which characters with diacritics are considered different\nfrom their base characters, or where correct folding would map to other\ncharacter sequences than just stripped characters. For example, in German\n\"ü\" is a character that's clearly different from \"u\" and should match \"ue\"\ninstead. The word \"betrügen\" means \"to defraud\", while \"betrugen\" is the past\ntense of \"to behave\". The name \"Müller\" is expected to match \"Mueller\", but\nnot \"Muller\". On the other hand, accent folding falls short for languages\nwhere different base characters are expected to match. In Japanese, for\nexample, hiragana and katakana characters with the same pronunciation (\"あ\"\nand \"ア\") are commonly treated as equivalent for lookups, but accent folding\ntreats them as different.\n",

19534

"static": 1

19535

},

19536

"Text.WordBreak": {

19537

"name": "Text.WordBreak",

19538

"shortname": "Text.WordBreak",

19539

"classitems": [],

19540

"plugins": [],

19541

"extensions": [],

19542

"plugin_for": [],

19543

"extension_for": [],

19544

"module": "text",

19545

"submodule": "text-wordbreak",

19546

"namespace": "",

19547

"file": "text/js/text-wordbreak.js",

19548

"line": 9,

19549

"description": "\nProvides utility methods for splitting strings on word breaks and determining\nwhether a character index represents a word boundary, using the generic word\nbreaking algorithm defined in the Unicode Text Segmentation guidelines\n(<a href=\"http://unicode.org/reports/tr29/#Word_Boundaries\">Unicode Standard\nAnnex #29</a>).\n\n\n\nThis algorithm provides a reasonable default for many languages. However, it\ndoes not cover language or context specific requirements, and it does not\nprovide meaningful results at all for languages that don't use spaces between\nwords, such as Chinese, Japanese, Thai, Lao, Khmer, and others. Server-based\nword breaking services usually provide significantly better results with\nbetter performance.\n",

19550

"static": 1

19551

},

19552

"Transition": {

19553

"name": "Transition",

19554

"shortname": "Transition",

19555

"classitems": [],

19556

"plugins": [],

19557

"extensions": [],

19558

"plugin_for": [],

19559

"extension_for": [],

19560

"module": "transition",

19561

"namespace": "",

19562

"file": "transition/js/transition-native.js",

19563

"line": 35,

19564

"description": "A class for constructing transition instances.\nAdds the \"transition\" method to Node.",

19565

"is_constructor": 1

19566

},

19567

"UploaderFlash": {

19568

"name": "UploaderFlash",

19569

"shortname": "UploaderFlash",

19570

"classitems": [],

19571

"plugins": [],

19572

"extensions": [],

19573

"plugin_for": [],

19574

"extension_for": [],

19575

"module": "uploader-flash",

19576

"namespace": "",

19577

"file": "uploader/js/uploader-flash.js",

19578

"line": 19,

19579

"description": "This module provides a UI for file selection and multiple file upload capability\nusing Flash as a transport engine.",

19580

"extends": "Widget",

19581

"is_constructor": 1,

19582

"params": [

19583

{

19584

"name": "config",

19585

"description": "Configuration object.",

19586

"type": "Object"

19587

}

19588

]

19589

},

19590

"UploaderHTML5": {

19591

"name": "UploaderHTML5",

19592

"shortname": "UploaderHTML5",

19593

"classitems": [],

19594

"plugins": [],

19595

"extensions": [],

19596

"plugin_for": [],

19597

"extension_for": [],

19598

"module": "uploader-html5",

19599

"namespace": "",

19600

"file": "uploader/js/uploader-html5.js",

19601

"line": 15,

19602

"description": "This module provides a UI for file selection and multiple file upload capability using\nHTML5 XMLHTTPRequest Level 2 as a transport engine.",

19603

"extends": "Widget",

19604

"is_constructor": 1

19605

},

19606

"Uploader.Queue": {

19607

"name": "Uploader.Queue",

19608

"shortname": "Uploader.Queue",

19609

"classitems": [],

19610

"plugins": [],

19611

"extensions": [],

19612

"plugin_for": [],

19613

"extension_for": [],

19614

"module": "uploader-queue",

19615

"namespace": "",

19616

"file": "uploader/js/uploader-queue.js",

19617

"line": 19,

19618

"description": "This class manages a queue of files to be uploaded to the server.",

19619

"extends": "Base",

19620

"is_constructor": 1,

19621

"params": [

19622

{

19623

"name": "config",

19624

"description": "Configuration object",

19625

"type": "Object"

19626

}

19627

]

19628

},

19629

"Uploader": {

19630

"name": "Uploader",

19631

"shortname": "Uploader",

19632

"classitems": [],

19633

"plugins": [],

19634

"extensions": [],

19635

"plugin_for": [],

19636

"extension_for": [],

19637

"module": "uploader",

19638

"namespace": "",

19639

"file": "uploader/js/uploader.js",

19640

"line": 11,

19641

"description": "`Y.Uploader` serves as an alias for either <a href=\"UploaderFlash.html\">`Y.UploaderFlash`</a>\nor <a href=\"UploaderHTML5.html\">`Y.UploaderHTML5`</a>, depending on the feature set available\nin a specific browser. If neither HTML5 nor Flash transport layers are available, `Y.Uploader.TYPE` \nstatic property is set to `\"none\"`."

19642

},

19643

"Plugin.WidgetAnim": {

19644

"name": "Plugin.WidgetAnim",

19645

"shortname": "Plugin.WidgetAnim",

19646

"classitems": [],

19647

"plugins": [],

19648

"extensions": [],

19649

"plugin_for": [],

19650

"extension_for": [],

19651

"module": "widget-anim",

19652

"namespace": "Plugin",

19653

"file": "widget-anim/js/WidgetAnim.js",

19654

"line": 29,

19655

"description": "A plugin class which can be used to animate widget visibility changes.",

19656

"extends": "Plugin.Base"

19657

},

19658

"WidgetAutohide": {

19659

"name": "WidgetAutohide",

19660

"shortname": "WidgetAutohide",

19661

"classitems": [],

19662

"plugins": [],

19663

"extensions": [],

19664

"plugin_for": [],

19665

"extension_for": [

19666

"Panel"

19667

],

19668

"module": "widget-autohide",

19669

"namespace": "",

19670

"file": "widget-autohide/js/Widget-Autohide.js",

19671

"line": 27,

19672

"description": "The WidgetAutohide class provides the hideOn attribute which can\nbe used to hide the widget when certain events occur.",

19673

"params": [

19674

{

19675

"name": "config",

19676

"description": "User configuration object",

19677

"type": "Object"

19678

}

19679

]

19680

},

19681

"WidgetButtons": {

19682

"name": "WidgetButtons",

19683

"shortname": "WidgetButtons",

19684

"classitems": [],

19685

"plugins": [],

19686

"extensions": [],

19687

"plugin_for": [],

19688

"extension_for": [

19689

"Widget",

19690

"Panel"

19691

],

19692

"module": "widget-buttons",

19693

"namespace": "",

19694

"file": "widget-buttons/js/widget-buttons.js",

19695

"line": 29,

19696

"description": "Provides header/body/footer button support for Widgets that use the\n`WidgetStdMod` extension.\n\nThis Widget extension makes it easy to declaratively configure a widget's\nbuttons. It adds a `buttons` attribute along with button- accessor and mutator\nmethods. All button nodes have the `Y.Plugin.Button` plugin applied.\n\nThis extension also includes `HTML_PARSER` support to seed a widget's `buttons`\nfrom those which already exist in its DOM.",

19697

"since": "3.4.0"

19698

},

19699

"WidgetChild": {

19700

"name": "WidgetChild",

19701

"shortname": "WidgetChild",

19702

"classitems": [],

19703

"plugins": [],

19704

"extensions": [],

19705

"plugin_for": [],

19706

"extension_for": [

19707

"Tab"

19708

],

19709

"module": "widget-child",

19710

"namespace": "",

19711

"file": "widget-child/js/Widget-Child.js",

19712

"line": 9,

19713

"description": "Widget extension providing functionality enabling a Widget to be a \nchild of another Widget.",

19714

"params": [

19715

{

19716

"name": "config",

19717

"description": "User configuration object.",

19718

"type": "Object"

19719

}

19720

]

19721

},

19722

"Widget": {

19723

"name": "Widget",

19724

"shortname": "Widget",

19725

"classitems": [],

19726

"plugins": [],

19727

"extensions": [],

19728

"plugin_for": [],

19729

"extension_for": [],

19730

"module": "widget",

19731

"namespace": "",

19732

"file": "widget/js/Widget.js",

19733

"line": 68,

19734

"description": "A base class for widgets, providing:\n<ul>\n <li>The render lifecycle method, in addition to the init and destroy \n lifecycle methods provide by Base</li>\n <li>Abstract methods to support consistent MVC structure across \n widgets: renderer, renderUI, bindUI, syncUI</li>\n <li>Support for common widget attributes, such as boundingBox, contentBox, visible, \n disabled, focused, strings</li>\n</ul>",

19735

"params": [

19736

{

19737

"name": "config",

19738

"description": "Object literal specifying widget configuration properties.",

19739

"type": "Object"

19740

}

19741

],

19742

"submodule": "widget-base",

19743

"is_constructor": 1,

19744

"extends": "Base"

19745

},

19746

"WidgetModality": {

19747

"name": "WidgetModality",

19748

"shortname": "WidgetModality",

19749

"classitems": [],

19750

"plugins": [],

19751

"extensions": [],

19752

"plugin_for": [],

19753

"extension_for": [

19754

"Panel"

19755

],

19756

"module": "widget-modality",

19757

"namespace": "",

19758

"file": "widget-modality/js/Widget-Modality.js",

19759

"line": 48,

19760

"description": "Widget extension, which can be used to add modality support to the base Widget class,\nthrough the Base.create method.",

19761

"params": [

19762

{

19763

"name": "config",

19764

"description": "User configuration object",

19765

"type": "Object"

19766

}

19767

]

19768

},

19769

"WidgetParent": {

19770

"name": "WidgetParent",

19771

"shortname": "WidgetParent",

19772

"classitems": [],

19773

"plugins": [],

19774

"extensions": [],

19775

"plugin_for": [],

19776

"extension_for": [

19777

"TabView"

19778

],

19779

"module": "widget-parent",

19780

"namespace": "",

19781

"file": "widget-parent/js/Widget-Parent.js",

19782

"line": 11,

19783

"description": "Widget extension providing functionality enabling a Widget to be a \nparent of another Widget.\n\nIn addition to the set of attributes supported by WidgetParent, the constructor\nconfiguration object can also contain a <code>children</code> which can be used\nto add child widgets to the parent during construction. The <code>children</code>\nproperty is an array of either child widget instances or child widget configuration \nobjects, and is sugar for the <a href=\"#method_add\">add</a> method. See the \n<a href=\"#method_add\">add</a> for details on the structure of the child widget \nconfiguration object.",

19784

"is_constructor": 1,

19785

"uses": [

19786

"ArrayList"

19787

],

19788

"params": [

19789

{

19790

"name": "config",

19791

"description": "User configuration object.",

19792

"type": "Object"

19793

}

19794

]

19795

},

19796

"WidgetPositionAlign": {

19797

"name": "WidgetPositionAlign",

19798

"shortname": "WidgetPositionAlign",

19799

"classitems": [],

19800

"plugins": [],

19801

"extensions": [],

19802

"plugin_for": [],

19803

"extension_for": [

19804

"AutoCompleteList",

19805

"Overlay",

19806

"Panel"

19807

],

19808

"module": "widget-position-align",

19809

"namespace": "",

19810

"file": "widget-position-align/js/Widget-PositionAlign.js",

19811

"line": 24,

19812

"description": "Widget extension, which can be used to add extended XY positioning support to\nthe base Widget class, through the `Base.create` method.\n\n**Note:** This extension requires that the `WidgetPosition` extension be added\nto the Widget (before `WidgetPositionAlign`, if part of the same extension list\npassed to `Base.build`).",

19813

"params": [

19814

{

19815

"name": "config",

19816

"description": "User configuration object.",

19817

"type": "Object"

19818

}

19819

],

19820

"is_constructor": 1

19821

},

19822

"WidgetPositionConstrain": {

19823

"name": "WidgetPositionConstrain",

19824

"shortname": "WidgetPositionConstrain",

19825

"classitems": [],

19826

"plugins": [],

19827

"extensions": [],

19828

"plugin_for": [],

19829

"extension_for": [

19830

"Overlay",

19831

"Panel"

19832

],

19833

"module": "widget-position-constrain",

19834

"namespace": "",

19835

"file": "widget-position-constrain/js/Widget-PositionConstrain.js",

19836

"line": 30,

19837

"description": "A widget extension, which can be used to add constrained xy positioning support to the base Widget class,\nthrough the <a href=\"Base.html#method_build\">Base.build</a> method. This extension requires that \nthe WidgetPosition extension be added to the Widget (before WidgetPositionConstrain, if part of the same \nextension list passed to Base.build).",

19838

"params": [

19839

{

19840

"name": "User",

19841

"description": "configuration object",

19842

"type": "Object"

19843

}

19844

]

19845

},

19846

"WidgetPosition": {

19847

"name": "WidgetPosition",

19848

"shortname": "WidgetPosition",

19849

"classitems": [],

19850

"plugins": [],

19851

"extensions": [],

19852

"plugin_for": [],

19853

"extension_for": [

19854

"AutoCompleteList",

19855

"Overlay",

19856

"Panel"

19857

],

19858

"module": "widget-position",

19859

"namespace": "",

19860

"file": "widget-position/js/Widget-Position.js",

19861

"line": 24,

19862

"description": "Widget extension, which can be used to add positioning support to the base Widget class, \nthrough the <a href=\"Base.html#method_build\">Base.build</a> method.",

19863

"params": [

19864

{

19865

"name": "config",

19866

"description": "User configuration object",

19867

"type": "Object"

19868

}

19869

]

19870

},

19871

"WidgetStack": {

19872

"name": "WidgetStack",

19873

"shortname": "WidgetStack",

19874

"classitems": [],

19875

"plugins": [],

19876

"extensions": [],

19877

"plugin_for": [],

19878

"extension_for": [

19879

"Overlay",

19880

"Panel"

19881

],

19882

"module": "widget-stack",

19883

"namespace": "",

19884

"file": "widget-stack/js/Widget-Stack.js",

19885

"line": 46,

19886

"description": "Widget extension, which can be used to add stackable (z-index) support to the\nbase Widget class along with a shimming solution, through the\n<a href=\"Base.html#method_build\">Base.build</a> method.",

19887

"params": [

19888

{

19889

"name": "User",

19890

"description": "configuration object",

19891

"type": "Object"

19892

}

19893

]

19894

},

19895

"WidgetStdMod": {

19896

"name": "WidgetStdMod",

19897

"shortname": "WidgetStdMod",

19898

"classitems": [],

19899

"plugins": [],

19900

"extensions": [],

19901

"plugin_for": [],

19902

"extension_for": [

19903

"Overlay",

19904

"Panel"

19905

],

19906

"module": "widget-stdmod",

19907

"namespace": "",

19908

"file": "widget-stdmod/js/Widget-StdMod.js",

19909

"line": 49,

19910

"description": "Widget extension, which can be used to add Standard Module support to the\nbase Widget class, through the <a href=\"Base.html#method_build\">Base.build</a>\nmethod.\n\nThe extension adds header, body and footer sections to the Widget's content box and\nprovides the corresponding methods and attributes to modify the contents of these sections.\n",

19911

"params": [

19912

{

19913

"name": "The",

19914

"description": "user configuration object",

19915

"type": "Object"

19916

}

19917

]

19918

},

19919

"YQLRequest": {

19920

"name": "YQLRequest",

19921

"shortname": "YQLRequest",

19922

"classitems": [],

19923

"plugins": [],

19924

"extensions": [],

19925

"plugin_for": [],

19926

"extension_for": [],

19927

"module": "yql",

19928

"namespace": "",

19929

"file": "yql/js/yql.js",

19930

"line": 5,

19931

"description": "Utility Class used under the hood my the YQL class",

19932

"is_constructor": 1,

19933

"params": [

19934

{

19935

"name": "sql",

19936

"description": "The SQL statement to execute",

19937

"type": "String"

19938

},

19939

{

19940

"name": "callback",

19941

"description": "The callback to execute after the query (Falls through to JSONP).",

19942

"type": "Function/Object"

19943

},

19944

{

19945

"name": "params",

19946

"description": "An object literal of extra parameters to pass along (optional).",

19947

"type": "Object"

19948

},

19949

{

19950

"name": "opts",

19951

"description": "An object literal of configuration options (optional): proto (http|https), base (url)",

19952

"type": "Object"

19953

}

19954

]

19955

},

19956

"YQL": {

19957

"name": "YQL",

19958

"shortname": "YQL",

19959

"classitems": [],

19960

"plugins": [],

19961

"extensions": [],

19962

"plugin_for": [],

19963

"extension_for": [],

19964

"module": "yql",

19965

"namespace": "",

19966

"file": "yql/js/yql.js",

19967

"line": 122,

19968

"description": "This class adds a sugar class to allow access to YQL (http://developer.yahoo.com/yql/).",

19969

"is_constructor": 1,

19970

"params": [

19971

{

19972

"name": "sql",

19973

"description": "The SQL statement to execute",

19974

"type": "String"

19975

},

19976

{

19977

"name": "callback",

19978

"description": "The callback to execute after the query (optional).",

19979

"type": "Function"

19980

},

19981

{

19982

"name": "params",

19983

"description": "An object literal of extra parameters to pass along (optional).",

19984

"type": "Object"

19985

},

19986

{

19987

"name": "opts",

19988

"description": "An object literal of configuration options (optional): proto (http|https), base (url)",

19989

"type": "Object"

19990

}

19991

]

19992

},

19993

"Features": {

19994

"name": "Features",

19995

"shortname": "Features",

19996

"classitems": [],

19997

"plugins": [],

19998

"extensions": [],

19999

"plugin_for": [],

20000

"extension_for": [],

20001

"module": "features",

20002

"namespace": "",

20003

"file": "yui/js/features.js",

20004

"line": 8,

20005

"description": "Feature detection",

20006

"static": 1

20007

},

20008

"Lang": {

20009

"name": "Lang",

20010

"shortname": "Lang",

20011

"classitems": [],

20012

"plugins": [],

20013

"extensions": [],

20014

"plugin_for": [],

20015

"extension_for": [],

20016

"module": "yui",

20017

"submodule": "yui-base",

20018

"namespace": "",

20019

"file": "yui/js/yui-lang.js",

20020

"line": 9,

20021

"description": "Provides core language utilites and extensions used throughout YUI.",

20022

"static": 1

20023

},

20024

"Object": {

20025

"name": "Object",

20026

"shortname": "Object",

20027

"classitems": [],

20028

"plugins": [],

20029

"extensions": [],

20030

"plugin_for": [],

20031

"extension_for": [],

20032

"module": "yui",

20033

"submodule": "yui-base",

20034

"namespace": "",

20035

"file": "yui/js/yui-object.js",

20036

"line": 9,

20037

"description": "Adds utilities to the YUI instance for working with objects."

20038

},

20039

"UA": {

20040

"name": "UA",

20041

"shortname": "UA",

20042

"classitems": [],

20043

"plugins": [],

20044

"extensions": [],

20045

"plugin_for": [],

20046

"extension_for": [],

20047

"module": "yui",

20048

"submodule": "yui-base",

20049

"namespace": "",

20050

"file": "yui/js/yui-ua.js",

20051

"line": 9,

20052

"description": "YUI user agent detection.\nDo not fork for a browser if it can be avoided. Use feature detection when\nyou can. Use the user agent as a last resort. For all fields listed\nas @type float, UA stores a version number for the browser engine,\n0 otherwise. This value may or may not map to the version number of\nthe browser using the engine. The value is presented as a float so\nthat it can easily be used for boolean evaluation as well as for\nlooking for a particular range of versions. Because of this,\nsome of the granularity of the version info may be lost. The fields that\nare @type string default to null. The API docs list the values that\nthese fields can have.",

20053

"static": 1

20054

}

20055

},

20056

"classitems": [

20057

{

20058

"file": "anim/js/anim-curve.js",

20059

"line": 22,

20060

"description": "Get the current position of the animated element based on t.\nEach point is an array of \"x\" and \"y\" values (0 = x, 1 = y)\nAt least 2 points are required (start and end).\nFirst point is start. Last point is end.\nAdditional control points are optional.",

20061

"itemtype": "method",

20062

"name": "getBezier",

20063

"static": 1,

20064

"params": [

20065

{

20066

"name": "points",

20067

"description": "An array containing Bezier points",

20068

"type": "Array"

20069

},

20070

{

20071

"name": "t",

20072

"description": "A number between 0 and 1 which is the basis for determining current position",

20073

"type": "Number"

20074

}

20075

],

20076

"return": {

20077

"description": "An array containing int x and y member data",

20078

"type": "Array"

20079

},

20080

"class": "Anim",

20081

"module": "anim",

20082

"submodule": "anim-curve"

20083

},

20084

{

20085

"file": "anim/js/anim-easing.js",

20086

"line": 25,

20087

"description": "Uniform speed between points.",

20088

"itemtype": "method",

20089

"name": "easeNone",

20090

"params": [

20091

{

20092

"name": "t",

20093

"description": "Time value used to compute current value",

20094

"type": "Number"

20095

},

20096

{

20097

"name": "b",

20098

"description": "Starting value",

20099

"type": "Number"

20100

},

20101

{

20102

"name": "c",

20103

"description": "Delta between start and end values",

20104

"type": "Number"

20105

},

20106

{

20107

"name": "d",

20108

"description": "Total length of animation",

20109

"type": "Number"

20110

}

20111

],

20112

"return": {

20113

"description": "The computed value for the current animation frame",

20114

"type": "Number"

20115

},

20116

"class": "Easing",

20117

"module": "anim",

20118

"submodule": "anim-easing"

20119

},

20120

{

20121

"file": "anim/js/anim-easing.js",

20122

"line": 39,

20123

"description": "Begins slowly and accelerates towards end. (quadratic)",

20124

"itemtype": "method",

20125

"name": "easeIn",

20126

"params": [

20127

{

20128

"name": "t",

20129

"description": "Time value used to compute current value",

20130

"type": "Number"

20131

},

20132

{

20133

"name": "b",

20134

"description": "Starting value",

20135

"type": "Number"

20136

},

20137

{

20138

"name": "c",

20139

"description": "Delta between start and end values",

20140

"type": "Number"

20141

},

20142

{

20143

"name": "d",

20144

"description": "Total length of animation",

20145

"type": "Number"

20146

}

20147

],

20148

"return": {

20149

"description": "The computed value for the current animation frame",

20150

"type": "Number"

20151

},

20152

"class": "Easing",

20153

"module": "anim",

20154

"submodule": "anim-easing"

20155

},

20156

{

20157

"file": "anim/js/anim-easing.js",

20158

"line": 52,

20159

"description": "Begins quickly and decelerates towards end. (quadratic)",

20160

"itemtype": "method",

20161

"name": "easeOut",

20162

"params": [

20163

{

20164

"name": "t",

20165

"description": "Time value used to compute current value",

20166

"type": "Number"

20167

},

20168

{

20169

"name": "b",

20170

"description": "Starting value",

20171

"type": "Number"

20172

},

20173

{

20174

"name": "c",

20175

"description": "Delta between start and end values",

20176

"type": "Number"

20177

},

20178

{

20179

"name": "d",

20180

"description": "Total length of animation",

20181

"type": "Number"

20182

}

20183

],

20184

"return": {

20185

"description": "The computed value for the current animation frame",

20186

"type": "Number"

20187

},

20188

"class": "Easing",

20189

"module": "anim",

20190

"submodule": "anim-easing"

20191

},

20192

{

20193

"file": "anim/js/anim-easing.js",

20194

"line": 65,

20195

"description": "Begins slowly and decelerates towards end. (quadratic)",

20196

"itemtype": "method",

20197

"name": "easeBoth",

20198

"params": [

20199

{

20200

"name": "t",

20201

"description": "Time value used to compute current value",

20202

"type": "Number"

20203

},

20204

{

20205

"name": "b",

20206

"description": "Starting value",

20207

"type": "Number"

20208

},

20209

{

20210

"name": "c",

20211

"description": "Delta between start and end values",

20212

"type": "Number"

20213

},

20214

{

20215

"name": "d",

20216

"description": "Total length of animation",

20217

"type": "Number"

20218

}

20219

],

20220

"return": {

20221

"description": "The computed value for the current animation frame",

20222

"type": "Number"

20223

},

20224

"class": "Easing",

20225

"module": "anim",

20226

"submodule": "anim-easing"

20227

},

20228

{

20229

"file": "anim/js/anim-easing.js",

20230

"line": 82,

20231

"description": "Begins slowly and accelerates towards end. (quartic)",

20232

"itemtype": "method",

20233

"name": "easeInStrong",

20234

"params": [

20235

{

20236

"name": "t",

20237

"description": "Time value used to compute current value",

20238

"type": "Number"

20239

},

20240

{

20241

"name": "b",

20242

"description": "Starting value",

20243

"type": "Number"

20244

},

20245

{

20246

"name": "c",

20247

"description": "Delta between start and end values",

20248

"type": "Number"

20249

},

20250

{

20251

"name": "d",

20252

"description": "Total length of animation",

20253

"type": "Number"

20254

}

20255

],

20256

"return": {

20257

"description": "The computed value for the current animation frame",

20258

"type": "Number"

20259

},

20260

"class": "Easing",

20261

"module": "anim",

20262

"submodule": "anim-easing"

20263

},

20264

{

20265

"file": "anim/js/anim-easing.js",

20266

"line": 95,

20267

"description": "Begins quickly and decelerates towards end. (quartic)",

20268

"itemtype": "method",

20269

"name": "easeOutStrong",

20270

"params": [

20271

{

20272

"name": "t",

20273

"description": "Time value used to compute current value",

20274

"type": "Number"

20275

},

20276

{

20277

"name": "b",

20278

"description": "Starting value",

20279

"type": "Number"

20280

},

20281

{

20282

"name": "c",

20283

"description": "Delta between start and end values",

20284

"type": "Number"

20285

},

20286

{

20287

"name": "d",

20288

"description": "Total length of animation",

20289

"type": "Number"

20290

}

20291

],

20292

"return": {

20293

"description": "The computed value for the current animation frame",

20294

"type": "Number"

20295

},

20296

"class": "Easing",

20297

"module": "anim",

20298

"submodule": "anim-easing"

20299

},

20300

{

20301

"file": "anim/js/anim-easing.js",

20302

"line": 108,

20303

"description": "Begins slowly and decelerates towards end. (quartic)",

20304

"itemtype": "method",

20305

"name": "easeBothStrong",

20306

"params": [

20307

{

20308

"name": "t",

20309

"description": "Time value used to compute current value",

20310

"type": "Number"

20311

},

20312

{

20313

"name": "b",

20314

"description": "Starting value",

20315

"type": "Number"

20316

},

20317

{

20318

"name": "c",

20319

"description": "Delta between start and end values",

20320

"type": "Number"

20321

},

20322

{

20323

"name": "d",

20324

"description": "Total length of animation",

20325

"type": "Number"

20326

}

20327

],

20328

"return": {

20329

"description": "The computed value for the current animation frame",

20330

"type": "Number"

20331

},

20332

"class": "Easing",

20333

"module": "anim",

20334

"submodule": "anim-easing"

20335

},

20336

{

20337

"file": "anim/js/anim-easing.js",

20338

"line": 125,

20339

"description": "Snap in elastic effect.",

20340

"itemtype": "method",

20341

"name": "elasticIn",

20342

"params": [

20343

{

20344

"name": "t",

20345

"description": "Time value used to compute current value",

20346

"type": "Number"

20347

},

20348

{

20349

"name": "b",

20350

"description": "Starting value",

20351

"type": "Number"

20352

},

20353

{

20354

"name": "c",

20355

"description": "Delta between start and end values",

20356

"type": "Number"

20357

},

20358

{

20359

"name": "d",

20360

"description": "Total length of animation",

20361

"type": "Number"

20362

},

20363

{

20364

"name": "a",

20365

"description": "Amplitude (optional)",

20366

"type": "Number"

20367

},

20368

{

20369

"name": "p",

20370

"description": "Period (optional)",

20371

"type": "Number"

20372

}

20373

],

20374

"return": {

20375

"description": "The computed value for the current animation frame",

20376

"type": "Number"

20377

},

20378

"class": "Easing",

20379

"module": "anim",

20380

"submodule": "anim-easing"

20381

},

20382

{

20383

"file": "anim/js/anim-easing.js",

20384

"line": 160,

20385

"description": "Snap out elastic effect.",

20386

"itemtype": "method",

20387

"name": "elasticOut",

20388

"params": [

20389

{

20390

"name": "t",

20391

"description": "Time value used to compute current value",

20392

"type": "Number"

20393

},

20394

{

20395

"name": "b",

20396

"description": "Starting value",

20397

"type": "Number"

20398

},

20399

{

20400

"name": "c",

20401

"description": "Delta between start and end values",

20402

"type": "Number"

20403

},

20404

{

20405

"name": "d",

20406

"description": "Total length of animation",

20407

"type": "Number"

20408

},

20409

{

20410

"name": "a",

20411

"description": "Amplitude (optional)",

20412

"type": "Number"

20413

},

20414

{

20415

"name": "p",

20416

"description": "Period (optional)",

20417

"type": "Number"

20418

}

20419

],

20420

"return": {

20421

"description": "The computed value for the current animation frame",

20422

"type": "Number"

20423

},

20424

"class": "Easing",

20425

"module": "anim",

20426

"submodule": "anim-easing"

20427

},

20428

{

20429

"file": "anim/js/anim-easing.js",

20430

"line": 194,

20431

"description": "Snap both elastic effect.",

20432

"itemtype": "method",

20433

"name": "elasticBoth",

20434

"params": [

20435

{

20436

"name": "t",

20437

"description": "Time value used to compute current value",

20438

"type": "Number"

20439

},

20440

{

20441

"name": "b",

20442

"description": "Starting value",

20443

"type": "Number"

20444

},

20445

{

20446

"name": "c",

20447

"description": "Delta between start and end values",

20448

"type": "Number"

20449

},

20450

{

20451

"name": "d",

20452

"description": "Total length of animation",

20453

"type": "Number"

20454

},

20455

{

20456

"name": "a",

20457

"description": "Amplitude (optional)",

20458

"type": "Number"

20459

},

20460

{

20461

"name": "p",

20462

"description": "Period (optional)",

20463

"type": "Number"

20464

}

20465

],

20466

"return": {

20467

"description": "The computed value for the current animation frame",

20468

"type": "Number"

20469

},

20470

"class": "Easing",

20471

"module": "anim",

20472

"submodule": "anim-easing"

20473

},

20474

{

20475

"file": "anim/js/anim-easing.js",

20476

"line": 236,

20477

"description": "Backtracks slightly, then reverses direction and moves to end.",

20478

"itemtype": "method",

20479

"name": "backIn",

20480

"params": [

20481

{

20482

"name": "t",

20483

"description": "Time value used to compute current value",

20484

"type": "Number"

20485

},

20486

{

20487

"name": "b",

20488

"description": "Starting value",

20489

"type": "Number"

20490

},

20491

{

20492

"name": "c",

20493

"description": "Delta between start and end values",

20494

"type": "Number"

20495

},

20496

{

20497

"name": "d",

20498

"description": "Total length of animation",

20499

"type": "Number"

20500

},

20501

{

20502

"name": "s",

20503

"description": "Overshoot (optional)",

20504

"type": "Number"

20505

}

20506

],

20507

"return": {

20508

"description": "The computed value for the current animation frame",

20509

"type": "Number"

20510

},

20511

"class": "Easing",

20512

"module": "anim",

20513

"submodule": "anim-easing"

20514

},

20515

{

20516

"file": "anim/js/anim-easing.js",

20517

"line": 256,

20518

"description": "Overshoots end, then reverses and comes back to end.",

20519

"itemtype": "method",

20520

"name": "backOut",

20521

"params": [

20522

{

20523

"name": "t",

20524

"description": "Time value used to compute current value",

20525

"type": "Number"

20526

},

20527

{

20528

"name": "b",

20529

"description": "Starting value",

20530

"type": "Number"

20531

},

20532

{

20533

"name": "c",

20534

"description": "Delta between start and end values",

20535

"type": "Number"

20536

},

20537

{

20538

"name": "d",

20539

"description": "Total length of animation",

20540

"type": "Number"

20541

},

20542

{

20543

"name": "s",

20544

"description": "Overshoot (optional)",

20545

"type": "Number"

20546

}

20547

],

20548

"return": {

20549

"description": "The computed value for the current animation frame",

20550

"type": "Number"

20551

},

20552

"class": "Easing",

20553

"module": "anim",

20554

"submodule": "anim-easing"

20555

},

20556

{

20557

"file": "anim/js/anim-easing.js",

20558

"line": 273,

20559

"description": "Backtracks slightly, then reverses direction, overshoots end, \nthen reverses and comes back to end.",

20560

"itemtype": "method",

20561

"name": "backBoth",

20562

"params": [

20563

{

20564

"name": "t",

20565

"description": "Time value used to compute current value",

20566

"type": "Number"

20567

},

20568

{

20569

"name": "b",

20570

"description": "Starting value",

20571

"type": "Number"

20572

},

20573

{

20574

"name": "c",

20575

"description": "Delta between start and end values",

20576

"type": "Number"

20577

},

20578

{

20579

"name": "d",

20580

"description": "Total length of animation",

20581

"type": "Number"

20582

},

20583

{

20584

"name": "s",

20585

"description": "Overshoot (optional)",

20586

"type": "Number"

20587

}

20588

],

20589

"return": {

20590

"description": "The computed value for the current animation frame",

20591

"type": "Number"

20592

},

20593

"class": "Easing",

20594

"module": "anim",

20595

"submodule": "anim-easing"

20596

},

20597

{

20598

"file": "anim/js/anim-easing.js",

20599

"line": 295,

20600

"description": "Bounce off of start.",

20601

"itemtype": "method",

20602

"name": "bounceIn",

20603

"params": [

20604

{

20605

"name": "t",

20606

"description": "Time value used to compute current value",

20607

"type": "Number"

20608

},

20609

{

20610

"name": "b",

20611

"description": "Starting value",

20612

"type": "Number"

20613

},

20614

{

20615

"name": "c",

20616

"description": "Delta between start and end values",

20617

"type": "Number"

20618

},

20619

{

20620

"name": "d",

20621

"description": "Total length of animation",

20622

"type": "Number"

20623

}

20624

],

20625

"return": {

20626

"description": "The computed value for the current animation frame",

20627

"type": "Number"

20628

},

20629

"class": "Easing",

20630

"module": "anim",

20631

"submodule": "anim-easing"

20632

},

20633

{

20634

"file": "anim/js/anim-easing.js",

20635

"line": 308,

20636

"description": "Bounces off end.",

20637

"itemtype": "method",

20638

"name": "bounceOut",

20639

"params": [

20640

{

20641

"name": "t",

20642

"description": "Time value used to compute current value",

20643

"type": "Number"

20644

},

20645

{

20646

"name": "b",

20647

"description": "Starting value",

20648

"type": "Number"

20649

},

20650

{

20651

"name": "c",

20652

"description": "Delta between start and end values",

20653

"type": "Number"

20654

},

20655

{

20656

"name": "d",

20657

"description": "Total length of animation",

20658

"type": "Number"

20659

}

20660

],

20661

"return": {

20662

"description": "The computed value for the current animation frame",

20663

"type": "Number"

20664

},

20665

"class": "Easing",

20666

"module": "anim",

20667

"submodule": "anim-easing"

20668

},

20669

{

20670

"file": "anim/js/anim-easing.js",

20671

"line": 328,

20672

"description": "Bounces off start and end.",

20673

"itemtype": "method",

20674

"name": "bounceBoth",

20675

"params": [

20676

{

20677

"name": "t",

20678

"description": "Time value used to compute current value",

20679

"type": "Number"

20680

},

20681

{

20682

"name": "b",

20683

"description": "Starting value",

20684

"type": "Number"

20685

},

20686

{

20687

"name": "c",

20688

"description": "Delta between start and end values",

20689

"type": "Number"

20690

},

20691

{

20692

"name": "d",

20693

"description": "Total length of animation",

20694

"type": "Number"

20695

}

20696

],

20697

"return": {

20698

"description": "The computed value for the current animation frame",

20699

"type": "Number"

20700

},

20701

"class": "Easing",

20702

"module": "anim",

20703

"submodule": "anim-easing"

20704

},

20705

{

20706

"file": "anim/js/anim.js",

20707

"line": 24,

20708

"itemtype": "event",

20709

"name": "start",

20710

"description": "fires when an animation begins.",

20711

"params": [

20712

{

20713

"name": "ev",

20714

"description": "The start event.",

20715

"type": "Event"

20716

}

20717

],

20718

"type": "Event.Custom",

20719

"class": "Anim",

20720

"module": "anim",

20721

"submodule": "anim-base"

20722

},

20723

{

20724

"file": "anim/js/anim.js",

20725

"line": 33,

20726

"itemtype": "event",

20727

"name": "tween",

20728

"description": "fires every frame of the animation.",

20729

"params": [

20730

{

20731

"name": "ev",

20732

"description": "The tween event.",

20733

"type": "Event"

20734

}

20735

],

20736

"type": "Event.Custom",

20737

"class": "Anim",

20738

"module": "anim",

20739

"submodule": "anim-base"

20740

},

20741

{

20742

"file": "anim/js/anim.js",

20743

"line": 41,

20744

"itemtype": "event",

20745

"name": "end",

20746

"description": "fires after the animation completes.",

20747

"params": [

20748

{

20749

"name": "ev",

20750

"description": "The end event.",

20751

"type": "Event"

20752

}

20753

],

20754

"type": "Event.Custom",

20755

"class": "Anim",

20756

"module": "anim",

20757

"submodule": "anim-base"

20758

},

20759

{

20760

"file": "anim/js/anim.js",

20761

"line": 67,

20762

"description": "Regex of properties that should use the default unit.",

20763

"itemtype": "property",

20764

"name": "RE_DEFAULT_UNIT",

20765

"static": 1,

20766

"class": "Anim",

20767

"module": "anim",

20768

"submodule": "anim-base"

20769

},

20770

{

20771

"file": "anim/js/anim.js",

20772

"line": 75,

20773

"description": "The default unit to use with properties that pass the RE_DEFAULT_UNIT test.",

20774

"itemtype": "property",

20775

"name": "DEFAULT_UNIT",

20776

"static": 1,

20777

"class": "Anim",

20778

"module": "anim",

20779

"submodule": "anim-base"

20780

},

20781

{

20782

"file": "anim/js/anim.js",

20783

"line": 87,

20784

"description": "Time in milliseconds passed to setInterval for frame processing",

20785

"itemtype": "property",

20786

"name": "intervalTime",

20787

"default": "20",

20788

"static": 1,

20789

"class": "Anim",

20790

"module": "anim",

20791

"submodule": "anim-base"

20792

},

20793

{

20794

"file": "anim/js/anim.js",

20795

"line": 96,

20796

"description": "Bucket for custom getters and setters",

20797

"itemtype": "property",

20798

"name": "behaviors",

20799

"static": 1,

20800

"class": "Anim",

20801

"module": "anim",

20802

"submodule": "anim-base"

20803

},

20804

{

20805

"file": "anim/js/anim.js",

20806

"line": 112,

20807

"description": "The default setter to use when setting object properties.",

20808

"itemtype": "property",

20809

"name": "DEFAULT_SETTER",

20810

"static": 1,

20811

"class": "Anim",

20812

"module": "anim",

20813

"submodule": "anim-base"

20814

},

20815

{

20816

"file": "anim/js/anim.js",

20817

"line": 135,

20818

"description": "The default getter to use when getting object properties.",

20819

"itemtype": "property",

20820

"name": "DEFAULT_GETTER",

20821

"static": 1,

20822

"class": "Anim",

20823

"module": "anim",

20824

"submodule": "anim-base"

20825

},

20826

{

20827

"file": "anim/js/anim.js",

20828

"line": 160,

20829

"description": "The object to be animated.",

20830

"itemtype": "attribute",

20831

"name": "node",

20832

"type": "Node",

20833

"class": "Anim",

20834

"module": "anim",

20835

"submodule": "anim-base"

20836

},

20837

{

20838

"file": "anim/js/anim.js",

20839

"line": 181,

20840

"description": "The length of the animation. Defaults to \"1\" (second).",

20841

"itemtype": "attribute",

20842

"name": "duration",

20843

"type": "NUM",

20844

"class": "Anim",

20845

"module": "anim",

20846

"submodule": "anim-base"

20847

},

20848

{

20849

"file": "anim/js/anim.js",

20850

"line": 190,

20851

"description": "The method that will provide values to the attribute(s) during the animation. \nDefaults to \"Easing.easeNone\".",

20852

"itemtype": "attribute",

20853

"name": "easing",

20854

"type": "Function",

20855

"class": "Anim",

20856

"module": "anim",

20857

"submodule": "anim-base"

20858

},

20859

{

20860

"file": "anim/js/anim.js",

20861

"line": 206,

20862

"description": "The starting values for the animated properties.\n\nFields may be strings, numbers, or functions.\nIf a function is used, the return value becomes the from value.\nIf no from value is specified, the DEFAULT_GETTER will be used.\nSupports any unit, provided it matches the \"to\" (or default)\nunit (e.g. `{width: '10em', color: 'rgb(0, 0 0)', borderColor: '#ccc'}`).\n\nIf using the default ('px' for length-based units), the unit may be omitted\n(e.g. `{width: 100}, borderColor: 'ccc'}`, which defaults to pixels\nand hex, respectively).",

20863

"itemtype": "attribute",

20864

"name": "from",

20865

"type": "Object",

20866

"class": "Anim",

20867

"module": "anim",

20868

"submodule": "anim-base"

20869

},

20870

{

20871

"file": "anim/js/anim.js",

20872

"line": 224,

20873

"description": "The ending values for the animated properties.\n\nFields may be strings, numbers, or functions.\nSupports any unit, provided it matches the \"from\" (or default)\nunit (e.g. `{width: '50%', color: 'red', borderColor: '#ccc'}`).\n\nIf using the default ('px' for length-based units), the unit may be omitted\n(e.g. `{width: 100, borderColor: 'ccc'}`, which defaults to pixels\nand hex, respectively).",

20874

"itemtype": "attribute",

20875

"name": "to",

20876

"type": "Object",

20877

"class": "Anim",

20878

"module": "anim",

20879

"submodule": "anim-base"

20880

},

20881

{

20882

"file": "anim/js/anim.js",

20883

"line": 240,

20884

"description": "Date stamp for the first frame of the animation.",

20885

"itemtype": "attribute",

20886

"name": "startTime",

20887

"type": "Int",

20888

"default": "0",

20889

"readonly": "",

20890

"class": "Anim",

20891

"module": "anim",

20892

"submodule": "anim-base"

20893

},

20894

{

20895

"file": "anim/js/anim.js",

20896

"line": 252,

20897

"description": "Current time the animation has been running.",

20898

"itemtype": "attribute",

20899

"name": "elapsedTime",

20900

"type": "Int",

20901

"default": "0",

20902

"readonly": "",

20903

"class": "Anim",

20904

"module": "anim",

20905

"submodule": "anim-base"

20906

},

20907

{

20908

"file": "anim/js/anim.js",

20909

"line": 264,

20910

"description": "Whether or not the animation is currently running.",

20911

"itemtype": "attribute",

20912

"name": "running",

20913

"type": "Boolean",

20914

"default": "false",

20915

"readonly": "",

20916

"class": "Anim",

20917

"module": "anim",

20918

"submodule": "anim-base"

20919

},

20920

{

20921

"file": "anim/js/anim.js",

20922

"line": 279,

20923

"description": "The number of times the animation should run",

20924

"itemtype": "attribute",

20925

"name": "iterations",

20926

"type": "Int",

20927

"default": "1",

20928

"class": "Anim",

20929

"module": "anim",

20930

"submodule": "anim-base"

20931

},

20932

{

20933

"file": "anim/js/anim.js",

20934

"line": 289,

20935

"description": "The number of iterations that have occurred.\nResets when an animation ends (reaches iteration count or stop() called).",

20936

"itemtype": "attribute",

20937

"name": "iterationCount",

20938

"type": "Int",

20939

"default": "0",

20940

"readonly": "",

20941

"class": "Anim",

20942

"module": "anim",

20943

"submodule": "anim-base"

20944

},

20945

{

20946

"file": "anim/js/anim.js",

20947

"line": 302,

20948

"description": "How iterations of the animation should behave. \nPossible values are \"normal\" and \"alternate\".\nNormal will repeat the animation, alternate will reverse on every other pass.",

20949

"itemtype": "attribute",

20950

"name": "direction",

20951

"type": "String",

20952

"default": "\"normal\"",

20953

"class": "Anim",

20954

"module": "anim",

20955

"submodule": "anim-base"

20956

},

20957

{

20958

"file": "anim/js/anim.js",

20959

"line": 315,

20960

"description": "Whether or not the animation is currently paused.",

20961

"itemtype": "attribute",

20962

"name": "paused",

20963

"type": "Boolean",

20964

"default": "false",

20965

"readonly": "",

20966

"class": "Anim",

20967

"module": "anim",

20968

"submodule": "anim-base"

20969

},

20970

{

20971

"file": "anim/js/anim.js",

20972

"line": 327,

20973

"description": "If true, animation begins from last frame",

20974

"itemtype": "attribute",

20975

"name": "reverse",

20976

"type": "Boolean",

20977

"default": "false",

20978

"class": "Anim",

20979

"module": "anim",

20980

"submodule": "anim-base"

20981

},

20982

{

20983

"file": "anim/js/anim.js",

20984

"line": 340,

20985

"description": "Runs all animation instances.",

20986

"itemtype": "method",

20987

"name": "run",

20988

"static": 1,

20989

"class": "Anim",

20990

"module": "anim",

20991

"submodule": "anim-base"

20992

},

20993

{

20994

"file": "anim/js/anim.js",

20995

"line": 354,

20996

"description": "Pauses all animation instances.",

20997

"itemtype": "method",

20998

"name": "pause",

20999

"static": 1,

21000

"class": "Anim",

21001

"module": "anim",

21002

"submodule": "anim-base"

21003

},

21004

{

21005

"file": "anim/js/anim.js",

21006

"line": 369,

21007

"description": "Stops all animation instances.",

21008

"itemtype": "method",

21009

"name": "stop",

21010

"static": 1,

21011

"class": "Anim",

21012

"module": "anim",

21013

"submodule": "anim-base"

21014

},

21015

{

21016

"file": "anim/js/anim.js",

21017

"line": 394,

21018

"description": "Called per Interval to handle each animation frame.",

21019

"itemtype": "method",

21020

"name": "_runFrame",

21021

"access": "private",

21022

"tagname": "",

21023

"static": 1,

21024

"class": "Anim",

21025

"module": "anim",

21026

"submodule": "anim-base"

21027

},

21028

{

21029

"file": "anim/js/anim.js",

21030

"line": 417,

21031

"description": "Starts or resumes an animation.",

21032

"itemtype": "method",

21033

"name": "run",

21034

"chainable": 1,

21035

"class": "Anim",

21036

"module": "anim",

21037

"submodule": "anim-base"

21038

},

21039

{

21040

"file": "anim/js/anim.js",

21041

"line": 431,

21042

"description": "Pauses the animation and\nfreezes it in its current state and time.\nCalling run() will continue where it left off.",

21043

"itemtype": "method",

21044

"name": "pause",

21045

"chainable": 1,

21046

"class": "Anim",

21047

"module": "anim",

21048

"submodule": "anim-base"

21049

},

21050

{

21051

"file": "anim/js/anim.js",

21052

"line": 445,

21053

"description": "Stops the animation and resets its time.",

21054

"itemtype": "method",

21055

"name": "stop",

21056

"params": [

21057

{

21058

"name": "finish",

21059

"description": "If true, the animation will move to the last frame",

21060

"type": "Boolean"

21061

}

21062

],

21063

"chainable": 1,

21064

"class": "Anim",

21065

"module": "anim",

21066

"submodule": "anim-base"

21067

},

21068

{

21069

"file": "anim/js/anim.js",

21070

"line": 477,

21071

"itemtype": "event",

21072

"name": "pause",

21073

"description": "fires when an animation is paused.",

21074

"params": [

21075

{

21076

"name": "ev",

21077

"description": "The pause event.",

21078

"type": "Event"

21079

}

21080

],

21081

"type": "Event.Custom",

21082

"class": "Anim",

21083

"module": "anim",

21084

"submodule": "anim-base"

21085

},

21086

{

21087

"file": "anim/js/anim.js",

21088

"line": 492,

21089

"itemtype": "event",

21090

"name": "resume",

21091

"description": "fires when an animation is resumed (run from pause).",

21092

"params": [

21093

{

21094

"name": "ev",

21095

"description": "The pause event.",

21096

"type": "Event"

21097

}

21098

],

21099

"type": "Event.Custom",

21100

"class": "Anim",

21101

"module": "anim",

21102

"submodule": "anim-base"

21103

},

21104

{

21105

"file": "anim/js/anim.js",

21106

"line": 578,

21107

"itemtype": "event",

21108

"name": "iteration",

21109

"description": "fires when an animation begins an iteration.",

21110

"params": [

21111

{

21112

"name": "ev",

21113

"description": "The iteration event.",

21114

"type": "Event"

21115

}

21116

],

21117

"type": "Event.Custom",

21118

"class": "Anim",

21119

"module": "anim",

21120

"submodule": "anim-base"

21121

},

21122

{

21123

"file": "app/js/app-extensions/app-transitions-native.js",

21124

"line": 27,

21125

"description": "Whether this app is currently transitioning its `activeView`.",

21126

"itemtype": "property",

21127

"name": "_transitioning",

21128

"type": "Boolean",

21129

"default": "false",

21130

"access": "protected",

21131

"tagname": "",

21132

"since": "3.5.0",

21133

"class": "App.TransitionsNative",

21134

"module": "app",

21135

"submodule": "app-transitions-native"

21136

},

21137

{

21138

"file": "app/js/app-extensions/app-transitions-native.js",

21139

"line": 37,

21140

"description": "A queue that holds pending calls to this app's `_uiTransitionActiveView()`\nmethod.",

21141

"itemtype": "property",

21142

"name": "_viewTransitionQueue",

21143

"type": "Array",

21144

"default": "[]",

21145

"access": "protected",

21146

"tagname": "",

21147

"since": "3.5.0",

21148

"class": "App.TransitionsNative",

21149

"module": "app",

21150

"submodule": "app-transitions-native"

21151

},

21152

{

21153

"file": "app/js/app-extensions/app-transitions-native.js",

21154

"line": 60,

21155

"description": "Dequeues any pending calls to `_uiTransitionActiveView()`.\n\n**Note:** When there is more than one queued transition, only the most\nrecent `activeView` change will be visually transitioned, while the others\nwill have their `transition` option overridden to `false`.",

21156

"itemtype": "method",

21157

"name": "_dequeueActiveView",

21158

"access": "protected",

21159

"tagname": "",

21160

"since": "3.5.0",

21161

"class": "App.TransitionsNative",

21162

"module": "app",

21163

"submodule": "app-transitions-native"

21164

},

21165

{

21166

"file": "app/js/app-extensions/app-transitions-native.js",

21167

"line": 89,

21168

"description": "Returns an object containing a named fx for both `viewIn` and `viewOut`\nbased on the relationship between the specified `newView` and `oldView`.",

21169

"itemtype": "method",

21170

"name": "_getFx",

21171

"params": [

21172

{

21173

"name": "newView",

21174

"description": "The view being transitioned-in.",

21175

"type": "View"

21176

},

21177

{

21178

"name": "oldView",

21179

"description": "The view being transitioned-out.",

21180

"type": "View"

21181

},

21182

{

21183

"name": "transition",

21184

"description": "The preferred transition to use.",

21185

"type": "String",

21186

"optional": true

21187

}

21188

],

21189

"return": {

21190

"description": "An object containing a named fx for both `viewIn` and\n `viewOut`.",

21191

"type": "Object"

21192

},

21193

"access": "protected",

21194

"tagname": "",

21195

"since": "3.5.0",

21196

"class": "App.TransitionsNative",

21197

"module": "app",

21198

"submodule": "app-transitions-native"

21199

},

21200

{

21201

"file": "app/js/app-extensions/app-transitions-native.js",

21202

"line": 125,

21203

"description": "Queues calls to `_uiTransitionActiveView()` to make sure a currently running\ntransition isn't interrupted.\n\n**Note:** This method prevents the default `_uiSetActiveView()` method from\nrunning.",

21204

"itemtype": "method",

21205

"name": "_queueActiveView",

21206

"access": "protected",

21207

"tagname": "",

21208

"since": "3.5.0",

21209

"class": "App.TransitionsNative",

21210

"module": "app",

21211

"submodule": "app-transitions-native"

21212

},

21213

{

21214

"file": "app/js/app-extensions/app-transitions-native.js",

21215

"line": 148,

21216

"description": "Performs the actual change of this app's `activeView` by visually\ntransitioning between the `newView` and `oldView` using any specified\n`options`.\n\nThe `newView` is attached to the app by rendering it to the `viewContainer`,\nand making this app a bubble target of its events.\n\nThe `oldView` is detached from the app by removing it from the\n`viewContainer`, and removing this app as a bubble target for its events.\nThe `oldView` will either be preserved or properly destroyed.\n\n**Note:** This method overrides `_uiSetActiveView()` and provides all of its\nfunctionality plus supports visual transitions. Also, the `activeView`\nattribute is read-only and can be changed by calling the `showView()`\nmethod.",

21217

"itemtype": "method",

21218

"name": "_uiTransitionActiveView",

21219

"params": [

21220

{

21221

"name": "newView",

21222

"description": "The View which is now this app's `activeView`.",

21223

"type": "View"

21224

},

21225

{

21226

"name": "oldView",

21227

"description": "The View which was this app's `activeView`.",

21228

"type": "View",

21229

"optional": true

21230

},

21231

{

21232

"name": "options",

21233

"description": "Optional object containing any of the following\n properties:",

21234

"type": "Object",

21235

"optional": true,

21236

"props": [

21237

{

21238

"name": "callback",

21239

"description": "Optional callback function to call\n after new `activeView` is ready to use, the function will be passed:",

21240

"type": "Function",

21241

"optional": true,

21242

"props": [

21243

{

21244

"name": "view",

21245

"description": "A reference to the new\n `activeView`.",

21246

"type": "View"

21247

}

21248

]

21249

},

21250

{

21251

"name": "prepend",

21252

"description": "Whether the `view` should be\n prepended instead of appended to the `viewContainer`.",

21253

"type": "Boolean",

21254

"optional": true,

21255

"optdefault": "false"

21256

},

21257

{

21258

"name": "render",

21259

"description": "Whether the `view` should be rendered.\n **Note:** If no value is specified, a view instance will only be\n rendered if it's newly created by this method.",

21260

"type": "Boolean",

21261

"optional": true

21262

},

21263

{

21264

"name": "transition",

21265

"description": "Optional transition override.\n A transition can be specified which will override the default, or\n `false` for no transition.",

21266

"type": "Boolean|String",

21267

"optional": true

21268

},

21269

{

21270

"name": "update",

21271

"description": "Whether an existing view should\n have its attributes updated by passing the `config` object to its\n `setAttrs()` method. **Note:** This option does not have an effect if\n the `view` instance is created as a result of calling this method.",

21272

"type": "Boolean",

21273

"optional": true,

21274

"optdefault": "false"

21275

}

21276

]

21277

}

21278

],

21279

"access": "protected",

21280

"tagname": "",

21281

"since": "3.5.0",

21282

"class": "App.TransitionsNative",

21283

"module": "app",

21284

"submodule": "app-transitions-native"

21285

},

21286

{

21287

"file": "app/js/app-extensions/app-transitions.js",

21288

"line": 39,

21289

"description": "Whether or not this application should use view transitions, and if so then\nwhich ones or `true` for the defaults which are specified by the\n`transitions` prototype property.\n\n**Note:** Transitions are an opt-in feature and will only be used in\nbrowsers which support native CSS3 transitions.",

21290

"itemtype": "attribute",

21291

"name": "transitions",

21292

"type": "Boolean|Object",

21293

"default": "false",

21294

"since": "3.5.0",

21295

"class": "App.Transitions",

21296

"module": "app",

21297

"submodule": "app-transitions"

21298

},

21299

{

21300

"file": "app/js/app-extensions/app-transitions.js",

21301

"line": 58,

21302

"description": "CSS classes used by `App.Transitions`.\n\nWhen an app is transitioning between `activeView`s, its `container` node will\nhave the \"yui3-app-transitioning\" CSS class added.",

21303

"itemtype": "property",

21304

"name": "CLASS_NAMES",

21305

"type": "Object",

21306

"static": 1,

21307

"since": "3.5.0",

21308

"class": "App.Transitions",

21309

"module": "app",

21310

"submodule": "app-transitions"

21311

},

21312

{

21313

"file": "app/js/app-extensions/app-transitions.js",

21314

"line": 73,

21315

"description": "Collect of transitions -> fx.\n\nA transition (e.g. \"fade\") is a simple name given to a configuration of fx to\napply, consisting of `viewIn` and `viewOut` properties who's values are names of\nfx registered on `Y.Transition.fx`.\n\nBy default transitions: `fade`, `slideLeft`, and `slideRight` have fx defined.",

21316

"itemtype": "property",

21317

"name": "FX",

21318

"type": "Object",

21319

"static": 1,

21320

"since": "3.5.0",

21321

"class": "App.Transitions",

21322

"module": "app",

21323

"submodule": "app-transitions"

21324

},

21325

{

21326

"file": "app/js/app-extensions/app-transitions.js",

21327

"line": 107,

21328

"description": "Default transitions to use when the `activeView` changes.\n\nThe following are types of changes for which transitions can be defined that\ncorrespond to the relationship between the new and previous `activeView`:\n\n * `navigate`: The default transition to use when changing the `activeView`\n of the application.\n\n * `toChild`: The transition to use when the new `activeView` is configured\n as a child of the previously active view via its `parent` property as\n defined in this app's `views`.\n\n * `toParent`: The transition to use when the new `activeView` is\n configured as the `parent` of the previously active view as defined in\n this app's `views`.\n\n**Note:** Transitions are an opt-in feature and will only be used in\nbrowsers which support native CSS3 transitions.",

21329

"itemtype": "property",

21330

"name": "transitions",

21331

"type": "Object",

21332

"default": "{\n navigate: 'fade',\n toChild : 'slideLeft',\n toParent: 'slideRight'\n }",

21333

"since": "3.5.0",

21334

"class": "App.Transitions",

21335

"module": "app",

21336

"submodule": "app-transitions"

21337

},

21338

{

21339

"file": "app/js/app-extensions/app-transitions.js",

21340

"line": 145,

21341

"description": "Sets which view is active/visible for the application. This will set the\napp's `activeView` attribute to the specified `view`.\n\nThe `view` will be \"attached\" to this app, meaning it will be both rendered\ninto this app's `viewContainer` node and all of its events will bubble to\nthe app. The previous `activeView` will be \"detached\" from this app.\n\nWhen a string-name is provided for a view which has been registered on this\napp's `views` object, the referenced metadata will be used and the\n`activeView` will be set to either a preserved view instance, or a new\ninstance of the registered view will be created using the specified `config`\nobject passed-into this method.\n\nA callback function can be specified as either the third or fourth argument,\nand this function will be called after the new `view` becomes the\n`activeView`, is rendered to the `viewContainer`, and is ready to use.",

21342

"example": [

21343

"\n var app = new Y.App({\n views: {\n usersView: {\n // Imagine that `Y.UsersView` has been defined.\n type: Y.UsersView\n }\n },\n\n transitions: true,\n users : new Y.ModelList()\n });\n\n app.route('/users/', function () {\n this.showView('usersView', {users: this.get('users')});\n });\n\n app.render();\n app.navigate('/uses/');\n // => Creates a new `Y.UsersView` and transitions to it."

21344

],

21345

"itemtype": "method",

21346

"name": "showView",

21347

"params": [

21348

{

21349

"name": "view",

21350

"description": "The name of a view defined in the `views` object,\n or a view instance which should become this app's `activeView`.",

21351

"type": "String|View"

21352

},

21353

{

21354

"name": "config",

21355

"description": "Optional configuration to use when creating a new\n view instance. This config object can also be used to update an existing\n or preserved view's attributes when `options.update` is `true`.",

21356

"type": "Object",

21357

"optional": true

21358

},

21359

{

21360

"name": "options",

21361

"description": "Optional object containing any of the following\n properties:",

21362

"type": "Object",

21363

"optional": true,

21364

"props": [

21365

{

21366

"name": "callback",

21367

"description": "Optional callback function to call\n after new `activeView` is ready to use, the function will be passed:",

21368

"type": "Function",

21369

"optional": true,

21370

"props": [

21371

{

21372

"name": "view",

21373

"description": "A reference to the new\n `activeView`.",

21374

"type": "View"

21375

}

21376

]

21377

},

21378

{

21379

"name": "prepend",

21380

"description": "Whether the `view` should be\n prepended instead of appended to the `viewContainer`.",

21381

"type": "Boolean",

21382

"optional": true,

21383

"optdefault": "false"

21384

},

21385

{

21386

"name": "render",

21387

"description": "Whether the `view` should be rendered.\n **Note:** If no value is specified, a view instance will only be\n rendered if it's newly created by this method.",

21388

"type": "Boolean",

21389

"optional": true

21390

},

21391

{

21392

"name": "transition",

21393

"description": "Optional transition override.\n A transition can be specified which will override the default, or\n `false` for no transition.",

21394

"type": "Boolean|String",

21395

"optional": true

21396

},

21397

{

21398

"name": "update",

21399

"description": "Whether an existing view should\n have its attributes updated by passing the `config` object to its\n `setAttrs()` method. **Note:** This option does not have an effect if\n the `view` instance is created as a result of calling this method.",

21400

"type": "Boolean",

21401

"optional": true,

21402

"optdefault": "false"

21403

}

21404

]

21405

},

21406

{

21407

"name": "callback",

21408

"description": "Optional callback Function to call after the\n new `activeView` is ready to use. **Note:** this will override\n `options.callback` and it can be specified as either the third or fourth\n argument. The function will be passed the following:",

21409

"type": "Function",

21410

"optional": true,

21411

"props": [

21412

{

21413

"name": "view",

21414

"description": "A reference to the new `activeView`.",

21415

"type": "View"

21416

}

21417

]

21418

}

21419

],

21420

"chainable": 1,

21421

"since": "3.5.0",

21422

"class": "App.Transitions",

21423

"module": "app",

21424

"submodule": "app-transitions"

21425

},

21426

{

21427

"file": "app/js/app-extensions/app-transitions.js",

21428

"line": 220,

21429

"description": "Setter for `transitions` attribute.\n\nWhen specified as `true`, the defaults will be use as specified by the\n`transitions` prototype property.",

21430

"itemtype": "method",

21431

"name": "_setTransitions",

21432

"params": [

21433

{

21434

"name": "transitions",

21435

"description": "The new `transitions` attribute value.",

21436

"type": "Boolean|Object"

21437

}

21438

],

21439

"return": {

21440

"description": "The processed value which represents the new state.",

21441

"type": "Mixed"

21442

},

21443

"access": "protected",

21444

"tagname": "",

21445

"see": [

21446

"App.Base.showView()"

21447

],

21448

"since": "3.5.0",

21449

"class": "App.Transitions",

21450

"module": "app",

21451

"submodule": "app-transitions"

21452

},

21453

{

21454

"file": "app/js/view-extensions/view-node-map.js",

21455

"line": 35,

21456

"description": "Returns the nearest View instance associated with the given Node. The Node may\nbe a View container or any child of a View container.\n\nNote that only instances of Views that have the Y.View.NodeMap extension mixed\nin will be returned. The base View class doesn't provide this functionality by\ndefault due to the additional memory management overhead involved in maintaining\na mapping of Nodes to View instances.",

21457

"itemtype": "method",

21458

"name": "getByNode",

21459

"params": [

21460

{

21461

"name": "node",

21462

"description": "Node instance, selector string, or\n HTMLElement.",

21463

"type": "Node|HTMLElement|String"

21464

}

21465

],

21466

"return": {

21467

"description": "Closest View instance associated with the given Node, or `null`\n if no associated View instance was found.",

21468

"type": "View"

21469

},

21470

"since": "3.5.0",

21471

"class": "View.NodeMap",

21472

"module": "app",

21473

"submodule": "view-node-map"

21474

},

21475

{

21476

"file": "app/js/app-base.js",

21477

"line": 76,

21478

"description": "Hash of view-name to metadata used to declaratively describe an\napplication's views and their relationship with the app and its other views.\n\nThe view metadata is composed of Objects keyed to a view-name that can have\nany or all of the following properties:\n\n * `type`: Function or a string representing the view constructor to use to\n create view instances. If a string is used, the constructor function is\n assumed to be on the `Y` object; e.g. `\"SomeView\"` -> `Y.SomeView`.\n\n * `preserve`: Boolean for whether the view instance should be retained. By\n default, the view instance will be destroyed when it is no longer the\n `activeView`. If `true` the view instance will simply be `removed()`\n from the DOM when it is no longer active. This is useful when the view\n is frequently used and may be expensive to re-create.\n\n * `parent`: String to another named view in this hash that represents the\n parent view within the application's view hierarchy; e.g. a `\"photo\"`\n view could have `\"album\"` has its `parent` view. This parent/child\n relationship is a useful cue for things like transitions.\n\n * `instance`: Used internally to manage the current instance of this named\n view. This can be used if your view instance is created up-front, or if\n you would rather manage the View lifecycle, but you probably should just\n let this be handled for you.\n\nIf `views` are specified at instantiation time, the metadata in the `views`\nObject here will be used as defaults when creating the instance's `views`.\n\nEvery `Y.App` instance gets its own copy of a `views` object so this Object\non the prototype will not be polluted.",

21479

"example": [

21480

"\n // Imagine that `Y.UsersView` and `Y.UserView` have been defined.\n var app = new Y.App({\n views: {\n users: {\n type : Y.UsersView,\n preserve: true\n },\n\n user: {\n type : Y.UserView,\n parent: 'users'\n }\n }\n });"

21481

],

21482

"itemtype": "property",

21483

"name": "views",

21484

"type": "Object",

21485

"default": "{}",

21486

"since": "3.5.0",

21487

"class": "App.Base",

21488

"module": "app",

21489

"submodule": "app-base"

21490

},

21491

{

21492

"file": "app/js/app-base.js",

21493

"line": 134,

21494

"description": "Map of view instance id (via `Y.stamp()`) to view-info object in `views`.\n\nThis mapping is used to tie a specific view instance back to its metadata by\nadding a reference to the the related view info on the `views` object.",

21495

"itemtype": "property",

21496

"name": "_viewInfoMap",

21497

"type": "Object",

21498

"default": "{}",

21499

"access": "protected",

21500

"tagname": "",

21501

"since": "3.5.0",

21502

"class": "App.Base",

21503

"module": "app",

21504

"submodule": "app-base"

21505

},

21506

{

21507

"file": "app/js/app-base.js",

21508

"line": 185,

21509

"description": "Creates and returns a new view instance using the provided `name` to look up\nthe view info metadata defined in the `views` object. The passed-in `config`\nobject is passed to the view constructor function.\n\nThis function also maps a view instance back to its view info metadata.",

21510

"itemtype": "method",

21511

"name": "createView",

21512

"params": [

21513

{

21514

"name": "name",

21515

"description": "The name of a view defined on the `views` object.",

21516

"type": "String"

21517

},

21518

{

21519

"name": "config",

21520

"description": "The configuration object passed to the view\n constructor function when creating the new view instance.",

21521

"type": "Object",

21522

"optional": true

21523

}

21524

],

21525

"return": {

21526

"description": "The new view instance.",

21527

"type": "View"

21528

},

21529

"since": "3.5.0",

21530

"class": "App.Base",

21531

"module": "app",

21532

"submodule": "app-base"

21533

},

21534

{

21535

"file": "app/js/app-base.js",

21536

"line": 215,

21537

"description": "Returns the metadata associated with a view instance or view name defined on\nthe `views` object.",

21538

"itemtype": "method",

21539

"name": "getViewInfo",

21540

"params": [

21541

{

21542

"name": "view",

21543

"description": "View instance, or name of a view defined on the\n `views` object.",

21544

"type": "View|String"

21545

}

21546

],

21547

"return": {

21548

"description": "The metadata for the view, or `undefined` if the view is\n not registered.",

21549

"type": "Object"

21550

},

21551

"since": "3.5.0",

21552

"class": "App.Base",

21553

"module": "app",

21554

"submodule": "app-base"

21555

},

21556

{

21557

"file": "app/js/app-base.js",

21558

"line": 234,

21559

"description": "Navigates to the specified URL if there is a route handler that matches. In\nbrowsers capable of using HTML5 history or when `serverRouting` is falsy,\nthe navigation will be enhanced by firing the `navigate` event and having\nthe app handle the \"request\". When `serverRouting` is `true`, non-HTML5\nbrowsers will navigate to the new URL via a full page reload.\n\nWhen there is a route handler for the specified URL and it is being\nnavigated to, this method will return `true`, otherwise it will return\n`false`.\n\n**Note:** The specified URL _must_ be of the same origin as the current URL,\notherwise an error will be logged and navigation will not occur. This is\nintended as both a security constraint and a purposely imposed limitation as\nit does not make sense to tell the app to navigate to a URL on a\ndifferent scheme, host, or port.",

21560

"itemtype": "method",

21561

"name": "navigate",

21562

"params": [

21563

{

21564

"name": "url",

21565

"description": "The URL to navigate to. This must be of the same origin\n as the current URL.",

21566

"type": "String"

21567

},

21568

{

21569

"name": "options",

21570

"description": "Additional options to configure the navigation.\n These are mixed into the `navigate` event facade.",

21571

"type": "Object",

21572

"optional": true,

21573

"props": [

21574

{

21575

"name": "replace",

21576

"description": "Whether or not the current history\n entry will be replaced, or a new entry will be created. Will default\n to `true` if the specified `url` is the same as the current URL.",

21577

"type": "Boolean",

21578

"optional": true

21579

},

21580

{

21581

"name": "force",

21582

"description": "Whether the enhanced navigation\n should occur even in browsers without HTML5 history. Will default to\n `true` when `serverRouting` is falsy.",

21583

"type": "Boolean",

21584

"optional": true

21585

}

21586

]

21587

}

21588

],

21589

"see": [

21590

"PjaxBase.navigate()"

21591

],

21592

"class": "App.Base",

21593

"module": "app",

21594

"submodule": "app-base"

21595

},

21596

{

21597

"file": "app/js/app-base.js",

21598

"line": 266,

21599

"description": "Renders this application by appending the `viewContainer` node to the\n`container` node if it isn't already a child of the container, and the\n`activeView` will be appended the view container, if it isn't already.\n\nYou should call this method at least once, usually after the initialization\nof your app instance so the proper DOM structure is setup and optionally\nappend the container to the DOM if it's not there already.\n\nYou may override this method to customize the app's rendering, but you\nshould expect that the `viewContainer`'s contents will be modified by the\napp for the purpose of rendering the `activeView` when it changes.",

21600

"itemtype": "method",

21601

"name": "render",

21602

"chainable": 1,

21603

"see": [

21604

"View.render()"

21605

],

21606

"class": "App.Base",

21607

"module": "app",

21608

"submodule": "app-base"

21609

},

21610

{

21611

"file": "app/js/app-base.js",

21612

"line": 306,

21613

"description": "Sets which view is active/visible for the application. This will set the\napp's `activeView` attribute to the specified `view`.\n\nThe `view` will be \"attached\" to this app, meaning it will be both rendered\ninto this app's `viewContainer` node and all of its events will bubble to\nthe app. The previous `activeView` will be \"detached\" from this app.\n\nWhen a string-name is provided for a view which has been registered on this\napp's `views` object, the referenced metadata will be used and the\n`activeView` will be set to either a preserved view instance, or a new\ninstance of the registered view will be created using the specified `config`\nobject passed-into this method.\n\nA callback function can be specified as either the third or fourth argument,\nand this function will be called after the new `view` becomes the\n`activeView`, is rendered to the `viewContainer`, and is ready to use.",

21614

"example": [

21615

"\n var app = new Y.App({\n views: {\n usersView: {\n // Imagine that `Y.UsersView` has been defined.\n type: Y.UsersView\n }\n },\n\n users: new Y.ModelList()\n });\n\n app.route('/users/', function () {\n this.showView('usersView', {users: this.get('users')});\n });\n\n app.render();\n app.navigate('/uses/'); // => Creates a new `Y.UsersView` and shows it."

21616

],

21617

"itemtype": "method",

21618

"name": "showView",

21619

"params": [

21620

{

21621

"name": "view",

21622

"description": "The name of a view defined in the `views` object,\n or a view instance which should become this app's `activeView`.",

21623

"type": "String|View"

21624

},

21625

{

21626

"name": "config",

21627

"description": "Optional configuration to use when creating a new\n view instance. This config object can also be used to update an existing\n or preserved view's attributes when `options.update` is `true`.",

21628

"type": "Object",

21629

"optional": true

21630

},

21631

{

21632

"name": "options",

21633

"description": "Optional object containing any of the following\n properties:",

21634

"type": "Object",

21635

"optional": true,

21636

"props": [

21637

{

21638

"name": "callback",

21639

"description": "Optional callback function to call\n after new `activeView` is ready to use, the function will be passed:",

21640

"type": "Function",

21641

"optional": true,

21642

"props": [

21643

{

21644

"name": "view",

21645

"description": "A reference to the new\n `activeView`.",

21646

"type": "View"

21647

}

21648

]

21649

},

21650

{

21651

"name": "prepend",

21652

"description": "Whether the `view` should be\n prepended instead of appended to the `viewContainer`.",

21653

"type": "Boolean",

21654

"optional": true,

21655

"optdefault": "false"

21656

},

21657

{

21658

"name": "render",

21659

"description": "Whether the `view` should be rendered.\n **Note:** If no value is specified, a view instance will only be\n rendered if it's newly created by this method.",

21660

"type": "Boolean",

21661

"optional": true

21662

},

21663

{

21664

"name": "update",

21665

"description": "Whether an existing view should\n have its attributes updated by passing the `config` object to its\n `setAttrs()` method. **Note:** This option does not have an effect if\n the `view` instance is created as a result of calling this method.",

21666

"type": "Boolean",

21667

"optional": true,

21668

"optdefault": "false"

21669

}

21670

]

21671

},

21672

{

21673

"name": "callback",

21674

"description": "Optional callback Function to call after the\n new `activeView` is ready to use. **Note:** this will override\n `options.callback` and it can be specified as either the third or fourth\n argument. The function will be passed the following:",

21675

"type": "Function",

21676

"optional": true,

21677

"props": [

21678

{

21679

"name": "view",

21680

"description": "A reference to the new `activeView`.",

21681

"type": "View"

21682

}

21683

]

21684

}

21685

],

21686

"chainable": 1,

21687

"since": "3.5.0",

21688

"class": "App.Base",

21689

"module": "app",

21690

"submodule": "app-base"

21691

},

21692

{

21693

"file": "app/js/app-base.js",

21694

"line": 431,

21695

"description": "Helper method to attach the view instance to the application by making the\napp a bubble target of the view, append the view to the `viewContainer`, and\nassign it to the `instance` property of the associated view info metadata.",

21696

"itemtype": "method",

21697

"name": "_attachView",

21698

"params": [

21699

{

21700

"name": "view",

21701

"description": "View to attach.",

21702

"type": "View"

21703

},

21704

{

21705

"name": "prepend=false",

21706

"description": "Whether the view should be prepended instead\n of appended to the `viewContainer`.",

21707

"type": "Boolean"

21708

}

21709

],

21710

"access": "protected",

21711

"tagname": "",

21712

"since": "3.5.0",

21713

"class": "App.Base",

21714

"module": "app",

21715

"submodule": "app-base"

21716

},

21717

{

21718

"file": "app/js/app-base.js",

21719

"line": 464,

21720

"description": "Overrides View's container destruction to deal with the `viewContainer` and\nchecks to make sure not to remove and purge the `<body>`.",

21721

"itemtype": "method",

21722

"name": "_destroyContainer",

21723

"access": "protected",

21724

"tagname": "",

21725

"see": [

21726

"View._destroyContainer()"

21727

],

21728

"class": "App.Base",

21729

"module": "app",

21730

"submodule": "app-base"

21731

},

21732

{

21733

"file": "app/js/app-base.js",

21734

"line": 501,

21735

"description": "Helper method to detach the view instance from the application by removing\nthe application as a bubble target of the view, and either just removing the\nview if it is intended to be preserved, or destroying the instance\ncompletely.",

21736

"itemtype": "method",

21737

"name": "_detachView",

21738

"params": [

21739

{

21740

"name": "view",

21741

"description": "View to detach.",

21742

"type": "View"

21743

}

21744

],

21745

"access": "protected",

21746

"tagname": "",

21747

"since": "3.5.0",

21748

"class": "App.Base",

21749

"module": "app",

21750

"submodule": "app-base"

21751

},

21752

{

21753

"file": "app/js/app-base.js",

21754

"line": 542,

21755

"description": "Getter for the `viewContainer` attribute.",

21756

"itemtype": "method",

21757

"name": "_getViewContainer",

21758

"params": [

21759

{

21760

"name": "value",

21761

"description": "Current attribute value.",

21762

"type": "Node|null"

21763

}

21764

],

21765

"return": {

21766

"description": "View container node.",

21767

"type": "Node"

21768

},

21769

"access": "protected",

21770

"tagname": "",

21771

"since": "3.5.0",

21772

"class": "App.Base",

21773

"module": "app",

21774

"submodule": "app-base"

21775

},

21776

{

21777

"file": "app/js/app-base.js",

21778

"line": 567,

21779

"description": "Gets the current full URL. When `html5` is false, the URL will first be\nupgraded before it's returned.",

21780

"itemtype": "method",

21781

"name": "_getURL",

21782

"return": {

21783

"description": "URL.",

21784

"type": "String"

21785

},

21786

"access": "protected",

21787

"tagname": "",

21788

"see": [

21789

"Router._getURL()"

21790

],

21791

"class": "App.Base",

21792

"module": "app",

21793

"submodule": "app-base"

21794

},

21795

{

21796

"file": "app/js/app-base.js",

21797

"line": 581,

21798

"description": "Provides the default value for the `html5` attribute.\n\nThe value returned is dependent on the value of the `serverRouting`\nattribute. When `serverRouting` is explicit set to `false` (not just falsy),\nthe default value for `html5` will be set to `false` for *all* browsers.\n\nWhen `serverRouting` is `true` or `undefined` the returned value will be\ndependent on the browser's capability of using HTML5 history.",

21799

"itemtype": "method",

21800

"name": "_initHtml5",

21801

"return": {

21802

"description": "Whether or not HTML5 history should be used.",

21803

"type": "Boolean"

21804

},

21805

"access": "protected",

21806

"tagname": "",

21807

"since": "3.5.0",

21808

"class": "App.Base",

21809

"module": "app",

21810

"submodule": "app-base"

21811

},

21812

{

21813

"file": "app/js/app-base.js",

21814

"line": 606,

21815

"description": "Determines if the specified `view` is configured as a child of the specified\n`parent` view. This requires both views to be either named-views, or view\ninstances created using configuration data that exists in the `views`\nobject, e.g. created by the `createView()` or `showView()` method.",

21816

"itemtype": "method",

21817

"name": "_isChildView",

21818

"params": [

21819

{

21820

"name": "view",

21821

"description": "The name of a view defined in the `views` object,\n or a view instance.",

21822

"type": "View|String"

21823

},

21824

{

21825

"name": "parent",

21826

"description": "The name of a view defined in the `views`\n object, or a view instance.",

21827

"type": "View|String"

21828

}

21829

],

21830

"return": {

21831

"description": "Whether the view is configured as a child of the parent.",

21832

"type": "Boolean"

21833

},

21834

"access": "protected",

21835

"tagname": "",

21836

"since": "3.5.0",

21837

"class": "App.Base",

21838

"module": "app",

21839

"submodule": "app-base"

21840

},

21841

{

21842

"file": "app/js/app-base.js",

21843

"line": 632,

21844

"description": "Determines if the specified `view` is configured as the parent of the\nspecified `child` view. This requires both views to be either named-views,\nor view instances created using configuration data that exists in the\n`views` object, e.g. created by the `createView()` or `showView()` method.",

21845

"itemtype": "method",

21846

"name": "_isParentView",

21847

"params": [

21848

{

21849

"name": "view",

21850

"description": "The name of a view defined in the `views` object,\n or a view instance.",

21851

"type": "View|String"

21852

},

21853

{

21854

"name": "parent",

21855

"description": "The name of a view defined in the `views`\n object, or a view instance.",

21856

"type": "View|String"

21857

}

21858

],

21859

"return": {

21860

"description": "Whether the view is configured as the parent of the child.",

21861

"type": "Boolean"

21862

},

21863

"access": "protected",

21864

"tagname": "",

21865

"since": "3.5.0",

21866

"class": "App.Base",

21867

"module": "app",

21868

"submodule": "app-base"

21869

},

21870

{

21871

"file": "app/js/app-base.js",

21872

"line": 658,

21873

"description": "Underlying implementation for `navigate()`.",

21874

"itemtype": "method",

21875

"name": "_navigate",

21876

"params": [

21877

{

21878

"name": "url",

21879

"description": "The fully-resolved URL that the app should dispatch to\n its route handlers to fulfill the enhanced navigation \"request\", or use to\n update `window.location` in non-HTML5 history capable browsers when\n `serverRouting` is `true`.",

21880

"type": "String"

21881

},

21882

{

21883

"name": "options",

21884

"description": "Additional options to configure the navigation.\n These are mixed into the `navigate` event facade.",

21885

"type": "Object",

21886

"optional": true,

21887

"props": [

21888

{

21889

"name": "replace",

21890

"description": "Whether or not the current history\n entry will be replaced, or a new entry will be created. Will default\n to `true` if the specified `url` is the same as the current URL.",

21891

"type": "Boolean",

21892

"optional": true

21893

},

21894

{

21895

"name": "force",

21896

"description": "Whether the enhanced navigation\n should occur even in browsers without HTML5 history. Will default to\n `true` when `serverRouting` is falsy.",

21897

"type": "Boolean",

21898

"optional": true

21899

}

21900

]

21901

}

21902

],

21903

"access": "protected",

21904

"tagname": "",

21905

"see": [

21906

"PjaxBase._navigate()"

21907

],

21908

"class": "App.Base",

21909

"module": "app",

21910

"submodule": "app-base"

21911

},

21912

{

21913

"file": "app/js/app-base.js",

21914

"line": 692,

21915

"description": "Will either save a history entry using `pushState()` or the location hash,\nor gracefully-degrade to sending a request to the server causing a full-page\nreload.\n\nOverrides Router's `_save()` method to preform graceful-degradation when the\napp's `serverRouting` is `true` and `html5` is `false` by updating the full\nURL via standard assignment to `window.location` or by calling\n`window.location.replace()`; both of which will cause a request to the\nserver resulting in a full-page reload.\n\nOtherwise this will just delegate off to Router's `_save()` method allowing\nthe client-side enhanced routing to occur.",

21916

"itemtype": "method",

21917

"name": "_save",

21918

"params": [

21919

{

21920

"name": "url",

21921

"description": "URL for the history entry.",

21922

"type": "String",

21923

"optional": true

21924

},

21925

{

21926

"name": "replace",

21927

"description": "If `true`, the current history entry will\n be replaced instead of a new one being added.",

21928

"type": "Boolean",

21929

"optional": true,

21930

"optdefault": "false"

21931

}

21932

],

21933

"chainable": 1,

21934

"access": "protected",

21935

"tagname": "",

21936

"see": [

21937

"Router._save()"

21938

],

21939

"class": "App.Base",

21940

"module": "app",

21941

"submodule": "app-base"

21942

},

21943

{

21944

"file": "app/js/app-base.js",

21945

"line": 741,

21946

"description": "Performs the actual change of this app's `activeView` by attaching the\n`newView` to this app, and detaching the `oldView` from this app using any\nspecified `options`.\n\nThe `newView` is attached to the app by rendering it to the `viewContainer`,\nand making this app a bubble target of its events.\n\nThe `oldView` is detached from the app by removing it from the\n`viewContainer`, and removing this app as a bubble target for its events.\nThe `oldView` will either be preserved or properly destroyed.\n\n**Note:** The `activeView` attribute is read-only and can be changed by\ncalling the `showView()` method.",

21947

"itemtype": "method",

21948

"name": "_uiSetActiveView",

21949

"params": [

21950

{

21951

"name": "newView",

21952

"description": "The View which is now this app's `activeView`.",

21953

"type": "View"

21954

},

21955

{

21956

"name": "oldView",

21957

"description": "The View which was this app's `activeView`.",

21958

"type": "View",

21959

"optional": true

21960

},

21961

{

21962

"name": "options",

21963

"description": "Optional object containing any of the following\n properties:",

21964

"type": "Object",

21965

"optional": true,

21966

"props": [

21967

{

21968

"name": "callback",

21969

"description": "Optional callback function to call\n after new `activeView` is ready to use, the function will be passed:",

21970

"type": "Function",

21971

"optional": true,

21972

"props": [

21973

{

21974

"name": "view",

21975

"description": "A reference to the new\n `activeView`.",

21976

"type": "View"

21977

}

21978

]

21979

},

21980

{

21981

"name": "prepend",

21982

"description": "Whether the `view` should be\n prepended instead of appended to the `viewContainer`.",

21983

"type": "Boolean",

21984

"optional": true,

21985

"optdefault": "false"

21986

},

21987

{

21988

"name": "render",

21989

"description": "Whether the `view` should be rendered.\n **Note:** If no value is specified, a view instance will only be\n rendered if it's newly created by this method.",

21990

"type": "Boolean",

21991

"optional": true

21992

},

21993

{

21994

"name": "update",

21995

"description": "Whether an existing view should\n have its attributes updated by passing the `config` object to its\n `setAttrs()` method. **Note:** This option does not have an effect if\n the `view` instance is created as a result of calling this method.",

21996

"type": "Boolean",

21997

"optional": true,

21998

"optdefault": "false"

21999

}

22000

]

22001

}

22002

],

22003

"access": "protected",

22004

"tagname": "",

22005

"since": "3.5.0",

22006

"class": "App.Base",

22007

"module": "app",

22008

"submodule": "app-base"

22009

},

22010

{

22011

"file": "app/js/app-base.js",

22012

"line": 797,

22013

"description": "Upgrades a hash-based URL to a full-path URL, if necessary.\n\nThe specified `url` will be upgraded if its of the same origin as the\ncurrent URL and has a path-like hash. URLs that don't need upgrading will be\nreturned as-is.",

22014

"example": [

22015

"\n app._upgradeURL('http://example.com/#/foo/'); // => 'http://example.com/foo/';"

22016

],

22017

"itemtype": "method",

22018

"name": "_upgradeURL",

22019

"params": [

22020

{

22021

"name": "url",

22022

"description": "The URL to upgrade from hash-based to full-path.",

22023

"type": "String"

22024

}

22025

],

22026

"return": {

22027

"description": "The upgraded URL, or the specified URL untouched.",

22028

"type": "String"

22029

},

22030

"access": "protected",

22031

"tagname": "",

22032

"since": "3.5.0",

22033

"class": "App.Base",

22034

"module": "app",

22035

"submodule": "app-base"

22036

},

22037

{

22038

"file": "app/js/app-base.js",

22039

"line": 840,

22040

"description": "Handles the application's `activeViewChange` event (which is fired when the\n`activeView` attribute changes) by detaching the old view, attaching the new\nview.\n\nThe `activeView` attribute is read-only, so the public API to change its\nvalue is through the `showView()` method.",

22041

"itemtype": "method",

22042

"name": "_afterActiveViewChange",

22043

"params": [

22044

{

22045

"name": "e",

22046

"description": "",

22047

"type": "EventFacade"

22048

}

22049

],

22050

"access": "protected",

22051

"tagname": "",

22052

"since": "3.5.0",

22053

"class": "App.Base",

22054

"module": "app",

22055

"submodule": "app-base"

22056

},

22057

{

22058

"file": "app/js/app-base.js",

22059

"line": 858,

22060

"description": "The application's active/visible view.\n\nThis attribute is read-only, to set the `activeView` use the\n`showView()` method.",

22061

"itemtype": "attribute",

22062

"name": "activeView",

22063

"type": "View",

22064

"default": "null",

22065

"readonly": "",

22066

"see": [

22067

"App.Base.showView()"

22068

],

22069

"since": "3.5.0",

22070

"class": "App.Base",

22071

"module": "app",

22072

"submodule": "app-base"

22073

},

22074

{

22075

"file": "app/js/app-base.js",

22076

"line": 876,

22077

"description": "Container node which represents the application's bounding-box, into\nwhich this app's content will be rendered.\n\nThe container node serves as the host for all DOM events attached by the\napp. Delegation is used to handle events on children of the container,\nallowing the container's contents to be re-rendered at any time without\nlosing event subscriptions.\n\nThe default container is the `<body>` Node, but you can override this in\na subclass, or by passing in a custom `container` config value at\ninstantiation time.\n\nWhen `container` is overridden by a subclass or passed as a config\noption at instantiation time, it may be provided as a selector string, a\nDOM element, or a `Y.Node` instance. During initialization, this app's\n`create()` method will be called to convert the container into a\n`Y.Node` instance if it isn't one already and stamp it with the CSS\nclass: `\"yui3-app\"`.\n\nThe container is not added to the page automatically. This allows you to\nhave full control over how and when your app is actually rendered to\nthe page.",

22078

"itemtype": "attribute",

22079

"name": "container",

22080

"type": "HTMLElement|Node|String",

22081

"default": "Y.one('body')",

22082

"initonly": "",

22083

"class": "App.Base",

22084

"module": "app",

22085

"submodule": "app-base"

22086

},

22087

{

22088

"file": "app/js/app-base.js",

22089

"line": 911,

22090

"description": "Whether or not this browser is capable of using HTML5 history.\n\nThis value is dependent on the value of `serverRouting` and will default\naccordingly.\n\nSetting this to `false` will force the use of hash-based history even on\nHTML5 browsers, but please don't do this unless you understand the\nconsequences.",

22091

"itemtype": "attribute",

22092

"name": "html5",

22093

"type": "Boolean",

22094

"initonly": "",

22095

"see": [

22096

"serverRouting"

22097

],

22098

"class": "App.Base",

22099

"module": "app",

22100

"submodule": "app-base"

22101

},

22102

{

22103

"file": "app/js/app-base.js",

22104

"line": 930,

22105

"description": "CSS selector string used to filter link click events so that only the\nlinks which match it will have the enhanced-navigation behavior of pjax\napplied.\n\nWhen a link is clicked and that link matches this selector, navigating\nto the link's `href` URL using the enhanced, pjax, behavior will be\nattempted; and the browser's default way to navigate to new pages will\nbe the fallback.\n\nBy default this selector will match _all_ links on the page.",

22106

"itemtype": "attribute",

22107

"name": "linkSelector",

22108

"type": "String|Function",

22109

"default": "\"a\"",

22110

"class": "App.Base",

22111

"module": "app",

22112

"submodule": "app-base"

22113

},

22114

{

22115

"file": "app/js/app-base.js",

22116

"line": 950,

22117

"description": "Whether or not this application's server is capable of properly routing\nall requests and rendering the initial state in the HTML responses.\n\nThis can have three different values, each having particular\nimplications on how the app will handle routing and navigation:\n\n * `undefined`: The best form of URLs will be chosen based on the\n capabilities of the browser. Given no information about the server\n environmentm a balanced approach to routing and navigation is\n chosen.\n\n The server should be capable of handling full-path requests, since\n full-URLs will be generated by browsers using HTML5 history. If this\n is a client-side-only app the server could handle full-URL requests\n by sending a redirect back to the root with a hash-based URL, e.g:\n\n Request: http://example.com/users/1\n Redirect to: http://example.com/#/users/1\n\n * `true`: The server is *fully* capable of properly handling requests\n to all full-path URLs the app can produce.\n\n This is the best option for progressive-enhancement because it will\n cause **all URLs to always have full-paths**, which means the server\n will be able to accurately handle all URLs this app produces. e.g.\n\n http://example.com/users/1\n\n To meet this strict full-URL requirement, browsers which are not\n capable of using HTML5 history will make requests to the server\n resulting in full-page reloads.\n\n * `false`: The server is *not* capable of properly handling requests\n to all full-path URLs the app can produce, therefore all routing\n will be handled by this App instance.\n\n Be aware that this will cause **all URLs to always be hash-based**,\n even in browsers that are capable of using HTML5 history. e.g.\n\n http://example.com/#/users/1\n\n A single-page or client-side-only app where the server sends a\n \"shell\" page with JavaScript to the client might have this\n restriction. If you're setting this to `false`, read the following:\n\n**Note:** When this is set to `false`, the server will *never* receive\nthe full URL because browsers do not send the fragment-part to the\nserver, that is everything after and including the \"#\".\n\nConsider the following example:\n\n URL shown in browser: http://example.com/#/users/1\n URL sent to server: http://example.com/\n\nYou should feel bad about hurting our precious web if you forcefully set\neither `serverRouting` or `html5` to `false`, because you're basically\npunching the web in the face here with your lossy URLs! Please make sure\nyou know what you're doing and that you understand the implications.\n\nIdeally you should always prefer full-path URLs (not /#/foo/), and want\nfull-page reloads when the client's browser is not capable of enhancing\nthe experience using the HTML5 history APIs. Setting this to `true` is\nthe best option for progressive-enhancement (and graceful-degradation).",

22118

"itemtype": "attribute",

22119

"name": "serverRouting",

22120

"type": "Boolean",

22121

"default": "undefined",

22122

"initonly": "",

22123

"since": "3.5.0",

22124

"class": "App.Base",

22125

"module": "app",

22126

"submodule": "app-base"

22127

},

22128

{

22129

"file": "app/js/app-base.js",

22130

"line": 1026,

22131

"description": "The node into which this app's `views` will be rendered when they become\nthe `activeView`.\n\nThe view container node serves as the container to hold the app's\n`activeView`. Each time the `activeView` is set via `showView()`, the\nprevious view will be removed from this node, and the new active view's\n`container` node will be appended.\n\nThe default view container is a `<div>` Node, but you can override this\nin a subclass, or by passing in a custom `viewContainer` config value at\ninstantiation time. The `viewContainer` may be provided as a selector\nstring, DOM element, or a `Y.Node` instance (having the `viewContainer`\nand the `container` be the same node is also supported).\n\nThe app's `render()` method will stamp the view container with the CSS\nclass `\"yui3-app-views\"` and append it to the app's `container` node if\nit isn't already, and any `activeView` will be appended to this node if\nit isn't already.",

22132

"itemtype": "attribute",

22133

"name": "viewContainer",

22134

"type": "HTMLElement|Node|String",

22135

"default": "Y.Node.create(this.containerTemplate)",

22136

"initonly": "",

22137

"since": "3.5.0",

22138

"class": "App.Base",

22139

"module": "app",

22140

"submodule": "app-base"

22141

},

22142

{

22143

"file": "app/js/app-base.js",

22144

"line": 1062,

22145

"description": "CSS class added to an app's `container` node.",

22146

"itemtype": "property",

22147

"name": "CSS_CLASS",

22148

"type": "String",

22149

"default": "\"yui3-app\"",

22150

"static": 1,

22151

"since": "3.5.0",

22152

"class": "App.Base",

22153

"module": "app",

22154

"submodule": "app-base"

22155

},

22156

{

22157

"file": "app/js/app-base.js",

22158

"line": 1073,

22159

"description": "CSS class added to an app's `viewContainer` node.",

22160

"itemtype": "property",

22161

"name": "VIEWS_CSS_CLASS",

22162

"type": "String",

22163

"default": "\"yui3-app-views\"",

22164

"static": 1,

22165

"since": "3.5.0",

22166

"class": "App.Base",

22167

"module": "app",

22168

"submodule": "app-base"

22169

},

22170

{

22171

"file": "app/js/app-base.js",

22172

"line": 1084,

22173

"description": "Properties that shouldn't be turned into ad-hoc attributes when passed to\nApp's constructor.",

22174

"itemtype": "property",

22175

"name": "_NON_ATTRS_CFG",

22176

"type": "Array",

22177

"static": 1,

22178

"access": "protected",

22179

"tagname": "",

22180

"since": "3.5.0",

22181

"class": "App.Base",

22182

"module": "app",

22183

"submodule": "app-base"

22184

},

22185

{

22186

"file": "app/js/model-list.js",

22187

"line": 33,

22188

"description": "Fired when a model is added to the list.\n\nListen to the `on` phase of this event to be notified before a model is\nadded to the list. Calling `e.preventDefault()` during the `on` phase will\nprevent the model from being added.\n\nListen to the `after` phase of this event to be notified after a model has\nbeen added to the list.",

22189

"itemtype": "event",

22190

"name": "add",

22191

"params": [

22192

{

22193

"name": "model",

22194

"description": "The model being added.",

22195

"type": "Model"

22196

},

22197

{

22198

"name": "index",

22199

"description": "The index at which the model will be added.",

22200

"type": "Number"

22201

}

22202

],

22203

"preventable": "_defAddFn",

22204

"class": "ModelList",

22205

"module": "app",

22206

"submodule": "model-list"

22207

},

22208

{

22209

"file": "app/js/model-list.js",

22210

"line": 50,

22211

"description": "Fired when a model is created or updated via the `create()` method, but\nbefore the model is actually saved or added to the list. The `add` event\nwill be fired after the model has been saved and added to the list.",

22212

"itemtype": "event",

22213

"name": "create",

22214

"params": [

22215

{

22216

"name": "model",

22217

"description": "The model being created/updated.",

22218

"type": "Model"

22219

}

22220

],

22221

"since": "3.5.0",

22222

"class": "ModelList",

22223

"module": "app",

22224

"submodule": "model-list"

22225

},

22226

{

22227

"file": "app/js/model-list.js",

22228

"line": 61,

22229

"description": "Fired when an error occurs, such as when an attempt is made to add a\nduplicate model to the list, or when a sync layer response can't be parsed.",

22230

"itemtype": "event",

22231

"name": "error",

22232

"params": [

22233

{

22234

"name": "error",

22235

"description": "Error message, object, or exception generated by the\n error. Calling `toString()` on this should result in a meaningful error\n message.",

22236

"type": "Any"

22237

},

22238

{

22239

"name": "src",

22240

"description": "Source of the error. May be one of the following (or any\n custom error source defined by a ModelList subclass):\n\n * `add`: Error while adding a model (probably because it's already in the\n list and can't be added again). The model in question will be provided\n as the `model` property on the event facade.\n * `parse`: An error parsing a JSON response. The response in question will\n be provided as the `response` property on the event facade.\n * `remove`: Error while removing a model (probably because it isn't in the\n list and can't be removed). The model in question will be provided as\n the `model` property on the event facade.",

22241

"type": "String"

22242

}

22243

],

22244

"class": "ModelList",

22245

"module": "app",

22246

"submodule": "model-list"

22247

},

22248

{

22249

"file": "app/js/model-list.js",

22250

"line": 83,

22251

"description": "Fired after models are loaded from a sync layer.",

22252

"itemtype": "event",

22253

"name": "load",

22254

"params": [

22255

{

22256

"name": "parsed",

22257

"description": "The parsed version of the sync layer's response to\n the load request.",

22258

"type": "Object"

22259

},

22260

{

22261

"name": "response",

22262

"description": "The sync layer's raw, unparsed response to the load\n request.",

22263

"type": "Mixed"

22264

}

22265

],

22266

"since": "3.5.0",

22267

"class": "ModelList",

22268

"module": "app",

22269

"submodule": "model-list"

22270

},

22271

{

22272

"file": "app/js/model-list.js",

22273

"line": 95,

22274

"description": "Fired when a model is removed from the list.\n\nListen to the `on` phase of this event to be notified before a model is\nremoved from the list. Calling `e.preventDefault()` during the `on` phase\nwill prevent the model from being removed.\n\nListen to the `after` phase of this event to be notified after a model has\nbeen removed from the list.",

22275

"itemtype": "event",

22276

"name": "remove",

22277

"params": [

22278

{

22279

"name": "model",

22280

"description": "The model being removed.",

22281

"type": "Model"

22282

},

22283

{

22284

"name": "index",

22285

"description": "The index of the model being removed.",

22286

"type": "Number"

22287

}

22288

],

22289

"preventable": "_defRemoveFn",

22290

"class": "ModelList",

22291

"module": "app",

22292

"submodule": "model-list"

22293

},

22294

{

22295

"file": "app/js/model-list.js",

22296

"line": 112,

22297

"description": "Fired when the list is completely reset via the `reset()` method or sorted\nvia the `sort()` method.\n\nListen to the `on` phase of this event to be notified before the list is\nreset. Calling `e.preventDefault()` during the `on` phase will prevent\nthe list from being reset.\n\nListen to the `after` phase of this event to be notified after the list has\nbeen reset.",

22298

"itemtype": "event",

22299

"name": "reset",

22300

"params": [

22301

{

22302

"name": "models",

22303

"description": "Array of the list's new models after the reset.",

22304

"type": "Model[]"

22305

},

22306

{

22307

"name": "src",

22308

"description": "Source of the event. May be either `'reset'` or\n `'sort'`.",

22309

"type": "String"

22310

}

22311

],

22312

"preventable": "_defResetFn",

22313

"class": "ModelList",

22314

"module": "app",

22315

"submodule": "model-list"

22316

},

22317

{

22318

"file": "app/js/model-list.js",

22319

"line": 138,

22320

"description": "The `Model` class or subclass of the models in this list.\n\nThe class specified here will be used to create model instances\nautomatically based on attribute hashes passed to the `add()`, `create()`,\nand `reset()` methods.\n\nYou may specify the class as an actual class reference or as a string that\nresolves to a class reference at runtime (the latter can be useful if the\nspecified class will be loaded lazily).",

22321

"itemtype": "property",

22322

"name": "model",

22323

"type": "Model|String",

22324

"default": "Y.Model",

22325

"class": "ModelList",

22326

"module": "app",

22327

"submodule": "model-list"

22328

},

22329

{

22330

"file": "app/js/model-list.js",

22331

"line": 157,

22332

"description": "Total hack to allow us to identify ModelList instances without using\n`instanceof`, which won't work when the instance was created in another\nwindow or YUI sandbox.",

22333

"itemtype": "property",

22334

"name": "_isYUIModelList",

22335

"type": "Boolean",

22336

"default": "true",

22337

"access": "protected",

22338

"tagname": "",

22339

"since": "3.5.0",

22340

"class": "ModelList",

22341

"module": "app",

22342

"submodule": "model-list"

22343

},

22344

{

22345

"file": "app/js/model-list.js",

22346

"line": 200,

22347

"description": "Adds the specified model or array of models to this list. You may also pass\nanother ModelList instance, in which case all the models in that list will\nbe added to this one as well.",

22348

"example": [

22349

"\n\n // Add a single model instance.\n list.add(new Model({foo: 'bar'}));\n\n // Add a single model, creating a new instance automatically.\n list.add({foo: 'bar'});\n\n // Add multiple models, creating new instances automatically.\n list.add([\n {foo: 'bar'},\n {baz: 'quux'}\n ]);\n\n // Add all the models in another ModelList instance.\n list.add(otherList);"

22350

],

22351

"itemtype": "method",

22352

"name": "add",

22353

"params": [

22354

{

22355

"name": "models",

22356

"description": "Model or array of\n models to add. May be existing model instances or hashes of model\n attributes, in which case new model instances will be created from the\n hashes. You may also pass a ModelList instance to add all the models it\n contains.",

22357

"type": "Model|Model[]|ModelList|Object|Object[]"

22358

},

22359

{

22360

"name": "options",

22361

"description": "Data to be mixed into the event facade of the\n `add` event(s) for the added models.",

22362

"type": "Object",

22363

"optional": true,

22364

"props": [

22365

{

22366

"name": "silent",

22367

"description": "If `true`, no `add` event(s)\n will be fired.",

22368

"type": "Boolean",

22369

"optional": true,

22370

"optdefault": "false"

22371

}

22372

]

22373

}

22374

],

22375

"return": {

22376

"description": "Added model or array of added models.",

22377

"type": "Model|Model[]"

22378

},

22379

"class": "ModelList",

22380

"module": "app",

22381

"submodule": "model-list"

22382

},

22383

{

22384

"file": "app/js/model-list.js",

22385

"line": 248,

22386

"description": "Define this method to provide a function that takes a model as a parameter\nand returns a value by which that model should be sorted relative to other\nmodels in this list.\n\nBy default, no comparator is defined, meaning that models will not be sorted\n(they'll be stored in the order they're added).",

22387

"example": [

22388

"\n var list = new Y.ModelList({model: Y.Model});\n\n list.comparator = function (model) {\n return model.get('id'); // Sort models by id.\n };"

22389

],

22390

"itemtype": "method",

22391

"name": "comparator",

22392

"params": [

22393

{

22394

"name": "model",

22395

"description": "Model being sorted.",

22396

"type": "Model"

22397

}

22398

],

22399

"return": {

22400

"description": "Value by which the model should be sorted relative\n to other models in this list.",

22401

"type": "Number|String"

22402

},

22403

"class": "ModelList",

22404

"module": "app",

22405

"submodule": "model-list"

22406

},

22407

{

22408

"file": "app/js/model-list.js",

22409

"line": 271,

22410

"description": "Creates or updates the specified model on the server, then adds it to this\nlist if the server indicates success.",

22411

"itemtype": "method",

22412

"name": "create",

22413

"params": [

22414

{

22415

"name": "model",

22416

"description": "Model to create. May be an existing model\n instance or a hash of model attributes, in which case a new model instance\n will be created from the hash.",

22417

"type": "Model|Object"

22418

},

22419

{

22420

"name": "options",

22421

"description": "Options to be passed to the model's `sync()` and\n `set()` methods and mixed into the `create` and `add` event facades.",

22422

"type": "Object",

22423

"optional": true,

22424

"props": [

22425

{

22426

"name": "silent",

22427

"description": "If `true`, no `add` event(s) will\n be fired.",

22428

"type": "Boolean",

22429

"optional": true,

22430

"optdefault": "false"

22431

}

22432

]

22433

},

22434

{

22435

"name": "callback",

22436

"description": "Called when the sync operation finishes.",

22437

"type": "Function",

22438

"optional": true,

22439

"props": [

22440

{

22441

"name": "err",

22442

"description": "If an error occurred, this parameter will\n contain the error. If the sync operation succeeded, _err_ will be\n falsy.",

22443

"type": "Error"

22444

},

22445

{

22446

"name": "response",

22447

"description": "The server's response.",

22448

"type": "Any"

22449

}

22450

]

22451

}

22452

],

22453

"return": {

22454

"description": "Created model.",

22455

"type": "Model"

22456

},

22457

"class": "ModelList",

22458

"module": "app",

22459

"submodule": "model-list"

22460

},

22461

{

22462

"file": "app/js/model-list.js",

22463

"line": 318,

22464

"description": "Executes the supplied function on each model in this list. Returns an array\ncontaining the models for which the supplied function returned a truthy\nvalue.\n\nThe callback function's `this` object will refer to this ModelList. Use\n`Y.bind()` to bind the `this` object to another object if desired.",

22465

"example": [

22466

"\n\n // Get an array containing only the models whose \"enabled\" attribute is\n // truthy.\n var filtered = list.filter(function (model) {\n return model.get('enabled');\n });\n\n // Get a new ModelList containing only the models whose \"enabled\"\n // attribute is truthy.\n var filteredList = list.filter({asList: true}, function (model) {\n return model.get('enabled');\n });"

22467

],

22468

"itemtype": "method",

22469

"name": "filter",

22470

"params": [

22471

{

22472

"name": "options",

22473

"description": "Filter options.",

22474

"type": "Object",

22475

"optional": true,

22476

"props": [

22477

{

22478

"name": "asList",

22479

"description": "If truthy, results will be\n returned as a new ModelList instance rather than as an array.",

22480

"type": "Boolean",

22481

"optional": true,

22482

"optdefault": "false"

22483

}

22484

]

22485

},

22486

{

22487

"name": "callback",

22488

"description": "Function to execute on each model.",

22489

"type": "Function",

22490

"props": [

22491

{

22492

"name": "model",

22493

"description": "Model instance.",

22494

"type": "Model"

22495

},

22496

{

22497

"name": "index",

22498

"description": "Index of the current model.",

22499

"type": "Number"

22500

},

22501

{

22502

"name": "list",

22503

"description": "The ModelList being filtered.",

22504

"type": "ModelList"

22505

}

22506

]

22507

}

22508

],

22509

"return": {

22510

"description": "Array of models for which the callback function\n returned a truthy value (empty if it never returned a truthy value). If\n the `options.asList` option is truthy, a new ModelList instance will be\n returned instead of an array.",

22511

"type": "Array|ModelList"

22512

},

22513

"since": "3.5.0",

22514

"class": "ModelList",

22515

"module": "app",

22516

"submodule": "model-list"

22517

},

22518

{

22519

"file": "app/js/model-list.js",

22520

"line": 384,

22521

"description": "If _name_ refers to an attribute on this ModelList instance, returns the\nvalue of that attribute. Otherwise, returns an array containing the values\nof the specified attribute from each model in this list.",

22522

"itemtype": "method",

22523

"name": "get",

22524

"params": [

22525

{

22526

"name": "name",

22527

"description": "Attribute name or object property path.",

22528

"type": "String"

22529

}

22530

],

22531

"return": {

22532

"description": "Attribute value or array of attribute values.",

22533

"type": "Any|Array"

22534

},

22535

"see": [

22536

"Model.get()"

22537

],

22538

"class": "ModelList",

22539

"module": "app",

22540

"submodule": "model-list"

22541

},

22542

{

22543

"file": "app/js/model-list.js",

22544

"line": 402,

22545

"description": "If _name_ refers to an attribute on this ModelList instance, returns the\nHTML-escaped value of that attribute. Otherwise, returns an array containing\nthe HTML-escaped values of the specified attribute from each model in this\nlist.\n\nThe values are escaped using `Escape.html()`.",

22546

"itemtype": "method",

22547

"name": "getAsHTML",

22548

"params": [

22549

{

22550

"name": "name",

22551

"description": "Attribute name or object property path.",

22552

"type": "String"

22553

}

22554

],

22555

"return": {

22556

"description": "HTML-escaped value or array of HTML-escaped\n values.",

22557

"type": "String|String[]"

22558

},

22559

"see": [

22560

"Model.getAsHTML()"

22561

],

22562

"class": "ModelList",

22563

"module": "app",

22564

"submodule": "model-list"

22565

},

22566

{

22567

"file": "app/js/model-list.js",

22568

"line": 424,

22569

"description": "If _name_ refers to an attribute on this ModelList instance, returns the\nURL-encoded value of that attribute. Otherwise, returns an array containing\nthe URL-encoded values of the specified attribute from each model in this\nlist.\n\nThe values are encoded using the native `encodeURIComponent()` function.",

22570

"itemtype": "method",

22571

"name": "getAsURL",

22572

"params": [

22573

{

22574

"name": "name",

22575

"description": "Attribute name or object property path.",

22576

"type": "String"

22577

}

22578

],

22579

"return": {

22580

"description": "URL-encoded value or array of URL-encoded values.",

22581

"type": "String|String[]"

22582

},

22583

"see": [

22584

"Model.getAsURL()"

22585

],

22586

"class": "ModelList",

22587

"module": "app",

22588

"submodule": "model-list"

22589

},

22590

{

22591

"file": "app/js/model-list.js",

22592

"line": 445,

22593

"description": "Returns the model with the specified _clientId_, or `null` if not found.",

22594

"itemtype": "method",

22595

"name": "getByClientId",

22596

"params": [

22597

{

22598

"name": "clientId",

22599

"description": "Client id.",

22600

"type": "String"

22601

}

22602

],

22603

"return": {

22604

"description": "Model, or `null` if not found.",

22605

"type": "Model"

22606

},

22607

"class": "ModelList",

22608

"module": "app",

22609

"submodule": "model-list"

22610

},

22611

{

22612

"file": "app/js/model-list.js",

22613

"line": 456,

22614

"description": "Returns the model with the specified _id_, or `null` if not found.\n\nNote that models aren't expected to have an id until they're saved, so if\nyou're working with unsaved models, it may be safer to call\n`getByClientId()`.",

22615

"itemtype": "method",

22616

"name": "getById",

22617

"params": [

22618

{

22619

"name": "id",

22620

"description": "Model id.",

22621

"type": "String|Number"

22622

}

22623

],

22624

"return": {

22625

"description": "Model, or `null` if not found.",

22626

"type": "Model"

22627

},

22628

"class": "ModelList",

22629

"module": "app",

22630

"submodule": "model-list"

22631

},

22632

{

22633

"file": "app/js/model-list.js",

22634

"line": 471,

22635

"description": "Calls the named method on every model in the list. Any arguments provided\nafter _name_ will be passed on to the invoked method.",

22636

"itemtype": "method",

22637

"name": "invoke",

22638

"params": [

22639

{

22640

"name": "name",

22641

"description": "Name of the method to call on each model.",

22642

"type": "String"

22643

},

22644

{

22645

"name": "args*",

22646

"description": "Zero or more arguments to pass to the invoked method.",

22647

"type": "Any",

22648

"optional": true

22649

}

22650

],

22651

"return": {

22652

"description": "Array of return values, indexed according to the index of\n the model on which the method was called.",

22653

"type": "Array"

22654

},

22655

"class": "ModelList",

22656

"module": "app",

22657

"submodule": "model-list"

22658

},

22659

{

22660

"file": "app/js/model-list.js",

22661

"line": 486,

22662

"description": "Returns the model at the specified _index_.",

22663

"itemtype": "method",

22664

"name": "item",

22665

"params": [

22666

{

22667

"name": "index",

22668

"description": "Index of the model to fetch.",

22669

"type": "Number"

22670

}

22671

],

22672

"return": {

22673

"description": "The model at the specified index, or `undefined` if there\n isn't a model there.",

22674

"type": "Model"

22675

},

22676

"class": "ModelList",

22677

"module": "app",

22678

"submodule": "model-list"

22679

},

22680

{

22681

"file": "app/js/model-list.js",

22682

"line": 497,

22683

"description": "Loads this list of models from the server.\n\nThis method delegates to the `sync()` method to perform the actual load\noperation, which is an asynchronous action. Specify a _callback_ function to\nbe notified of success or failure.\n\nIf the load operation succeeds, a `reset` event will be fired.",

22684

"itemtype": "method",

22685

"name": "load",

22686

"params": [

22687

{

22688

"name": "options",

22689

"description": "Options to be passed to `sync()` and to\n `reset()` when adding the loaded models. It's up to the custom sync\n implementation to determine what options it supports or requires, if any.",

22690

"type": "Object",

22691

"optional": true

22692

},

22693

{

22694

"name": "callback",

22695

"description": "Called when the sync operation finishes.",

22696

"type": "Function",

22697

"optional": true,

22698

"props": [

22699

{

22700

"name": "err",

22701

"description": "If an error occurred, this parameter will\n contain the error. If the sync operation succeeded, _err_ will be\n falsy.",

22702

"type": "Error"

22703

},

22704

{

22705

"name": "response",

22706

"description": "The server's response. This value will\n be passed to the `parse()` method, which is expected to parse it and\n return an array of model attribute hashes.",

22707

"type": "Any"

22708

}

22709

]

22710

}

22711

],

22712

"chainable": 1,

22713

"class": "ModelList",

22714

"module": "app",

22715

"submodule": "model-list"

22716

},

22717

{

22718

"file": "app/js/model-list.js",

22719

"line": 563,

22720

"description": "Executes the specified function on each model in this list and returns an\narray of the function's collected return values.",

22721

"itemtype": "method",

22722

"name": "map",

22723

"params": [

22724

{

22725

"name": "fn",

22726

"description": "Function to execute on each model.",

22727

"type": "Function",

22728

"props": [

22729

{

22730

"name": "model",

22731

"description": "Current model being iterated.",

22732

"type": "Model"

22733

},

22734

{

22735

"name": "index",

22736

"description": "Index of the current model in the list.",

22737

"type": "Number"

22738

},

22739

{

22740

"name": "models",

22741

"description": "Array of models being iterated.",

22742

"type": "Model[]"

22743

}

22744

]

22745

},

22746

{

22747

"name": "thisObj",

22748

"description": "`this` object to use when calling _fn_.",

22749

"type": "Object",

22750

"optional": true

22751

}

22752

],

22753

"return": {

22754

"description": "Array of return values from _fn_.",

22755

"type": "Array"

22756

},

22757

"class": "ModelList",

22758

"module": "app",

22759

"submodule": "model-list"

22760

},

22761

{

22762

"file": "app/js/model-list.js",

22763

"line": 579,

22764

"description": "Called to parse the _response_ when the list is loaded from the server.\nThis method receives a server _response_ and is expected to return an array\nof model attribute hashes.\n\nThe default implementation assumes that _response_ is either an array of\nattribute hashes or a JSON string that can be parsed into an array of\nattribute hashes. If _response_ is a JSON string and either `Y.JSON` or the\nnative `JSON` object are available, it will be parsed automatically. If a\nparse error occurs, an `error` event will be fired and the model will not be\nupdated.\n\nYou may override this method to implement custom parsing logic if necessary.",

22765

"itemtype": "method",

22766

"name": "parse",

22767

"params": [

22768

{

22769

"name": "response",

22770

"description": "Server response.",

22771

"type": "Any"

22772

}

22773

],

22774

"return": {

22775

"description": "Array of model attribute hashes.",

22776

"type": "Object[]"

22777

},

22778

"class": "ModelList",

22779

"module": "app",

22780

"submodule": "model-list"

22781

},

22782

{

22783

"file": "app/js/model-list.js",

22784

"line": 615,

22785

"description": "Removes the specified model or array of models from this list. You may also\npass another ModelList instance to remove all the models that are in both\nthat instance and this instance.",

22786

"itemtype": "method",

22787

"name": "remove",

22788

"params": [

22789

{

22790

"name": "models",

22791

"description": "Models to remove.",

22792

"type": "Model|Model[]|ModelList"

22793

},

22794

{

22795

"name": "options",

22796

"description": "Data to be mixed into the event facade of the\n `remove` event(s) for the removed models.",

22797

"type": "Object",

22798

"optional": true,

22799

"props": [

22800

{

22801

"name": "silent",

22802

"description": "If `true`, no `remove` event(s)\n will be fired.",

22803

"type": "Boolean",

22804

"optional": true,

22805

"optdefault": "false"

22806

}

22807

]

22808

}

22809

],

22810

"return": {

22811

"description": "Removed model or array of removed models.",

22812

"type": "Model|Model[]"

22813

},

22814

"class": "ModelList",

22815

"module": "app",

22816

"submodule": "model-list"

22817

},

22818

{

22819

"file": "app/js/model-list.js",

22820

"line": 642,

22821

"description": "Completely replaces all models in the list with those specified, and fires a\nsingle `reset` event.\n\nUse `reset` when you want to add or remove a large number of items at once\nwith less overhead, and without firing `add` or `remove` events for each\none.",

22822

"itemtype": "method",

22823

"name": "reset",

22824

"params": [

22825

{

22826

"name": "models",

22827

"description": "Models to add. May be existing\n model instances or hashes of model attributes, in which case new model\n instances will be created from the hashes. If a ModelList is passed, all\n the models in that list will be added to this list. Calling `reset()`\n without passing in any models will clear the list.",

22828

"type": "Model[]|ModelList|Object[]",

22829

"optional": true

22830

},

22831

{

22832

"name": "options",

22833

"description": "Data to be mixed into the event facade of the\n `reset` event.",

22834

"type": "Object",

22835

"optional": true,

22836

"props": [

22837

{

22838

"name": "silent",

22839

"description": "If `true`, no `reset` event will\n be fired.",

22840

"type": "Boolean",

22841

"optional": true,

22842

"optdefault": "false"

22843

}

22844

]

22845

}

22846

],

22847

"chainable": 1,

22848

"class": "ModelList",

22849

"module": "app",

22850

"submodule": "model-list"

22851

},

22852

{

22853

"file": "app/js/model-list.js",

22854

"line": 694,

22855

"description": "Forcibly re-sorts the list.\n\nUsually it shouldn't be necessary to call this method since the list\nmaintains its sort order when items are added and removed, but if you change\nthe `comparator` function after items are already in the list, you'll need\nto re-sort.",

22856

"itemtype": "method",

22857

"name": "sort",

22858

"params": [

22859

{

22860

"name": "options",

22861

"description": "Data to be mixed into the event facade of the\n `reset` event.",

22862

"type": "Object",

22863

"optional": true,

22864

"props": [

22865

{

22866

"name": "silent",

22867

"description": "If `true`, no `reset` event will\n be fired.",

22868

"type": "Boolean",

22869

"optional": true,

22870

"optdefault": "false"

22871

}

22872

]

22873

}

22874

],

22875

"chainable": 1,

22876

"class": "ModelList",

22877

"module": "app",

22878

"submodule": "model-list"

22879

},

22880

{

22881

"file": "app/js/model-list.js",

22882

"line": 732,

22883

"description": "Override this method to provide a custom persistence implementation for this\nlist. The default method just calls the callback without actually doing\nanything.\n\nThis method is called internally by `load()`.",

22884

"itemtype": "method",

22885

"name": "sync",

22886

"params": [

22887

{

22888

"name": "action",

22889

"description": "Sync action to perform. May be one of the following:\n\n * `create`: Store a list of newly-created models for the first time.\n * `delete`: Delete a list of existing models.\n * `read` : Load a list of existing models.\n * `update`: Update a list of existing models.\n\n Currently, model lists only make use of the `read` action, but other\n actions may be used in future versions.",

22890

"type": "String"

22891

},

22892

{

22893

"name": "options",

22894

"description": "Sync options. It's up to the custom sync\n implementation to determine what options it supports or requires, if any.",

22895

"type": "Object",

22896

"optional": true

22897

},

22898

{

22899

"name": "callback",

22900

"description": "Called when the sync operation finishes.",

22901

"type": "Function",

22902

"optional": true,

22903

"props": [

22904

{

22905

"name": "err",

22906

"description": "If an error occurred, this parameter will\n contain the error. If the sync operation succeeded, _err_ will be\n falsy.",

22907

"type": "Error"

22908

},

22909

{

22910

"name": "response",

22911

"description": "The server's response. This value will\n be passed to the `parse()` method, which is expected to parse it and\n return an array of model attribute hashes.",

22912

"type": "Any",

22913

"optional": true

22914

}

22915

]

22916

}

22917

],

22918

"class": "ModelList",

22919

"module": "app",

22920

"submodule": "model-list"

22921

},

22922

{

22923

"file": "app/js/model-list.js",

22924

"line": 768,

22925

"description": "Returns an array containing the models in this list.",

22926

"itemtype": "method",

22927

"name": "toArray",

22928

"return": {

22929

"description": "Array containing the models in this list.",

22930

"type": "Array"

22931

},

22932

"class": "ModelList",

22933

"module": "app",

22934

"submodule": "model-list"

22935

},

22936

{

22937

"file": "app/js/model-list.js",

22938

"line": 778,

22939

"description": "Returns an array containing attribute hashes for each model in this list,\nsuitable for being passed to `Y.JSON.stringify()`.\n\nUnder the hood, this method calls `toJSON()` on each model in the list and\npushes the results into an array.",

22940

"itemtype": "method",

22941

"name": "toJSON",

22942

"return": {

22943

"description": "Array of model attribute hashes.",

22944

"type": "Object[]"

22945

},

22946

"see": [

22947

"Model.toJSON()"

22948

],

22949

"class": "ModelList",

22950

"module": "app",

22951

"submodule": "model-list"

22952

},

22953

{

22954

"file": "app/js/model-list.js",

22955

"line": 797,

22956

"description": "Adds the specified _model_ if it isn't already in this list.\n\nIf the model's `clientId` or `id` matches that of a model that's already in\nthe list, an `error` event will be fired and the model will not be added.",

22957

"itemtype": "method",

22958

"name": "_add",

22959

"params": [

22960

{

22961

"name": "model",

22962

"description": "Model or object to add.",

22963

"type": "Model|Object"

22964

},

22965

{

22966

"name": "options",

22967

"description": "Data to be mixed into the event facade of the\n `add` event for the added model.",

22968

"type": "Object",

22969

"optional": true,

22970

"props": [

22971

{

22972

"name": "silent",

22973

"description": "If `true`, no `add` event will be\n fired.",

22974

"type": "Boolean",

22975

"optional": true,

22976

"optdefault": "false"

22977

}

22978

]

22979

}

22980

],

22981

"return": {

22982

"description": "The added model.",

22983

"type": "Model"

22984

},

22985

"access": "protected",

22986

"tagname": "",

22987

"class": "ModelList",

22988

"module": "app",

22989

"submodule": "model-list"

22990

},

22991

{

22992

"file": "app/js/model-list.js",

22993

"line": 845,

22994

"description": "Adds this list as a bubble target for the specified model's events.",

22995

"itemtype": "method",

22996

"name": "_attachList",

22997

"params": [

22998

{

22999

"name": "model",

23000

"description": "Model to attach to this list.",

23001

"type": "Model"

23002

}

23003

],

23004

"access": "protected",

23005

"tagname": "",

23006

"class": "ModelList",

23007

"module": "app",

23008

"submodule": "model-list"

23009

},

23010

{

23011

"file": "app/js/model-list.js",

23012

"line": 858,

23013

"description": "Clears all internal state and the internal list of models, returning this\nlist to an empty state. Automatically detaches all models in the list.",

23014

"itemtype": "method",

23015

"name": "_clear",

23016

"access": "protected",

23017

"tagname": "",

23018

"class": "ModelList",

23019

"module": "app",

23020

"submodule": "model-list"

23021

},

23022

{

23023

"file": "app/js/model-list.js",

23024

"line": 873,

23025

"description": "Compares the value _a_ to the value _b_ for sorting purposes. Values are\nassumed to be the result of calling a model's `comparator()` method. You can\noverride this method to implement custom sorting logic, such as a descending\nsort or multi-field sorting.",

23026

"itemtype": "method",

23027

"name": "_compare",

23028

"params": [

23029

{

23030

"name": "a",

23031

"description": "First value to compare.",

23032

"type": "Mixed"

23033

},

23034

{

23035

"name": "b",

23036

"description": "Second value to compare.",

23037

"type": "Mixed"

23038

}

23039

],

23040

"return": {

23041

"description": "`-1` if _a_ should come before _b_, `0` if they're\n equivalent, `1` if _a_ should come after _b_.",

23042

"type": "Number"

23043

},

23044

"access": "protected",

23045

"tagname": "",

23046

"since": "3.5.0",

23047

"class": "ModelList",

23048

"module": "app",

23049

"submodule": "model-list"

23050

},

23051

{

23052

"file": "app/js/model-list.js",

23053

"line": 891,

23054

"description": "Removes this list as a bubble target for the specified model's events.",

23055

"itemtype": "method",

23056

"name": "_detachList",

23057

"params": [

23058

{

23059

"name": "model",

23060

"description": "Model to detach.",

23061

"type": "Model"

23062

}

23063

],

23064

"access": "protected",

23065

"tagname": "",

23066

"class": "ModelList",

23067

"module": "app",

23068

"submodule": "model-list"

23069

},

23070

{

23071

"file": "app/js/model-list.js",

23072

"line": 907,

23073

"description": "Returns the index at which the given _model_ should be inserted to maintain\nthe sort order of the list.",

23074

"itemtype": "method",

23075

"name": "_findIndex",

23076

"params": [

23077

{

23078

"name": "model",

23079

"description": "The model being inserted.",

23080

"type": "Model"

23081

}

23082

],

23083

"return": {

23084

"description": "Index at which the model should be inserted.",

23085

"type": "Number"

23086

},

23087

"access": "protected",

23088

"tagname": "",

23089

"class": "ModelList",

23090

"module": "app",

23091

"submodule": "model-list"

23092

},

23093

{

23094

"file": "app/js/model-list.js",

23095

"line": 944,

23096

"description": "Removes the specified _model_ if it's in this list.",

23097

"itemtype": "method",

23098

"name": "_remove",

23099

"params": [

23100

{

23101

"name": "model",

23102

"description": "Model to remove.",

23103

"type": "Model"

23104

},

23105

{

23106

"name": "options",

23107

"description": "Data to be mixed into the event facade of the\n `remove` event for the removed model.",

23108

"type": "Object",

23109

"optional": true,

23110

"props": [

23111

{

23112

"name": "silent",

23113

"description": "If `true`, no `remove` event will\n be fired.",

23114

"type": "Boolean",

23115

"optional": true,

23116

"optdefault": "false"

23117

}

23118

]

23119

}

23120

],

23121

"return": {

23122

"description": "Removed model.",

23123

"type": "Model"

23124

},

23125

"access": "protected",

23126

"tagname": "",

23127

"class": "ModelList",

23128

"module": "app",

23129

"submodule": "model-list"

23130

},

23131

{

23132

"file": "app/js/model-list.js",

23133

"line": 983,

23134

"description": "Array sort function used by `sort()` to re-sort the models in the list.",

23135

"itemtype": "method",

23136

"name": "_sort",

23137

"params": [

23138

{

23139

"name": "a",

23140

"description": "First model to compare.",

23141

"type": "Model"

23142

},

23143

{

23144

"name": "b",

23145

"description": "Second model to compare.",

23146

"type": "Model"

23147

}

23148

],

23149

"return": {

23150

"description": "`-1` if _a_ is less than _b_, `0` if equal, `1` if greater.",

23151

"type": "Number"

23152

},

23153

"access": "protected",

23154

"tagname": "",

23155

"class": "ModelList",

23156

"module": "app",

23157

"submodule": "model-list"

23158

},

23159

{

23160

"file": "app/js/model-list.js",

23161

"line": 998,

23162

"description": "Updates the model maps when a model's `id` attribute changes.",

23163

"itemtype": "method",

23164

"name": "_afterIdChange",

23165

"params": [

23166

{

23167

"name": "e",

23168

"description": "",

23169

"type": "EventFacade"

23170

}

23171

],

23172

"access": "protected",

23173

"tagname": "",

23174

"class": "ModelList",

23175

"module": "app",

23176

"submodule": "model-list"

23177

},

23178

{

23179

"file": "app/js/model-list.js",

23180

"line": 1012,

23181

"description": "Default event handler for `add` events.",

23182

"itemtype": "method",

23183

"name": "_defAddFn",

23184

"params": [

23185

{

23186

"name": "e",

23187

"description": "",

23188

"type": "EventFacade"

23189

}

23190

],

23191

"access": "protected",

23192

"tagname": "",

23193

"class": "ModelList",

23194

"module": "app",

23195

"submodule": "model-list"

23196

},

23197

{

23198

"file": "app/js/model-list.js",

23199

"line": 1033,

23200

"description": "Default event handler for `remove` events.",

23201

"itemtype": "method",

23202

"name": "_defRemoveFn",

23203

"params": [

23204

{

23205

"name": "e",

23206

"description": "",

23207

"type": "EventFacade"

23208

}

23209

],

23210

"access": "protected",

23211

"tagname": "",

23212

"class": "ModelList",

23213

"module": "app",

23214

"submodule": "model-list"

23215

},

23216

{

23217

"file": "app/js/model-list.js",

23218

"line": 1054,

23219

"description": "Default event handler for `reset` events.",

23220

"itemtype": "method",

23221

"name": "_defResetFn",

23222

"params": [

23223

{

23224

"name": "e",

23225

"description": "",

23226

"type": "EventFacade"

23227

}

23228

],

23229

"access": "protected",

23230

"tagname": "",

23231

"class": "ModelList",

23232

"module": "app",

23233

"submodule": "model-list"

23234

},

23235

{

23236

"file": "app/js/model.js",

23237

"line": 30,

23238

"description": "Fired when one or more attributes on this model are changed.",

23239

"itemtype": "event",

23240

"name": "change",

23241

"params": [

23242

{

23243

"name": "changed",

23244

"description": "Hash of change information for each attribute that\n changed. Each item in the hash has the following properties:",

23245

"type": "Object",

23246

"props": [

23247

{

23248

"name": "newVal",

23249

"description": "New value of the attribute.",

23250

"type": "Any"

23251

},

23252

{

23253

"name": "prevVal",

23254

"description": "Previous value of the attribute.",

23255

"type": "Any"

23256

},

23257

{

23258

"name": "src",

23259

"description": "Source of the change event, if any.",

23260

"type": "String|null"

23261

}

23262

]

23263

}

23264

],

23265

"class": "Model",

23266

"module": "app",

23267

"submodule": "model"

23268

},

23269

{

23270

"file": "app/js/model.js",

23271

"line": 42,

23272

"description": "Fired when an error occurs, such as when the model doesn't validate or when\na sync layer response can't be parsed.",

23273

"itemtype": "event",

23274

"name": "error",

23275

"params": [

23276

{

23277

"name": "error",

23278

"description": "Error message, object, or exception generated by the\n error. Calling `toString()` on this should result in a meaningful error\n message.",

23279

"type": "Any"

23280

},

23281

{

23282

"name": "src",

23283

"description": "Source of the error. May be one of the following (or any\n custom error source defined by a Model subclass):\n\n * `load`: An error loading the model from a sync layer. The sync layer's\n response (if any) will be provided as the `response` property on the\n event facade.\n\n * `parse`: An error parsing a JSON response. The response in question will\n be provided as the `response` property on the event facade.\n\n * `save`: An error saving the model to a sync layer. The sync layer's\n response (if any) will be provided as the `response` property on the\n event facade.\n\n * `validate`: The model failed to validate. The attributes being validated\n will be provided as the `attributes` property on the event facade.",

23284

"type": "String"

23285

}

23286

],

23287

"class": "Model",

23288

"module": "app",

23289

"submodule": "model"

23290

},

23291

{

23292

"file": "app/js/model.js",

23293

"line": 69,

23294

"description": "Fired after model attributes are loaded from a sync layer.",

23295

"itemtype": "event",

23296

"name": "load",

23297

"params": [

23298

{

23299

"name": "parsed",

23300

"description": "The parsed version of the sync layer's response to\n the load request.",

23301

"type": "Object"

23302

},

23303

{

23304

"name": "response",

23305

"description": "The sync layer's raw, unparsed response to the load\n request.",

23306

"type": "Any"

23307

}

23308

],

23309

"since": "3.5.0",

23310

"class": "Model",

23311

"module": "app",

23312

"submodule": "model"

23313

},

23314

{

23315

"file": "app/js/model.js",

23316

"line": 81,

23317

"description": "Fired after model attributes are saved to a sync layer.",

23318

"itemtype": "event",

23319

"name": "save",

23320

"params": [

23321

{

23322

"name": "parsed",

23323

"description": "The parsed version of the sync layer's response to\n the save request, if there was a response.",

23324

"type": "Object",

23325

"optional": true

23326

},

23327

{

23328

"name": "response",

23329

"description": "The sync layer's raw, unparsed response to the save\n request, if there was one.",

23330

"type": "Any",

23331

"optional": true

23332

}

23333

],

23334

"since": "3.5.0",

23335

"class": "Model",

23336

"module": "app",

23337

"submodule": "model"

23338

},

23339

{

23340

"file": "app/js/model.js",

23341

"line": 100,

23342

"description": "Hash of attributes that have changed since the last time this model was\nsaved.",

23343

"itemtype": "property",

23344

"name": "changed",

23345

"type": "Object",

23346

"default": "{}",

23347

"class": "Model",

23348

"module": "app",

23349

"submodule": "model"

23350

},

23351

{

23352

"file": "app/js/model.js",

23353

"line": 109,

23354

"description": "Name of the attribute to use as the unique id (or primary key) for this\nmodel.\n\nThe default is `id`, but if your persistence layer uses a different name for\nthe primary key (such as `_id` or `uid`), you can specify that here.\n\nThe built-in `id` attribute will always be an alias for whatever attribute\nname you specify here, so getting and setting `id` will always behave the\nsame as getting and setting your custom id attribute.",

23355

"itemtype": "property",

23356

"name": "idAttribute",

23357

"type": "String",

23358

"default": "`'id'`",

23359

"class": "Model",

23360

"module": "app",

23361

"submodule": "model"

23362

},

23363

{

23364

"file": "app/js/model.js",

23365

"line": 126,

23366

"description": "Hash of attributes that were changed in the last `change` event. Each item\nin this hash is an object with the following properties:\n\n * `newVal`: The new value of the attribute after it changed.\n * `prevVal`: The old value of the attribute before it changed.\n * `src`: The source of the change, or `null` if no source was specified.",

23367

"itemtype": "property",

23368

"name": "lastChange",

23369

"type": "Object",

23370

"default": "{}",

23371

"class": "Model",

23372

"module": "app",

23373

"submodule": "model"

23374

},

23375

{

23376

"file": "app/js/model.js",

23377

"line": 139,

23378

"description": "Array of `ModelList` instances that contain this model.\n\nWhen a model is in one or more lists, the model's events will bubble up to\nthose lists. You can subscribe to a model event on a list to be notified\nwhen any model in the list fires that event.\n\nThis property is updated automatically when this model is added to or\nremoved from a `ModelList` instance. You shouldn't alter it manually. When\nworking with models in a list, you should always add and remove models using\nthe list's `add()` and `remove()` methods.",

23379

"example": [

23380

" Subscribing to model events on a list:\n\n // Assuming `list` is an existing Y.ModelList instance.\n list.on('*:change', function (e) {\n // This function will be called whenever any model in the list\n // fires a `change` event.\n //\n // `e.target` will refer to the model instance that fired the\n // event.\n });"

23381

],

23382

"itemtype": "property",

23383

"name": "lists",

23384

"type": "ModelList[]",

23385

"default": "`[]`",

23386

"class": "Model",

23387

"module": "app",

23388

"submodule": "model"

23389

},

23390

{

23391

"file": "app/js/model.js",

23392

"line": 169,

23393

"description": "This tells `Y.Base` that it should create ad-hoc attributes for config\nproperties passed to Model's constructor. This makes it possible to\ninstantiate a model and set a bunch of attributes without having to subclass\n`Y.Model` and declare all those attributes first.",

23394

"itemtype": "property",

23395

"name": "_allowAdHocAttrs",

23396

"type": "Boolean",

23397

"default": "true",

23398

"access": "protected",

23399

"tagname": "",

23400

"since": "3.5.0",

23401

"class": "Model",

23402

"module": "app",

23403

"submodule": "model"

23404

},

23405

{

23406

"file": "app/js/model.js",

23407

"line": 183,

23408

"description": "Total hack to allow us to identify Model instances without using\n`instanceof`, which won't work when the instance was created in another\nwindow or YUI sandbox.",

23409

"itemtype": "property",

23410

"name": "_isYUIModel",

23411

"type": "Boolean",

23412

"default": "true",

23413

"access": "protected",

23414

"tagname": "",

23415

"since": "3.5.0",

23416

"class": "Model",

23417

"module": "app",

23418

"submodule": "model"

23419

},

23420

{

23421

"file": "app/js/model.js",

23422

"line": 205,

23423

"description": "Destroys this model instance and removes it from its containing lists, if\nany.\n\nThe _callback_, if one is provided, will be called after the model is\ndestroyed.\n\nIf `options.remove` is `true`, then this method delegates to the `sync()`\nmethod to delete the model from the persistence layer, which is an\nasynchronous action. In this case, the _callback_ (if provided) will be\ncalled after the sync layer indicates success or failure of the delete\noperation.",

23424

"itemtype": "method",

23425

"name": "destroy",

23426

"params": [

23427

{

23428

"name": "options",

23429

"description": "Sync options. It's up to the custom sync\n implementation to determine what options it supports or requires, if\n any.",

23430

"type": "Object",

23431

"optional": true,

23432

"props": [

23433

{

23434

"name": "remove",

23435

"description": "If `true`, the model will be\n deleted via the sync layer in addition to the instance being destroyed.",

23436

"type": "Boolean",

23437

"optional": true,

23438

"optdefault": "false"

23439

}

23440

]

23441

},

23442

{

23443

"name": "callback",

23444

"description": "Called after the model has been destroyed (and\n deleted via the sync layer if `options.remove` is `true`).",

23445

"type": "Callback",

23446

"optional": true,

23447

"props": [

23448

{

23449

"name": "err",

23450

"description": "If an error occurred, this parameter will\n contain the error. Otherwise _err_ will be `null`.",

23451

"type": "Error|null"

23452

}

23453

]

23454

}

23455

],

23456

"chainable": 1,

23457

"class": "Model",

23458

"module": "app",

23459

"submodule": "model"

23460

},

23461

{

23462

"file": "app/js/model.js",

23463

"line": 260,

23464

"description": "Returns a clientId string that's unique among all models on the current page\n(even models in other YUI instances). Uniqueness across pageviews is\nunlikely.",

23465

"itemtype": "method",

23466

"name": "generateClientId",

23467

"return": {

23468

"description": "Unique clientId.",

23469

"type": "String"

23470

},

23471

"class": "Model",

23472

"module": "app",

23473

"submodule": "model"

23474

},

23475

{

23476

"file": "app/js/model.js",

23477

"line": 273,

23478

"description": "Returns the value of the specified attribute.\n\nIf the attribute's value is an object, _name_ may use dot notation to\nspecify the path to a specific property within the object, and the value of\nthat property will be returned.",

23479

"example": [

23480

"\n // Set the 'foo' attribute to an object.\n myModel.set('foo', {\n bar: {\n baz: 'quux'\n }\n });\n\n // Get the value of 'foo'.\n myModel.get('foo');\n // => {bar: {baz: 'quux'}}\n\n // Get the value of 'foo.bar.baz'.\n myModel.get('foo.bar.baz');\n // => 'quux'"

23481

],

23482

"itemtype": "method",

23483

"name": "get",

23484

"params": [

23485

{

23486

"name": "name",

23487

"description": "Attribute name or object property path.",

23488

"type": "String"

23489

}

23490

],

23491

"return": {

23492

"description": "Attribute value, or `undefined` if the attribute doesn't\n exist.",

23493

"type": "Any"

23494

},

23495

"class": "Model",

23496

"module": "app",

23497

"submodule": "model"

23498

},

23499

{

23500

"file": "app/js/model.js",

23501

"line": 304,

23502

"description": "Returns an HTML-escaped version of the value of the specified string\nattribute. The value is escaped using `Y.Escape.html()`.",

23503

"itemtype": "method",

23504

"name": "getAsHTML",

23505

"params": [

23506

{

23507

"name": "name",

23508

"description": "Attribute name or object property path.",

23509

"type": "String"

23510

}

23511

],

23512

"return": {

23513

"description": "HTML-escaped attribute value.",

23514

"type": "String"

23515

},

23516

"class": "Model",

23517

"module": "app",

23518

"submodule": "model"

23519

},

23520

{

23521

"file": "app/js/model.js",

23522

"line": 317,

23523

"description": "Returns a URL-encoded version of the value of the specified string\nattribute. The value is encoded using the native `encodeURIComponent()`\nfunction.",

23524

"itemtype": "method",

23525

"name": "getAsURL",

23526

"params": [

23527

{

23528

"name": "name",

23529

"description": "Attribute name or object property path.",

23530

"type": "String"

23531

}

23532

],

23533

"return": {

23534

"description": "URL-encoded attribute value.",

23535

"type": "String"

23536

},

23537

"class": "Model",

23538

"module": "app",

23539

"submodule": "model"

23540

},

23541

{

23542

"file": "app/js/model.js",

23543

"line": 331,

23544

"description": "Returns `true` if any attribute of this model has been changed since the\nmodel was last saved.\n\nNew models (models for which `isNew()` returns `true`) are implicitly\nconsidered to be \"modified\" until the first time they're saved.",

23545

"itemtype": "method",

23546

"name": "isModified",

23547

"return": {

23548

"description": "`true` if this model has changed since it was last saved,\n `false` otherwise.",

23549

"type": "Boolean"

23550

},

23551

"class": "Model",

23552

"module": "app",

23553

"submodule": "model"

23554

},

23555

{

23556

"file": "app/js/model.js",

23557

"line": 346,

23558

"description": "Returns `true` if this model is \"new\", meaning it hasn't been saved since it\nwas created.\n\nNewness is determined by checking whether the model's `id` attribute has\nbeen set. An empty id is assumed to indicate a new model, whereas a\nnon-empty id indicates a model that was either loaded or has been saved\nsince it was created.",

23559

"itemtype": "method",

23560

"name": "isNew",

23561

"return": {

23562

"description": "`true` if this model is new, `false` otherwise.",

23563

"type": "Boolean"

23564

},

23565

"class": "Model",

23566

"module": "app",

23567

"submodule": "model"

23568

},

23569

{

23570

"file": "app/js/model.js",

23571

"line": 362,

23572

"description": "Loads this model from the server.\n\nThis method delegates to the `sync()` method to perform the actual load\noperation, which is an asynchronous action. Specify a _callback_ function to\nbe notified of success or failure.\n\nA successful load operation will fire a `load` event, while an unsuccessful\nload operation will fire an `error` event with the `src` value \"load\".\n\nIf the load operation succeeds and one or more of the loaded attributes\ndiffer from this model's current attributes, a `change` event will be fired.",

23573

"itemtype": "method",

23574

"name": "load",

23575

"params": [

23576

{

23577

"name": "options",

23578

"description": "Options to be passed to `sync()` and to `set()`\n when setting the loaded attributes. It's up to the custom sync\n implementation to determine what options it supports or requires, if any.",

23579

"type": "Object",

23580

"optional": true

23581

},

23582

{

23583

"name": "callback",

23584

"description": "Called when the sync operation finishes.",

23585

"type": "Callback",

23586

"optional": true,

23587

"props": [

23588

{

23589

"name": "err",

23590

"description": "If an error occurred, this parameter will\n contain the error. If the sync operation succeeded, _err_ will be\n `null`.",

23591

"type": "Error|null"

23592

},

23593

{

23594

"name": "response",

23595

"description": "The server's response. This value will\n be passed to the `parse()` method, which is expected to parse it and\n return an attribute hash.",

23596

"type": "Any"

23597

}

23598

]

23599

}

23600

],

23601

"chainable": 1,

23602

"class": "Model",

23603

"module": "app",

23604

"submodule": "model"

23605

},

23606

{

23607

"file": "app/js/model.js",

23608

"line": 434,

23609

"description": "Called to parse the _response_ when the model is loaded from the server.\nThis method receives a server _response_ and is expected to return an\nattribute hash.\n\nThe default implementation assumes that _response_ is either an attribute\nhash or a JSON string that can be parsed into an attribute hash. If\n_response_ is a JSON string and either `Y.JSON` or the native `JSON` object\nare available, it will be parsed automatically. If a parse error occurs, an\n`error` event will be fired and the model will not be updated.\n\nYou may override this method to implement custom parsing logic if necessary.",

23610

"itemtype": "method",

23611

"name": "parse",

23612

"params": [

23613

{

23614

"name": "response",

23615

"description": "Server response.",

23616

"type": "Any"

23617

}

23618

],

23619

"return": {

23620

"description": "Attribute hash.",

23621

"type": "Object"

23622

},

23623

"class": "Model",

23624

"module": "app",

23625

"submodule": "model"

23626

},

23627

{

23628

"file": "app/js/model.js",

23629

"line": 469,

23630

"description": "Saves this model to the server.\n\nThis method delegates to the `sync()` method to perform the actual save\noperation, which is an asynchronous action. Specify a _callback_ function to\nbe notified of success or failure.\n\nA successful save operation will fire a `save` event, while an unsuccessful\nsave operation will fire an `error` event with the `src` value \"save\".\n\nIf the save operation succeeds and one or more of the attributes returned in\nthe server's response differ from this model's current attributes, a\n`change` event will be fired.",

23631

"itemtype": "method",

23632

"name": "save",

23633

"params": [

23634

{

23635

"name": "options",

23636

"description": "Options to be passed to `sync()` and to `set()`\n when setting synced attributes. It's up to the custom sync implementation\n to determine what options it supports or requires, if any.",

23637

"type": "Object",

23638

"optional": true

23639

},

23640

{

23641

"name": "callback",

23642

"description": "Called when the sync operation finishes.",

23643

"type": "Function",

23644

"optional": true,

23645

"props": [

23646

{

23647

"name": "err",

23648

"description": "If an error occurred or validation\n failed, this parameter will contain the error. If the sync operation\n succeeded, _err_ will be `null`.",

23649

"type": "Error|null"

23650

},

23651

{

23652

"name": "response",

23653

"description": "The server's response. This value will\n be passed to the `parse()` method, which is expected to parse it and\n return an attribute hash.",

23654

"type": "Any"

23655

}

23656

]

23657

}

23658

],

23659

"chainable": 1,

23660

"class": "Model",

23661

"module": "app",

23662

"submodule": "model"

23663

},

23664

{

23665

"file": "app/js/model.js",

23666

"line": 550,

23667

"description": "Sets the value of a single attribute. If model validation fails, the\nattribute will not be set and an `error` event will be fired.\n\nUse `setAttrs()` to set multiple attributes at once.",

23668

"example": [

23669

"\n model.set('foo', 'bar');"

23670

],

23671

"itemtype": "method",

23672

"name": "set",

23673

"params": [

23674

{

23675

"name": "name",

23676

"description": "Attribute name or object property path.",

23677

"type": "String"

23678

},

23679

{

23680

"name": "value",

23681

"description": "Value to set.",

23682

"type": "Any"

23683

},

23684

{

23685

"name": "options",

23686

"description": "Data to be mixed into the event facade of the\n `change` event(s) for these attributes.",

23687

"type": "Object",

23688

"optional": true,

23689

"props": [

23690

{

23691

"name": "silent",

23692

"description": "If `true`, no `change` event will\n be fired.",

23693

"type": "Boolean",

23694

"optional": true,

23695

"optdefault": "false"

23696

}

23697

]

23698

}

23699

],

23700

"chainable": 1,

23701

"class": "Model",

23702

"module": "app",

23703

"submodule": "model"

23704

},

23705

{

23706

"file": "app/js/model.js",

23707

"line": 575,

23708

"description": "Sets the values of multiple attributes at once. If model validation fails,\nthe attributes will not be set and an `error` event will be fired.",

23709

"example": [

23710

"\n model.setAttrs({\n foo: 'bar',\n baz: 'quux'\n });"

23711

],

23712

"itemtype": "method",

23713

"name": "setAttrs",

23714

"params": [

23715

{

23716

"name": "attributes",

23717

"description": "Hash of attribute names and values to set.",

23718

"type": "Object"

23719

},

23720

{

23721

"name": "options",

23722

"description": "Data to be mixed into the event facade of the\n `change` event(s) for these attributes.",

23723

"type": "Object",

23724

"optional": true,

23725

"props": [

23726

{

23727

"name": "silent",

23728

"description": "If `true`, no `change` event will\n be fired.",

23729

"type": "Boolean",

23730

"optional": true,

23731

"optdefault": "false"

23732

}

23733

]

23734

}

23735

],

23736

"chainable": 1,

23737

"class": "Model",

23738

"module": "app",

23739

"submodule": "model"

23740

},

23741

{

23742

"file": "app/js/model.js",

23743

"line": 652,

23744

"description": "Override this method to provide a custom persistence implementation for this\nmodel. The default just calls the callback without actually doing anything.\n\nThis method is called internally by `load()`, `save()`, and `destroy()`.",

23745

"itemtype": "method",

23746

"name": "sync",

23747

"params": [

23748

{

23749

"name": "action",

23750

"description": "Sync action to perform. May be one of the following:\n\n * `create`: Store a newly-created model for the first time.\n * `delete`: Delete an existing model.\n * `read` : Load an existing model.\n * `update`: Update an existing model.",

23751

"type": "String"

23752

},

23753

{

23754

"name": "options",

23755

"description": "Sync options. It's up to the custom sync\n implementation to determine what options it supports or requires, if any.",

23756

"type": "Object",

23757

"optional": true

23758

},

23759

{

23760

"name": "callback",

23761

"description": "Called when the sync operation finishes.",

23762

"type": "Function",

23763

"optional": true,

23764

"props": [

23765

{

23766

"name": "err",

23767

"description": "If an error occurred, this parameter will\n contain the error. If the sync operation succeeded, _err_ will be\n falsy.",

23768

"type": "Error|null"

23769

},

23770

{

23771

"name": "response",

23772

"description": "The server's response.",

23773

"type": "Any",

23774

"optional": true

23775

}

23776

]

23777

}

23778

],

23779

"class": "Model",

23780

"module": "app",

23781

"submodule": "model"

23782

},

23783

{

23784

"file": "app/js/model.js",

23785

"line": 682,

23786

"description": "Returns a copy of this model's attributes that can be passed to\n`Y.JSON.stringify()` or used for other nefarious purposes.\n\nThe `clientId` attribute is not included in the returned object.\n\nIf you've specified a custom attribute name in the `idAttribute` property,\nthe default `id` attribute will not be included in the returned object.\n\nNote: The ECMAScript 5 specification states that objects may implement a\n`toJSON` method to provide an alternate object representation to serialize\nwhen passed to `JSON.stringify(obj)`. This allows class instances to be\nserialized as if they were plain objects. This is why Model's `toJSON`\nreturns an object, not a JSON string.\n\nSee <http://es5.github.com/#x15.12.3> for details.",

23787

"itemtype": "method",

23788

"name": "toJSON",

23789

"return": {

23790

"description": "Copy of this model's attributes.",

23791

"type": "Object"

23792

},

23793

"class": "Model",

23794

"module": "app",

23795

"submodule": "model"

23796

},

23797

{

23798

"file": "app/js/model.js",

23799

"line": 716,

23800

"description": "Reverts the last change to the model.\n\nIf an _attrNames_ array is provided, then only the named attributes will be\nreverted (and only if they were modified in the previous change). If no\n_attrNames_ array is provided, then all changed attributes will be reverted\nto their previous values.\n\nNote that only one level of undo is available: from the current state to the\nprevious state. If `undo()` is called when no previous state is available,\nit will simply do nothing.",

23801

"itemtype": "method",

23802

"name": "undo",

23803

"params": [

23804

{

23805

"name": "attrNames",

23806

"description": "Array of specific attribute names to revert. If\n not specified, all attributes modified in the last change will be\n reverted.",

23807

"type": "Array",

23808

"optional": true

23809

},

23810

{

23811

"name": "options",

23812

"description": "Data to be mixed into the event facade of the\n change event(s) for these attributes.",

23813

"type": "Object",

23814

"optional": true,

23815

"props": [

23816

{

23817

"name": "silent",

23818

"description": "If `true`, no `change` event will\n be fired.",

23819

"type": "Boolean",

23820

"optional": true,

23821

"optdefault": "false"

23822

}

23823

]

23824

}

23825

],

23826

"chainable": 1,

23827

"class": "Model",

23828

"module": "app",

23829

"submodule": "model"

23830

},

23831

{

23832

"file": "app/js/model.js",

23833

"line": 759,

23834

"description": "Override this method to provide custom validation logic for this model.\n\nWhile attribute-specific validators can be used to validate individual\nattributes, this method gives you a hook to validate a hash of all\nattributes before the model is saved. This method is called automatically\nbefore `save()` takes any action. If validation fails, the `save()` call\nwill be aborted.\n\nIn your validation method, call the provided `callback` function with no\narguments to indicate success. To indicate failure, pass a single argument,\nwhich may contain an error message, an array of error messages, or any other\nvalue. This value will be passed along to the `error` event.",

23835

"example": [

23836

"\n\n model.validate = function (attrs, callback) {\n if (attrs.pie !== true) {\n // No pie?! Invalid!\n callback('Must provide pie.');\n return;\n }\n\n // Success!\n callback();\n };"

23837

],

23838

"itemtype": "method",

23839

"name": "validate",

23840

"params": [

23841

{

23842

"name": "attrs",

23843

"description": "Attribute hash containing all model attributes to\n be validated.",

23844

"type": "Object"

23845

},

23846

{

23847

"name": "callback",

23848

"description": "Validation callback. Call this function when your\n validation logic finishes. To trigger a validation failure, pass any\n value as the first argument to the callback (ideally a meaningful\n validation error of some kind).",

23849

"type": "Function",

23850

"props": [

23851

{

23852

"name": "err",

23853

"description": "Validation error. Don't provide this\n argument if validation succeeds. If validation fails, set this to an\n error message or some other meaningful value. It will be passed\n along to the resulting `error` event.",

23854

"type": "Any",

23855

"optional": true

23856

}

23857

]

23858

}

23859

],

23860

"class": "Model",

23861

"module": "app",

23862

"submodule": "model"

23863

},

23864

{

23865

"file": "app/js/model.js",

23866

"line": 805,

23867

"description": "Duckpunches the `addAttr` method provided by `Y.Attribute` to keep the\n`id` attribute’s value and a custom id attribute’s (if provided) value\nin sync when adding the attributes to the model instance object.\n\nMarked as protected to hide it from Model's public API docs, even though\nthis is a public method in Attribute.",

23868

"itemtype": "method",

23869

"name": "addAttr",

23870

"params": [

23871

{

23872

"name": "name",

23873

"description": "The name of the attribute.",

23874

"type": "String"

23875

},

23876

{

23877

"name": "config",

23878

"description": "An object with attribute configuration property/value\n pairs, specifying the configuration for the attribute.",

23879

"type": "Object"

23880

},

23881

{

23882

"name": "lazy",

23883

"description": "(optional) Whether or not to add this attribute lazily\n (on the first call to get/set).",

23884

"type": "Boolean"

23885

}

23886

],

23887

"return": {

23888

"description": "A reference to the host object.",

23889

"type": "Object"

23890

},

23891

"chainable": 1,

23892

"access": "protected",

23893

"tagname": "",

23894

"class": "Model",

23895

"module": "app",

23896

"submodule": "model"

23897

},

23898

{

23899

"file": "app/js/model.js",

23900

"line": 860,

23901

"description": "Calls the public, overridable `validate()` method and fires an `error` event\nif validation fails.",

23902

"itemtype": "method",

23903

"name": "_validate",

23904

"params": [

23905

{

23906

"name": "attributes",

23907

"description": "Attribute hash.",

23908

"type": "Object"

23909

},

23910

{

23911

"name": "callback",

23912

"description": "Validation callback.",

23913

"type": "Function",

23914

"props": [

23915

{

23916

"name": "err",

23917

"description": "Value on failure, non-value on success.",

23918

"type": "Any",

23919

"optional": true

23920

}

23921

]

23922

}

23923

],

23924

"access": "protected",

23925

"tagname": "",

23926

"class": "Model",

23927

"module": "app",

23928

"submodule": "model"

23929

},

23930

{

23931

"file": "app/js/model.js",

23932

"line": 901,

23933

"description": "Duckpunches the `_defAttrChangeFn()` provided by `Y.Attribute` so we can\nhave a single global notification when a change event occurs.",

23934

"itemtype": "method",

23935

"name": "_defAttrChangeFn",

23936

"params": [

23937

{

23938

"name": "e",

23939

"description": "",

23940

"type": "EventFacade"

23941

}

23942

],

23943

"access": "protected",

23944

"tagname": "",

23945

"class": "Model",

23946

"module": "app",

23947

"submodule": "model"

23948

},

23949

{

23950

"file": "app/js/model.js",

23951

"line": 928,

23952

"description": "A client-only identifier for this model.\n\nLike the `id` attribute, `clientId` may be used to retrieve model\ninstances from lists. Unlike the `id` attribute, `clientId` is\nautomatically generated, and is only intended to be used on the client\nduring the current pageview.",

23953

"itemtype": "attribute",

23954

"name": "clientId",

23955

"type": "String",

23956

"readonly": "",

23957

"class": "Model",

23958

"module": "app",

23959

"submodule": "model"

23960

},

23961

{

23962

"file": "app/js/model.js",

23963

"line": 945,

23964

"description": "A unique identifier for this model. Among other things, this id may be\nused to retrieve model instances from lists, so it should be unique.\n\nIf the id is empty, this model instance is assumed to represent a new\nitem that hasn't yet been saved.\n\nIf you would prefer to use a custom attribute as this model's id instead\nof using the `id` attribute (for example, maybe you'd rather use `_id`\nor `uid` as the primary id), you may set the `idAttribute` property to\nthe name of your custom id attribute. The `id` attribute will then\nact as an alias for your custom attribute.",

23965

"itemtype": "attribute",

23966

"name": "id",

23967

"type": "String|Number|null",

23968

"default": "`null`",

23969

"class": "Model",

23970

"module": "app",

23971

"submodule": "model"

23972

},

23973

{

23974

"file": "app/js/router.js",

23975

"line": 20,

23976

"description": "Fired when the router is ready to begin dispatching to route handlers.\n\nYou shouldn't need to wait for this event unless you plan to implement some\nkind of custom dispatching logic. It's used internally in order to avoid\ndispatching to an initial route if a browser history change occurs first.",

23977

"itemtype": "event",

23978

"name": "ready",

23979

"params": [

23980

{

23981

"name": "dispatched",

23982

"description": "`true` if routes have already been dispatched\n (most likely due to a history change).",

23983

"type": "Boolean"

23984

}

23985

],

23986

"fireonce": "",

23987

"class": "Router",

23988

"module": "app",

23989

"submodule": "router"

23990

},

23991

{

23992

"file": "app/js/router.js",

23993

"line": 60,

23994

"description": "Whether or not `_dispatch()` has been called since this router was\ninstantiated.",

23995

"itemtype": "property",

23996

"name": "_dispatched",

23997

"type": "Boolean",

23998

"default": "undefined",

23999

"access": "protected",

24000

"tagname": "",

24001

"class": "Router",

24002

"module": "app",

24003

"submodule": "router"

24004

},

24005

{

24006

"file": "app/js/router.js",

24007

"line": 70,

24008

"description": "Whether or not we're currently in the process of dispatching to routes.",

24009

"itemtype": "property",

24010

"name": "_dispatching",

24011

"type": "Boolean",

24012

"default": "undefined",

24013

"access": "protected",

24014

"tagname": "",

24015

"class": "Router",

24016

"module": "app",

24017

"submodule": "router"

24018

},

24019

{

24020

"file": "app/js/router.js",

24021

"line": 79,

24022

"description": "Cached copy of the `html5` attribute for internal use.",

24023

"itemtype": "property",

24024

"name": "_html5",

24025

"type": "Boolean",

24026

"access": "protected",

24027

"tagname": "",

24028

"class": "Router",

24029

"module": "app",

24030

"submodule": "router"

24031

},

24032

{

24033

"file": "app/js/router.js",

24034

"line": 87,

24035

"description": "Whether or not the `ready` event has fired yet.",

24036

"itemtype": "property",

24037

"name": "_ready",

24038

"type": "Boolean",

24039

"default": "undefined",

24040

"access": "protected",

24041

"tagname": "",

24042

"class": "Router",

24043

"module": "app",

24044

"submodule": "router"

24045

},

24046

{

24047

"file": "app/js/router.js",

24048

"line": 96,

24049

"description": "Regex used to match parameter placeholders in route paths.\n\nSubpattern captures:\n\n 1. Parameter prefix character. Either a `:` for subpath parameters that\n should only match a single level of a path, or `*` for splat parameters\n that should match any number of path levels.\n\n 2. Parameter name, if specified, otherwise it is a wildcard match.",

24050

"itemtype": "property",

24051

"name": "_regexPathParam",

24052

"type": "RegExp",

24053

"access": "protected",

24054

"tagname": "",

24055

"class": "Router",

24056

"module": "app",

24057

"submodule": "router"

24058

},

24059

{

24060

"file": "app/js/router.js",

24061

"line": 113,

24062

"description": "Regex that matches and captures the query portion of a URL, minus the\npreceding `?` character, and discarding the hash portion of the URL if any.",

24063

"itemtype": "property",

24064

"name": "_regexUrlQuery",

24065

"type": "RegExp",

24066

"access": "protected",

24067

"tagname": "",

24068

"class": "Router",

24069

"module": "app",

24070

"submodule": "router"

24071

},

24072

{

24073

"file": "app/js/router.js",

24074

"line": 123,

24075

"description": "Regex that matches everything before the path portion of a URL (the origin).\nThis will be used to strip this part of the URL from a string when we\nonly want the path.",

24076

"itemtype": "property",

24077

"name": "_regexUrlOrigin",

24078

"type": "RegExp",

24079

"access": "protected",

24080

"tagname": "",

24081

"class": "Router",

24082

"module": "app",

24083

"submodule": "router"

24084

},

24085

{

24086

"file": "app/js/router.js",

24087

"line": 183,

24088

"description": "Dispatches to the first route handler that matches the current URL, if any.\n\nIf `dispatch()` is called before the `ready` event has fired, it will\nautomatically wait for the `ready` event before dispatching. Otherwise it\nwill dispatch immediately.",

24089

"itemtype": "method",

24090

"name": "dispatch",

24091

"chainable": 1,

24092

"class": "Router",

24093

"module": "app",

24094

"submodule": "router"

24095

},

24096

{

24097

"file": "app/js/router.js",

24098

"line": 207,

24099

"description": "Gets the current route path, relative to the `root` (if any).",

24100

"itemtype": "method",

24101

"name": "getPath",

24102

"return": {

24103

"description": "Current route path.",

24104

"type": "String"

24105

},

24106

"class": "Router",

24107

"module": "app",

24108

"submodule": "router"

24109

},

24110

{

24111

"file": "app/js/router.js",

24112

"line": 217,

24113

"description": "Returns `true` if this router has at least one route that matches the\nspecified URL, `false` otherwise.\n\nThis method enforces the same-origin security constraint on the specified\n`url`; any URL which is not from the same origin as the current URL will\nalways return `false`.",

24114

"itemtype": "method",

24115

"name": "hasRoute",

24116

"params": [

24117

{

24118

"name": "url",

24119

"description": "URL to match.",

24120

"type": "String"

24121

}

24122

],

24123

"return": {

24124

"description": "`true` if there's at least one matching route, `false`\n otherwise.",

24125

"type": "Boolean"

24126

},

24127

"class": "Router",

24128

"module": "app",

24129

"submodule": "router"

24130

},

24131

{

24132

"file": "app/js/router.js",

24133

"line": 240,

24134

"description": "Returns an array of route objects that match the specified URL path.\n\nThis method is called internally to determine which routes match the current\npath whenever the URL changes. You may override it if you want to customize\nthe route matching logic, although this usually shouldn't be necessary.\n\nEach returned route object has the following properties:\n\n * `callback`: A function or a string representing the name of a function\n this router that should be executed when the route is triggered.\n * `keys`: An array of strings representing the named parameters defined in\n the route's path specification, if any.\n * `path`: The route's path specification, which may be either a string or\n a regex.\n * `regex`: A regular expression version of the route's path specification.\n This regex is used to determine whether the route matches a given path.",

24135

"example": [

24136

"\n router.route('/foo', function () {});\n router.match('/foo');\n // => [{callback: ..., keys: [], path: '/foo', regex: ...}]"

24137

],

24138

"itemtype": "method",

24139

"name": "match",

24140

"params": [

24141

{

24142

"name": "path",

24143

"description": "URL path to match.",

24144

"type": "String"

24145

}

24146

],

24147

"return": {

24148

"description": "Array of route objects that match the specified path.",

24149

"type": "Object[]"

24150

},

24151

"class": "Router",

24152

"module": "app",

24153

"submodule": "router"

24154

},

24155

{

24156

"file": "app/js/router.js",

24157

"line": 273,

24158

"description": "Removes the `root` URL from the front of _url_ (if it's there) and returns\nthe result. The returned path will always have a leading `/`.",

24159

"itemtype": "method",

24160

"name": "removeRoot",

24161

"params": [

24162

{

24163

"name": "url",

24164

"description": "URL.",

24165

"type": "String"

24166

}

24167

],

24168

"return": {

24169

"description": "Rootless path.",

24170

"type": "String"

24171

},

24172

"class": "Router",

24173

"module": "app",

24174

"submodule": "router"

24175

},

24176

{

24177

"file": "app/js/router.js",

24178

"line": 295,

24179

"description": "Removes a query string from the end of the _url_ (if one exists) and returns\nthe result.",

24180

"itemtype": "method",

24181

"name": "removeQuery",

24182

"params": [

24183

{

24184

"name": "url",

24185

"description": "URL.",

24186

"type": "String"

24187

}

24188

],

24189

"return": {

24190

"description": "Queryless path.",

24191

"type": "String"

24192

},

24193

"class": "Router",

24194

"module": "app",

24195

"submodule": "router"

24196

},

24197

{

24198

"file": "app/js/router.js",

24199

"line": 307,

24200

"description": "Replaces the current browser history entry with a new one, and dispatches to\nthe first matching route handler, if any.\n\nBehind the scenes, this method uses HTML5 `pushState()` in browsers that\nsupport it (or the location hash in older browsers and IE) to change the\nURL.\n\nThe specified URL must share the same origin (i.e., protocol, host, and\nport) as the current page, or an error will occur.",

24201

"example": [

24202

"\n // Starting URL: http://example.com/\n\n router.replace('/path/');\n // New URL: http://example.com/path/\n\n router.replace('/path?foo=bar');\n // New URL: http://example.com/path?foo=bar\n\n router.replace('/');\n // New URL: http://example.com/"

24203

],

24204

"itemtype": "method",

24205

"name": "replace",

24206

"params": [

24207

{

24208

"name": "url",

24209

"description": "URL to set. This URL needs to be of the same origin as\n the current URL. This can be a URL relative to the router's `root`\n attribute. If no URL is specified, the page's current URL will be used.",

24210

"type": "String",

24211

"optional": true

24212

}

24213

],

24214

"chainable": 1,

24215

"see": [

24216

"save()"

24217

],

24218

"class": "Router",

24219

"module": "app",

24220

"submodule": "router"

24221

},

24222

{

24223

"file": "app/js/router.js",

24224

"line": 341,

24225

"description": "Adds a route handler for the specified URL _path_.\n\nThe _path_ parameter may be either a string or a regular expression. If it's\na string, it may contain named parameters: `:param` will match any single\npart of a URL path (not including `/` characters), and `*param` will match\nany number of parts of a URL path (including `/` characters). These named\nparameters will be made available as keys on the `req.params` object that's\npassed to route handlers.\n\nIf the _path_ parameter is a regex, all pattern matches will be made\navailable as numbered keys on `req.params`, starting with `0` for the full\nmatch, then `1` for the first subpattern match, and so on.\n\nHere's a set of sample routes along with URL paths that they match:\n\n * Route: `/photos/:tag/:page`\n * URL: `/photos/kittens/1`, params: `{tag: 'kittens', page: '1'}`\n * URL: `/photos/puppies/2`, params: `{tag: 'puppies', page: '2'}`\n\n * Route: `/file/*path`\n * URL: `/file/foo/bar/baz.txt`, params: `{path: 'foo/bar/baz.txt'}`\n * URL: `/file/foo`, params: `{path: 'foo'}`\n\nIf multiple route handlers match a given URL, they will be executed in the\norder they were added. The first route that was added will be the first to\nbe executed.",

24226

"example": [

24227

"\n router.route('/photos/:tag/:page', function (req, res, next) {\n Y.log('Current tag: ' + req.params.tag);\n Y.log('Current page number: ' + req.params.page);\n });"

24228

],

24229

"itemtype": "method",

24230

"name": "route",

24231

"params": [

24232

{

24233

"name": "path",

24234

"description": "Path to match. May be a string or a regular\n expression.",

24235

"type": "String|RegExp"

24236

},

24237

{

24238

"name": "callback",

24239

"description": "Callback function to call whenever this\n route is triggered. If specified as a string, the named function will be\n called on this router instance.",

24240

"type": "Function|String",

24241

"props": [

24242

{

24243

"name": "req",

24244

"description": "Request object containing information about\n the request. It contains the following properties.",

24245

"type": "Object",

24246

"props": [

24247

{

24248

"name": "params",

24249

"description": "Captured parameters matched by\n the route path specification. If a string path was used and contained\n named parameters, then this will be a key/value hash mapping parameter\n names to their matched values. If a regex path was used, this will be\n an array of subpattern matches starting at index 0 for the full match,\n then 1 for the first subpattern match, and so on.",

24250

"type": "Array|Object"

24251

},

24252

{

24253

"name": "path",

24254

"description": "The current URL path.",

24255

"type": "String"

24256

},

24257

{

24258

"name": "query",

24259

"description": "Query hash representing the URL query\n string, if any. Parameter names are keys, and are mapped to parameter\n values.",

24260

"type": "Object"

24261

},

24262

{

24263

"name": "url",

24264

"description": "The full URL.",

24265

"type": "String"

24266

},

24267

{

24268

"name": "src",

24269

"description": "What initiated the dispatch. In an\n HTML5 browser, when the back/forward buttons are used, this property\n will have a value of \"popstate\".",

24270

"type": "String"

24271

}

24272

]

24273

},

24274

{

24275

"name": "res",

24276

"description": "Response object containing methods and\n information that relate to responding to a request. It contains the\n following properties.",

24277

"type": "Object",

24278

"props": [

24279

{

24280

"name": "req",

24281

"description": "Reference to the request object.",

24282

"type": "Object"

24283

}

24284

]

24285

},

24286

{

24287

"name": "next",

24288

"description": "Callback to pass control to the next\n matching route. If you don't call this function, then no further route\n handlers will be executed, even if there are more that match. If you do\n call this function, then the next matching route handler (if any) will\n be called, and will receive the same `req` object that was passed to\n this route (so you can use the request object to pass data along to\n subsequent routes).",

24289

"type": "Function"

24290

}

24291

]

24292

}

24293

],

24294

"chainable": 1,

24295

"class": "Router",

24296

"module": "app",

24297

"submodule": "router"

24298

},

24299

{

24300

"file": "app/js/router.js",

24301

"line": 423,

24302

"description": "Saves a new browser history entry and dispatches to the first matching route\nhandler, if any.\n\nBehind the scenes, this method uses HTML5 `pushState()` in browsers that\nsupport it (or the location hash in older browsers and IE) to change the\nURL and create a history entry.\n\nThe specified URL must share the same origin (i.e., protocol, host, and\nport) as the current page, or an error will occur.",

24303

"example": [

24304

"\n // Starting URL: http://example.com/\n\n router.save('/path/');\n // New URL: http://example.com/path/\n\n router.save('/path?foo=bar');\n // New URL: http://example.com/path?foo=bar\n\n router.save('/');\n // New URL: http://example.com/"

24305

],

24306

"itemtype": "method",

24307

"name": "save",

24308

"params": [

24309

{

24310

"name": "url",

24311

"description": "URL to set. This URL needs to be of the same origin as\n the current URL. This can be a URL relative to the router's `root`\n attribute. If no URL is specified, the page's current URL will be used.",

24312

"type": "String",

24313

"optional": true

24314

}

24315

],

24316

"chainable": 1,

24317

"see": [

24318

"replace()"

24319

],

24320

"class": "Router",

24321

"module": "app",

24322

"submodule": "router"

24323

},

24324

{

24325

"file": "app/js/router.js",

24326

"line": 457,

24327

"description": "Upgrades a hash-based URL to an HTML5 URL if necessary. In non-HTML5\nbrowsers, this method is a noop.",

24328

"itemtype": "method",

24329

"name": "upgrade",

24330

"return": {

24331

"description": "`true` if the URL was upgraded, `false` otherwise.",

24332

"type": "Boolean"

24333

},

24334

"class": "Router",

24335

"module": "app",

24336

"submodule": "router"

24337

},

24338

{

24339

"file": "app/js/router.js",

24340

"line": 489,

24341

"description": "Wrapper around `decodeURIComponent` that also converts `+` chars into\nspaces.",

24342

"itemtype": "method",

24343

"name": "_decode",

24344

"params": [

24345

{

24346

"name": "string",

24347

"description": "String to decode.",

24348

"type": "String"

24349

}

24350

],

24351

"return": {

24352

"description": "Decoded string.",

24353

"type": "String"

24354

},

24355

"access": "protected",

24356

"tagname": "",

24357

"class": "Router",

24358

"module": "app",

24359

"submodule": "router"

24360

},

24361

{

24362

"file": "app/js/router.js",

24363

"line": 502,

24364

"description": "Shifts the topmost `_save()` call off the queue and executes it. Does\nnothing if the queue is empty.",

24365

"itemtype": "method",

24366

"name": "_dequeue",

24367

"chainable": 1,

24368

"see": [

24369

"_queue"

24370

],

24371

"access": "protected",

24372

"tagname": "",

24373

"class": "Router",

24374

"module": "app",

24375

"submodule": "router"

24376

},

24377

{

24378

"file": "app/js/router.js",

24379

"line": 530,

24380

"description": "Dispatches to the first route handler that matches the specified _path_.\n\nIf called before the `ready` event has fired, the dispatch will be aborted.\nThis ensures normalized behavior between Chrome (which fires a `popstate`\nevent on every pageview) and other browsers (which do not).",

24381

"itemtype": "method",

24382

"name": "_dispatch",

24383

"params": [

24384

{

24385

"name": "path",

24386

"description": "URL path.",

24387

"type": "String"

24388

},

24389

{

24390

"name": "url",

24391

"description": "Full URL.",

24392

"type": "String"

24393

},

24394

{

24395

"name": "src",

24396

"description": "What initiated the dispatch.",

24397

"type": "String"

24398

}

24399

],

24400

"chainable": 1,

24401

"access": "protected",

24402

"tagname": "",

24403

"class": "Router",

24404

"module": "app",

24405

"submodule": "router"

24406

},

24407

{

24408

"file": "app/js/router.js",

24409

"line": 587,

24410

"description": "Gets the current path from the location hash, or an empty string if the\nhash is empty.",

24411

"itemtype": "method",

24412

"name": "_getHashPath",

24413

"return": {

24414

"description": "Current hash path, or an empty string if the hash is empty.",

24415

"type": "String"

24416

},

24417

"access": "protected",

24418

"tagname": "",

24419

"class": "Router",

24420

"module": "app",

24421

"submodule": "router"

24422

},

24423

{

24424

"file": "app/js/router.js",

24425

"line": 599,

24426

"description": "Gets the location origin (i.e., protocol, host, and port) as a URL.",

24427

"example": [

24428

"\n http://example.com"

24429

],

24430

"itemtype": "method",

24431

"name": "_getOrigin",

24432

"return": {

24433

"description": "Location origin (i.e., protocol, host, and port).",

24434

"type": "String"

24435

},

24436

"access": "protected",

24437

"tagname": "",

24438

"class": "Router",

24439

"module": "app",

24440

"submodule": "router"

24441

},

24442

{

24443

"file": "app/js/router.js",

24444

"line": 614,

24445

"description": "Gets the current route path, relative to the `root` (if any).",

24446

"itemtype": "method",

24447

"name": "_getPath",

24448

"return": {

24449

"description": "Current route path.",

24450

"type": "String"

24451

},

24452

"access": "protected",

24453

"tagname": "",

24454

"class": "Router",

24455

"module": "app",

24456

"submodule": "router"

24457

},

24458

{

24459

"file": "app/js/router.js",

24460

"line": 628,

24461

"description": "Gets the current route query string.",

24462

"itemtype": "method",

24463

"name": "_getQuery",

24464

"return": {

24465

"description": "Current route query string.",

24466

"type": "String"

24467

},

24468

"access": "protected",

24469

"tagname": "",

24470

"class": "Router",

24471

"module": "app",

24472

"submodule": "router"

24473

},

24474

{

24475

"file": "app/js/router.js",

24476

"line": 649,

24477

"description": "Creates a regular expression from the given route specification. If _path_\nis already a regex, it will be returned unmodified.",

24478

"itemtype": "method",

24479

"name": "_getRegex",

24480

"params": [

24481

{

24482

"name": "path",

24483

"description": "Route path specification.",

24484

"type": "String|RegExp"

24485

},

24486

{

24487

"name": "keys",

24488

"description": "Array reference to which route parameter names will be\n added.",

24489

"type": "Array"

24490

}

24491

],

24492

"return": {

24493

"description": "Route regex.",

24494

"type": "RegExp"

24495

},

24496

"access": "protected",

24497

"tagname": "",

24498

"class": "Router",

24499

"module": "app",

24500

"submodule": "router"

24501

},

24502

{

24503

"file": "app/js/router.js",

24504

"line": 684,

24505

"description": "Gets a request object that can be passed to a route handler.",

24506

"itemtype": "method",

24507

"name": "_getRequest",

24508

"params": [

24509

{

24510

"name": "path",

24511

"description": "Current path being dispatched.",

24512

"type": "String"

24513

},

24514

{

24515

"name": "url",

24516

"description": "Current full URL being dispatched.",

24517

"type": "String"

24518

},

24519

{

24520

"name": "src",

24521

"description": "What initiated the dispatch.",

24522

"type": "String"

24523

}

24524

],

24525

"return": {

24526

"description": "Request object.",

24527

"type": "Object"

24528

},

24529

"access": "protected",

24530

"tagname": "",

24531

"class": "Router",

24532

"module": "app",

24533

"submodule": "router"

24534

},

24535

{

24536

"file": "app/js/router.js",

24537

"line": 703,

24538

"description": "Gets a response object that can be passed to a route handler.",

24539

"itemtype": "method",

24540

"name": "_getResponse",

24541

"params": [

24542

{

24543

"name": "req",

24544

"description": "Request object.",

24545

"type": "Object"

24546

}

24547

],

24548

"return": {

24549

"description": "Response Object.",

24550

"type": "Object"

24551

},

24552

"access": "protected",

24553

"tagname": "",

24554

"class": "Router",

24555

"module": "app",

24556

"submodule": "router"

24557

},

24558

{

24559

"file": "app/js/router.js",

24560

"line": 722,

24561

"description": "Getter for the `routes` attribute.",

24562

"itemtype": "method",

24563

"name": "_getRoutes",

24564

"return": {

24565

"description": "Array of route objects.",

24566

"type": "Object[]"

24567

},

24568

"access": "protected",

24569

"tagname": "",

24570

"class": "Router",

24571

"module": "app",

24572

"submodule": "router"

24573

},

24574

{

24575

"file": "app/js/router.js",

24576

"line": 733,

24577

"description": "Gets the current full URL.",

24578

"itemtype": "method",

24579

"name": "_getURL",

24580

"return": {

24581

"description": "URL.",

24582

"type": "String"

24583

},

24584

"access": "protected",

24585

"tagname": "",

24586

"class": "Router",

24587

"module": "app",

24588

"submodule": "router"

24589

},

24590

{

24591

"file": "app/js/router.js",

24592

"line": 744,

24593

"description": "Returns `true` when the specified `url` is from the same origin as the\ncurrent URL; i.e., the protocol, host, and port of the URLs are the same.\n\nAll host or path relative URLs are of the same origin. A scheme-relative URL\nis first prefixed with the current scheme before being evaluated.",

24594

"itemtype": "method",

24595

"name": "_hasSameOrigin",

24596

"params": [

24597

{

24598

"name": "url",

24599

"description": "URL to compare origin with the current URL.",

24600

"type": "String"

24601

}

24602

],

24603

"return": {

24604

"description": "Whether the URL has the same origin of the current URL.",

24605

"type": "Boolean"

24606

},

24607

"access": "protected",

24608

"tagname": "",

24609

"class": "Router",

24610

"module": "app",

24611

"submodule": "router"

24612

},

24613

{

24614

"file": "app/js/router.js",

24615

"line": 767,

24616

"description": "Joins the `root` URL to the specified _url_, normalizing leading/trailing\n`/` characters.",

24617

"example": [

24618

"\n router.set('root', '/foo');\n router._joinURL('bar'); // => '/foo/bar'\n router._joinURL('/bar'); // => '/foo/bar'\n\n router.set('root', '/foo/');\n router._joinURL('bar'); // => '/foo/bar'\n router._joinURL('/bar'); // => '/foo/bar'"

24619

],

24620

"itemtype": "method",

24621

"name": "_joinURL",

24622

"params": [

24623

{

24624

"name": "url",

24625

"description": "URL to append to the `root` URL.",

24626

"type": "String"

24627

}

24628

],

24629

"return": {

24630

"description": "Joined URL.",

24631

"type": "String"

24632

},

24633

"access": "protected",

24634

"tagname": "",

24635

"class": "Router",

24636

"module": "app",

24637

"submodule": "router"

24638

},

24639

{

24640

"file": "app/js/router.js",

24641

"line": 799,

24642

"description": "Parses a URL query string into a key/value hash. If `Y.QueryString.parse` is\navailable, this method will be an alias to that.",

24643

"itemtype": "method",

24644

"name": "_parseQuery",

24645

"params": [

24646

{

24647

"name": "query",

24648

"description": "Query string to parse.",

24649

"type": "String"

24650

}

24651

],

24652

"return": {

24653

"description": "Hash of key/value pairs for query parameters.",

24654

"type": "Object"

24655

},

24656

"access": "protected",

24657

"tagname": "",

24658

"class": "Router",

24659

"module": "app",

24660

"submodule": "router"

24661

},

24662

{

24663

"file": "app/js/router.js",

24664

"line": 827,

24665

"description": "Queues up a `_save()` call to run after all previously-queued calls have\nfinished.\n\nThis is necessary because if we make multiple `_save()` calls before the\nfirst call gets dispatched, then both calls will dispatch to the last call's\nURL.\n\nAll arguments passed to `_queue()` will be passed on to `_save()` when the\nqueued function is executed.",

24666

"itemtype": "method",

24667

"name": "_queue",

24668

"chainable": 1,

24669

"see": [

24670

"_dequeue"

24671

],

24672

"access": "protected",

24673

"tagname": "",

24674

"class": "Router",

24675

"module": "app",

24676

"submodule": "router"

24677

},

24678

{

24679

"file": "app/js/router.js",

24680

"line": 872,

24681

"description": "Saves a history entry using either `pushState()` or the location hash.\n\nThis method enforces the same-origin security constraint; attempting to save\na `url` that is not from the same origin as the current URL will result in\nan error.",

24682

"itemtype": "method",

24683

"name": "_save",

24684

"params": [

24685

{

24686

"name": "url",

24687

"description": "URL for the history entry.",

24688

"type": "String",

24689

"optional": true

24690

},

24691

{

24692

"name": "replace",

24693

"description": "If `true`, the current history entry will\n be replaced instead of a new one being added.",

24694

"type": "Boolean",

24695

"optional": true,

24696

"optdefault": "false"

24697

}

24698

],

24699

"chainable": 1,

24700

"access": "protected",

24701

"tagname": "",

24702

"class": "Router",

24703

"module": "app",

24704

"submodule": "router"

24705

},

24706

{

24707

"file": "app/js/router.js",

24708

"line": 920,

24709

"description": "Setter for the `routes` attribute.",

24710

"itemtype": "method",

24711

"name": "_setRoutes",

24712

"params": [

24713

{

24714

"name": "routes",

24715

"description": "Array of route objects.",

24716

"type": "Object[]"

24717

}

24718

],

24719

"return": {

24720

"description": "Array of route objects.",

24721

"type": "Object[]"

24722

},

24723

"access": "protected",

24724

"tagname": "",

24725

"class": "Router",

24726

"module": "app",

24727

"submodule": "router"

24728

},

24729

{

24730

"file": "app/js/router.js",

24731

"line": 940,

24732

"description": "Handles `history:change` and `hashchange` events.",

24733

"itemtype": "method",

24734

"name": "_afterHistoryChange",

24735

"params": [

24736

{

24737

"name": "e",

24738

"description": "",

24739

"type": "EventFacade"

24740

}

24741

],

24742

"access": "protected",

24743

"tagname": "",

24744

"class": "Router",

24745

"module": "app",

24746

"submodule": "router"

24747

},

24748

{

24749

"file": "app/js/router.js",

24750

"line": 971,

24751

"description": "Default handler for the `ready` event.",

24752

"itemtype": "method",

24753

"name": "_defReadyFn",

24754

"params": [

24755

{

24756

"name": "e",

24757

"description": "",

24758

"type": "EventFacade"

24759

}

24760

],

24761

"access": "protected",

24762

"tagname": "",

24763

"class": "Router",

24764

"module": "app",

24765

"submodule": "router"

24766

},

24767

{

24768

"file": "app/js/router.js",

24769

"line": 986,

24770

"description": "Whether or not this browser is capable of using HTML5 history.\n\nSetting this to `false` will force the use of hash-based history even on\nHTML5 browsers, but please don't do this unless you understand the\nconsequences.",

24771

"itemtype": "attribute",

24772

"name": "html5",

24773

"type": "Boolean",

24774

"initonly": "",

24775

"class": "Router",

24776

"module": "app",

24777

"submodule": "router"

24778

},

24779

{

24780

"file": "app/js/router.js",

24781

"line": 1007,

24782

"description": "Absolute root path from which all routes should be evaluated.\n\nFor example, if your router is running on a page at\n`http://example.com/myapp/` and you add a route with the path `/`, your\nroute will never execute, because the path will always be preceded by\n`/myapp`. Setting `root` to `/myapp` would cause all routes to be\nevaluated relative to that root URL, so the `/` route would then execute\nwhen the user browses to `http://example.com/myapp/`.",

24783

"itemtype": "attribute",

24784

"name": "root",

24785

"type": "String",

24786

"default": "`''`",

24787

"class": "Router",

24788

"module": "app",

24789

"submodule": "router"

24790

},

24791

{

24792

"file": "app/js/router.js",

24793

"line": 1025,

24794

"description": "Array of route objects.\n\nEach item in the array must be an object with the following properties:\n\n * `path`: String or regex representing the path to match. See the docs\n for the `route()` method for more details.\n\n * `callback`: Function or a string representing the name of a function\n on this router instance that should be called when the route is\n triggered. See the docs for the `route()` method for more details.\n\nThis attribute is intended to be used to set routes at init time, or to\ncompletely reset all routes after init. To add routes after init without\nresetting all existing routes, use the `route()` method.",

24795

"itemtype": "attribute",

24796

"name": "routes",

24797

"type": "Object[]",

24798

"default": "`[]`",

24799

"see": [

24800

"route"

24801

],

24802

"class": "Router",

24803

"module": "app",

24804

"submodule": "router"

24805

},

24806

{

24807

"file": "app/js/view.js",

24808

"line": 40,

24809

"description": "Template for this view's container.",

24810

"itemtype": "property",

24811

"name": "containerTemplate",

24812

"type": "String",

24813

"default": "\"<div/>\"",

24814

"since": "3.5.0",

24815

"class": "View",

24816

"module": "app",

24817

"submodule": "view"

24818

},

24819

{

24820

"file": "app/js/view.js",

24821

"line": 50,

24822

"description": "Hash of CSS selectors mapped to events to delegate to elements matching\nthose selectors.\n\nCSS selectors are relative to the `container` element. Events are attached\nto the container, and delegation is used so that subscribers are only\nnotified of events that occur on elements inside the container that match\nthe specified selectors. This allows the container's contents to be re-\nrendered as needed without losing event subscriptions.\n\nEvent handlers can be specified either as functions or as strings that map\nto function names on this view instance or its prototype.\n\nThe `this` object in event handlers will refer to this view instance. If\nyou'd prefer `this` to be something else, use `Y.bind()` to bind a custom\n`this` object.",

24823

"example": [

24824

"\n\n var view = new Y.View({\n events: {\n // Call `this.toggle()` whenever the element with the id\n // \"toggle-button\" is clicked.\n '#toggle-button': {click: 'toggle'},\n\n // Call `this.hoverOn()` when the mouse moves over any element\n // with the \"hoverable\" class, and `this.hoverOff()` when the\n // mouse moves out of any element with the \"hoverable\" class.\n '.hoverable': {\n mouseover: 'hoverOn',\n mouseout : 'hoverOff'\n }\n }\n });"

24825

],

24826

"itemtype": "property",

24827

"name": "events",

24828

"type": "Object",

24829

"default": "{}",

24830

"class": "View",

24831

"module": "app",

24832

"submodule": "view"

24833

},

24834

{

24835

"file": "app/js/view.js",

24836

"line": 91,

24837

"description": "Template for this view's contents.\n\nThis is a convenience property that has no default behavior of its own.\nIt's only provided as a convention to allow you to store whatever you\nconsider to be a template, whether that's an HTML string, a `Y.Node`\ninstance, a Mustache template, or anything else your little heart\ndesires.\n\nHow this template gets used is entirely up to you and your custom\n`render()` method.",

24838

"itemtype": "property",

24839

"name": "template",

24840

"type": "mixed",

24841

"default": "''",

24842

"class": "View",

24843

"module": "app",

24844

"submodule": "view"

24845

},

24846

{

24847

"file": "app/js/view.js",

24848

"line": 111,

24849

"description": "This tells `Y.Base` that it should create ad-hoc attributes for config\nproperties passed to View's constructor. This makes it possible to\ninstantiate a view and set a bunch of attributes without having to subclass\n`Y.View` and declare all those attributes first.",

24850

"itemtype": "property",

24851

"name": "_allowAdHocAttrs",

24852

"type": "Boolean",

24853

"default": "true",

24854

"access": "protected",

24855

"tagname": "",

24856

"since": "3.5.0",

24857

"class": "View",

24858

"module": "app",

24859

"submodule": "view"

24860

},

24861

{

24862

"file": "app/js/view.js",

24863

"line": 146,

24864

"description": "Destroys this View, detaching any DOM events and optionally also destroying\nits container node.\n\nBy default, the container node will not be destroyed. Pass an _options_\nobject with a truthy `remove` property to destroy the container as well.",

24865

"itemtype": "method",

24866

"name": "destroy",

24867

"params": [

24868

{

24869

"name": "options",

24870

"description": "Options.",

24871

"type": "Object",

24872

"optional": true,

24873

"props": [

24874

{

24875

"name": "remove",

24876

"description": "If `true`, this View's container\n will be removed from the DOM and destroyed as well.",

24877

"type": "Boolean",

24878

"optional": true,

24879

"optdefault": "false"

24880

}

24881

]

24882

}

24883

],

24884

"chainable": 1,

24885

"class": "View",

24886

"module": "app",

24887

"submodule": "view"

24888

},

24889

{

24890

"file": "app/js/view.js",

24891

"line": 181,

24892

"description": "Attaches delegated event handlers to this view's container element. This\nmethod is called internally to subscribe to events configured in the\n`events` attribute when the view is initialized.\n\nYou may override this method to customize the event attaching logic.",

24893

"itemtype": "method",

24894

"name": "attachEvents",

24895

"params": [

24896

{

24897

"name": "events",

24898

"description": "Hash of events to attach. See the docs for the\n `events` attribute for details on the format. If not specified, this\n view's `events` property will be used.",

24899

"type": "Object",

24900

"optional": true

24901

}

24902

],

24903

"chainable": 1,

24904

"see": [

24905

"detachEvents"

24906

],

24907

"class": "View",

24908

"module": "app",

24909

"submodule": "view"

24910

},

24911

{

24912

"file": "app/js/view.js",

24913

"line": 226,

24914

"description": "Creates and returns a container node for this view.\n\nBy default, the container is created from the HTML template specified in the\n`containerTemplate` property, and is _not_ added to the DOM automatically.\n\nYou may override this method to customize how the container node is created\n(such as by rendering it from a custom template format). Your method must\nreturn a `Y.Node` instance.",

24915

"itemtype": "method",

24916

"name": "create",

24917

"params": [

24918

{

24919

"name": "container",

24920

"description": "Selector string, `Y.Node`\n instance, or DOM element to use at the container node.",

24921

"type": "HTMLElement|Node|String",

24922

"optional": true

24923

}

24924

],

24925

"return": {

24926

"description": "Node instance of the created container node.",

24927

"type": "Node"

24928

},

24929

"class": "View",

24930

"module": "app",

24931

"submodule": "view"

24932

},

24933

{

24934

"file": "app/js/view.js",

24935

"line": 246,

24936

"description": "Detaches DOM events that have previously been attached to the container by\n`attachEvents()`.",

24937

"itemtype": "method",

24938

"name": "detachEvents",

24939

"chainable": 1,

24940

"see": [

24941

"attachEvents"

24942

],

24943

"class": "View",

24944

"module": "app",

24945

"submodule": "view"

24946

},

24947

{

24948

"file": "app/js/view.js",

24949

"line": 263,

24950

"description": "Removes this view's container element from the DOM (if it's in the DOM),\nbut doesn't destroy it or any event listeners attached to it.",

24951

"itemtype": "method",

24952

"name": "remove",

24953

"chainable": 1,

24954

"class": "View",

24955

"module": "app",

24956

"submodule": "view"

24957

},

24958

{

24959

"file": "app/js/view.js",

24960

"line": 276,

24961

"description": "Renders this view.\n\nThis method is a noop by default. Override it to provide a custom\nimplementation that renders this view's content and appends it to the\ncontainer element. Ideally your `render` method should also return `this` as\nthe end to allow chaining, but that's up to you.\n\nSince there's no default renderer, you're free to render your view however\nyou see fit, whether that means manipulating the DOM directly, dumping\nstrings into `innerHTML`, or using a template language of some kind.\n\nFor basic templating needs, `Y.Node.create()` and `Y.Lang.sub()` may\nsuffice, but there are no restrictions on what tools or techniques you can\nuse to render your view. All you need to do is append something to the\ncontainer element at some point, and optionally append the container\nto the DOM if it's not there already.",

24962

"itemtype": "method",

24963

"name": "render",

24964

"chainable": 1,

24965

"class": "View",

24966

"module": "app",

24967

"submodule": "view"

24968

},

24969

{

24970

"file": "app/js/view.js",

24971

"line": 303,

24972

"description": "Removes the `container` from the DOM and purges all its event listeners.",

24973

"itemtype": "method",

24974

"name": "_destroyContainer",

24975

"access": "protected",

24976

"tagname": "",

24977

"class": "View",

24978

"module": "app",

24979

"submodule": "view"

24980

},

24981

{

24982

"file": "app/js/view.js",

24983

"line": 314,

24984

"description": "Getter for the `container` attribute.",

24985

"itemtype": "method",

24986

"name": "_getContainer",

24987

"params": [

24988

{

24989

"name": "value",

24990

"description": "Current attribute value.",

24991

"type": "Node|null"

24992

}

24993

],

24994

"return": {

24995

"description": "Container node.",

24996

"type": "Node"

24997

},

24998

"access": "protected",

24999

"tagname": "",

25000

"since": "3.5.0",

25001

"class": "View",

25002

"module": "app",

25003

"submodule": "view"

25004

},

25005

{

25006

"file": "app/js/view.js",

25007

"line": 348,

25008

"description": "Handles `containerChange` events. Detaches event handlers from the old\ncontainer (if any) and attaches them to the new container.\n\nRight now the `container` attr is initOnly so this event should only ever\nfire the first time the container is created, but in the future (once Y.App\ncan handle it) we may allow runtime container changes.",

25009

"itemtype": "method",

25010

"name": "_afterContainerChange",

25011

"access": "protected",

25012

"tagname": "",

25013

"since": "3.5.0",

25014

"class": "View",

25015

"module": "app",

25016

"submodule": "view"

25017

},

25018

{

25019

"file": "app/js/view.js",

25020

"line": 367,

25021

"description": "Container node into which this view's content will be rendered.\n\nThe container node serves as the host for all DOM events attached by the\nview. Delegation is used to handle events on children of the container,\nallowing the container's contents to be re-rendered at any time without\nlosing event subscriptions.\n\nThe default container is a `<div>` Node, but you can override this in\na subclass, or by passing in a custom `container` config value at\ninstantiation time. If you override the default container in a subclass\nusing `ATTRS`, you must use the `valueFn` property. The view's constructor \nwill ignore any assignments using `value`.\n\nWhen `container` is overridden by a subclass or passed as a config\noption at instantiation time, you can provide it as a selector string, a\nDOM element, a `Y.Node` instance, or (if you are subclassing and modifying\nthe attribute), a `valueFn` function that returns a `Y.Node` instance. \nThe value will be converted into a `Y.Node` instance if it isn't one \nalready.\n\nThe container is not added to the page automatically. This allows you to\nhave full control over how and when your view is actually rendered to\nthe page.",

25022

"itemtype": "attribute",

25023

"name": "container",

25024

"type": "HTMLElement|Node|String",

25025

"default": "Y.Node.create(this.containerTemplate)",

25026

"writeonce": "",

25027

"class": "View",

25028

"module": "app",

25029

"submodule": "view"

25030

},

25031

{

25032

"file": "app/js/view.js",

25033

"line": 404,

25034

"description": "Properties that shouldn't be turned into ad-hoc attributes when passed to\nView's constructor.",

25035

"itemtype": "property",

25036

"name": "_NON_ATTRS_CFG",

25037

"type": "Array",

25038

"static": 1,

25039

"access": "protected",

25040

"tagname": "",

25041

"since": "3.5.0",

25042

"class": "View",

25043

"module": "app",

25044

"submodule": "view"

25045

},

25046

{

25047

"file": "arraysort/js/arraysort.js",

25048

"line": 19,

25049

"description": "Comparator function for simple case-insensitive sorting of an array of\nstrings.",

25050

"itemtype": "method",

25051

"name": "compare",

25052

"params": [

25053

{

25054

"name": "a",

25055

"description": "First sort argument.",

25056

"type": "Object"

25057

},

25058

{

25059

"name": "b",

25060

"description": "Second sort argument.",

25061

"type": "Object"

25062

},

25063

{

25064

"name": "desc",

25065

"description": "`true` if sort direction is descending, `false` if\n sort direction is ascending.",

25066

"type": "Boolean"

25067

}

25068

],

25069

"return": {

25070

"description": "-1 when a < b. 0 when a == b. 1 when a > b.",

25071

"type": "Boolean"

25072

},

25073

"class": "ArraySort",

25074

"module": "arraysort"

25075

},

25076

{

25077

"file": "async-queue/js/async-queue.js",

25078

"line": 53,

25079

"description": "Static default values used to populate callback configuration properties.\nPreconfigured defaults include:\n\n<ul>\n <li><code>autoContinue</code>: <code>true</code></li>\n <li><code>iterations</code>: 1</li>\n <li><code>timeout</code>: 10 (10ms between callbacks)</li>\n <li><code>until</code>: (function to run until iterations <= 0)</li>\n</ul>",

25080

"itemtype": "property",

25081

"name": "defaults",

25082

"type": "{Object}",

25083

"static": 1,

25084

"class": "AsyncQueue",

25085

"module": "async-queue"

25086

},

25087

{

25088

"file": "async-queue/js/async-queue.js",

25089

"line": 79,

25090

"description": "Used to indicate the queue is currently executing a callback.",

25091

"itemtype": "property",

25092

"name": "_running",

25093

"type": "{Boolean|Object} true for synchronous callback execution, the\n return handle from Y.later for async callbacks.\n Otherwise false.",

25094

"access": "protected",

25095

"tagname": "",

25096

"class": "AsyncQueue",

25097

"module": "async-queue"

25098

},

25099

{

25100

"file": "async-queue/js/async-queue.js",

25101

"line": 90,

25102

"description": "Initializes the AsyncQueue instance properties and events.",

25103

"itemtype": "method",

25104

"name": "_init",

25105

"access": "protected",

25106

"tagname": "",

25107

"class": "AsyncQueue",

25108

"module": "async-queue"

25109

},

25110

{

25111

"file": "async-queue/js/async-queue.js",

25112

"line": 101,

25113

"description": "Callback defaults for this instance. Static defaults that are not\noverridden are also included.",

25114

"itemtype": "property",

25115

"name": "defaults",

25116

"type": "{Object}",

25117

"class": "AsyncQueue",

25118

"module": "async-queue"

25119

},

25120

{

25121

"file": "async-queue/js/async-queue.js",

25122

"line": 113,

25123

"description": "Initializes the instance events.",

25124

"itemtype": "method",

25125

"name": "_initEvents",

25126

"access": "protected",

25127

"tagname": "",

25128

"class": "AsyncQueue",

25129

"module": "async-queue"

25130

},

25131

{

25132

"file": "async-queue/js/async-queue.js",

25133

"line": 129,

25134

"description": "Returns the next callback needing execution. If a callback is\nconfigured to repeat via iterations or until, it will be returned until\nthe completion criteria is met.\n\nWhen the queue is empty, null is returned.",

25135

"itemtype": "method",

25136

"name": "next",

25137

"return": {

25138

"description": "the callback to execute",

25139

"type": "Function"

25140

},

25141

"class": "AsyncQueue",

25142

"module": "async-queue"

25143

},

25144

{

25145

"file": "async-queue/js/async-queue.js",

25146

"line": 155,

25147

"description": "Default functionality for the "shift" event. Shifts the\ncallback stored in the event object's callback property from\nthe queue if it is the first item.",

25148

"itemtype": "method",

25149

"name": "_defShiftFn",

25150

"params": [

25151

{

25152

"name": "e",

25153

"description": "The event object",

25154

"type": "Event"

25155

}

25156

],

25157

"access": "protected",

25158

"tagname": "",

25159

"class": "AsyncQueue",

25160

"module": "async-queue"

25161

},

25162

{

25163

"file": "async-queue/js/async-queue.js",

25164

"line": 170,

25165

"description": "Creates a wrapper function to execute the callback using the aggregated \nconfiguration generated by combining the static AsyncQueue.defaults, the\ninstance defaults, and the specified callback settings.\n\nThe wrapper function is decorated with the callback configuration as\nproperties for runtime modification.",

25166

"itemtype": "method",

25167

"name": "_prepare",

25168

"params": [

25169

{

25170

"name": "callback",

25171

"description": "the raw callback",

25172

"type": "Object|Function"

25173

}

25174

],

25175

"return": {

25176

"description": "a decorated function wrapper to execute the callback",

25177

"type": "Function"

25178

},

25179

"access": "protected",

25180

"tagname": "",

25181

"class": "AsyncQueue",

25182

"module": "async-queue"

25183

},

25184

{

25185

"file": "async-queue/js/async-queue.js",

25186

"line": 207,

25187

"description": "Sets the queue in motion. All queued callbacks will be executed in\norder unless pause() or stop() is called or if one of the callbacks is\nconfigured with autoContinue: false.",

25188

"itemtype": "method",

25189

"name": "run",

25190

"return": {

25191

"description": "the AsyncQueue instance",

25192

"type": "AsyncQueue"

25193

},

25194

"chainable": 1,

25195

"class": "AsyncQueue",

25196

"module": "async-queue"

25197

},

25198

{

25199

"file": "async-queue/js/async-queue.js",

25200

"line": 230,

25201

"description": "Event fired after the last queued callback is executed.",

25202

"itemtype": "event",

25203

"name": "complete",

25204

"class": "AsyncQueue",

25205

"module": "async-queue"

25206

},

25207

{

25208

"file": "async-queue/js/async-queue.js",

25209

"line": 240,

25210

"description": "Handles the execution of callbacks. Returns a boolean indicating\nwhether it is appropriate to continue running.",

25211

"itemtype": "method",

25212

"name": "_execute",

25213

"params": [

25214

{

25215

"name": "callback",

25216

"description": "the callback object to execute",

25217

"type": "Object"

25218

}

25219

],

25220

"return": {

25221

"description": "whether the run loop should continue",

25222

"type": "Boolean"

25223

},

25224

"access": "protected",

25225

"tagname": "",

25226

"class": "AsyncQueue",

25227

"module": "async-queue"

25228

},

25229

{

25230

"file": "async-queue/js/async-queue.js",

25231

"line": 262,

25232

"description": "Schedules the execution of asynchronous callbacks.",

25233

"itemtype": "method",

25234

"name": "_schedule",

25235

"params": [

25236

{

25237

"name": "callback",

25238

"description": "the callback object to execute",

25239

"type": "Object"

25240

}

25241

],

25242

"return": {

25243

"description": "whether the run loop should continue",

25244

"type": "Boolean"

25245

},

25246

"access": "protected",

25247

"tagname": "",

25248

"class": "AsyncQueue",

25249

"module": "async-queue"

25250

},

25251

{

25252

"file": "async-queue/js/async-queue.js",

25253

"line": 280,

25254

"description": "Determines if the queue is waiting for a callback to complete execution.",

25255

"itemtype": "method",

25256

"name": "isRunning",

25257

"return": {

25258

"description": "true if queue is waiting for a \n from any initiated transactions",

25259

"type": "Boolean"

25260

},

25261

"class": "AsyncQueue",

25262

"module": "async-queue"

25263

},

25264

{

25265

"file": "async-queue/js/async-queue.js",

25266

"line": 291,

25267

"description": "Default functionality for the "execute" event. Executes the\ncallback function",

25268

"itemtype": "method",

25269

"name": "_defExecFn",

25270

"params": [

25271

{

25272

"name": "e",

25273

"description": "the event object",

25274

"type": "Event"

25275

}

25276

],

25277

"access": "protected",

25278

"tagname": "",

25279

"class": "AsyncQueue",

25280

"module": "async-queue"

25281

},

25282

{

25283

"file": "async-queue/js/async-queue.js",

25284

"line": 303,

25285

"description": "Add any number of callbacks to the end of the queue. Callbacks may be\nprovided as functions or objects.",

25286

"itemtype": "method",

25287

"name": "add",

25288

"params": [

25289

{

25290

"name": "callback",

25291

"description": "0..n callbacks",

25292

"type": "Function|Object",

25293

"multiple": true

25294

}

25295

],

25296

"return": {

25297

"description": "the AsyncQueue instance",

25298

"type": "AsyncQueue"

25299

},

25300

"chainable": 1,

25301

"class": "AsyncQueue",

25302

"module": "async-queue"

25303

},

25304

{

25305

"file": "async-queue/js/async-queue.js",

25306

"line": 318,

25307

"description": "Default functionality for the "add" event. Adds the callbacks\nin the event facade to the queue. Callbacks successfully added to the\nqueue are present in the event's <code>added</code> property in the\nafter phase.",

25308

"itemtype": "method",

25309

"name": "_defAddFn",

25310

"params": [

25311

{

25312

"name": "e",

25313

"description": "the event object",

25314

"type": "Event"

25315

}

25316

],

25317

"access": "protected",

25318

"tagname": "",

25319

"class": "AsyncQueue",

25320

"module": "async-queue"

25321

},

25322

{

25323

"file": "async-queue/js/async-queue.js",

25324

"line": 342,

25325

"description": "Pause the execution of the queue after the execution of the current\ncallback completes. If called from code outside of a queued callback,\nclears the timeout for the pending callback. Paused queue can be\nrestarted with q.run()",

25326

"itemtype": "method",

25327

"name": "pause",

25328

"return": {

25329

"description": "the AsyncQueue instance",

25330

"type": "AsyncQueue"

25331

},

25332

"chainable": 1,

25333

"class": "AsyncQueue",

25334

"module": "async-queue"

25335

},

25336

{

25337

"file": "async-queue/js/async-queue.js",

25338

"line": 362,

25339

"description": "Stop and clear the queue after the current execution of the\ncurrent callback completes.",

25340

"itemtype": "method",

25341

"name": "stop",

25342

"return": {

25343

"description": "the AsyncQueue instance",

25344

"type": "AsyncQueue"

25345

},

25346

"chainable": 1,

25347

"class": "AsyncQueue",

25348

"module": "async-queue"

25349

},

25350

{

25351

"file": "async-queue/js/async-queue.js",

25352

"line": 376,

25353

"description": "Returns the current index of a callback. Pass in either the id or\ncallback function from getCallback.",

25354

"itemtype": "method",

25355

"name": "indexOf",

25356

"params": [

25357

{

25358

"name": "callback",

25359

"description": "the callback or its specified id",

25360

"type": "String|Function"

25361

}

25362

],

25363

"return": {

25364

"description": "index of the callback or -1 if not found",

25365

"type": "Number"

25366

},

25367

"class": "AsyncQueue",

25368

"module": "async-queue"

25369

},

25370

{

25371

"file": "async-queue/js/async-queue.js",

25372

"line": 397,

25373

"description": "Retrieve a callback by its id. Useful to modify the configuration\nwhile the queue is running.",

25374

"itemtype": "method",

25375

"name": "getCallback",

25376

"params": [

25377

{

25378

"name": "id",

25379

"description": "the id assigned to the callback",

25380

"type": "String"

25381

}

25382

],

25383

"return": {

25384

"description": "the callback object",

25385

"type": "Object"

25386

},

25387

"class": "AsyncQueue",

25388

"module": "async-queue"

25389

},

25390

{

25391

"file": "async-queue/js/async-queue.js",

25392

"line": 411,

25393

"description": "Promotes the named callback to the top of the queue. If a callback is\ncurrently executing or looping (via until or iterations), the promotion\nis scheduled to occur after the current callback has completed.",

25394

"itemtype": "method",

25395

"name": "promote",

25396

"params": [

25397

{

25398

"name": "callback",

25399

"description": "the callback object or a callback's id",

25400

"type": "String|Object"

25401

}

25402

],

25403

"return": {

25404

"description": "the AsyncQueue instance",

25405

"type": "AsyncQueue"

25406

},

25407

"chainable": 1,

25408

"class": "AsyncQueue",

25409

"module": "async-queue"

25410

},

25411

{

25412

"file": "async-queue/js/async-queue.js",

25413

"line": 436,

25414

"description": "Default functionality for the "promote" event. Promotes the\nnamed callback to the head of the queue.\n\nThe event object will contain a property "callback", which\nholds the id of a callback or the callback object itself.",

25415

"itemtype": "method",

25416

"name": "_defPromoteFn",

25417

"params": [

25418

{

25419

"name": "e",

25420

"description": "the custom event",

25421

"type": "Event"

25422

}

25423

],

25424

"access": "protected",

25425

"tagname": "",

25426

"class": "AsyncQueue",

25427

"module": "async-queue"

25428

},

25429

{

25430

"file": "async-queue/js/async-queue.js",

25431

"line": 458,

25432

"description": "Removes the callback from the queue. If the queue is active, the\nremoval is scheduled to occur after the current callback has completed.",

25433

"itemtype": "method",

25434

"name": "remove",

25435

"params": [

25436

{

25437

"name": "callback",

25438

"description": "the callback object or a callback's id",

25439

"type": "String|Object"

25440

}

25441

],

25442

"return": {

25443

"description": "the AsyncQueue instance",

25444

"type": "AsyncQueue"

25445

},

25446

"chainable": 1,

25447

"class": "AsyncQueue",

25448

"module": "async-queue"

25449

},

25450

{

25451

"file": "async-queue/js/async-queue.js",

25452

"line": 484,

25453

"description": "Default functionality for the "remove" event. Removes the\ncallback from the queue.\n\nThe event object will contain a property "callback", which\nholds the id of a callback or the callback object itself.",

25454

"itemtype": "method",

25455

"name": "_defRemoveFn",

25456

"params": [

25457

{

25458

"name": "e",

25459

"description": "the custom event",

25460

"type": "Event"

25461

}

25462

],

25463

"access": "protected",

25464

"tagname": "",

25465

"class": "AsyncQueue",

25466

"module": "async-queue"

25467

},

25468

{

25469

"file": "async-queue/js/async-queue.js",

25470

"line": 501,

25471

"description": "Returns the number of callbacks in the queue.",

25472

"itemtype": "method",

25473

"name": "size",

25474

"return": {

25475

"description": "",

25476

"type": "Number"

25477

},

25478

"class": "AsyncQueue",

25479

"module": "async-queue"

25480

},

25481

{

25482

"file": "attribute/js/Attribute.js",

25483

"line": 72,

25484

"description": "The value to return from an attribute setter in order to prevent the set from going through.\n\nYou can return this value from your setter if you wish to combine validator and setter \nfunctionality into a single setter function, which either returns the massaged value to be stored or \nAttributeCore.INVALID_VALUE to prevent invalid values from being stored.",

25485

"itemtype": "property",

25486

"name": "INVALID_VALUE",

25487

"type": "Object",

25488

"static": 1,

25489

"final": 1,

25490

"class": "Attribute",

25491

"module": "attribute",

25492

"submodule": "attribute-base"

25493

},

25494

{

25495

"file": "attribute/js/Attribute.js",

25496

"line": 86,

25497

"description": "The list of properties which can be configured for \neach attribute (e.g. setter, getter, writeOnce etc.).\n\nThis property is used internally as a whitelist for faster\nY.mix operations.",

25498

"itemtype": "property",

25499

"name": "_ATTR_CFG",

25500

"type": "Array",

25501

"static": 1,

25502

"access": "protected",

25503

"tagname": "",

25504

"class": "Attribute",

25505

"module": "attribute",

25506

"submodule": "attribute-base"

25507

},

25508

{

25509

"file": "attribute/js/AttributeCore.js",

25510

"line": 78,

25511

"description": "The value to return from an attribute setter in order to prevent the set from going through.\n\nYou can return this value from your setter if you wish to combine validator and setter \nfunctionality into a single setter function, which either returns the massaged value to be stored or \nAttributeCore.INVALID_VALUE to prevent invalid values from being stored.",

25512

"itemtype": "property",

25513

"name": "INVALID_VALUE",

25514

"type": "Object",

25515

"static": 1,

25516

"final": 1,

25517

"class": "AttributeCore",

25518

"module": "attribute",

25519

"submodule": "attribute-core"

25520

},

25521

{

25522

"file": "attribute/js/AttributeCore.js",

25523

"line": 93,

25524

"description": "The list of properties which can be configured for \neach attribute (e.g. setter, getter, writeOnce etc.).\n\nThis property is used internally as a whitelist for faster\nY.mix operations.",

25525

"itemtype": "property",

25526

"name": "_ATTR_CFG",

25527

"type": "Array",

25528

"static": 1,

25529

"access": "protected",

25530

"tagname": "",

25531

"class": "AttributeCore",

25532

"module": "attribute",

25533

"submodule": "attribute-core"

25534

},

25535

{

25536

"file": "attribute/js/AttributeCore.js",

25537

"line": 109,

25538

"description": "Constructor logic for attributes. Initializes the host state, and sets up the inital attributes passed to the \nconstructor.",

25539

"itemtype": "method",

25540

"name": "_initAttrHost",

25541

"params": [

25542

{

25543

"name": "attrs",

25544

"description": "The attributes to add during construction (passed through to <a href=\"#method_addAttrs\">addAttrs</a>). These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor.",

25545

"type": "Object"

25546

},

25547

{

25548

"name": "values",

25549

"description": "The initial attribute values to apply (passed through to <a href=\"#method_addAttrs\">addAttrs</a>). These are not merged/cloned. The caller is responsible for isolating user provided values if required.",

25550

"type": "Object"

25551

},

25552

{

25553

"name": "lazy",

25554

"description": "Whether or not to add attributes lazily (passed through to <a href=\"#method_addAttrs\">addAttrs</a>).",

25555

"type": "Boolean"

25556

}

25557

],

25558

"access": "private",

25559

"tagname": "",

25560

"class": "AttributeCore",

25561

"module": "attribute",

25562

"submodule": "attribute-core"

25563

},

25564

{

25565

"file": "attribute/js/AttributeCore.js",

25566

"line": 124,

25567

"description": "\nAdds an attribute with the provided configuration to the host object.\n\n\nThe config argument object supports the following properties:\n\n\n<dl>\n <dt>value <Any></dt>\n <dd>The initial value to set on the attribute</dd>\n\n <dt>valueFn <Function | String></dt>\n <dd>\n A function, which will return the initial value to set on the attribute. This is useful\n for cases where the attribute configuration is defined statically, but needs to \n reference the host instance (\"this\") to obtain an initial value. If both the value and valueFn properties are defined, \n the value returned by the valueFn has precedence over the value property, unless it returns undefined, in which \n case the value property is used.\n\n valueFn can also be set to a string, representing the name of the instance method to be used to retrieve the value.\n </dd>\n\n <dt>readOnly <boolean></dt>\n <dd>Whether or not the attribute is read only. Attributes having readOnly set to true\n cannot be modified by invoking the set method.</dd>\n\n <dt>writeOnce <boolean> or <string></dt>\n <dd>\n Whether or not the attribute is \"write once\". Attributes having writeOnce set to true, \n can only have their values set once, be it through the default configuration, \n constructor configuration arguments, or by invoking set.\n The writeOnce attribute can also be set to the string \"initOnly\", in which case the attribute can only be set during initialization\n (when used with Base, this means it can only be set during construction)\n </dd>\n\n <dt>setter <Function | String></dt>\n <dd>\n The setter function used to massage or normalize the value passed to the set method for the attribute. \n The value returned by the setter will be the final stored value. Returning\n <a href=\"#property_Attribute.INVALID_VALUE\">Attribute.INVALID_VALUE</a>, from the setter will prevent\n the value from being stored.\n \n \n setter can also be set to a string, representing the name of the instance method to be used as the setter function.\n </dd>\n \n <dt>getter <Function | String></dt>\n <dd>\n \n The getter function used to massage or normalize the value returned by the get method for the attribute.\n The value returned by the getter function is the value which will be returned to the user when they \n invoke get.\n \n\n getter can also be set to a string, representing the name of the instance method to be used as the getter function.\n </dd>\n\n <dt>validator <Function | String></dt>\n <dd>\n \n The validator function invoked prior to setting the stored value. Returning\n false from the validator function will prevent the value from being stored.\n \n \n validator can also be set to a string, representing the name of the instance method to be used as the validator function.\n </dd>\n\n <dt>lazyAdd <boolean></dt>\n <dd>Whether or not to delay initialization of the attribute until the first call to get/set it. \n This flag can be used to over-ride lazy initialization on a per attribute basis, when adding multiple attributes through \n the <a href=\"#method_addAttrs\">addAttrs</a> method.</dd>\n\n</dl>\n\nThe setter, getter and validator are invoked with the value and name passed in as the first and second arguments, and with\nthe context (\"this\") set to the host object.\n\nConfiguration properties outside of the list mentioned above are considered private properties used internally by attribute, \nand are not intended for public use.",

25568

"itemtype": "method",

25569

"name": "addAttr",

25570

"params": [

25571

{

25572

"name": "name",

25573

"description": "The name of the attribute.",

25574

"type": "String"

25575

},

25576

{

25577

"name": "config",

25578

"description": "An object with attribute configuration property/value pairs, specifying the configuration for the attribute.\n\n\nNOTE: The configuration object is modified when adding an attribute, so if you need \nto protect the original values, you will need to merge the object.\n",

25579

"type": "Object"

25580

},

25581

{

25582

"name": "lazy",

25583

"description": "(optional) Whether or not to add this attribute lazily (on the first call to get/set).",

25584

"type": "Boolean"

25585

}

25586

],

25587

"return": {

25588

"description": "A reference to the host object.",

25589

"type": "Object"

25590

},

25591

"chainable": 1,

25592

"class": "AttributeCore",

25593

"module": "attribute",

25594

"submodule": "attribute-core"

25595

},

25596

{

25597

"file": "attribute/js/AttributeCore.js",

25598

"line": 272,

25599

"description": "Checks if the given attribute has been added to the host",

25600

"itemtype": "method",

25601

"name": "attrAdded",

25602

"params": [

25603

{

25604

"name": "name",

25605

"description": "The name of the attribute to check.",

25606

"type": "String"

25607

}

25608

],

25609

"return": {

25610

"description": "true if an attribute with the given name has been added, false if it hasn't. This method will return true for lazily added attributes.",

25611

"type": "Boolean"

25612

},

25613

"class": "AttributeCore",

25614

"module": "attribute",

25615

"submodule": "attribute-core"

25616

},

25617

{

25618

"file": "attribute/js/AttributeCore.js",

25619

"line": 283,

25620

"description": "Returns the current value of the attribute. If the attribute\nhas been configured with a 'getter' function, this method will delegate\nto the 'getter' to obtain the value of the attribute.",

25621

"itemtype": "method",

25622

"name": "get",

25623

"params": [

25624

{

25625

"name": "name",

25626

"description": "The name of the attribute. If the value of the attribute is an Object, \ndot notation can be used to obtain the value of a property of the object (e.g. <code>get(\"x.y.z\")</code>)",

25627

"type": "String"

25628

}

25629

],

25630

"return": {

25631

"description": "The value of the attribute",

25632

"type": "Any"

25633

},

25634

"class": "AttributeCore",

25635

"module": "attribute",

25636

"submodule": "attribute-core"

25637

},

25638

{

25639

"file": "attribute/js/AttributeCore.js",

25640

"line": 299,

25641

"description": "Checks whether or not the attribute is one which has been\nadded lazily and still requires initialization.",

25642

"itemtype": "method",

25643

"name": "_isLazyAttr",

25644

"access": "private",

25645

"tagname": "",

25646

"params": [

25647

{

25648

"name": "name",

25649

"description": "The name of the attribute",

25650

"type": "String"

25651

}

25652

],

25653

"return": {

25654

"description": "true if it's a lazily added attribute, false otherwise.",

25655

"type": "Boolean"

25656

},

25657

"class": "AttributeCore",

25658

"module": "attribute",

25659

"submodule": "attribute-core"

25660

},

25661

{

25662

"file": "attribute/js/AttributeCore.js",

25663

"line": 312,

25664

"description": "Finishes initializing an attribute which has been lazily added.",

25665

"itemtype": "method",

25666

"name": "_addLazyAttr",

25667

"access": "private",

25668

"tagname": "",

25669

"params": [

25670

{

25671

"name": "name",

25672

"description": "The name of the attribute",

25673

"type": "Object"

25674

}

25675

],

25676

"class": "AttributeCore",

25677

"module": "attribute",

25678

"submodule": "attribute-core"

25679

},

25680

{

25681

"file": "attribute/js/AttributeCore.js",

25682

"line": 328,

25683

"description": "Sets the value of an attribute.",

25684

"itemtype": "method",

25685

"name": "set",

25686

"chainable": 1,

25687

"params": [

25688

{

25689

"name": "name",

25690

"description": "The name of the attribute. If the \ncurrent value of the attribute is an Object, dot notation can be used\nto set the value of a property within the object (e.g. <code>set(\"x.y.z\", 5)</code>).",

25691

"type": "String"

25692

},

25693

{

25694

"name": "value",

25695

"description": "The value to set the attribute to.",

25696

"type": "Any"

25697

}

25698

],

25699

"return": {

25700

"description": "A reference to the host object.",

25701

"type": "Object"

25702

},

25703

"class": "AttributeCore",

25704

"module": "attribute",

25705

"submodule": "attribute-core"

25706

},

25707

{

25708

"file": "attribute/js/AttributeCore.js",

25709

"line": 346,

25710

"description": "Allows setting of readOnly/writeOnce attributes. See <a href=\"#method_set\">set</a> for argument details.",

25711

"itemtype": "method",

25712

"name": "_set",

25713

"access": "protected",

25714

"tagname": "",

25715

"chainable": 1,

25716

"params": [

25717

{

25718

"name": "name",

25719

"description": "The name of the attribute.",

25720

"type": "String"

25721

},

25722

{

25723

"name": "val",

25724

"description": "The value to set the attribute to.",

25725

"type": "Any"

25726

}

25727

],

25728

"return": {

25729

"description": "A reference to the host object.",

25730

"type": "Object"

25731

},

25732

"class": "AttributeCore",

25733

"module": "attribute",

25734

"submodule": "attribute-core"

25735

},

25736

{

25737

"file": "attribute/js/AttributeCore.js",

25738

"line": 361,

25739

"description": "Provides the common implementation for the public set and protected _set methods.\n\nSee <a href=\"#method_set\">set</a> for argument details.",

25740

"itemtype": "method",

25741

"name": "_setAttr",

25742

"access": "protected",

25743

"tagname": "",

25744

"chainable": 1,

25745

"params": [

25746

{

25747

"name": "name",

25748

"description": "The name of the attribute.",

25749

"type": "String"

25750

},

25751

{

25752

"name": "value",

25753

"description": "The value to set the attribute to.",

25754

"type": "Any"

25755

},

25756

{

25757

"name": "opts",

25758

"description": "(Optional) Optional event data to be mixed into\nthe event facade passed to subscribers of the attribute's change event.\nThis is currently a hack. There's no real need for the AttributeCore implementation\nto support this parameter, but breaking it out into AttributeEvents, results in\nadditional function hops for the critical path. May change in 3.5.0 PR3.",

25759

"type": "Object"

25760

},

25761

{

25762

"name": "force",

25763

"description": "If true, allows the caller to set values for \nreadOnly or writeOnce attributes which have already been set.",

25764

"type": "Boolean"

25765

}

25766

],

25767

"return": {

25768

"description": "A reference to the host object.",

25769

"type": "Object"

25770

},

25771

"class": "AttributeCore",

25772

"module": "attribute",

25773

"submodule": "attribute-core"

25774

},

25775

{

25776

"file": "attribute/js/AttributeCore.js",

25777

"line": 468,

25778

"description": "Provides the common implementation for the public get method,\nallowing Attribute hosts to over-ride either method.\n\nSee <a href=\"#method_get\">get</a> for argument details.",

25779

"itemtype": "method",

25780

"name": "_getAttr",

25781

"access": "protected",

25782

"tagname": "",

25783

"chainable": 1,

25784

"params": [

25785

{

25786

"name": "name",

25787

"description": "The name of the attribute.",

25788

"type": "String"

25789

}

25790

],

25791

"return": {

25792

"description": "The value of the attribute.",

25793

"type": "Any"

25794

},

25795

"class": "AttributeCore",

25796

"module": "attribute",

25797

"submodule": "attribute-core"

25798

},

25799

{

25800

"file": "attribute/js/AttributeCore.js",

25801

"line": 522,

25802

"description": "Gets the stored value for the attribute, from either the \ninternal state object, or the state proxy if it exits",

25803

"itemtype": "method",

25804

"name": "_getStateVal",

25805

"access": "private",

25806

"tagname": "",

25807

"params": [

25808

{

25809

"name": "name",

25810

"description": "The name of the attribute",

25811

"type": "String"

25812

}

25813

],

25814

"return": {

25815

"description": "The stored value of the attribute",

25816

"type": "Any"

25817

},

25818

"class": "AttributeCore",

25819

"module": "attribute",

25820

"submodule": "attribute-core"

25821

},

25822

{

25823

"file": "attribute/js/AttributeCore.js",

25824

"line": 536,

25825

"description": "Sets the stored value for the attribute, in either the \ninternal state object, or the state proxy if it exits",

25826

"itemtype": "method",

25827

"name": "_setStateVal",

25828

"access": "private",

25829

"tagname": "",

25830

"params": [

25831

{

25832

"name": "name",

25833

"description": "The name of the attribute",

25834

"type": "String"

25835

},

25836

{

25837

"name": "value",

25838

"description": "The value of the attribute",

25839

"type": "Any"

25840

}

25841

],

25842

"class": "AttributeCore",

25843

"module": "attribute",

25844

"submodule": "attribute-core"

25845

},

25846

{

25847

"file": "attribute/js/AttributeCore.js",

25848

"line": 554,

25849

"description": "Updates the stored value of the attribute in the privately held State object,\nif validation and setter passes.",

25850

"itemtype": "method",

25851

"name": "_setAttrVal",

25852

"access": "private",

25853

"tagname": "",

25854

"params": [

25855

{

25856

"name": "attrName",

25857

"description": "The attribute name.",

25858

"type": "String"

25859

},

25860

{

25861

"name": "subAttrName",

25862

"description": "The sub-attribute name, if setting a sub-attribute property (\"x.y.z\").",

25863

"type": "String"

25864

},

25865

{

25866

"name": "prevVal",

25867

"description": "The currently stored value of the attribute.",

25868

"type": "Any"

25869

},

25870

{

25871

"name": "newVal",

25872

"description": "The value which is going to be stored.",

25873

"type": "Any"

25874

}

25875

],

25876

"return": {

25877

"description": "true if the new attribute value was stored, false if not.",

25878

"type": "Booolean"

25879

},

25880

"class": "AttributeCore",

25881

"module": "attribute",

25882

"submodule": "attribute-core"

25883

},

25884

{

25885

"file": "attribute/js/AttributeCore.js",

25886

"line": 635,

25887

"description": "Sets multiple attribute values.",

25888

"itemtype": "method",

25889

"name": "setAttrs",

25890

"params": [

25891

{

25892

"name": "attrs",

25893

"description": "An object with attributes name/value pairs.",

25894

"type": "Object"

25895

}

25896

],

25897

"return": {

25898

"description": "A reference to the host object.",

25899

"type": "Object"

25900

},

25901

"chainable": 1,

25902

"class": "AttributeCore",

25903

"module": "attribute",

25904

"submodule": "attribute-core"

25905

},

25906

{

25907

"file": "attribute/js/AttributeCore.js",

25908

"line": 647,

25909

"description": "Implementation behind the public setAttrs method, to set multiple attribute values.",

25910

"itemtype": "method",

25911

"name": "_setAttrs",

25912

"access": "protected",

25913

"tagname": "",

25914

"params": [

25915

{

25916

"name": "attrs",

25917

"description": "An object with attributes name/value pairs.",

25918

"type": "Object"

25919

}

25920

],

25921

"return": {

25922

"description": "A reference to the host object.",

25923

"type": "Object"

25924

},

25925

"chainable": 1,

25926

"class": "AttributeCore",

25927

"module": "attribute",

25928

"submodule": "attribute-core"

25929

},

25930

{

25931

"file": "attribute/js/AttributeCore.js",

25932

"line": 665,

25933

"description": "Gets multiple attribute values.",

25934

"itemtype": "method",

25935

"name": "getAttrs",

25936

"params": [

25937

{

25938

"name": "attrs",

25939

"description": "Optional. An array of attribute names. If omitted, all attribute values are\nreturned. If set to true, all attributes modified from their initial values are returned.",

25940

"type": "Array | boolean"

25941

}

25942

],

25943

"return": {

25944

"description": "An object with attribute name/value pairs.",

25945

"type": "Object"

25946

},

25947

"class": "AttributeCore",

25948

"module": "attribute",

25949

"submodule": "attribute-core"

25950

},

25951

{

25952

"file": "attribute/js/AttributeCore.js",

25953

"line": 677,

25954

"description": "Implementation behind the public getAttrs method, to get multiple attribute values.",

25955

"itemtype": "method",

25956

"name": "_getAttrs",

25957

"access": "protected",

25958

"tagname": "",

25959

"params": [

25960

{

25961

"name": "attrs",

25962

"description": "Optional. An array of attribute names. If omitted, all attribute values are\nreturned. If set to true, all attributes modified from their initial values are returned.",

25963

"type": "Array | boolean"

25964

}

25965

],

25966

"return": {

25967

"description": "An object with attribute name/value pairs.",

25968

"type": "Object"

25969

},

25970

"class": "AttributeCore",

25971

"module": "attribute",

25972

"submodule": "attribute-core"

25973

},

25974

{

25975

"file": "attribute/js/AttributeCore.js",

25976

"line": 708,

25977

"description": "Configures a group of attributes, and sets initial values.\n\n\nNOTE: This method does not isolate the configuration object by merging/cloning. \nThe caller is responsible for merging/cloning the configuration object if required.\n",

25978

"itemtype": "method",

25979

"name": "addAttrs",

25980

"chainable": 1,

25981

"params": [

25982

{

25983

"name": "cfgs",

25984

"description": "An object with attribute name/configuration pairs.",

25985

"type": "Object"

25986

},

25987

{

25988

"name": "values",

25989

"description": "An object with attribute name/value pairs, defining the initial values to apply.\nValues defined in the cfgs argument will be over-written by values in this argument unless defined as read only.",

25990

"type": "Object"

25991

},

25992

{

25993

"name": "lazy",

25994

"description": "Whether or not to delay the intialization of these attributes until the first call to get/set.\nIndividual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration.\nSee <a href=\"#method_addAttr\">addAttr</a>.",

25995

"type": "Boolean"

25996

}

25997

],

25998

"return": {

25999

"description": "A reference to the host object.",

26000

"type": "Object"

26001

},

26002

"class": "AttributeCore",

26003

"module": "attribute",

26004

"submodule": "attribute-core"

26005

},

26006

{

26007

"file": "attribute/js/AttributeCore.js",

26008

"line": 740,

26009

"description": "Implementation behind the public addAttrs method. \n\nThis method is invoked directly by get if it encounters a scenario \nin which an attribute's valueFn attempts to obtain the \nvalue an attribute in the same group of attributes, which has not yet \nbeen added (on demand initialization).",

26010

"itemtype": "method",

26011

"name": "_addAttrs",

26012

"access": "private",

26013

"tagname": "",

26014

"params": [

26015

{

26016

"name": "cfgs",

26017

"description": "An object with attribute name/configuration pairs.",

26018

"type": "Object"

26019

},

26020

{

26021

"name": "values",

26022

"description": "An object with attribute name/value pairs, defining the initial values to apply.\nValues defined in the cfgs argument will be over-written by values in this argument unless defined as read only.",

26023

"type": "Object"

26024

},

26025

{

26026

"name": "lazy",

26027

"description": "Whether or not to delay the intialization of these attributes until the first call to get/set.\nIndividual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration.\nSee <a href=\"#method_addAttr\">addAttr</a>.",

26028

"type": "Boolean"

26029

}

26030

],

26031

"class": "AttributeCore",

26032

"module": "attribute",

26033

"submodule": "attribute-core"

26034

},

26035

{

26036

"file": "attribute/js/AttributeCore.js",

26037

"line": 786,

26038

"description": "Utility method to protect an attribute configuration\nhash, by merging the entire object and the individual \nattr config objects.",

26039

"itemtype": "method",

26040

"name": "_protectAttrs",

26041

"access": "protected",

26042

"tagname": "",

26043

"params": [

26044

{

26045

"name": "attrs",

26046

"description": "A hash of attribute to configuration object pairs.",

26047

"type": "Object"

26048

}

26049

],

26050

"return": {

26051

"description": "A protected version of the attrs argument.",

26052

"type": "Object"

26053

},

26054

"class": "AttributeCore",

26055

"module": "attribute",

26056

"submodule": "attribute-core"

26057

},

26058

{

26059

"file": "attribute/js/AttributeCore.js",

26060

"line": 808,

26061

"description": "Utility method to normalize attribute values. The base implementation \nsimply merges the hash to protect the original.",

26062

"itemtype": "method",

26063

"name": "_normAttrVals",

26064

"params": [

26065

{

26066

"name": "valueHash",

26067

"description": "An object with attribute name/value pairs",

26068

"type": "Object"

26069

}

26070

],

26071

"return": {

26072

"description": "",

26073

"type": "Object"

26074

},

26075

"access": "private",

26076

"tagname": "",

26077

"class": "AttributeCore",

26078

"module": "attribute",

26079

"submodule": "attribute-core"

26080

},

26081

{

26082

"file": "attribute/js/AttributeCore.js",

26083

"line": 823,

26084

"description": "Returns the initial value of the given attribute from\neither the default configuration provided, or the \nover-ridden value if it exists in the set of initValues \nprovided and the attribute is not read-only.",

26085

"params": [

26086

{

26087

"name": "attr",

26088

"description": "The name of the attribute",

26089

"type": "String"

26090

},

26091

{

26092

"name": "cfg",

26093

"description": "The attribute configuration object",

26094

"type": "Object"

26095

},

26096

{

26097

"name": "initValues",

26098

"description": "The object with simple and complex attribute name/value pairs returned from _normAttrVals",

26099

"type": "Object"

26100

}

26101

],

26102

"return": {

26103

"description": "The initial value of the attribute.",

26104

"type": "Any"

26105

},

26106

"itemtype": "method",

26107

"name": "_getAttrInitVal",

26108

"access": "private",

26109

"tagname": "",

26110

"class": "AttributeCore",

26111

"module": "attribute",

26112

"submodule": "attribute-core"

26113

},

26114

{

26115

"file": "attribute/js/AttributeCore.js",

26116

"line": 862,

26117

"description": "Utility method to set up initial attributes defined during construction, either through the constructor.ATTRS property, or explicitly passed in.",

26118

"itemtype": "method",

26119

"name": "_initAttrs",

26120

"access": "protected",

26121

"tagname": "",

26122

"params": [

26123

{

26124

"name": "attrs",

26125

"description": "The attributes to add during construction (passed through to <a href=\"#method_addAttrs\">addAttrs</a>). These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor.",

26126

"type": "Object"

26127

},

26128

{

26129

"name": "values",

26130

"description": "The initial attribute values to apply (passed through to <a href=\"#method_addAttrs\">addAttrs</a>). These are not merged/cloned. The caller is responsible for isolating user provided values if required.",

26131

"type": "Object"

26132

},

26133

{

26134

"name": "lazy",

26135

"description": "Whether or not to add attributes lazily (passed through to <a href=\"#method_addAttrs\">addAttrs</a>).",

26136

"type": "Boolean"

26137

}

26138

],

26139

"class": "AttributeCore",

26140

"module": "attribute",

26141

"submodule": "attribute-core"

26142

},

26143

{

26144

"file": "attribute/js/AttributeEvents.js",

26145

"line": 41,

26146

"description": "Sets the value of an attribute.",

26147

"itemtype": "method",

26148

"name": "set",

26149

"chainable": 1,

26150

"params": [

26151

{

26152

"name": "name",

26153

"description": "The name of the attribute. If the \ncurrent value of the attribute is an Object, dot notation can be used\nto set the value of a property within the object (e.g. <code>set(\"x.y.z\", 5)</code>).",

26154

"type": "String"

26155

},

26156

{

26157

"name": "value",

26158

"description": "The value to set the attribute to.",

26159

"type": "Any"

26160

},

26161

{

26162

"name": "opts",

26163

"description": "(Optional) Optional event data to be mixed into\nthe event facade passed to subscribers of the attribute's change event. This \ncan be used as a flexible way to identify the source of a call to set, allowing \nthe developer to distinguish between set called internally by the host, vs. \nset called externally by the application developer.",

26164

"type": "Object"

26165

}

26166

],

26167

"return": {

26168

"description": "A reference to the host object.",

26169

"type": "Object"

26170

},

26171

"class": "AttributeEvents",

26172

"module": "attribute",

26173

"submodule": "attribute-events"

26174

},

26175

{

26176

"file": "attribute/js/AttributeEvents.js",

26177

"line": 65,

26178

"description": "Allows setting of readOnly/writeOnce attributes. See <a href=\"#method_set\">set</a> for argument details.",

26179

"itemtype": "method",

26180

"name": "_set",

26181

"access": "protected",

26182

"tagname": "",

26183

"chainable": 1,

26184

"params": [

26185

{

26186

"name": "name",

26187

"description": "The name of the attribute.",

26188

"type": "String"

26189

},

26190

{

26191

"name": "val",

26192

"description": "The value to set the attribute to.",

26193

"type": "Any"

26194

},

26195

{

26196

"name": "opts",

26197

"description": "(Optional) Optional event data to be mixed into\nthe event facade passed to subscribers of the attribute's change event.",

26198

"type": "Object"

26199

}

26200

],

26201

"return": {

26202

"description": "A reference to the host object.",

26203

"type": "Object"

26204

},

26205

"class": "AttributeEvents",

26206

"module": "attribute",

26207

"submodule": "attribute-events"

26208

},

26209

{

26210

"file": "attribute/js/AttributeEvents.js",

26211

"line": 82,

26212

"description": "Sets multiple attribute values.",

26213

"itemtype": "method",

26214

"name": "setAttrs",

26215

"params": [

26216

{

26217

"name": "attrs",

26218

"description": "An object with attributes name/value pairs.",

26219

"type": "Object"

26220

}

26221

],

26222

"return": {

26223

"description": "A reference to the host object.",

26224

"type": "Object"

26225

},

26226

"chainable": 1,

26227

"class": "AttributeEvents",

26228

"module": "attribute",

26229

"submodule": "attribute-events"

26230

},

26231

{

26232

"file": "attribute/js/AttributeEvents.js",

26233

"line": 94,

26234

"description": "Utility method to help setup the event payload and fire the attribute change event.",

26235

"itemtype": "method",

26236

"name": "_fireAttrChange",

26237

"access": "private",

26238

"tagname": "",

26239

"params": [

26240

{

26241

"name": "attrName",

26242

"description": "The name of the attribute",

26243

"type": "String"

26244

},

26245

{

26246

"name": "subAttrName",

26247

"description": "The full path of the property being changed, \nif this is a sub-attribute value being change. Otherwise null.",

26248

"type": "String"

26249

},

26250

{

26251

"name": "currVal",

26252

"description": "The current value of the attribute",

26253

"type": "Any"

26254

},

26255

{

26256

"name": "newVal",

26257

"description": "The new value of the attribute",

26258

"type": "Any"

26259

},

26260

{

26261

"name": "opts",

26262

"description": "Any additional event data to mix into the attribute change event's event facade.",

26263

"type": "Object"

26264

}

26265

],

26266

"class": "AttributeEvents",

26267

"module": "attribute",

26268

"submodule": "attribute-events"

26269

},

26270

{

26271

"file": "attribute/js/AttributeEvents.js",

26272

"line": 148,

26273

"description": "Default function for attribute change events.",

26274

"access": "private",

26275

"tagname": "",

26276

"itemtype": "method",

26277

"name": "_defAttrChangeFn",

26278

"params": [

26279

{

26280

"name": "e",

26281

"description": "The event object for attribute change events.",

26282

"type": "EventFacade"

26283

}

26284

],

26285

"class": "AttributeEvents",

26286

"module": "attribute",

26287

"submodule": "attribute-events"

26288

},

26289

{

26290

"file": "attribute/js/AttributeExtras.js",

26291

"line": 39,

26292

"description": "Updates the configuration of an attribute which has already been added.\n\nThe properties which can be modified through this interface are limited\nto the following subset of attributes, which can be safely modified\nafter a value has already been set on the attribute: readOnly, writeOnce, \nbroadcast and getter.\n",

26293

"itemtype": "method",

26294

"name": "modifyAttr",

26295

"params": [

26296

{

26297

"name": "name",

26298

"description": "The name of the attribute whose configuration is to be updated.",

26299

"type": "String"

26300

},

26301

{

26302

"name": "config",

26303

"description": "An object with configuration property/value pairs, specifying the configuration properties to modify.",

26304

"type": "Object"

26305

}

26306

],

26307

"class": "AttributeExtras",

26308

"module": "attribute",

26309

"submodule": "attribute-extras"

26310

},

26311

{

26312

"file": "attribute/js/AttributeExtras.js",

26313

"line": 77,

26314

"description": "Removes an attribute from the host object",

26315

"itemtype": "method",

26316

"name": "removeAttr",

26317

"params": [

26318

{

26319

"name": "name",

26320

"description": "The name of the attribute to be removed.",

26321

"type": "String"

26322

}

26323

],

26324

"class": "AttributeExtras",

26325

"module": "attribute",

26326

"submodule": "attribute-extras"

26327

},

26328

{

26329

"file": "attribute/js/AttributeExtras.js",

26330

"line": 87,

26331

"description": "Resets the attribute (or all attributes) to its initial value, as long as\nthe attribute is not readOnly, or writeOnce.",

26332

"itemtype": "method",

26333

"name": "reset",

26334

"params": [

26335

{

26336

"name": "name",

26337

"description": "Optional. The name of the attribute to reset. If omitted, all attributes are reset.",

26338

"type": "String"

26339

}

26340

],

26341

"return": {

26342

"description": "A reference to the host object.",

26343

"type": "Object"

26344

},

26345

"chainable": 1,

26346

"class": "AttributeExtras",

26347

"module": "attribute",

26348

"submodule": "attribute-extras"

26349

},

26350

{

26351

"file": "attribute/js/AttributeExtras.js",

26352

"line": 112,

26353

"description": "Returns an object with the configuration properties (and value)\nfor the given attribute. If attrName is not provided, returns the\nconfiguration properties for all attributes.",

26354

"itemtype": "method",

26355

"name": "_getAttrCfg",

26356

"access": "protected",

26357

"tagname": "",

26358

"params": [

26359

{

26360

"name": "name",

26361

"description": "Optional. The attribute name. If not provided, the method will return the configuration for all attributes.",

26362

"type": "String"

26363

}

26364

],

26365

"return": {

26366

"description": "The configuration properties for the given attribute, or all attributes.",

26367

"type": "Object"

26368

},

26369

"class": "AttributeExtras",

26370

"module": "attribute",

26371

"submodule": "attribute-extras"

26372

},

26373

{

26374

"file": "attribute/js/ComplexAttribute.js",

26375

"line": 15,

26376

"description": "Utility method to split out simple attribute name/value pairs (\"x\") \nfrom complex attribute name/value pairs (\"x.y.z\"), so that complex\nattributes can be keyed by the top level attribute name.",

26377

"itemtype": "method",

26378

"name": "_normAttrVals",

26379

"params": [

26380

{

26381

"name": "valueHash",

26382

"description": "An object with attribute name/value pairs",

26383

"type": "Object"

26384

}

26385

],

26386

"return": {

26387

"description": "An object literal with 2 properties - \"simple\" and \"complex\",\ncontaining simple and complex attribute values respectively keyed \nby the top level attribute name, or null, if valueHash is falsey.",

26388

"type": "Object"

26389

},

26390

"access": "private",

26391

"tagname": "",

26392

"class": "Attribute",

26393

"module": "attribute",

26394

"submodule": "attribute-complex"

26395

},

26396

{

26397

"file": "attribute/js/ComplexAttribute.js",

26398

"line": 58,

26399

"description": "Returns the initial value of the given attribute from\neither the default configuration provided, or the \nover-ridden value if it exists in the set of initValues \nprovided and the attribute is not read-only.",

26400

"params": [

26401

{

26402

"name": "attr",

26403

"description": "The name of the attribute",

26404

"type": "String"

26405

},

26406

{

26407

"name": "cfg",

26408

"description": "The attribute configuration object",

26409

"type": "Object"

26410

},

26411

{

26412

"name": "initValues",

26413

"description": "The object with simple and complex attribute name/value pairs returned from _normAttrVals",

26414

"type": "Object"

26415

}

26416

],

26417

"return": {

26418

"description": "The initial value of the attribute.",

26419

"type": "Any"

26420

},

26421

"itemtype": "method",

26422

"name": "_getAttrInitVal",

26423

"access": "private",

26424

"tagname": "",

26425

"class": "Attribute",

26426

"module": "attribute",

26427

"submodule": "attribute-complex"

26428

},

26429

{

26430

"file": "attribute/js/State.js",

26431

"line": 13,

26432

"description": "Hash of attributes",

26433

"itemtype": "property",

26434

"name": "data",

26435

"class": "State",

26436

"module": "attribute"

26437

},

26438

{

26439

"file": "attribute/js/State.js",

26440

"line": 22,

26441

"description": "Adds a property to an item.",

26442

"itemtype": "method",

26443

"name": "add",

26444

"params": [

26445

{

26446

"name": "name",

26447

"description": "The name of the item.",

26448

"type": "String"

26449

},

26450

{

26451

"name": "key",

26452

"description": "The name of the property.",

26453

"type": "String"

26454

},

26455

{

26456

"name": "val",

26457

"description": "The value of the property.",

26458

"type": "Any"

26459

}

26460

],

26461

"class": "State",

26462

"module": "attribute"

26463

},

26464

{

26465

"file": "attribute/js/State.js",

26466

"line": 36,

26467

"description": "Adds multiple properties to an item.",

26468

"itemtype": "method",

26469

"name": "addAll",

26470

"params": [

26471

{

26472

"name": "name",

26473

"description": "The name of the item.",

26474

"type": "String"

26475

},

26476

{

26477

"name": "o",

26478

"description": "A hash of property/value pairs.",

26479

"type": "Object"

26480

}

26481

],

26482

"class": "State",

26483

"module": "attribute"

26484

},

26485

{

26486

"file": "attribute/js/State.js",

26487

"line": 53,

26488

"description": "Removes a property from an item.",

26489

"itemtype": "method",

26490

"name": "remove",

26491

"params": [

26492

{

26493

"name": "name",

26494

"description": "The name of the item.",

26495

"type": "String"

26496

},

26497

{

26498

"name": "key",

26499

"description": "The property to remove.",

26500

"type": "String"

26501

}

26502

],

26503

"class": "State",

26504

"module": "attribute"

26505

},

26506

{

26507

"file": "attribute/js/State.js",

26508

"line": 67,

26509

"description": "Removes multiple properties from an item, or remove the item completely.",

26510

"itemtype": "method",

26511

"name": "removeAll",

26512

"params": [

26513

{

26514

"name": "name",

26515

"description": "The name of the item.",

26516

"type": "String"

26517

},

26518

{

26519

"name": "o",

26520

"description": "Collection of properties to delete. If not provided, the entire item is removed.",

26521

"type": "Object|Array"

26522

}

26523

],

26524

"class": "State",

26525

"module": "attribute"

26526

},

26527

{

26528

"file": "attribute/js/State.js",

26529

"line": 92,

26530

"description": "For a given item, returns the value of the property requested, or undefined if not found.",

26531

"itemtype": "method",

26532

"name": "get",

26533

"params": [

26534

{

26535

"name": "name",

26536

"description": "The name of the item",

26537

"type": "String"

26538

},

26539

{

26540

"name": "key",

26541

"description": "Optional. The property value to retrieve.",

26542

"type": "String"

26543

}

26544

],

26545

"return": {

26546

"description": "The value of the supplied property.",

26547

"type": "Any"

26548

},

26549

"class": "State",

26550

"module": "attribute"

26551

},

26552

{

26553

"file": "attribute/js/State.js",

26554

"line": 105,

26555

"description": "For the given item, returns an object with all of the\nitem's property/value pairs. By default the object returned\nis a shallow copy of the stored data, but passing in true\nas the second parameter will return a reference to the stored\ndata.",

26556

"itemtype": "method",

26557

"name": "getAll",

26558

"params": [

26559

{

26560

"name": "name",

26561

"description": "The name of the item",

26562

"type": "String"

26563

},

26564

{

26565

"name": "reference",

26566

"description": "true, if you want a reference to the stored\nobject",

26567

"type": "Boolean"

26568

}

26569

],

26570

"return": {

26571

"description": "An object with property/value pairs for the item.",

26572

"type": "Object"

26573

},

26574

"class": "State",

26575

"module": "attribute"

26576

},

26577

{

26578

"file": "autocomplete/js/autocomplete-base.js",

26579

"line": 103,

26580

"description": "Fires after the query has been completely cleared or no longer meets the\nminimum query length requirement.",

26581

"itemtype": "event",

26582

"name": "clear",

26583

"params": [

26584

{

26585

"name": "prevVal",

26586

"description": "Value of the query before it was cleared.",

26587

"type": "String"

26588

},

26589

{

26590

"name": "src",

26591

"description": "Source of the event.",

26592

"type": "String"

26593

}

26594

],

26595

"preventable": "_defClearFn",

26596

"class": "AutoCompleteBase",

26597

"module": "autocomplete",

26598

"submodule": "autocomplete-base"

26599

},

26600

{

26601

"file": "autocomplete/js/autocomplete-base.js",

26602

"line": 116,

26603

"description": "Fires when the contents of the input field have changed and the input\nvalue meets the criteria necessary to generate an autocomplete query.",

26604

"itemtype": "event",

26605

"name": "query",

26606

"params": [

26607

{

26608

"name": "inputValue",

26609

"description": "Full contents of the text input field or\n textarea that generated the query.",

26610

"type": "String"

26611

},

26612

{

26613

"name": "query",

26614

"description": "AutoComplete query. This is the string that will\n be used to request completion results. It may or may not be the same\n as `inputValue`.",

26615

"type": "String"

26616

},

26617

{

26618

"name": "src",

26619

"description": "Source of the event.",

26620

"type": "String"

26621

}

26622

],

26623

"preventable": "_defQueryFn",

26624

"class": "AutoCompleteBase",

26625

"module": "autocomplete",

26626

"submodule": "autocomplete-base"

26627

},

26628

{

26629

"file": "autocomplete/js/autocomplete-base.js",

26630

"line": 133,

26631

"description": "Fires after query results are received from the source. If no source has\nbeen set, this event will not fire.",

26632

"itemtype": "event",

26633

"name": "results",

26634

"params": [

26635

{

26636

"name": "data",

26637

"description": "Raw, unfiltered result data (if available).",

26638

"type": "Array|Object"

26639

},

26640

{

26641

"name": "query",

26642

"description": "Query that generated these results.",

26643

"type": "String"

26644

},

26645

{

26646

"name": "results",

26647

"description": "Array of filtered, formatted, and highlighted\n results. Each item in the array is an object with the following\n properties:",

26648

"type": "Object[]",

26649

"props": [

26650

{

26651

"name": "display",

26652

"description": "Formatted result\n HTML suitable for display to the user. If no custom formatter is\n set, this will be an HTML-escaped version of the string in the\n `text` property.",

26653

"type": "Node|HTMLElement|String"

26654

},

26655

{

26656

"name": "highlighted",

26657

"description": "Highlighted (but not\n formatted) result text. This property will only be set if a\n highlighter is in use.",

26658

"type": "String",

26659

"optional": true

26660

},

26661

{

26662

"name": "raw",

26663

"description": "Raw, unformatted result in whatever form it\n was provided by the source.",

26664

"type": "Any"

26665

},

26666

{

26667

"name": "text",

26668

"description": "Plain text version of the result,\n suitable for being inserted into the value of a text input field\n or textarea when the result is selected by a user. This value is\n not HTML-escaped and should not be inserted into the page using\n `innerHTML` or `Node#setContent()`.",

26669

"type": "String"

26670

}

26671

]

26672

}

26673

],

26674

"preventable": "_defResultsFn",

26675

"class": "AutoCompleteBase",

26676

"module": "autocomplete",

26677

"submodule": "autocomplete-base"

26678

},

26679

{

26680

"file": "autocomplete/js/autocomplete-base.js",

26681

"line": 177,

26682

"description": "Clears the result cache.",

26683

"itemtype": "method",

26684

"name": "clearCache",

26685

"chainable": 1,

26686

"since": "3.5.0",

26687

"class": "AutoCompleteBase",

26688

"module": "autocomplete",

26689

"submodule": "autocomplete-base"

26690

},

26691

{

26692

"file": "autocomplete/js/autocomplete-base.js",

26693

"line": 189,

26694

"description": "Sends a request to the configured source. If no source is configured, this\nmethod won't do anything.\n\nUsually there's no reason to call this method manually; it will be called\nautomatically when user input causes a `query` event to be fired. The only\ntime you'll need to call this method manually is if you want to force a\nrequest to be sent when no user input has occurred.",

26695

"itemtype": "method",

26696

"name": "sendRequest",

26697

"params": [

26698

{

26699

"name": "query",

26700

"description": "Query to send. If specified, the `query` attribute\n will be set to this query. If not specified, the current value of the\n `query` attribute will be used.",

26701

"type": "String",

26702

"optional": true

26703

},

26704

{

26705

"name": "requestTemplate",

26706

"description": "Request template function. If not\n specified, the current value of the `requestTemplate` attribute will be\n used.",

26707

"type": "Function",

26708

"optional": true

26709

}

26710

],

26711

"chainable": 1,

26712

"class": "AutoCompleteBase",

26713

"module": "autocomplete",

26714

"submodule": "autocomplete-base"

26715

},

26716

{

26717

"file": "autocomplete/js/autocomplete-base.js",

26718

"line": 242,

26719

"description": "Attaches event listeners and behaviors.",

26720

"itemtype": "method",

26721

"name": "_bindUIACBase",

26722

"access": "protected",

26723

"tagname": "",

26724

"class": "AutoCompleteBase",

26725

"module": "autocomplete",

26726

"submodule": "autocomplete-base"

26727

},

26728

{

26729

"file": "autocomplete/js/autocomplete-base.js",

26730

"line": 278,

26731

"description": "Synchronizes the UI state of the `inputNode`.",

26732

"itemtype": "method",

26733

"name": "_syncUIACBase",

26734

"access": "protected",

26735

"tagname": "",

26736

"class": "AutoCompleteBase",

26737

"module": "autocomplete",

26738

"submodule": "autocomplete-base"

26739

},

26740

{

26741

"file": "autocomplete/js/autocomplete-base.js",

26742

"line": 291,

26743

"description": "Creates a DataSource-like object that simply returns the specified array as\na response. See the `source` attribute for more details.",

26744

"itemtype": "method",

26745

"name": "_createArraySource",

26746

"params": [

26747

{

26748

"name": "source",

26749

"description": "",

26750

"type": "Array"

26751

}

26752

],

26753

"return": {

26754

"description": "DataSource-like object.",

26755

"type": "Object"

26756

},

26757

"access": "protected",

26758

"tagname": "",

26759

"class": "AutoCompleteBase",

26760

"module": "autocomplete",

26761

"submodule": "autocomplete-base"

26762

},

26763

{

26764

"file": "autocomplete/js/autocomplete-base.js",

26765

"line": 311,

26766

"description": "Creates a DataSource-like object that passes the query to a custom-defined\nfunction, which is expected to call the provided callback with an array of\nresults. See the `source` attribute for more details.",

26767

"itemtype": "method",

26768

"name": "_createFunctionSource",

26769

"params": [

26770

{

26771

"name": "source",

26772

"description": "Function that accepts a query and a callback as\n parameters, and calls the callback with an array of results.",

26773

"type": "Function"

26774

}

26775

],

26776

"return": {

26777

"description": "DataSource-like object.",

26778

"type": "Object"

26779

},

26780

"access": "protected",

26781

"tagname": "",

26782

"class": "AutoCompleteBase",

26783

"module": "autocomplete",

26784

"submodule": "autocomplete-base"

26785

},

26786

{

26787

"file": "autocomplete/js/autocomplete-base.js",

26788

"line": 343,

26789

"description": "Creates a DataSource-like object that looks up queries as properties on the\nspecified object, and returns the found value (if any) as a response. See\nthe `source` attribute for more details.",

26790

"itemtype": "method",

26791

"name": "_createObjectSource",

26792

"params": [

26793

{

26794

"name": "source",

26795

"description": "",

26796

"type": "Object"

26797

}

26798

],

26799

"return": {

26800

"description": "DataSource-like object.",

26801

"type": "Object"

26802

},

26803

"access": "protected",

26804

"tagname": "",

26805

"class": "AutoCompleteBase",

26806

"module": "autocomplete",

26807

"submodule": "autocomplete-base"

26808

},

26809

{

26810

"file": "autocomplete/js/autocomplete-base.js",

26811

"line": 369,

26812

"description": "Returns `true` if _value_ is either a function or `null`.",

26813

"itemtype": "method",

26814

"name": "_functionValidator",

26815

"params": [

26816

{

26817

"name": "value",

26818

"description": "Value to validate.",

26819

"type": "Function|null"

26820

}

26821

],

26822

"access": "protected",

26823

"tagname": "",

26824

"class": "AutoCompleteBase",

26825

"module": "autocomplete",

26826

"submodule": "autocomplete-base"

26827

},

26828

{

26829

"file": "autocomplete/js/autocomplete-base.js",

26830

"line": 380,

26831

"description": "Faster and safer alternative to `Y.Object.getValue()`. Doesn't bother\ncasting the path to an array (since we already know it's an array) and\ndoesn't throw an error if a value in the middle of the object hierarchy is\nneither `undefined` nor an object.",

26832

"itemtype": "method",

26833

"name": "_getObjectValue",

26834

"params": [

26835

{

26836

"name": "obj",

26837

"description": "",

26838

"type": "Object"

26839

},

26840

{

26841

"name": "path",

26842

"description": "",

26843

"type": "Array"

26844

}

26845

],

26846

"return": {

26847

"description": "Located value, or `undefined` if the value was\n not found at the specified path.",

26848

"type": "Any"

26849

},

26850

"access": "protected",

26851

"tagname": "",

26852

"class": "AutoCompleteBase",

26853

"module": "autocomplete",

26854

"submodule": "autocomplete-base"

26855

},

26856

{

26857

"file": "autocomplete/js/autocomplete-base.js",

26858

"line": 405,

26859

"description": "Parses result responses, performs filtering and highlighting, and fires the\n`results` event.",

26860

"itemtype": "method",

26861

"name": "_parseResponse",

26862

"params": [

26863

{

26864

"name": "query",

26865

"description": "Query that generated these results.",

26866

"type": "String"

26867

},

26868

{

26869

"name": "response",

26870

"description": "Response containing results.",

26871

"type": "Object"

26872

},

26873

{

26874

"name": "data",

26875

"description": "Raw response data.",

26876

"type": "Object"

26877

}

26878

],

26879

"access": "protected",

26880

"tagname": "",

26881

"class": "AutoCompleteBase",

26882

"module": "autocomplete",

26883

"submodule": "autocomplete-base"

26884

},

26885

{

26886

"file": "autocomplete/js/autocomplete-base.js",

26887

"line": 536,

26888

"description": "Returns the query portion of the specified input value, or `null` if there\nis no suitable query within the input value.\n\nIf a query delimiter is defined, the query will be the last delimited part\nof of the string.",

26889

"itemtype": "method",

26890

"name": "_parseValue",

26891

"params": [

26892

{

26893

"name": "value",

26894

"description": "Input value from which to extract the query.",

26895

"type": "String"

26896

}

26897

],

26898

"return": {

26899

"description": "query",

26900

"type": "String|null"

26901

},

26902

"access": "protected",

26903

"tagname": "",

26904

"class": "AutoCompleteBase",

26905

"module": "autocomplete",

26906

"submodule": "autocomplete-base"

26907

},

26908

{

26909

"file": "autocomplete/js/autocomplete-base.js",

26910

"line": 559,

26911

"description": "Setter for the `enableCache` attribute.",

26912

"itemtype": "method",

26913

"name": "_setEnableCache",

26914

"params": [

26915

{

26916

"name": "value",

26917

"description": "",

26918

"type": "Boolean"

26919

}

26920

],

26921

"access": "protected",

26922

"tagname": "",

26923

"since": "3.5.0",

26924

"class": "AutoCompleteBase",

26925

"module": "autocomplete",

26926

"submodule": "autocomplete-base"

26927

},

26928

{

26929

"file": "autocomplete/js/autocomplete-base.js",

26930

"line": 576,

26931

"description": "Setter for locator attributes.",

26932

"itemtype": "method",

26933

"name": "_setLocator",

26934

"params": [

26935

{

26936

"name": "locator",

26937

"description": "",

26938

"type": "Function|String|null"

26939

}

26940

],

26941

"return": {

26942

"description": "",

26943

"type": "Function|null"

26944

},

26945

"access": "protected",

26946

"tagname": "",

26947

"class": "AutoCompleteBase",

26948

"module": "autocomplete",

26949

"submodule": "autocomplete-base"

26950

},

26951

{

26952

"file": "autocomplete/js/autocomplete-base.js",

26953

"line": 598,

26954

"description": "Setter for the `requestTemplate` attribute.",

26955

"itemtype": "method",

26956

"name": "_setRequestTemplate",

26957

"params": [

26958

{

26959

"name": "template",

26960

"description": "",

26961

"type": "Function|String|null"

26962

}

26963

],

26964

"return": {

26965

"description": "",

26966

"type": "Function|null"

26967

},

26968

"access": "protected",

26969

"tagname": "",

26970

"class": "AutoCompleteBase",

26971

"module": "autocomplete",

26972

"submodule": "autocomplete-base"

26973

},

26974

{

26975

"file": "autocomplete/js/autocomplete-base.js",

26976

"line": 618,

26977

"description": "Setter for the `resultFilters` attribute.",

26978

"itemtype": "method",

26979

"name": "_setResultFilters",

26980

"params": [

26981

{

26982

"name": "filters",

26983

"description": "`null`, a filter\n function, an array of filter functions, or a string or array of strings\n representing the names of methods on `Y.AutoCompleteFilters`.",

26984

"type": "Array|Function|String|null"

26985

}

26986

],

26987

"return": {

26988

"description": "Array of filter functions (empty if filters is\n `null`).",

26989

"type": "Function[]"

26990

},

26991

"access": "protected",

26992

"tagname": "",

26993

"class": "AutoCompleteBase",

26994

"module": "autocomplete",

26995

"submodule": "autocomplete-base"

26996

},

26997

{

26998

"file": "autocomplete/js/autocomplete-base.js",

26999

"line": 661,

27000

"description": "Setter for the `resultHighlighter` attribute.",

27001

"itemtype": "method",

27002

"name": "_setResultHighlighter",

27003

"params": [

27004

{

27005

"name": "highlighter",

27006

"description": "`null`, a highlighter function, or\n a string representing the name of a method on\n `Y.AutoCompleteHighlighters`.",

27007

"type": "Function|String|null"

27008

}

27009

],

27010

"return": {

27011

"description": "",

27012

"type": "Function|null"

27013

},

27014

"access": "protected",

27015

"tagname": "",

27016

"class": "AutoCompleteBase",

27017

"module": "autocomplete",

27018

"submodule": "autocomplete-base"

27019

},

27020

{

27021

"file": "autocomplete/js/autocomplete-base.js",

27022

"line": 688,

27023

"description": "Setter for the `source` attribute. Returns a DataSource or a DataSource-like\nobject depending on the type of _source_ and/or the value of the\n`sourceType` attribute.",

27024

"itemtype": "method",

27025

"name": "_setSource",

27026

"params": [

27027

{

27028

"name": "source",

27029

"description": "AutoComplete source. See the `source` attribute for\n details.",

27030

"type": "Any"

27031

}

27032

],

27033

"return": {

27034

"description": "",

27035

"type": "DataSource|Object"

27036

},

27037

"access": "protected",

27038

"tagname": "",

27039

"class": "AutoCompleteBase",

27040

"module": "autocomplete",

27041

"submodule": "autocomplete-base"

27042

},

27043

{

27044

"file": "autocomplete/js/autocomplete-base.js",

27045

"line": 723,

27046

"description": "Shared success callback for non-DataSource sources.",

27047

"itemtype": "method",

27048

"name": "_sourceSuccess",

27049

"params": [

27050

{

27051

"name": "data",

27052

"description": "Response data.",

27053

"type": "Any"

27054

},

27055

{

27056

"name": "request",

27057

"description": "Request object.",

27058

"type": "Object"

27059

}

27060

],

27061

"access": "protected",

27062

"tagname": "",

27063

"class": "AutoCompleteBase",

27064

"module": "autocomplete",

27065

"submodule": "autocomplete-base"

27066

},

27067

{

27068

"file": "autocomplete/js/autocomplete-base.js",

27069

"line": 738,

27070

"description": "Synchronizes the UI state of the `allowBrowserAutocomplete` attribute.",

27071

"itemtype": "method",

27072

"name": "_syncBrowserAutocomplete",

27073

"access": "protected",

27074

"tagname": "",

27075

"class": "AutoCompleteBase",

27076

"module": "autocomplete",

27077

"submodule": "autocomplete-base"

27078

},

27079

{

27080

"file": "autocomplete/js/autocomplete-base.js",

27081

"line": 753,

27082

"description": "Updates the query portion of the `value` attribute.\n\nIf a query delimiter is defined, the last delimited portion of the input\nvalue will be replaced with the specified _value_.",

27083

"itemtype": "method",

27084

"name": "_updateValue",

27085

"params": [

27086

{

27087

"name": "newVal",

27088

"description": "New value.",

27089

"type": "String"

27090

}

27091

],

27092

"access": "protected",

27093

"tagname": "",

27094

"class": "AutoCompleteBase",

27095

"module": "autocomplete",

27096

"submodule": "autocomplete-base"

27097

},

27098

{

27099

"file": "autocomplete/js/autocomplete-base.js",

27100

"line": 789,

27101

"description": "Updates the current `source` based on the new `sourceType` to ensure that\nthe two attributes don't get out of sync when they're changed separately.",

27102

"itemtype": "method",

27103

"name": "_afterSourceTypeChange",

27104

"params": [

27105

{

27106

"name": "e",

27107

"description": "",

27108

"type": "EventFacade"

27109

}

27110

],

27111

"access": "protected",

27112

"tagname": "",

27113

"class": "AutoCompleteBase",

27114

"module": "autocomplete",

27115

"submodule": "autocomplete-base"

27116

},

27117

{

27118

"file": "autocomplete/js/autocomplete-base.js",

27119

"line": 803,

27120

"description": "Handles change events for the `value` attribute.",

27121

"itemtype": "method",

27122

"name": "_afterValueChange",

27123

"params": [

27124

{

27125

"name": "e",

27126

"description": "",

27127

"type": "EventFacade"

27128

}

27129

],

27130

"access": "protected",

27131

"tagname": "",

27132

"class": "AutoCompleteBase",

27133

"module": "autocomplete",

27134

"submodule": "autocomplete-base"

27135

},

27136

{

27137

"file": "autocomplete/js/autocomplete-base.js",

27138

"line": 860,

27139

"description": "Handles `blur` events on the input node.",

27140

"itemtype": "method",

27141

"name": "_onInputBlur",

27142

"params": [

27143

{

27144

"name": "e",

27145

"description": "",

27146

"type": "EventFacade"

27147

}

27148

],

27149

"access": "protected",

27150

"tagname": "",

27151

"class": "AutoCompleteBase",

27152

"module": "autocomplete",

27153

"submodule": "autocomplete-base"

27154

},

27155

{

27156

"file": "autocomplete/js/autocomplete-base.js",

27157

"line": 898,

27158

"description": "Handles `valueChange` events on the input node and fires a `query` event\nwhen the input value meets the configured criteria.",

27159

"itemtype": "method",

27160

"name": "_onInputValueChange",

27161

"params": [

27162

{

27163

"name": "e",

27164

"description": "",

27165

"type": "EventFacade"

27166

}

27167

],

27168

"access": "protected",

27169

"tagname": "",

27170

"class": "AutoCompleteBase",

27171

"module": "autocomplete",

27172

"submodule": "autocomplete-base"

27173

},

27174

{

27175

"file": "autocomplete/js/autocomplete-base.js",

27176

"line": 916,

27177

"description": "Handles source responses and fires the `results` event.",

27178

"itemtype": "method",

27179

"name": "_onResponse",

27180

"params": [

27181

{

27182

"name": "e",

27183

"description": "",

27184

"type": "EventFacade"

27185

}

27186

],

27187

"access": "protected",

27188

"tagname": "",

27189

"class": "AutoCompleteBase",

27190

"module": "autocomplete",

27191

"submodule": "autocomplete-base"

27192

},

27193

{

27194

"file": "autocomplete/js/autocomplete-base.js",

27195

"line": 932,

27196

"description": "Default `clear` event handler. Sets the `results` attribute to an empty\narray and `query` to null.",

27197

"itemtype": "method",

27198

"name": "_defClearFn",

27199

"access": "protected",

27200

"tagname": "",

27201

"class": "AutoCompleteBase",

27202

"module": "autocomplete",

27203

"submodule": "autocomplete-base"

27204

},

27205

{

27206

"file": "autocomplete/js/autocomplete-base.js",

27207

"line": 944,

27208

"description": "Default `query` event handler. Sets the `query` attribute and sends a\nrequest to the source if one is configured.",

27209

"itemtype": "method",

27210

"name": "_defQueryFn",

27211

"params": [

27212

{

27213

"name": "e",

27214

"description": "",

27215

"type": "EventFacade"

27216

}

27217

],

27218

"access": "protected",

27219

"tagname": "",

27220

"class": "AutoCompleteBase",

27221

"module": "autocomplete",

27222

"submodule": "autocomplete-base"

27223

},

27224

{

27225

"file": "autocomplete/js/autocomplete-base.js",

27226

"line": 957,

27227

"description": "Default `results` event handler. Sets the `results` attribute to the latest\nresults.",

27228

"itemtype": "method",

27229

"name": "_defResultsFn",

27230

"params": [

27231

{

27232

"name": "e",

27233

"description": "",

27234

"type": "EventFacade"

27235

}

27236

],

27237

"access": "protected",

27238

"tagname": "",

27239

"class": "AutoCompleteBase",

27240

"module": "autocomplete",

27241

"submodule": "autocomplete-base"

27242

},

27243

{

27244

"file": "autocomplete/js/autocomplete-base.js",

27245

"line": 972,

27246

"description": "Whether or not to enable the browser's built-in autocomplete functionality\nfor input fields.",

27247

"itemtype": "attribute",

27248

"name": "allowBrowserAutocomplete",

27249

"type": "Boolean",

27250

"default": "false",

27251

"class": "AutoCompleteBase",

27252

"module": "autocomplete",

27253

"submodule": "autocomplete-base"

27254

},

27255

{

27256

"file": "autocomplete/js/autocomplete-base.js",

27257

"line": 984,

27258

"description": "When a `queryDelimiter` is set, trailing delimiters will automatically be\nstripped from the input value by default when the input node loses focus.\nSet this to `true` to allow trailing delimiters.",

27259

"itemtype": "attribute",

27260

"name": "allowTrailingDelimiter",

27261

"type": "Boolean",

27262

"default": "false",

27263

"class": "AutoCompleteBase",

27264

"module": "autocomplete",

27265

"submodule": "autocomplete-base"

27266

},

27267

{

27268

"file": "autocomplete/js/autocomplete-base.js",

27269

"line": 997,

27270

"description": "Whether or not to enable in-memory caching in result sources that support\nit.",

27271

"itemtype": "attribute",

27272

"name": "enableCache",

27273

"type": "Boolean",

27274

"default": "true",

27275

"since": "3.5.0",

27276

"class": "AutoCompleteBase",

27277

"module": "autocomplete",

27278

"submodule": "autocomplete-base"

27279

},

27280

{

27281

"file": "autocomplete/js/autocomplete-base.js",

27282

"line": 1012,

27283

"description": "Node to monitor for changes, which will generate `query` events when\nappropriate. May be either an `<input>` or a `<textarea>`.",

27284

"itemtype": "attribute",

27285

"name": "inputNode",

27286

"type": "Node|HTMLElement|String",

27287

"initonly": "",

27288

"class": "AutoCompleteBase",

27289

"module": "autocomplete",

27290

"submodule": "autocomplete-base"

27291

},

27292

{

27293

"file": "autocomplete/js/autocomplete-base.js",

27294

"line": 1025,

27295

"description": "Maximum number of results to return. A value of `0` or less will allow an\nunlimited number of results.",

27296

"itemtype": "attribute",

27297

"name": "maxResults",

27298

"type": "Number",

27299

"default": "0",

27300

"class": "AutoCompleteBase",

27301

"module": "autocomplete",

27302

"submodule": "autocomplete-base"

27303

},

27304

{

27305

"file": "autocomplete/js/autocomplete-base.js",

27306

"line": 1037,

27307

"description": "Minimum number of characters that must be entered before a `query` event\nwill be fired. A value of `0` allows empty queries; a negative value will\neffectively disable all `query` events.",

27308

"itemtype": "attribute",

27309

"name": "minQueryLength",

27310

"type": "Number",

27311

"default": "1",

27312

"class": "AutoCompleteBase",

27313

"module": "autocomplete",

27314

"submodule": "autocomplete-base"

27315

},

27316

{

27317

"file": "autocomplete/js/autocomplete-base.js",

27318

"line": 1050,

27319

"description": "Current query, or `null` if there is no current query.\n\nThe query might not be the same as the current value of the input node, both\nfor timing reasons (due to `queryDelay`) and because when one or more\n`queryDelimiter` separators are in use, only the last portion of the\ndelimited input string will be used as the query value.",

27320

"itemtype": "attribute",

27321

"name": "query",

27322

"type": "String|null",

27323

"default": "null",

27324

"readonly": "",

27325

"class": "AutoCompleteBase",

27326

"module": "autocomplete",

27327

"submodule": "autocomplete-base"

27328

},

27329

{

27330

"file": "autocomplete/js/autocomplete-base.js",

27331

"line": 1068,

27332

"description": "Number of milliseconds to delay after input before triggering a `query`\nevent. If new input occurs before this delay is over, the previous input\nevent will be ignored and a new delay will begin.\n\nThis can be useful both to throttle queries to a remote data source and to\navoid distracting the user by showing them less relevant results before\nthey've paused their typing.",

27333

"itemtype": "attribute",

27334

"name": "queryDelay",

27335

"type": "Number",

27336

"default": "100",

27337

"class": "AutoCompleteBase",

27338

"module": "autocomplete",

27339

"submodule": "autocomplete-base"

27340

},

27341

{

27342

"file": "autocomplete/js/autocomplete-base.js",

27343

"line": 1085,

27344

"description": "Query delimiter string. When a delimiter is configured, the input value\nwill be split on the delimiter, and only the last portion will be used in\nautocomplete queries and updated when the `query` attribute is\nmodified.",

27345

"itemtype": "attribute",

27346

"name": "queryDelimiter",

27347

"type": "String|null",

27348

"default": "null",

27349

"class": "AutoCompleteBase",

27350

"module": "autocomplete",

27351

"submodule": "autocomplete-base"

27352

},

27353

{

27354

"file": "autocomplete/js/autocomplete-base.js",

27355

"line": 1099,

27356

"description": "Source request template. This can be a function that accepts a query as a\nparameter and returns a request string, or it can be a string containing the\nplaceholder \"{query}\", which will be replaced with the actual URI-encoded\nquery. In either case, the resulting string will be appended to the request\nURL when the `source` attribute is set to a remote DataSource, JSONP URL, or\nXHR URL (it will not be appended to YQL URLs).\n\nWhile `requestTemplate` may be set to either a function or a string, it will\nalways be returned as a function that accepts a query argument and returns a\nstring.",

27357

"itemtype": "attribute",

27358

"name": "requestTemplate",

27359

"type": "Function|String|null",

27360

"default": "null",

27361

"class": "AutoCompleteBase",

27362

"module": "autocomplete",

27363

"submodule": "autocomplete-base"

27364

},

27365

{

27366

"file": "autocomplete/js/autocomplete-base.js",

27367

"line": 1120,

27368

"description": "Array of local result filter functions. If provided, each filter will be\ncalled with two arguments when results are received: the query and an array\nof result objects. See the documentation for the `results` event for a list\nof the properties available on each result object.\n\nEach filter is expected to return a filtered or modified version of the\nresults array, which will then be passed on to subsequent filters, then the\n`resultHighlighter` function (if set), then the `resultFormatter` function\n(if set), and finally to subscribers to the `results` event.\n\nIf no `source` is set, result filters will not be called.\n\nPrepackaged result filters provided by the autocomplete-filters and\nautocomplete-filters-accentfold modules can be used by specifying the filter\nname as a string, such as `'phraseMatch'` (assuming the necessary filters\nmodule is loaded).",

27369

"itemtype": "attribute",

27370

"name": "resultFilters",

27371

"type": "Array",

27372

"default": "[]",

27373

"class": "AutoCompleteBase",

27374

"module": "autocomplete",

27375

"submodule": "autocomplete-base"

27376

},

27377

{

27378

"file": "autocomplete/js/autocomplete-base.js",

27379

"line": 1147,

27380

"description": "Function which will be used to format results. If provided, this function\nwill be called with two arguments after results have been received and\nfiltered: the query and an array of result objects. The formatter is\nexpected to return an array of HTML strings or Node instances containing the\ndesired HTML for each result.\n\nSee the documentation for the `results` event for a list of the properties\navailable on each result object.\n\nIf no `source` is set, the formatter will not be called.",

27381

"itemtype": "attribute",

27382

"name": "resultFormatter",

27383

"type": "Function|null",

27384

"class": "AutoCompleteBase",

27385

"module": "autocomplete",

27386

"submodule": "autocomplete-base"

27387

},

27388

{

27389

"file": "autocomplete/js/autocomplete-base.js",

27390

"line": 1167,

27391

"description": "Function which will be used to highlight results. If provided, this function\nwill be called with two arguments after results have been received and\nfiltered: the query and an array of filtered result objects. The highlighter\nis expected to return an array of highlighted result text in the form of\nHTML strings.\n\nSee the documentation for the `results` event for a list of the properties\navailable on each result object.\n\nIf no `source` is set, the highlighter will not be called.",

27392

"itemtype": "attribute",

27393

"name": "resultHighlighter",

27394

"type": "Function|null",

27395

"class": "AutoCompleteBase",

27396

"module": "autocomplete",

27397

"submodule": "autocomplete-base"

27398

},

27399

{

27400

"file": "autocomplete/js/autocomplete-base.js",

27401

"line": 1187,

27402

"description": "Locator that should be used to extract an array of results from a non-array\nresponse.\n\nBy default, no locator is applied, and all responses are assumed to be\narrays by default. If all responses are already arrays, you don't need to\ndefine a locator.\n\nThe locator may be either a function (which will receive the raw response as\nan argument and must return an array) or a string representing an object\npath, such as \"foo.bar.baz\" (which would return the value of\n`result.foo.bar.baz` if the response is an object).\n\nWhile `resultListLocator` may be set to either a function or a string, it\nwill always be returned as a function that accepts a response argument and\nreturns an array.",

27403

"itemtype": "attribute",

27404

"name": "resultListLocator",

27405

"type": "Function|String|null",

27406

"class": "AutoCompleteBase",

27407

"module": "autocomplete",

27408

"submodule": "autocomplete-base"

27409

},

27410

{

27411

"file": "autocomplete/js/autocomplete-base.js",

27412

"line": 1212,

27413

"description": "Current results, or an empty array if there are no results.",

27414

"itemtype": "attribute",

27415

"name": "results",

27416

"type": "Array",

27417

"default": "[]",

27418

"readonly": "",

27419

"class": "AutoCompleteBase",

27420

"module": "autocomplete",

27421

"submodule": "autocomplete-base"

27422

},

27423

{

27424

"file": "autocomplete/js/autocomplete-base.js",

27425

"line": 1225,

27426

"description": "Locator that should be used to extract a plain text string from a non-string\nresult item. The resulting text value will typically be the value that ends\nup being inserted into an input field or textarea when the user of an\nautocomplete implementation selects a result.\n\nBy default, no locator is applied, and all results are assumed to be plain\ntext strings. If all results are already plain text strings, you don't need\nto define a locator.\n\nThe locator may be either a function (which will receive the raw result as\nan argument and must return a string) or a string representing an object\npath, such as \"foo.bar.baz\" (which would return the value of\n`result.foo.bar.baz` if the result is an object).\n\nWhile `resultTextLocator` may be set to either a function or a string, it\nwill always be returned as a function that accepts a result argument and\nreturns a string.",

27427

"itemtype": "attribute",

27428

"name": "resultTextLocator",

27429

"type": "Function|String|null",

27430

"class": "AutoCompleteBase",

27431

"module": "autocomplete",

27432

"submodule": "autocomplete-base"

27433

},

27434

{

27435

"file": "autocomplete/js/autocomplete-base.js",

27436

"line": 1252,

27437

"description": "Source for autocomplete results. The following source types are supported:\n\n<dl>\n <dt>Array</dt>\n <dd>\n \n The full array will be provided to any configured filters for each\n query. This is an easy way to create a fully client-side autocomplete\n implementation.\n \n\n \n Example: `['first result', 'second result', 'etc']`\n \n </dd>\n\n <dt>DataSource</dt>\n <dd>\n A `DataSource` instance or other object that provides a DataSource-like\n `sendRequest` method. See the `DataSource` documentation for details.\n </dd>\n\n <dt>Function</dt>\n <dd>\n \n A function source will be called with the current query and a\n callback function as parameters, and should either return an array of\n results (for synchronous operation) or return nothing and pass an\n array of results to the provided callback (for asynchronous\n operation).\n \n\n \n Example (synchronous):\n \n\n <pre>\n function (query) {\n return ['foo', 'bar'];\n }\n </pre>\n\n \n Example (async):\n \n\n <pre>\n function (query, callback) {\n callback(['foo', 'bar']);\n }\n </pre>\n </dd>\n\n <dt>Object</dt>\n <dd>\n \n An object will be treated as a query hashmap. If a property on the\n object matches the current query, the value of that property will be\n used as the response.\n \n\n \n The response is assumed to be an array of results by default. If the\n response is not an array, provide a `resultListLocator` to\n process the response and return an array.\n \n\n \n Example: `{foo: ['foo result 1', 'foo result 2'], bar: ['bar result']}`\n \n </dd>\n</dl>\n\nIf the optional `autocomplete-sources` module is loaded, then\nthe following additional source types will be supported as well:\n\n<dl>\n <dt><select> Node</dt>\n <dd>\n You may provide a YUI Node instance wrapping a <select>\n element, and the options in the list will be used as results. You\n will also need to specify a `resultTextLocator` of 'text'\n or 'value', depending on what you want to use as the text of the\n result.\n\n Each result will be an object with the following properties:\n\n <dl>\n <dt>html (String)</dt>\n <dd>\n HTML content of the <option> element.\n </dd>\n\n <dt>index (Number)</dt>\n <dd>\n Index of the <option> element in the list.\n </dd>\n\n <dt>node (Y.Node)</dt>\n <dd>\n Node instance referring to the original <option> element.\n </dd>\n\n <dt>selected (Boolean)</dt>\n <dd>\n Whether or not this item is currently selected in the\n <select> list.\n </dd>\n\n <dt>text (String)</dt>\n <dd>\n Text content of the <option> element.\n </dd>\n\n <dt>value (String)</dt>\n <dd>\n Value of the <option> element.\n </dd>\n </dl>\n </dd>\n\n <dt>String (JSONP URL)</dt>\n <dd>\n \n If a URL with a `{callback}` placeholder is provided, it will be used to\n make a JSONP request. The `{query}` placeholder will be replaced with\n the current query, and the `{callback}` placeholder will be replaced\n with an internally-generated JSONP callback name. Both placeholders must\n appear in the URL, or the request will fail. An optional `{maxResults}`\n placeholder may also be provided, and will be replaced with the value of\n the maxResults attribute (or 1000 if the maxResults attribute is 0 or\n less).\n \n\n \n The response is assumed to be an array of results by default. If the\n response is not an array, provide a `resultListLocator` to process the\n response and return an array.\n \n\n \n The `jsonp` module must be loaded in order for\n JSONP URL sources to work. If the `jsonp` module\n is not already loaded, it will be loaded on demand if possible.\n \n\n \n Example: `'http://example.com/search?q={query}&callback={callback}'`\n \n </dd>\n\n <dt>String (XHR URL)</dt>\n <dd>\n \n If a URL without a `{callback}` placeholder is provided, it will be used\n to make a same-origin XHR request. The `{query}` placeholder will be\n replaced with the current query. An optional `{maxResults}` placeholder\n may also be provided, and will be replaced with the value of the\n maxResults attribute (or 1000 if the maxResults attribute is 0 or less).\n \n\n \n The response is assumed to be a JSON array of results by default. If the\n response is a JSON object and not an array, provide a\n `resultListLocator` to process the response and return an array. If the\n response is in some form other than JSON, you will need to use a custom\n DataSource instance as the source.\n \n\n \n The `io-base` and `json-parse` modules\n must be loaded in order for XHR URL sources to work. If\n these modules are not already loaded, they will be loaded on demand\n if possible.\n \n\n \n Example: `'http://example.com/search?q={query}'`\n \n </dd>\n\n <dt>String (YQL query)</dt>\n <dd>\n \n If a YQL query is provided, it will be used to make a YQL request. The\n `{query}` placeholder will be replaced with the current autocomplete\n query. This placeholder must appear in the YQL query, or the request\n will fail. An optional `{maxResults}` placeholder may also be provided,\n and will be replaced with the value of the maxResults attribute (or 1000\n if the maxResults attribute is 0 or less).\n \n\n \n The `yql` module must be loaded in order for YQL\n sources to work. If the `yql` module is not\n already loaded, it will be loaded on demand if possible.\n \n\n \n Example: `'select * from search.suggest where query=\"{query}\"'`\n \n </dd>\n</dl>\n\nAs an alternative to providing a source, you could simply listen for `query`\nevents and handle them any way you see fit. Providing a source is optional,\nbut will usually be simpler.",

27438

"itemtype": "attribute",

27439

"name": "source",

27440

27441

"class": "AutoCompleteBase",

27442

"module": "autocomplete",

27443

"submodule": "autocomplete-base"

27444

},

27445

{

27446

"file": "autocomplete/js/autocomplete-base.js",

27447

"line": 1469,

27448

"description": "May be used to force a specific source type, overriding the automatic source\ntype detection. It should almost never be necessary to do this, but as they\ntaught us in the Boy Scouts, one should always be prepared, so it's here if\nyou need it. Be warned that if you set this attribute and something breaks,\nit's your own fault.\n\nSupported `sourceType` values are: 'array', 'datasource', 'function', and\n'object'.\n\nIf the `autocomplete-sources` module is loaded, the following additional\nsource types are supported: 'io', 'jsonp', 'select', 'string', 'yql'",

27449

"itemtype": "attribute",

27450

"name": "sourceType",

27451

"type": "String",

27452

"class": "AutoCompleteBase",

27453

"module": "autocomplete",

27454

"submodule": "autocomplete-base"

27455

},

27456

{

27457

"file": "autocomplete/js/autocomplete-base.js",

27458

"line": 1489,

27459

"description": "If the `inputNode` specified at instantiation time has a `node-tokeninput`\nplugin attached to it, this attribute will be a reference to the\n`Y.Plugin.TokenInput` instance.",

27460

"itemtype": "attribute",

27461

"name": "tokenInput",

27462

"type": "Plugin.TokenInput",

27463

"readonly": "",

27464

"class": "AutoCompleteBase",

27465

"module": "autocomplete",

27466

"submodule": "autocomplete-base"

27467

},

27468

{

27469

"file": "autocomplete/js/autocomplete-base.js",

27470

"line": 1502,

27471

"description": "Current value of the input node.",

27472

"itemtype": "attribute",

27473

"name": "value",

27474

"type": "String",

27475

"default": "''",

27476

"class": "AutoCompleteBase",

27477

"module": "autocomplete",

27478

"submodule": "autocomplete-base"

27479

},

27480

{

27481

"file": "autocomplete/js/autocomplete-base.js",

27482

"line": 1525,

27483

"description": "Mapping of built-in source types to their setter functions. DataSource instances\nand DataSource-like objects are handled natively, so are not mapped here.",

27484

"itemtype": "property",

27485

"name": "SOURCE_TYPES",

27486

"type": "{Object}",

27487

"static": 1,

27488

"class": "AutoCompleteBase",

27489

"module": "autocomplete",

27490

"submodule": "autocomplete-base"

27491

},

27492

{

27493

"file": "autocomplete/js/autocomplete-filters-accentfold.js",

27494

"line": 23,

27495

"description": "Accent folding version of `charMatch()`.",

27496

"itemtype": "method",

27497

"name": "charMatchFold",

27498

"params": [

27499

{

27500

"name": "query",

27501

"description": "Query to match",

27502

"type": "String"

27503

},

27504

{

27505

"name": "results",

27506

"description": "Results to filter",

27507

"type": "Array"

27508

}

27509

],

27510

"return": {

27511

"description": "Filtered results",

27512

"type": "Array"

27513

},

27514

"static": 1,

27515

"class": "AutoCompleteFilters",

27516

"module": "autocomplete",

27517

"submodule": "autocomplete-filters-accentfold"

27518

},

27519

{

27520

"file": "autocomplete/js/autocomplete-filters-accentfold.js",

27521

"line": 46,

27522

"description": "Accent folding version of `phraseMatch()`.",

27523

"itemtype": "method",

27524

"name": "phraseMatchFold",

27525

"params": [

27526

{

27527

"name": "query",

27528

"description": "Query to match",

27529

"type": "String"

27530

},

27531

{

27532

"name": "results",

27533

"description": "Results to filter",

27534

"type": "Array"

27535

}

27536

],

27537

"return": {

27538

"description": "Filtered results",

27539

"type": "Array"

27540

},

27541

"static": 1,

27542

"class": "AutoCompleteFilters",

27543

"module": "autocomplete",

27544

"submodule": "autocomplete-filters-accentfold"

27545

},

27546

{

27547

"file": "autocomplete/js/autocomplete-filters-accentfold.js",

27548

"line": 65,

27549

"description": "Accent folding version of `startsWith()`.",

27550

"itemtype": "method",

27551

"name": "startsWithFold",

27552

"params": [

27553

{

27554

"name": "query",

27555

"description": "Query to match",

27556

"type": "String"

27557

},

27558

{

27559

"name": "results",

27560

"description": "Results to filter",

27561

"type": "Array"

27562

}

27563

],

27564

"return": {

27565

"description": "Filtered results",

27566

"type": "Array"

27567

},

27568

"static": 1,

27569

"class": "AutoCompleteFilters",

27570

"module": "autocomplete",

27571

"submodule": "autocomplete-filters-accentfold"

27572

},

27573

{

27574

"file": "autocomplete/js/autocomplete-filters-accentfold.js",

27575

"line": 84,

27576

"description": "Accent folding version of `subWordMatch()`.",

27577

"itemtype": "method",

27578

"name": "subWordMatchFold",

27579

"params": [

27580

{

27581

"name": "query",

27582

"description": "Query to match",

27583

"type": "String"

27584

},

27585

{

27586

"name": "results",

27587

"description": "Results to filter",

27588

"type": "Array"

27589

}

27590

],

27591

"return": {

27592

"description": "Filtered results",

27593

"type": "Array"

27594

},

27595

"static": 1,

27596

"class": "AutoCompleteFilters",

27597

"module": "autocomplete",

27598

"submodule": "autocomplete-filters-accentfold"

27599

},

27600

{

27601

"file": "autocomplete/js/autocomplete-filters-accentfold.js",

27602

"line": 107,

27603

"description": "Accent folding version of `wordMatch()`.",

27604

"itemtype": "method",

27605

"name": "wordMatchFold",

27606

"params": [

27607

{

27608

"name": "query",

27609

"description": "Query to match",

27610

"type": "String"

27611

},

27612

{

27613

"name": "results",

27614

"description": "Results to filter",

27615

"type": "Array"

27616

}

27617

],

27618

"return": {

27619

"description": "Filtered results",

27620

"type": "Array"

27621

},

27622

"static": 1,

27623

"class": "AutoCompleteFilters",

27624

"module": "autocomplete",

27625

"submodule": "autocomplete-filters-accentfold"

27626

},

27627

{

27628

"file": "autocomplete/js/autocomplete-filters.js",

27629

"line": 17,

27630

"description": "Returns an array of results that contain all of the characters in the query,\nin any order (not necessarily consecutive). Case-insensitive.",

27631

"itemtype": "method",

27632

"name": "charMatch",

27633

"params": [

27634

{

27635

"name": "query",

27636

"description": "Query to match",

27637

"type": "String"

27638

},

27639

{

27640

"name": "results",

27641

"description": "Results to filter",

27642

"type": "Array"

27643

}

27644

],

27645

"return": {

27646

"description": "Filtered results",

27647

"type": "Array"

27648

},

27649

"static": 1,

27650

"class": "AutoCompleteFilters",

27651

"module": "autocomplete",

27652

"submodule": "autocomplete-filters"

27653

},

27654

{

27655

"file": "autocomplete/js/autocomplete-filters.js",

27656

"line": 49,

27657

"description": "Case-sensitive version of `charMatch()`.",

27658

"itemtype": "method",

27659

"name": "charMatchCase",

27660

"params": [

27661

{

27662

"name": "query",

27663

"description": "Query to match",

27664

"type": "String"

27665

},

27666

{

27667

"name": "results",

27668

"description": "Results to filter",

27669

"type": "Array"

27670

}

27671

],

27672

"return": {

27673

"description": "Filtered results",

27674

"type": "Array"

27675

},

27676

"static": 1,

27677

"class": "AutoCompleteFilters",

27678

"module": "autocomplete",

27679

"submodule": "autocomplete-filters"

27680

},

27681

{

27682

"file": "autocomplete/js/autocomplete-filters.js",

27683

"line": 62,

27684

"description": "Returns an array of results that contain the complete query as a phrase.\nCase-insensitive.",

27685

"itemtype": "method",

27686

"name": "phraseMatch",

27687

"params": [

27688

{

27689

"name": "query",

27690

"description": "Query to match",

27691

"type": "String"

27692

},

27693

{

27694

"name": "results",

27695

"description": "Results to filter",

27696

"type": "Array"

27697

}

27698

],

27699

"return": {

27700

"description": "Filtered results",

27701

"type": "Array"

27702

},

27703

"static": 1,

27704

"class": "AutoCompleteFilters",

27705

"module": "autocomplete",

27706

"submodule": "autocomplete-filters"

27707

},

27708

{

27709

"file": "autocomplete/js/autocomplete-filters.js",

27710

"line": 87,

27711

"description": "Case-sensitive version of `phraseMatch()`.",

27712

"itemtype": "method",

27713

"name": "phraseMatchCase",

27714

"params": [

27715

{

27716

"name": "query",

27717

"description": "Query to match",

27718

"type": "String"

27719

},

27720

{

27721

"name": "results",

27722

"description": "Results to filter",

27723

"type": "Array"

27724

}

27725

],

27726

"return": {

27727

"description": "Filtered results",

27728

"type": "Array"

27729

},

27730

"static": 1,

27731

"class": "AutoCompleteFilters",

27732

"module": "autocomplete",

27733

"submodule": "autocomplete-filters"

27734

},

27735

{

27736

"file": "autocomplete/js/autocomplete-filters.js",

27737

"line": 100,

27738

"description": "Returns an array of results that start with the complete query as a phrase.\nCase-insensitive.",

27739

"itemtype": "method",

27740

"name": "startsWith",

27741

"params": [

27742

{

27743

"name": "query",

27744

"description": "Query to match",

27745

"type": "String"

27746

},

27747

{

27748

"name": "results",

27749

"description": "Results to filter",

27750

"type": "Array"

27751

}

27752

],

27753

"return": {

27754

"description": "Filtered results",

27755

"type": "Array"

27756

},

27757

"static": 1,

27758

"class": "AutoCompleteFilters",

27759

"module": "autocomplete",

27760

"submodule": "autocomplete-filters"

27761

},

27762

{

27763

"file": "autocomplete/js/autocomplete-filters.js",

27764

"line": 125,

27765

"description": "Case-sensitive version of `startsWith()`.",

27766

"itemtype": "method",

27767

"name": "startsWithCase",

27768

"params": [

27769

{

27770

"name": "query",

27771

"description": "Query to match",

27772

"type": "String"

27773

},

27774

{

27775

"name": "results",

27776

"description": "Results to filter",

27777

"type": "Array"

27778

}

27779

],

27780

"return": {

27781

"description": "Filtered results",

27782

"type": "Array"

27783

},

27784

"static": 1,

27785

"class": "AutoCompleteFilters",

27786

"module": "autocomplete",

27787

"submodule": "autocomplete-filters"

27788

},

27789

{

27790

"file": "autocomplete/js/autocomplete-filters.js",

27791

"line": 138,

27792

"description": "Returns an array of results in which all the words of the query match either\nwhole words or parts of words in the result. Non-word characters like\nwhitespace and certain punctuation are ignored. Case-insensitive.\n\nThis is basically a combination of `wordMatch()` (by ignoring whitespace and\nword order) and `phraseMatch()` (by allowing partial matching instead of\nrequiring the entire word to match).\n\nExample use case: Trying to find personal names independently of name order\n(Western or Eastern order) and supporting immediate feedback by allowing\npartial occurences. So queries like \"J. Doe\", \"Doe, John\", and \"J. D.\" would\nall match \"John Doe\".",

27793

"itemtype": "method",

27794

"name": "subWordMatch",

27795

"params": [

27796

{

27797

"name": "query",

27798

"description": "Query to match",

27799

"type": "String"

27800

},

27801

{

27802

"name": "results",

27803

"description": "Results to filter",

27804

"type": "Array"

27805

}

27806

],

27807

"return": {

27808

"description": "Filtered results",

27809

"type": "Array"

27810

},

27811

"static": 1,

27812

"class": "AutoCompleteFilters",

27813

"module": "autocomplete",

27814

"submodule": "autocomplete-filters"

27815

},

27816

{

27817

"file": "autocomplete/js/autocomplete-filters.js",

27818

"line": 178,

27819

"description": "Case-sensitive version of `subWordMatch()`.",

27820

"itemtype": "method",

27821

"name": "subWordMatchCase",

27822

"params": [

27823

{

27824

"name": "query",

27825

"description": "Query to match",

27826

"type": "String"

27827

},

27828

{

27829

"name": "results",

27830

"description": "Results to filter",

27831

"type": "Array"

27832

}

27833

],

27834

"return": {

27835

"description": "Filtered results",

27836

"type": "Array"

27837

},

27838

"static": 1,

27839

"class": "AutoCompleteFilters",

27840

"module": "autocomplete",

27841

"submodule": "autocomplete-filters"

27842

},

27843

{

27844

"file": "autocomplete/js/autocomplete-filters.js",

27845

"line": 191,

27846

"description": "Returns an array of results that contain all of the words in the query, in\nany order. Non-word characters like whitespace and certain punctuation are\nignored. Case-insensitive.",

27847

"itemtype": "method",

27848

"name": "wordMatch",

27849

"params": [

27850

{

27851

"name": "query",

27852

"description": "Query to match",

27853

"type": "String"

27854

},

27855

{

27856

"name": "results",

27857

"description": "Results to filter",

27858

"type": "Array"

27859

}

27860

],

27861

"return": {

27862

"description": "Filtered results",

27863

"type": "Array"

27864

},

27865

"static": 1,

27866

"class": "AutoCompleteFilters",

27867

"module": "autocomplete",

27868

"submodule": "autocomplete-filters"

27869

},

27870

{

27871

"file": "autocomplete/js/autocomplete-filters.js",

27872

"line": 222,

27873

"description": "Case-sensitive version of `wordMatch()`.",

27874

"itemtype": "method",

27875

"name": "wordMatchCase",

27876

"params": [

27877

{

27878

"name": "query",

27879

"description": "Query to match",

27880

"type": "String"

27881

},

27882

{

27883

"name": "results",

27884

"description": "Results to filter",

27885

"type": "Array"

27886

}

27887

],

27888

"return": {

27889

"description": "Filtered results",

27890

"type": "Array"

27891

},

27892

"static": 1,

27893

"class": "AutoCompleteFilters",

27894

"module": "autocomplete",

27895

"submodule": "autocomplete-filters"

27896

},

27897

{

27898

"file": "autocomplete/js/autocomplete-highlighters-accentfold.js",

27899

"line": 22,

27900

"description": "Accent-folding version of `charMatch()`.",

27901

"itemtype": "method",

27902

"name": "charMatchFold",

27903

"params": [

27904

{

27905

"name": "query",

27906

"description": "Query to match",

27907

"type": "String"

27908

},

27909

{

27910

"name": "results",

27911

"description": "Results to highlight",

27912

"type": "Array"

27913

}

27914

],

27915

"return": {

27916

"description": "Highlighted results",

27917

"type": "Array"

27918

},

27919

"static": 1,

27920

"class": "AutoCompleteHighlighters",

27921

"module": "autocomplete",

27922

"submodule": "autocomplete-highlighters-accentfold"

27923

},

27924

{

27925

"file": "autocomplete/js/autocomplete-highlighters-accentfold.js",

27926

"line": 39,

27927

"description": "Accent-folding version of `phraseMatch()`.",

27928

"itemtype": "method",

27929

"name": "phraseMatchFold",

27930

"params": [

27931

{

27932

"name": "query",

27933

"description": "Query to match",

27934

"type": "String"

27935

},

27936

{

27937

"name": "results",

27938

"description": "Results to highlight",

27939

"type": "Array"

27940

}

27941

],

27942

"return": {

27943

"description": "Highlighted results",

27944

"type": "Array"

27945

},

27946

"static": 1,

27947

"class": "AutoCompleteHighlighters",

27948

"module": "autocomplete",

27949

"submodule": "autocomplete-highlighters-accentfold"

27950

},

27951

{

27952

"file": "autocomplete/js/autocomplete-highlighters-accentfold.js",

27953

"line": 54,

27954

"description": "Accent-folding version of `startsWith()`.",

27955

"itemtype": "method",

27956

"name": "startsWithFold",

27957

"params": [

27958

{

27959

"name": "query",

27960

"description": "Query to match",

27961

"type": "String"

27962

},

27963

{

27964

"name": "results",

27965

"description": "Results to highlight",

27966

"type": "Array"

27967

}

27968

],

27969

"return": {

27970

"description": "Highlighted results",

27971

"type": "Array"

27972

},

27973

"static": 1,

27974

"class": "AutoCompleteHighlighters",

27975

"module": "autocomplete",

27976

"submodule": "autocomplete-highlighters-accentfold"

27977

},

27978

{

27979

"file": "autocomplete/js/autocomplete-highlighters-accentfold.js",

27980

"line": 71,

27981

"description": "Accent-folding version of `subWordMatch()`.",

27982

"itemtype": "method",

27983

"name": "subWordMatchFold",

27984

"params": [

27985

{

27986

"name": "query",

27987

"description": "Query to match",

27988

"type": "String"

27989

},

27990

{

27991

"name": "results",

27992

"description": "Results to highlight",

27993

"type": "Array"

27994

}

27995

],

27996

"return": {

27997

"description": "Highlighted results",

27998

"type": "Array"

27999

},

28000

"static": 1,

28001

"class": "AutoCompleteHighlighters",

28002

"module": "autocomplete",

28003

"submodule": "autocomplete-highlighters-accentfold"

28004

},

28005

{

28006

"file": "autocomplete/js/autocomplete-highlighters-accentfold.js",

28007

"line": 88,

28008

"description": "Accent-folding version of `wordMatch()`.",

28009

"itemtype": "method",

28010

"name": "wordMatchFold",

28011

"params": [

28012

{

28013

"name": "query",

28014

"description": "Query to match",

28015

"type": "String"

28016

},

28017

{

28018

"name": "results",

28019

"description": "Results to highlight",

28020

"type": "Array"

28021

}

28022

],

28023

"return": {

28024

"description": "Highlighted results",

28025

"type": "Array"

28026

},

28027

"static": 1,

28028

"class": "AutoCompleteHighlighters",

28029

"module": "autocomplete",

28030

"submodule": "autocomplete-highlighters-accentfold"

28031

},

28032

{

28033

"file": "autocomplete/js/autocomplete-highlighters.js",

28034

"line": 16,

28035

"description": "Highlights any individual query character that occurs anywhere in a result.\nCase-insensitive.",

28036

"itemtype": "method",

28037

"name": "charMatch",

28038

"params": [

28039

{

28040

"name": "query",

28041

"description": "Query to match",

28042

"type": "String"

28043

},

28044

{

28045

"name": "results",

28046

"description": "Results to highlight",

28047

"type": "Array"

28048

}

28049

],

28050

"return": {

28051

"description": "Highlighted results",

28052

"type": "Array"

28053

},

28054

"static": 1,

28055

"class": "AutoCompleteHighlighters",

28056

"module": "autocomplete",

28057

"submodule": "autocomplete-highlighters"

28058

},

28059

{

28060

"file": "autocomplete/js/autocomplete-highlighters.js",

28061

"line": 40,

28062

"description": "Case-sensitive version of `charMatch()`.",

28063

"itemtype": "method",

28064

"name": "charMatchCase",

28065

"params": [

28066

{

28067

"name": "query",

28068

"description": "Query to match",

28069

"type": "String"

28070

},

28071

{

28072

"name": "results",

28073

"description": "Results to highlight",

28074

"type": "Array"

28075

}

28076

],

28077

"return": {

28078

"description": "Highlighted results",

28079

"type": "Array"

28080

},

28081

"static": 1,

28082

"class": "AutoCompleteHighlighters",

28083

"module": "autocomplete",

28084

"submodule": "autocomplete-highlighters"

28085

},

28086

{

28087

"file": "autocomplete/js/autocomplete-highlighters.js",

28088

"line": 53,

28089

"description": "Highlights the complete query as a phrase anywhere within a result. Case-\ninsensitive.",

28090

"itemtype": "method",

28091

"name": "phraseMatch",

28092

"params": [

28093

{

28094

"name": "query",

28095

"description": "Query to match",

28096

"type": "String"

28097

},

28098

{

28099

"name": "results",

28100

"description": "Results to highlight",

28101

"type": "Array"

28102

}

28103

],

28104

"return": {

28105

"description": "Highlighted results",

28106

"type": "Array"

28107

},

28108

"static": 1,

28109

"class": "AutoCompleteHighlighters",

28110

"module": "autocomplete",

28111

"submodule": "autocomplete-highlighters"

28112

},

28113

{

28114

"file": "autocomplete/js/autocomplete-highlighters.js",

28115

"line": 74,

28116

"description": "Case-sensitive version of `phraseMatch()`.",

28117

"itemtype": "method",

28118

"name": "phraseMatchCase",

28119

"params": [

28120

{

28121

"name": "query",

28122

"description": "Query to match",

28123

"type": "String"

28124

},

28125

{

28126

"name": "results",

28127

"description": "Results to highlight",

28128

"type": "Array"

28129

}

28130

],

28131

"return": {

28132

"description": "Highlighted results",

28133

"type": "Array"

28134

},

28135

"static": 1,

28136

"class": "AutoCompleteHighlighters",

28137

"module": "autocomplete",

28138

"submodule": "autocomplete-highlighters"

28139

},

28140

{

28141

"file": "autocomplete/js/autocomplete-highlighters.js",

28142

"line": 87,

28143

"description": "Highlights the complete query as a phrase at the beginning of a result.\nCase-insensitive.",

28144

"itemtype": "method",

28145

"name": "startsWith",

28146

"params": [

28147

{

28148

"name": "query",

28149

"description": "Query to match",

28150

"type": "String"

28151

},

28152

{

28153

"name": "results",

28154

"description": "Results to highlight",

28155

"type": "Array"

28156

}

28157

],

28158

"return": {

28159

"description": "Highlighted results",

28160

"type": "Array"

28161

},

28162

"static": 1,

28163

"class": "AutoCompleteHighlighters",

28164

"module": "autocomplete",

28165

"submodule": "autocomplete-highlighters"

28166

},

28167

{

28168

"file": "autocomplete/js/autocomplete-highlighters.js",

28169

"line": 109,

28170

"description": "Case-sensitive version of `startsWith()`.",

28171

"itemtype": "method",

28172

"name": "startsWithCase",

28173

"params": [

28174

{

28175

"name": "query",

28176

"description": "Query to match",

28177

"type": "String"

28178

},

28179

{

28180

"name": "results",

28181

"description": "Results to highlight",

28182

"type": "Array"

28183

}

28184

],

28185

"return": {

28186

"description": "Highlighted results",

28187

"type": "Array"

28188

},

28189

"static": 1,

28190

"class": "AutoCompleteHighlighters",

28191

"module": "autocomplete",

28192

"submodule": "autocomplete-highlighters"

28193

},

28194

{

28195

"file": "autocomplete/js/autocomplete-highlighters.js",

28196

"line": 122,

28197

"description": "Highlights portions of results in which words from the query match either\nwhole words or parts of words in the result. Non-word characters like\nwhitespace and certain punctuation are ignored. Case-insensitive.",

28198

"itemtype": "method",

28199

"name": "subWordMatch",

28200

"params": [

28201

{

28202

"name": "query",

28203

"description": "Query to match",

28204

"type": "String"

28205

},

28206

{

28207

"name": "results",

28208

"description": "Results to highlight",

28209

"type": "Array"

28210

}

28211

],

28212

"return": {

28213

"description": "Highlighted results",

28214

"type": "Array"

28215

},

28216

"static": 1,

28217

"class": "AutoCompleteHighlighters",

28218

"module": "autocomplete",

28219

"submodule": "autocomplete-highlighters"

28220

},

28221

{

28222

"file": "autocomplete/js/autocomplete-highlighters.js",

28223

"line": 148,

28224

"description": "Case-sensitive version of `subWordMatch()`.",

28225

"itemtype": "method",

28226

"name": "subWordMatchCase",

28227

"params": [

28228

{

28229

"name": "query",

28230

"description": "Query to match",

28231

"type": "String"

28232

},

28233

{

28234

"name": "results",

28235

"description": "Results to highlight",

28236

"type": "Array"

28237

}

28238

],

28239

"return": {

28240

"description": "Highlighted results",

28241

"type": "Array"

28242

},

28243

"static": 1,

28244

"class": "AutoCompleteHighlighters",

28245

"module": "autocomplete",

28246

"submodule": "autocomplete-highlighters"

28247

},

28248

{

28249

"file": "autocomplete/js/autocomplete-highlighters.js",

28250

"line": 161,

28251

"description": "Highlights individual words in results that are also in the query. Non-word\ncharacters like punctuation are ignored. Case-insensitive.",

28252

"itemtype": "method",

28253

"name": "wordMatch",

28254

"params": [

28255

{

28256

"name": "query",

28257

"description": "Query to match",

28258

"type": "String"

28259

},

28260

{

28261

"name": "results",

28262

"description": "Results to highlight",

28263

"type": "Array"

28264

}

28265

],

28266

"return": {

28267

"description": "Highlighted results",

28268

"type": "Array"

28269

},

28270

"static": 1,

28271

"class": "AutoCompleteHighlighters",

28272

"module": "autocomplete",

28273

"submodule": "autocomplete-highlighters"

28274

},

28275

{

28276

"file": "autocomplete/js/autocomplete-highlighters.js",

28277

"line": 182,

28278

"description": "Case-sensitive version of `wordMatch()`.",

28279

"itemtype": "method",

28280

"name": "wordMatchCase",

28281

"params": [

28282

{

28283

"name": "query",

28284

"description": "Query to match",

28285

"type": "String"

28286

},

28287

{

28288

"name": "results",

28289

"description": "Results to highlight",

28290

"type": "Array"

28291

}

28292

],

28293

"return": {

28294

"description": "Highlighted results",

28295

"type": "Array"

28296

},

28297

"static": 1,

28298

"class": "AutoCompleteHighlighters",

28299

"module": "autocomplete",

28300

"submodule": "autocomplete-highlighters"

28301

},

28302

{

28303

"file": "autocomplete/js/autocomplete-list-keys.js",

28304

"line": 24,

28305

"description": "Initializes keyboard command mappings.",

28306

"itemtype": "method",

28307

"name": "_initKeys",

28308

"access": "protected",

28309

"tagname": "",

28310

"class": "AutoCompleteList",

28311

"module": "autocomplete",

28312

"submodule": "autocomplete-list-keys"

28313

},

28314

{

28315

"file": "autocomplete/js/autocomplete-list-keys.js",

28316

"line": 53,

28317

"description": "Binds keyboard events.",

28318

"itemtype": "method",

28319

"name": "_bindKeys",

28320

"access": "protected",

28321

"tagname": "",

28322

"class": "AutoCompleteList",

28323

"module": "autocomplete",

28324

"submodule": "autocomplete-list-keys"

28325

},

28326

{

28327

"file": "autocomplete/js/autocomplete-list-keys.js",

28328

"line": 63,

28329

"description": "Unbinds keyboard events.",

28330

"itemtype": "method",

28331

"name": "_unbindKeys",

28332

"access": "protected",

28333

"tagname": "",

28334

"class": "AutoCompleteList",

28335

"module": "autocomplete",

28336

"submodule": "autocomplete-list-keys"

28337

},

28338

{

28339

"file": "autocomplete/js/autocomplete-list-keys.js",

28340

"line": 76,

28341

"description": "Called when the down arrow key is pressed.",

28342

"itemtype": "method",

28343

"name": "_keyDown",

28344

"access": "protected",

28345

"tagname": "",

28346

"class": "AutoCompleteList",

28347

"module": "autocomplete",

28348

"submodule": "autocomplete-list-keys"

28349

},

28350

{

28351

"file": "autocomplete/js/autocomplete-list-keys.js",

28352

"line": 90,

28353

"description": "Called when the enter key is pressed.",

28354

"itemtype": "method",

28355

"name": "_keyEnter",

28356

"access": "protected",

28357

"tagname": "",

28358

"class": "AutoCompleteList",

28359

"module": "autocomplete",

28360

"submodule": "autocomplete-list-keys"

28361

},

28362

{

28363

"file": "autocomplete/js/autocomplete-list-keys.js",

28364

"line": 107,

28365

"description": "Called when the escape key is pressed.",

28366

"itemtype": "method",

28367

"name": "_keyEsc",

28368

"access": "protected",

28369

"tagname": "",

28370

"class": "AutoCompleteList",

28371

"module": "autocomplete",

28372

"submodule": "autocomplete-list-keys"

28373

},

28374

{

28375

"file": "autocomplete/js/autocomplete-list-keys.js",

28376

"line": 117,

28377

"description": "Called when the tab key is pressed.",

28378

"itemtype": "method",

28379

"name": "_keyTab",

28380

"access": "protected",

28381

"tagname": "",

28382

"class": "AutoCompleteList",

28383

"module": "autocomplete",

28384

"submodule": "autocomplete-list-keys"

28385

},

28386

{

28387

"file": "autocomplete/js/autocomplete-list-keys.js",

28388

"line": 138,

28389

"description": "Called when the up arrow key is pressed.",

28390

"itemtype": "method",

28391

"name": "_keyUp",

28392

"access": "protected",

28393

"tagname": "",

28394

"class": "AutoCompleteList",

28395

"module": "autocomplete",

28396

"submodule": "autocomplete-list-keys"

28397

},

28398

{

28399

"file": "autocomplete/js/autocomplete-list-keys.js",

28400

"line": 150,

28401

"description": "Handles `inputNode` key events.",

28402

"itemtype": "method",

28403

"name": "_onInputKey",

28404

"params": [

28405

{

28406

"name": "e",

28407

"description": "",

28408

"type": "EventTarget"

28409

}

28410

],

28411

"access": "protected",

28412

"tagname": "",

28413

"class": "AutoCompleteList",

28414

"module": "autocomplete",

28415

"submodule": "autocomplete-list-keys"

28416

},

28417

{

28418

"file": "autocomplete/js/autocomplete-list.js",

28419

"line": 99,

28420

"description": "Fires when an autocomplete suggestion is selected from the list,\ntypically via a keyboard action or mouse click.",

28421

"itemtype": "event",

28422

"name": "select",

28423

"params": [

28424

{

28425

"name": "itemNode",

28426

"description": "List item node that was selected.",

28427

"type": "Node"

28428

},

28429

{

28430

"name": "result",

28431

"description": "AutoComplete result object.",

28432

"type": "Object"

28433

}

28434

],

28435

"preventable": "_defSelectFn",

28436

"class": "AutoCompleteList",

28437

"module": "autocomplete",

28438

"submodule": "autocomplete-list"

28439

},

28440

{

28441

"file": "autocomplete/js/autocomplete-list.js",

28442

"line": 173,

28443

"description": "Hides the list, unless the `alwaysShowList` attribute is `true`.",

28444

"itemtype": "method",

28445

"name": "hide",

28446

"see": [

28447

"show"

28448

],

28449

"chainable": 1,

28450

"class": "AutoCompleteList",

28451

"module": "autocomplete",

28452

"submodule": "autocomplete-list"

28453

},

28454

{

28455

"file": "autocomplete/js/autocomplete-list.js",

28456

"line": 184,

28457

"description": "Selects the specified _itemNode_, or the current `activeItem` if _itemNode_\nis not specified.",

28458

"itemtype": "method",

28459

"name": "selectItem",

28460

"params": [

28461

{

28462

"name": "itemNode",

28463

"description": "Item node to select.",

28464

"type": "Node",

28465

"optional": true

28466

},

28467

{

28468

"name": "originEvent",

28469

"description": "Event that triggered the selection, if\n any.",

28470

"type": "EventFacade",

28471

"optional": true

28472

}

28473

],

28474

"chainable": 1,

28475

"class": "AutoCompleteList",

28476

"module": "autocomplete",

28477

"submodule": "autocomplete-list"

28478

},

28479

{

28480

"file": "autocomplete/js/autocomplete-list.js",

28481

"line": 218,

28482

"description": "Activates the next item after the currently active item. If there is no next\nitem and the `circular` attribute is `true`, focus will wrap back to the\ninput node.",

28483

"itemtype": "method",

28484

"name": "_activateNextItem",

28485

"chainable": 1,

28486

"access": "protected",

28487

"tagname": "",

28488

"class": "AutoCompleteList",

28489

"module": "autocomplete",

28490

"submodule": "autocomplete-list"

28491

},

28492

{

28493

"file": "autocomplete/js/autocomplete-list.js",

28494

"line": 243,

28495

"description": "Activates the item previous to the currently active item. If there is no\nprevious item and the `circular` attribute is `true`, focus will wrap back\nto the input node.",

28496

"itemtype": "method",

28497

"name": "_activatePrevItem",

28498

"chainable": 1,

28499

"access": "protected",

28500

"tagname": "",

28501

"class": "AutoCompleteList",

28502

"module": "autocomplete",

28503

"submodule": "autocomplete-list"

28504

},

28505

{

28506

"file": "autocomplete/js/autocomplete-list.js",

28507

"line": 262,

28508

"description": "Appends the specified result _items_ to the list inside a new item node.",

28509

"itemtype": "method",

28510

"name": "_add",

28511

"params": [

28512

{

28513

"name": "items",

28514

"description": "Result item or array of\n result items.",

28515

"type": "Array|Node|HTMLElement|String"

28516

}

28517

],

28518

"return": {

28519

"description": "Added nodes.",

28520

"type": "NodeList"

28521

},

28522

"access": "protected",

28523

"tagname": "",

28524

"class": "AutoCompleteList",

28525

"module": "autocomplete",

28526

"submodule": "autocomplete-list"

28527

},

28528

{

28529

"file": "autocomplete/js/autocomplete-list.js",

28530

"line": 284,

28531

"description": "Updates the ARIA live region with the specified message.",

28532

"itemtype": "method",

28533

"name": "_ariaSay",

28534

"params": [

28535

{

28536

"name": "stringId",

28537

"description": "String id (from the `strings` attribute) of the\n message to speak.",

28538

"type": "String"

28539

},

28540

{

28541

"name": "subs",

28542

"description": "Substitutions for placeholders in the string.",

28543

"type": "Object",

28544

"optional": true

28545

}

28546

],

28547

"access": "protected",

28548

"tagname": "",

28549

"class": "AutoCompleteList",

28550

"module": "autocomplete",

28551

"submodule": "autocomplete-list"

28552

},

28553

{

28554

"file": "autocomplete/js/autocomplete-list.js",

28555

"line": 298,

28556

"description": "Binds `inputNode` events and behavior.",

28557

"itemtype": "method",

28558

"name": "_bindInput",

28559

"access": "protected",

28560

"tagname": "",

28561

"class": "AutoCompleteList",

28562

"module": "autocomplete",

28563

"submodule": "autocomplete-list"

28564

},

28565

{

28566

"file": "autocomplete/js/autocomplete-list.js",

28567

"line": 337,

28568

"description": "Binds list events.",

28569

"itemtype": "method",

28570

"name": "_bindList",

28571

"access": "protected",

28572

"tagname": "",

28573

"class": "AutoCompleteList",

28574

"module": "autocomplete",

28575

"submodule": "autocomplete-list"

28576

},

28577

{

28578

"file": "autocomplete/js/autocomplete-list.js",

28579

"line": 364,

28580

"description": "Clears the contents of the tray.",

28581

"itemtype": "method",

28582

"name": "_clear",

28583

"access": "protected",

28584

"tagname": "",

28585

"class": "AutoCompleteList",

28586

"module": "autocomplete",

28587

"submodule": "autocomplete-list"

28588

},

28589

{

28590

"file": "autocomplete/js/autocomplete-list.js",

28591

"line": 377,

28592

"description": "Creates and returns an ARIA live region node.",

28593

"itemtype": "method",

28594

"name": "_createAriaNode",

28595

"return": {

28596

"description": "ARIA node.",

28597

"type": "Node"

28598

},

28599

"access": "protected",

28600

"tagname": "",

28601

"class": "AutoCompleteList",

28602

"module": "autocomplete",

28603

"submodule": "autocomplete-list"

28604

},

28605

{

28606

"file": "autocomplete/js/autocomplete-list.js",

28607

"line": 393,

28608

"description": "Creates and returns an item node with the specified _content_.",

28609

"itemtype": "method",

28610

"name": "_createItemNode",

28611

"params": [

28612

{

28613

"name": "result",

28614

"description": "Result object.",

28615

"type": "Object"

28616

}

28617

],

28618

"return": {

28619

"description": "Item node.",

28620

"type": "Node"

28621

},

28622

"access": "protected",

28623

"tagname": "",

28624

"class": "AutoCompleteList",

28625

"module": "autocomplete",

28626

"submodule": "autocomplete-list"

28627

},

28628

{

28629

"file": "autocomplete/js/autocomplete-list.js",

28630

"line": 410,

28631

"description": "Creates and returns a list node. If the `listNode` attribute is already set\nto an existing node, that node will be used.",

28632

"itemtype": "method",

28633

"name": "_createListNode",

28634

"return": {

28635

"description": "List node.",

28636

"type": "Node"

28637

},

28638

"access": "protected",

28639

"tagname": "",

28640

"class": "AutoCompleteList",

28641

"module": "autocomplete",

28642

"submodule": "autocomplete-list"

28643

},

28644

{

28645

"file": "autocomplete/js/autocomplete-list.js",

28646

"line": 432,

28647

"description": "Gets the first item node in the list, or `null` if the list is empty.",

28648

"itemtype": "method",

28649

"name": "_getFirstItemNode",

28650

"return": {

28651

"description": "",

28652

"type": "Node|null"

28653

},

28654

"access": "protected",

28655

"tagname": "",

28656

"class": "AutoCompleteList",

28657

"module": "autocomplete",

28658

"submodule": "autocomplete-list"

28659

},

28660

{

28661

"file": "autocomplete/js/autocomplete-list.js",

28662

"line": 443,

28663

"description": "Gets the last item node in the list, or `null` if the list is empty.",

28664

"itemtype": "method",

28665

"name": "_getLastItemNode",

28666

"return": {

28667

"description": "",

28668

"type": "Node|null"

28669

},

28670

"access": "protected",

28671

"tagname": "",

28672

"class": "AutoCompleteList",

28673

"module": "autocomplete",

28674

"submodule": "autocomplete-list"

28675

},

28676

{

28677

"file": "autocomplete/js/autocomplete-list.js",

28678

"line": 454,

28679

"description": "Synchronizes the result list's position and alignment.",

28680

"itemtype": "method",

28681

"name": "_syncPosition",

28682

"access": "protected",

28683

"tagname": "",

28684

"class": "AutoCompleteList",

28685

"module": "autocomplete",

28686

"submodule": "autocomplete-list"

28687

},

28688

{

28689

"file": "autocomplete/js/autocomplete-list.js",

28690

"line": 468,

28691

"description": "Synchronizes the results displayed in the list with those in the _results_\nargument, or with the `results` attribute if an argument is not provided.",

28692

"itemtype": "method",

28693

"name": "_syncResults",

28694

"params": [

28695

{

28696

"name": "results",

28697

"description": "Results.",

28698

"type": "Array",

28699

"optional": true

28700

}

28701

],

28702

"access": "protected",

28703

"tagname": "",

28704

"class": "AutoCompleteList",

28705

"module": "autocomplete",

28706

"submodule": "autocomplete-list"

28707

},

28708

{

28709

"file": "autocomplete/js/autocomplete-list.js",

28710

"line": 495,

28711

"description": "Synchronizes the size of the iframe shim used for IE6 and lower. In other\nbrowsers, this method is a noop.",

28712

"itemtype": "method",

28713

"name": "_syncShim",

28714

"access": "protected",

28715

"tagname": "",

28716

"class": "AutoCompleteList",

28717

"module": "autocomplete",

28718

"submodule": "autocomplete-list"

28719

},

28720

{

28721

"file": "autocomplete/js/autocomplete-list.js",

28722

"line": 506,

28723

"description": "Synchronizes the visibility of the tray with the _visible_ argument, or with\nthe `visible` attribute if an argument is not provided.",

28724

"itemtype": "method",

28725

"name": "_syncVisibility",

28726

"params": [

28727

{

28728

"name": "visible",

28729

"description": "Visibility.",

28730

"type": "Boolean",

28731

"optional": true

28732

}

28733

],

28734

"access": "protected",

28735

"tagname": "",

28736

"class": "AutoCompleteList",

28737

"module": "autocomplete",

28738

"submodule": "autocomplete-list"

28739

},

28740

{

28741

"file": "autocomplete/js/autocomplete-list.js",

28742

"line": 551,

28743

"description": "Handles `activeItemChange` events.",

28744

"itemtype": "method",

28745

"name": "_afterActiveItemChange",

28746

"params": [

28747

{

28748

"name": "e",

28749

"description": "",

28750

"type": "EventFacade"

28751

}

28752

],

28753

"access": "protected",

28754

"tagname": "",

28755

"class": "AutoCompleteList",

28756

"module": "autocomplete",

28757

"submodule": "autocomplete-list"

28758

},

28759

{

28760

"file": "autocomplete/js/autocomplete-list.js",

28761

"line": 588,

28762

"description": "Handles `alwaysShowListChange` events.",

28763

"itemtype": "method",

28764

"name": "_afterAlwaysShowListChange",

28765

"params": [

28766

{

28767

"name": "e",

28768

"description": "",

28769

"type": "EventFacade"

28770

}

28771

],

28772

"access": "protected",

28773

"tagname": "",

28774

"class": "AutoCompleteList",

28775

"module": "autocomplete",

28776

"submodule": "autocomplete-list"

28777

},

28778

{

28779

"file": "autocomplete/js/autocomplete-list.js",

28780

"line": 599,

28781

"description": "Handles click events on the document. If the click is outside both the\ninput node and the bounding box, the list will be hidden.",

28782

"itemtype": "method",

28783

"name": "_afterDocClick",

28784

"params": [

28785

{

28786

"name": "e",

28787

"description": "",

28788

"type": "EventFacade"

28789

}

28790

],

28791

"access": "protected",

28792

"tagname": "",

28793

"since": "3.5.0",

28794

"class": "AutoCompleteList",

28795

"module": "autocomplete",

28796

"submodule": "autocomplete-list"

28797

},

28798

{

28799

"file": "autocomplete/js/autocomplete-list.js",

28800

"line": 619,

28801

"description": "Handles `hoveredItemChange` events.",

28802

"itemtype": "method",

28803

"name": "_afterHoveredItemChange",

28804

"params": [

28805

{

28806

"name": "e",

28807

"description": "",

28808

"type": "EventFacade"

28809

}

28810

],

28811

"access": "protected",

28812

"tagname": "",

28813

"class": "AutoCompleteList",

28814

"module": "autocomplete",

28815

"submodule": "autocomplete-list"

28816

},

28817

{

28818

"file": "autocomplete/js/autocomplete-list.js",

28819

"line": 639,

28820

"description": "Handles `inputNode` blur events.",

28821

"itemtype": "method",

28822

"name": "_afterListInputBlur",

28823

"access": "protected",

28824

"tagname": "",

28825

"class": "AutoCompleteList",

28826

"module": "autocomplete",

28827

"submodule": "autocomplete-list"

28828

},

28829

{

28830

"file": "autocomplete/js/autocomplete-list.js",

28831

"line": 657,

28832

"description": "Handles `inputNode` focus events.",

28833

"itemtype": "method",

28834

"name": "_afterListInputFocus",

28835

"access": "protected",

28836

"tagname": "",

28837

"class": "AutoCompleteList",

28838

"module": "autocomplete",

28839

"submodule": "autocomplete-list"

28840

},

28841

{

28842

"file": "autocomplete/js/autocomplete-list.js",

28843

"line": 667,

28844

"description": "Handles `mouseover` events.",

28845

"itemtype": "method",

28846

"name": "_afterMouseOver",

28847

"params": [

28848

{

28849

"name": "e",

28850

"description": "",

28851

"type": "EventFacade"

28852

}

28853

],

28854

"access": "protected",

28855

"tagname": "",

28856

"class": "AutoCompleteList",

28857

"module": "autocomplete",

28858

"submodule": "autocomplete-list"

28859

},

28860

{

28861

"file": "autocomplete/js/autocomplete-list.js",

28862

"line": 684,

28863

"description": "Handles `mouseout` events.",

28864

"itemtype": "method",

28865

"name": "_afterMouseOut",

28866

"params": [

28867

{

28868

"name": "e",

28869

"description": "",

28870

"type": "EventFacade"

28871

}

28872

],

28873

"access": "protected",

28874

"tagname": "",

28875

"class": "AutoCompleteList",

28876

"module": "autocomplete",

28877

"submodule": "autocomplete-list"

28878

},

28879

{

28880

"file": "autocomplete/js/autocomplete-list.js",

28881

"line": 696,

28882

"description": "Handles `resultsChange` events.",

28883

"itemtype": "method",

28884

"name": "_afterResultsChange",

28885

"params": [

28886

{

28887

"name": "e",

28888

"description": "",

28889

"type": "EventFacade"

28890

}

28891

],

28892

"access": "protected",

28893

"tagname": "",

28894

"class": "AutoCompleteList",

28895

"module": "autocomplete",

28896

"submodule": "autocomplete-list"

28897

},

28898

{

28899

"file": "autocomplete/js/autocomplete-list.js",

28900

"line": 711,

28901

"description": "Handles `visibleChange` events.",

28902

"itemtype": "method",

28903

"name": "_afterVisibleChange",

28904

"params": [

28905

{

28906

"name": "e",

28907

"description": "",

28908

"type": "EventFacade"

28909

}

28910

],

28911

"access": "protected",

28912

"tagname": "",

28913

"class": "AutoCompleteList",

28914

"module": "autocomplete",

28915

"submodule": "autocomplete-list"

28916

},

28917

{

28918

"file": "autocomplete/js/autocomplete-list.js",

28919

"line": 722,

28920

"description": "Delegated event handler for item `click` events.",

28921

"itemtype": "method",

28922

"name": "_onItemClick",

28923

"params": [

28924

{

28925

"name": "e",

28926

"description": "",

28927

"type": "EventFacade"

28928

}

28929

],

28930

"access": "protected",

28931

"tagname": "",

28932

"class": "AutoCompleteList",

28933

"module": "autocomplete",

28934

"submodule": "autocomplete-list"

28935

},

28936

{

28937

"file": "autocomplete/js/autocomplete-list.js",

28938

"line": 738,

28939

"description": "Default `select` event handler.",

28940

"itemtype": "method",

28941

"name": "_defSelectFn",

28942

"params": [

28943

{

28944

"name": "e",

28945

"description": "",

28946

"type": "EventFacade"

28947

}

28948

],

28949

"access": "protected",

28950

"tagname": "",

28951

"class": "AutoCompleteList",

28952

"module": "autocomplete",

28953

"submodule": "autocomplete-list"

28954

},

28955

{

28956

"file": "autocomplete/js/autocomplete-list.js",

28957

"line": 756,

28958

"description": "If `true`, the first item in the list will be activated by default when\nthe list is initially displayed and when results change.",

28959

"itemtype": "attribute",

28960

"name": "activateFirstItem",

28961

"type": "Boolean",

28962

"default": "false",

28963

"class": "AutoCompleteList",

28964

"module": "autocomplete",

28965

"submodule": "autocomplete-list"

28966

},

28967

{

28968

"file": "autocomplete/js/autocomplete-list.js",

28969

"line": 768,

28970

"description": "Item that's currently active, if any. When the user presses enter, this\nis the item that will be selected.",

28971

"itemtype": "attribute",

28972

"name": "activeItem",

28973

"type": "Node",

28974

"class": "AutoCompleteList",

28975

"module": "autocomplete",

28976

"submodule": "autocomplete-list"

28977

},

28978

{

28979

"file": "autocomplete/js/autocomplete-list.js",

28980

"line": 780,

28981

"description": "If `true`, the list will remain visible even when there are no results\nto display.",

28982

"itemtype": "attribute",

28983

"name": "alwaysShowList",

28984

"type": "Boolean",

28985

"default": "false",

28986

"class": "AutoCompleteList",

28987

"module": "autocomplete",

28988

"submodule": "autocomplete-list"

28989

},

28990

{

28991

"file": "autocomplete/js/autocomplete-list.js",

28992

"line": 792,

28993

"description": "If `true`, keyboard navigation will wrap around to the opposite end of\nthe list when navigating past the first or last item.",

28994

"itemtype": "attribute",

28995

"name": "circular",

28996

"type": "Boolean",

28997

"default": "true",

28998

"class": "AutoCompleteList",

28999

"module": "autocomplete",

29000

"submodule": "autocomplete-list"

29001

},

29002

{

29003

"file": "autocomplete/js/autocomplete-list.js",

29004

"line": 804,

29005

"description": "Item currently being hovered over by the mouse, if any.",

29006

"itemtype": "attribute",

29007

"name": "hoveredItem",

29008

"type": "Node|null",

29009

"readonly": "",

29010

"class": "AutoCompleteList",

29011

"module": "autocomplete",

29012

"submodule": "autocomplete-list"

29013

},

29014

{

29015

"file": "autocomplete/js/autocomplete-list.js",

29016

"line": 816,

29017

"description": "Node that will contain result items.",

29018

"itemtype": "attribute",

29019

"name": "listNode",

29020

"type": "Node|null",

29021

"initonly": "",

29022

"class": "AutoCompleteList",

29023

"module": "autocomplete",

29024

"submodule": "autocomplete-list"

29025

},

29026

{

29027

"file": "autocomplete/js/autocomplete-list.js",

29028

"line": 828,

29029

"description": "If `true`, the viewport will be scrolled to ensure that the active list\nitem is visible when necessary.",

29030

"itemtype": "attribute",

29031

"name": "scrollIntoView",

29032

"type": "Boolean",

29033

"default": "false",

29034

"class": "AutoCompleteList",

29035

"module": "autocomplete",

29036

"submodule": "autocomplete-list"

29037

},

29038

{

29039

"file": "autocomplete/js/autocomplete-list.js",

29040

"line": 840,

29041

"description": "Translatable strings used by the AutoCompleteList widget.",

29042

"itemtype": "attribute",

29043

"name": "strings",

29044

"type": "Object",

29045

"class": "AutoCompleteList",

29046

"module": "autocomplete",

29047

"submodule": "autocomplete-list"

29048

},

29049

{

29050

"file": "autocomplete/js/autocomplete-list.js",

29051

"line": 852,

29052

"description": "If `true`, pressing the tab key while the list is visible will select\nthe active item, if any.",

29053

"itemtype": "attribute",

29054

"name": "tabSelect",

29055

"type": "Boolean",

29056

"default": "true",

29057

"class": "AutoCompleteList",

29058

"module": "autocomplete",

29059

"submodule": "autocomplete-list"

29060

},

29061

{

29062

"file": "autocomplete/js/autocomplete-sources.js",

29063

"line": 19,

29064

"description": "Regular expression used to determine whether a String source is a YQL query.",

29065

"itemtype": "property",

29066

"name": "_YQL_SOURCE_REGEX",

29067

"type": "RegExp",

29068

"access": "protected",

29069

"tagname": "",

29070

"class": "AutoCompleteBase",

29071

"module": "autocomplete",

29072

"submodule": "autocomplete-sources"

29073

},

29074

{

29075

"file": "autocomplete/js/autocomplete-sources.js",

29076

"line": 29,

29077

"description": "Runs before AutoCompleteBase's `_createObjectSource()` method and augments\nit to support additional object-based source types.",

29078

"itemtype": "method",

29079

"name": "_beforeCreateObjectSource",

29080

"params": [

29081

{

29082

"name": "source",

29083

"description": "",

29084

"type": "String"

29085

}

29086

],

29087

"access": "protected",

29088

"tagname": "",

29089

"class": "AutoCompleteBase",

29090

"module": "autocomplete",

29091

"submodule": "autocomplete-sources"

29092

},

29093

{

29094

"file": "autocomplete/js/autocomplete-sources.js",

29095

"line": 57,

29096

"description": "Creates a DataSource-like object that uses `Y.io` as a source. See the\n`source` attribute for more details.",

29097

"itemtype": "method",

29098

"name": "_createIOSource",

29099

"params": [

29100

{

29101

"name": "source",

29102

"description": "URL.",

29103

"type": "String"

29104

}

29105

],

29106

"return": {

29107

"description": "DataSource-like object.",

29108

"type": "Object"

29109

},

29110

"access": "protected",

29111

"tagname": "",

29112

"class": "AutoCompleteBase",

29113

"module": "autocomplete",

29114

"submodule": "autocomplete-sources"

29115

},

29116

{

29117

"file": "autocomplete/js/autocomplete-sources.js",

29118

"line": 131,

29119

"description": "Creates a DataSource-like object that uses the specified JSONPRequest\ninstance as a source. See the `source` attribute for more details.",

29120

"itemtype": "method",

29121

"name": "_createJSONPSource",

29122

"params": [

29123

{

29124

"name": "source",

29125

"description": "URL string or JSONPRequest instance.",

29126

"type": "JSONPRequest|String"

29127

}

29128

],

29129

"return": {

29130

"description": "DataSource-like object.",

29131

"type": "Object"

29132

},

29133

"access": "protected",

29134

"tagname": "",

29135

"class": "AutoCompleteBase",

29136

"module": "autocomplete",

29137

"submodule": "autocomplete-sources"

29138

},

29139

{

29140

"file": "autocomplete/js/autocomplete-sources.js",

29141

"line": 200,

29142

"description": "Creates a DataSource-like object that uses the specified `<select>` node as\na source.",

29143

"itemtype": "method",

29144

"name": "_createSelectSource",

29145

"params": [

29146

{

29147

"name": "source",

29148

"description": "YUI Node instance wrapping a `<select>` node.",

29149

"type": "Node"

29150

}

29151

],

29152

"return": {

29153

"description": "DataSource-like object.",

29154

"type": "Object"

29155

},

29156

"access": "protected",

29157

"tagname": "",

29158

"class": "AutoCompleteBase",

29159

"module": "autocomplete",

29160

"submodule": "autocomplete-sources"

29161

},

29162

{

29163

"file": "autocomplete/js/autocomplete-sources.js",

29164

"line": 234,

29165

"description": "Creates a DataSource-like object that calls the specified URL or executes\nthe specified YQL query for results. If the string starts with \"select \",\n\"use \", or \"set \" (case-insensitive), it's assumed to be a YQL query;\notherwise, it's assumed to be a URL (which may be absolute or relative).\nURLs containing a \"{callback}\" placeholder are assumed to be JSONP URLs; all\nothers will use XHR. See the `source` attribute for more details.",

29166

"itemtype": "method",

29167

"name": "_createStringSource",

29168

"params": [

29169

{

29170

"name": "source",

29171

"description": "URL or YQL query.",

29172

"type": "String"

29173

}

29174

],

29175

"return": {

29176

"description": "DataSource-like object.",

29177

"type": "Object"

29178

},

29179

"access": "protected",

29180

"tagname": "",

29181

"class": "AutoCompleteBase",

29182

"module": "autocomplete",

29183

"submodule": "autocomplete-sources"

29184

},

29185

{

29186

"file": "autocomplete/js/autocomplete-sources.js",

29187

"line": 262,

29188

"description": "Creates a DataSource-like object that uses the specified YQL query string to\ncreate a YQL-based source. See the `source` attribute for details. If no\n`resultListLocator` is defined, this method will set a best-guess locator\nthat might work for many typical YQL queries.",

29189

"itemtype": "method",

29190

"name": "_createYQLSource",

29191

"params": [

29192

{

29193

"name": "source",

29194

"description": "YQL query.",

29195

"type": "String"

29196

}

29197

],

29198

"return": {

29199

"description": "DataSource-like object.",

29200

"type": "Object"

29201

},

29202

"access": "protected",

29203

"tagname": "",

29204

"class": "AutoCompleteBase",

29205

"module": "autocomplete",

29206

"submodule": "autocomplete-sources"

29207

},

29208

{

29209

"file": "autocomplete/js/autocomplete-sources.js",

29210

"line": 349,

29211

"description": "Default resultListLocator used when a string-based YQL source is set and the\nimplementer hasn't already specified one.",

29212

"itemtype": "method",

29213

"name": "_defaultYQLLocator",

29214

"params": [

29215

{

29216

"name": "response",

29217

"description": "YQL response object.",

29218

"type": "Object"

29219

}

29220

],

29221

"return": {

29222

"description": "",

29223

"type": "Array"

29224

},

29225

"access": "protected",

29226

"tagname": "",

29227

"class": "AutoCompleteBase",

29228

"module": "autocomplete",

29229

"submodule": "autocomplete-sources"

29230

},

29231

{

29232

"file": "autocomplete/js/autocomplete-sources.js",

29233

"line": 381,

29234

"description": "Returns a formatted XHR URL based on the specified base _url_, _query_, and\nthe current _requestTemplate_ if any.",

29235

"itemtype": "method",

29236

"name": "_getXHRUrl",

29237

"params": [

29238

{

29239

"name": "url",

29240

"description": "Base URL.",

29241

"type": "String"

29242

},

29243

{

29244

"name": "request",

29245

"description": "Request object containing `query` and `request`\n properties.",

29246

"type": "Object"

29247

}

29248

],

29249

"return": {

29250

"description": "Formatted URL.",

29251

"type": "String"

29252

},

29253

"access": "protected",

29254

"tagname": "",

29255

"class": "AutoCompleteBase",

29256

"module": "autocomplete",

29257

"submodule": "autocomplete-sources"

29258

},

29259

{

29260

"file": "autocomplete/js/autocomplete-sources.js",

29261

"line": 407,

29262

"description": "URL formatter passed to `JSONPRequest` instances.",

29263

"itemtype": "method",

29264

"name": "_jsonpFormatter",

29265

"params": [

29266

{

29267

"name": "url",

29268

"description": "",

29269

"type": "String"

29270

},

29271

{

29272

"name": "proxy",

29273

"description": "",

29274

"type": "String"

29275

},

29276

{

29277

"name": "query",

29278

"description": "",

29279

"type": "String"

29280

}

29281

],

29282

"return": {

29283

"description": "Formatted URL",

29284

"type": "String"

29285

},

29286

"access": "protected",

29287

"tagname": "",

29288

"class": "AutoCompleteBase",

29289

"module": "autocomplete",

29290

"submodule": "autocomplete-sources"

29291

},

29292

{

29293

"file": "autocomplete/js/autocomplete-sources.js",

29294

"line": 436,

29295

"description": "YQL environment file URL to load when the `source` is set to a YQL query.\nSet this to `null` to use the default Open Data Tables environment file\n(http://datatables.org/alltables.env).",

29296

"itemtype": "attribute",

29297

"name": "yqlEnv",

29298

"type": "String",

29299

"default": "null",

29300

"class": "AutoCompleteBase",

29301

"module": "autocomplete",

29302

"submodule": "autocomplete-sources"

29303

},

29304

{

29305

"file": "autocomplete/js/autocomplete-sources.js",

29306

"line": 450,

29307

"description": "URL protocol to use when the `source` is set to a YQL query.",

29308

"itemtype": "attribute",

29309

"name": "yqlProtocol",

29310

"type": "String",

29311

"default": "'http'",

29312

"class": "AutoCompleteBase",

29313

"module": "autocomplete",

29314

"submodule": "autocomplete-sources"

29315

},

29316

{

29317

"file": "base/js/Base.js",

29318

"line": 91,

29319

"description": "The list of properties which can be configured for \neach attribute (e.g. setter, getter, writeOnce, readOnly etc.)",

29320

"itemtype": "property",

29321

"name": "_ATTR_CFG",

29322

"type": "Array",

29323

"static": 1,

29324

"access": "private",

29325

"tagname": "",

29326

"class": "Base",

29327

"module": "base",

29328

"submodule": "base-base"

29329

},

29330

{

29331

"file": "base/js/Base.js",

29332

"line": 103,

29333

"description": "The array of non-attribute configuration properties supported by this class. \n\n`Base` supports \"on\", \"after\", \"plugins\" and \"bubbleTargets\" properties, \nwhich are not set up as attributes. \n\nThis property is primarily required so that when \n<a href=\"#property__allowAdHocAttrs\">`_allowAdHocAttrs`</a> is enabled by\na class, non-attribute configurations don't get added as ad-hoc attributes.",

29334

"itemtype": "property",

29335

"name": "_NON_ATTRS_CFG",

29336

"type": "Array",

29337

"static": 1,

29338

"access": "private",

29339

"tagname": "",

29340

"class": "Base",

29341

"module": "base",

29342

"submodule": "base-base"

29343

},

29344

{

29345

"file": "base/js/Base.js",

29346

"line": 120,

29347

"description": "\nThe string to be used to identify instances of \nthis class, for example in prefixing events.\n\n\nClasses extending Base, should define their own\nstatic NAME property, which should be camelCase by\nconvention (e.g. MyClass.NAME = \"myClass\";).\n",

29348

"itemtype": "property",

29349

"name": "NAME",

29350

"type": "String",

29351

"static": 1,

29352

"class": "Base",

29353

"module": "base",

29354

"submodule": "base-base"

29355

},

29356

{

29357

"file": "base/js/Base.js",

29358

"line": 136,

29359

"description": "The default set of attributes which will be available for instances of this class, and \ntheir configuration. In addition to the configuration properties listed by \nAttribute's <a href=\"Attribute.html#method_addAttr\">addAttr</a> method, the attribute \ncan also be configured with a \"cloneDefaultValue\" property, which defines how the statically\ndefined value field should be protected (\"shallow\", \"deep\" and false are supported values). \n\nBy default if the value is an object literal or an array it will be \"shallow\" cloned, to \nprotect the default value.",

29360

"itemtype": "property",

29361

"name": "ATTRS",

29362

"type": "Object",

29363

"static": 1,

29364

"class": "Base",

29365

"module": "base",

29366

"submodule": "base-base"

29367

},

29368

{

29369

"file": "base/js/Base.js",

29370

"line": 154,

29371

"description": "Internal construction logic for Base.",

29372

"itemtype": "method",

29373

"name": "_initBase",

29374

"params": [

29375

{

29376

"name": "config",

29377

"description": "The constructor configuration object",

29378

"type": "Object"

29379

}

29380

],

29381

"access": "private",

29382

"tagname": "",

29383

"class": "Base",

29384

"module": "base",

29385

"submodule": "base-base"

29386

},

29387

{

29388

"file": "base/js/Base.js",

29389

"line": 169,

29390

"description": "Initializes Attribute",

29391

"itemtype": "method",

29392

"name": "_initAttribute",

29393

"access": "private",

29394

"tagname": "",

29395

"class": "Base",

29396

"module": "base",

29397

"submodule": "base-base"

29398

},

29399

{

29400

"file": "base/js/Base.js",

29401

"line": 180,

29402

"description": "Utility method to define the attribute hash used to filter/whitelist property mixes for \nthis class.",

29403

"itemtype": "method",

29404

"name": "_attrCfgHash",

29405

"access": "private",

29406

"tagname": "",

29407

"class": "Base",

29408

"module": "base",

29409

"submodule": "base-base"

29410

},

29411

{

29412

"file": "base/js/Base.js",

29413

"line": 191,

29414

"description": "Init lifecycle method, invoked during construction.\nFires the init event prior to setting up attributes and \ninvoking initializers for the class hierarchy.",

29415

"itemtype": "method",

29416

"name": "init",

29417

"chainable": 1,

29418

"params": [

29419

{

29420

"name": "config",

29421

"description": "Object with configuration property name/value pairs",

29422

"type": "Object"

29423

}

29424

],

29425

"return": {

29426

"description": "A reference to this object",

29427

"type": "Base"

29428

},

29429

"class": "Base",

29430

"module": "base",

29431

"submodule": "base-base"

29432

},

29433

{

29434

"file": "base/js/Base.js",

29435

"line": 202,

29436

"description": "\nLifecycle event for the init phase, fired prior to initialization. \nInvoking the preventDefault() method on the event object provided \nto subscribers will prevent initialization from occuring.\n\n\nSubscribers to the \"after\" momemt of this event, will be notified\nafter initialization of the object is complete (and therefore\ncannot prevent initialization).\n",

29437

"itemtype": "event",

29438

"name": "init",

29439

"preventable": "_defInitFn",

29440

"params": [

29441

{

29442

"name": "e",

29443

"description": "Event object, with a cfg property which \nrefers to the configuration object passed to the constructor.",

29444

"type": "EventFacade"

29445

}

29446

],

29447

"class": "Base",

29448

"module": "base",

29449

"submodule": "base-base"

29450

},

29451

{

29452

"file": "base/js/Base.js",

29453

"line": 233,

29454

"description": "Handles the special on, after and target properties which allow the user to\neasily configure on and after listeners as well as bubble targets during \nconstruction, prior to init.",

29455

"access": "private",

29456

"tagname": "",

29457

"itemtype": "method",

29458

"name": "_preInitEventCfg",

29459

"params": [

29460

{

29461

"name": "config",

29462

"description": "The user configuration object",

29463

"type": "Object"

29464

}

29465

],

29466

"class": "Base",

29467

"module": "base",

29468

"submodule": "base-base"

29469

},

29470

{

29471

"file": "base/js/Base.js",

29472

"line": 267,

29473

"description": "\nDestroy lifecycle method. Fires the destroy\nevent, prior to invoking destructors for the\nclass hierarchy.\n\n\nSubscribers to the destroy\nevent can invoke preventDefault on the event object, to prevent destruction\nfrom proceeding.\n",

29474

"itemtype": "method",

29475

"name": "destroy",

29476

"return": {

29477

"description": "A reference to this object",

29478

"type": "Base"

29479

},

29480

"chainable": 1,

29481

"class": "Base",

29482

"module": "base",

29483

"submodule": "base-base"

29484

},

29485

{

29486

"file": "base/js/Base.js",

29487

"line": 285,

29488

"description": "\nLifecycle event for the destroy phase, \nfired prior to destruction. Invoking the preventDefault \nmethod on the event object provided to subscribers will \nprevent destruction from proceeding.\n\n\nSubscribers to the \"after\" moment of this event, will be notified\nafter destruction is complete (and as a result cannot prevent\ndestruction).\n",

29489

"itemtype": "event",

29490

"name": "destroy",

29491

"preventable": "_defDestroyFn",

29492

"params": [

29493

{

29494

"name": "e",

29495

"description": "Event object",

29496

"type": "EventFacade"

29497

}

29498

],

29499

"class": "Base",

29500

"module": "base",

29501

"submodule": "base-base"

29502

},

29503

{

29504

"file": "base/js/Base.js",

29505

"line": 313,

29506

"description": "Default init event handler",

29507

"itemtype": "method",

29508

"name": "_defInitFn",

29509

"params": [

29510

{

29511

"name": "e",

29512

"description": "Event object, with a cfg property which \nrefers to the configuration object passed to the constructor.",

29513

"type": "EventFacade"

29514

}

29515

],

29516

"access": "protected",

29517

"tagname": "",

29518

"class": "Base",

29519

"module": "base",

29520

"submodule": "base-base"

29521

},

29522

{

29523

"file": "base/js/Base.js",

29524

"line": 325,

29525

"description": "Default destroy event handler",

29526

"itemtype": "method",

29527

"name": "_defDestroyFn",

29528

"params": [

29529

{

29530

"name": "e",

29531

"description": "Event object",

29532

"type": "EventFacade"

29533

}

29534

],

29535

"access": "protected",

29536

"tagname": "",

29537

"class": "Base",

29538

"module": "base",

29539

"submodule": "base-base"

29540

},

29541

{

29542

"file": "base/js/BaseBuild.js",

29543

"line": 260,

29544

"description": "\nBuilds a custom constructor function (class) from the\nmain function, and array of extension functions (classes)\nprovided. The NAME field for the constructor function is \ndefined by the first argument passed in.\n\n\nThe cfg object supports the following properties\n\n<dl>\n <dt>dynamic <boolean></dt>\n <dd>\n If true (default), a completely new class\n is created which extends the main class, and acts as the \n host on which the extension classes are augmented.\n If false, the extensions classes are augmented directly to\n the main class, modifying the main class' prototype.\n </dd>\n <dt>aggregates <String[]></dt>\n <dd>An array of static property names, which will get aggregated\n on to the built class, in addition to the default properties build \n will always aggregate as defined by the main class' static _buildCfg\n property.\n </dd>\n</dl>",

29545

"itemtype": "method",

29546

"name": "build",

29547

"deprecated": true,

29548

"deprecationMessage": "Use the more convenient Base.create and Base.mix methods instead",

29549

"static": 1,

29550

"params": [

29551

{

29552

"name": "name",

29553

"description": "The name of the new class. Used to defined the NAME property for the new class.",

29554

"type": "Function"

29555

},

29556

{

29557

"name": "main",

29558

"description": "The main class on which to base the built class",

29559

"type": "Function"

29560

},

29561

{

29562

"name": "extensions",

29563

"description": "The set of extension classes which will be\naugmented/aggregated to the built class.",

29564

"type": "Function[]"

29565

},

29566

{

29567

"name": "cfg",

29568

"description": "Optional. Build configuration for the class (see description).",

29569

"type": "Object"

29570

}

29571

],

29572

"return": {

29573

"description": "A custom class, created from the provided main and extension classes",

29574

"type": "Function"

29575

},

29576

"class": "Base",

29577

"module": "base",

29578

"submodule": "base-build"

29579

},

29580

{

29581

"file": "base/js/BaseBuild.js",

29582

"line": 301,

29583

"description": "Creates a new class (constructor function) which extends the base class passed in as the second argument, \nand mixes in the array of extensions provided.\n\nPrototype properties or methods can be added to the new class, using the px argument (similar to Y.extend).\n\nStatic properties or methods can be added to the new class, using the sx argument (similar to Y.extend).\n\n**NOTE FOR COMPONENT DEVELOPERS**: Both the `base` class, and `extensions` can define static a `_buildCfg` \nproperty, which acts as class creation meta-data, and drives how special static properties from the base \nclass, or extensions should be copied, aggregated or (custom) mixed into the newly created class.\n\nThe `_buildCfg` property is a hash with 3 supported properties: `statics`, `aggregates` and `custom`, e.g:\n\n // If the Base/Main class is the thing introducing the property:\n\n MyBaseClass._buildCfg = {\n \n // Static properties/methods to copy (Alias) to the built class.\n statics: [\"CopyThisMethod\", \"CopyThisProperty\"],\n\n // Static props to aggregate onto the built class.\n aggregates: [\"AggregateThisProperty\"],\n\n // Static properties which need custom handling (e.g. deep merge etc.)\n custom: {\n \"CustomProperty\" : function(property, Receiver, Supplier) {\n ...\n var triggers = Receiver.CustomProperty.triggers; \n Receiver.CustomProperty.triggers = triggers.concat(Supplier.CustomProperty.triggers);\n ...\n }\n }\n };\n\n MyBaseClass.CopyThisMethod = function() {...}; \n MyBaseClass.CopyThisProperty = \"foo\";\n MyBaseClass.AggregateThisProperty = {...};\n MyBaseClass.CustomProperty = {\n triggers: [...]\n }\n\n // Or, if the Extension is the thing introducing the property:\n\n MyExtension._buildCfg = {\n statics : ...\n aggregates : ...\n custom : ... \n } \n\nThis way, when users pass your base or extension class to `Y.Base.create` or `Y.Base.mix`, they don't need to\nknow which properties need special handling. `Y.Base` has a buildCfg which defines `ATTRS` for custom mix handling\n(to protect the static config objects), and `Y.Widget` has a buildCfg which specifies `HTML_PARSER` for \nstraight up aggregation.",

29584

"itemtype": "method",

29585

"name": "create",

29586

"static": 1,

29587

"params": [

29588

{

29589

"name": "name",

29590

"description": "The name of the newly created class. Used to defined the NAME property for the new class.",

29591

"type": "Function"

29592

},

29593

{

29594

"name": "main",

29595

"description": "The base class which the new class should extend. This class needs to be Base or a class derived from base (e.g. Widget).",

29596

"type": "Function"

29597

},

29598

{

29599

"name": "extensions",

29600

"description": "The list of extensions which will be mixed into the built class.",

29601

"type": "Function[]"

29602

},

29603

{

29604

"name": "px",

29605

"description": "The set of prototype properties/methods to add to the built class.",

29606

"type": "Object"

29607

},

29608

{

29609

"name": "sx",

29610

"description": "The set of static properties/methods to add to the built class.",

29611

"type": "Object"

29612

}

29613

],

29614

"return": {

29615

"description": "The newly created class.",

29616

"type": "Function"

29617

},

29618

"class": "Base",

29619

"module": "base",

29620

"submodule": "base-build"

29621

},

29622

{

29623

"file": "base/js/BaseBuild.js",

29624

"line": 369,

29625

"description": "Mixes in a list of extensions to an existing class.",

29626

"itemtype": "method",

29627

"name": "mix",

29628

"static": 1,

29629

"params": [

29630

{

29631

"name": "main",

29632

"description": "The existing class into which the extensions should be mixed. The class needs to be Base or a class derived from Base (e.g. Widget)",

29633

"type": "Function"

29634

},

29635

{

29636

"name": "extensions",

29637

"description": "The set of extension classes which will mixed into the existing main class.",

29638

"type": "Function[]"

29639

}

29640

],

29641

"return": {

29642

"description": "The modified main class, with extensions mixed in.",

29643

"type": "Function"

29644

},

29645

"class": "Base",

29646

"module": "base",

29647

"submodule": "base-build"

29648

},

29649

{

29650

"file": "base/js/BaseBuild.js",

29651

"line": 381,

29652

"description": "The build configuration for the Base class.\n\nDefines the static fields which need to be aggregated\nwhen the Base class is used as the main class passed to\nthe <a href=\"#method_Base.build\">Base.build</a> method.",

29653

"itemtype": "property",

29654

"name": "_buildCfg",

29655

"type": "Object",

29656

"static": 1,

29657

"final": 1,

29658

"access": "private",

29659

"tagname": "",

29660

"class": "Base",

29661

"module": "base",

29662

"submodule": "base-build"

29663

},

29664

{

29665

"file": "base/js/BaseCore.js",

29666

"line": 73,

29667

"description": "The list of properties which can be configured for each attribute \n(e.g. setter, getter, writeOnce, readOnly etc.)",

29668

"itemtype": "property",

29669

"name": "_ATTR_CFG",

29670

"type": "Array",

29671

"static": 1,

29672

"access": "private",

29673

"tagname": "",

29674

"class": "BaseCore",

29675

"module": "base",

29676

"submodule": "base-core"

29677

},

29678

{

29679

"file": "base/js/BaseCore.js",

29680

"line": 85,

29681

"description": "The array of non-attribute configuration properties supported by this class. \n\nFor example `BaseCore` defines a \"plugins\" configuration property which \nshould not be set up as an attribute. This property is primarily required so \nthat when <a href=\"#property__allowAdHocAttrs\">`_allowAdHocAttrs`</a> is enabled by a class, \nnon-attribute configuration properties don't get added as ad-hoc attributes.",

29682

"itemtype": "property",

29683

"name": "_NON_ATTRS_CFG",

29684

"type": "Array",

29685

"static": 1,

29686

"access": "private",

29687

"tagname": "",

29688

"class": "BaseCore",

29689

"module": "base",

29690

"submodule": "base-core"

29691

},

29692

{

29693

"file": "base/js/BaseCore.js",

29694

"line": 100,

29695

"description": "This property controls whether or not instances of this class should\nallow users to add ad-hoc attributes through the constructor configuration \nhash.\n\nAdHoc attributes are attributes which are not defined by the class, and are \nnot handled by the MyClass._NON_ATTRS_CFG",

29696

"itemtype": "property",

29697

"name": "_allowAdHocAttrs",

29698

"type": "boolean",

29699

"default": "undefined (false)",

29700

"access": "protected",

29701

"tagname": "",

29702

"class": "BaseCore",

29703

"module": "base",

29704

"submodule": "base-core"

29705

},

29706

{

29707

"file": "base/js/BaseCore.js",

29708

"line": 114,

29709

"description": "The string to be used to identify instances of this class.\n\nClasses extending BaseCore, should define their own\nstatic NAME property, which should be camelCase by\nconvention (e.g. MyClass.NAME = \"myClass\";).",

29710

"itemtype": "property",

29711

"name": "NAME",

29712

"type": "String",

29713

"static": 1,

29714

"class": "BaseCore",

29715

"module": "base",

29716

"submodule": "base-core"

29717

},

29718

{

29719

"file": "base/js/BaseCore.js",

29720

"line": 127,

29721

"description": "The default set of attributes which will be available for instances of this class, and \ntheir configuration. In addition to the configuration properties listed by \nAttributeCore's <a href=\"AttributeCore.html#method_addAttr\">addAttr</a> method, \nthe attribute can also be configured with a \"cloneDefaultValue\" property, which \ndefines how the statically defined value field should be protected \n(\"shallow\", \"deep\" and false are supported values). \n\nBy default if the value is an object literal or an array it will be \"shallow\" \ncloned, to protect the default value.",

29722

"itemtype": "property",

29723

"name": "ATTRS",

29724

"type": "Object",

29725

"static": 1,

29726

"class": "BaseCore",

29727

"module": "base",

29728

"submodule": "base-core"

29729

},

29730

{

29731

"file": "base/js/BaseCore.js",

29732

"line": 143,

29733

"description": "Flag indicating whether or not this object\nhas been through the init lifecycle phase.",

29734

"itemtype": "attribute",

29735

"name": "initialized",

29736

"readonly": "",

29737

"default": "false",

29738

"type": "boolean",

29739

"class": "BaseCore",

29740

"module": "base",

29741

"submodule": "base-core"

29742

},

29743

{

29744

"file": "base/js/BaseCore.js",

29745

"line": 157,

29746

"description": "Flag indicating whether or not this object\nhas been through the destroy lifecycle phase.",

29747

"itemtype": "attribute",

29748

"name": "destroyed",

29749

"readonly": "",

29750

"default": "false",

29751

"type": "boolean",

29752

"class": "BaseCore",

29753

"module": "base",

29754

"submodule": "base-core"

29755

},

29756

{

29757

"file": "base/js/BaseCore.js",

29758

"line": 174,

29759

"description": "Internal construction logic for BaseCore.",

29760

"itemtype": "method",

29761

"name": "_initBase",

29762

"params": [

29763

{

29764

"name": "config",

29765

"description": "The constructor configuration object",

29766

"type": "Object"

29767

}

29768

],

29769

"access": "private",

29770

"tagname": "",

29771

"class": "BaseCore",

29772

"module": "base",

29773

"submodule": "base-core"

29774

},

29775

{

29776

"file": "base/js/BaseCore.js",

29777

"line": 196,

29778

"description": "The string used to identify the class of this object.",

29779

"deprecated": true,

29780

"deprecationMessage": "Use this.constructor.NAME",

29781

"itemtype": "property",

29782

"name": "name",

29783

"type": "String",

29784

"class": "BaseCore",

29785

"module": "base",

29786

"submodule": "base-core"

29787

},

29788

{

29789

"file": "base/js/BaseCore.js",

29790

"line": 208,

29791

"description": "Initializes AttributeCore",

29792

"itemtype": "method",

29793

"name": "_initAttribute",

29794

"access": "private",

29795

"tagname": "",

29796

"class": "BaseCore",

29797

"module": "base",

29798

"submodule": "base-core"

29799

},

29800

{

29801

"file": "base/js/BaseCore.js",

29802

"line": 218,

29803

"description": "Init lifecycle method, invoked during construction. Sets up attributes \nand invokes initializers for the class hierarchy.",

29804

"itemtype": "method",

29805

"name": "init",

29806

"chainable": 1,

29807

"params": [

29808

{

29809

"name": "cfg",

29810

"description": "Object with configuration property name/value pairs",

29811

"type": "Object"

29812

}

29813

],

29814

"return": {

29815

"description": "A reference to this object",

29816

"type": "BaseCore"

29817

},

29818

"class": "BaseCore",

29819

"module": "base",

29820

"submodule": "base-core"

29821

},

29822

{

29823

"file": "base/js/BaseCore.js",

29824

"line": 235,

29825

"description": "Internal initialization implementation for BaseCore",

29826

"itemtype": "method",

29827

"name": "_baseInit",

29828

"access": "private",

29829

"tagname": "",

29830

"class": "BaseCore",

29831

"module": "base",

29832

"submodule": "base-core"

29833

},

29834

{

29835

"file": "base/js/BaseCore.js",

29836

"line": 251,

29837

"description": "Destroy lifecycle method. Invokes destructors for the class hierarchy.",

29838

"itemtype": "method",

29839

"name": "destroy",

29840

"return": {

29841

"description": "A reference to this object",

29842

"type": "BaseCore"

29843

},

29844

"chainable": 1,

29845

"class": "BaseCore",

29846

"module": "base",

29847

"submodule": "base-core"

29848

},

29849

{

29850

"file": "base/js/BaseCore.js",

29851

"line": 263,

29852

"description": "Internal destroy implementation for BaseCore",

29853

"itemtype": "method",

29854

"name": "_baseDestroy",

29855

"access": "private",

29856

"tagname": "",

29857

"class": "BaseCore",

29858

"module": "base",

29859

"submodule": "base-core"

29860

},

29861

{

29862

"file": "base/js/BaseCore.js",

29863

"line": 277,

29864

"description": "Returns the class hierarchy for this object, with BaseCore being the last class in the array.",

29865

"itemtype": "method",

29866

"name": "_getClasses",

29867

"access": "protected",

29868

"tagname": "",

29869

"return": {

29870

"description": "An array of classes (constructor functions), making up the class hierarchy for this object.\nThis value is cached the first time the method, or _getAttrCfgs, is invoked. Subsequent invocations return the \ncached value.",

29871

"type": "Function[]"

29872

},

29873

"class": "BaseCore",

29874

"module": "base",

29875

"submodule": "base-core"

29876

},

29877

{

29878

"file": "base/js/BaseCore.js",

29879

"line": 293,

29880

"description": "Returns an aggregated set of attribute configurations, by traversing \nthe class hierarchy.",

29881

"itemtype": "method",

29882

"name": "_getAttrCfgs",

29883

"access": "protected",

29884

"tagname": "",

29885

"return": {

29886

"description": "The hash of attribute configurations, aggregated across classes in the hierarchy\nThis value is cached the first time the method, or _getClasses, is invoked. Subsequent invocations return\nthe cached value.",

29887

"type": "Object"

29888

},

29889

"class": "BaseCore",

29890

"module": "base",

29891

"submodule": "base-core"

29892

},

29893

{

29894

"file": "base/js/BaseCore.js",

29895

"line": 310,

29896

"description": "A helper method used when processing ATTRS across the class hierarchy during \ninitialization. Returns a disposable object with the attributes defined for \nthe provided class, extracted from the set of all attributes passed in.",

29897

"itemtype": "method",

29898

"name": "_filterAttrCfs",

29899

"access": "private",

29900

"tagname": "",

29901

"params": [

29902

{

29903

"name": "clazz",

29904

"description": "The class for which the desired attributes are required.",

29905

"type": "Function"

29906

},

29907

{

29908

"name": "allCfgs",

29909

"description": "The set of all attribute configurations for this instance. \nAttributes will be removed from this set, if they belong to the filtered class, so\nthat by the time all classes are processed, allCfgs will be empty.",

29910

"type": "Object"

29911

}

29912

],

29913

"return": {

29914

"description": "The set of attributes belonging to the class passed in, in the form\nof an object with attribute name/configuration pairs.",

29915

"type": "Object"

29916

},

29917

"class": "BaseCore",

29918

"module": "base",

29919

"submodule": "base-core"

29920

},

29921

{

29922

"file": "base/js/BaseCore.js",

29923

"line": 342,

29924

"itemtype": "method",

29925

"name": "_filterAdHocAttrs",

29926

"access": "private",

29927

"tagname": "",

29928

"params": [

29929

{

29930

"name": "allAttrs",

29931

"description": "The set of all attribute configurations for this instance. \nAttributes will be removed from this set, if they belong to the filtered class, so\nthat by the time all classes are processed, allCfgs will be empty.",

29932

"type": "Object"

29933

},

29934

{

29935

"name": "userVals",

29936

"description": "The config object passed in by the user, from which adhoc attrs are to be filtered.",

29937

"type": "Object"

29938

}

29939

],

29940

"return": {

29941

"description": "The set of adhoc attributes passed in, in the form\nof an object with attribute name/configuration pairs.",

29942

"type": "Object"

29943

},

29944

"class": "BaseCore",

29945

"module": "base",

29946

"submodule": "base-core"

29947

},

29948

{

29949

"file": "base/js/BaseCore.js",

29950

"line": 372,

29951

"description": "A helper method used by _getClasses and _getAttrCfgs, which determines both\nthe array of classes and aggregate set of attribute configurations\nacross the class hierarchy for the instance.",

29952

"itemtype": "method",

29953

"name": "_initHierarchyData",

29954

"access": "private",

29955

"tagname": "",

29956

"class": "BaseCore",

29957

"module": "base",

29958

"submodule": "base-core"

29959

},

29960

{

29961

"file": "base/js/BaseCore.js",

29962

"line": 415,

29963

"description": "Utility method to define the attribute hash used to filter/whitelist property mixes for \nthis class.",

29964

"itemtype": "method",

29965

"name": "_attrCfgHash",

29966

"access": "private",

29967

"tagname": "",

29968

"class": "BaseCore",

29969

"module": "base",

29970

"submodule": "base-core"

29971

},

29972

{

29973

"file": "base/js/BaseCore.js",

29974

"line": 426,

29975

"description": "A helper method, used by _initHierarchyData to aggregate \nattribute configuration across the instances class hierarchy.\n\nThe method will protect the attribute configuration value to protect the statically defined \ndefault value in ATTRS if required (if the value is an object literal, array or the \nattribute configuration has cloneDefaultValue set to shallow or deep).",

29976

"itemtype": "method",

29977

"name": "_aggregateAttrs",

29978

"access": "private",

29979

"tagname": "",

29980

"params": [

29981

{

29982

"name": "allAttrs",

29983

"description": "An array of ATTRS definitions across classes in the hierarchy \n(subclass first, Base last)",

29984

"type": "Array"

29985

}

29986

],

29987

"return": {

29988

"description": "The aggregate set of ATTRS definitions for the instance",

29989

"type": "Object"

29990

},

29991

"class": "BaseCore",

29992

"module": "base",

29993

"submodule": "base-core"

29994

},

29995

{

29996

"file": "base/js/BaseCore.js",

29997

"line": 501,

29998

"description": "Initializes the class hierarchy for the instance, which includes \ninitializing attributes for each class defined in the class's \nstatic <a href=\"#property_BaseCore.ATTRS\">ATTRS</a> property and \ninvoking the initializer method on the prototype of each class in the hierarchy.",

29999

"itemtype": "method",

30000

"name": "_initHierarchy",

30001

"params": [

30002

{

30003

"name": "userVals",

30004

"description": "Object with configuration property name/value pairs",

30005

"type": "Object"

30006

}

30007

],

30008

"access": "private",

30009

"tagname": "",

30010

"class": "BaseCore",

30011

"module": "base",

30012

"submodule": "base-core"

30013

},

30014

{

30015

"file": "base/js/BaseCore.js",

30016

"line": 559,

30017

"description": "Destroys the class hierarchy for this instance by invoking\nthe destructor method on the prototype of each class in the hierarchy.",

30018

"itemtype": "method",

30019

"name": "_destroyHierarchy",

30020

"access": "private",

30021

"tagname": "",

30022

"class": "BaseCore",

30023

"module": "base",

30024

"submodule": "base-core"

30025

},

30026

{

30027

"file": "base/js/BaseCore.js",

30028

"line": 592,

30029

"description": "Default toString implementation. Provides the constructor NAME\nand the instance guid, if set.",

30030

"itemtype": "method",

30031

"name": "toString",

30032

"return": {

30033

"description": "String representation for this object",

30034

"type": "String"

30035

},

30036

"class": "BaseCore",

30037

"module": "base",

30038

"submodule": "base-core"

30039

},

30040

{

30041

"file": "base/js/BasePluginHost.js",

30042

"line": 15,

30043

"description": "Alias for <a href=\"Plugin.Host.html#method_Plugin.Host.plug\">Plugin.Host.plug</a>. See aliased \nmethod for argument and return value details.",

30044

"itemtype": "method",

30045

"name": "plug",

30046

"static": 1,

30047

"class": "Base",

30048

"module": "base",

30049

"submodule": "base-pluginhost"

30050

},

30051

{

30052

"file": "base/js/BasePluginHost.js",

30053

"line": 24,

30054

"description": "Alias for <a href=\"Plugin.Host.html#method_Plugin.Host.unplug\">Plugin.Host.unplug</a>. See the \naliased method for argument and return value details.",

30055

"itemtype": "method",

30056

"name": "unplug",

30057

"static": 1,

30058

"class": "Base",

30059

"module": "base",

30060

"submodule": "base-pluginhost"

30061

},

30062

{

30063

"file": "button/js/button.js",

30064

"line": 31,

30065

"itemtype": "method",

30066

"name": "initializer",

30067

"description": "Internal init() handler.",

30068

"params": [

30069

{

30070

"name": "config",

30071

"description": "Config object.",

30072

"type": "Object"

30073

}

30074

],

30075

"access": "private",

30076

"tagname": "",

30077

"class": "Button",

30078

"module": "button"

30079

},

30080

{

30081

"file": "button/js/button.js",

30082

"line": 41,

30083

"description": "Hooks up events for the widget",

30084

"itemtype": "method",

30085

"name": "bindUI",

30086

"class": "Button",

30087

"module": "button"

30088

},

30089

{

30090

"file": "button/js/button.js",

30091

"line": 53,

30092

"itemtype": "method",

30093

"name": "syncUI",

30094

"description": "Updates button attributes",

30095

"class": "Button",

30096

"module": "button"

30097

},

30098

{

30099

"file": "button/js/button.js",

30100

"line": 63,

30101

"itemtype": "method",

30102

"name": "_afterLabelChange",

30103

"access": "private",

30104

"tagname": "",

30105

"class": "Button",

30106

"module": "button"

30107

},

30108

{

30109

"file": "button/js/button.js",

30110

"line": 71,

30111

"itemtype": "method",

30112

"name": "_afterDisabledChange",

30113

"access": "private",

30114

"tagname": "",

30115

"class": "Button",

30116

"module": "button"

30117

},

30118

{

30119

"file": "button/js/button.js",

30120

"line": 82,

30121

"description": "The identity of the widget.",

30122

"itemtype": "property",

30123

"name": "NAME",

30124

"type": "String",

30125

"default": "'button'",

30126

"readonly": "",

30127

"access": "protected",

30128

"tagname": "",

30129

"static": 1,

30130

"class": "Button",

30131

"module": "button"

30132

},

30133

{

30134

"file": "button/js/button.js",

30135

"line": 94,

30136

"description": "Static property used to define the default attribute configuration of\nthe Widget.",

30137

"itemtype": "property",

30138

"name": "ATTRS",

30139

"type": "{Object}",

30140

"access": "protected",

30141

"tagname": "",

30142

"static": 1,

30143

"class": "Button",

30144

"module": "button"

30145

},

30146

{

30147

"file": "button/js/button.js",

30148

"line": 113,

30149

"itemtype": "property",

30150

"name": "HTML_PARSER",

30151

"type": "{Object}",

30152

"access": "protected",

30153

"tagname": "",

30154

"static": 1,

30155

"class": "Button",

30156

"module": "button"

30157

},

30158

{

30159

"file": "button/js/button.js",

30160

"line": 130,

30161

"description": "List of class names used in the ButtonGroup's DOM",

30162

"itemtype": "property",

30163

"name": "CLASS_NAMES",

30164

"type": "Object",

30165

"static": 1,

30166

"class": "Button",

30167

"module": "button"

30168

},

30169

{

30170

"file": "button/js/button.js",

30171

"line": 179,

30172

"itemtype": "method",

30173

"name": "bindUI",

30174

"description": "Hooks up events for the widget",

30175

"class": "ToggleButton",

30176

"module": "button"

30177

},

30178

{

30179

"file": "button/js/button.js",

30180

"line": 193,

30181

"itemtype": "method",

30182

"name": "syncUI",

30183

"description": "Syncs the UI for the widget",

30184

"class": "ToggleButton",

30185

"module": "button"

30186

},

30187

{

30188

"file": "button/js/button.js",

30189

"line": 215,

30190

"itemtype": "method",

30191

"name": "_uiSetSelected",

30192

"access": "private",

30193

"tagname": "",

30194

"class": "ToggleButton",

30195

"module": "button"

30196

},

30197

{

30198

"file": "button/js/button.js",

30199

"line": 230,

30200

"itemtype": "method",

30201

"name": "toggle",

30202

"description": "Toggles the selected/pressed/checked state of a ToggleButton",

30203

"access": "public",

30204

"tagname": "",

30205

"class": "ToggleButton",

30206

"module": "button"

30207

},

30208

{

30209

"file": "button/js/button.js",

30210

"line": 242,

30211

"description": "The identity of the widget.",

30212

"itemtype": "property",

30213

"name": "NAME",

30214

"type": "{String}",

30215

"default": "'buttongroup'",

30216

"readonly": "",

30217

"access": "protected",

30218

"tagname": "",

30219

"static": 1,

30220

"class": "ToggleButton",

30221

"module": "button"

30222

},

30223

{

30224

"file": "button/js/button.js",

30225

"line": 254,

30226

"description": "Static property used to define the default attribute configuration of\nthe Widget.",

30227

"itemtype": "property",

30228

"name": "ATTRS",

30229

"type": "{Object}",

30230

"access": "protected",

30231

"tagname": "",

30232

"static": 1,

30233

"class": "ToggleButton",

30234

"module": "button"

30235

},

30236

{

30237

"file": "button/js/button.js",

30238

"line": 270,

30239

"itemtype": "property",

30240

"name": "HTML_PARSER",

30241

"type": "{Object}",

30242

"access": "protected",

30243

"tagname": "",

30244

"static": 1,

30245

"class": "ToggleButton",

30246

"module": "button"

30247

},

30248

{

30249

"file": "button/js/button.js",

30250

"line": 285,

30251

"itemtype": "property",

30252

"name": "ARIA_STATES",

30253

"type": "{Object}",

30254

"access": "protected",

30255

"tagname": "",

30256

"static": 1,

30257

"class": "ToggleButton",

30258

"module": "button"

30259

},

30260

{

30261

"file": "button/js/button.js",

30262

"line": 293,

30263

"itemtype": "property",

30264

"name": "ARIA_ROLES",

30265

"type": "{Object}",

30266

"access": "protected",

30267

"tagname": "",

30268

"static": 1,

30269

"class": "ToggleButton",

30270

"module": "button"

30271

},

30272

{

30273

"file": "button/js/button.js",

30274

"line": 301,

30275

"description": "Array of static constants used to identify the classnames applied to DOM nodes",

30276

"itemtype": "property",

30277

"name": "CLASS_NAMES",

30278

"type": "Object",

30279

"static": 1,

30280

"class": "ToggleButton",

30281

"module": "button"

30282

},

30283

{

30284

"file": "button/js/core.js",

30285

"line": 26,

30286

"itemtype": "method",

30287

"name": "initializer",

30288

"description": "Internal init() handler.",

30289

"params": [

30290

{

30291

"name": "config",

30292

"description": "Config object.",

30293

"type": "Object"

30294

}

30295

],

30296

"access": "private",

30297

"tagname": "",

30298

"class": "ButtonCore",

30299

"module": "button-core"

30300

},

30301

{

30302

"file": "button/js/core.js",

30303

"line": 38,

30304

"itemtype": "method",

30305

"name": "_initNode",

30306

"description": "Node initializer",

30307

"params": [

30308

{

30309

"name": "config",

30310

"description": "Config object.",

30311

"type": "Object"

30312

}

30313

],

30314

"access": "private",

30315

"tagname": "",

30316

"class": "ButtonCore",

30317

"module": "button-core"

30318

},

30319

{

30320

"file": "button/js/core.js",

30321

"line": 52,

30322

"itemtype": "method",

30323

"name": "_initAttributes",

30324

"description": "Attribute initializer",

30325

"params": [

30326

{

30327

"name": "config",

30328

"description": "Config object.",

30329

"type": "Object"

30330

}

30331

],

30332

"access": "private",

30333

"tagname": "",

30334

"class": "ButtonCore",

30335

"module": "button-core"

30336

},

30337

{

30338

"file": "button/js/core.js",

30339

"line": 66,

30340

"itemtype": "method",

30341

"name": "renderUI",

30342

"description": "Renders any UI/DOM elements for Button instances",

30343

"params": [

30344

{

30345

"name": "config",

30346

"description": "Config object.",

30347

"type": "Object"

30348

}

30349

],

30350

"access": "private",

30351

"tagname": "",

30352

"class": "ButtonCore",

30353

"module": "button-core"

30354

},

30355

{

30356

"file": "button/js/core.js",

30357

"line": 84,

30358

"itemtype": "method",

30359

"name": "enable",

30360

"description": "Sets the button's `disabled` DOM attribute to false",

30361

"access": "public",

30362

"tagname": "",

30363

"class": "ButtonCore",

30364

"module": "button-core"

30365

},

30366

{

30367

"file": "button/js/core.js",

30368

"line": 93,

30369

"itemtype": "method",

30370

"name": "disable",

30371

"description": "Sets the button's `disabled` DOM attribute to true",

30372

"access": "public",

30373

"tagname": "",

30374

"class": "ButtonCore",

30375

"module": "button-core"

30376

},

30377

{

30378

"file": "button/js/core.js",

30379

"line": 102,

30380

"itemtype": "method",

30381

"name": "getNode",

30382

"description": "Gets the host node for this button instance",

30383

"access": "public",

30384

"tagname": "",

30385

"class": "ButtonCore",

30386

"module": "button-core"

30387

},

30388

{

30389

"file": "button/js/core.js",

30390

"line": 111,

30391

"itemtype": "method",

30392

"name": "_getLabel",

30393

"description": "Getter for a button's 'label' ATTR",

30394

"access": "private",

30395

"tagname": "",

30396

"class": "ButtonCore",

30397

"module": "button-core"

30398

},

30399

{

30400

"file": "button/js/core.js",

30401

"line": 131,

30402

"itemtype": "method",

30403

"name": "_uiSetLabel",

30404

"description": "Setter for a button's 'label' ATTR",

30405

"params": [

30406

{

30407

"name": "label",

30408

"description": "",

30409

"type": "String"

30410

}

30411

],

30412

"access": "private",

30413

"tagname": "",

30414

"class": "ButtonCore",

30415

"module": "button-core"

30416

},

30417

{

30418

"file": "button/js/core.js",

30419

"line": 150,

30420

"itemtype": "method",

30421

"name": "_uiSetDisabled",

30422

"description": "Setter for the 'disabled' ATTR",

30423

"params": [

30424

{

30425

"name": "value",

30426

"description": "",

30427

"type": "Boolean"

30428

}

30429

],

30430

"access": "private",

30431

"tagname": "",

30432

"class": "ButtonCore",

30433

"module": "button-core"

30434

},

30435

{

30436

"file": "button/js/core.js",

30437

"line": 166,

30438

"description": "Attribute configuration.",

30439

"itemtype": "property",

30440

"name": "ATTRS",

30441

"type": "{Object}",

30442

"access": "private",

30443

"tagname": "",

30444

"static": 1,

30445

"class": "ButtonCore",

30446

"module": "button-core"

30447

},

30448

{

30449

"file": "button/js/core.js",

30450

"line": 188,

30451

"description": "Name of this component.",

30452

"itemtype": "property",

30453

"name": "NAME",

30454

"type": "String",

30455

"static": 1,

30456

"class": "ButtonCore",

30457

"module": "button-core"

30458

},

30459

{

30460

"file": "button/js/core.js",

30461

"line": 197,

30462

"description": "Array of static constants used to identify the classnames applied to DOM nodes",

30463

"itemtype": "property",

30464

"name": "CLASS_NAMES",

30465

"type": "{Object}",

30466

"access": "public",

30467

"tagname": "",

30468

"static": 1,

30469

"class": "ButtonCore",

30470

"module": "button-core"

30471

},

30472

{

30473

"file": "button/js/core.js",

30474

"line": 212,

30475

"description": "Array of static constants used to for applying ARIA states",

30476

"itemtype": "property",

30477

"name": "CLASS_NAMES",

30478

"type": "{Object}",

30479

"access": "private",

30480

"tagname": "",

30481

"static": 1,

30482

"class": "ButtonCore",

30483

"module": "button-core"

30484

},

30485

{

30486

"file": "button/js/core.js",

30487

"line": 225,

30488

"description": "Array of static constants used to for applying ARIA roles",

30489

"itemtype": "property",

30490

"name": "CLASS_NAMES",

30491

"type": "{Object}",

30492

"access": "private",

30493

"tagname": "",

30494

"static": 1,

30495

"class": "ButtonCore",

30496

"module": "button-core"

30497

},

30498

{

30499

"file": "button/js/group.js",

30500

"line": 28,

30501

"itemtype": "method",

30502

"name": "renderUI",

30503

"description": "Creates a visual representation of the widget based on existing parameters.",

30504

"access": "public",

30505

"tagname": "",

30506

"class": "ButtonGroup",

30507

"module": "button-group"

30508

},

30509

{

30510

"file": "button/js/group.js",

30511

"line": 37,

30512

"itemtype": "method",

30513

"name": "bindUI",

30514

"description": "Hooks up events for the widget",

30515

"access": "public",

30516

"tagname": "",

30517

"class": "ButtonGroup",

30518

"module": "button-group"

30519

},

30520

{

30521

"file": "button/js/group.js",

30522

"line": 49,

30523

"itemtype": "method",

30524

"name": "getButtons",

30525

"description": "Returns all buttons inside this this button group",

30526

"access": "public",

30527

"tagname": "",

30528

"class": "ButtonGroup",

30529

"module": "button-group"

30530

},

30531

{

30532

"file": "button/js/group.js",

30533

"line": 60,

30534

"itemtype": "method",

30535

"name": "getSelectedButtons",

30536

"description": "Returns all Y.Buttons instances that are selected",

30537

"access": "public",

30538

"tagname": "",

30539

"class": "ButtonGroup",

30540

"module": "button-group"

30541

},

30542

{

30543

"file": "button/js/group.js",

30544

"line": 80,

30545

"itemtype": "method",

30546

"name": "getSelectedValues",

30547

"description": "Returns the values of all Y.Button instances that are selected",

30548

"access": "public",

30549

"tagname": "",

30550

"class": "ButtonGroup",

30551

"module": "button-group"

30552

},

30553

{

30554

"file": "button/js/group.js",

30555

"line": 102,

30556

"itemtype": "method",

30557

"name": "_handleClick",

30558

"description": "A delegated click handler for when any button is clicked in the content box",

30559

"params": [

30560

{

30561

"name": "e",

30562

"description": "An event object",

30563

"type": "Object"

30564

}

30565

],

30566

"access": "private",

30567

"tagname": "",

30568

"class": "ButtonGroup",

30569

"module": "button-group"

30570

},

30571

{

30572

"file": "button/js/group.js",

30573

"line": 135,

30574

"description": "The identity of the widget.",

30575

"itemtype": "property",

30576

"name": "NAME",

30577

"type": "{String}",

30578

"default": "'buttongroup'",

30579

"readonly": "",

30580

"access": "protected",

30581

"tagname": "",

30582

"static": 1,

30583

"class": "ButtonGroup",

30584

"module": "button-group"

30585

},

30586

{

30587

"file": "button/js/group.js",

30588

"line": 147,

30589

"description": "Static property used to define the default attribute configuration of\nthe Widget.",

30590

"itemtype": "property",

30591

"name": "ATTRS",

30592

"type": "{Object}",

30593

"access": "protected",

30594

"tagname": "",

30595

"static": 1,

30596

"class": "ButtonGroup",

30597

"module": "button-group"

30598

},

30599

{

30600

"file": "button/js/group.js",

30601

"line": 163,

30602

"description": "List of class names to use for ButtonGroups",

30603

"itemtype": "property",

30604

"name": "CLASS_NAMES",

30605

"type": "{Object}",

30606

"static": 1,

30607

"class": "ButtonGroup",

30608

"module": "button-group"

30609

},

30610

{

30611

"file": "button/js/plugin.js",

30612

"line": 19,

30613

"itemtype": "method",

30614

"name": "_afterNodeGet",

30615

"params": [

30616

{

30617

"name": "name",

30618

"description": "",

30619

"type": "String"

30620

}

30621

],

30622

"access": "private",

30623

"tagname": "",

30624

"class": "ButtonPlugin",

30625

"module": "button-plugin"

30626

},

30627

{

30628

"file": "button/js/plugin.js",

30629

"line": 34,

30630

"itemtype": "method",

30631

"name": "_afterNodeSet",

30632

"params": [

30633

{

30634

"name": "name",

30635

"description": "",

30636

"type": "String"

30637

},

30638

{

30639

"name": "val",

30640

"description": "",

30641

"type": "String"

30642

}

30643

],

30644

"access": "private",

30645

"tagname": "",

30646

"class": "ButtonPlugin",

30647

"module": "button-plugin"

30648

},

30649

{

30650

"file": "button/js/plugin.js",

30651

"line": 49,

30652

"itemtype": "method",

30653

"name": "_initNode",

30654

"params": [

30655

{

30656

"name": "config",

30657

"description": "",

30658

"type": "Object"

30659

}

30660

],

30661

"access": "private",

30662

"tagname": "",

30663

"class": "ButtonPlugin",

30664

"module": "button-plugin"

30665

},

30666

{

30667

"file": "button/js/plugin.js",

30668

"line": 62,

30669

"itemtype": "method",

30670

"name": "destroy",

30671

"access": "private",

30672

"tagname": "",

30673

"class": "ButtonPlugin",

30674

"module": "button-plugin"

30675

},

30676

{

30677

"file": "button/js/plugin.js",

30678

"line": 72,

30679

"description": "Attribute configuration.",

30680

"itemtype": "property",

30681

"name": "ATTRS",

30682

"type": "{Object}",

30683

"access": "private",

30684

"tagname": "",

30685

"static": 1,

30686

"class": "ButtonPlugin",

30687

"module": "button-plugin"

30688

},

30689

{

30690

"file": "button/js/plugin.js",

30691

"line": 82,

30692

"description": "Name of this component.",

30693

"itemtype": "property",

30694

"name": "NAME",

30695

"type": "String",

30696

"static": 1,

30697

"class": "ButtonPlugin",

30698

"module": "button-plugin"

30699

},

30700

{

30701

"file": "button/js/plugin.js",

30702

"line": 91,

30703

"description": "Namespace of this component.",

30704

"itemtype": "property",

30705

"name": "NS",

30706

"type": "String",

30707

"static": 1,

30708

"class": "ButtonPlugin",

30709

"module": "button-plugin"

30710

},

30711

{

30712

"file": "button/js/plugin.js",

30713

"line": 102,

30714

"itemtype": "method",

30715

"name": "createNode",

30716

"description": "A factory that plugs a Y.Node instance with Y.Plugin.Button",

30717

"params": [

30718

{

30719

"name": "node",

30720

"description": "",

30721

"type": "Object"

30722

},

30723

{

30724

"name": "config",

30725

"description": "",

30726

"type": "Object"

30727

}

30728

],

30729

"return": {

30730

"description": "A plugged Y.Node instance",

30731

"type": "Object"

30732

},

30733

"access": "public",

30734

"tagname": "",

30735

"class": "ButtonPlugin",

30736

"module": "button-plugin"

30737

},

30738

{

30739

"file": "cache/js/cache-base.js",

30740

"line": 33,

30741

"description": "Class name.",

30742

"itemtype": "property",

30743

"name": "NAME",

30744

"type": "String",

30745

"static": 1,

30746

"final": 1,

30747

"value": "\"cache\"",

30748

"class": "Cache",

30749

"module": "cache",

30750

"submodule": "cache-base"

30751

},

30752

{

30753

"file": "cache/js/cache-base.js",

30754

"line": 52,

30755

"itemtype": "attribute",

30756

"name": "max",

30757

"description": "Maximum number of entries the Cache can hold.\nSet to 0 to turn off caching.",

30758

"type": "Number",

30759

"default": "0",

30760

"class": "Cache",

30761

"module": "cache",

30762

"submodule": "cache-base"

30763

},

30764

{

30765

"file": "cache/js/cache-base.js",

30766

"line": 64,

30767

"itemtype": "attribute",

30768

"name": "size",

30769

"description": "Number of entries currently cached.",

30770

"type": "Number",

30771

"class": "Cache",

30772

"module": "cache",

30773

"submodule": "cache-base"

30774

},

30775

{

30776

"file": "cache/js/cache-base.js",

30777

"line": 74,

30778

"itemtype": "attribute",

30779

"name": "uniqueKeys",

30780

"description": "Validate uniqueness of stored keys. Default is false and\nis more performant.",

30781

"type": "Boolean",

30782

"class": "Cache",

30783

"module": "cache",

30784

"submodule": "cache-base"

30785

},

30786

{

30787

"file": "cache/js/cache-base.js",

30788

"line": 84,

30789

"itemtype": "attribute",

30790

"name": "expires",

30791

"description": "Absolute Date when data expires or\nrelative number of milliseconds. Zero disables expiration.",

30792

"type": "Date | Number",

30793

"default": "0",

30794

"class": "Cache",

30795

"module": "cache",

30796

"submodule": "cache-base"

30797

},

30798

{

30799

"file": "cache/js/cache-base.js",

30800

"line": 98,

30801

"itemtype": "attribute",

30802

"name": "entries",

30803

"description": "Cached entries.",

30804

"type": "Array",

30805

"class": "Cache",

30806

"module": "cache",

30807

"submodule": "cache-base"

30808

},

30809

{

30810

"file": "cache/js/cache-base.js",

30811

"line": 117,

30812

"description": "Array of request/response objects indexed chronologically.",

30813

"itemtype": "property",

30814

"name": "_entries",

30815

"type": "Object[]",

30816

"access": "private",

30817

"tagname": "",

30818

"class": "Cache",

30819

"module": "cache",

30820

"submodule": "cache-base"

30821

},

30822

{

30823

"file": "cache/js/cache-base.js",

30824

"line": 132,

30825

"itemtype": "method",

30826

"name": "initializer",

30827

"description": "Internal init() handler.",

30828

"params": [

30829

{

30830

"name": "config",

30831

"description": "Config object.",

30832

"type": "Object"

30833

}

30834

],

30835

"access": "private",

30836

"tagname": "",

30837

"class": "Cache",

30838

"module": "cache",

30839

"submodule": "cache-base"

30840

},

30841

{

30842

"file": "cache/js/cache-base.js",

30843

"line": 140,

30844

"itemtype": "event",

30845

"name": "add",

30846

"description": "Fired when an entry is added.",

30847

"params": [

30848

{

30849

"name": "e",

30850

"description": "Event Facade with the following properties:\n<dl>\n<dt>entry (Object)</dt> <dd>The cached entry.</dd>\n</dl>",

30851

"type": "Event.Facade"

30852

}

30853

],

30854

"preventable": "_defAddFn",

30855

"class": "Cache",

30856

"module": "cache",

30857

"submodule": "cache-base"

30858

},

30859

{

30860

"file": "cache/js/cache-base.js",

30861

"line": 151,

30862

"itemtype": "event",

30863

"name": "flush",

30864

"description": "Fired when the cache is flushed.",

30865

"params": [

30866

{

30867

"name": "e",

30868

"description": "Event Facade object.",

30869

"type": "Event.Facade"

30870

}

30871

],

30872

"preventable": "_defFlushFn",

30873

"class": "Cache",

30874

"module": "cache",

30875

"submodule": "cache-base"

30876

},

30877

{

30878

"file": "cache/js/cache-base.js",

30879

"line": 159,

30880

"itemtype": "event",

30881

"name": "request",

30882

"description": "Fired when an entry is requested from the cache.",

30883

"params": [

30884

{

30885

"name": "e",

30886

"description": "Event Facade with the following properties:\n<dl>\n<dt>request (Object)</dt> <dd>The request object.</dd>\n</dl>",

30887

"type": "Event.Facade"

30888

}

30889

],

30890

"class": "Cache",

30891

"module": "cache",

30892

"submodule": "cache-base"

30893

},

30894

{

30895

"file": "cache/js/cache-base.js",

30896

"line": 168,

30897

"itemtype": "event",

30898

"name": "retrieve",

30899

"description": "Fired when an entry is retrieved from the cache.",

30900

"params": [

30901

{

30902

"name": "e",

30903

"description": "Event Facade with the following properties:\n<dl>\n<dt>entry (Object)</dt> <dd>The retrieved entry.</dd>\n</dl>",

30904

"type": "Event.Facade"

30905

}

30906

],

30907

"class": "Cache",

30908

"module": "cache",

30909

"submodule": "cache-base"

30910

},

30911

{

30912

"file": "cache/js/cache-base.js",

30913

"line": 182,

30914

"itemtype": "method",

30915

"name": "destructor",

30916

"description": "Internal destroy() handler.",

30917

"access": "private",

30918

"tagname": "",

30919

"class": "Cache",

30920

"module": "cache",

30921

"submodule": "cache-base"

30922

},

30923

{

30924

"file": "cache/js/cache-base.js",

30925

"line": 198,

30926

"description": "Sets max.",

30927

"itemtype": "method",

30928

"name": "_setMax",

30929

"access": "protected",

30930

"tagname": "",

30931

"class": "Cache",

30932

"module": "cache",

30933

"submodule": "cache-base"

30934

},

30935

{

30936

"file": "cache/js/cache-base.js",

30937

"line": 221,

30938

"description": "Gets size.",

30939

"itemtype": "method",

30940

"name": "_getSize",

30941

"access": "protected",

30942

"tagname": "",

30943

"class": "Cache",

30944

"module": "cache",

30945

"submodule": "cache-base"

30946

},

30947

{

30948

"file": "cache/js/cache-base.js",

30949

"line": 231,

30950

"description": "Gets all entries.",

30951

"itemtype": "method",

30952

"name": "_getEntries",

30953

"access": "protected",

30954

"tagname": "",

30955

"class": "Cache",

30956

"module": "cache",

30957

"submodule": "cache-base"

30958

},

30959

{

30960

"file": "cache/js/cache-base.js",

30961

"line": 242,

30962

"description": "Adds entry to cache.",

30963

"itemtype": "method",

30964

"name": "_defAddFn",

30965

"params": [

30966

{

30967

"name": "e",

30968

"description": "Event Facade with the following properties:\n<dl>\n<dt>entry (Object)</dt> <dd>The cached entry.</dd>\n</dl>",

30969

"type": "Event.Facade"

30970

}

30971

],

30972

"access": "protected",

30973

"tagname": "",

30974

"class": "Cache",

30975

"module": "cache",

30976

"submodule": "cache-base"

30977

},

30978

{

30979

"file": "cache/js/cache-base.js",

30980

"line": 277,

30981

"description": "Flushes cache.",

30982

"itemtype": "method",

30983

"name": "_defFlushFn",

30984

"params": [

30985

{

30986

"name": "e",

30987

"description": "Event Facade object.",

30988

"type": "Event.Facade"

30989

}

30990

],

30991

"access": "protected",

30992

"tagname": "",

30993

"class": "Cache",

30994

"module": "cache",

30995

"submodule": "cache-base"

30996

},

30997

{

30998

"file": "cache/js/cache-base.js",

30999

"line": 306,

31000

"description": "Default overridable method compares current request with given cache entry.\nReturns true if current request matches the cached request, otherwise\nfalse. Implementers should override this method to customize the\ncache-matching algorithm.",

31001

"itemtype": "method",

31002

"name": "_isMatch",

31003

"params": [

31004

{

31005

"name": "request",

31006

"description": "Request object.",

31007

"type": "Object"

31008

},

31009

{

31010

"name": "entry",

31011

"description": "Cached entry.",

31012

"type": "Object"

31013

}

31014

],

31015

"return": {

31016

"description": "True if current request matches given cached request, false otherwise.",

31017

"type": "Boolean"

31018

},

31019

"access": "protected",

31020

"tagname": "",

31021

"class": "Cache",

31022

"module": "cache",

31023

"submodule": "cache-base"

31024

},

31025

{

31026

"file": "cache/js/cache-base.js",

31027

"line": 325,

31028

"description": "Returns position of a request in the entries array, otherwise null.",

31029

"itemtype": "method",

31030

"name": "_position",

31031

"params": [

31032

{

31033

"name": "request",

31034

"description": "Request object.",

31035

"type": "Object"

31036

}

31037

],

31038

"return": {

31039

"description": "Array position if found, null otherwise.",

31040

"type": "Number"

31041

},

31042

"access": "protected",

31043

"tagname": "",

31044

"class": "Cache",

31045

"module": "cache",

31046

"submodule": "cache-base"

31047

},

31048

{

31049

"file": "cache/js/cache-base.js",

31050

"line": 358,

31051

"description": "Adds a new entry to the cache of the format\n{request:request, response:response, cached:cached, expires:expires}.\nIf cache is full, evicts the stalest entry before adding the new one.",

31052

"itemtype": "method",

31053

"name": "add",

31054

"params": [

31055

{

31056

"name": "request",

31057

"description": "Request value.",

31058

"type": "Object"

31059

},

31060

{

31061

"name": "response",

31062

"description": "Response value.",

31063

"type": "Object"

31064

}

31065

],

31066

"class": "Cache",

31067

"module": "cache",

31068

"submodule": "cache-base"

31069

},

31070

{

31071

"file": "cache/js/cache-base.js",

31072

"line": 384,

31073

"description": "Flushes cache.",

31074

"itemtype": "method",

31075

"name": "flush",

31076

"class": "Cache",

31077

"module": "cache",

31078

"submodule": "cache-base"

31079

},

31080

{

31081

"file": "cache/js/cache-base.js",

31082

"line": 393,

31083

"description": "Retrieves cached object for given request, if available, and refreshes\nentry in the cache. Returns null if there is no cache match.",

31084

"itemtype": "method",

31085

"name": "retrieve",

31086

"params": [

31087

{

31088

"name": "request",

31089

"description": "Request object.",

31090

"type": "Object"

31091

}

31092

],

31093

"return": {

31094

"description": "Cached object with the properties request and response, or null.",

31095

"type": "Object"

31096

},

31097

"class": "Cache",

31098

"module": "cache",

31099

"submodule": "cache-base"

31100

},

31101

{

31102

"file": "cache/js/cache-offline.js",

31103

"line": 35,

31104

"itemtype": "event",

31105

"name": "error",

31106

"description": "Fired when an entry could not be added, most likely due to\nexceeded browser quota.\n<dl>\n<dt>error (Object)</dt> <dd>The error object.</dd>\n</dl>",

31107

"class": "CacheOffline",

31108

"module": "cache",

31109

"submodule": "cache-offline"

31110

},

31111

{

31112

"file": "cache/js/cache-offline.js",

31113

"line": 50,

31114

"description": "Class name.",

31115

"itemtype": "property",

31116

"name": "NAME",

31117

"type": "String",

31118

"static": 1,

31119

"final": 1,

31120

"value": "\"cacheOffline\"",

31121

"class": "CacheOffline",

31122

"module": "cache",

31123

"submodule": "cache-offline"

31124

},

31125

{

31126

"file": "cache/js/cache-offline.js",

31127

"line": 68,

31128

"itemtype": "attribute",

31129

"name": "sandbox",

31130

"description": "A string that must be passed in via the constructor.\nThis identifier is used to sandbox one cache instance's entries\nfrom another. Calling the cache instance's flush and length methods\nor get(\"entries\") will apply to only these sandboxed entries.",

31131

"type": "String",

31132

"default": "\"default\"",

31133

"initonly": "",

31134

"class": "CacheOffline",

31135

"module": "cache",

31136

"submodule": "cache-offline"

31137

},

31138

{

31139

"file": "cache/js/cache-offline.js",

31140

"line": 83,

31141

"itemtype": "attribute",

31142

"name": "expires",

31143

"description": "Absolute Date when data expires or\nrelative number of milliseconds. Zero disables expiration.",

31144

"type": "Date | Number",

31145

"default": "86400000 (one day)",

31146

"class": "CacheOffline",

31147

"module": "cache",

31148

"submodule": "cache-offline"

31149

},

31150

{

31151

"file": "cache/js/cache-offline.js",

31152

"line": 94,

31153

"itemtype": "attribute",

31154

"name": "max",

31155

"description": "Disabled.",

31156

"readonly": "",

31157

"default": "null",

31158

"class": "CacheOffline",

31159

"module": "cache",

31160

"submodule": "cache-offline"

31161

},

31162

{

31163

"file": "cache/js/cache-offline.js",

31164

"line": 105,

31165

"itemtype": "attribute",

31166

"name": "uniqueKeys",

31167

"description": "Always true for CacheOffline.",

31168

"readonly": "",

31169

"default": "true",

31170

"class": "CacheOffline",

31171

"module": "cache",

31172

"submodule": "cache-offline"

31173

},

31174

{

31175

"file": "cache/js/cache-offline.js",

31176

"line": 120,

31177

"description": "Removes all items from all sandboxes. Useful if localStorage has\nexceeded quota. Only supported on browsers that implement HTML 5\nlocalStorage.",

31178

"itemtype": "method",

31179

"name": "flushAll",

31180

"static": 1,

31181

"class": "CacheOffline",

31182

"module": "cache",

31183

"submodule": "cache-offline"

31184

},

31185

{

31186

"file": "cache/js/cache-offline.js",

31187

"line": 163,

31188

"description": "Always return null.",

31189

"itemtype": "method",

31190

"name": "_setMax",

31191

"access": "protected",

31192

"tagname": "",

31193

"class": "CacheOffline",

31194

"module": "cache",

31195

"submodule": "cache-offline"

31196

},

31197

{

31198

"file": "cache/js/cache-offline.js",

31199

"line": 173,

31200

"description": "Gets size.",

31201

"itemtype": "method",

31202

"name": "_getSize",

31203

"access": "protected",

31204

"tagname": "",

31205

"class": "CacheOffline",

31206

"module": "cache",

31207

"submodule": "cache-offline"

31208

},

31209

{

31210

"file": "cache/js/cache-offline.js",

31211

"line": 192,

31212

"description": "Gets all entries.",

31213

"itemtype": "method",

31214

"name": "_getEntries",

31215

"access": "protected",

31216

"tagname": "",

31217

"class": "CacheOffline",

31218

"module": "cache",

31219

"submodule": "cache-offline"

31220

},

31221

{

31222

"file": "cache/js/cache-offline.js",

31223

"line": 212,

31224

"description": "Adds entry to cache.",

31225

"itemtype": "method",

31226

"name": "_defAddFn",

31227

"params": [

31228

{

31229

"name": "e",

31230

"description": "Event Facade with the following properties:\n<dl>\n<dt>entry (Object)</dt> <dd>The cached entry.</dd>\n</dl>",

31231

"type": "Event.Facade"

31232

}

31233

],

31234

"access": "protected",

31235

"tagname": "",

31236

"class": "CacheOffline",

31237

"module": "cache",

31238

"submodule": "cache-offline"

31239

},

31240

{

31241

"file": "cache/js/cache-offline.js",

31242

"line": 243,

31243

"description": "Flushes cache.",

31244

"itemtype": "method",

31245

"name": "_defFlushFn",

31246

"params": [

31247

{

31248

"name": "e",

31249

"description": "Event Facade object.",

31250

"type": "Event.Facade"

31251

}

31252

],

31253

"access": "protected",

31254

"tagname": "",

31255

"class": "CacheOffline",

31256

"module": "cache",

31257

"submodule": "cache-offline"

31258

},

31259

{

31260

"file": "cache/js/cache-offline.js",

31261

"line": 267,

31262

"description": "Adds a new entry to the cache of the format\n{request:request, response:response, cached:cached, expires: expires}.",

31263

"itemtype": "method",

31264

"name": "add",

31265

"params": [

31266

{

31267

"name": "request",

31268

"description": "Request value must be a String or JSON.",

31269

"type": "Object"

31270

},

31271

{

31272

"name": "response",

31273

"description": "Response value must be a String or JSON.",

31274

"type": "Object"

31275

}

31276

],

31277

"class": "CacheOffline",

31278

"module": "cache",

31279

"submodule": "cache-offline"

31280

},

31281

{

31282

"file": "cache/js/cache-offline.js",

31283

"line": 276,

31284

"description": "Retrieves cached object for given request, if available.\nReturns null if there is no cache match.",

31285

"itemtype": "method",

31286

"name": "retrieve",

31287

"params": [

31288

{

31289

"name": "request",

31290

"description": "Request object.",

31291

"type": "Object"

31292

}

31293

],

31294

"return": {

31295

"description": "Cached object with the properties request, response,\nand expires, or null.",

31296

"type": "Object"

31297

},

31298

"class": "CacheOffline",

31299

"module": "cache",

31300

"submodule": "cache-offline"

31301

},

31302

{

31303

"file": "cache/js/cache-offline.js",

31304

"line": 324,

31305

"description": "Always return null.",

31306

"itemtype": "method",

31307

"name": "_setMax",

31308

"access": "protected",

31309

"tagname": "",

31310

"class": "CacheOffline",

31311

"module": "cache",

31312

"submodule": "cache-offline"

31313

},

31314

{

31315

"file": "cache/js/cache-plugin.js",

31316

"line": 23,

31317

"description": "The namespace for the plugin. This will be the property on the host which\nreferences the plugin instance.",

31318

"itemtype": "property",

31319

"name": "NS",

31320

"type": "String",

31321

"static": 1,

31322

"final": 1,

31323

"value": "\"cache\"",

31324

"class": "Plugin.Cache",

31325

"module": "cache",

31326

"submodule": "cache-plugin"

31327

},

31328

{

31329

"file": "cache/js/cache-plugin.js",

31330

"line": 35,

31331

"description": "Class name.",

31332

"itemtype": "property",

31333

"name": "NAME",

31334

"type": "String",

31335

"static": 1,

31336

"final": 1,

31337

"value": "\"dataSourceCache\"",

31338

"class": "Plugin.Cache",

31339

"module": "cache",

31340

"submodule": "cache-plugin"

31341

},

31342

{

31343

"file": "calendar/js/calendar-base.js",

31344

"line": 61,

31345

"description": "A storage for various properties of individual month\npanes.",

31346

"itemtype": "property",

31347

"name": "_paneProperties",

31348

"type": "Object",

31349

"access": "private",

31350

"tagname": "",

31351

"class": "CalendarBase",

31352

"module": "calendar",

31353

"submodule": "calendar-base"

31354

},

31355

{

31356

"file": "calendar/js/calendar-base.js",

31357

"line": 71,

31358

"description": "The number of month panes in the calendar, deduced\nfrom the CONTENT_TEMPLATE's number of {calendar_grid}\ntokens.",

31359

"itemtype": "property",

31360

"name": "_paneNumber",

31361

"type": "Number",

31362

"access": "private",

31363

"tagname": "",

31364

"class": "CalendarBase",

31365

"module": "calendar",

31366

"submodule": "calendar-base"

31367

},

31368

{

31369

"file": "calendar/js/calendar-base.js",

31370

"line": 82,

31371

"description": "The unique id used to prefix various elements of this\ncalendar instance.",

31372

"itemtype": "property",

31373

"name": "_calendarId",

31374

"type": "String",

31375

"access": "private",

31376

"tagname": "",

31377

"class": "CalendarBase",

31378

"module": "calendar",

31379

"submodule": "calendar-base"

31380

},

31381

{

31382

"file": "calendar/js/calendar-base.js",

31383

"line": 92,

31384

"description": "The hash map of selected dates, populated with\nselectDates() and deselectDates() methods",

31385

"itemtype": "property",

31386

"name": "_selectedDates",

31387

"type": "Object",

31388

"access": "private",

31389

"tagname": "",

31390

"class": "CalendarBase",

31391

"module": "calendar",

31392

"submodule": "calendar-base"

31393

},

31394

{

31395

"file": "calendar/js/calendar-base.js",

31396

"line": 102,

31397

"description": "A private copy of the rules object, populated\nby setting the customRenderer attribute.",

31398

"itemtype": "property",

31399

"name": "_rules",

31400

"type": "Object",

31401

"access": "private",

31402

"tagname": "",

31403

"class": "CalendarBase",

31404

"module": "calendar",

31405

"submodule": "calendar-base"

31406

},

31407

{

31408

"file": "calendar/js/calendar-base.js",

31409

"line": 112,

31410

"description": "A private copy of the filterFunction, populated\nby setting the customRenderer attribute.",

31411

"itemtype": "property",

31412

"name": "_filterFunction",

31413

"type": "Function",

31414

"access": "private",

31415

"tagname": "",

31416

"class": "CalendarBase",

31417

"module": "calendar",

31418

"submodule": "calendar-base"

31419

},

31420

{

31421

"file": "calendar/js/calendar-base.js",

31422

"line": 122,

31423

"description": "Storage for calendar cells modified by any custom\nformatting. The storage is cleared, used to restore\ncells to the original state, and repopulated accordingly\nwhen the calendar is rerendered.",

31424

"itemtype": "property",

31425

"name": "_storedDateCells",

31426

"type": "Object",

31427

"access": "private",

31428

"tagname": "",

31429

"class": "CalendarBase",

31430

"module": "calendar",

31431

"submodule": "calendar-base"

31432

},

31433

{

31434

"file": "calendar/js/calendar-base.js",

31435

"line": 134,

31436

"description": "Designated initializer\nInitializes instance-level properties of\ncalendar.",

31437

"itemtype": "method",

31438

"name": "initializer",

31439

"class": "CalendarBase",

31440

"module": "calendar",

31441

"submodule": "calendar-base"

31442

},

31443

{

31444

"file": "calendar/js/calendar-base.js",

31445

"line": 149,

31446

"description": "renderUI implementation\n\nCreates a visual representation of the calendar based on existing parameters.",

31447

"itemtype": "method",

31448

"name": "renderUI",

31449

"class": "CalendarBase",

31450

"module": "calendar",

31451

"submodule": "calendar-base"

31452

},

31453

{

31454

"file": "calendar/js/calendar-base.js",

31455

"line": 171,

31456

"description": "bindUI implementation\n\nAssigns listeners to relevant events that change the state\nof the calendar.",

31457

"itemtype": "method",

31458

"name": "bindUI",

31459

"class": "CalendarBase",

31460

"module": "calendar",

31461

"submodule": "calendar-base"

31462

},

31463

{

31464

"file": "calendar/js/calendar-base.js",

31465

"line": 190,

31466

"description": "syncUI implementation\n\nUpdate the scroll position, based on the current value of scrollY",

31467

"itemtype": "method",

31468

"name": "syncUI",

31469

"class": "CalendarBase",

31470

"module": "calendar",

31471

"submodule": "calendar-base"

31472

},

31473

{

31474

"file": "calendar/js/calendar-base.js",

31475

"line": 207,

31476

"description": "An internal utility method that generates a list of selected dates \nfrom the hash storage.",

31477

"itemtype": "method",

31478

"name": "_getSelectedDatesList",

31479

"access": "protected",

31480

"tagname": "",

31481

"return": {

31482

"description": "The array of `Date`s that are currently selected.",

31483

"type": "Array"

31484

},

31485

"class": "CalendarBase",

31486

"module": "calendar",

31487

"submodule": "calendar-base"

31488

},

31489

{

31490

"file": "calendar/js/calendar-base.js",

31491

"line": 227,

31492

"description": "A utility method that returns all dates selected in a specific month.",

31493

"itemtype": "method",

31494

"name": "_getSelectedDatesInMonth",

31495

"params": [

31496

{

31497

"name": "oDate",

31498

"description": "corresponding to the month for which selected dates\nare requested.",

31499

"type": "Date"

31500

}

31501

],

31502

"access": "protected",

31503

"tagname": "",

31504

"return": {

31505

"description": "The array of `Date`s in a given month that are currently selected.",

31506

"type": "Array"

31507

},

31508

"class": "CalendarBase",

31509

"module": "calendar",

31510

"submodule": "calendar-base"

31511

},

31512

{

31513

"file": "calendar/js/calendar-base.js",

31514

"line": 248,

31515

"description": "An internal rendering method that modifies a date cell to have the\nselected CSS class if the date cell is visible.",

31516

"itemtype": "method",

31517

"name": "_renderSelectedDate",

31518

"params": [

31519

{

31520

"name": "oDate",

31521

"description": "The date corresponding to a specific date cell.",

31522

"type": "Date"

31523

}

31524

],

31525

"access": "private",

31526

"tagname": "",

31527

"class": "CalendarBase",

31528

"module": "calendar",

31529

"submodule": "calendar-base"

31530

},

31531

{

31532

"file": "calendar/js/calendar-base.js",

31533

"line": 262,

31534

"description": "An internal rendering method that modifies a date cell to remove the\nselected CSS class if the date cell is visible.",

31535

"itemtype": "method",

31536

"name": "_renderUnelectedDate",

31537

"params": [

31538

{

31539

"name": "oDate",

31540

"description": "The date corresponding to a specific date cell.",

31541

"type": "Date"

31542

}

31543

],

31544

"access": "private",

31545

"tagname": "",

31546

"class": "CalendarBase",

31547

"module": "calendar",

31548

"submodule": "calendar-base"

31549

},

31550

{

31551

"file": "calendar/js/calendar-base.js",

31552

"line": 276,

31553

"description": "An internal utility method that checks whether a particular date\nis in the current view of the calendar.",

31554

"itemtype": "method",

31555

"name": "_isDateVisible",

31556

"params": [

31557

{

31558

"name": "oDate",

31559

"description": "The date corresponding to a specific date cell.",

31560

"type": "Date"

31561

}

31562

],

31563

"access": "private",

31564

"tagname": "",

31565

"return": {

31566

"description": "Returns true if the given date is in the current \nview of the calendar.",

31567

"type": "Boolean"

31568

},

31569

"class": "CalendarBase",

31570

"module": "calendar",

31571

"submodule": "calendar-base"

31572

},

31573

{

31574

"file": "calendar/js/calendar-base.js",

31575

"line": 299,

31576

"description": "An internal parsing method that receives a String list of numbers\nand number ranges (of the form \"1,2,3,4-6,7-9,10,11\" etc.) and checks\nwhether a specific number is included in this list. Used for looking\nup dates in the customRenderer rule set.",

31577

"itemtype": "method",

31578

"name": "_isNumInList",

31579

"params": [

31580

{

31581

"name": "num",

31582

"description": "The number to look for in a list.",

31583

"type": "Number"

31584

},

31585

{

31586

"name": "strList",

31587

"description": "The list of numbers of the form \"1,2,3,4-6,7-8,9\", etc.",

31588

"type": "String"

31589

}

31590

],

31591

"access": "private",

31592

"tagname": "",

31593

"return": {

31594

"description": "Returns true if the given number is in the given list.",

31595

"type": "Boolean"

31596

},

31597

"class": "CalendarBase",

31598

"module": "calendar",

31599

"submodule": "calendar-base"

31600

},

31601

{

31602

"file": "calendar/js/calendar-base.js",

31603

"line": 332,

31604

"description": "Given a specific date, returns an array of rules (from the customRenderer rule set)\nthat the given date matches.",

31605

"itemtype": "method",

31606

"name": "_getRulesForDate",

31607

"params": [

31608

{

31609

"name": "oDate",

31610

"description": "The date for which an array of rules is needed",

31611

"type": "Date"

31612

}

31613

],

31614

"access": "private",

31615

"tagname": "",

31616

"return": {

31617

"description": "Returns an array of `String`s, each containg the name of\na rule that the given date matches.",

31618

"type": "Array"

31619

},

31620

"class": "CalendarBase",

31621

"module": "calendar",

31622

"submodule": "calendar-base"

31623

},

31624

{

31625

"file": "calendar/js/calendar-base.js",

31626

"line": 388,

31627

"description": "A utility method which, given a specific date and a name of the rule,\nchecks whether the date matches the given rule.",

31628

"itemtype": "method",

31629

"name": "_matchesRule",

31630

"params": [

31631

{

31632

"name": "oDate",

31633

"description": "The date to check",

31634

"type": "Date"

31635

},

31636

{

31637

"name": "rule",

31638

"description": "The name of the rule that the date should match.",

31639

"type": "String"

31640

}

31641

],

31642

"access": "private",

31643

"tagname": "",

31644

"return": {

31645

"description": "Returns true if the date matches the given rule.",

31646

"type": "Boolean"

31647

},

31648

"class": "CalendarBase",

31649

"module": "calendar",

31650

"submodule": "calendar-base"

31651

},

31652

{

31653

"file": "calendar/js/calendar-base.js",

31654

"line": 403,

31655

"description": "A utility method which checks whether a given date matches the `enabledDatesRule`\nor does not match the `disabledDatesRule` and therefore whether it can be selected.",

31656

"itemtype": "method",

31657

"name": "_canBeSelected",

31658

"params": [

31659

{

31660

"name": "oDate",

31661

"description": "The date to check",

31662

"type": "Date"

31663

}

31664

],

31665

"access": "private",

31666

"tagname": "",

31667

"return": {

31668

"description": "Returns true if the date can be selected; false otherwise.",

31669

"type": "Boolean"

31670

},

31671

"class": "CalendarBase",

31672

"module": "calendar",

31673

"submodule": "calendar-base"

31674

},

31675

{

31676

"file": "calendar/js/calendar-base.js",

31677

"line": 427,

31678

"description": "Selects a given date or array of dates.",

31679

"itemtype": "method",

31680

"name": "selectDates",

31681

"params": [

31682

{

31683

"name": "dates",

31684

"description": "A `Date` or `Array` of `Date`s.",

31685

"type": "Date|Array"

31686

}

31687

],

31688

"class": "CalendarBase",

31689

"module": "calendar",

31690

"submodule": "calendar-base"

31691

},

31692

{

31693

"file": "calendar/js/calendar-base.js",

31694

"line": 441,

31695

"description": "Deselects a given date or array of dates, or deselects\nall dates if no argument is specified.",

31696

"itemtype": "method",

31697

"name": "deselectDates",

31698

"params": [

31699

{

31700

"name": "dates",

31701

"description": "A `Date` or `Array` of `Date`s, or no\nargument if all dates should be deselected.",

31702

"type": "Date|Array",

31703

"optional": true

31704

}

31705

],

31706

"class": "CalendarBase",

31707

"module": "calendar",

31708

"submodule": "calendar-base"

31709

},

31710

{

31711

"file": "calendar/js/calendar-base.js",

31712

"line": 460,

31713

"description": "A utility method that adds a given date to selection..",

31714

"itemtype": "method",

31715

"name": "_addDateToSelection",

31716

"params": [

31717

{

31718

"name": "oDate",

31719

"description": "The date to add to selection.",

31720

"type": "Date"

31721

},

31722

{

31723

"name": "index",

31724

"description": "An optional parameter that is used\nto differentiate between individual date selections and multiple\ndate selections.",

31725

"type": "Number",

31726

"optional": true

31727

}

31728

],

31729

"access": "private",

31730

"tagname": "",

31731

"class": "CalendarBase",

31732

"module": "calendar",

31733

"submodule": "calendar-base"

31734

},

31735

{

31736

"file": "calendar/js/calendar-base.js",

31737

"line": 501,

31738

"description": "A utility method that adds a given list of dates to selection.",

31739

"itemtype": "method",

31740

"name": "_addDatesToSelection",

31741

"params": [

31742

{

31743

"name": "datesArray",

31744

"description": "The list of dates to add to selection.",

31745

"type": "Array"

31746

}

31747

],

31748

"access": "private",

31749

"tagname": "",

31750

"class": "CalendarBase",

31751

"module": "calendar",

31752

"submodule": "calendar-base"

31753

},

31754

{

31755

"file": "calendar/js/calendar-base.js",

31756

"line": 512,

31757

"description": "A utility method that adds a given range of dates to selection.",

31758

"itemtype": "method",

31759

"name": "_addDateRangeToSelection",

31760

"params": [

31761

{

31762

"name": "startDate",

31763

"description": "The first date of the given range.",

31764

"type": "Date"

31765

},

31766

{

31767

"name": "endDate",

31768

"description": "The last date of the given range.",

31769

"type": "Date"

31770

}

31771

],

31772

"access": "private",

31773

"tagname": "",

31774

"class": "CalendarBase",

31775

"module": "calendar",

31776

"submodule": "calendar-base"

31777

},

31778

{

31779

"file": "calendar/js/calendar-base.js",

31780

"line": 542,

31781

"description": "A utility method that removes a given date from selection..",

31782

"itemtype": "method",

31783

"name": "_removeDateFromSelection",

31784

"params": [

31785

{

31786

"name": "oDate",

31787

"description": "The date to remove from selection.",

31788

"type": "Date"

31789

},

31790

{

31791

"name": "index",

31792

"description": "An optional parameter that is used\nto differentiate between individual date selections and multiple\ndate selections.",

31793

"type": "Number",

31794

"optional": true

31795

}

31796

],

31797

"access": "private",

31798

"tagname": "",

31799

"class": "CalendarBase",

31800

"module": "calendar",

31801

"submodule": "calendar-base"

31802

},

31803

{

31804

"file": "calendar/js/calendar-base.js",

31805

"line": 566,

31806

"description": "A utility method that removes a given list of dates from selection.",

31807

"itemtype": "method",

31808

"name": "_removeDatesFromSelection",

31809

"params": [

31810

{

31811

"name": "datesArray",

31812

"description": "The list of dates to remove from selection.",

31813

"type": "Array"

31814

}

31815

],

31816

"access": "private",

31817

"tagname": "",

31818

"class": "CalendarBase",

31819

"module": "calendar",

31820

"submodule": "calendar-base"

31821

},

31822

{

31823

"file": "calendar/js/calendar-base.js",

31824

"line": 577,

31825

"description": "A utility method that removes a given range of dates from selection.",

31826

"itemtype": "method",

31827

"name": "_removeDateRangeFromSelection",

31828

"params": [

31829

{

31830

"name": "startDate",

31831

"description": "The first date of the given range.",

31832

"type": "Date"

31833

},

31834

{

31835

"name": "endDate",

31836

"description": "The last date of the given range.",

31837

"type": "Date"

31838

}

31839

],

31840

"access": "private",

31841

"tagname": "",

31842

"class": "CalendarBase",

31843

"module": "calendar",

31844

"submodule": "calendar-base"

31845

},

31846

{

31847

"file": "calendar/js/calendar-base.js",

31848

"line": 595,

31849

"description": "A utility method that removes all dates from selection.",

31850

"itemtype": "method",

31851

"name": "_clearSelection",

31852

"params": [

31853

{

31854

"name": "noevent",

31855

"description": "A Boolean specifying whether a selectionChange\nevent should be fired.",

31856

"type": "Boolean"

31857

}

31858

],

31859

"access": "private",

31860

"tagname": "",

31861

"class": "CalendarBase",

31862

"module": "calendar",

31863

"submodule": "calendar-base"

31864

},

31865

{

31866

"file": "calendar/js/calendar-base.js",

31867

"line": 610,

31868

"description": "A utility method that fires a selectionChange event.",

31869

"itemtype": "method",

31870

"name": "_fireSelectionChange",

31871

"access": "private",

31872

"tagname": "",

31873

"class": "CalendarBase",

31874

"module": "calendar",

31875

"submodule": "calendar-base"

31876

},

31877

{

31878

"file": "calendar/js/calendar-base.js",

31879

"line": 617,

31880

"description": "Fired when the set of selected dates changes. Contains a payload with\na `newSelection` property with an array of selected dates.",

31881

"itemtype": "event",

31882

"name": "selectionChange",

31883

"class": "CalendarBase",

31884

"module": "calendar",

31885

"submodule": "calendar-base"

31886

},

31887

{

31888

"file": "calendar/js/calendar-base.js",

31889

"line": 626,

31890

"description": "A utility method that restores cells modified by custom formatting.",

31891

"itemtype": "method",

31892

"name": "_restoreModifiedCells",

31893

"access": "private",

31894

"tagname": "",

31895

"class": "CalendarBase",

31896

"module": "calendar",

31897

"submodule": "calendar-base"

31898

},

31899

{

31900

"file": "calendar/js/calendar-base.js",

31901

"line": 640,

31902

"description": "A rendering assist method that renders all cells modified by the customRenderer\nrules, as well as the enabledDatesRule and disabledDatesRule.",

31903

"itemtype": "method",

31904

"name": "_renderCustomRules",

31905

"access": "private",

31906

"tagname": "",

31907

"class": "CalendarBase",

31908

"module": "calendar",

31909

"submodule": "calendar-base"

31910

},

31911

{

31912

"file": "calendar/js/calendar-base.js",

31913

"line": 680,

31914

"description": "A rendering assist method that renders all cells that are currently selected.",

31915

"itemtype": "method",

31916

"name": "_renderSelectedDates",

31917

"access": "private",

31918

"tagname": "",

31919

"class": "CalendarBase",

31920

"module": "calendar",

31921

"submodule": "calendar-base"

31922

},

31923

{

31924

"file": "calendar/js/calendar-base.js",

31925

"line": 698,

31926

"description": "A utility method that converts a date to the node wrapping the calendar cell\nthe date corresponds to..",

31927

"itemtype": "method",

31928

"name": "_dateToNode",

31929

"params": [

31930

{

31931

"name": "oDate",

31932

"description": "The date to convert to Node",

31933

"type": "Date"

31934

}

31935

],

31936

"access": "protected",

31937

"tagname": "",

31938

"return": {

31939

"description": "The node wrapping the DOM element of the cell the date \ncorresponds to.",

31940

"type": "Node"

31941

},

31942

"class": "CalendarBase",

31943

"module": "calendar",

31944

"submodule": "calendar-base"

31945

},

31946

{

31947

"file": "calendar/js/calendar-base.js",

31948

"line": 772,

31949

"description": "A utility method that converts a node corresponding to the DOM element of\nthe cell for a particular date to that date.",

31950

"itemtype": "method",

31951

"name": "_nodeToDate",

31952

"params": [

31953

{

31954

"name": "oNode",

31955

"description": "The Node wrapping the DOM element of a particular date cell.",

31956

"type": "Node"

31957

}

31958

],

31959

"access": "protected",

31960

"tagname": "",

31961

"return": {

31962

"description": "The date corresponding to the DOM element that the given node wraps.",

31963

"type": "Date"

31964

},

31965

"class": "CalendarBase",

31966

"module": "calendar",

31967

"submodule": "calendar-base"

31968

},

31969

{

31970

"file": "calendar/js/calendar-base.js",

31971

"line": 793,

31972

"description": "A placeholder method, called from bindUI, to bind the Calendar events.",

31973

"itemtype": "method",

31974

"name": "_bindCalendarEvents",

31975

"access": "protected",

31976

"tagname": "",

31977

"class": "CalendarBase",

31978

"module": "calendar",

31979

"submodule": "calendar-base"

31980

},

31981

{

31982

"file": "calendar/js/calendar-base.js",

31983

"line": 802,

31984

"description": "A utility method that normalizes a given date by converting it to the 1st\nday of the month the date is in, with the time set to noon.",

31985

"itemtype": "method",

31986

"name": "_normalizeDate",

31987

"params": [

31988

{

31989

"name": "oDate",

31990

"description": "The date to normalize",

31991

"type": "Date"

31992

}

31993

],

31994

"access": "protected",

31995

"tagname": "",

31996

"return": {

31997

"description": "The normalized date, set to the first of the month, with time\nset to noon.",

31998

"type": "Date"

31999

},

32000

"class": "CalendarBase",

32001

"module": "calendar",

32002

"submodule": "calendar-base"

32003

},

32004

{

32005

"file": "calendar/js/calendar-base.js",

32006

"line": 821,

32007

"description": "A render assist utility method that computes the cutoff column for the calendar \nrendering mask.",

32008

"itemtype": "method",

32009

"name": "_getCutoffColumn",

32010

"params": [

32011

{

32012

"name": "date",

32013

"description": "The date of the month grid to compute the cutoff column for.",

32014

"type": "Date"

32015

},

32016

{

32017

"name": "firstday",

32018

"description": "The first day of the week (modified by internationalized calendars)",

32019

"type": "Number"

32020

}

32021

],

32022

"access": "private",

32023

"tagname": "",

32024

"return": {

32025

"description": "The number of the cutoff column.",

32026

"type": "Number"

32027

},

32028

"class": "CalendarBase",

32029

"module": "calendar",

32030

"submodule": "calendar-base"

32031

},

32032

{

32033

"file": "calendar/js/calendar-base.js",

32034

"line": 838,

32035

"description": "A render assist method that turns on the view of the previous month's dates \nin a given calendar pane.",

32036

"itemtype": "method",

32037

"name": "_turnPrevMonthOn",

32038

"params": [

32039

{

32040

"name": "pane",

32041

"description": "The calendar pane that needs its previous month's dates view\nmodified.",

32042

"type": "Node"

32043

}

32044

],

32045

"access": "protected",

32046

"tagname": "",

32047

"class": "CalendarBase",

32048

"module": "calendar",

32049

"submodule": "calendar-base"

32050

},

32051

{

32052

"file": "calendar/js/calendar-base.js",

32053

"line": 870,

32054

"description": "A render assist method that turns off the view of the previous month's dates \nin a given calendar pane.",

32055

"itemtype": "method",

32056

"name": "_turnPrevMonthOff",

32057

"params": [

32058

{

32059

"name": "pane",

32060

"description": "The calendar pane that needs its previous month's dates view\nmodified.",

32061

"type": "Node"

32062

}

32063

],

32064

"access": "protected",

32065

"tagname": "",

32066

"class": "CalendarBase",

32067

"module": "calendar",

32068

"submodule": "calendar-base"

32069

},

32070

{

32071

"file": "calendar/js/calendar-base.js",

32072

"line": 888,

32073

"description": "A render assist method that cleans up the last few cells in the month grid\nwhen the number of days in the month changes.",

32074

"itemtype": "method",

32075

"name": "_cleanUpNextMonthCells",

32076

"params": [

32077

{

32078

"name": "pane",

32079

"description": "The calendar pane that needs the last date cells cleaned up.",

32080

"type": "Node"

32081

}

32082

],

32083

"access": "private",

32084

"tagname": "",

32085

"class": "CalendarBase",

32086

"module": "calendar",

32087

"submodule": "calendar-base"

32088

},

32089

{

32090

"file": "calendar/js/calendar-base.js",

32091

"line": 904,

32092

"description": "A render assist method that turns on the view of the next month's dates \nin a given calendar pane.",

32093

"itemtype": "method",

32094

"name": "_turnNextMonthOn",

32095

"params": [

32096

{

32097

"name": "pane",

32098

"description": "The calendar pane that needs its next month's dates view\nmodified.",

32099

"type": "Node"

32100

}

32101

],

32102

"access": "protected",

32103

"tagname": "",

32104

"class": "CalendarBase",

32105

"module": "calendar",

32106

"submodule": "calendar-base"

32107

},

32108

{

32109

"file": "calendar/js/calendar-base.js",

32110

"line": 936,

32111

"description": "A render assist method that turns off the view of the next month's dates \nin a given calendar pane.",

32112

"itemtype": "method",

32113

"name": "_turnNextMonthOff",

32114

"params": [

32115

{

32116

"name": "pane",

32117

"description": "The calendar pane that needs its next month's dates view\nmodified.",

32118

"type": "Node"

32119

}

32120

],

32121

"access": "protected",

32122

"tagname": "",

32123

"class": "CalendarBase",

32124

"module": "calendar",

32125

"submodule": "calendar-base"

32126

},

32127

{

32128

"file": "calendar/js/calendar-base.js",

32129

"line": 967,

32130

"description": "The handler for the change in the showNextMonth attribute.",

32131

"itemtype": "method",

32132

"name": "_afterShowNextMonthChange",

32133

"access": "private",

32134

"tagname": "",

32135

"class": "CalendarBase",

32136

"module": "calendar",

32137

"submodule": "calendar-base"

32138

},

32139

{

32140

"file": "calendar/js/calendar-base.js",

32141

"line": 989,

32142

"description": "The handler for the change in the showPrevMonth attribute.",

32143

"itemtype": "method",

32144

"name": "_afterShowPrevMonthChange",

32145

"access": "private",

32146

"tagname": "",

32147

"class": "CalendarBase",

32148

"module": "calendar",

32149

"submodule": "calendar-base"

32150

},

32151

{

32152

"file": "calendar/js/calendar-base.js",

32153

"line": 1008,

32154

"description": "The handler for the change in the headerRenderer attribute.",

32155

"itemtype": "method",

32156

"name": "_afterHeaderRendererChange",

32157

"access": "private",

32158

"tagname": "",

32159

"class": "CalendarBase",

32160

"module": "calendar",

32161

"submodule": "calendar-base"

32162

},

32163

{

32164

"file": "calendar/js/calendar-base.js",

32165

"line": 1018,

32166

"description": "The handler for the change in the customRenderer attribute.",

32167

"itemtype": "method",

32168

"name": "_afterCustomRendererChange",

32169

"access": "private",

32170

"tagname": "",

32171

"class": "CalendarBase",

32172

"module": "calendar",

32173

"submodule": "calendar-base"

32174

},

32175

{

32176

"file": "calendar/js/calendar-base.js",

32177

"line": 1028,

32178

"description": "The handler for the change in the date attribute. Modifies the calendar\nview by shifting the calendar grid mask and running custom rendering and\nselection rendering as necessary.",

32179

"itemtype": "method",

32180

"name": "_afterDateChange",

32181

"access": "private",

32182

"tagname": "",

32183

"class": "CalendarBase",

32184

"module": "calendar",

32185

"submodule": "calendar-base"

32186

},

32187

{

32188

"file": "calendar/js/calendar-base.js",

32189

"line": 1063,

32190

"description": "A rendering assist method that initializes the HTML for a single\ncalendar pane.",

32191

"itemtype": "method",

32192

"name": "_initCalendarPane",

32193

"params": [

32194

{

32195

"name": "baseDate",

32196

"description": "The date corresponding to the month of the given\ncalendar pane.",

32197

"type": "Date"

32198

},

32199

{

32200

"name": "pane_id",

32201

"description": "The id of the pane, to be used as a prefix for\nelement ids in the given pane.",

32202

"type": "String"

32203

}

32204

],

32205

"access": "private",

32206

"tagname": "",

32207

"class": "CalendarBase",

32208

"module": "calendar",

32209

"submodule": "calendar-base"

32210

},

32211

{

32212

"file": "calendar/js/calendar-base.js",

32213

"line": 1171,

32214

"description": "A rendering assist method that rerenders a specified calendar pane, based\non a new Date.",

32215

"itemtype": "method",

32216

"name": "_rerenderCalendarPane",

32217

"params": [

32218

{

32219

"name": "newDate",

32220

"description": "The date corresponding to the month of the given\ncalendar pane.",

32221

"type": "Date"

32222

},

32223

{

32224

"name": "pane",

32225

"description": "The node corresponding to the calendar pane to be rerenders.",

32226

"type": "Node"

32227

}

32228

],

32229

"access": "private",

32230

"tagname": "",

32231

"class": "CalendarBase",

32232

"module": "calendar",

32233

"submodule": "calendar-base"

32234

},

32235

{

32236

"file": "calendar/js/calendar-base.js",

32237

"line": 1275,

32238

"description": "A rendering assist method that updates the calendar header based\non a given date and potentially the provided headerRenderer.",

32239

"itemtype": "method",

32240

"name": "_updateCalendarHeader",

32241

"params": [

32242

{

32243

"name": "baseDate",

32244

"description": "The date with which to update the calendar header.",

32245

"type": "Date"

32246

}

32247

],

32248

"access": "private",

32249

"tagname": "",

32250

"class": "CalendarBase",

32251

"module": "calendar",

32252

"submodule": "calendar-base"

32253

},

32254

{

32255

"file": "calendar/js/calendar-base.js",

32256

"line": 1296,

32257

"description": "A rendering assist method that initializes the calendar header HTML \nbased on a given date and potentially the provided headerRenderer.",

32258

"itemtype": "method",

32259

"name": "_updateCalendarHeader",

32260

"params": [

32261

{

32262

"name": "baseDate",

32263

"description": "The date with which to initialize the calendar header.",

32264

"type": "Date"

32265

}

32266

],

32267

"access": "private",

32268

"tagname": "",

32269

"class": "CalendarBase",

32270

"module": "calendar",

32271

"submodule": "calendar-base"

32272

},

32273

{

32274

"file": "calendar/js/calendar-base.js",

32275

"line": 1310,

32276

"description": "A rendering assist method that initializes the calendar HTML \nbased on a given date.",

32277

"itemtype": "method",

32278

"name": "_initCalendarHTML",

32279

"params": [

32280

{

32281

"name": "baseDate",

32282

"description": "The date with which to initialize the calendar.",

32283

"type": "Date"

32284

}

32285

],

32286

"access": "private",

32287

"tagname": "",

32288

"class": "CalendarBase",

32289

"module": "calendar",

32290

"submodule": "calendar-base"

32291

},

32292

{

32293

"file": "calendar/js/calendar-base.js",

32294

"line": 1346,

32295

"description": "The CSS classnames for the calendar templates.",

32296

"itemtype": "property",

32297

"name": "CALENDAR_STRINGS",

32298

"type": "Object",

32299

"readonly": "",

32300

"access": "protected",

32301

"tagname": "",

32302

"static": 1,

32303

"class": "CalendarBase",

32304

"module": "calendar",

32305

"submodule": "calendar-base"

32306

},

32307

{

32308

"file": "calendar/js/calendar-base.js",

32309

"line": 1390,

32310

"description": "The main content template for calendar.",

32311

"itemtype": "property",

32312

"name": "CONTENT_TEMPLATE",

32313

"type": "String",

32314

"access": "protected",

32315

"tagname": "",

32316

"static": 1,

32317

"class": "CalendarBase",

32318

"module": "calendar",

32319

"submodule": "calendar-base"

32320

},

32321

{

32322

"file": "calendar/js/calendar-base.js",

32323

"line": 1404,

32324

"description": "A single pane template for calendar (same as default CONTENT_TEMPLATE)",

32325

"itemtype": "property",

32326

"name": "ONE_PANE_TEMPLATE",

32327

"type": "String",

32328

"access": "protected",

32329

"tagname": "",

32330

"readonly": "",

32331

"static": 1,

32332

"class": "CalendarBase",

32333

"module": "calendar",

32334

"submodule": "calendar-base"

32335

},

32336

{

32337

"file": "calendar/js/calendar-base.js",

32338

"line": 1419,

32339

"description": "A two pane template for calendar.",

32340

"itemtype": "property",

32341

"name": "TWO_PANE_TEMPLATE",

32342

"type": "String",

32343

"access": "protected",

32344

"tagname": "",

32345

"readonly": "",

32346

"static": 1,

32347

"class": "CalendarBase",

32348

"module": "calendar",

32349

"submodule": "calendar-base"

32350

},

32351

{

32352

"file": "calendar/js/calendar-base.js",

32353

"line": 1440,

32354

"description": "A three pane template for calendar.",

32355

"itemtype": "property",

32356

"name": "THREE_PANE_TEMPLATE",

32357

"type": "String",

32358

"access": "protected",

32359

"tagname": "",

32360

"readonly": "",

32361

"static": 1,

32362

"class": "CalendarBase",

32363

"module": "calendar",

32364

"submodule": "calendar-base"

32365

},

32366

{

32367

"file": "calendar/js/calendar-base.js",

32368

"line": 1464,

32369

"description": "A template for the calendar grid.",

32370

"itemtype": "property",

32371

"name": "CALENDAR_GRID_TEMPLATE",

32372

"type": "String",

32373

"access": "protected",

32374

"tagname": "",

32375

"static": 1,

32376

"class": "CalendarBase",

32377

"module": "calendar",

32378

"submodule": "calendar-base"

32379

},

32380

{

32381

"file": "calendar/js/calendar-base.js",

32382

"line": 1480,

32383

"description": "A template for the calendar header.",

32384

"itemtype": "property",

32385

"name": "HEADER_TEMPLATE",

32386

"type": "String",

32387

"access": "protected",

32388

"tagname": "",

32389

"static": 1,

32390

"class": "CalendarBase",

32391

"module": "calendar",

32392

"submodule": "calendar-base"

32393

},

32394

{

32395

"file": "calendar/js/calendar-base.js",

32396

"line": 1493,

32397

"description": "A template for the row of weekday names.",

32398

"itemtype": "property",

32399

"name": "WEEKDAY_ROW_TEMPLATE",

32400

"type": "String",

32401

"access": "protected",

32402

"tagname": "",

32403

"static": 1,

32404

"class": "CalendarBase",

32405

"module": "calendar",

32406

"submodule": "calendar-base"

32407

},

32408

{

32409

"file": "calendar/js/calendar-base.js",

32410

"line": 1504,

32411

"description": "A template for a single row of calendar days.",

32412

"itemtype": "property",

32413

"name": "CALDAY_ROW_TEMPLATE",

32414

"type": "String",

32415

"access": "protected",

32416

"tagname": "",

32417

"static": 1,

32418

"class": "CalendarBase",

32419

"module": "calendar",

32420

"submodule": "calendar-base"

32421

},

32422

{

32423

"file": "calendar/js/calendar-base.js",

32424

"line": 1515,

32425

"description": "A template for a single cell with a weekday name.",

32426

"itemtype": "property",

32427

"name": "CALDAY_ROW_TEMPLATE",

32428

"type": "String",

32429

"access": "protected",

32430

"tagname": "",

32431

"static": 1,

32432

"class": "CalendarBase",

32433

"module": "calendar",

32434

"submodule": "calendar-base"

32435

},

32436

{

32437

"file": "calendar/js/calendar-base.js",

32438

"line": 1524,

32439

"description": "A template for a single cell with a calendar day.",

32440

"itemtype": "property",

32441

"name": "CALDAY_TEMPLATE",

32442

"type": "String",

32443

"access": "protected",

32444

"tagname": "",

32445

"static": 1,

32446

"class": "CalendarBase",

32447

"module": "calendar",

32448

"submodule": "calendar-base"

32449

},

32450

{

32451

"file": "calendar/js/calendar-base.js",

32452

"line": 1535,

32453

"description": "The identity of the widget.",

32454

"itemtype": "property",

32455

"name": "NAME",

32456

"type": "String",

32457

"default": "'calendarBase'",

32458

"readonly": "",

32459

"access": "protected",

32460

"tagname": "",

32461

"static": 1,

32462

"class": "CalendarBase",

32463

"module": "calendar",

32464

"submodule": "calendar-base"

32465

},

32466

{

32467

"file": "calendar/js/calendar-base.js",

32468

"line": 1547,

32469

"description": "Static property used to define the default attribute configuration of\nthe Widget.",

32470

"itemtype": "property",

32471

"name": "ATTRS",

32472

"type": "{Object}",

32473

"access": "protected",

32474

"tagname": "",

32475

"static": 1,

32476

"class": "CalendarBase",

32477

"module": "calendar",

32478

"submodule": "calendar-base"

32479

},

32480

{

32481

"file": "calendar/js/calendar-base.js",

32482

"line": 1560,

32483

"description": "The date corresponding to the current calendar view. Always\nnormalized to the first of the month that contains the date\nat assignment time. Used as the first date visible in the\ncalendar.",

32484

"itemtype": "attribute",

32485

"name": "date",

32486

"type": "Date",

32487

"default": "The first of the month containing today's date, as\nset on the end user's system.",

32488

"class": "CalendarBase",

32489

"module": "calendar",

32490

"submodule": "calendar-base"

32491

},

32492

{

32493

"file": "calendar/js/calendar-base.js",

32494

"line": 1584,

32495

"description": "A setting specifying whether to shows days from the previous\nmonth in the visible month's grid, if there are empty preceding\ncells available.",

32496

"itemtype": "attribute",

32497

"name": "showPrevMonth",

32498

"type": "boolean",

32499

"default": "false",

32500

"class": "CalendarBase",

32501

"module": "calendar",

32502

"submodule": "calendar-base"

32503

},

32504

{

32505

"file": "calendar/js/calendar-base.js",

32506

"line": 1597,

32507

"description": "A setting specifying whether to shows days from the next\nmonth in the visible month's grid, if there are empty\ncells available at the end.",

32508

"itemtype": "attribute",

32509

"name": "showNextMonth",

32510

"type": "boolean",

32511

"default": "false",

32512

"class": "CalendarBase",

32513

"module": "calendar",

32514

"submodule": "calendar-base"

32515

},

32516

{

32517

"file": "calendar/js/calendar-base.js",

32518

"line": 1610,

32519

"description": "Strings and properties derived from the internationalization packages\nfor the calendar.",

32520

"itemtype": "attribute",

32521

"name": "strings",

32522

"type": "Object",

32523

"access": "protected",

32524

"tagname": "",

32525

"class": "CalendarBase",

32526

"module": "calendar",

32527

"submodule": "calendar-base"

32528

},

32529

{

32530

"file": "calendar/js/calendar-base.js",

32531

"line": 1622,

32532

"description": "Custom header renderer for the calendar.",

32533

"itemtype": "attribute",

32534

"name": "headerRenderer",

32535

"type": "String | Function",

32536

"class": "CalendarBase",

32537

"module": "calendar",

32538

"submodule": "calendar-base"

32539

},

32540

{

32541

"file": "calendar/js/calendar-base.js",

32542

"line": 1632,

32543

"description": "The name of the rule which all enabled dates should match.\nEither disabledDatesRule or enabledDatesRule should be specified,\nor neither, but not both.",

32544

"itemtype": "attribute",

32545

"name": "enabledDatesRule",

32546

"type": "String",

32547

"default": "null",

32548

"class": "CalendarBase",

32549

"module": "calendar",

32550

"submodule": "calendar-base"

32551

},

32552

{

32553

"file": "calendar/js/calendar-base.js",

32554

"line": 1645,

32555

"description": "The name of the rule which all disabled dates should match.\nEither disabledDatesRule or enabledDatesRule should be specified,\nor neither, but not both.",

32556

"itemtype": "attribute",

32557

"name": "disabledDatesRule",

32558

"type": "String",

32559

"default": "null",

32560

"class": "CalendarBase",

32561

"module": "calendar",

32562

"submodule": "calendar-base"

32563

},

32564

{

32565

"file": "calendar/js/calendar-base.js",

32566

"line": 1658,

32567

"description": "A read-only attribute providing a list of currently selected dates.",

32568

"itemtype": "attribute",

32569

"name": "selectedDates",

32570

"readonly": "",

32571

"type": "Array",

32572

"class": "CalendarBase",

32573

"module": "calendar",

32574

"submodule": "calendar-base"

32575

},

32576

{

32577

"file": "calendar/js/calendar-base.js",

32578

"line": 1672,

32579

"description": "An object of the form {rules:Object, filterFunction:Function},\nproviding set of rules and a custom rendering function for \ncustomizing specific calendar cells.",

32580

"itemtype": "attribute",

32581

"name": "customRenderer",

32582

"readonly": "",

32583

"type": "Object",

32584

"default": "{}",

32585

"class": "CalendarBase",

32586

"module": "calendar",

32587

"submodule": "calendar-base"

32588

},

32589

{

32590

"file": "calendar/js/calendar.js",

32591

"line": 51,

32592

"description": "A property tracking the last selected date on the calendar, for the\npurposes of multiple selection.",

32593

"itemtype": "property",

32594

"name": "_lastSelectedDate",

32595

"type": "Date",

32596

"default": "null",

32597

"access": "private",

32598

"tagname": "",

32599

"class": "Calendar",

32600

"module": "calendar"

32601

},

32602

{

32603

"file": "calendar/js/calendar.js",

32604

"line": 62,

32605

"description": "Designated initializer. Activates the navigation plugin for the calendar.",

32606

"itemtype": "method",

32607

"name": "initializer",

32608

"class": "Calendar",

32609

"module": "calendar"

32610

},

32611

{

32612

"file": "calendar/js/calendar.js",

32613

"line": 76,

32614

"description": "syncUI implementation\n\nUpdate the scroll position, based on the current value of scrollY",

32615

"itemtype": "method",

32616

"name": "syncUI",

32617

"class": "Calendar",

32618

"module": "calendar"

32619

},

32620

{

32621

"file": "calendar/js/calendar.js",

32622

"line": 86,

32623

"description": "Overrides the _bindCalendarEvents placeholder in CalendarBase\nand binds calendar events during bindUI stage.",

32624

"itemtype": "method",

32625

"name": "_bindCalendarEvents",

32626

"access": "protected",

32627

"tagname": "",

32628

"class": "Calendar",

32629

"module": "calendar"

32630

},

32631

{

32632

"file": "calendar/js/calendar.js",

32633

"line": 103,

32634

"description": "Highlights a specific date node with keyboard highlight class",

32635

"itemtype": "method",

32636

"name": "_highlightDateNode",

32637

"params": [

32638

{

32639

"name": "oDate",

32640

"description": "Date corresponding the node to be highlighted",

32641

"type": "Date"

32642

}

32643

],

32644

"access": "protected",

32645

"tagname": "",

32646

"class": "Calendar",

32647

"module": "calendar"

32648

},

32649

{

32650

"file": "calendar/js/calendar.js",

32651

"line": 116,

32652

"description": "Unhighlights a specific date node currently highlighted with keyboard highlight class",

32653

"itemtype": "method",

32654

"name": "_unhighlightCurrentDateNode",

32655

"access": "protected",

32656

"tagname": "",

32657

"class": "Calendar",

32658

"module": "calendar"

32659

},

32660

{

32661

"file": "calendar/js/calendar.js",

32662

"line": 128,

32663

"description": "Returns the grid number for a specific calendar grid (for multi-grid templates)",

32664

"itemtype": "method",

32665

"name": "_getGridNumber",

32666

"params": [

32667

{

32668

"name": "gridNode",

32669

"description": "Node corresponding to a specific grid",

32670

"type": "Node"

32671

}

32672

],

32673

"access": "protected",

32674

"tagname": "",

32675

"class": "Calendar",

32676

"module": "calendar"

32677

},

32678

{

32679

"file": "calendar/js/calendar.js",

32680

"line": 139,

32681

"description": "Handler for loss of focus of calendar grid",

32682

"itemtype": "method",

32683

"name": "_blurCalendarGrid",

32684

"access": "protected",

32685

"tagname": "",

32686

"class": "Calendar",

32687

"module": "calendar"

32688

},

32689

{

32690

"file": "calendar/js/calendar.js",

32691

"line": 149,

32692

"description": "Handler for gain of focus of calendar cell",

32693

"itemtype": "method",

32694

"name": "_focusCalendarCell",

32695

"access": "protected",

32696

"tagname": "",

32697

"class": "Calendar",

32698

"module": "calendar"

32699

},

32700

{

32701

"file": "calendar/js/calendar.js",

32702

"line": 159,

32703

"description": "Handler for gain of focus of calendar grid",

32704

"itemtype": "method",

32705

"name": "_focusCalendarGrid",

32706

"access": "protected",

32707

"tagname": "",

32708

"class": "Calendar",

32709

"module": "calendar"

32710

},

32711

{

32712

"file": "calendar/js/calendar.js",

32713

"line": 169,

32714

"description": "Handler for keyboard press on a calendar grid",

32715

"itemtype": "method",

32716

"name": "_keydownCalendar",

32717

"access": "protected",

32718

"tagname": "",

32719

"class": "Calendar",

32720

"module": "calendar"

32721

},

32722

{

32723

"file": "calendar/js/calendar.js",

32724

"line": 262,

32725

"description": "Handles the calendar clicks based on selection mode.",

32726

"itemtype": "method",

32727

"name": "_clickCalendar",

32728

"params": [

32729

{

32730

"name": "ev",

32731

"description": "A click event",

32732

"type": "Event"

32733

}

32734

],

32735

"access": "private",

32736

"tagname": "",

32737

"class": "Calendar",

32738

"module": "calendar"

32739

},

32740

{

32741

"file": "calendar/js/calendar.js",

32742

"line": 338,

32743

"description": "Fired when a specific date cell in the calendar is clicked. The event carries a \npayload which includes a `cell` property corresponding to the node of the actual\ndate cell, and a `date` property, with the `Date` that was clicked.",

32744

"itemtype": "event",

32745

"name": "dateClick",

32746

"class": "Calendar",

32747

"module": "calendar"

32748

},

32749

{

32750

"file": "calendar/js/calendar.js",

32751

"line": 348,

32752

"description": "Fired when any of the previous month's days displayed before the calendar grid\nare clicked.",

32753

"itemtype": "event",

32754

"name": "prevMonthClick",

32755

"class": "Calendar",

32756

"module": "calendar"

32757

},

32758

{

32759

"file": "calendar/js/calendar.js",

32760

"line": 357,

32761

"description": "Fired when any of the next month's days displayed after the calendar grid\nare clicked.",

32762

"itemtype": "event",

32763

"name": "nextMonthClick",

32764

"class": "Calendar",

32765

"module": "calendar"

32766

},

32767

{

32768

"file": "calendar/js/calendar.js",

32769

"line": 367,

32770

"description": "Subtracts one month from the current calendar view.",

32771

"itemtype": "method",

32772

"name": "subtractMonth",

32773

"class": "Calendar",

32774

"module": "calendar"

32775

},

32776

{

32777

"file": "calendar/js/calendar.js",

32778

"line": 376,

32779

"description": "Subtracts one year from the current calendar view.",

32780

"itemtype": "method",

32781

"name": "subtractYear",

32782

"class": "Calendar",

32783

"module": "calendar"

32784

},

32785

{

32786

"file": "calendar/js/calendar.js",

32787

"line": 385,

32788

"description": "Adds one month to the current calendar view.",

32789

"itemtype": "method",

32790

"name": "addMonth",

32791

"class": "Calendar",

32792

"module": "calendar"

32793

},

32794

{

32795

"file": "calendar/js/calendar.js",

32796

"line": 394,

32797

"description": "Adds one year to the current calendar view.",

32798

"itemtype": "method",

32799

"name": "addYear",

32800

"class": "Calendar",

32801

"module": "calendar"

32802

},

32803

{

32804

"file": "calendar/js/calendar.js",

32805

"line": 405,

32806

"description": "The identity of the widget.",

32807

"itemtype": "property",

32808

"name": "NAME",

32809

"type": "String",

32810

"default": "'calendar'",

32811

"readonly": "",

32812

"access": "protected",

32813

"tagname": "",

32814

"static": 1,

32815

"class": "Calendar",

32816

"module": "calendar"

32817

},

32818

{

32819

"file": "calendar/js/calendar.js",

32820

"line": 417,

32821

"description": "Static property used to define the default attribute configuration of\nthe Widget.",

32822

"itemtype": "property",

32823

"name": "ATTRS",

32824

"type": "{Object}",

32825

"access": "protected",

32826

"tagname": "",

32827

"static": 1,

32828

"class": "Calendar",

32829

"module": "calendar"

32830

},

32831

{

32832

"file": "calendar/js/calendar.js",

32833

"line": 428,

32834

"description": "A setting specifying the type of selection the calendar allows.\nPossible values include:\n<ul>\n <li>`single` - One date at a time</li>\n <li>`multiple-sticky` - Multiple dates, selected one at a time (the dates \"stick\"). This option\n is appropriate for mobile devices, where function keys from the keyboard are not available.</li>\n <li>`multiple` - Multiple dates, selected with Ctrl/Meta keys for additional single\n dates, and Shift key for date ranges.</li>",

32835

"itemtype": "attribute",

32836

"name": "selectionMode",

32837

"type": "String",

32838

"default": "single",

32839

"class": "Calendar",

32840

"module": "calendar"

32841

},

32842

{

32843

"file": "calendar/js/calendar.js",

32844

"line": 446,

32845

"description": "The date corresponding to the current calendar view. Always\nnormalized to the first of the month that contains the date\nat assignment time. Used as the first date visible in the\ncalendar.",

32846

"itemtype": "attribute",

32847

"name": "date",

32848

"type": "Date",

32849

"default": "Today's date as set on the user's computer.",

32850

"class": "Calendar",

32851

"module": "calendar"

32852

},

32853

{

32854

"file": "calendar/js/calendar.js",

32855

"line": 481,

32856

"description": "The minimum date that can be displayed by the calendar. The calendar will not\nallow dates earlier than this one to be set, and will reset any earlier date to\nthis date. Should be `null` if no minimum date is needed.",

32857

"itemtype": "attribute",

32858

"name": "minimumDate",

32859

"type": "Date",

32860

"default": "null",

32861

"class": "Calendar",

32862

"module": "calendar"

32863

},

32864

{

32865

"file": "calendar/js/calendar.js",

32866

"line": 507,

32867

"description": "The maximum date that can be displayed by the calendar. The calendar will not\nallow dates later than this one to be set, and will reset any later date to\nthis date. Should be `null` if no maximum date is needed.",

32868

"itemtype": "attribute",

32869

"name": "maximumDate",

32870

"type": "Date",

32871

"default": "null",

32872

"class": "Calendar",

32873

"module": "calendar"

32874

},

32875

{

32876

"file": "calendar/js/calendarnavigator.js",

32877

"line": 31,

32878

"description": "The namespace for the plugin. This will be the property on the widget, which will \nreference the plugin instance, when it's plugged in.",

32879

"itemtype": "property",

32880

"name": "NS",

32881

"static": 1,

32882

"type": "String",

32883

"default": "\"navigator\"",

32884

"class": "Plugin.CalendarNavigator",

32885

"module": "calendarnavigator",

32886

"namespace": "Plugin"

32887

},

32888

{

32889

"file": "calendar/js/calendarnavigator.js",

32890

"line": 42,

32891

"description": "The NAME of the CalendarNavigator class. Used to prefix events generated\nby the plugin class.",

32892

"itemtype": "property",

32893

"name": "NAME",

32894

"static": 1,

32895

"type": "String",

32896

"default": "\"pluginCalendarNavigator\"",

32897

"class": "Plugin.CalendarNavigator",

32898

"module": "calendarnavigator",

32899

"namespace": "Plugin"

32900

},

32901

{

32902

"file": "calendar/js/calendarnavigator.js",

32903

"line": 54,

32904

"description": "Static property used to define the default attribute \nconfiguration for the plugin.",

32905

"itemtype": "property",

32906

"name": "ATTRS",

32907

"type": "Object",

32908

"static": 1,

32909

"class": "Plugin.CalendarNavigator",

32910

"module": "calendarnavigator",

32911

"namespace": "Plugin"

32912

},

32913

{

32914

"file": "calendar/js/calendarnavigator.js",

32915

"line": 64,

32916

"description": "The number of months to shift by when the control arrows are clicked.",

32917

"itemtype": "attribute",

32918

"name": "shiftByMonths",

32919

"type": "Number",

32920

"default": "1 (months)",

32921

"class": "Plugin.CalendarNavigator",

32922

"module": "calendarnavigator",

32923

"namespace": "Plugin"

32924

},

32925

{

32926

"file": "calendar/js/calendarnavigator.js",

32927

"line": 76,

32928

"description": "The CSS classnames for the calendar navigator controls.",

32929

"itemtype": "property",

32930

"name": "CALENDARNAV_STRINGS",

32931

"type": "Object",

32932

"readonly": "",

32933

"access": "protected",

32934

"tagname": "",

32935

"static": 1,

32936

"class": "Plugin.CalendarNavigator",

32937

"module": "calendarnavigator",

32938

"namespace": "Plugin"

32939

},

32940

{

32941

"file": "calendar/js/calendarnavigator.js",

32942

"line": 89,

32943

"description": "The template for the calendar navigator previous month control.",

32944

"itemtype": "property",

32945

"name": "PREV_MONTH_CONTROL_TEMPLATE",

32946

"type": "String",

32947

"access": "protected",

32948

"tagname": "",

32949

"static": 1,

32950

"class": "Plugin.CalendarNavigator",

32951

"module": "calendarnavigator",

32952

"namespace": "Plugin"

32953

},

32954

{

32955

"file": "calendar/js/calendarnavigator.js",

32956

"line": 99,

32957

"description": "The template for the calendar navigator next month control.",

32958

"itemtype": "property",

32959

"name": "NEXT_MONTH_CONTROL_TEMPLATE",

32960

"type": "String",

32961

"readonly": "",

32962

"access": "protected",

32963

"tagname": "",

32964

"static": 1,

32965

"class": "Plugin.CalendarNavigator",

32966

"module": "calendarnavigator",

32967

"namespace": "Plugin"

32968

},

32969

{

32970

"file": "calendar/js/calendarnavigator.js",

32971

"line": 117,

32972

"description": "The initializer lifecycle implementation. Modifies the host widget's \nrender to add navigation controls.",

32973

"itemtype": "method",

32974

"name": "initializer",

32975

"params": [

32976

{

32977

"name": "config",

32978

"description": "The user configuration for the plugin",

32979

"type": "Object"

32980

}

32981

],

32982

"class": "Plugin.CalendarNavigator",

32983

"module": "calendarnavigator",

32984

"namespace": "Plugin"

32985

},

32986

{

32987

"file": "calendar/js/calendarnavigator.js",

32988

"line": 133,

32989

"description": "The initializer destructor implementation. Responsible for destroying the initialized\ncontrol mechanisms.",

32990

"itemtype": "method",

32991

"name": "destructor",

32992

"class": "Plugin.CalendarNavigator",

32993

"module": "calendarnavigator",

32994

"namespace": "Plugin"

32995

},

32996

{

32997

"file": "calendar/js/calendarnavigator.js",

32998

"line": 143,

32999

"description": "Private utility method that subtracts months from the host calendar date\nbased on the control click and the shiftByMonths property.",

33000

"itemtype": "method",

33001

"name": "_subtractMonths",

33002

"params": [

33003

{

33004

"name": "ev",

33005

"description": "Click event from the controls",

33006

"type": "Event"

33007

}

33008

],

33009

"access": "protected",

33010

"tagname": "",

33011

"class": "Plugin.CalendarNavigator",

33012

"module": "calendarnavigator",

33013

"namespace": "Plugin"

33014

},

33015

{

33016

"file": "calendar/js/calendarnavigator.js",

33017

"line": 160,

33018

"description": "Private utility method that adds months to the host calendar date\nbased on the control click and the shiftByMonths property.",

33019

"itemtype": "method",

33020

"name": "_addMonths",

33021

"params": [

33022

{

33023

"name": "ev",

33024

"description": "Click event from the controls",

33025

"type": "Event"

33026

}

33027

],

33028

"access": "protected",

33029

"tagname": "",

33030

"class": "Plugin.CalendarNavigator",

33031

"module": "calendarnavigator",

33032

"namespace": "Plugin"

33033

},

33034

{

33035

"file": "calendar/js/calendarnavigator.js",

33036

"line": 220,

33037

"description": "Private render assist method that renders the previous month control",

33038

"itemtype": "method",

33039

"name": "_renderPrevControls",

33040

"access": "private",

33041

"tagname": "",

33042

"class": "Plugin.CalendarNavigator",

33043

"module": "calendarnavigator",

33044

"namespace": "Plugin"

33045

},

33046

{

33047

"file": "calendar/js/calendarnavigator.js",

33048

"line": 234,

33049

"description": "Private render assist method that renders the next month control",

33050

"itemtype": "method",

33051

"name": "_renderNextControls",

33052

"access": "private",

33053

"tagname": "",

33054

"class": "Plugin.CalendarNavigator",

33055

"module": "calendarnavigator",

33056

"namespace": "Plugin"

33057

},

33058

{

33059

"file": "calendar/js/calendarnavigator.js",

33060

"line": 248,

33061

"description": "Protected render assist method that initialized and renders the navigation controls.",

33062

"itemtype": "method",

33063

"name": "_initNavigationControls",

33064

"access": "protected",

33065

"tagname": "",

33066

"class": "Plugin.CalendarNavigator",

33067

"module": "calendarnavigator",

33068

"namespace": "Plugin"

33069

},

33070

{

33071

"file": "charts/js/AreaSeries.js",

33072

"line": 12,

33073

"access": "protected",

33074

"tagname": "Renders the series.",

33075

"itemtype": "method",

33076

"name": "drawSeries",

33077

"class": "AreaSeries",

33078

"module": "charts"

33079

},

33080

{

33081

"file": "charts/js/AreaSeries.js",

33082

"line": 24,

33083

"access": "protected",

33084

"tagname": "Method used by `styles` setter. Overrides base implementation.",

33085

"itemtype": "method",

33086

"name": "_setStyles",

33087

"params": [

33088

{

33089

"name": "newStyles",

33090

"description": "Hash of properties to update.",

33091

"type": "Object"

33092

}

33093

],

33094

"return": {

33095

"description": "Object"

33096

},

33097

"class": "AreaSeries",

33098

"module": "charts"

33099

},

33100

{

33101

"file": "charts/js/AreaSeries.js",

33102

"line": 42,

33103

"access": "protected",

33104

"tagname": "Gets the default value for the `styles` attribute. Overrides\nbase implementation.",

33105

"itemtype": "method",

33106

"name": "_getDefaultStyles",

33107

"return": {

33108

"description": "Object"

33109

},

33110

"class": "AreaSeries",

33111

"module": "charts"

33112

},

33113

{

33114

"file": "charts/js/AreaSeries.js",

33115

"line": 59,

33116

"description": "Read-only attribute indicating the type of series.",

33117

"itemtype": "attribute",

33118

"name": "type",

33119

"type": "String",

33120

"default": "area",

33121

"class": "AreaSeries",

33122

"module": "charts"

33123

},

33124

{

33125

"file": "charts/js/AreaSeries.js",

33126

"line": 70,

33127

"description": "Style properties used for drawing area fills. This attribute is inherited from `Renderer`. Below are the default values:\n\n <dl>\n <dt>color</dt><dd>The color of the fill. The default value is determined by the order of the series on the graph. The color will be \n retrieved from the following array:\n `[\"#66007f\", \"#a86f41\", \"#295454\", \"#996ab2\", \"#e8cdb7\", \"#90bdbd\",\"#000000\",\"#c3b8ca\", \"#968373\", \"#678585\"]`\n </dd>\n <dt>alpha</dt><dd>Number between 0 and 1 that indicates the opacity of the fill. The default value is 1</dd>\n </dl>",

33128

"itemtype": "attribute",

33129

"name": "styles",

33130

"type": "Object",

33131

"class": "AreaSeries",

33132

"module": "charts"

33133

},

33134

{

33135

"file": "charts/js/AreaSplineSeries.js",

33136

"line": 12,

33137

"access": "protected",

33138

"tagname": "Draws the series.",

33139

"itemtype": "method",

33140

"name": "drawSeries",

33141

"class": "AreaSplineSeries",

33142

"module": "charts"

33143

},

33144

{

33145

"file": "charts/js/AreaSplineSeries.js",

33146

"line": 25,

33147

"description": "Read-only attribute indicating the type of series.",

33148

"itemtype": "attribute",

33149

"name": "type",

33150

"type": "String",

33151

"default": "areaSpline",

33152

"class": "AreaSplineSeries",

33153

"module": "charts"

33154

},

33155

{

33156

"file": "charts/js/AreaSplineSeries.js",

33157

"line": 36,

33158

"description": "Style properties used for drawing area fills. This attribute is inherited from `Renderer`. Below are the default values:\n\n <dl>\n <dt>color</dt><dd>The color of the fill. The default value is determined by the order of the series on the graph. The color will be \n retrieved from the following array:\n `[\"#66007f\", \"#a86f41\", \"#295454\", \"#996ab2\", \"#e8cdb7\", \"#90bdbd\",\"#000000\",\"#c3b8ca\", \"#968373\", \"#678585\"]`\n </dd>\n <dt>alpha</dt><dd>Number between 0 and 1 that indicates the opacity of the fill. The default value is 1</dd>\n </dl>",

33159

"itemtype": "attribute",

33160

"name": "styles",

33161

"type": "Object",

33162

"class": "AreaSplineSeries",

33163

"module": "charts"

33164

},

33165

{

33166

"file": "charts/js/Axis.js",

33167

"line": 12,

33168

"description": "Storage for calculatedWidth value.",

33169

"itemtype": "property",

33170

"name": "_calculatedWidth",

33171

"type": "Number",

33172

"access": "private",

33173

"tagname": "",

33174

"class": "Axis",

33175

"module": "charts"

33176

},

33177

{

33178

"file": "charts/js/Axis.js",

33179

"line": 21,

33180

"description": "Storage for calculatedHeight value.",

33181

"itemtype": "property",

33182

"name": "_calculatedHeight",

33183

"type": "Number",

33184

"access": "private",

33185

"tagname": "",

33186

"class": "Axis",

33187

"module": "charts"

33188

},

33189

{

33190

"file": "charts/js/Axis.js",

33191

"line": 30,

33192

"description": "Handles change to the dataProvider",

33193

"itemtype": "method",

33194

"name": "_dataChangeHandler",

33195

"params": [

33196

{

33197

"name": "e",

33198

"description": "Event object",

33199

"type": "Object"

33200

}

33201

],

33202

"access": "private",

33203

"tagname": "",

33204

"class": "Axis",

33205

"module": "charts"

33206

},

33207

{

33208

"file": "charts/js/Axis.js",

33209

"line": 45,

33210

"description": "Handles change to the position attribute",

33211

"itemtype": "method",

33212

"name": "_positionChangeHandler",

33213

"params": [

33214

{

33215

"name": "e",

33216

"description": "Event object",

33217

"type": "Object"

33218

}

33219

],

33220

"access": "private",

33221

"tagname": "",

33222

"class": "Axis",

33223

"module": "charts"

33224

},

33225

{

33226

"file": "charts/js/Axis.js",

33227

"line": 58,

33228

"description": "Updates the the Graphic instance",

33229

"itemtype": "method",

33230

"name": "_updateGraphic",

33231

"params": [

33232

{

33233

"name": "position",

33234

"description": "Position of axis",

33235

"type": "String"

33236

}

33237

],

33238

"access": "private",

33239

"tagname": "",

33240

"class": "Axis",

33241

"module": "charts"

33242

},

33243

{

33244

"file": "charts/js/Axis.js",

33245

"line": 84,

33246

"description": "Handles changes to axis.",

33247

"itemtype": "method",

33248

"name": "_updateHandler",

33249

"params": [

33250

{

33251

"name": "e",

33252

"description": "Event object",

33253

"type": "Object"

33254

}

33255

],

33256

"access": "private",

33257

"tagname": "",

33258

"class": "Axis",

33259

"module": "charts"

33260

},

33261

{

33262

"file": "charts/js/Axis.js",

33263

"line": 99,

33264

"itemtype": "method",

33265

"name": "renderUI",

33266

"access": "private",

33267

"tagname": "",

33268

"class": "Axis",

33269

"module": "charts"

33270

},

33271

{

33272

"file": "charts/js/Axis.js",

33273

"line": 108,

33274

"itemtype": "method",

33275

"name": "syncUI",

33276

"access": "private",

33277

"tagname": "",

33278

"class": "Axis",

33279

"module": "charts"

33280

},

33281

{

33282

"file": "charts/js/Axis.js",

33283

"line": 139,

33284

"description": "Creates a graphic instance to be used for the axis line and ticks.",

33285

"itemtype": "method",

33286

"name": "_setCanvas",

33287

"access": "private",

33288

"tagname": "",

33289

"class": "Axis",

33290

"module": "charts"

33291

},

33292

{

33293

"file": "charts/js/Axis.js",

33294

"line": 172,

33295

"description": "Gets the default value for the `styles` attribute. Overrides\nbase implementation.",

33296

"itemtype": "method",

33297

"name": "_getDefaultStyles",

33298

"return": {

33299

"description": "Object"

33300

},

33301

"access": "protected",

33302

"tagname": "",

33303

"class": "Axis",

33304

"module": "charts"

33305

},

33306

{

33307

"file": "charts/js/Axis.js",

33308

"line": 240,

33309

"description": "Updates the axis when the size changes.",

33310

"itemtype": "method",

33311

"name": "_handleSizeChange",

33312

"params": [

33313

{

33314

"name": "e",

33315

"description": "Event object.",

33316

"type": "Object"

33317

}

33318

],

33319

"access": "private",

33320

"tagname": "",

33321

"class": "Axis",

33322

"module": "charts"

33323

},

33324

{

33325

"file": "charts/js/Axis.js",

33326

"line": 262,

33327

"description": "Maps key values to classes containing layout algorithms",

33328

"itemtype": "property",

33329

"name": "_layoutClasses",

33330

"type": "Object",

33331

"access": "private",

33332

"tagname": "",

33333

"class": "Axis",

33334

"module": "charts"

33335

},

33336

{

33337

"file": "charts/js/Axis.js",

33338

"line": 277,

33339

"description": "Draws a line segment between 2 points",

33340

"itemtype": "method",

33341

"name": "drawLine",

33342

"params": [

33343

{

33344

"name": "startPoint",

33345

"description": "x and y coordinates for the start point of the line segment",

33346

"type": "Object"

33347

},

33348

{

33349

"name": "endPoint",

33350

"description": "x and y coordinates for the for the end point of the line segment",

33351

"type": "Object"

33352

},

33353

{

33354

"name": "line",

33355

"description": "styles (weight, color and alpha to be applied to the line segment)",

33356

"type": "Object"

33357

}

33358

],

33359

"access": "private",

33360

"tagname": "",

33361

"class": "Axis",

33362

"module": "charts"

33363

},

33364

{

33365

"file": "charts/js/Axis.js",

33366

"line": 292,

33367

"description": "Generates the properties necessary for rotating and positioning a text field.",

33368

"itemtype": "method",

33369

"name": "_getTextRotationProps",

33370

"params": [

33371

{

33372

"name": "styles",

33373

"description": "properties for the text field",

33374

"type": "Object"

33375

}

33376

],

33377

"return": {

33378

"description": "Object"

33379

},

33380

"access": "private",

33381

"tagname": "",

33382

"class": "Axis",

33383

"module": "charts"

33384

},

33385

{

33386

"file": "charts/js/Axis.js",

33387

"line": 332,

33388

"description": "Draws an axis.",

33389

"itemtype": "method",

33390

"name": "_drawAxis",

33391

"access": "private",

33392

"tagname": "",

33393

"class": "Axis",

33394

"module": "charts"

33395

},

33396

{

33397

"file": "charts/js/Axis.js",

33398

"line": 465,

33399

"description": "Calculates and sets the total size of a title.",

33400

"itemtype": "method",

33401

"name": "_setTotalTitleSize",

33402

"params": [

33403

{

33404

"name": "styles",

33405

"description": "Properties for the title field.",

33406

"type": "Object"

33407

}

33408

],

33409

"access": "private",

33410

"tagname": "",

33411

"class": "Axis",

33412

"module": "charts"

33413

},

33414

{

33415

"file": "charts/js/Axis.js",

33416

"line": 505,

33417

"description": "Updates path.",

33418

"itemtype": "method",

33419

"name": "_updatePathElement",

33420

"access": "private",

33421

"tagname": "",

33422

"class": "Axis",

33423

"module": "charts"

33424

},

33425

{

33426

"file": "charts/js/Axis.js",

33427

"line": 533,

33428

"description": "Updates the content and style properties for a title field.",

33429

"itemtype": "method",

33430

"name": "_updateTitle",

33431

"access": "private",

33432

"tagname": "",

33433

"class": "Axis",

33434

"module": "charts"

33435

},

33436

{

33437

"file": "charts/js/Axis.js",

33438

"line": 595,

33439

"description": "Creates or updates an axis label.",

33440

"itemtype": "method",

33441

"name": "getLabel",

33442

"params": [

33443

{

33444

"name": "pt",

33445

"description": "x and y coordinates for the label",

33446

"type": "Object"

33447

},

33448

{

33449

"name": "styles",

33450

"description": "styles applied to label",

33451

"type": "Object"

33452

}

33453

],

33454

"return": {

33455

"description": "HTMLElement"

33456

},

33457

"access": "private",

33458

"tagname": "",

33459

"class": "Axis",

33460

"module": "charts"

33461

},

33462

{

33463

"file": "charts/js/Axis.js",

33464

"line": 644,

33465

"description": "Creates a cache of labels that can be re-used when the axis redraws.",

33466

"itemtype": "method",

33467

"name": "_createLabelCache",

33468

"access": "private",

33469

"tagname": "",

33470

"class": "Axis",

33471

"module": "charts"

33472

},

33473

{

33474

"file": "charts/js/Axis.js",

33475

"line": 666,

33476

"description": "Removes axis labels from the dom and clears the label cache.",

33477

"itemtype": "method",

33478

"name": "_clearLabelCache",

33479

"access": "private",

33480

"tagname": "",

33481

"class": "Axis",

33482

"module": "charts"

33483

},

33484

{

33485

"file": "charts/js/Axis.js",

33486

"line": 690,

33487

"description": "Gets the end point of an axis.",

33488

"itemtype": "method",

33489

"name": "getLineEnd",

33490

"return": {

33491

"description": "Object"

33492

},

33493

"access": "private",

33494

"tagname": "",

33495

"class": "Axis",

33496

"module": "charts"

33497

},

33498

{

33499

"file": "charts/js/Axis.js",

33500

"line": 712,

33501

"description": "Calcuates the width or height of an axis depending on its direction.",

33502

"itemtype": "method",

33503

"name": "getLength",

33504

"return": {

33505

"description": "Number"

33506

},

33507

"access": "private",

33508

"tagname": "",

33509

"class": "Axis",

33510

"module": "charts"

33511

},

33512

{

33513

"file": "charts/js/Axis.js",

33514

"line": 738,

33515

"description": "Gets the position of the first point on an axis.",

33516

"itemtype": "method",

33517

"name": "getFirstPoint",

33518

"params": [

33519

{

33520

"name": "pt",

33521

"description": "Object containing x and y coordinates.",

33522

"type": "Object"

33523

}

33524

],

33525

"return": {

33526

"description": "Object"

33527

},

33528

"access": "private",

33529

"tagname": "",

33530

"class": "Axis",

33531

"module": "charts"

33532

},

33533

{

33534

"file": "charts/js/Axis.js",

33535

"line": 763,

33536

"description": "Gets the position of the next point on an axis.",

33537

"itemtype": "method",

33538

"name": "getNextPoint",

33539

"params": [

33540

{

33541

"name": "point",

33542

"description": "Object containing x and y coordinates.",

33543

"type": "Object"

33544

},

33545

{

33546

"name": "majorUnitDistance",

33547

"description": "Distance in pixels between ticks.",

33548

"type": "Number"

33549

}

33550

],

33551

"return": {

33552

"description": "Object"

33553

},

33554

"access": "private",

33555

"tagname": "",

33556

"class": "Axis",

33557

"module": "charts"

33558

},

33559

{

33560

"file": "charts/js/Axis.js",

33561

"line": 786,

33562

"description": "Calculates the placement of last tick on an axis.",

33563

"itemtype": "method",

33564

"name": "getLastPoint",

33565

"return": {

33566

"description": "Object"

33567

},

33568

"access": "private",

33569

"tagname": "",

33570

"class": "Axis",

33571

"module": "charts"

33572

},

33573

{

33574

"file": "charts/js/Axis.js",

33575

"line": 809,

33576

"description": "Calculates position on the axis.",

33577

"itemtype": "method",

33578

"name": "getPosition",

33579

"params": [

33580

{

33581

"name": "point",

33582

"description": "contains x and y values",

33583

"type": "Object"

33584

}

33585

],

33586

"access": "private",

33587

"tagname": "",

33588

"class": "Axis",

33589

"module": "charts"

33590

},

33591

{

33592

"file": "charts/js/Axis.js",

33593

"line": 844,

33594

"description": "Rotates and positions a text field.",

33595

"itemtype": "method",

33596

"name": "_rotate",

33597

"params": [

33598

{

33599

"name": "label",

33600

"description": "text field to rotate and position",

33601

"type": "HTMLElement"

33602

},

33603

{

33604

"name": "props",

33605

"description": "properties to be applied to the text field.",

33606

"type": "Object"

33607

}

33608

],

33609

"access": "private",

33610

"tagname": "",

33611

"class": "Axis",

33612

"module": "charts"

33613

},

33614

{

33615

"file": "charts/js/Axis.js",

33616

"line": 916,

33617

"description": "Simulates a rotation with a specified transformOrigin.",

33618

"itemtype": "method",

33619

"name": "_simulateTransformOrigin",

33620

"params": [

33621

{

33622

"name": "matrix",

33623

"description": "Reference to a `Matrix` instance.",

33624

"type": "Matrix"

33625

},

33626

{

33627

"name": "rot",

33628

"description": "The rotation (in degrees) that will be performed on a matrix.",

33629

"type": "Number"

33630

},

33631

{

33632

"name": "transformOrigin",

33633

"description": "An array represeniting the origin in which to perform the transform. The first \nindex represents the x origin and the second index represents the y origin.",

33634

"type": "Array"

33635

},

33636

{

33637

"name": "w",

33638

"description": "The width of the object that will be transformed.",

33639

"type": "Number"

33640

},

33641

{

33642

"name": "h",

33643

"description": "The height of the object that will be transformed.",

33644

"type": "Number"

33645

}

33646

],

33647

"access": "private",

33648

"tagname": "",

33649

"class": "Axis",

33650

"module": "charts"

33651

},

33652

{

33653

"file": "charts/js/Axis.js",

33654

"line": 939,

33655

"description": "Returns the coordinates (top, right, bottom, left) for the bounding box of the last label.",

33656

"itemtype": "method",

33657

"name": "getMaxLabelBounds",

33658

"return": {

33659

"description": "Object"

33660

},

33661

"class": "Axis",

33662

"module": "charts"

33663

},

33664

{

33665

"file": "charts/js/Axis.js",

33666

"line": 950,

33667

"description": "Returns the coordinates (top, right, bottom, left) for the bounding box of the first label.",

33668

"itemtype": "method",

33669

"name": "getMinLabelBounds",

33670

"return": {

33671

"description": "Object"

33672

},

33673

"class": "Axis",

33674

"module": "charts"

33675

},

33676

{

33677

"file": "charts/js/Axis.js",

33678

"line": 961,

33679

"description": "Returns the coordinates (top, right, bottom, left) for the bounding box of a label.",

33680

"itemtype": "method",

33681

"name": "_getLabelBounds",

33682

"params": [

33683

{

33684

"name": "Value",

33685

"description": "of the label",

33686

"type": "String"

33687

}

33688

],

33689

"return": {

33690

"description": "Object"

33691

},

33692

"access": "private",

33693

"tagname": "",

33694

"class": "Axis",

33695

"module": "charts"

33696

},

33697

{

33698

"file": "charts/js/Axis.js",

33699

"line": 992,

33700

"description": "Removes all DOM elements from an HTML element. Used to clear out labels during detruction\nphase.",

33701

"itemtype": "method",

33702

"name": "_removeChildren",

33703

"access": "private",

33704

"tagname": "",

33705

"class": "Axis",

33706

"module": "charts"

33707

},

33708

{

33709

"file": "charts/js/Axis.js",

33710

"line": 1013,

33711

"description": "Destructor implementation Axis class. Removes all labels and the Graphic instance from the widget.",

33712

"itemtype": "method",

33713

"name": "destructor",

33714

"access": "protected",

33715

"tagname": "",

33716

"class": "Axis",

33717

"module": "charts"

33718

},

33719

{

33720

"file": "charts/js/Axis.js",

33721

"line": 1042,

33722

"description": "Length in pixels of largest text bounding box. Used to calculate the height of the axis.",

33723

"itemtype": "property",

33724

"name": "maxLabelSize",

33725

"type": "Number",

33726

"access": "protected",

33727

"tagname": "",

33728

"class": "Axis",

33729

"module": "charts"

33730

},

33731

{

33732

"file": "charts/js/Axis.js",

33733

"line": 1051,

33734

"description": "Updates the content of text field. This method writes a value into a text field using \n`appendChild`. If the value is a `String`, it is converted to a `TextNode` first.",

33735

"itemtype": "method",

33736

"name": "_setText",

33737

"params": [

33738

{

33739

"name": "label",

33740

"description": "label to be updated",

33741

"type": "HTMLElement"

33742

},

33743

{

33744

"name": "val",

33745

"description": "value with which to update the label",

33746

"type": "String"

33747

}

33748

],

33749

"access": "private",

33750

"tagname": "",

33751

"class": "Axis",

33752

"module": "charts"

33753

},

33754

{

33755

"file": "charts/js/Axis.js",

33756

"line": 1080,

33757

"description": "When set, defines the width of a vertical axis instance. By default, vertical axes automatically size based on their contents. When the\nwidth attribute is set, the axis will not calculate its width. When the width attribute is explicitly set, axis labels will postion themselves off of the \nthe inner edge of the axis and the title, if present, will position itself off of the outer edge. If a specified width is less than the sum of \nthe axis' contents, excess content will overflow.",

33758

"itemtype": "attribute",

33759

"name": "width",

33760

"type": "Number",

33761

"class": "Axis",

33762

"module": "charts"

33763

},

33764

{

33765

"file": "charts/js/Axis.js",

33766

"line": 1108,

33767

"description": "When set, defines the height of a horizontal axis instance. By default, horizontal axes automatically size based on their contents. When the\nheight attribute is set, the axis will not calculate its height. When the height attribute is explicitly set, axis labels will postion themselves off of the \nthe inner edge of the axis and the title, if present, will position itself off of the outer edge. If a specified height is less than the sum of \nthe axis' contents, excess content will overflow.",

33768

"itemtype": "attribute",

33769

"name": "height",

33770

"type": "Number",

33771

"class": "Axis",

33772

"module": "charts"

33773

},

33774

{

33775

"file": "charts/js/Axis.js",

33776

"line": 1136,

33777

"description": "Calculated value of an axis' width. By default, the value is used internally for vertical axes. If the `width` attribute is explicitly set, this value will be ignored.",

33778

"itemtype": "attribute",

33779

"name": "calculatedWidth",

33780

"type": "Number",

33781

"access": "private",

33782

"tagname": "",

33783

"class": "Axis",

33784

"module": "charts"

33785

},

33786

{

33787

"file": "charts/js/Axis.js",

33788

"line": 1156,

33789

"description": "Calculated value of an axis' height. By default, the value is used internally for horizontal axes. If the `height` attribute is explicitly set, this value will be ignored.",

33790

"itemtype": "attribute",

33791

"name": "calculatedHeight",

33792

"type": "Number",

33793

"access": "private",

33794

"tagname": "",

33795

"class": "Axis",

33796

"module": "charts"

33797

},

33798

{

33799

"file": "charts/js/Axis.js",

33800

"line": 1176,

33801

"description": "Difference betweend the first/last tick and edge of axis.",

33802

"itemtype": "attribute",

33803

"name": "edgeOffset",

33804

"type": "Number",

33805

"access": "protected",

33806

"tagname": "",

33807

"class": "Axis",

33808

"module": "charts"

33809

},

33810

{

33811

"file": "charts/js/Axis.js",

33812

"line": 1188,

33813

"description": "The graphic in which the axis line and ticks will be rendered.",

33814

"itemtype": "attribute",

33815

"name": "graphic",

33816

"type": "Graphic",

33817

"class": "Axis",

33818

"module": "charts"

33819

},

33820

{

33821

"file": "charts/js/Axis.js",

33822

"line": 1196,

33823

"itemtype": "attribute",

33824

"name": "path",

33825

"type": "Shape",

33826

"readonly": "",

33827

"access": "private",

33828

"tagname": "",

33829

"class": "Axis",

33830

"module": "charts"

33831

},

33832

{

33833

"file": "charts/js/Axis.js",

33834

"line": 1219,

33835

"itemtype": "attribute",

33836

"name": "tickPath",

33837

"type": "Shape",

33838

"readonly": "",

33839

"access": "private",

33840

"tagname": "",

33841

"class": "Axis",

33842

"module": "charts"

33843

},

33844

{

33845

"file": "charts/js/Axis.js",

33846

"line": 1242,

33847

"description": "Contains the contents of the axis.",

33848

"itemtype": "attribute",

33849

"name": "node",

33850

"type": "HTMLElement",

33851

"class": "Axis",

33852

"module": "charts"

33853

},

33854

{

33855

"file": "charts/js/Axis.js",

33856

"line": 1250,

33857

"description": "Direction of the axis.",

33858

"itemtype": "attribute",

33859

"name": "position",

33860

"type": "String",

33861

"class": "Axis",

33862

"module": "charts"

33863

},

33864

{

33865

"file": "charts/js/Axis.js",

33866

"line": 1268,

33867

"description": "Distance determined by the tick styles used to calculate the distance between the axis\nline in relation to the top of the axis.",

33868

"itemtype": "attribute",

33869

"name": "topTickOffset",

33870

"type": "Number",

33871

"class": "Axis",

33872

"module": "charts"

33873

},

33874

{

33875

"file": "charts/js/Axis.js",

33876

"line": 1279,

33877

"description": "Distance determined by the tick styles used to calculate the distance between the axis\nline in relation to the bottom of the axis.",

33878

"itemtype": "attribute",

33879

"name": "bottomTickOffset",

33880

"type": "Number",

33881

"class": "Axis",

33882

"module": "charts"

33883

},

33884

{

33885

"file": "charts/js/Axis.js",

33886

"line": 1290,

33887

"description": "Distance determined by the tick styles used to calculate the distance between the axis\nline in relation to the left of the axis.",

33888

"itemtype": "attribute",

33889

"name": "leftTickOffset",

33890

"type": "Number",

33891

"class": "Axis",

33892

"module": "charts"

33893

},

33894

{

33895

"file": "charts/js/Axis.js",

33896

"line": 1301,

33897

"description": "Distance determined by the tick styles used to calculate the distance between the axis\nline in relation to the right side of the axis.",

33898

"itemtype": "attribute",

33899

"name": "rightTickOffset",

33900

"type": "Number",

33901

"class": "Axis",

33902

"module": "charts"

33903

},

33904

{

33905

"file": "charts/js/Axis.js",

33906

"line": 1312,

33907

"description": "Collection of labels used to render the axis.",

33908

"itemtype": "attribute",

33909

"name": "labels",

33910

"type": "Array",

33911

"class": "Axis",

33912

"module": "charts"

33913

},

33914

{

33915

"file": "charts/js/Axis.js",

33916

"line": 1326,

33917

"description": "Collection of points used for placement of labels and ticks along the axis.",

33918

"itemtype": "attribute",

33919

"name": "tickPoints",

33920

"type": "Array",

33921

"class": "Axis",

33922

"module": "charts"

33923

},

33924

{

33925

"file": "charts/js/Axis.js",

33926

"line": 1345,

33927

"description": "Indicates whether the axis overlaps the graph. If an axis is the inner most axis on a given\nposition and the tick position is inside or cross, the axis will need to overlap the graph.",

33928

"itemtype": "attribute",

33929

"name": "overlapGraph",

33930

"type": "Boolean",

33931

"class": "Axis",

33932

"module": "charts"

33933

},

33934

{

33935

"file": "charts/js/Axis.js",

33936

"line": 1361,

33937

"description": "Object which should have by the labelFunction",

33938

"itemtype": "attribute",

33939

"name": "labelFunctionScope",

33940

"type": "Object",

33941

"class": "Axis",

33942

"module": "charts"

33943

},

33944

{

33945

"file": "charts/js/Axis.js",

33946

"line": 1369,

33947

"description": "Length in pixels of largest text bounding box. Used to calculate the height of the axis.",

33948

"itemtype": "attribute",

33949

"name": "maxLabelSize",

33950

"type": "Number",

33951

"access": "protected",

33952

"tagname": "",

33953

"class": "Axis",

33954

"module": "charts"

33955

},

33956

{

33957

"file": "charts/js/Axis.js",

33958

"line": 1389,

33959

"description": "Title for the axis. When specified, the title will display. The position of the title is determined by the axis position. \n<dl>\n <dt>top</dt><dd>Appears above the axis and it labels. The default rotation is 0.</dd>\n <dt>right</dt><dd>Appears to the right of the axis and its labels. The default rotation is 90.</dd>\n <dt>bottom</dt><dd>Appears below the axis and its labels. The default rotation is 0.</dd>\n <dt>left</dt><dd>Appears to the left of the axis and its labels. The default rotation is -90.</dd>\n</dl>",

33960

"itemtype": "attribute",

33961

"name": "title",

33962

"type": "String",

33963

"class": "Axis",

33964

"module": "charts"

33965

},

33966

{

33967

"file": "charts/js/Axis.js",

33968

"line": 1405,

33969

"description": "Method used for formatting a label. This attribute allows for the default label formatting method to overridden. The method use would need\nto implement the arguments below and return a `String` or `HTMLElement`. \n<dl>\n <dt>val</dt><dd>Label to be formatted. (`String`)</dd>\n <dt>format</dt><dd>Template for formatting label. (optional)</dd>\n</dl>",

33970

"itemtype": "attribute",

33971

"name": "labelFunction",

33972

"type": "Function",

33973

"class": "Axis",

33974

"module": "charts"

33975

},

33976

{

33977

"file": "charts/js/Axis.js",

33978

"line": 1423,

33979

"description": "Function used to append an axis value to an axis label. This function has the following signature:\n <dl>\n <dt>textField</dt><dd>The axis label to be appended. (`HTMLElement`)</dd>\n <dt>val</dt><dd>The value to attach to the text field. This method will accept an `HTMLELement`\n or a `String`. This method does not use (`HTMLElement` | `String`)</dd>\n </dl>\nThe default method appends a value to the `HTMLElement` using the `appendChild` method. If the given \nvalue is a `String`, the method will convert the the value to a `textNode` before appending to the \n`HTMLElement`. This method will not convert an `HTMLString` to an `HTMLElement`.",

33980

"itemtype": "attribute",

33981

"name": "appendLabelFunction",

33982

"type": "Function",

33983

"class": "Axis",

33984

"module": "charts"

33985

},

33986

{

33987

"file": "charts/js/Axis.js",

33988

"line": 1444,

33989

"description": "Function used to append a title value to the title object. This function has the following signature:\n <dl>\n <dt>textField</dt><dd>The title text field to be appended. (`HTMLElement`)</dd>\n <dt>val</dt><dd>The value to attach to the text field. This method will accept an `HTMLELement`\n or a `String`. This method does not use (`HTMLElement` | `String`)</dd>\n </dl>\nThe default method appends a value to the `HTMLElement` using the `appendChild` method. If the given \nvalue is a `String`, the method will convert the the value to a `textNode` before appending to the \n`HTMLElement` element. This method will not convert an `HTMLString` to an `HTMLElement`.",

33990

"itemtype": "attribute",

33991

"name": "appendTitleFunction",

33992

"type": "Function",

33993

"class": "Axis",

33994

"module": "charts"

33995

},

33996

{

33997

"file": "charts/js/Axis.js",

33998

"line": 1465,

33999

"description": "Style properties used for drawing an axis. This attribute is inherited from `Renderer`. Below are the default values:\n <dl>\n <dt>majorTicks</dt><dd>Properties used for drawing ticks.\n <dl>\n <dt>display</dt><dd>Position of the tick. Possible values are `inside`, `outside`, `cross` and `none`. The\n default value is `inside`.</dd>\n <dt>length</dt><dd>The length (in pixels) of the tick. The default value is 4.</dd>\n <dt>color</dt><dd>The color of the tick. The default value is `#dad8c9`</dd>\n <dt>weight</dt><dd>Number indicating the width of the tick. The default value is 1.</dd>\n <dt>alpha</dt><dd>Number from 0 to 1 indicating the opacity of the tick. The default value is 1.</dd>\n </dl>\n </dd>\n <dt>line</dt><dd>Properties used for drawing the axis line. \n <dl>\n <dt>weight</dt><dd>Number indicating the width of the axis line. The default value is 1.</dd>\n <dt>color</dt><dd>The color of the axis line. The default value is `#dad8c9`.</dd>\n <dt>alpha</dt><dd>Number from 0 to 1 indicating the opacity of the tick. The default value is 1.</dd>\n </dl>\n </dd>\n <dt>majorUnit</dt><dd>Properties used to calculate the `majorUnit` for the axis. \n <dl>\n <dt>determinant</dt><dd>The algorithm used for calculating distance between ticks. The possible options are `count` and `distance`. If\n the `determinant` is `count`, the axis ticks will spaced so that a specified number of ticks appear on the axis. If the `determinant`\n is `distance`, the axis ticks will spaced out according to the specified distance. The default value is `count`.</dd>\n <dt>count</dt><dd>Number of ticks to appear on the axis when the `determinant` is `count`. The default value is 11.</dd>\n <dt>distance</dt><dd>The distance (in pixels) between ticks when the `determinant` is `distance`. The default value is 75.</dd>\n </dl>\n </dd>\n <dt>label</dt><dd>Properties and styles applied to the axis labels.\n <dl>\n <dt>color</dt><dd>The color of the labels. The default value is `#808080`.</dd>\n <dt>alpha</dt><dd>Number between 0 and 1 indicating the opacity of the labels. The default value is 1.</dd>\n <dt>fontSize</dt><dd>The font-size of the labels. The default value is 85%</dd>\n <dt>rotation</dt><dd>The rotation, in degrees (between -90 and 90) of the labels. The default value is 0.</dd>\n <dt>margin</dt><dd>The distance between the label and the axis/tick. Depending on the position of the `Axis`, only one of the properties used.\n <dl>\n <dt>top</dt><dd>Pixel value used for an axis with a `position` of `bottom`. The default value is 4.</dd>\n <dt>right</dt><dd>Pixel value used for an axis with a `position` of `left`. The default value is 4.</dd>\n <dt>bottom</dt><dd>Pixel value used for an axis with a `position` of `top`. The default value is 4.</dd>\n <dt>left</dt><dd>Pixel value used for an axis with a `position` of `right`. The default value is 4.</dd>\n </dl>\n </dd>\n </dl>\n </dd>\n </dl>",

34000

"itemtype": "attribute",

34001

"name": "styles",

34002

"type": "Object",

34003

"class": "Axis",

34004

"module": "charts"

34005

},

34006

{

34007

"file": "charts/js/AxisType.js",

34008

"line": 10,

34009

"itemtype": "method",

34010

"name": "initializer",

34011

"access": "private",

34012

"tagname": "",

34013

"class": "AxisType",

34014

"module": "charts"

34015

},

34016

{

34017

"file": "charts/js/AxisType.js",

34018

"line": 26,

34019

"itemtype": "method",

34020

"name": "bindUI",

34021

"access": "private",

34022

"tagname": "",

34023

"class": "AxisType",

34024

"module": "charts"

34025

},

34026

{

34027

"file": "charts/js/AxisType.js",

34028

"line": 41,

34029

"description": "Handles changes to `dataProvider`.",

34030

"itemtype": "method",

34031

"name": "_dataProviderChangeHandler",

34032

"params": [

34033

{

34034

"name": "e",

34035

"description": "Event object.",

34036

"type": "Object"

34037

}

34038

],

34039

"access": "private",

34040

"tagname": "",

34041

"class": "AxisType",

34042

"module": "charts"

34043

},

34044

{

34045

"file": "charts/js/AxisType.js",

34046

"line": 69,

34047

"description": "Constant used to generate unique id.",

34048

"itemtype": "property",

34049

"name": "GUID",

34050

"type": "String",

34051

"access": "private",

34052

"tagname": "",

34053

"class": "AxisType",

34054

"module": "charts"

34055

},

34056

{

34057

"file": "charts/js/AxisType.js",

34058

"line": 78,

34059

"description": "Type of data used in `Axis`.",

34060

"itemtype": "property",

34061

"name": "_type",

34062

"type": "String",

34063

"readonly": "",

34064

"access": "private",

34065

"tagname": "",

34066

"class": "AxisType",

34067

"module": "charts"

34068

},

34069

{

34070

"file": "charts/js/AxisType.js",

34071

"line": 88,

34072

"description": "Storage for `setMaximum` attribute.",

34073

"itemtype": "property",

34074

"name": "_setMaximum",

34075

"type": "Object",

34076

"access": "private",

34077

"tagname": "",

34078

"class": "AxisType",

34079

"module": "charts"

34080

},

34081

{

34082

"file": "charts/js/AxisType.js",

34083

"line": 97,

34084

"description": "Storage for `dataMaximum` attribute.",

34085

"itemtype": "property",

34086

"name": "_dataMaximum",

34087

"type": "Object",

34088

"access": "private",

34089

"tagname": "",

34090

"class": "AxisType",

34091

"module": "charts"

34092

},

34093

{

34094

"file": "charts/js/AxisType.js",

34095

"line": 106,

34096

"description": "Storage for `setMinimum` attribute.",

34097

"itemtype": "property",

34098

"name": "_setMinimum",

34099

"type": "Object",

34100

"access": "private",

34101

"tagname": "",

34102

"class": "AxisType",

34103

"module": "charts"

34104

},

34105

{

34106

"file": "charts/js/AxisType.js",

34107

"line": 115,

34108

"description": "Reference to data array.",

34109

"itemtype": "property",

34110

"name": "_data",

34111

"type": "Array",

34112

"access": "private",

34113

"tagname": "",

34114

"class": "AxisType",

34115

"module": "charts"

34116

},

34117

{

34118

"file": "charts/js/AxisType.js",

34119

"line": 124,

34120

"description": "Indicates whether the all data is up to date.",

34121

"itemtype": "property",

34122

"name": "_updateTotalDataFlag",

34123

"type": "Boolean",

34124

"access": "private",

34125

"tagname": "",

34126

"class": "AxisType",

34127

"module": "charts"

34128

},

34129

{

34130

"file": "charts/js/AxisType.js",

34131

"line": 133,

34132

"description": "Storage for `dataReady` attribute.",

34133

"itemtype": "property",

34134

"name": "_dataReady",

34135

"type": "Boolean",

34136

"readonly": "",

34137

"access": "private",

34138

"tagname": "",

34139

"class": "AxisType",

34140

"module": "charts"

34141

},

34142

{

34143

"file": "charts/js/AxisType.js",

34144

"line": 143,

34145

"description": "Adds an array to the key hash.",

34146

"itemtype": "method",

34147

"name": "addKey",

34148

"params": [

34149

{

34150

"name": "value",

34151

"description": "Indicates what key to use in retrieving\nthe array."

34152

}

34153

],

34154

"class": "AxisType",

34155

"module": "charts"

34156

},

34157

{

34158

"file": "charts/js/AxisType.js",

34159

"line": 155,

34160

"description": "Gets an array of values based on a key.",

34161

"itemtype": "method",

34162

"name": "_getKeyArray",

34163

"params": [

34164

{

34165

"name": "key",

34166

"description": "Value key associated with the data array.",

34167

"type": "String"

34168

},

34169

{

34170

"name": "data",

34171

"description": "Array in which the data resides.",

34172

"type": "Array"

34173

}

34174

],

34175

"return": {

34176

"description": "Array"

34177

},

34178

"access": "private",

34179

"tagname": "",

34180

"class": "AxisType",

34181

"module": "charts"

34182

},

34183

{

34184

"file": "charts/js/AxisType.js",

34185

"line": 178,

34186

"description": "Sets data by key",

34187

"itemtype": "method",

34188

"name": "_setDataByKey",

34189

"params": [

34190

{

34191

"name": "key",

34192

"description": "Key value to use.",

34193

"type": "String"

34194

},

34195

{

34196

"name": "data",

34197

"description": "Array to use.",

34198

"type": "Array"

34199

}

34200

],

34201

"access": "private",

34202

"tagname": "",

34203

"class": "AxisType",

34204

"module": "charts"

34205

},

34206

{

34207

"file": "charts/js/AxisType.js",

34208

"line": 202,

34209

"description": "Updates the total data array.",

34210

"itemtype": "method",

34211

"name": "_updateTotalData",

34212

"access": "private",

34213

"tagname": "",

34214

"class": "AxisType",

34215

"module": "charts"

34216

},

34217

{

34218

"file": "charts/js/AxisType.js",

34219

"line": 223,

34220

"description": "Removes an array from the key hash.",

34221

"itemtype": "method",

34222

"name": "removeKey",

34223

"params": [

34224

{

34225

"name": "value",

34226

"description": "Indicates what key to use in removing from \nthe hash.",

34227

"type": "String"

34228

}

34229

],

34230

"class": "AxisType",

34231

"module": "charts"

34232

},

34233

{

34234

"file": "charts/js/AxisType.js",

34235

"line": 240,

34236

"description": "Returns a value based of a key value and an index.",

34237

"itemtype": "method",

34238

"name": "getKeyValueAt",

34239

"params": [

34240

{

34241

"name": "key",

34242

"description": "value used to look up the correct array",

34243

"type": "String"

34244

},

34245

{

34246

"name": "index",

34247

"description": "within the array",

34248

"type": "Number"

34249

}

34250

],

34251

"return": {

34252

"description": "Number"

34253

},

34254

"class": "AxisType",

34255

"module": "charts"

34256

},

34257

{

34258

"file": "charts/js/AxisType.js",

34259

"line": 259,

34260

"description": "Returns an array of values based on an identifier key.",

34261

"itemtype": "method",

34262

"name": "getDataByKey",

34263

"params": [

34264

{

34265

"name": "value",

34266

"description": "value used to identify the array",

34267

"type": "String"

34268

}

34269

],

34270

"return": {

34271

"description": "Object"

34272

},

34273

"class": "AxisType",

34274

"module": "charts"

34275

},

34276

{

34277

"file": "charts/js/AxisType.js",

34278

"line": 276,

34279

"description": "Calculates the maximum and minimum values for the `Axis`.",

34280

"itemtype": "method",

34281

"name": "_updateMinAndMax",

34282

"access": "private",

34283

"tagname": "",

34284

"class": "AxisType",

34285

"module": "charts"

34286

},

34287

{

34288

"file": "charts/js/AxisType.js",

34289

"line": 312,

34290

"description": "Returns the total number of majorUnits that will appear on an axis.",

34291

"itemtype": "method",

34292

"name": "getTotalMajorUnits",

34293

"return": {

34294

"description": "Number"

34295

},

34296

"class": "AxisType",

34297

"module": "charts"

34298

},

34299

{

34300

"file": "charts/js/AxisType.js",

34301

"line": 334,

34302

"description": "Returns the distance between major units on an axis.",

34303

"itemtype": "method",

34304

"name": "getMajorUnitDistance",

34305

"params": [

34306

{

34307

"name": "len",

34308

"description": "Number of ticks",

34309

"type": "Number"

34310

},

34311

{

34312

"name": "uiLen",

34313

"description": "Size of the axis.",

34314

"type": "Number"

34315

},

34316

{

34317

"name": "majorUnit",

34318

"description": "Hash of properties used to determine the majorUnit",

34319

"type": "Object"

34320

}

34321

],

34322

"return": {

34323

"description": "Number"

34324

},

34325

"class": "AxisType",

34326

"module": "charts"

34327

},

34328

{

34329

"file": "charts/js/AxisType.js",

34330

"line": 357,

34331

"description": "Gets the distance that the first and last ticks are offset from there respective\nedges.",

34332

"itemtype": "method",

34333

"name": "getEdgeOffset",

34334

"params": [

34335

{

34336

"name": "ct",

34337

"description": "Number of ticks on the axis.",

34338

"type": "Number"

34339

},

34340

{

34341

"name": "l",

34342

"description": "Length (in pixels) of the axis.",

34343

"type": "Number"

34344

}

34345

],

34346

"return": {

34347

"description": "Number"

34348

},

34349

"class": "AxisType",

34350

"module": "charts"

34351

},

34352

{

34353

"file": "charts/js/AxisType.js",

34354

"line": 371,

34355

"description": "Calculates and returns a value based on the number of labels and the index of\nthe current label.",

34356

"itemtype": "method",

34357

"name": "getLabelByIndex",

34358

"params": [

34359

{

34360

"name": "i",

34361

"description": "Index of the label.",

34362

"type": "Number"

34363

},

34364

{

34365

"name": "l",

34366

"description": "Total number of labels.",

34367

"type": "Number"

34368

}

34369

],

34370

"return": {

34371

"description": "String"

34372

},

34373

"class": "AxisType",

34374

"module": "charts"

34375

},

34376

{

34377

"file": "charts/js/AxisType.js",

34378

"line": 391,

34379

"description": "Updates the `Axis` after a change in keys.",

34380

"itemtype": "method",

34381

"name": "_keyChangeHandler",

34382

"params": [

34383

{

34384

"name": "e",

34385

"description": "Event object.",

34386

"type": "Object"

34387

}

34388

],

34389

"access": "private",

34390

"tagname": "",

34391

"class": "AxisType",

34392

"module": "charts"

34393

},

34394

{

34395

"file": "charts/js/AxisType.js",

34396

"line": 404,

34397

"description": "Checks to see if data extends beyond the range of the axis. If so,\nthat data will need to be hidden. This method is internal, temporary and subject\nto removal in the future.",

34398

"itemtype": "method",

34399

"name": "_hasDataOverflow",

34400

"access": "protected",

34401

"tagname": "",

34402

"return": {

34403

"description": "Boolean"

34404

},

34405

"class": "AxisType",

34406

"module": "charts"

34407

},

34408

{

34409

"file": "charts/js/AxisType.js",

34410

"line": 422,

34411

"description": "Returns a string corresponding to the first label on an \naxis.",

34412

"itemtype": "method",

34413

"name": "getMinimumValue",

34414

"return": {

34415

"description": "String"

34416

},

34417

"class": "AxisType",

34418

"module": "charts"

34419

},

34420

{

34421

"file": "charts/js/AxisType.js",

34422

"line": 434,

34423

"description": "Returns a string corresponding to the last label on an \naxis.",

34424

"itemtype": "method",

34425

"name": "getMaximumValue",

34426

"return": {

34427

"description": "String"

34428

},

34429

"class": "AxisType",

34430

"module": "charts"

34431

},

34432

{

34433

"file": "charts/js/AxisType.js",

34434

"line": 447,

34435

"description": "Hash of array identifed by a string value.",

34436

"itemtype": "attribute",

34437

"name": "keys",

34438

"type": "Object",

34439

"class": "AxisType",

34440

"module": "charts"

34441

},

34442

{

34443

"file": "charts/js/AxisType.js",

34444

"line": 491,

34445

"description": "Indicates how to round unit values.\n <dl>\n <dt>niceNumber</dt><dd>Units will be smoothed based on the number of ticks and data range.</dd>\n <dt>auto</dt><dd>If the range is greater than 1, the units will be rounded.</dd>\n <dt>numeric value</dt><dd>Units will be equal to the numeric value.</dd>\n <dt>null</dt><dd>No rounding will occur.</dd>\n </dl>",

34446

"itemtype": "attribute",

34447

"name": "roundingMethod",

34448

"type": "String",

34449

"default": "niceNumber",

34450

"class": "AxisType",

34451

"module": "charts"

34452

},

34453

{

34454

"file": "charts/js/AxisType.js",

34455

"line": 508,

34456

"description": "Returns the type of axis data\n <dl>\n <dt>time</dt><dd>Manages time data</dd>\n <dt>stacked</dt><dd>Manages stacked numeric data</dd> \n <dt>numeric</dt><dd>Manages numeric data</dd>\n <dt>category</dt><dd>Manages categorical data</dd>\n </dl>",

34457

"itemtype": "attribute",

34458

"name": "type",

34459

"type": "String",

34460

"class": "AxisType",

34461

"module": "charts"

34462

},

34463

{

34464

"file": "charts/js/AxisType.js",

34465

"line": 530,

34466

"description": "Instance of `ChartDataProvider` that the class uses\nto build its own data.",

34467

"itemtype": "attribute",

34468

"name": "dataProvider",

34469

"type": "Array",

34470

"class": "AxisType",

34471

"module": "charts"

34472

},

34473

{

34474

"file": "charts/js/AxisType.js",

34475

"line": 544,

34476

"description": "The maximum value contained in the `data` array. Used for\n`maximum` when `autoMax` is true.",

34477

"itemtype": "attribute",

34478

"name": "dataMaximum",

34479

"type": "Number",

34480

"class": "AxisType",

34481

"module": "charts"

34482

},

34483

{

34484

"file": "charts/js/AxisType.js",

34485

"line": 562,

34486

"description": "The maximum value that will appear on an axis.",

34487

"itemtype": "attribute",

34488

"name": "maximum",

34489

"type": "Number",

34490

"class": "AxisType",

34491

"module": "charts"

34492

},

34493

{

34494

"file": "charts/js/AxisType.js",

34495

"line": 594,

34496

"description": "The minimum value contained in the `data` array. Used for\n`minimum` when `autoMin` is true.",

34497

"itemtype": "attribute",

34498

"name": "dataMinimum",

34499

"type": "Number",

34500

"class": "AxisType",

34501

"module": "charts"

34502

},

34503

{

34504

"file": "charts/js/AxisType.js",

34505

"line": 612,

34506

"description": "The minimum value that will appear on an axis.",

34507

"itemtype": "attribute",

34508

"name": "minimum",

34509

"type": "Number",

34510

"class": "AxisType",

34511

"module": "charts"

34512

},

34513

{

34514

"file": "charts/js/AxisType.js",

34515

"line": 637,

34516

"description": "Determines whether the maximum is calculated or explicitly \nset by the user.",

34517

"itemtype": "attribute",

34518

"name": "setMax",

34519

"type": "Boolean",

34520

"class": "AxisType",

34521

"module": "charts"

34522

},

34523

{

34524

"file": "charts/js/AxisType.js",

34525

"line": 653,

34526

"description": "Determines whether the minimum is calculated or explicitly\nset by the user.",

34527

"itemtype": "attribute",

34528

"name": "setMin",

34529

"type": "Boolean",

34530

"class": "AxisType",

34531

"module": "charts"

34532

},

34533

{

34534

"file": "charts/js/AxisType.js",

34535

"line": 669,

34536

"description": "Array of axis data",

34537

"itemtype": "attribute",

34538

"name": "data",

34539

"type": "Array",

34540

"class": "AxisType",

34541

"module": "charts"

34542

},

34543

{

34544

"file": "charts/js/AxisType.js",

34545

"line": 686,

34546

"description": "Array containing all the keys in the axis.",

34547

"itemtype": "attribute",

34548

"name": "keyCollection",

34549

"type": "Array",

34550

"class": "AxisType",

34551

"module": "charts"

34552

},

34553

{

34554

"file": "charts/js/BarSeries.js",

34555

"line": 13,

34556

"description": "Helper method for calculating the size of markers.",

34557

"itemtype": "method",

34558

"name": "_getMarkerDimensions",

34559

"params": [

34560

{

34561

"name": "xcoord",

34562

"description": "The x-coordinate representing the data point for the marker.",

34563

"type": "Number"

34564

},

34565

{

34566

"name": "ycoord",

34567

"description": "The y-coordinate representing the data point for the marker.",

34568

"type": "Number"

34569

},

34570

{

34571

"name": "calculatedSize",

34572

"description": "The calculated size for the marker. For a `BarSeries` is it the width. For a `ColumnSeries` it is the height.",

34573

"type": "Number"

34574

},

34575

{

34576

"name": "offset",

34577

"description": "Distance of position offset dictated by other marker series in the same graph.",

34578

"type": "Number"

34579

}

34580

],

34581

"return": {

34582

"description": "Object"

34583

},

34584

"access": "private",

34585

"tagname": "",

34586

"class": "BarSeries",

34587

"module": "charts"

34588

},

34589

{

34590

"file": "charts/js/BarSeries.js",

34591

"line": 42,

34592

"description": "Resizes and positions markers based on a mouse interaction.",

34593

"itemtype": "method",

34594

"name": "updateMarkerState",

34595

"params": [

34596

{

34597

"name": "type",

34598

"description": "state of the marker",

34599

"type": "String"

34600

},

34601

{

34602

"name": "i",

34603

"description": "index of the marker",

34604

"type": "Number"

34605

}

34606

],

34607

"access": "protected",

34608

"tagname": "",

34609

"class": "BarSeries",

34610

"module": "charts"

34611

},

34612

{

34613

"file": "charts/js/BarSeries.js",

34614

"line": 106,

34615

"description": "Read-only attribute indicating the type of series.",

34616

"itemtype": "attribute",

34617

"name": "type",

34618

"type": "String",

34619

"default": "bar",

34620

"class": "BarSeries",

34621

"module": "charts"

34622

},

34623

{

34624

"file": "charts/js/BarSeries.js",

34625

"line": 117,

34626

"description": "Indicates the direction of the category axis that the bars are plotted against.",

34627

"itemtype": "attribute",

34628

"name": "direction",

34629

"type": "String",

34630

"class": "BarSeries",

34631

"module": "charts"

34632

},

34633

{

34634

"file": "charts/js/BarSeries.js",

34635

"line": 127,

34636

"description": "Style properties used for drawing markers. This attribute is inherited from `MarkerSeries`. Below are the default values:\n <dl>\n <dt>fill</dt><dd>A hash containing the following values:\n <dl>\n <dt>color</dt><dd>Color of the fill. The default value is determined by the order of the series on the graph. The color\n will be retrieved from the below array: \n `[\"#66007f\", \"#a86f41\", \"#295454\", \"#996ab2\", \"#e8cdb7\", \"#90bdbd\",\"#000000\",\"#c3b8ca\", \"#968373\", \"#678585\"]`\n </dd>\n <dt>alpha</dt><dd>Number from 0 to 1 indicating the opacity of the marker fill. The default value is 1.</dd>\n </dl>\n </dd>\n <dt>border</dt><dd>A hash containing the following values:\n <dl>\n <dt>color</dt><dd>Color of the border. The default value is determined by the order of the series on the graph. The color\n will be retrieved from the below array: \n `[\"#205096\", \"#b38206\", \"#000000\", \"#94001e\", \"#9d6fa0\", \"#e55b00\", \"#5e85c9\", \"#adab9e\", \"#6ac291\", \"#006457\"]`\n <dt>alpha</dt><dd>Number from 0 to 1 indicating the opacity of the marker border. The default value is 1.</dd>\n <dt>weight</dt><dd>Number indicating the width of the border. The default value is 1.</dd>\n </dl>\n </dd>\n <dt>height</dt><dd>indicates the width of the marker. The default value is 12.</dd>\n <dt>over</dt><dd>hash containing styles for markers when highlighted by a `mouseover` event. The default \n values for each style is null. When an over style is not set, the non-over value will be used. For example,\n the default value for `marker.over.fill.color` is equivalent to `marker.fill.color`.</dd>\n </dl>",

34637

"itemtype": "attribute",

34638

"name": "styles",

34639

"type": "Object",

34640

"class": "BarSeries",

34641

"module": "charts"

34642

},

34643

{

34644

"file": "charts/js/BottomAxisLayout.js",

34645

"line": 11,

34646

"description": "Default margins for text fields.",

34647

"access": "private",

34648

"tagname": "",

34649

"itemtype": "method",

34650

"name": "_getDefaultMargins",

34651

"return": {

34652

"description": "Object"

34653

},

34654

"class": "BottomAxisLayout",

34655

"module": "charts"

34656

},

34657

{

34658

"file": "charts/js/BottomAxisLayout.js",

34659

"line": 28,

34660

"description": "Sets the length of the tick on either side of the axis line.",

34661

"itemtype": "method",

34662

"name": "setTickOffsets",

34663

"access": "protected",

34664

"tagname": "",

34665

"class": "BottomAxisLayout",

34666

"module": "charts"

34667

},

34668

{

34669

"file": "charts/js/BottomAxisLayout.js",

34670

"line": 65,

34671

"description": "Calculates the coordinates for the first point on an axis.",

34672

"itemtype": "method",

34673

"name": "getLineStart",

34674

"access": "protected",

34675

"tagname": "",

34676

"class": "BottomAxisLayout",

34677

"module": "charts"

34678

},

34679

{

34680

"file": "charts/js/BottomAxisLayout.js",

34681

"line": 90,

34682

"description": "Draws a tick",

34683

"itemtype": "method",

34684

"name": "drawTick",

34685

"params": [

34686

{

34687

"name": "path",

34688

"description": "reference to the path `Path` element in which to draw the tick.",

34689

"type": "Path"

34690

},

34691

{

34692

"name": "pt",

34693

"description": "hash containing x and y coordinates",

34694

"type": "Object"

34695

},

34696

{

34697

"name": "tickStyles",

34698

"description": "hash of properties used to draw the tick",

34699

"type": "Object"

34700

}

34701

],

34702

"access": "protected",

34703

"tagname": "",

34704

"class": "BottomAxisLayout",

34705

"module": "charts"

34706

},

34707

{

34708

"file": "charts/js/BottomAxisLayout.js",

34709

"line": 110,

34710

"description": "Calculates the point for a label.",

34711

"itemtype": "method",

34712

"name": "getLabelPoint",

34713

"params": [

34714

{

34715

"name": "pt",

34716

"description": "Object containing x and y coordinates",

34717

"type": "Object"

34718

}

34719

],

34720

"return": {

34721

"description": "Object"

34722

},

34723

"access": "protected",

34724

"tagname": "",

34725

"class": "BottomAxisLayout",

34726

"module": "charts"

34727

},

34728

{

34729

"file": "charts/js/BottomAxisLayout.js",

34730

"line": 123,

34731

"description": "Updates the value for the `maxLabelSize` for use in calculating total size.",

34732

"itemtype": "method",

34733

"name": "updateMaxLabelSize",

34734

"params": [

34735

{

34736

"name": "label",

34737

"description": "to measure",

34738

"type": "HTMLElement"

34739

}

34740

],

34741

"access": "protected",

34742

"tagname": "",

34743

"class": "BottomAxisLayout",

34744

"module": "charts"

34745

},

34746

{

34747

"file": "charts/js/BottomAxisLayout.js",

34748

"line": 154,

34749

"description": "Determines the available label height when the axis width has been explicitly set.",

34750

"itemtype": "method",

34751

"name": "getExplicitlySized",

34752

"return": {

34753

"description": "Boolean"

34754

},

34755

"access": "protected",

34756

"tagname": "",

34757

"class": "BottomAxisLayout",

34758

"module": "charts"

34759

},

34760

{

34761

"file": "charts/js/BottomAxisLayout.js",

34762

"line": 176,

34763

"description": "Rotate and position title.",

34764

"itemtype": "method",

34765

"name": "positionTitle",

34766

"params": [

34767

{

34768

"name": "label",

34769

"description": "to rotate position",

34770

"type": "HTMLElement"

34771

}

34772

],

34773

"access": "protected",

34774

"tagname": "",

34775

"class": "BottomAxisLayout",

34776

"module": "charts"

34777

},

34778

{

34779

"file": "charts/js/BottomAxisLayout.js",

34780

"line": 206,

34781

"description": "Rotate and position labels.",

34782

"itemtype": "method",

34783

"name": "positionLabel",

34784

"params": [

34785

{

34786

"name": "label",

34787

"description": "to rotate position",

34788

"type": "HTMLElement"

34789

},

34790

{

34791

"name": "pt",

34792

"description": "hash containing the x and y coordinates in which the label will be positioned\nagainst.",

34793

"type": "Object"

34794

}

34795

],

34796

"access": "protected",

34797

"tagname": "",

34798

"class": "BottomAxisLayout",

34799

"module": "charts"

34800

},

34801

{

34802

"file": "charts/js/BottomAxisLayout.js",

34803

"line": 254,

34804

"description": "Adjusts the coordinates of an axis label based on the rotation.",

34805

"itemtype": "method",

34806

"name": "_setRotationCoords",

34807

"params": [

34808

{

34809

"name": "props",

34810

"description": "Coordinates, dimension and rotation properties of the label.",

34811

"type": "Object"

34812

}

34813

],

34814

"access": "protected",

34815

"tagname": "",

34816

"class": "BottomAxisLayout",

34817

"module": "charts"

34818

},

34819

{

34820

"file": "charts/js/BottomAxisLayout.js",

34821

"line": 289,

34822

"description": "Returns the transformOrigin to use for an axis label based on the position of the axis \nand the rotation of the label.",

34823

"itemtype": "method",

34824

"name": "_getTransformOrigin",

34825

"params": [

34826

{

34827

"name": "rot",

34828

"description": "The rotation (in degrees) of the label.",

34829

"type": "Number"

34830

}

34831

],

34832

"return": {

34833

"description": "Array"

34834

},

34835

"access": "protected",

34836

"tagname": "",

34837

"class": "BottomAxisLayout",

34838

"module": "charts"

34839

},

34840

{

34841

"file": "charts/js/BottomAxisLayout.js",

34842

"line": 316,

34843

"description": "Adjusts position for inner ticks.",

34844

"itemtype": "method",

34845

"name": "offsetNodeForTick",

34846

"params": [

34847

{

34848

"name": "cb",

34849

"description": "contentBox of the axis",

34850

"type": "Node"

34851

}

34852

],

34853

"access": "protected",

34854

"tagname": "",

34855

"class": "BottomAxisLayout",

34856

"module": "charts"

34857

},

34858

{

34859

"file": "charts/js/BottomAxisLayout.js",

34860

"line": 329,

34861

"description": "Assigns a height based on the size of the contents.",

34862

"itemtype": "method",

34863

"name": "setCalculatedSize",

34864

"access": "protected",

34865

"tagname": "",

34866

"class": "BottomAxisLayout",

34867

"module": "charts"

34868

},

34869

{

34870

"file": "charts/js/CartesianChart.js",

34871

"line": 10,

34872

"itemtype": "method",

34873

"name": "renderUI",

34874

"access": "private",

34875

"tagname": "",

34876

"class": "CartesianChart",

34877

"module": "charts"

34878

},

34879

{

34880

"file": "charts/js/CartesianChart.js",

34881

"line": 48,

34882

"description": "When `interactionType` is set to `planar`, listens for mouse move events and fires `planarEvent:mouseover` or `planarEvent:mouseout` depending on the position of the mouse in relation to \ndata points on the `Chart`.",

34883

"itemtype": "method",

34884

"name": "_planarEventDispatcher",

34885

"params": [

34886

{

34887

"name": "e",

34888

"description": "Event object.",

34889

"type": "Object"

34890

}

34891

],

34892

"access": "private",

34893

"tagname": "",

34894

"class": "CartesianChart",

34895

"module": "charts"

34896

},

34897

{

34898

"file": "charts/js/CartesianChart.js",

34899

"line": 148,

34900

"description": "Broadcasts when `interactionType` is set to `planar` and a series' marker plane has received a mouseover event.",

34901

"itemtype": "event",

34902

"name": "planarEvent:mouseover",

34903

"preventable": "false",

34904

"params": [

34905

{

34906

"name": "e",

34907

"description": "Event facade with the following additional\n properties:\n <dl>\n <dt>categoryItem</dt><dd>An array of hashes, each containing information about the category `Axis` of each marker whose plane has been intersected.</dd>\n <dt>valueItem</dt><dd>An array of hashes, each containing information about the value `Axis` of each marker whose plane has been intersected.</dd>\n <dt>x</dt><dd>The x-coordinate of the mouse in relation to the Chart.</dd>\n <dt>y</dt><dd>The y-coordinate of the mouse in relation to the Chart.</dd>\n <dt>pageX</dt><dd>The x location of the event on the page (including scroll)</dd>\n <dt>pageY</dt><dd>The y location of the event on the page (including scroll)</dd>\n <dt>items</dt><dd>An array including all the series which contain a marker whose plane has been intersected.</dd>\n <dt>index</dt><dd>Index of the markers in their respective series.</dd>\n <dt>originEvent</dt><dd>Underlying dom event.</dd>\n </dl>",

34908

"type": "EventFacade"

34909

}

34910

],

34911

"class": "CartesianChart",

34912

"module": "charts"

34913

},

34914

{

34915

"file": "charts/js/CartesianChart.js",

34916

"line": 168,

34917

"description": "Broadcasts when `interactionType` is set to `planar` and a series' marker plane has received a mouseout event.",

34918

"itemtype": "event",

34919

"name": "planarEvent:mouseout",

34920

"preventable": "false",

34921

"params": [

34922

{

34923

"name": "e",

34924

"description": "",

34925

"type": "EventFacade"

34926

}

34927

],

34928

"class": "CartesianChart",

34929

"module": "charts"

34930

},

34931

{

34932

"file": "charts/js/CartesianChart.js",

34933

"line": 196,

34934

"description": "Indicates the default series type for the chart.",

34935

"itemtype": "property",

34936

"name": "_type",

34937

"type": "{String}",

34938

"access": "private",

34939

"tagname": "",

34940

"class": "CartesianChart",

34941

"module": "charts"

34942

},

34943

{

34944

"file": "charts/js/CartesianChart.js",

34945

"line": 205,

34946

"description": "Queue of axes instances that will be updated. This method is used internally to determine when all axes have been updated.",

34947

"itemtype": "property",

34948

"name": "_itemRenderQueue",

34949

"type": "Array",

34950

"access": "private",

34951

"tagname": "",

34952

"class": "CartesianChart",

34953

"module": "charts"

34954

},

34955

{

34956

"file": "charts/js/CartesianChart.js",

34957

"line": 214,

34958

"description": "Adds an `Axis` instance to the `_itemRenderQueue`.",

34959

"itemtype": "method",

34960

"name": "_addToAxesRenderQueue",

34961

"params": [

34962

{

34963

"name": "axis",

34964

"description": "An `Axis` instance.",

34965

"type": "Axis"

34966

}

34967

],

34968

"access": "private",

34969

"tagname": "",

34970

"class": "CartesianChart",

34971

"module": "charts"

34972

},

34973

{

34974

"file": "charts/js/CartesianChart.js",

34975

"line": 233,

34976

"description": "Adds axis instance to the appropriate array based on position",

34977

"itemtype": "method",

34978

"name": "_addToAxesCollection",

34979

"params": [

34980

{

34981

"name": "position",

34982

"description": "The position of the axis",

34983

"type": "String"

34984

},

34985

{

34986

"name": "axis",

34987

"description": "The `Axis` instance",

34988

"type": "Axis"

34989

}

34990

],

34991

"class": "CartesianChart",

34992

"module": "charts"

34993

},

34994

{

34995

"file": "charts/js/CartesianChart.js",

34996

"line": 251,

34997

"description": "Returns the default value for the `seriesCollection` attribute.",

34998

"itemtype": "method",

34999

"name": "_getDefaultSeriesCollection",

35000

"params": [

35001

{

35002

"name": "val",

35003

"description": "Array containing either `CartesianSeries` instances or objects containing data to construct series instances.",

35004

"type": "Array"

35005

}

35006

],

35007

"return": {

35008

"description": "Array"

35009

},

35010

"access": "private",

35011

"tagname": "",

35012

"class": "CartesianChart",

35013

"module": "charts"

35014

},

35015

{

35016

"file": "charts/js/CartesianChart.js",

35017

"line": 264,

35018

"description": "Parses and returns a series collection from an object and default properties.",

35019

"itemtype": "method",

35020

"name": "_parseSeriesCollection",

35021

"params": [

35022

{

35023

"name": "val",

35024

"description": "Object contain properties for series being set.",

35025

"type": "Object"

35026

}

35027

],

35028

"return": {

35029

"description": "Object"

35030

},

35031

"access": "private",

35032

"tagname": "",

35033

"class": "CartesianChart",

35034

"module": "charts"

35035

},

35036

{

35037

"file": "charts/js/CartesianChart.js",

35038

"line": 368,

35039

"description": "Parse and sets the axes for a series instance.",

35040

"itemtype": "method",

35041

"name": "_parseSeriesAxes",

35042

"params": [

35043

{

35044

"name": "series",

35045

"description": "A `CartesianSeries` instance.",

35046

"type": "CartesianSeries"

35047

}

35048

],

35049

"access": "private",

35050

"tagname": "",

35051

"class": "CartesianChart",

35052

"module": "charts"

35053

},

35054

{

35055

"file": "charts/js/CartesianChart.js",

35056

"line": 401,

35057

"description": "Returns the category axis instance for the chart.",

35058

"itemtype": "method",

35059

"name": "_getCategoryAxis",

35060

"return": {

35061

"description": "Axis"

35062

},

35063

"access": "private",

35064

"tagname": "",

35065

"class": "CartesianChart",

35066

"module": "charts"

35067

},

35068

{

35069

"file": "charts/js/CartesianChart.js",

35070

"line": 417,

35071

"description": "Returns the value axis for a series.",

35072

"itemtype": "method",

35073

"name": "_getSeriesAxis",

35074

"params": [

35075

{

35076

"name": "key",

35077

"description": "The key value used to determine the axis instance.",

35078

"type": "String"

35079

}

35080

],

35081

"return": {

35082

"description": "Axis"

35083

},

35084

"access": "private",

35085

"tagname": "",

35086

"class": "CartesianChart",

35087

"module": "charts"

35088

},

35089

{

35090

"file": "charts/js/CartesianChart.js",

35091

"line": 456,

35092

"description": "Gets an attribute from an object, using a getter for Base objects and a property for object\nliterals. Used for determining attributes from series/axis references which can be an actual class instance\nor a hash of properties that will be used to create a class instance.",

35093

"itemtype": "method",

35094

"name": "_getBaseAttribute",

35095

"params": [

35096

{

35097

"name": "item",

35098

"description": "Object or instance in which the attribute resides.",

35099

"type": "Object"

35100

},

35101

{

35102

"name": "key",

35103

"description": "Attribute whose value will be returned.",

35104

"type": "String"

35105

}

35106

],

35107

"return": {

35108

"description": "Object"

35109

},

35110

"access": "private",

35111

"tagname": "",

35112

"class": "CartesianChart",

35113

"module": "charts"

35114

},

35115

{

35116

"file": "charts/js/CartesianChart.js",

35117

"line": 480,

35118

"description": "Sets an attribute on an object, using a setter of Base objects and a property for object\nliterals. Used for setting attributes on a Base class, either directly or to be stored in an object literal\nfor use at instantiation.",

35119

"itemtype": "method",

35120

"name": "_setBaseAttribute",

35121

"params": [

35122

{

35123

"name": "item",

35124

"description": "Object or instance in which the attribute resides.",

35125

"type": "Object"

35126

},

35127

{

35128

"name": "key",

35129

"description": "Attribute whose value will be assigned.",

35130

"type": "String"

35131

},

35132

{

35133

"name": "value",

35134

"description": "Value to be assigned to the attribute.",

35135

"type": "Object"

35136

}

35137

],

35138

"access": "private",

35139

"tagname": "",

35140

"class": "CartesianChart",

35141

"module": "charts"

35142

},

35143

{

35144

"file": "charts/js/CartesianChart.js",

35145

"line": 503,

35146

"description": "Creates `Axis` instances.",

35147

"itemtype": "method",

35148

"name": "_setAxes",

35149

"params": [

35150

{

35151

"name": "val",

35152

"description": "Object containing `Axis` instances or objects in which to construct `Axis` instances.",

35153

"type": "Object"

35154

}

35155

],

35156

"return": {

35157

"description": "Object"

35158

},

35159

"access": "private",

35160

"tagname": "",

35161

"class": "CartesianChart",

35162

"module": "charts"

35163

},

35164

{

35165

"file": "charts/js/CartesianChart.js",

35166

"line": 619,

35167

"description": "Adds axes to the chart.",

35168

"itemtype": "method",

35169

"name": "_addAxes",

35170

"access": "private",

35171

"tagname": "",

35172

"class": "CartesianChart",

35173

"module": "charts"

35174

},

35175

{

35176

"file": "charts/js/CartesianChart.js",

35177

"line": 676,

35178

"description": "Renders the Graph.",

35179

"itemtype": "method",

35180

"name": "_addSeries",

35181

"access": "private",

35182

"tagname": "",

35183

"class": "CartesianChart",

35184

"module": "charts"

35185

},

35186

{

35187

"file": "charts/js/CartesianChart.js",

35188

"line": 690,

35189

"description": "Adds gridlines to the chart.",

35190

"itemtype": "method",

35191

"name": "_addGridlines",

35192

"access": "private",

35193

"tagname": "",

35194

"class": "CartesianChart",

35195

"module": "charts"

35196

},

35197

{

35198

"file": "charts/js/CartesianChart.js",

35199

"line": 763,

35200

"description": "Returns all the keys contained in a `dataProvider`.",

35201

"itemtype": "method",

35202

"name": "_getAllKeys",

35203

"params": [

35204

{

35205

"name": "dp",

35206

"description": "Collection of objects to be parsed.",

35207

"type": "Array"

35208

}

35209

],

35210

"return": {

35211

"description": "Object"

35212

},

35213

"class": "CartesianChart",

35214

"module": "charts"

35215

},

35216

{

35217

"file": "charts/js/CartesianChart.js",

35218

"line": 791,

35219

"description": "Default Function for the axes attribute.",

35220

"itemtype": "method",

35221

"name": "_getDefaultAxes",

35222

"return": {

35223

"description": "Object"

35224

},

35225

"access": "private",

35226

"tagname": "",

35227

"class": "CartesianChart",

35228

"module": "charts"

35229

},

35230

{

35231

"file": "charts/js/CartesianChart.js",

35232

"line": 803,

35233

"description": "Generates and returns a key-indexed object containing `Axis` instances or objects used to create `Axis` instances.",

35234

"itemtype": "method",

35235

"name": "_parseAxes",

35236

"params": [

35237

{

35238

"name": "axes",

35239

"description": "Object containing `Axis` instances or `Axis` attributes.",

35240

"type": "Object"

35241

}

35242

],

35243

"return": {

35244

"description": "Object"

35245

},

35246

"access": "private",

35247

"tagname": "",

35248

"class": "CartesianChart",

35249

"module": "charts"

35250

},

35251

{

35252

"file": "charts/js/CartesianChart.js",

35253

"line": 970,

35254

"description": "Determines the position of an axis when one is not specified.",

35255

"itemtype": "method",

35256

"name": "_getDefaultAxisPosition",

35257

"params": [

35258

{

35259

"name": "axis",

35260

"description": "`Axis` instance.",

35261

"type": "Axis"

35262

},

35263

{

35264

"name": "valueAxes",

35265

"description": "Array of `Axis` instances.",

35266

"type": "Array"

35267

},

35268

{

35269

"name": "position",

35270

"description": "Default position depending on the direction of the chart and type of axis.",

35271

"type": "String"

35272

}

35273

],

35274

"return": {

35275

"description": "String"

35276

},

35277

"access": "private",

35278

"tagname": "",

35279

"class": "CartesianChart",

35280

"module": "charts"

35281

},

35282

{

35283

"file": "charts/js/CartesianChart.js",

35284

"line": 1014,

35285

"description": "Returns an object literal containing a categoryItem and a valueItem for a given series index. Below is the structure of each:",

35286

"itemtype": "method",

35287

"name": "getSeriesItems",

35288

"params": [

35289

{

35290

"name": "series",

35291

"description": "Reference to a series.",

35292

"type": "CartesianSeries"

35293

},

35294

{

35295

"name": "index",

35296

"description": "Index of the specified item within a series.",

35297

"type": "Number"

35298

}

35299

],

35300

"return": {

35301

"description": "Object An object literal containing the following:\n\n <dl>\n <dt>categoryItem</dt><dd>Object containing the following data related to the category axis of the series.\n <dl>\n <dt>axis</dt><dd>Reference to the category axis of the series.</dd>\n <dt>key</dt><dd>Category key for the series.</dd>\n <dt>value</dt><dd>Value on the axis corresponding to the series index.</dd>\n </dl>\n </dd>\n <dt>valueItem</dt><dd>Object containing the following data related to the category axis of the series.\n <dl>\n <dt>axis</dt><dd>Reference to the value axis of the series.</dd>\n <dt>key</dt><dd>Value key for the series.</dd>\n <dt>value</dt><dd>Value on the axis corresponding to the series index.</dd>\n </dl>\n </dd>\n </dl>"

35302

},

35303

"class": "CartesianChart",

35304

"module": "charts"

35305

},

35306

{

35307

"file": "charts/js/CartesianChart.js",

35308

"line": 1080,

35309

"description": "Handler for sizeChanged event.",

35310

"itemtype": "method",

35311

"name": "_sizeChanged",

35312

"params": [

35313

{

35314

"name": "e",

35315

"description": "Event object.",

35316

"type": "Object"

35317

}

35318

],

35319

"access": "private",

35320

"tagname": "",

35321

"class": "CartesianChart",

35322

"module": "charts"

35323

},

35324

{

35325

"file": "charts/js/CartesianChart.js",

35326

"line": 1102,

35327

"description": "Returns the maximum distance in pixels that the extends outside the top bounds of all vertical axes.",

35328

"itemtype": "method",

35329

"name": "_getTopOverflow",

35330

"params": [

35331

{

35332

"name": "set1",

35333

"description": "Collection of axes to check.",

35334

"type": "Array"

35335

},

35336

{

35337

"name": "set2",

35338

"description": "Seconf collection of axes to check.",

35339

"type": "Array"

35340

},

35341

{

35342

"name": "width",

35343

"description": "Width of the axes",

35344

"type": "Number"

35345

}

35346

],

35347

"return": {

35348

"description": "Number"

35349

},

35350

"access": "private",

35351

"tagname": "",

35352

"class": "CartesianChart",

35353

"module": "charts"

35354

},

35355

{

35356

"file": "charts/js/CartesianChart.js",

35357

"line": 1140,

35358

"description": "Returns the maximum distance in pixels that the extends outside the right bounds of all horizontal axes.",

35359

"itemtype": "method",

35360

"name": "_getRightOverflow",

35361

"params": [

35362

{

35363

"name": "set1",

35364

"description": "Collection of axes to check.",

35365

"type": "Array"

35366

},

35367

{

35368

"name": "set2",

35369

"description": "Seconf collection of axes to check.",

35370

"type": "Array"

35371

},

35372

{

35373

"name": "width",

35374

"description": "Width of the axes",

35375

"type": "Number"

35376

}

35377

],

35378

"return": {

35379

"description": "Number"

35380

},

35381

"access": "private",

35382

"tagname": "",

35383

"class": "CartesianChart",

35384

"module": "charts"

35385

},

35386

{

35387

"file": "charts/js/CartesianChart.js",

35388

"line": 1178,

35389

"description": "Returns the maximum distance in pixels that the extends outside the left bounds of all horizontal axes.",

35390

"itemtype": "method",

35391

"name": "_getLeftOverflow",

35392

"params": [

35393

{

35394

"name": "set1",

35395

"description": "Collection of axes to check.",

35396

"type": "Array"

35397

},

35398

{

35399

"name": "set2",

35400

"description": "Seconf collection of axes to check.",

35401

"type": "Array"

35402

},

35403

{

35404

"name": "width",

35405

"description": "Width of the axes",

35406

"type": "Number"

35407

}

35408

],

35409

"return": {

35410

"description": "Number"

35411

},

35412

"access": "private",

35413

"tagname": "",

35414

"class": "CartesianChart",

35415

"module": "charts"

35416

},

35417

{

35418

"file": "charts/js/CartesianChart.js",

35419

"line": 1216,

35420

"description": "Returns the maximum distance in pixels that the extends outside the bottom bounds of all vertical axes.",

35421

"itemtype": "method",

35422

"name": "_getBottomOverflow",

35423

"params": [

35424

{

35425

"name": "set1",

35426

"description": "Collection of axes to check.",

35427

"type": "Array"

35428

},

35429

{

35430

"name": "set2",

35431

"description": "Seconf collection of axes to check.",

35432

"type": "Array"

35433

},

35434

{

35435

"name": "height",

35436

"description": "Height of the axes",

35437

"type": "Number"

35438

}

35439

],

35440

"return": {

35441

"description": "Number"

35442

},

35443

"access": "private",

35444

"tagname": "",

35445

"class": "CartesianChart",

35446

"module": "charts"

35447

},

35448

{

35449

"file": "charts/js/CartesianChart.js",

35450

"line": 1254,

35451

"description": "Redraws and position all the components of the chart instance.",

35452

"itemtype": "method",

35453

"name": "_redraw",

35454

"access": "private",

35455

"tagname": "",

35456

"class": "CartesianChart",

35457

"module": "charts"

35458

},

35459

{

35460

"file": "charts/js/CartesianChart.js",

35461

"line": 1518,

35462

"description": "Destructor implementation for the CartesianChart class. Calls destroy on all axes, series and the Graph instance.\nRemoves the tooltip and overlay HTML elements.",

35463

"itemtype": "method",

35464

"name": "destructor",

35465

"access": "protected",

35466

"tagname": "",

35467

"class": "CartesianChart",

35468

"module": "charts"

35469

},

35470

{

35471

"file": "charts/js/CartesianChart.js",

35472

"line": 1575,

35473

"description": "Returns the appropriate message based on the key press.",

35474

"itemtype": "method",

35475

"name": "_getAriaMessage",

35476

"params": [

35477

{

35478

"name": "key",

35479

"description": "The keycode that was pressed.",

35480

"type": "Number"

35481

}

35482

],

35483

"return": {

35484

"description": "String"

35485

},

35486

"class": "CartesianChart",

35487

"module": "charts"

35488

},

35489

{

35490

"file": "charts/js/CartesianChart.js",

35491

"line": 1658,

35492

"description": "Indicates whether axis labels are allowed to overflow beyond the bounds of the chart's content box.",

35493

"itemtype": "attribute",

35494

"name": "allowContentOverflow",

35495

"type": "Boolean",

35496

"class": "CartesianChart",

35497

"module": "charts"

35498

},

35499

{

35500

"file": "charts/js/CartesianChart.js",

35501

"line": 1668,

35502

"description": "Style object for the axes.",

35503

"itemtype": "attribute",

35504

"name": "axesStyles",

35505

"type": "Object",

35506

"access": "private",

35507

"tagname": "",

35508

"class": "CartesianChart",

35509

"module": "charts"

35510

},

35511

{

35512

"file": "charts/js/CartesianChart.js",

35513

"line": 1712,

35514

"description": "Style object for the series",

35515

"itemtype": "attribute",

35516

"name": "seriesStyles",

35517

"type": "Object",

35518

"access": "private",

35519

"tagname": "",

35520

"class": "CartesianChart",

35521

"module": "charts"

35522

},

35523

{

35524

"file": "charts/js/CartesianChart.js",

35525

"line": 1775,

35526

"description": "Styles for the graph.",

35527

"itemtype": "attribute",

35528

"name": "graphStyles",

35529

"type": "Object",

35530

"access": "private",

35531

"tagname": "",

35532

"class": "CartesianChart",

35533

"module": "charts"

35534

},

35535

{

35536

"file": "charts/js/CartesianChart.js",

35537

"line": 1801,

35538

"description": "Style properties for the chart. Contains a key indexed hash of the following:\n <dl>\n <dt>series</dt><dd>A key indexed hash containing references to the `styles` attribute for each series in the chart.\n Specific style attributes vary depending on the series:\n <ul>\n <li><a href=\"AreaSeries.html#attr_styles\">AreaSeries</a></li>\n <li><a href=\"BarSeries.html#attr_styles\">BarSeries</a></li>\n <li><a href=\"ColumnSeries.html#attr_styles\">ColumnSeries</a></li>\n <li><a href=\"ComboSeries.html#attr_styles\">ComboSeries</a></li>\n <li><a href=\"LineSeries.html#attr_styles\">LineSeries</a></li>\n <li><a href=\"MarkerSeries.html#attr_styles\">MarkerSeries</a></li>\n <li><a href=\"SplineSeries.html#attr_styles\">SplineSeries</a></li>\n </ul>\n </dd>\n <dt>axes</dt><dd>A key indexed hash containing references to the `styles` attribute for each axes in the chart. Specific\n style attributes can be found in the <a href=\"Axis.html#attr_styles\">Axis</a> class.</dd>\n <dt>graph</dt><dd>A reference to the `styles` attribute in the chart. Specific style attributes can be found in the\n <a href=\"Graph.html#attr_styles\">Graph</a> class.</dd>\n </dl>",

35539

"itemtype": "attribute",

35540

"name": "styles",

35541

"type": "Object",

35542

"class": "CartesianChart",

35543

"module": "charts"

35544

},

35545

{

35546

"file": "charts/js/CartesianChart.js",

35547

"line": 1866,

35548

"description": "Axes to appear in the chart. This can be a key indexed hash of axis instances or object literals\nused to construct the appropriate axes.",

35549

"itemtype": "attribute",

35550

"name": "axes",

35551

"type": "Object",

35552

"class": "CartesianChart",

35553

"module": "charts"

35554

},

35555

{

35556

"file": "charts/js/CartesianChart.js",

35557

"line": 1882,

35558

"description": "Collection of series to appear on the chart. This can be an array of Series instances or object literals\nused to construct the appropriate series.",

35559

"itemtype": "attribute",

35560

"name": "seriesCollection",

35561

"type": "Array",

35562

"class": "CartesianChart",

35563

"module": "charts"

35564

},

35565

{

35566

"file": "charts/js/CartesianChart.js",

35567

"line": 1898,

35568

"description": "Reference to the left-aligned axes for the chart.",

35569

"itemtype": "attribute",

35570

"name": "leftAxesCollection",

35571

"type": "Array",

35572

"access": "private",

35573

"tagname": "",

35574

"class": "CartesianChart",

35575

"module": "charts"

35576

},

35577

{

35578

"file": "charts/js/CartesianChart.js",

35579

"line": 1907,

35580

"description": "Reference to the bottom-aligned axes for the chart.",

35581

"itemtype": "attribute",

35582

"name": "bottomAxesCollection",

35583

"type": "Array",

35584

"access": "private",

35585

"tagname": "",

35586

"class": "CartesianChart",

35587

"module": "charts"

35588

},

35589

{

35590

"file": "charts/js/CartesianChart.js",

35591

"line": 1916,

35592

"description": "Reference to the right-aligned axes for the chart.",

35593

"itemtype": "attribute",

35594

"name": "rightAxesCollection",

35595

"type": "Array",

35596

"access": "private",

35597

"tagname": "",

35598

"class": "CartesianChart",

35599

"module": "charts"

35600

},

35601

{

35602

"file": "charts/js/CartesianChart.js",

35603

"line": 1925,

35604

"description": "Reference to the top-aligned axes for the chart.",

35605

"itemtype": "attribute",

35606

"name": "topAxesCollection",

35607

"type": "Array",

35608

"access": "private",

35609

"tagname": "",

35610

"class": "CartesianChart",

35611

"module": "charts"

35612

},

35613

{

35614

"file": "charts/js/CartesianChart.js",

35615

"line": 1934,

35616

"description": "Indicates whether or not the chart is stacked.",

35617

"itemtype": "attribute",

35618

"name": "stacked",

35619

"type": "Boolean",

35620

"class": "CartesianChart",

35621

"module": "charts"

35622

},

35623

{

35624

"file": "charts/js/CartesianChart.js",

35625

"line": 1944,

35626

"description": "Direction of chart's category axis when there is no series collection specified. Charts can\nbe horizontal or vertical. When the chart type is column, the chart is horizontal.\nWhen the chart type is bar, the chart is vertical.",

35627

"itemtype": "attribute",

35628

"name": "direction",

35629

"type": "String",

35630

"class": "CartesianChart",

35631

"module": "charts"

35632

},

35633

{

35634

"file": "charts/js/CartesianChart.js",

35635

"line": 1974,

35636

"description": "Indicates whether or not an area is filled in a combo chart.",

35637

"itemtype": "attribute",

35638

"name": "showAreaFill",

35639

"type": "Boolean",

35640

"class": "CartesianChart",

35641

"module": "charts"

35642

},

35643

{

35644

"file": "charts/js/CartesianChart.js",

35645

"line": 1982,

35646

"description": "Indicates whether to display markers in a combo chart.",

35647

"itemtype": "attribute",

35648

"name": "showMarkers",

35649

"type": "Boolean",

35650

"class": "CartesianChart",

35651

"module": "charts"

35652

},

35653

{

35654

"file": "charts/js/CartesianChart.js",

35655

"line": 1990,

35656

"description": "Indicates whether to display lines in a combo chart.",

35657

"itemtype": "attribute",

35658

"name": "showLines",

35659

"type": "Boolean",

35660

"class": "CartesianChart",

35661

"module": "charts"

35662

},

35663

{

35664

"file": "charts/js/CartesianChart.js",

35665

"line": 1998,

35666

"description": "Indicates the key value used to identify a category axis in the `axes` hash. If\nnot specified, the categoryKey attribute value will be used.",

35667

"itemtype": "attribute",

35668

"name": "categoryAxisName",

35669

"type": "String",

35670

"class": "CartesianChart",

35671

"module": "charts"

35672

},

35673

{

35674

"file": "charts/js/CartesianChart.js",

35675

"line": 2008,

35676

"description": "Indicates the key value used to identify a the series axis when an axis not generated.",

35677

"itemtype": "attribute",

35678

"name": "valueAxisName",

35679

"type": "String",

35680

"class": "CartesianChart",

35681

"module": "charts"

35682

},

35683

{

35684

"file": "charts/js/CartesianChart.js",

35685

"line": 2018,

35686

"description": "Reference to the horizontalGridlines for the chart.",

35687

"itemtype": "attribute",

35688

"name": "horizontalGridlines",

35689

"type": "Gridlines",

35690

"class": "CartesianChart",

35691

"module": "charts"

35692

},

35693

{

35694

"file": "charts/js/CartesianChart.js",

35695

"line": 2052,

35696

"description": "Reference to the verticalGridlines for the chart.",

35697

"itemtype": "attribute",

35698

"name": "verticalGridlines",

35699

"type": "Gridlines",

35700

"class": "CartesianChart",

35701

"module": "charts"

35702

},

35703

{

35704

"file": "charts/js/CartesianChart.js",

35705

"line": 2086,

35706

"description": "Type of chart when there is no series collection specified.",

35707

"itemtype": "attribute",

35708

"name": "type",

35709

"type": "String",

35710

"class": "CartesianChart",

35711

"module": "charts"

35712

},

35713

{

35714

"file": "charts/js/CartesianChart.js",

35715

"line": 2123,

35716

"description": "Reference to the category axis used by the chart.",

35717

"itemtype": "attribute",

35718

"name": "categoryAxis",

35719

"type": "Axis",

35720

"class": "CartesianChart",

35721

"module": "charts"

35722

},

35723

{

35724

"file": "charts/js/CartesianChartLegend.js",

35725

"line": 56,

35726

"description": "Displays items horizontally in a legend.",

35727

"itemtype": "method",

35728

"name": "_positionLegendItems",

35729

"params": [

35730

{

35731

"name": "items",

35732

"description": "Array of items to display in the legend.",

35733

"type": "Array"

35734

},

35735

{

35736

"name": "maxWidth",

35737

"description": "The width of the largest item in the legend.",

35738

"type": "Number"

35739

},

35740

{

35741

"name": "maxHeight",

35742

"description": "The height of the largest item in the legend.",

35743

"type": "Number"

35744

},

35745

{

35746

"name": "totalWidth",

35747

"description": "The total width of all items in a legend.",

35748

"type": "Number"

35749

},

35750

{

35751

"name": "totalHeight",

35752

"description": "The total height of all items in a legend.",

35753

"type": "Number"

35754

},

35755

{

35756

"name": "padding",

35757

"description": "The left, top, right and bottom padding properties for the legend.",

35758

"type": "Number"

35759

},

35760

{

35761

"name": "horizontalGap",

35762

"description": "The horizontal distance between items in a legend.",

35763

"type": "Number"

35764

},

35765

{

35766

"name": "verticalGap",

35767

"description": "The vertical distance between items in a legend.",

35768

"type": "Number"

35769

},

35770

{

35771

"name": "hAlign",

35772

"description": "The horizontal alignment of the legend.",

35773

"type": "String"

35774

},

35775

{

35776

"name": "vAlign",

35777

"description": "The vertical alignment of the legend.",

35778

"type": "String"

35779

}

35780

],

35781

"access": "protected",

35782

"tagname": "",

35783

"class": "HorizontalLegendLayout",

35784

"module": "charts",

35785

"submodule": "charts-legend"

35786

},

35787

{

35788

"file": "charts/js/CartesianChartLegend.js",

35789

"line": 133,

35790

"description": "Creates row and total width arrays used for displaying multiple rows of\nlegend items based on the items, available width and horizontalGap for the legend.",

35791

"itemtype": "method",

35792

"name": "_setRowArrays",

35793

"params": [

35794

{

35795

"name": "items",

35796

"description": "Array of legend items to display in a legend.",

35797

"type": "Array"

35798

},

35799

{

35800

"name": "limit",

35801

"description": "Total available width for displaying items in a legend.",

35802

"type": "Number"

35803

},

35804

{

35805

"name": "horizontalGap",

35806

"description": "Horizontal distance between items in a legend.",

35807

"type": "Number"

35808

}

35809

],

35810

"access": "protected",

35811

"tagname": "",

35812

"class": "HorizontalLegendLayout",

35813

"module": "charts",

35814

"submodule": "charts-legend"

35815

},

35816

{

35817

"file": "charts/js/CartesianChartLegend.js",

35818

"line": 177,

35819

"description": "Returns the starting x-coordinate for a row of legend items.",

35820

"itemtype": "method",

35821

"name": "getStartPoint",

35822

"params": [

35823

{

35824

"name": "w",

35825

"description": "Width of the legend.",

35826

"type": "Number"

35827

},

35828

{

35829

"name": "totalWidth",

35830

"description": "Total width of all labels in the row.",

35831

"type": "Number"

35832

},

35833

{

35834

"name": "align",

35835

"description": "Horizontal alignment of items for the legend.",

35836

"type": "String"

35837

},

35838

{

35839

"name": "padding",

35840

"description": "Object contain left, top, right and bottom padding properties.",

35841

"type": "Object"

35842

}

35843

],

35844

"return": {

35845

"description": "Number"

35846

},

35847

"access": "protected",

35848

"tagname": "",

35849

"class": "HorizontalLegendLayout",

35850

"module": "charts",

35851

"submodule": "charts-legend"

35852

},

35853

{

35854

"file": "charts/js/CartesianChartLegend.js",

35855

"line": 215,

35856

"description": "Displays items vertically in a legend.",

35857

"itemtype": "method",

35858

"name": "_positionLegendItems",

35859

"params": [

35860

{

35861

"name": "items",

35862

"description": "Array of items to display in the legend.",

35863

"type": "Array"

35864

},

35865

{

35866

"name": "maxWidth",

35867

"description": "The width of the largest item in the legend.",

35868

"type": "Number"

35869

},

35870

{

35871

"name": "maxHeight",

35872

"description": "The height of the largest item in the legend.",

35873

"type": "Number"

35874

},

35875

{

35876

"name": "totalWidth",

35877

"description": "The total width of all items in a legend.",

35878

"type": "Number"

35879

},

35880

{

35881

"name": "totalHeight",

35882

"description": "The total height of all items in a legend.",

35883

"type": "Number"

35884

},

35885

{

35886

"name": "padding",

35887

"description": "The left, top, right and bottom padding properties for the legend.",

35888

"type": "Number"

35889

},

35890

{

35891

"name": "horizontalGap",

35892

"description": "The horizontal distance between items in a legend.",

35893

"type": "Number"

35894

},

35895

{

35896

"name": "verticalGap",

35897

"description": "The vertical distance between items in a legend.",

35898

"type": "Number"

35899

},

35900

{

35901

"name": "hAlign",

35902

"description": "The horizontal alignment of the legend.",

35903

"type": "String"

35904

},

35905

{

35906

"name": "vAlign",

35907

"description": "The vertical alignment of the legend.",

35908

"type": "String"

35909

}

35910

],

35911

"access": "protected",

35912

"tagname": "",

35913

"class": "VerticalLegendLayout",

35914

"module": "charts",

35915

"submodule": "charts-legend"

35916

},

35917

{

35918

"file": "charts/js/CartesianChartLegend.js",

35919

"line": 295,

35920

"description": "Creates column and total height arrays used for displaying multiple columns of\nlegend items based on the items, available height and verticalGap for the legend.",

35921

"itemtype": "method",

35922

"name": "_setColumnArrays",

35923

"params": [

35924

{

35925

"name": "items",

35926

"description": "Array of legend items to display in a legend.",

35927

"type": "Array"

35928

},

35929

{

35930

"name": "limit",

35931

"description": "Total available height for displaying items in a legend.",

35932

"type": "Number"

35933

},

35934

{

35935

"name": "verticalGap",

35936

"description": "Vertical distance between items in a legend.",

35937

"type": "Number"

35938

}

35939

],

35940

"access": "protected",

35941

"tagname": "",

35942

"class": "VerticalLegendLayout",

35943

"module": "charts",

35944

"submodule": "charts-legend"

35945

},

35946

{

35947

"file": "charts/js/CartesianChartLegend.js",

35948

"line": 339,

35949

"description": "Returns the starting y-coordinate for a column of legend items.",

35950

"itemtype": "method",

35951

"name": "getStartPoint",

35952

"params": [

35953

{

35954

"name": "h",

35955

"description": "Height of the legend.",

35956

"type": "Number"

35957

},

35958

{

35959

"name": "totalHeight",

35960

"description": "Total height of all labels in the column.",

35961

"type": "Number"

35962

},

35963

{

35964

"name": "align",

35965

"description": "Vertical alignment of items for the legend.",

35966

"type": "String"

35967

},

35968

{

35969

"name": "padding",

35970

"description": "Object contain left, top, right and bottom padding properties.",

35971

"type": "Object"

35972

}

35973

],

35974

"return": {

35975

"description": "Number"

35976

},

35977

"access": "protected",

35978

"tagname": "",

35979

"class": "VerticalLegendLayout",

35980

"module": "charts",

35981

"submodule": "charts-legend"

35982

},

35983

{

35984

"file": "charts/js/CartesianChartLegend.js",

35985

"line": 370,

35986

"description": "Redraws and position all the components of the chart instance.",

35987

"itemtype": "method",

35988

"name": "_redraw",

35989

"access": "private",

35990

"tagname": "",

35991

"class": "VerticalLegendLayout",

35992

"module": "charts",

35993

"submodule": "charts-legend"

35994

},

35995

{

35996

"file": "charts/js/CartesianChartLegend.js",

35997

"line": 662,

35998

"description": "Positions the legend in a chart and returns the properties of the legend to be used in the \nchart's layout algorithm.",

35999

"itemtype": "method",

36000

"name": "_getLayoutDimensions",

36001

"return": {

36002

"description": "The left, top, right and bottom values for the legend.",

36003

"type": "Object"

36004

},

36005

"access": "protected",

36006

"tagname": "",

36007

"class": "VerticalLegendLayout",

36008

"module": "charts",

36009

"submodule": "charts-legend"

36010

},

36011

{

36012

"file": "charts/js/CartesianChartLegend.js",

36013

"line": 716,

36014

"description": "Destructor implementation for the CartesianChart class. Calls destroy on all axes, series, legend (if available) and the Graph instance.\nRemoves the tooltip and overlay HTML elements.",

36015

"itemtype": "method",

36016

"name": "destructor",

36017

"access": "protected",

36018

"tagname": "",

36019

"class": "VerticalLegendLayout",

36020

"module": "charts",

36021

"submodule": "charts-legend"

36022

},

36023

{

36024

"file": "charts/js/CartesianSeries.js",

36025

"line": 11,

36026

"description": "Storage for `xDisplayName` attribute.",

36027

"itemtype": "property",

36028

"name": "_xDisplayName",

36029

"type": "String",

36030

"access": "private",

36031

"tagname": "",

36032

"class": "CartesianSeries",

36033

"module": "charts"

36034

},

36035

{

36036

"file": "charts/js/CartesianSeries.js",

36037

"line": 20,

36038

"description": "Storage for `yDisplayName` attribute.",

36039

"itemtype": "property",

36040

"name": "_yDisplayName",

36041

"type": "String",

36042

"access": "private",

36043

"tagname": "",

36044

"class": "CartesianSeries",

36045

"module": "charts"

36046

},

36047

{

36048

"file": "charts/js/CartesianSeries.js",

36049

"line": 29,

36050

"description": "Th x-coordinate for the left edge of the series.",

36051

"itemtype": "property",

36052

"name": "_leftOrigin",

36053

"type": "String",

36054

"access": "private",

36055

"tagname": "",

36056

"class": "CartesianSeries",

36057

"module": "charts"

36058

},

36059

{

36060

"file": "charts/js/CartesianSeries.js",

36061

"line": 38,

36062

"description": "The y-coordinate for the bottom edge of the series.",

36063

"itemtype": "property",

36064

"name": "_bottomOrigin",

36065

"type": "String",

36066

"access": "private",

36067

"tagname": "",

36068

"class": "CartesianSeries",

36069

"module": "charts"

36070

},

36071

{

36072

"file": "charts/js/CartesianSeries.js",

36073

"line": 47,

36074

"itemtype": "method",

36075

"name": "render",

36076

"access": "private",

36077

"tagname": "",

36078

"class": "CartesianSeries",

36079

"module": "charts"

36080

},

36081

{

36082

"file": "charts/js/CartesianSeries.js",

36083

"line": 59,

36084

"description": "Adds event listeners.",

36085

"itemtype": "method",

36086

"name": "addListeners",

36087

"access": "private",

36088

"tagname": "",

36089

"class": "CartesianSeries",

36090

"module": "charts"

36091

},

36092

{

36093

"file": "charts/js/CartesianSeries.js",

36094

"line": 105,

36095

"description": "Event handler for the xAxisChange event.",

36096

"itemtype": "method",

36097

"name": "_xAxisChangeHandler",

36098

"params": [

36099

{

36100

"name": "e",

36101

"description": "Event object.",

36102

"type": "Object"

36103

}

36104

],

36105

"access": "private",

36106

"tagname": "",

36107

"class": "CartesianSeries",

36108

"module": "charts"

36109

},

36110

{

36111

"file": "charts/js/CartesianSeries.js",

36112

"line": 119,

36113

"description": "Event handler the yAxisChange event.",

36114

"itemtype": "method",

36115

"name": "_yAxisChangeHandler",

36116

"params": [

36117

{

36118

"name": "e",

36119

"description": "Event object.",

36120

"type": "Object"

36121

}

36122

],

36123

"access": "private",

36124

"tagname": "",

36125

"class": "CartesianSeries",

36126

"module": "charts"

36127

},

36128

{

36129

"file": "charts/js/CartesianSeries.js",

36130

"line": 133,

36131

"description": "Constant used to generate unique id.",

36132

"itemtype": "property",

36133

"name": "GUID",

36134

"type": "String",

36135

"access": "private",

36136

"tagname": "",

36137

"class": "CartesianSeries",

36138

"module": "charts"

36139

},

36140

{

36141

"file": "charts/js/CartesianSeries.js",

36142

"line": 142,

36143

"description": "Event handler for xDataChange event.",

36144

"itemtype": "method",

36145

"name": "_xDataChangeHandler",

36146

"params": [

36147

{

36148

"name": "event",

36149

"description": "Event object.",

36150

"type": "Object"

36151

}

36152

],

36153

"access": "private",

36154

"tagname": "",

36155

"class": "CartesianSeries",

36156

"module": "charts"

36157

},

36158

{

36159

"file": "charts/js/CartesianSeries.js",

36160

"line": 158,

36161

"description": "Event handler for yDataChange event.",

36162

"itemtype": "method",

36163

"name": "_yDataChangeHandler",

36164

"params": [

36165

{

36166

"name": "event",

36167

"description": "Event object.",

36168

"type": "Object"

36169

}

36170

],

36171

"access": "private",

36172

"tagname": "",

36173

"class": "CartesianSeries",

36174

"module": "charts"

36175

},

36176

{

36177

"file": "charts/js/CartesianSeries.js",

36178

"line": 174,

36179

"description": "Checks to ensure that both xAxis and yAxis data are available. If so, set the `xData` and `yData` attributes and return `true`. Otherwise, return `false`.",

36180

"itemtype": "method",

36181

"name": "_updateAxisData",

36182

"return": {

36183

"description": "Boolean"

36184

},

36185

"access": "private",

36186

"tagname": "",

36187

"class": "CartesianSeries",

36188

"module": "charts"

36189

},

36190

{

36191

"file": "charts/js/CartesianSeries.js",

36192

"line": 204,

36193

"description": "Draws the series is the xAxis and yAxis data are both available.",

36194

"itemtype": "method",

36195

"name": "validate",

36196

"access": "private",

36197

"tagname": "",

36198

"class": "CartesianSeries",

36199

"module": "charts"

36200

},

36201

{

36202

"file": "charts/js/CartesianSeries.js",

36203

"line": 222,

36204

"description": "Creates a `Graphic` instance.",

36205

"itemtype": "method",

36206

"name": "_setCanvas",

36207

"access": "protected",

36208

"tagname": "",

36209

"class": "CartesianSeries",

36210

"module": "charts"

36211

},

36212

{

36213

"file": "charts/js/CartesianSeries.js",

36214

"line": 235,

36215

"description": "Calculates the coordinates for the series.",

36216

"itemtype": "method",

36217

"name": "setAreaData",

36218

"access": "protected",

36219

"tagname": "",

36220

"class": "CartesianSeries",

36221

"module": "charts"

36222

},

36223

{

36224

"file": "charts/js/CartesianSeries.js",

36225

"line": 321,

36226

"description": "Draws the series.",

36227

"itemtype": "method",

36228

"name": "draw",

36229

"access": "protected",

36230

"tagname": "",

36231

"class": "CartesianSeries",

36232

"module": "charts"

36233

},

36234

{

36235

"file": "charts/js/CartesianSeries.js",

36236

"line": 362,

36237

"description": "Default value for plane offsets when the parent chart's `interactiveType` is `planar`.",

36238

"itemtype": "property",

36239

"name": "_defaultPlaneOffset",

36240

"type": "Number",

36241

"access": "private",

36242

"tagname": "",

36243

"class": "CartesianSeries",

36244

"module": "charts"

36245

},

36246

{

36247

"file": "charts/js/CartesianSeries.js",

36248

"line": 371,

36249

"description": "Gets the default value for the `styles` attribute. Overrides\nbase implementation.",

36250

"itemtype": "method",

36251

"name": "_getDefaultStyles",

36252

"return": {

36253

"description": "Object"

36254

},

36255

"access": "protected",

36256

"tagname": "",

36257

"class": "CartesianSeries",

36258

"module": "charts"

36259

},

36260

{

36261

"file": "charts/js/CartesianSeries.js",

36262

"line": 389,

36263

"description": "Collection of default colors used for lines in a series when not specified by user.",

36264

"itemtype": "property",

36265

"name": "_defaultLineColors",

36266

"type": "Array",

36267

"access": "protected",

36268

"tagname": "",

36269

"class": "CartesianSeries",

36270

"module": "charts"

36271

},

36272

{

36273

"file": "charts/js/CartesianSeries.js",

36274

"line": 398,

36275

"description": "Collection of default colors used for marker fills in a series when not specified by user.",

36276

"itemtype": "property",

36277

"name": "_defaultFillColors",

36278

"type": "Array",

36279

"access": "protected",

36280

"tagname": "",

36281

"class": "CartesianSeries",

36282

"module": "charts"

36283

},

36284

{

36285

"file": "charts/js/CartesianSeries.js",

36286

"line": 407,

36287

"description": "Collection of default colors used for marker borders in a series when not specified by user.",

36288

"itemtype": "property",

36289

"name": "_defaultBorderColors",

36290

"type": "Array",

36291

"access": "protected",

36292

"tagname": "",

36293

"class": "CartesianSeries",

36294

"module": "charts"

36295

},

36296

{

36297

"file": "charts/js/CartesianSeries.js",

36298

"line": 416,

36299

"description": "Collection of default colors used for area fills, histogram fills and pie fills in a series when not specified by user.",

36300

"itemtype": "property",

36301

"name": "_defaultSliceColors",

36302

"type": "Array",

36303

"access": "protected",

36304

"tagname": "",

36305

"class": "CartesianSeries",

36306

"module": "charts"

36307

},

36308

{

36309

"file": "charts/js/CartesianSeries.js",

36310

"line": 425,

36311

"description": "Parses a color based on a series order and type.",

36312

"itemtype": "method",

36313

"name": "_getDefaultColor",

36314

"params": [

36315

{

36316

"name": "index",

36317

"description": "Index indicating the series order.",

36318

"type": "Number"

36319

},

36320

{

36321

"name": "type",

36322

"description": "Indicates which type of object needs the color.",

36323

"type": "String"

36324

}

36325

],

36326

"return": {

36327

"description": "String"

36328

},

36329

"access": "protected",

36330

"tagname": "",

36331

"class": "CartesianSeries",

36332

"module": "charts"

36333

},

36334

{

36335

"file": "charts/js/CartesianSeries.js",

36336

"line": 453,

36337

"description": "Shows/hides contents of the series.",

36338

"itemtype": "method",

36339

"name": "_handleVisibleChange",

36340

"params": [

36341

{

36342

"name": "e",

36343

"description": "Event object.",

36344

"type": "Object"

36345

}

36346

],

36347

"access": "protected",

36348

"tagname": "",

36349

"class": "CartesianSeries",

36350

"module": "charts"

36351

},

36352

{

36353

"file": "charts/js/CartesianSeries.js",

36354

"line": 465,

36355

"description": "Returns the sum of all values for the series.",

36356

"itemtype": "method",

36357

"name": "getTotalValues",

36358

"return": {

36359

"description": "Number"

36360

},

36361

"class": "CartesianSeries",

36362

"module": "charts"

36363

},

36364

{

36365

"file": "charts/js/CartesianSeries.js",

36366

"line": 477,

36367

"description": "Destructor implementation for the CartesianSeries class. Calls destroy on all Graphic instances.",

36368

"itemtype": "method",

36369

"name": "destructor",

36370

"access": "protected",

36371

"tagname": "",

36372

"class": "CartesianSeries",

36373

"module": "charts"

36374

},

36375

{

36376

"file": "charts/js/CartesianSeries.js",

36377

"line": 501,

36378

"description": "Name used for for displaying data related to the x-coordinate.",

36379

"itemtype": "attribute",

36380

"name": "xDisplayName",

36381

"type": "String",

36382

"class": "CartesianSeries",

36383

"module": "charts"

36384

},

36385

{

36386

"file": "charts/js/CartesianSeries.js",

36387

"line": 520,

36388

"description": "Name used for for displaying data related to the y-coordinate.",

36389

"itemtype": "attribute",

36390

"name": "yDisplayName",

36391

"type": "String",

36392

"class": "CartesianSeries",

36393

"module": "charts"

36394

},

36395

{

36396

"file": "charts/js/CartesianSeries.js",

36397

"line": 539,

36398

"description": "Name used for for displaying category data",

36399

"itemtype": "attribute",

36400

"name": "categoryDisplayName",

36401

"type": "String",

36402

"readonly": "",

36403

"class": "CartesianSeries",

36404

"module": "charts"

36405

},

36406

{

36407

"file": "charts/js/CartesianSeries.js",

36408

"line": 555,

36409

"description": "Name used for for displaying value data",

36410

"itemtype": "attribute",

36411

"name": "valueDisplayName",

36412

"type": "String",

36413

"readonly": "",

36414

"class": "CartesianSeries",

36415

"module": "charts"

36416

},

36417

{

36418

"file": "charts/js/CartesianSeries.js",

36419

"line": 571,

36420

"description": "Read-only attribute indicating the type of series.",

36421

"itemtype": "attribute",

36422

"name": "type",

36423

"type": "String",

36424

"default": "cartesian",

36425

"class": "CartesianSeries",

36426

"module": "charts"

36427

},

36428

{

36429

"file": "charts/js/CartesianSeries.js",

36430

"line": 582,

36431

"description": "Order of this instance of this `type`.",

36432

"itemtype": "attribute",

36433

"name": "order",

36434

"type": "Number",

36435

"class": "CartesianSeries",

36436

"module": "charts"

36437

},

36438

{

36439

"file": "charts/js/CartesianSeries.js",

36440

"line": 590,

36441

"description": "Order of the instance",

36442

"itemtype": "attribute",

36443

"name": "graphOrder",

36444

"type": "Number",

36445

"class": "CartesianSeries",

36446

"module": "charts"

36447

},

36448

{

36449

"file": "charts/js/CartesianSeries.js",

36450

"line": 598,

36451

"description": "x coordinates for the series.",

36452

"itemtype": "attribute",

36453

"name": "xcoords",

36454

"type": "Array",

36455

"class": "CartesianSeries",

36456

"module": "charts"

36457

},

36458

{

36459

"file": "charts/js/CartesianSeries.js",

36460

"line": 606,

36461

"description": "y coordinates for the series",

36462

"itemtype": "attribute",

36463

"name": "ycoords",

36464

"type": "Array",

36465

"class": "CartesianSeries",

36466

"module": "charts"

36467

},

36468

{

36469

"file": "charts/js/CartesianSeries.js",

36470

"line": 614,

36471

"description": "Reference to the `Chart` application.",

36472

"itemtype": "attribute",

36473

"name": "chart",

36474

"type": "ChartBase",

36475

"readonly": "",

36476

"class": "CartesianSeries",

36477

"module": "charts"

36478

},

36479

{

36480

"file": "charts/js/CartesianSeries.js",

36481

"line": 630,

36482

"description": "Reference to the `Graph` in which the series is drawn into.",

36483

"itemtype": "attribute",

36484

"name": "graph",

36485

"type": "Graph",

36486

"class": "CartesianSeries",

36487

"module": "charts"

36488

},

36489

{

36490

"file": "charts/js/CartesianSeries.js",

36491

"line": 638,

36492

"description": "Reference to the `Axis` instance used for assigning \nx-values to the graph.",

36493

"itemtype": "attribute",

36494

"name": "xAxis",

36495

"type": "Axis",

36496

"class": "CartesianSeries",

36497

"module": "charts"

36498

},

36499

{

36500

"file": "charts/js/CartesianSeries.js",

36501

"line": 647,

36502

"description": "Reference to the `Axis` instance used for assigning \ny-values to the graph.",

36503

"itemtype": "attribute",

36504

"name": "yAxis",

36505

"type": "Axis",

36506

"class": "CartesianSeries",

36507

"module": "charts"

36508

},

36509

{

36510

"file": "charts/js/CartesianSeries.js",

36511

"line": 656,

36512

"description": "Indicates which array to from the hash of value arrays in \nthe x-axis `Axis` instance.",

36513

"itemtype": "attribute",

36514

"name": "xKey",

36515

"type": "String",

36516

"class": "CartesianSeries",

36517

"module": "charts"

36518

},

36519

{

36520

"file": "charts/js/CartesianSeries.js",

36521

"line": 670,

36522

"description": "Indicates which array to from the hash of value arrays in \nthe y-axis `Axis` instance.",

36523

"itemtype": "attribute",

36524

"name": "yKey",

36525

"type": "String",

36526

"class": "CartesianSeries",

36527

"module": "charts"

36528

},

36529

{

36530

"file": "charts/js/CartesianSeries.js",

36531

"line": 684,

36532

"description": "Array of x values for the series.",

36533

"itemtype": "attribute",

36534

"name": "xData",

36535

"type": "Array",

36536

"class": "CartesianSeries",

36537

"module": "charts"

36538

},

36539

{

36540

"file": "charts/js/CartesianSeries.js",

36541

"line": 692,

36542

"description": "Array of y values for the series.",

36543

"itemtype": "attribute",

36544

"name": "yData",

36545

"type": "Array",

36546

"class": "CartesianSeries",

36547

"module": "charts"

36548

},

36549

{

36550

"file": "charts/js/CartesianSeries.js",

36551

"line": 700,

36552

"description": "Indicates whether the Series has been through its initial set up.",

36553

"itemtype": "attribute",

36554

"name": "rendered",

36555

"type": "Boolean",

36556

"class": "CartesianSeries",

36557

"module": "charts"

36558

},

36559

{

36560

"file": "charts/js/CartesianSeries.js",

36561

"line": 725,

36562

"description": "Returns the height of the parent graph",

36563

"itemtype": "attribute",

36564

"name": "height",

36565

"type": "Number",

36566

"class": "CartesianSeries",

36567

"module": "charts"

36568

},

36569

{

36570

"file": "charts/js/CartesianSeries.js",

36571

"line": 740,

36572

"description": "Indicates whether to show the series",

36573

"itemtype": "attribute",

36574

"name": "visible",

36575

"type": "Boolean",

36576

"default": "true",

36577

"class": "CartesianSeries",

36578

"module": "charts"

36579

},

36580

{

36581

"file": "charts/js/CartesianSeries.js",

36582

"line": 751,

36583

"description": "Collection of area maps along the xAxis. Used to determine mouseover for multiple\nseries.",

36584

"itemtype": "attribute",

36585

"name": "xMarkerPlane",

36586

"type": "Array",

36587

"class": "CartesianSeries",

36588

"module": "charts"

36589

},

36590

{

36591

"file": "charts/js/CartesianSeries.js",

36592

"line": 760,

36593

"description": "Collection of area maps along the yAxis. Used to determine mouseover for multiple\nseries.",

36594

"itemtype": "attribute",

36595

"name": "yMarkerPlane",

36596

"type": "Array",

36597

"class": "CartesianSeries",

36598

"module": "charts"

36599

},

36600

{

36601

"file": "charts/js/CartesianSeries.js",

36602

"line": 769,

36603

"description": "Distance from a data coordinate to the left/right for setting a hotspot.",

36604

"itemtype": "attribute",

36605

"name": "xMarkerPlaneOffset",

36606

"type": "Number",

36607

"class": "CartesianSeries",

36608

"module": "charts"

36609

},

36610

{

36611

"file": "charts/js/CartesianSeries.js",

36612

"line": 786,

36613

"description": "Distance from a data coordinate to the top/bottom for setting a hotspot.",

36614

"itemtype": "attribute",

36615

"name": "yMarkerPlaneOffset",

36616

"type": "Number",

36617

"class": "CartesianSeries",

36618

"module": "charts"

36619

},

36620

{

36621

"file": "charts/js/CartesianSeries.js",

36622

"line": 803,

36623

"description": "Direction of the series",

36624

"itemtype": "attribute",

36625

"name": "direction",

36626

"type": "String",

36627

"class": "CartesianSeries",

36628

"module": "charts"

36629

},

36630

{

36631

"file": "charts/js/CartesianSeries.js",

36632

"line": 813,

36633

"description": "Indicates whether or not markers for a series will be grouped and rendered in a single complex shape instance.",

36634

"itemtype": "attribute",

36635

"name": "groupMarkers",

36636

"type": "Boolean",

36637

"class": "CartesianSeries",

36638

"module": "charts"

36639

},

36640

{

36641

"file": "charts/js/CategoryAxis.js",

36642

"line": 19,

36643

"description": "Formats a label based on the axis type and optionally specified format.",

36644

"itemtype": "method",

36645

"name": "formatLabel",

36646

"params": [

36647

{

36648

"name": "value",

36649

"description": "",

36650

"type": "Object"

36651

},

36652

{

36653

"name": "format",

36654

"description": "Pattern used to format the value.",

36655

"type": "Object"

36656

}

36657

],

36658

"return": {

36659

"description": "String"

36660

},

36661

"class": "CategoryAxis",

36662

"module": "charts"

36663

},

36664

{

36665

"file": "charts/js/CategoryAxis.js",

36666

"line": 32,

36667

"description": "Object storing key data.",

36668

"itemtype": "property",

36669

"name": "_indices",

36670

"access": "private",

36671

"tagname": "",

36672

"class": "CategoryAxis",

36673

"module": "charts"

36674

},

36675

{

36676

"file": "charts/js/CategoryAxis.js",

36677

"line": 40,

36678

"description": "Constant used to generate unique id.",

36679

"itemtype": "property",

36680

"name": "GUID",

36681

"type": "String",

36682

"access": "private",

36683

"tagname": "",

36684

"class": "CategoryAxis",

36685

"module": "charts"

36686

},

36687

{

36688

"file": "charts/js/CategoryAxis.js",

36689

"line": 49,

36690

"description": "Type of data used in `Axis`.",

36691

"itemtype": "property",

36692

"name": "_dataType",

36693

"readonly": "",

36694

"access": "private",

36695

"tagname": "",

36696

"class": "CategoryAxis",

36697

"module": "charts"

36698

},

36699

{

36700

"file": "charts/js/CategoryAxis.js",

36701

"line": 58,

36702

"description": "Calculates the maximum and minimum values for the `Axis`.",

36703

"itemtype": "method",

36704

"name": "_updateMinAndMax",

36705

"access": "private",

36706

"tagname": "",

36707

"class": "CategoryAxis",

36708

"module": "charts"

36709

},

36710

{

36711

"file": "charts/js/CategoryAxis.js",

36712

"line": 70,

36713

"description": "Gets an array of values based on a key.",

36714

"itemtype": "method",

36715

"name": "_getKeyArray",

36716

"params": [

36717

{

36718

"name": "key",

36719

"description": "Value key associated with the data array.",

36720

"type": "String"

36721

},

36722

{

36723

"name": "data",

36724

"description": "Array in which the data resides.",

36725

"type": "Array"

36726

}

36727

],

36728

"return": {

36729

"description": "Array"

36730

},

36731

"access": "private",

36732

"tagname": "",

36733

"class": "CategoryAxis",

36734

"module": "charts"

36735

},

36736

{

36737

"file": "charts/js/CategoryAxis.js",

36738

"line": 100,

36739

"description": "Sets data by key",

36740

"itemtype": "method",

36741

"name": "_setDataByKey",

36742

"params": [

36743

{

36744

"name": "key",

36745

"description": "Key value to use.",

36746

"type": "String"

36747

},

36748

{

36749

"name": "data",

36750

"description": "Array to use.",

36751

"type": "Array"

36752

}

36753

],

36754

"access": "private",

36755

"tagname": "",

36756

"class": "CategoryAxis",

36757

"module": "charts"

36758

},

36759

{

36760

"file": "charts/js/CategoryAxis.js",

36761

"line": 131,

36762

"description": "Returns an array of values based on an identifier key.",

36763

"itemtype": "method",

36764

"name": "getDataByKey",

36765

"params": [

36766

{

36767

"name": "value",

36768

"description": "value used to identify the array",

36769

"type": "String"

36770

}

36771

],

36772

"return": {

36773

"description": "Array"

36774

},

36775

"class": "CategoryAxis",

36776

"module": "charts"

36777

},

36778

{

36779

"file": "charts/js/CategoryAxis.js",

36780

"line": 152,

36781

"description": "Returns the total number of majorUnits that will appear on an axis.",

36782

"itemtype": "method",

36783

"name": "getTotalMajorUnits",

36784

"params": [

36785

{

36786

"name": "majorUnit",

36787

"description": "Object containing properties related to the majorUnit.",

36788

"type": "Object"

36789

},

36790

{

36791

"name": "len",

36792

"description": "Length of the axis.",

36793

"type": "Number"

36794

}

36795

],

36796

"return": {

36797

"description": "Number"

36798

},

36799

"class": "CategoryAxis",

36800

"module": "charts"

36801

},

36802

{

36803

"file": "charts/js/CategoryAxis.js",

36804

"line": 165,

36805

"description": "Returns the distance between major units on an axis.",

36806

"itemtype": "method",

36807

"name": "getMajorUnitDistance",

36808

"params": [

36809

{

36810

"name": "len",

36811

"description": "Number of ticks",

36812

"type": "Number"

36813

},

36814

{

36815

"name": "uiLen",

36816

"description": "Size of the axis.",

36817

"type": "Number"

36818

},

36819

{

36820

"name": "majorUnit",

36821

"description": "Hash of properties used to determine the majorUnit",

36822

"type": "Object"

36823

}

36824

],

36825

"return": {

36826

"description": "Number"

36827

},

36828

"class": "CategoryAxis",

36829

"module": "charts"

36830

},

36831

{

36832

"file": "charts/js/CategoryAxis.js",

36833

"line": 188,

36834

"description": "Gets the distance that the first and last ticks are offset from there respective\nedges.",

36835

"itemtype": "method",

36836

"name": "getEdgeOffset",

36837

"params": [

36838

{

36839

"name": "ct",

36840

"description": "Number of ticks on the axis.",

36841

"type": "Number"

36842

},

36843

{

36844

"name": "l",

36845

"description": "Length (in pixels) of the axis.",

36846

"type": "Number"

36847

}

36848

],

36849

"return": {

36850

"description": "Number"

36851

},

36852

"class": "CategoryAxis",

36853

"module": "charts"

36854

},

36855

{

36856

"file": "charts/js/CategoryAxis.js",

36857

"line": 202,

36858

"description": "Returns a value based of a key value and an index.",

36859

"itemtype": "method",

36860

"name": "getKeyValueAt",

36861

"params": [

36862

{

36863

"name": "key",

36864

"description": "value used to look up the correct array",

36865

"type": "String"

36866

},

36867

{

36868

"name": "index",

36869

"description": "within the array",

36870

"type": "Number"

36871

}

36872

],

36873

"return": {

36874

"description": "String"

36875

},

36876

"class": "CategoryAxis",

36877

"module": "charts"

36878

},

36879

{

36880

"file": "charts/js/CategoryAxis.js",

36881

"line": 221,

36882

"description": "Calculates and returns a value based on the number of labels and the index of\nthe current label.",

36883

"itemtype": "method",

36884

"name": "getLabelByIndex",

36885

"params": [

36886

{

36887

"name": "i",

36888

"description": "Index of the label.",

36889

"type": "Number"

36890

},

36891

{

36892

"name": "l",

36893

"description": "Total number of labels.",

36894

"type": "Number"

36895

}

36896

],

36897

"return": {

36898

"description": "String"

36899

},

36900

"class": "CategoryAxis",

36901

"module": "charts"

36902

},

36903

{

36904

"file": "charts/js/CategoryAxis.js",

36905

"line": 246,

36906

"description": "Returns a string corresponding to the first label on an \naxis.",

36907

"itemtype": "method",

36908

"name": "getMinimumValue",

36909

"return": {

36910

"description": "String"

36911

},

36912

"class": "CategoryAxis",

36913

"module": "charts"

36914

},

36915

{

36916

"file": "charts/js/CategoryAxis.js",

36917

"line": 260,

36918

"description": "Returns a string corresponding to the last label on an \naxis.",

36919

"itemtype": "method",

36920

"name": "getMaximumValue",

36921

"return": {

36922

"description": "String"

36923

},

36924

"class": "CategoryAxis",

36925

"module": "charts"

36926

},

36927

{

36928

"file": "charts/js/ChartBase.js",

36929

"line": 11,

36930

"description": "Sets the `aria-label` for the chart.",

36931

"itemtype": "attribute",

36932

"name": "ariaLabel",

36933

"type": "String",

36934

"class": "ChartBase",

36935

"module": "charts"

36936

},

36937

{

36938

"file": "charts/js/ChartBase.js",

36939

"line": 31,

36940

"description": "Sets the aria description for the chart.",

36941

"itemtype": "attribute",

36942

"name": "ariaDescription",

36943

"type": "String",

36944

"class": "ChartBase",

36945

"module": "charts"

36946

},

36947

{

36948

"file": "charts/js/ChartBase.js",

36949

"line": 51,

36950

"description": "Reference to the default tooltip available for the chart.\nContains the following properties:\n <dl>\n <dt>node</dt><dd>Reference to the actual dom node</dd>\n <dt>showEvent</dt><dd>Event that should trigger the tooltip</dd>\n <dt>hideEvent</dt><dd>Event that should trigger the removal of a tooltip (can be an event or an array of events)</dd>\n <dt>styles</dt><dd>A hash of style properties that will be applied to the tooltip node</dd>\n <dt>show</dt><dd>Indicates whether or not to show the tooltip</dd>\n <dt>markerEventHandler</dt><dd>Displays and hides tooltip based on marker events</dd>\n <dt>planarEventHandler</dt><dd>Displays and hides tooltip based on planar events</dd>\n <dt>markerLabelFunction</dt><dd>Reference to the function used to format a marker event triggered tooltip's text. The method contains \n the following arguments:\n <dl>\n <dt>categoryItem</dt><dd>An object containing the following:\n <dl>\n <dt>axis</dt><dd>The axis to which the category is bound.</dd>\n <dt>displayName</dt><dd>The display name set to the category (defaults to key if not provided).</dd>\n <dt>key</dt><dd>The key of the category.</dd>\n <dt>value</dt><dd>The value of the category.</dd>\n </dl>\n </dd>\n <dt>valueItem</dt><dd>An object containing the following:\n <dl>\n <dt>axis</dt><dd>The axis to which the item's series is bound.</dd>\n <dt>displayName</dt><dd>The display name of the series. (defaults to key if not provided)</dd>\n <dt>key</dt><dd>The key for the series.</dd>\n <dt>value</dt><dd>The value for the series item.</dd> \n </dl>\n </dd>\n <dt>itemIndex</dt><dd>The index of the item within the series.</dd>\n <dt>series</dt><dd> The `CartesianSeries` instance of the item.</dd>\n <dt>seriesIndex</dt><dd>The index of the series in the `seriesCollection`.</dd>\n </dl>\n The method returns an `HTMLElement` which is written into the DOM using `appendChild`. If you override this method and choose to return an html string, you\n will also need to override the tooltip's `setTextFunction` method to accept an html string.\n </dd>\n <dt>planarLabelFunction</dt><dd>Reference to the function used to format a planar event triggered tooltip's text\n <dl>\n <dt>categoryAxis</dt><dd> `CategoryAxis` Reference to the categoryAxis of the chart.\n <dt>valueItems</dt><dd>Array of objects for each series that has a data point in the coordinate plane of the event. Each object contains the following data:\n <dl>\n <dt>axis</dt><dd>The value axis of the series.</dd>\n <dt>key</dt><dd>The key for the series.</dd>\n <dt>value</dt><dd>The value for the series item.</dd>\n <dt>displayName</dt><dd>The display name of the series. (defaults to key if not provided)</dd>\n </dl> \n </dd>\n <dt>index</dt><dd>The index of the item within its series.</dd>\n <dt>seriesArray</dt><dd>Array of series instances for each value item.</dd>\n <dt>seriesIndex</dt><dd>The index of the series in the `seriesCollection`.</dd>\n </dl>\n </dd>\n </dl>\n The method returns an `HTMLElement` which is written into the DOM using `appendChild`. If you override this method and choose to return an html string, you\n will also need to override the tooltip's `setTextFunction` method to accept an html string.\n </dd>\n <dt>setTextFunction</dt><dd>Method that writes content returned from `planarLabelFunction` or `markerLabelFunction` into the the tooltip node.\n has the following signature:\n <dl>\n <dt>label</dt><dd>The `HTMLElement` that the content is to be added.</dd>\n <dt>val</dt><dd>The content to be rendered into tooltip. This can be a `String` or `HTMLElement`. If an HTML string is used, it will be rendered as a\n string.</dd>\n </dl>\n </dd>\n </dl>",

36951

"itemtype": "attribute",

36952

"name": "tooltip",

36953

"type": "Object",

36954

"class": "ChartBase",

36955

"module": "charts"

36956

},

36957

{

36958

"file": "charts/js/ChartBase.js",

36959

"line": 129,

36960

"description": "The key value used for the chart's category axis.",

36961

"itemtype": "attribute",

36962

"name": "categoryKey",

36963

"type": "String",

36964

"default": "category",

36965

"class": "ChartBase",

36966

"module": "charts"

36967

},

36968

{

36969

"file": "charts/js/ChartBase.js",

36970

"line": 140,

36971

"description": "Indicates the type of axis to use for the category axis.\n\n <dl>\n <dt>category</dt><dd>Specifies a `CategoryAxis`.</dd>\n <dt>time</dt><dd>Specifies a `TimeAxis</dd>\n </dl>",

36972

"itemtype": "attribute",

36973

"name": "categoryType",

36974

"type": "String",

36975

"default": "category",

36976

"class": "ChartBase",

36977

"module": "charts"

36978

},

36979

{

36980

"file": "charts/js/ChartBase.js",

36981

"line": 156,

36982

"description": "Indicates the the type of interactions that will fire events.\n\n <dl>\n <dt>marker</dt><dd>Events will be broadcasted when the mouse interacts with individual markers.</dd>\n <dt>planar</dt><dd>Events will be broadcasted when the mouse intersects the plane of any markers on the chart.</dd>\n <dt>none</dt><dd>No events will be broadcasted.</dd>\n </dl>",

36983

"itemtype": "attribute",

36984

"name": "interactionType",

36985

"type": "String",

36986

"default": "marker",

36987

"class": "ChartBase",

36988

"module": "charts"

36989

},

36990

{

36991

"file": "charts/js/ChartBase.js",

36992

"line": 173,

36993

"description": "Data used to generate the chart.",

36994

"itemtype": "attribute",

36995

"name": "dataProvider",

36996

"type": "Array",

36997

"class": "ChartBase",

36998

"module": "charts"

36999

},

37000

{

37001

"file": "charts/js/ChartBase.js",

37002

"line": 186,

37003

"description": "A collection of keys that map to the series axes. If no keys are set,\nthey will be generated automatically depending on the data structure passed into \nthe chart.",

37004

"itemtype": "attribute",

37005

"name": "seriesKeys",

37006

"type": "Array",

37007

"class": "ChartBase",

37008

"module": "charts"

37009

},

37010

{

37011

"file": "charts/js/ChartBase.js",

37012

"line": 196,

37013

"description": "Reference to all the axes in the chart.",

37014

"itemtype": "attribute",

37015

"name": "axesCollection",

37016

"type": "Array",

37017

"class": "ChartBase",

37018

"module": "charts"

37019

},

37020

{

37021

"file": "charts/js/ChartBase.js",

37022

"line": 204,

37023

"description": "Reference to graph instance.",

37024

"itemtype": "attribute",

37025

"name": "graph",

37026

"type": "Graph",

37027

"class": "ChartBase",

37028

"module": "charts"

37029

},

37030

{

37031

"file": "charts/js/ChartBase.js",

37032

"line": 214,

37033

"description": "Indicates whether or not markers for a series will be grouped and rendered in a single complex shape instance.",

37034

"itemtype": "attribute",

37035

"name": "groupMarkers",

37036

"type": "Boolean",

37037

"class": "ChartBase",

37038

"module": "charts"

37039

},

37040

{

37041

"file": "charts/js/ChartBase.js",

37042

"line": 235,

37043

"description": "Handler for itemRendered event.",

37044

"itemtype": "method",

37045

"name": "_itemRendered",

37046

"params": [

37047

{

37048

"name": "e",

37049

"description": "Event object.",

37050

"type": "Object"

37051

}

37052

],

37053

"access": "private",

37054

"tagname": "",

37055

"class": "ChartBase",

37056

"module": "charts"

37057

},

37058

{

37059

"file": "charts/js/ChartBase.js",

37060

"line": 251,

37061

"description": "Default value function for the `Graph` attribute.",

37062

"itemtype": "method",

37063

"name": "_getGraph",

37064

"return": {

37065

"description": "Graph"

37066

},

37067

"access": "private",

37068

"tagname": "",

37069

"class": "ChartBase",

37070

"module": "charts"

37071

},

37072

{

37073

"file": "charts/js/ChartBase.js",

37074

"line": 270,

37075

"description": "Returns a series instance by index or key value.",

37076

"itemtype": "method",

37077

"name": "getSeries",

37078

"params": [

37079

{

37080

"name": "val",

37081

"description": ""

37082

}

37083

],

37084

"return": {

37085

"description": "CartesianSeries"

37086

},

37087

"class": "ChartBase",

37088

"module": "charts"

37089

},

37090

{

37091

"file": "charts/js/ChartBase.js",

37092

"line": 295,

37093

"description": "Returns an `Axis` instance by key reference. If the axis was explicitly set through the `axes` attribute,\nthe key will be the same as the key used in the `axes` object. For default axes, the key for\nthe category axis is the value of the `categoryKey` (`category`). For the value axis, the default \nkey is `values`.",

37094

"itemtype": "method",

37095

"name": "getAxisByKey",

37096

"params": [

37097

{

37098

"name": "val",

37099

"description": "Key reference used to look up the axis.",

37100

"type": "String"

37101

}

37102

],

37103

"return": {

37104

"description": "Axis"

37105

},

37106

"class": "ChartBase",

37107

"module": "charts"

37108

},

37109

{

37110

"file": "charts/js/ChartBase.js",

37111

"line": 316,

37112

"description": "Returns the category axis for the chart.",

37113

"itemtype": "method",

37114

"name": "getCategoryAxis",

37115

"return": {

37116

"description": "Axis"

37117

},

37118

"class": "ChartBase",

37119

"module": "charts"

37120

},

37121

{

37122

"file": "charts/js/ChartBase.js",

37123

"line": 334,

37124

"description": "Default direction of the chart.",

37125

"itemtype": "property",

37126

"name": "_direction",

37127

"type": "String",

37128

"default": "horizontal",

37129

"access": "private",

37130

"tagname": "",

37131

"class": "ChartBase",

37132

"module": "charts"

37133

},

37134

{

37135

"file": "charts/js/ChartBase.js",

37136

"line": 344,

37137

"description": "Storage for the `dataProvider` attribute.",

37138

"itemtype": "property",

37139

"name": "_dataProvider",

37140

"type": "Array",

37141

"access": "private",

37142

"tagname": "",

37143

"class": "ChartBase",

37144

"module": "charts"

37145

},

37146

{

37147

"file": "charts/js/ChartBase.js",

37148

"line": 353,

37149

"description": "Setter method for `dataProvider` attribute.",

37150

"itemtype": "method",

37151

"name": "_setDataValues",

37152

"params": [

37153

{

37154

"name": "val",

37155

"description": "Array to be set as `dataProvider`.",

37156

"type": "Array"

37157

}

37158

],

37159

"return": {

37160

"description": "Array"

37161

},

37162

"access": "private",

37163

"tagname": "",

37164

"class": "ChartBase",

37165

"module": "charts"

37166

},

37167

{

37168

"file": "charts/js/ChartBase.js",

37169

"line": 386,

37170

"description": "Storage for `seriesCollection` attribute.",

37171

"itemtype": "property",

37172

"name": "_seriesCollection",

37173

"type": "Array",

37174

"access": "private",

37175

"tagname": "",

37176

"class": "ChartBase",

37177

"module": "charts"

37178

},

37179

{

37180

"file": "charts/js/ChartBase.js",

37181

"line": 395,

37182

"description": "Setter method for `seriesCollection` attribute.",

37183

"itemtype": "property",

37184

"name": "_setSeriesCollection",

37185

"access": "private",

37186

"tagname": "",

37187

"class": "ChartBase",

37188

"module": "charts",

37189

"subprops": [

37190

{

37191

"name": "val",

37192

"description": "Array of either `CartesianSeries` instances or objects containing series attribute key value pairs.",

37193

"type": "Array"

37194

}

37195

]

37196

},

37197

{

37198

"file": "charts/js/ChartBase.js",

37199

"line": 406,

37200

"description": "Helper method that returns the axis class that a key references.",

37201

"itemtype": "method",

37202

"name": "_getAxisClass",

37203

"params": [

37204

{

37205

"name": "t",

37206

"description": "The type of axis.",

37207

"type": "String"

37208

}

37209

],

37210

"return": {

37211

"description": "Axis"

37212

},

37213

"access": "private",

37214

"tagname": "",

37215

"class": "ChartBase",

37216

"module": "charts"

37217

},

37218

{

37219

"file": "charts/js/ChartBase.js",

37220

"line": 419,

37221

"description": "Key value pairs of axis types.",

37222

"itemtype": "property",

37223

"name": "_axisClass",

37224

"type": "Object",

37225

"access": "private",

37226

"tagname": "",

37227

"class": "ChartBase",

37228

"module": "charts"

37229

},

37230

{

37231

"file": "charts/js/ChartBase.js",

37232

"line": 433,

37233

"description": "Collection of axes.",

37234

"itemtype": "property",

37235

"name": "_axes",

37236

"type": "Array",

37237

"access": "private",

37238

"tagname": "",

37239

"class": "ChartBase",

37240

"module": "charts"

37241

},

37242

{

37243

"file": "charts/js/ChartBase.js",

37244

"line": 442,

37245

"itemtype": "method",

37246

"name": "initializer",

37247

"access": "private",

37248

"tagname": "",

37249

"class": "ChartBase",

37250

"module": "charts"

37251

},

37252

{

37253

"file": "charts/js/ChartBase.js",

37254

"line": 454,

37255

"itemtype": "method",

37256

"name": "renderUI",

37257

"access": "private",

37258

"tagname": "",

37259

"class": "ChartBase",

37260

"module": "charts"

37261

},

37262

{

37263

"file": "charts/js/ChartBase.js",

37264

"line": 475,

37265

"description": "Creates an aria `live-region`, `aria-label` and `aria-describedby` for the Chart.",

37266

"itemtype": "method",

37267

"name": "_setAriaElements",

37268

"params": [

37269

{

37270

"name": "cb",

37271

"description": "Reference to the Chart's `contentBox` attribute.",

37272

"type": "Node"

37273

}

37274

],

37275

"access": "private",

37276

"tagname": "",

37277

"class": "ChartBase",

37278

"module": "charts"

37279

},

37280

{

37281

"file": "charts/js/ChartBase.js",

37282

"line": 505,

37283

"description": "Sets a node offscreen for use as aria-description or aria-live-regin.",

37284

"itemtype": "method",

37285

"name": "_setOffscreen",

37286

"return": {

37287

"description": "Node"

37288

},

37289

"access": "private",

37290

"tagname": "",

37291

"class": "ChartBase",

37292

"module": "charts"

37293

},

37294

{

37295

"file": "charts/js/ChartBase.js",

37296

"line": 525,

37297

"itemtype": "method",

37298

"name": "syncUI",

37299

"access": "private",

37300

"tagname": "",

37301

"class": "ChartBase",

37302

"module": "charts"

37303

},

37304

{

37305

"file": "charts/js/ChartBase.js",

37306

"line": 534,

37307

"itemtype": "method",

37308

"name": "bindUI",

37309

"access": "private",

37310

"tagname": "",

37311

"class": "ChartBase",

37312

"module": "charts"

37313

},

37314

{

37315

"file": "charts/js/ChartBase.js",

37316

"line": 646,

37317

"description": "Event handler for marker events.",

37318

"itemtype": "method",

37319

"name": "_markerEventDispatcher",

37320

"params": [

37321

{

37322

"name": "e",

37323

"description": "Event object.",

37324

"type": "Object"

37325

}

37326

],

37327

"access": "private",

37328

"tagname": "",

37329

"class": "ChartBase",

37330

"module": "charts"

37331

},

37332

{

37333

"file": "charts/js/ChartBase.js",

37334

"line": 678,

37335

"description": "Broadcasts when `interactionType` is set to `marker` and a series marker has received a mouseover event.",

37336

"itemtype": "event",

37337

"name": "markerEvent:mouseover",

37338

"preventable": "false",

37339

"params": [

37340

{

37341

"name": "e",

37342

"description": "Event facade with the following additional\n properties:\n <dl>\n <dt>categoryItem</dt><dd>Hash containing information about the category `Axis`.</dd>\n <dt>valueItem</dt><dd>Hash containing information about the value `Axis`.</dd>\n <dt>node</dt><dd>The dom node of the marker.</dd>\n <dt>x</dt><dd>The x-coordinate of the mouse in relation to the Chart.</dd>\n <dt>y</dt><dd>The y-coordinate of the mouse in relation to the Chart.</dd>\n <dt>series</dt><dd>Reference to the series of the marker.</dd>\n <dt>index</dt><dd>Index of the marker in the series.</dd>\n <dt>seriesIndex</dt><dd>The `order` of the marker's series.</dd>\n </dl>",

37343

"type": "EventFacade"

37344

}

37345

],

37346

"class": "ChartBase",

37347

"module": "charts"

37348

},

37349

{

37350

"file": "charts/js/ChartBase.js",

37351

"line": 697,

37352

"description": "Broadcasts when `interactionType` is set to `marker` and a series marker has received a mouseout event.",

37353

"itemtype": "event",

37354

"name": "markerEvent:mouseout",

37355

"preventable": "false",

37356

"params": [

37357

{

37358

"name": "e",

37359

"description": "Event facade with the following additional\n properties:\n <dl>\n <dt>categoryItem</dt><dd>Hash containing information about the category `Axis`.</dd>\n <dt>valueItem</dt><dd>Hash containing information about the value `Axis`.</dd>\n <dt>node</dt><dd>The dom node of the marker.</dd>\n <dt>x</dt><dd>The x-coordinate of the mouse in relation to the Chart.</dd>\n <dt>y</dt><dd>The y-coordinate of the mouse in relation to the Chart.</dd>\n <dt>series</dt><dd>Reference to the series of the marker.</dd>\n <dt>index</dt><dd>Index of the marker in the series.</dd>\n <dt>seriesIndex</dt><dd>The `order` of the marker's series.</dd>\n </dl>",

37360

"type": "EventFacade"

37361

}

37362

],

37363

"class": "ChartBase",

37364

"module": "charts"

37365

},

37366

{

37367

"file": "charts/js/ChartBase.js",

37368

"line": 715,

37369

"description": "Broadcasts when `interactionType` is set to `marker` and a series marker has received a mousedown event.",

37370

"itemtype": "event",

37371

"name": "markerEvent:mousedown",

37372

"preventable": "false",

37373

"params": [

37374

{

37375

"name": "e",

37376

"description": "Event facade with the following additional\n properties:\n <dl>\n <dt>categoryItem</dt><dd>Hash containing information about the category `Axis`.</dd>\n <dt>valueItem</dt><dd>Hash containing information about the value `Axis`.</dd>\n <dt>node</dt><dd>The dom node of the marker.</dd>\n <dt>x</dt><dd>The x-coordinate of the mouse in relation to the Chart.</dd>\n <dt>y</dt><dd>The y-coordinate of the mouse in relation to the Chart.</dd>\n <dt>series</dt><dd>Reference to the series of the marker.</dd>\n <dt>index</dt><dd>Index of the marker in the series.</dd>\n <dt>seriesIndex</dt><dd>The `order` of the marker's series.</dd>\n </dl>",

37377

"type": "EventFacade"

37378

}

37379

],

37380

"class": "ChartBase",

37381

"module": "charts"

37382

},

37383

{

37384

"file": "charts/js/ChartBase.js",

37385

"line": 733,

37386

"description": "Broadcasts when `interactionType` is set to `marker` and a series marker has received a mouseup event.",

37387

"itemtype": "event",

37388

"name": "markerEvent:mouseup",

37389

"preventable": "false",

37390

"params": [

37391

{

37392

"name": "e",

37393

"description": "Event facade with the following additional\n properties:\n <dl>\n <dt>categoryItem</dt><dd>Hash containing information about the category `Axis`.</dd>\n <dt>valueItem</dt><dd>Hash containing information about the value `Axis`.</dd>\n <dt>node</dt><dd>The dom node of the marker.</dd>\n <dt>x</dt><dd>The x-coordinate of the mouse in relation to the Chart.</dd>\n <dt>y</dt><dd>The y-coordinate of the mouse in relation to the Chart.</dd>\n <dt>series</dt><dd>Reference to the series of the marker.</dd>\n <dt>index</dt><dd>Index of the marker in the series.</dd>\n <dt>seriesIndex</dt><dd>The `order` of the marker's series.</dd>\n </dl>",

37394

"type": "EventFacade"

37395

}

37396

],

37397

"class": "ChartBase",

37398

"module": "charts"

37399

},

37400

{

37401

"file": "charts/js/ChartBase.js",

37402

"line": 751,

37403

"description": "Broadcasts when `interactionType` is set to `marker` and a series marker has received a click event.",

37404

"itemtype": "event",

37405

"name": "markerEvent:click",

37406

"preventable": "false",

37407

"params": [

37408

{

37409

"name": "e",

37410

"description": "Event facade with the following additional\n properties:\n <dl>\n <dt>categoryItem</dt><dd>Hash containing information about the category `Axis`.</dd>\n <dt>valueItem</dt><dd>Hash containing information about the value `Axis`.</dd>\n <dt>node</dt><dd>The dom node of the marker.</dd>\n <dt>x</dt><dd>The x-coordinate of the mouse in relation to the Chart.</dd>\n <dt>y</dt><dd>The y-coordinate of the mouse in relation to the Chart.</dd>\n <dt>pageX</dt><dd>The x location of the event on the page (including scroll)</dd>\n <dt>pageY</dt><dd>The y location of the event on the page (including scroll)</dd>\n <dt>series</dt><dd>Reference to the series of the marker.</dd>\n <dt>index</dt><dd>Index of the marker in the series.</dd>\n <dt>seriesIndex</dt><dd>The `order` of the marker's series.</dd>\n <dt>originEvent</dt><dd>Underlying dom event.</dd>\n </dl>",

37411

"type": "EventFacade"

37412

}

37413

],

37414

"class": "ChartBase",

37415

"module": "charts"

37416

},

37417

{

37418

"file": "charts/js/ChartBase.js",

37419

"line": 787,

37420

"description": "Event handler for dataProviderChange.",

37421

"itemtype": "method",

37422

"name": "_dataProviderChangeHandler",

37423

"params": [

37424

{

37425

"name": "e",

37426

"description": "Event object.",

37427

"type": "Object"

37428

}

37429

],

37430

"access": "private",

37431

"tagname": "",

37432

"class": "ChartBase",

37433

"module": "charts"

37434

},

37435

{

37436

"file": "charts/js/ChartBase.js",

37437

"line": 822,

37438

"description": "Event listener for toggling the tooltip. If a tooltip is visible, hide it. If not, it \nwill create and show a tooltip based on the event object.",

37439

"itemtype": "method",

37440

"name": "toggleTooltip",

37441

"params": [

37442

{

37443

"name": "e",

37444

"description": "Event object.",

37445

"type": "Object"

37446

}

37447

],

37448

"class": "ChartBase",

37449

"module": "charts"

37450

},

37451

{

37452

"file": "charts/js/ChartBase.js",

37453

"line": 842,

37454

"description": "Shows a tooltip",

37455

"itemtype": "method",

37456

"name": "_showTooltip",

37457

"params": [

37458

{

37459

"name": "msg",

37460

"description": "Message to dispaly in the tooltip.",

37461

"type": "String"

37462

},

37463

{

37464

"name": "x",

37465

"description": "x-coordinate",

37466

"type": "Number"

37467

},

37468

{

37469

"name": "y",

37470

"description": "y-coordinate",

37471

"type": "Number"

37472

}

37473

],

37474

"access": "private",

37475

"tagname": "",

37476

"class": "ChartBase",

37477

"module": "charts"

37478

},

37479

{

37480

"file": "charts/js/ChartBase.js",

37481

"line": 865,

37482

"description": "Positions the tooltip",

37483

"itemtype": "method",

37484

"name": "_positionTooltip",

37485

"params": [

37486

{

37487

"name": "e",

37488

"description": "Event object.",

37489

"type": "Object"

37490

}

37491

],

37492

"access": "private",

37493

"tagname": "",

37494

"class": "ChartBase",

37495

"module": "charts"

37496

},

37497

{

37498

"file": "charts/js/ChartBase.js",

37499

"line": 886,

37500

"description": "Hides the default tooltip",

37501

"itemtype": "method",

37502

"name": "hideTooltip",

37503

"class": "ChartBase",

37504

"module": "charts"

37505

},

37506

{

37507

"file": "charts/js/ChartBase.js",

37508

"line": 902,

37509

"description": "Adds a tooltip to the dom.",

37510

"itemtype": "method",

37511

"name": "_addTooltip",

37512

"access": "private",

37513

"tagname": "",

37514

"class": "ChartBase",

37515

"module": "charts"

37516

},

37517

{

37518

"file": "charts/js/ChartBase.js",

37519

"line": 923,

37520

"description": "Updates the tooltip attribute.",

37521

"itemtype": "method",

37522

"name": "_updateTooltip",

37523

"params": [

37524

{

37525

"name": "val",

37526

"description": "Object containing properties for the tooltip.",

37527

"type": "Object"

37528

}

37529

],

37530

"return": {

37531

"description": "Object"

37532

},

37533

"access": "private",

37534

"tagname": "",

37535

"class": "ChartBase",

37536

"module": "charts"

37537

},

37538

{

37539

"file": "charts/js/ChartBase.js",

37540

"line": 973,

37541

"description": "Default getter for `tooltip` attribute.",

37542

"itemtype": "method",

37543

"name": "_getTooltip",

37544

"return": {

37545

"description": "Object"

37546

},

37547

"access": "private",

37548

"tagname": "",

37549

"class": "ChartBase",

37550

"module": "charts"

37551

},

37552

{

37553

"file": "charts/js/ChartBase.js",

37554

"line": 1025,

37555

"description": "Formats tooltip text when `interactionType` is `planar`.",

37556

"itemtype": "method",

37557

"name": "_planarLabelFunction",

37558

"params": [

37559

{

37560

"name": "categoryAxis",

37561

"description": "Reference to the categoryAxis of the chart.",

37562

"type": "Axis"

37563

},

37564

{

37565

"name": "valueItems",

37566

"description": "Array of objects for each series that has a data point in the coordinate plane of the event. Each object contains the following data:\n <dl>\n <dt>axis</dt><dd>The value axis of the series.</dd>\n <dt>key</dt><dd>The key for the series.</dd>\n <dt>value</dt><dd>The value for the series item.</dd>\n <dt>displayName</dt><dd>The display name of the series. (defaults to key if not provided)</dd>\n </dl>",

37567

"type": "Array"

37568

},

37569

{

37570

"name": "index",

37571

"description": "The index of the item within its series.",

37572

"type": "Number"

37573

},

37574

{

37575

"name": "seriesArray",

37576

"description": "Array of series instances for each value item.",

37577

"type": "Array"

37578

},

37579

{

37580

"name": "seriesIndex",

37581

"description": "The index of the series in the `seriesCollection`.",

37582

"type": "Number"

37583

}

37584

],

37585

"return": {

37586

"description": "",

37587

"type": "String | HTML"

37588

},

37589

"access": "private",

37590

"tagname": "",

37591

"class": "ChartBase",

37592

"module": "charts"

37593

},

37594

{

37595

"file": "charts/js/ChartBase.js",

37596

"line": 1084,

37597

"description": "Formats tooltip text when `interactionType` is `marker`.",

37598

"itemtype": "method",

37599

"name": "_tooltipLabelFunction",

37600

"params": [

37601

{

37602

"name": "categoryItem",

37603

"description": "An object containing the following:\n <dl>\n <dt>axis</dt><dd>The axis to which the category is bound.</dd>\n <dt>displayName</dt><dd>The display name set to the category (defaults to key if not provided)</dd>\n <dt>key</dt><dd>The key of the category.</dd>\n <dt>value</dt><dd>The value of the category</dd>\n </dl>",

37604

"type": "Object"

37605

},

37606

{

37607

"name": "valueItem",

37608

"description": "An object containing the following:\n <dl>\n <dt>axis</dt><dd>The axis to which the item's series is bound.</dd>\n <dt>displayName</dt><dd>The display name of the series. (defaults to key if not provided)</dd>\n <dt>key</dt><dd>The key for the series.</dd>\n <dt>value</dt><dd>The value for the series item.</dd> \n </dl>",

37609

"type": "Object"

37610

},

37611

{

37612

"name": "itemIndex",

37613

"description": "The index of the item within the series.",

37614

"type": "Number"

37615

},

37616

{

37617

"name": "series",

37618

"description": "The `CartesianSeries` instance of the item.",

37619

"type": "CartesianSeries"

37620

},

37621

{

37622

"name": "seriesIndex",

37623

"description": "The index of the series in the `seriesCollection`.",

37624

"type": "Number"

37625

}

37626

],

37627

"return": {

37628

"description": "",

37629

"type": "String | HTML"

37630

},

37631

"access": "private",

37632

"tagname": "",

37633

"class": "ChartBase",

37634

"module": "charts"

37635

},

37636

{

37637

"file": "charts/js/ChartBase.js",

37638

"line": 1131,

37639

"description": "Event handler for the tooltipChange.",

37640

"itemtype": "method",

37641

"name": "_tooltipChangeHandler",

37642

"params": [

37643

{

37644

"name": "e",

37645

"description": "Event object.",

37646

"type": "Object"

37647

}

37648

],

37649

"access": "private",

37650

"tagname": "",

37651

"class": "ChartBase",

37652

"module": "charts"

37653

},

37654

{

37655

"file": "charts/js/ChartBase.js",

37656

"line": 1156,

37657

"description": "Updates the content of text field. This method writes a value into a text field using \n`appendChild`. If the value is a `String`, it is converted to a `TextNode` first.",

37658

"itemtype": "method",

37659

"name": "_setText",

37660

"params": [

37661

{

37662

"name": "label",

37663

"description": "label to be updated",

37664

"type": "HTMLElement"

37665

},

37666

{

37667

"name": "val",

37668

"description": "value with which to update the label",

37669

"type": "String"

37670

}

37671

],

37672

"access": "private",

37673

"tagname": "",

37674

"class": "ChartBase",

37675

"module": "charts"

37676

},

37677

{

37678

"file": "charts/js/ChartLegend.js",

37679

"line": 10,

37680

"description": "Initializes the chart.",

37681

"itemtype": "method",

37682

"name": "initializer",

37683

"access": "private",

37684

"tagname": "",

37685

"class": "ChartLegend",

37686

"module": "charts",

37687

"submodule": "charts-legend"

37688

},

37689

{

37690

"file": "charts/js/ChartLegend.js",

37691

"line": 21,

37692

"itemtype": "method",

37693

"name": "renderUI",

37694

"access": "private",

37695

"tagname": "",

37696

"class": "ChartLegend",

37697

"module": "charts",

37698

"submodule": "charts-legend"

37699

},

37700

{

37701

"file": "charts/js/ChartLegend.js",

37702

"line": 40,

37703

"itemtype": "method",

37704

"name": "bindUI",

37705

"access": "private",

37706

"tagname": "",

37707

"class": "ChartLegend",

37708

"module": "charts",

37709

"submodule": "charts-legend"

37710

},

37711

{

37712

"file": "charts/js/ChartLegend.js",

37713

"line": 53,

37714

"itemtype": "method",

37715

"name": "syncUI",

37716

"access": "private",

37717

"tagname": "",

37718

"class": "ChartLegend",

37719

"module": "charts",

37720

"submodule": "charts-legend"

37721

},

37722

{

37723

"file": "charts/js/ChartLegend.js",

37724

"line": 67,

37725

"description": "Handles changes to legend.",

37726

"itemtype": "method",

37727

"name": "_updateHandler",

37728

"params": [

37729

{

37730

"name": "e",

37731

"description": "Event object",

37732

"type": "Object"

37733

}

37734

],

37735

"access": "private",

37736

"tagname": "",

37737

"class": "ChartLegend",

37738

"module": "charts",

37739

"submodule": "charts-legend"

37740

},

37741

{

37742

"file": "charts/js/ChartLegend.js",

37743

"line": 82,

37744

"description": "Handles position changes.",

37745

"itemtype": "method",

37746

"name": "_positionChangeHandler",

37747

"params": [

37748

{

37749

"name": "e",

37750

"description": "Event object",

37751

"type": "Object"

37752

}

37753

],

37754

"access": "private",

37755

"tagname": "",

37756

"class": "ChartLegend",

37757

"module": "charts",

37758

"submodule": "charts-legend"

37759

},

37760

{

37761

"file": "charts/js/ChartLegend.js",

37762

"line": 103,

37763

"description": "Updates the legend when the size changes.",

37764

"itemtype": "method",

37765

"name": "_handleSizeChange",

37766

"params": [

37767

{

37768

"name": "e",

37769

"description": "Event object.",

37770

"type": "Object"

37771

}

37772

],

37773

"access": "private",

37774

"tagname": "",

37775

"class": "ChartLegend",

37776

"module": "charts",

37777

"submodule": "charts-legend"

37778

},

37779

{

37780

"file": "charts/js/ChartLegend.js",

37781

"line": 122,

37782

"description": "Draws the legend",

37783

"itemtype": "method",

37784

"name": "_drawLegend",

37785

"access": "private",

37786

"tagname": "",

37787

"class": "ChartLegend",

37788

"module": "charts",

37789

"submodule": "charts-legend"

37790

},

37791

{

37792

"file": "charts/js/ChartLegend.js",

37793

"line": 256,

37794

"description": "Updates the background for the legend.",

37795

"itemtype": "method",

37796

"name": "_updateBackground",

37797

"params": [

37798

{

37799

"name": "styles",

37800

"description": "Reference to the legend's styles attribute",

37801

"type": "Object"

37802

}

37803

],

37804

"access": "private",

37805

"tagname": "",

37806

"class": "ChartLegend",

37807

"module": "charts",

37808

"submodule": "charts-legend"

37809

},

37810

{

37811

"file": "charts/js/ChartLegend.js",

37812

"line": 282,

37813

"description": "Retrieves the marker styles based on the type of series. For series that contain a marker, the marker styles are returned.",

37814

"itemtype": "method",

37815

"name": "_getStylesBySeriesType",

37816

"params": [

37817

{

37818

"name": "The",

37819

"description": "series in which the style properties will be received.",

37820

"type": "CartesianSeries | PieSeries"

37821

}

37822

],

37823

"return": {

37824

"description": "Object An object containing fill, border and shape information."

37825

},

37826

"access": "private",

37827

"tagname": "",

37828

"class": "ChartLegend",

37829

"module": "charts",

37830

"submodule": "charts-legend"

37831

},

37832

{

37833

"file": "charts/js/ChartLegend.js",

37834

"line": 337,

37835

"description": "Returns a legend item consisting of the following properties:\n <dl>\n <dt>node</dt><dd>The `Node` containing the legend item elements.</dd>\n <dt>shape</dt><dd>The `Shape` element for the legend item.</dd>\n <dt>textNode</dt><dd>The `Node` containing the text></dd>\n <dt>text</dt><dd></dd>\n </dl>",

37836

"itemtype": "method",

37837

"name": "_getLegendItem",

37838

"params": [

37839

{

37840

"name": "shapeProps",

37841

"description": "Reference to the `node` attribute.",

37842

"type": "Node"

37843

},

37844

{

37845

"name": "shapeClass",

37846

"description": "The type of shape",

37847

"type": "String | Class"

37848

},

37849

{

37850

"name": "fill",

37851

"description": "Properties for the shape's fill",

37852

"type": "Object"

37853

},

37854

{

37855

"name": "border",

37856

"description": "Properties for the shape's border",

37857

"type": "Object"

37858

},

37859

{

37860

"name": "text",

37861

"description": "String to be rendered as the legend's text",

37862

"type": "String"

37863

},

37864

{

37865

"name": "width",

37866

"description": "Total width of the legend item",

37867

"type": "Number"

37868

},

37869

{

37870

"name": "height",

37871

"description": "Total height of the legend item",

37872

"type": "Number"

37873

},

37874

{

37875

"name": "text",

37876

"description": "Text for the legendItem",

37877

"type": "HTML | String"

37878

}

37879

],

37880

"return": {

37881

"description": "Object"

37882

},

37883

"access": "private",

37884

"tagname": "",

37885

"class": "ChartLegend",

37886

"module": "charts",

37887

"submodule": "charts-legend"

37888

},

37889

{

37890

"file": "charts/js/ChartLegend.js",

37891

"line": 403,

37892

"description": "Evaluates and returns correct class for drawing a shape.",

37893

"itemtype": "method",

37894

"name": "_getShapeClass",

37895

"return": {

37896

"description": "Shape"

37897

},

37898

"access": "private",

37899

"tagname": "",

37900

"class": "ChartLegend",

37901

"module": "charts",

37902

"submodule": "charts-legend"

37903

},

37904

{

37905

"file": "charts/js/ChartLegend.js",

37906

"line": 416,

37907

"description": "Returns the default hash for the `styles` attribute.",

37908

"itemtype": "method",

37909

"name": "_getDefaultStyles",

37910

"return": {

37911

"description": "Object"

37912

},

37913

"access": "protected",

37914

"tagname": "",

37915

"class": "ChartLegend",

37916

"module": "charts",

37917

"submodule": "charts-legend"

37918

},

37919

{

37920

"file": "charts/js/ChartLegend.js",

37921

"line": 458,

37922

"description": "Gets the default values for series that use the utility. This method is used by\nthe class' `styles` attribute's getter to get build default values.",

37923

"itemtype": "method",

37924

"name": "_getPlotDefaults",

37925

"return": {

37926

"description": "Object"

37927

},

37928

"access": "protected",

37929

"tagname": "",

37930

"class": "ChartLegend",

37931

"module": "charts",

37932

"submodule": "charts-legend"

37933

},

37934

{

37935

"file": "charts/js/ChartLegend.js",

37936

"line": 475,

37937

"description": "Destroys legend items.",

37938

"itemtype": "method",

37939

"name": "_destroyLegendItems",

37940

"access": "private",

37941

"tagname": "",

37942

"class": "ChartLegend",

37943

"module": "charts",

37944

"submodule": "charts-legend"

37945

},

37946

{

37947

"file": "charts/js/ChartLegend.js",

37948

"line": 498,

37949

"description": "Maps layout classes.",

37950

"itemtype": "property",

37951

"name": "_layout",

37952

"access": "private",

37953

"tagname": "",

37954

"class": "ChartLegend",

37955

"module": "charts",

37956

"submodule": "charts-legend"

37957

},

37958

{

37959

"file": "charts/js/ChartLegend.js",

37960

"line": 509,

37961

"description": "Destructor implementation ChartLegend class. Removes all items and the Graphic instance from the widget.",

37962

"itemtype": "method",

37963

"name": "destructor",

37964

"access": "protected",

37965

"tagname": "",

37966

"class": "ChartLegend",

37967

"module": "charts",

37968

"submodule": "charts-legend"

37969

},

37970

{

37971

"file": "charts/js/ChartLegend.js",

37972

"line": 526,

37973

"description": "Indicates whether the chart's contentBox is the parentNode for the legend.",

37974

"itemtype": "attribute",

37975

"name": "includeInChartLayout",

37976

"type": "Boolean",

37977

"access": "private",

37978

"tagname": "",

37979

"class": "ChartLegend",

37980

"module": "charts",

37981

"submodule": "charts-legend"

37982

},

37983

{

37984

"file": "charts/js/ChartLegend.js",

37985

"line": 537,

37986

"description": "Reference to the `Chart` instance.",

37987

"itemtype": "attribute",

37988

"name": "chart",

37989

"type": "Chart",

37990

"class": "ChartLegend",

37991

"module": "charts",

37992

"submodule": "charts-legend"

37993

},

37994

{

37995

"file": "charts/js/ChartLegend.js",

37996

"line": 551,

37997

"description": "Indicates the direction in relation of the legend's layout. The `direction` of the legend is determined by its\n`position` value.",

37998

"itemtype": "attribute",

37999

"name": "direction",

38000

"type": "String",

38001

"class": "ChartLegend",

38002

"module": "charts",

38003

"submodule": "charts-legend"

38004

},

38005

{

38006

"file": "charts/js/ChartLegend.js",

38007

"line": 562,

38008

"description": "Indicates the position and direction of the legend. Possible values are `left`, `top`, `right` and `bottom`. Values of `left` and\n`right` values have a `direction` of `vertical`. Values of `top` and `bottom` values have a `direction` of `horizontal`.",

38009

"itemtype": "attribute",

38010

"name": "position",

38011

"type": "String",

38012

"class": "ChartLegend",

38013

"module": "charts",

38014

"submodule": "charts-legend"

38015

},

38016

{

38017

"file": "charts/js/ChartLegend.js",

38018

"line": 588,

38019

"description": "The width of the legend. Depending on the implementation of the ChartLegend, this value is `readOnly`. By default, the legend is included in the layout of the `Chart` that \nit references. Under this circumstance, `width` is always `readOnly`. When the legend is rendered in its own dom element, the `readOnly` status is determined by the \ndirection of the legend. If the `position` is `left` or `right` or the `direction` is `vertical`, width is `readOnly`. If the position is `top` or `bottom` or the `direction`\nis `horizontal`, width can be explicitly set. If width is not explicitly set, the width will be determined by the width of the legend's parent element.",

38020

"itemtype": "attribute",

38021

"name": "width",

38022

"type": "Number",

38023

"class": "ChartLegend",

38024

"module": "charts",

38025

"submodule": "charts-legend"

38026

},

38027

{

38028

"file": "charts/js/ChartLegend.js",

38029

"line": 627,

38030

"description": "The height of the legend. Depending on the implementation of the ChartLegend, this value is `readOnly`. By default, the legend is included in the layout of the `Chart` that \nit references. Under this circumstance, `height` is always `readOnly`. When the legend is rendered in its own dom element, the `readOnly` status is determined by the \ndirection of the legend. If the `position` is `top` or `bottom` or the `direction` is `horizontal`, height is `readOnly`. If the position is `left` or `right` or the `direction`\nis `vertical`, height can be explicitly set. If height is not explicitly set, the height will be determined by the width of the legend's parent element.",

38031

"itemtype": "attribute",

38032

"name": "height",

38033

"type": "Number",

38034

"class": "ChartLegend",

38035

"module": "charts",

38036

"submodule": "charts-legend"

38037

},

38038

{

38039

"file": "charts/js/ChartLegend.js",

38040

"line": 668,

38041

"description": "Indicates the x position of legend.",

38042

"itemtype": "attribute",

38043

"name": "x",

38044

"type": "Number",

38045

"readonly": "",

38046

"class": "ChartLegend",

38047

"module": "charts",

38048

"submodule": "charts-legend"

38049

},

38050

{

38051

"file": "charts/js/ChartLegend.js",

38052

"line": 691,

38053

"description": "Indicates the y position of legend.",

38054

"itemtype": "attribute",

38055

"name": "y",

38056

"type": "Number",

38057

"readonly": "",

38058

"class": "ChartLegend",

38059

"module": "charts",

38060

"submodule": "charts-legend"

38061

},

38062

{

38063

"file": "charts/js/ChartLegend.js",

38064

"line": 714,

38065

"description": "Background for the legend.",

38066

"itemtype": "attribute",

38067

"name": "background",

38068

"type": "Rect",

38069

"class": "ChartLegend",

38070

"module": "charts",

38071

"submodule": "charts-legend"

38072

},

38073

{

38074

"file": "charts/js/ChartLegend.js",

38075

"line": 722,

38076

"description": "Properties used to display and style the ChartLegend. This attribute is inherited from `Renderer`. Below are the default values:\n\n <dl>\n <dt>gap</dt><dd>Distance, in pixels, between the `ChartLegend` instance and the chart's content. When `ChartLegend` is rendered within a `Chart` instance this value is applied.</dd>\n <dt>hAlign</dt><dd>Defines the horizontal alignment of the `items` in a `ChartLegend` rendered in a horizontal direction. This value is applied when the instance's `position` is set to top or bottom. This attribute can be set to left, center or right. The default value is center.</dd>\n <dt>vAlign</dt><dd>Defines the vertical alignment of the `items` in a `ChartLegend` rendered in vertical direction. This value is applied when the instance's `position` is set to left or right. The attribute can be set to top, middle or bottom. The default value is middle.</dd>\n <dt>item</dt><dd>Set of style properties applied to the `items` of the `ChartLegend`.\n <dl>\n <dt>hSpacing</dt><dd>Horizontal distance, in pixels, between legend `items`.</dd>\n <dt>vSpacing</dt><dd>Vertical distance, in pixels, between legend `items`.</dd>\n <dt>label</dt><dd>Properties for the text of an `item`.\n <dl>\n <dt>color</dt><dd>Color of the text. The default values is \"#808080\".</dd>\n <dt>fontSize</dt><dd>Font size for the text. The default value is \"85%\".</dd>\n </dl>\n </dd>\n <dt>marker</dt><dd>Properties for the `item` markers.\n <dl>\n <dt>width</dt><dd>Specifies the width of the markers.</dd>\n <dt>height</dt><dd>Specifies the height of the markers.</dd>\n </dl>\n </dd>\n </dl>\n </dd>\n <dt>background</dt><dd>Properties for the `ChartLegend` background.\n <dl>\n <dt>fill</dt><dd>Properties for the background fill.\n <dl>\n <dt>color</dt><dd>Color for the fill. The default value is \"#faf9f2\".</dd>\n </dl>\n </dd>\n <dt>border</dt><dd>Properties for the background border.\n <dl>\n <dt>color</dt><dd>Color for the border. The default value is \"#dad8c9\".</dd>\n <dt>weight</dt><dd>Weight of the border. The default values is 1.</dd>\n </dl>\n </dd>\n </dl>\n </dd>\n</dl>",

38077

"itemtype": "attribute",

38078

"name": "styles",

38079

"type": "Object",

38080

"class": "ChartLegend",

38081

"module": "charts",

38082

"submodule": "charts-legend"

38083

},

38084

{

38085

"file": "charts/js/CircleGroup.js",

38086

"line": 16,

38087

"description": "Algorithm for drawing shape.",

38088

"itemtype": "method",

38089

"name": "drawShape",

38090

"params": [

38091

{

38092

"name": "cfg",

38093

"description": "Parameters used to draw the shape.",

38094

"type": "Object"

38095

}

38096

],

38097

"class": "GroupCircle",

38098

"module": "graphics"

38099

},

38100

{

38101

"file": "charts/js/ColumnSeries.js",

38102

"line": 13,

38103

"description": "Helper method for calculating the size of markers.",

38104

"itemtype": "method",

38105

"name": "_getMarkerDimensions",

38106

"params": [

38107

{

38108

"name": "xcoord",

38109

"description": "The x-coordinate representing the data point for the marker.",

38110

"type": "Number"

38111

},

38112

{

38113

"name": "ycoord",

38114

"description": "The y-coordinate representing the data point for the marker.",

38115

"type": "Number"

38116

},

38117

{

38118

"name": "calculatedSize",

38119

"description": "The calculated size for the marker. For a `BarSeries` is it the width. For a `ColumnSeries` it is the height.",

38120

"type": "Number"

38121

},

38122

{

38123

"name": "offset",

38124

"description": "Distance of position offset dictated by other marker series in the same graph.",

38125

"type": "Number"

38126

}

38127

],

38128

"return": {

38129

"description": "Object"

38130

},

38131

"access": "private",

38132

"tagname": "",

38133

"class": "ColumnSeries",

38134

"module": "charts"

38135

},

38136

{

38137

"file": "charts/js/ColumnSeries.js",

38138

"line": 42,

38139

"description": "Resizes and positions markers based on a mouse interaction.",

38140

"itemtype": "method",

38141

"name": "updateMarkerState",

38142

"params": [

38143

{

38144

"name": "type",

38145

"description": "state of the marker",

38146

"type": "String"

38147

},

38148

{

38149

"name": "i",

38150

"description": "index of the marker",

38151

"type": "Number"

38152

}

38153

],

38154

"access": "protected",

38155

"tagname": "",

38156

"class": "ColumnSeries",

38157

"module": "charts"

38158

},

38159

{

38160

"file": "charts/js/ColumnSeries.js",

38161

"line": 106,

38162

"description": "Read-only attribute indicating the type of series.",

38163

"itemtype": "attribute",

38164

"name": "type",

38165

"type": "String",

38166

"readonly": "",

38167

"default": "column",

38168

"class": "ColumnSeries",

38169

"module": "charts"

38170

},

38171

{

38172

"file": "charts/js/ColumnSeries.js",

38173

"line": 118,

38174

"description": "Style properties used for drawing markers. This attribute is inherited from `MarkerSeries`. Below are the default values:\n <dl>\n <dt>fill</dt><dd>A hash containing the following values:\n <dl>\n <dt>color</dt><dd>Color of the fill. The default value is determined by the order of the series on the graph. The color\n will be retrieved from the below array: \n `[\"#66007f\", \"#a86f41\", \"#295454\", \"#996ab2\", \"#e8cdb7\", \"#90bdbd\",\"#000000\",\"#c3b8ca\", \"#968373\", \"#678585\"]`\n </dd>\n <dt>alpha</dt><dd>Number from 0 to 1 indicating the opacity of the marker fill. The default value is 1.</dd>\n </dl>\n </dd>\n <dt>border</dt><dd>A hash containing the following values:\n <dl>\n <dt>color</dt><dd>Color of the border. The default value is determined by the order of the series on the graph. The color\n will be retrieved from the below array: \n `[\"#205096\", \"#b38206\", \"#000000\", \"#94001e\", \"#9d6fa0\", \"#e55b00\", \"#5e85c9\", \"#adab9e\", \"#6ac291\", \"#006457\"]`\n <dt>alpha</dt><dd>Number from 0 to 1 indicating the opacity of the marker border. The default value is 1.</dd>\n <dt>weight</dt><dd>Number indicating the width of the border. The default value is 1.</dd>\n </dl>\n </dd>\n <dt>width</dt><dd>indicates the width of the marker. The default value is 12.</dd>\n <dt>over</dt><dd>hash containing styles for markers when highlighted by a `mouseover` event. The default \n values for each style is null. When an over style is not set, the non-over value will be used. For example,\n the default value for `marker.over.fill.color` is equivalent to `marker.fill.color`.</dd>\n </dl>",

38175

"itemtype": "attribute",

38176

"name": "styles",

38177

"type": "Object",

38178

"class": "ColumnSeries",

38179

"module": "charts"

38180

},

38181

{

38182

"file": "charts/js/ComboSeries.js",

38183

"line": 15,

38184

"access": "protected",

38185

"tagname": "Draws the series.",

38186

"itemtype": "method",

38187

"name": "drawSeries",

38188

"class": "ComboSeries",

38189

"module": "charts"

38190

},

38191

{

38192

"file": "charts/js/ComboSeries.js",

38193

"line": 38,

38194

"description": "Toggles visibility",

38195

"itemtype": "method",

38196

"name": "_toggleVisible",

38197

"params": [

38198

{

38199

"name": "visible",

38200

"description": "indicates visibilitye",

38201

"type": "Boolean"

38202

}

38203

],

38204

"access": "private",

38205

"tagname": "",

38206

"class": "ComboSeries",

38207

"module": "charts"

38208

},

38209

{

38210

"file": "charts/js/ComboSeries.js",

38211

"line": 78,

38212

"access": "protected",

38213

"tagname": "Returns the default hash for the `styles` attribute.",

38214

"itemtype": "method",

38215

"name": "_getDefaultStyles",

38216

"return": {

38217

"description": "Object"

38218

},

38219

"class": "ComboSeries",

38220

"module": "charts"

38221

},

38222

{

38223

"file": "charts/js/ComboSeries.js",

38224

"line": 97,

38225

"description": "Read-only attribute indicating the type of series.",

38226

"itemtype": "attribute",

38227

"name": "type",

38228

"type": "String",

38229

"default": "combo",

38230

"class": "ComboSeries",

38231

"module": "charts"

38232

},

38233

{

38234

"file": "charts/js/ComboSeries.js",

38235

"line": 108,

38236

"description": "Indicates whether a fill is displayed.",

38237

"itemtype": "attribute",

38238

"name": "showAreaFill",

38239

"type": "Boolean",

38240

"default": "false",

38241

"class": "ComboSeries",

38242

"module": "charts"

38243

},

38244

{

38245

"file": "charts/js/ComboSeries.js",

38246

"line": 119,

38247

"description": "Indicates whether lines are displayed.",

38248

"itemtype": "attribute",

38249

"name": "showLines",

38250

"type": "Boolean",

38251

"default": "true",

38252

"class": "ComboSeries",

38253

"module": "charts"

38254

},

38255

{

38256

"file": "charts/js/ComboSeries.js",

38257

"line": 130,

38258

"description": "Indicates whether markers are displayed.",

38259

"itemtype": "attribute",

38260

"name": "showMarkers",

38261

"type": "Boolean",

38262

"default": "true",

38263

"class": "ComboSeries",

38264

"module": "charts"

38265

},

38266

{

38267

"file": "charts/js/ComboSeries.js",

38268

"line": 141,

38269

"description": "Reference to the styles of the markers. These styles can also\nbe accessed through the `styles` attribute. Below are default\nvalues:\n <dl>\n <dt>fill</dt><dd>A hash containing the following values:\n <dl>\n <dt>color</dt><dd>Color of the fill. The default value is determined by the order of the series on the graph. The color\n will be retrieved from the below array: \n `[\"#6084d0\", \"#eeb647\", \"#6c6b5f\", \"#d6484f\", \"#ce9ed1\", \"#ff9f3b\", \"#93b7ff\", \"#e0ddd0\", \"#94ecba\", \"#309687\"]`\n </dd>\n <dt>alpha</dt><dd>Number from 0 to 1 indicating the opacity of the marker fill. The default value is 1.</dd>\n </dl>\n </dd>\n <dt>border</dt><dd>A hash containing the following values:\n <dl>\n <dt>color</dt><dd>Color of the border. The default value is determined by the order of the series on the graph. The color\n will be retrieved from the below array: \n `[\"#205096\", \"#b38206\", \"#000000\", \"#94001e\", \"#9d6fa0\", \"#e55b00\", \"#5e85c9\", \"#adab9e\", \"#6ac291\", \"#006457\"]`\n <dt>alpha</dt><dd>Number from 0 to 1 indicating the opacity of the marker border. The default value is 1.</dd>\n <dt>weight</dt><dd>Number indicating the width of the border. The default value is 1.</dd>\n </dl>\n </dd>\n <dt>width</dt><dd>indicates the width of the marker. The default value is 10.</dd>\n <dt>height</dt><dd>indicates the height of the marker The default value is 10.</dd>\n <dt>over</dt><dd>hash containing styles for markers when highlighted by a `mouseover` event. The default \n values for each style is null. When an over style is not set, the non-over value will be used. For example,\n the default value for `marker.over.fill.color` is equivalent to `marker.fill.color`.</dd>\n </dl>",

38270

"itemtype": "attribute",

38271

"name": "marker",

38272

"type": "Object",

38273

"class": "ComboSeries",

38274

"module": "charts"

38275

},

38276

{

38277

"file": "charts/js/ComboSeries.js",

38278

"line": 186,

38279

"description": "Reference to the styles of the lines. These styles can also be accessed through the `styles` attribute.\nBelow are the default values:\n <dl>\n <dt>color</dt><dd>The color of the line. The default value is determined by the order of the series on the graph. The color will be\n retrieved from the following array: \n `[\"#426ab3\", \"#d09b2c\", \"#000000\", \"#b82837\", \"#b384b5\", \"#ff7200\", \"#779de3\", \"#cbc8ba\", \"#7ed7a6\", \"#007a6c\"]`\n <dt>weight</dt><dd>Number that indicates the width of the line. The default value is 6.</dd>\n <dt>alpha</dt><dd>Number between 0 and 1 that indicates the opacity of the line. The default value is 1.</dd>\n <dt>lineType</dt><dd>Indicates whether the line is solid or dashed. The default value is solid.</dd> \n <dt>dashLength</dt><dd>When the `lineType` is dashed, indicates the length of the dash. The default value is 10.</dd>\n <dt>gapSpace</dt><dd>When the `lineType` is dashed, indicates the distance between dashes. The default value is 10.</dd>\n <dt>connectDiscontinuousPoints</dt><dd>Indicates whether or not to connect lines when there is a missing or null value between points. The default value is true.</dd> \n <dt>discontinuousType</dt><dd>Indicates whether the line between discontinuous points is solid or dashed. The default value is solid.</dd>\n <dt>discontinuousDashLength</dt><dd>When the `discontinuousType` is dashed, indicates the length of the dash. The default value is 10.</dd>\n <dt>discontinuousGapSpace</dt><dd>When the `discontinuousType` is dashed, indicates the distance between dashes. The default value is 10.</dd>\n </dl>",

38280

"itemtype": "attribute",

38281

"name": "line",

38282

"type": "Object",

38283

"class": "ComboSeries",

38284

"module": "charts"

38285

},

38286

{

38287

"file": "charts/js/ComboSeries.js",

38288

"line": 219,

38289

"description": "Reference to the styles of the area fills. These styles can also be accessed through the `styles` attribute.\nBelow are the default values:\n\n <dl>\n <dt>color</dt><dd>The color of the fill. The default value is determined by the order of the series on the graph. The color will be \n retrieved from the following array:\n `[\"#66007f\", \"#a86f41\", \"#295454\", \"#996ab2\", \"#e8cdb7\", \"#90bdbd\",\"#000000\",\"#c3b8ca\", \"#968373\", \"#678585\"]`\n </dd>\n <dt>alpha</dt><dd>Number between 0 and 1 that indicates the opacity of the fill. The default value is 1</dd>\n </dl>",

38290

"itemtype": "attribute",

38291

"name": "area",

38292

"type": "Object",

38293

"class": "ComboSeries",

38294

"module": "charts"

38295

},

38296

{

38297

"file": "charts/js/ComboSeries.js",

38298

"line": 246,

38299

"description": "Style properties for the series. Contains a key indexed hash of the following:\n <dl>\n <dt>marker</dt><dd>Style properties for the markers in the series. Specific style attributes are listed\n <a href=\"#attr_marker\">here</a>.</dd>\n <dt>line</dt><dd>Style properties for the lines in the series. Specific\n style attributes are listed <a href=\"#attr_line\">here</a>.</dd>\n <dt>area</dt><dd>Style properties for the area fills in the series. Specific style attributes are listed\n <a href=\"#attr_area\">here</a>.</dd>\n </dl>",

38300

"itemtype": "attribute",

38301

"name": "styles",

38302

"type": "Object",

38303

"class": "ComboSeries",

38304

"module": "charts"

38305

},

38306

{

38307

"file": "charts/js/ComboSplineSeries.js",

38308

"line": 13,

38309

"access": "protected",

38310

"tagname": "Draws the series.",

38311

"itemtype": "method",

38312

"name": "drawSeries",

38313

"class": "ComboSplineSeries",

38314

"module": "charts"

38315

},

38316

{

38317

"file": "charts/js/ComboSplineSeries.js",

38318

"line": 37,

38319

"description": "Read-only attribute indicating the type of series.",

38320

"itemtype": "attribute",

38321

"name": "type",

38322

"type": "String",

38323

"default": "comboSpline",

38324

"class": "ComboSplineSeries",

38325

"module": "charts"

38326

},

38327

{

38328

"file": "charts/js/CurveUtil.js",

38329

"line": 13,

38330

"description": "Creates an array of start, end and control points for splines.",

38331

"itemtype": "method",

38332

"name": "getCurveControlPoints",

38333

"params": [

38334

{

38335

"name": "xcoords",

38336

"description": "Collection of x-coordinates used for calculate the curves",

38337

"type": "Array"

38338

},

38339

{

38340

"name": "ycoords",

38341

"description": "Collection of y-coordinates used for calculate the curves",

38342

"type": "Array"

38343

}

38344

],

38345

"return": {

38346

"description": "Object"

38347

},

38348

"access": "protected",

38349

"tagname": "",

38350

"class": "CurveUtil",

38351

"module": "charts"

38352

},

38353

{

38354

"file": "charts/js/CurveUtil.js",

38355

"line": 88,

38356

"description": "Gets the control points for the curve.",

38357

"itemtype": "method",

38358

"name": "getControlPoints",

38359

"params": [

38360

{

38361

"name": "vals",

38362

"description": "Collection of values coords used to generate control points.",

38363

"type": "Array"

38364

}

38365

],

38366

"return": {

38367

"description": "Array"

38368

},

38369

"access": "private",

38370

"tagname": "",

38371

"class": "CurveUtil",

38372

"module": "charts"

38373

},

38374

{

38375

"file": "charts/js/DiamondGroup.js",

38376

"line": 16,

38377

"description": "Updates the diamond.",

38378

"itemtype": "method",

38379

"name": "_draw",

38380

"access": "private",

38381

"tagname": "",

38382

"class": "GroupDiamond",

38383

"module": "graphics"

38384

},

38385

{

38386

"file": "charts/js/EllipseGroup.js",

38387

"line": 16,

38388

"description": "Updates the diamond.",

38389

"itemtype": "method",

38390

"name": "_draw",

38391

"access": "private",

38392

"tagname": "",

38393

"class": "EllipseGroup",

38394

"module": "graphics"

38395

},

38396

{

38397

"file": "charts/js/Fills.js",

38398

"line": 29,

38399

"description": "Returns a path shape used for drawing fills.",

38400

"itemtype": "method",

38401

"name": "_getPath",

38402

"return": {

38403

"description": "Path"

38404

},

38405

"access": "private",

38406

"tagname": "",

38407

"class": "Fills",

38408

"module": "charts"

38409

},

38410

{

38411

"file": "charts/js/Fills.js",

38412

"line": 47,

38413

"description": "Toggles visibility",

38414

"itemtype": "method",

38415

"name": "_toggleVisible",

38416

"params": [

38417

{

38418

"name": "visible",

38419

"description": "indicates visibilitye",

38420

"type": "Boolean"

38421

}

38422

],

38423

"access": "private",

38424

"tagname": "",

38425

"class": "Fills",

38426

"module": "charts"

38427

},

38428

{

38429

"file": "charts/js/Fills.js",

38430

"line": 62,

38431

"description": "Draws fill",

38432

"itemtype": "method",

38433

"name": "drawFill",

38434

"params": [

38435

{

38436

"name": "xcoords",

38437

"description": "The x-coordinates for the series.",

38438

"type": "Array"

38439

},

38440

{

38441

"name": "ycoords",

38442

"description": "The y-coordinates for the series.",

38443

"type": "Array"

38444

}

38445

],

38446

"access": "protected",

38447

"tagname": "",

38448

"class": "Fills",

38449

"module": "charts"

38450

},

38451

{

38452

"file": "charts/js/Fills.js",

38453

"line": 111,

38454

"description": "Draws a fill for a spline",

38455

"itemtype": "method",

38456

"name": "drawAreaSpline",

38457

"access": "protected",

38458

"tagname": "",

38459

"class": "Fills",

38460

"module": "charts"

38461

},

38462

{

38463

"file": "charts/js/Fills.js",

38464

"line": 169,

38465

"description": "Draws a a stacked area spline",

38466

"itemtype": "method",

38467

"name": "drawStackedAreaSpline",

38468

"access": "protected",

38469

"tagname": "",

38470

"class": "Fills",

38471

"module": "charts"

38472

},

38473

{

38474

"file": "charts/js/Fills.js",

38475

"line": 260,

38476

"description": "Storage for default area styles.",

38477

"itemtype": "property",

38478

"name": "_defaults",

38479

"type": "Object",

38480

"access": "private",

38481

"tagname": "",

38482

"class": "Fills",

38483

"module": "charts"

38484

},

38485

{

38486

"file": "charts/js/Fills.js",

38487

"line": 269,

38488

"description": "Concatenates coordinate array with correct coordinates for closing an area fill.",

38489

"itemtype": "method",

38490

"name": "_getClosingPoints",

38491

"return": {

38492

"description": "Array"

38493

},

38494

"access": "protected",

38495

"tagname": "",

38496

"class": "Fills",

38497

"module": "charts"

38498

},

38499

{

38500

"file": "charts/js/Fills.js",

38501

"line": 299,

38502

"description": "Concatenates coordinate array with the correct coordinates for closing an area stack.",

38503

"itemtype": "method",

38504

"name": "_getStackedClosingPoints",

38505

"return": {

38506

"description": "Array"

38507

},

38508

"access": "protected",

38509

"tagname": "",

38510

"class": "Fills",

38511

"module": "charts"

38512

},

38513

{

38514

"file": "charts/js/Fills.js",

38515

"line": 349,

38516

"description": "Returns default values for area styles.",

38517

"itemtype": "method",

38518

"name": "_getAreaDefaults",

38519

"return": {

38520

"description": "Object"

38521

},

38522

"access": "private",

38523

"tagname": "",

38524

"class": "Fills",

38525

"module": "charts"

38526

},

38527

{

38528

"file": "charts/js/Graph.js",

38529

"line": 12,

38530

"itemtype": "method",

38531

"name": "bindUI",

38532

"access": "private",

38533

"tagname": "",

38534

"class": "Graph",

38535

"module": "charts"

38536

},

38537

{

38538

"file": "charts/js/Graph.js",

38539

"line": 25,

38540

"itemtype": "method",

38541

"name": "syncUI",

38542

"access": "private",

38543

"tagname": "",

38544

"class": "Graph",

38545

"module": "charts"

38546

},

38547

{

38548

"file": "charts/js/Graph.js",

38549

"line": 71,

38550

"description": "Object of arrays containing series mapped to a series type.",

38551

"itemtype": "property",

38552

"name": "seriesTypes",

38553

"type": "Object",

38554

"access": "private",

38555

"tagname": "",

38556

"class": "Graph",

38557

"module": "charts"

38558

},

38559

{

38560

"file": "charts/js/Graph.js",

38561

"line": 80,

38562

"description": "Returns a series instance based on an index.",

38563

"itemtype": "method",

38564

"name": "getSeriesByIndex",

38565

"params": [

38566

{

38567

"name": "val",

38568

"description": "index of the series",

38569

"type": "Number"

38570

}

38571

],

38572

"return": {

38573

"description": "CartesianSeries"

38574

},

38575

"class": "Graph",

38576

"module": "charts"

38577

},

38578

{

38579

"file": "charts/js/Graph.js",

38580

"line": 98,

38581

"description": "Returns a series instance based on a key value.",

38582

"itemtype": "method",

38583

"name": "getSeriesByKey",

38584

"params": [

38585

{

38586

"name": "val",

38587

"description": "key value of the series",

38588

"type": "String"

38589

}

38590

],

38591

"return": {

38592

"description": "CartesianSeries"

38593

},

38594

"class": "Graph",

38595

"module": "charts"

38596

},

38597

{

38598

"file": "charts/js/Graph.js",

38599

"line": 116,

38600

"description": "Adds dispatcher to a `_dispatcher` used to\nto ensure all series have redrawn before for firing event.",

38601

"itemtype": "method",

38602

"name": "addDispatcher",

38603

"params": [

38604

{

38605

"name": "val",

38606

"description": "series instance to add",

38607

"type": "CartesianSeries"

38608

}

38609

],

38610

"access": "protected",

38611

"tagname": "",

38612

"class": "Graph",

38613

"module": "charts"

38614

},

38615

{

38616

"file": "charts/js/Graph.js",

38617

"line": 133,

38618

"description": "Collection of series to be displayed in the graph.",

38619

"itemtype": "property",

38620

"name": "_seriesCollection",

38621

"type": "Array",

38622

"access": "private",

38623

"tagname": "",

38624

"class": "Graph",

38625

"module": "charts"

38626

},

38627

{

38628

"file": "charts/js/Graph.js",

38629

"line": 142,

38630

"description": "Object containing key value pairs of `CartesianSeries` instances.",

38631

"itemtype": "property",

38632

"name": "_seriesDictionary",

38633

"type": "Object",

38634

"access": "private",

38635

"tagname": "",

38636

"class": "Graph",

38637

"module": "charts"

38638

},

38639

{

38640

"file": "charts/js/Graph.js",

38641

"line": 151,

38642

"description": "Parses series instances to be displayed in the graph.",

38643

"itemtype": "method",

38644

"name": "_parseSeriesCollection",

38645

"params": [

38646

{

38647

"name": "Collection",

38648

"description": "of `CartesianSeries` instances or objects container `CartesianSeries` attributes values.",

38649

"type": "Array"

38650

}

38651

],

38652

"access": "private",

38653

"tagname": "",

38654

"class": "Graph",

38655

"module": "charts"

38656

},

38657

{

38658

"file": "charts/js/Graph.js",

38659

"line": 199,

38660

"description": "Adds a series to the graph.",

38661

"itemtype": "method",

38662

"name": "_addSeries",

38663

"params": [

38664

{

38665

"name": "series",

38666

"description": "Series to add to the graph.",

38667

"type": "CartesianSeries"

38668

}

38669

],

38670

"access": "private",

38671

"tagname": "",

38672

"class": "Graph",

38673

"module": "charts"

38674

},

38675

{

38676

"file": "charts/js/Graph.js",

38677

"line": 231,

38678

"description": "Creates a `CartesianSeries` instance from an object containing attribute key value pairs. The key value pairs include attributes for the specific series and a type value which defines the type of\nseries to be used.",

38679

"itemtype": "method",

38680

"name": "createSeries",

38681

"params": [

38682

{

38683

"name": "seriesData",

38684

"description": "Series attribute key value pairs.",

38685

"type": "Object"

38686

}

38687

],

38688

"access": "private",

38689

"tagname": "",

38690

"class": "Graph",

38691

"module": "charts"

38692

},

38693

{

38694

"file": "charts/js/Graph.js",

38695

"line": 264,

38696

"description": "String reference for pre-defined `Series` classes.",

38697

"itemtype": "property",

38698

"name": "_seriesMap",

38699

"type": "Object",

38700

"access": "private",

38701

"tagname": "",

38702

"class": "Graph",

38703

"module": "charts"

38704

},

38705

{

38706

"file": "charts/js/Graph.js",

38707

"line": 295,

38708

"description": "Returns a specific `CartesianSeries` class based on key value from a look up table of a direct reference to a class. When specifying a key value, the following options\nare available:\n\n <table>\n <tr><th>Key Value</th><th>Class</th></tr>\n <tr><td>line</td><td>Y.LineSeries</td></tr> \n <tr><td>column</td><td>Y.ColumnSeries</td></tr> \n <tr><td>bar</td><td>Y.BarSeries</td></tr> \n <tr><td>area</td><td>Y.AreaSeries</td></tr> \n <tr><td>stackedarea</td><td>Y.StackedAreaSeries</td></tr> \n <tr><td>stackedline</td><td>Y.StackedLineSeries</td></tr> \n <tr><td>stackedcolumn</td><td>Y.StackedColumnSeries</td></tr> \n <tr><td>stackedbar</td><td>Y.StackedBarSeries</td></tr> \n <tr><td>markerseries</td><td>Y.MarkerSeries</td></tr> \n <tr><td>spline</td><td>Y.SplineSeries</td></tr> \n <tr><td>areaspline</td><td>Y.AreaSplineSeries</td></tr> \n <tr><td>stackedspline</td><td>Y.StackedSplineSeries</td></tr>\n <tr><td>stackedareaspline</td><td>Y.StackedAreaSplineSeries</td></tr>\n <tr><td>stackedmarkerseries</td><td>Y.StackedMarkerSeries</td></tr>\n <tr><td>pie</td><td>Y.PieSeries</td></tr>\n <tr><td>combo</td><td>Y.ComboSeries</td></tr>\n <tr><td>stackedcombo</td><td>Y.StackedComboSeries</td></tr>\n <tr><td>combospline</td><td>Y.ComboSplineSeries</td></tr>\n <tr><td>stackedcombospline</td><td>Y.StackedComboSplineSeries</td></tr>\n </table>\n\nWhen referencing a class directly, you can specify any of the above classes or any custom class that extends `CartesianSeries` or `PieSeries`.",

38709

"itemtype": "method",

38710

"name": "_getSeries",

38711

"params": [

38712

{

38713

"name": "type",

38714

"description": "Series type.",

38715

"type": "String | Object"

38716

}

38717

],

38718

"return": {

38719

"description": "CartesianSeries"

38720

},

38721

"access": "private",

38722

"tagname": "",

38723

"class": "Graph",

38724

"module": "charts"

38725

},

38726

{

38727

"file": "charts/js/Graph.js",

38728

"line": 343,

38729

"description": "Event handler for marker events.",

38730

"itemtype": "method",

38731

"name": "_markerEventHandler",

38732

"params": [

38733

{

38734

"name": "e",

38735

"description": "Event object.",

38736

"type": "Object"

38737

}

38738

],

38739

"access": "private",

38740

"tagname": "",

38741

"class": "Graph",

38742

"module": "charts"

38743

},

38744

{

38745

"file": "charts/js/Graph.js",

38746

"line": 360,

38747

"description": "Collection of `CartesianSeries` instances to be redrawn.",

38748

"itemtype": "property",

38749

"name": "_dispatchers",

38750

"type": "Array",

38751

"access": "private",

38752

"tagname": "",

38753

"class": "Graph",

38754

"module": "charts"

38755

},

38756

{

38757

"file": "charts/js/Graph.js",

38758

"line": 369,

38759

"description": "Updates the `Graph` styles.",

38760

"itemtype": "method",

38761

"name": "_updateStyles",

38762

"access": "private",

38763

"tagname": "",

38764

"class": "Graph",

38765

"module": "charts"

38766

},

38767

{

38768

"file": "charts/js/Graph.js",

38769

"line": 386,

38770

"description": "Event handler for size changes.",

38771

"itemtype": "method",

38772

"name": "_sizeChangeHandler",

38773

"params": [

38774

{

38775

"name": "e",

38776

"description": "Event object.",

38777

"type": "Object"

38778

}

38779

],

38780

"access": "private",

38781

"tagname": "",

38782

"class": "Graph",

38783

"module": "charts"

38784

},

38785

{

38786

"file": "charts/js/Graph.js",

38787

"line": 430,

38788

"description": "Draws each series.",

38789

"itemtype": "method",

38790

"name": "_drawSeries",

38791

"access": "private",

38792

"tagname": "",

38793

"class": "Graph",

38794

"module": "charts"

38795

},

38796

{

38797

"file": "charts/js/Graph.js",

38798

"line": 469,

38799

"description": "Event handler for series drawingComplete event.",

38800

"itemtype": "method",

38801

"name": "_drawingCompleteHandler",

38802

"params": [

38803

{

38804

"name": "e",

38805

"description": "Event object.",

38806

"type": "Object"

38807

}

38808

],

38809

"access": "private",

38810

"tagname": "",

38811

"class": "Graph",

38812

"module": "charts"

38813

},

38814

{

38815

"file": "charts/js/Graph.js",

38816

"line": 496,

38817

"description": "Gets the default value for the `styles` attribute. Overrides\nbase implementation.",

38818

"itemtype": "method",

38819

"name": "_getDefaultStyles",

38820

"return": {

38821

"description": "Object"

38822

},

38823

"access": "protected",

38824

"tagname": "",

38825

"class": "Graph",

38826

"module": "charts"

38827

},

38828

{

38829

"file": "charts/js/Graph.js",

38830

"line": 521,

38831

"description": "Destructor implementation Graph class. Removes all Graphic instances from the widget.",

38832

"itemtype": "method",

38833

"name": "destructor",

38834

"access": "protected",

38835

"tagname": "",

38836

"class": "Graph",

38837

"module": "charts"

38838

},

38839

{

38840

"file": "charts/js/Graph.js",

38841

"line": 544,

38842

"description": "The x-coordinate for the graph.",

38843

"itemtype": "attribute",

38844

"name": "x",

38845

"type": "Number",

38846

"access": "protected",

38847

"tagname": "",

38848

"class": "Graph",

38849

"module": "charts"

38850

},

38851

{

38852

"file": "charts/js/Graph.js",

38853

"line": 559,

38854

"description": "The y-coordinate for the graph.",

38855

"itemtype": "attribute",

38856

"name": "y",

38857

"type": "Number",

38858

"access": "protected",

38859

"tagname": "",

38860

"class": "Graph",

38861

"module": "charts"

38862

},

38863

{

38864

"file": "charts/js/Graph.js",

38865

"line": 574,

38866

"description": "Reference to the chart instance using the graph.",

38867

"itemtype": "attribute",

38868

"name": "chart",

38869

"type": "ChartBase",

38870

"readonly": "",

38871

"class": "Graph",

38872

"module": "charts"

38873

},

38874

{

38875

"file": "charts/js/Graph.js",

38876

"line": 583,

38877

"description": "Collection of series. When setting the `seriesCollection` the array can contain a combination of either\n`CartesianSeries` instances or object literals with properties that will define a series.",

38878

"itemtype": "attribute",

38879

"name": "seriesCollection",

38880

"type": "CartesianSeries",

38881

"class": "Graph",

38882

"module": "charts"

38883

},

38884

{

38885

"file": "charts/js/Graph.js",

38886

"line": 603,

38887

"description": "Indicates whether the `Graph` has a background.",

38888

"itemtype": "attribute",

38889

"name": "showBackground",

38890

"type": "Boolean",

38891

"default": "true",

38892

"class": "Graph",

38893

"module": "charts"

38894

},

38895

{

38896

"file": "charts/js/Graph.js",

38897

"line": 614,

38898

"description": "Read-only hash lookup for all series on in the `Graph`.",

38899

"itemtype": "attribute",

38900

"name": "seriesDictionary",

38901

"type": "Object",

38902

"readonly": "",

38903

"class": "Graph",

38904

"module": "charts"

38905

},

38906

{

38907

"file": "charts/js/Graph.js",

38908

"line": 630,

38909

"description": "Reference to the horizontal `Gridlines` instance.",

38910

"itemtype": "attribute",

38911

"name": "horizontalGridlines",

38912

"type": "Gridlines",

38913

"default": "null",

38914

"class": "Graph",

38915

"module": "charts"

38916

},

38917

{

38918

"file": "charts/js/Graph.js",

38919

"line": 661,

38920

"description": "Reference to the vertical `Gridlines` instance.",

38921

"itemtype": "attribute",

38922

"name": "verticalGridlines",

38923

"type": "Gridlines",

38924

"default": "null",

38925

"class": "Graph",

38926

"module": "charts"

38927

},

38928

{

38929

"file": "charts/js/Graph.js",

38930

"line": 692,

38931

"description": "Reference to graphic instance used for the background.",

38932

"itemtype": "attribute",

38933

"name": "background",

38934

"type": "Graphic",

38935

"readonly": "",

38936

"class": "Graph",

38937

"module": "charts"

38938

},

38939

{

38940

"file": "charts/js/Graph.js",

38941

"line": 712,

38942

"description": "Reference to graphic instance used for gridlines.",

38943

"itemtype": "attribute",

38944

"name": "gridlines",

38945

"type": "Graphic",

38946

"readonly": "",

38947

"class": "Graph",

38948

"module": "charts"

38949

},

38950

{

38951

"file": "charts/js/Graph.js",

38952

"line": 734,

38953

"description": "Reference to graphic instance used for series.",

38954

"itemtype": "attribute",

38955

"name": "graphic",

38956

"type": "Graphic",

38957

"readonly": "",

38958

"class": "Graph",

38959

"module": "charts"

38960

},

38961

{

38962

"file": "charts/js/Graph.js",

38963

"line": 756,

38964

"description": "Indicates whether or not markers for a series will be grouped and rendered in a single complex shape instance.",

38965

"itemtype": "attribute",

38966

"name": "groupMarkers",

38967

"type": "Boolean",

38968

"class": "Graph",

38969

"module": "charts"

38970

},

38971

{

38972

"file": "charts/js/Graph.js",

38973

"line": 766,

38974

"description": "Style properties used for drawing a background. Below are the default values:\n <dl>\n <dt>background</dt><dd>An object containing the following values:\n <dl>\n <dt>fill</dt><dd>Defines the style properties for the fill. Contains the following values:\n <dl>\n <dt>color</dt><dd>Color of the fill. The default value is #faf9f2.</dd>\n <dt>alpha</dt><dd>Number from 0 to 1 indicating the opacity of the background fill. The default value is 1.</dd>\n </dl>\n </dd>\n <dt>border</dt><dd>Defines the style properties for the border. Contains the following values:\n <dl>\n <dt>color</dt><dd>Color of the border. The default value is #dad8c9.</dd>\n <dt>alpha</dt><dd>Number from 0 to 1 indicating the opacity of the background border. The default value is 1.</dd>\n <dt>weight</dt><dd>Number indicating the width of the border. The default value is 1.</dd>\n </dl>\n </dd>\n </dl>\n </dd>\n </dl>",

38975

"itemtype": "attribute",

38976

"name": "styles",

38977

"type": "Object",

38978

"class": "Graph",

38979

"module": "charts"

38980

},

38981

{

38982

"file": "charts/js/Gridlines.js",

38983

"line": 11,

38984

"description": "Reference to the `Path` element used for drawing Gridlines.",

38985

"itemtype": "property",

38986

"name": "_path",

38987

"type": "Path",

38988

"access": "private",

38989

"tagname": "",

38990

"class": "Gridlines",

38991

"module": "charts"

38992

},

38993

{

38994

"file": "charts/js/Gridlines.js",

38995

"line": 20,

38996

"description": "Removes the Gridlines.",

38997

"itemtype": "method",

38998

"name": "remove",

38999

"access": "private",

39000

"tagname": "",

39001

"class": "Gridlines",

39002

"module": "charts"

39003

},

39004

{

39005

"file": "charts/js/Gridlines.js",

39006

"line": 35,

39007

"description": "Draws the gridlines",

39008

"itemtype": "method",

39009

"name": "draw",

39010

"access": "protected",

39011

"tagname": "",

39012

"class": "Gridlines",

39013

"module": "charts"

39014

},

39015

{

39016

"file": "charts/js/Gridlines.js",

39017

"line": 49,

39018

"description": "Algorithm for drawing gridlines",

39019

"itemtype": "method",

39020

"name": "_drawGridlines",

39021

"access": "private",

39022

"tagname": "",

39023

"class": "Gridlines",

39024

"module": "charts"

39025

},

39026

{

39027

"file": "charts/js/Gridlines.js",

39028

"line": 108,

39029

"description": "Algorithm for horizontal lines.",

39030

"itemtype": "method",

39031

"name": "_horizontalLine",

39032

"params": [

39033

{

39034

"name": "path",

39035

"description": "Reference to path element",

39036

"type": "Path"

39037

},

39038

{

39039

"name": "pt",

39040

"description": "Coordinates corresponding to a major unit of an axis.",

39041

"type": "Object"

39042

},

39043

{

39044

"name": "w",

39045

"description": "Width of the Graph",

39046

"type": "Number"

39047

},

39048

{

39049

"name": "h",

39050

"description": "Height of the Graph",

39051

"type": "Number"

39052

}

39053

],

39054

"access": "private",

39055

"tagname": "",

39056

"class": "Gridlines",

39057

"module": "charts"

39058

},

39059

{

39060

"file": "charts/js/Gridlines.js",

39061

"line": 124,

39062

"description": "Algorithm for vertical lines.",

39063

"itemtype": "method",

39064

"name": "_verticalLine",

39065

"params": [

39066

{

39067

"name": "path",

39068

"description": "Reference to path element",

39069

"type": "Path"

39070

},

39071

{

39072

"name": "pt",

39073

"description": "Coordinates corresponding to a major unit of an axis.",

39074

"type": "Object"

39075

},

39076

{

39077

"name": "w",

39078

"description": "Width of the Graph",

39079

"type": "Number"

39080

},

39081

{

39082

"name": "h",

39083

"description": "Height of the Graph",

39084

"type": "Number"

39085

}

39086

],

39087

"access": "private",

39088

"tagname": "",

39089

"class": "Gridlines",

39090

"module": "charts"

39091

},

39092

{

39093

"file": "charts/js/Gridlines.js",

39094

"line": 140,

39095

"description": "Gets the default value for the `styles` attribute. Overrides\nbase implementation.",

39096

"itemtype": "method",

39097

"name": "_getDefaultStyles",

39098

"return": {

39099

"description": "Object"

39100

},

39101

"access": "protected",

39102

"tagname": "",

39103

"class": "Gridlines",

39104

"module": "charts"

39105

},

39106

{

39107

"file": "charts/js/Gridlines.js",

39108

"line": 163,

39109

"description": "Indicates the direction of the gridline.",

39110

"itemtype": "attribute",

39111

"name": "direction",

39112

"type": "String",

39113

"class": "Gridlines",

39114

"module": "charts"

39115

},

39116

{

39117

"file": "charts/js/Gridlines.js",

39118

"line": 171,

39119

"description": "Indicate the `Axis` in which to bind\nthe gridlines.",

39120

"itemtype": "attribute",

39121

"name": "axis",

39122

"type": "Axis",

39123

"class": "Gridlines",

39124

"module": "charts"

39125

},

39126

{

39127

"file": "charts/js/Gridlines.js",

39128

"line": 180,

39129

"description": "Indicates the `Graph` in which the gridlines \nare drawn.",

39130

"itemtype": "attribute",

39131

"name": "graph",

39132

"type": "Graph",

39133

"class": "Gridlines",

39134

"module": "charts"

39135

},

39136

{

39137

"file": "charts/js/Histogram.js",

39138

"line": 11,

39139

"description": "Draws the series.",

39140

"itemtype": "method",

39141

"name": "drawSeries",

39142

"access": "protected",

39143

"tagname": "",

39144

"class": "Histogram",

39145

"module": "charts"

39146

},

39147

{

39148

"file": "charts/js/Histogram.js",

39149

"line": 172,

39150

"description": "Collection of default colors used for marker fills in a series when not specified by user.",

39151

"itemtype": "property",

39152

"name": "_defaultFillColors",

39153

"type": "Array",

39154

"access": "protected",

39155

"tagname": "",

39156

"class": "Histogram",

39157

"module": "charts"

39158

},

39159

{

39160

"file": "charts/js/Histogram.js",

39161

"line": 181,

39162

"description": "Gets the default style values for the markers.",

39163

"itemtype": "method",

39164

"name": "_getPlotDefaults",

39165

"return": {

39166

"description": "Object"

39167

},

39168

"access": "private",

39169

"tagname": "",

39170

"class": "Histogram",

39171

"module": "charts"

39172

},

39173

{

39174

"file": "charts/js/LeftAxisLayout.js",

39175

"line": 11,

39176

"description": "Default margins for text fields.",

39177

"access": "private",

39178

"tagname": "",

39179

"itemtype": "method",

39180

"name": "_getDefaultMargins",

39181

"return": {

39182

"description": "Object"

39183

},

39184

"class": "LeftAxisLayout",

39185

"module": "charts"

39186

},

39187

{

39188

"file": "charts/js/LeftAxisLayout.js",

39189

"line": 28,

39190

"description": "Sets the length of the tick on either side of the axis line.",

39191

"itemtype": "method",

39192

"name": "setTickOffset",

39193

"access": "protected",

39194

"tagname": "",

39195

"class": "LeftAxisLayout",

39196

"module": "charts"

39197

},

39198

{

39199

"file": "charts/js/LeftAxisLayout.js",

39200

"line": 65,

39201

"description": "Draws a tick",

39202

"itemtype": "method",

39203

"name": "drawTick",

39204

"params": [

39205

{

39206

"name": "path",

39207

"description": "reference to the path `Path` element in which to draw the tick.",

39208

"type": "Path"

39209

},

39210

{

39211

"name": "pt",

39212

"description": "Point on the axis in which the tick will intersect.",

39213

"type": "Object"

39214

},

39215

{

39216

"name": "tickStyle",

39217

"description": "Hash of properties to apply to the tick.",

39218

"type": "Object"

39219

}

39220

],

39221

"access": "protected",

39222

"tagname": "",

39223

"class": "LeftAxisLayout",

39224

"module": "charts"

39225

},

39226

{

39227

"file": "charts/js/LeftAxisLayout.js",

39228

"line": 85,

39229

"description": "Calculates the coordinates for the first point on an axis.",

39230

"itemtype": "method",

39231

"name": "getLineStart",

39232

"return": {

39233

"description": "",

39234

"type": "Object"

39235

},

39236

"access": "protected",

39237

"tagname": "",

39238

"class": "LeftAxisLayout",

39239

"module": "charts"

39240

},

39241

{

39242

"file": "charts/js/LeftAxisLayout.js",

39243

"line": 111,

39244

"description": "Calculates the point for a label.",

39245

"itemtype": "method",

39246

"name": "getLabelPoint",

39247

"params": [

39248

{

39249

"name": "point",

39250

"description": "Point on the axis in which the tick will intersect.",

39251

"type": "Object"

39252

}

39253

],

39254

"return": {

39255

"description": "",

39256

"type": "Object"

39257

},

39258

"access": "protected",

39259

"tagname": "",

39260

"class": "LeftAxisLayout",

39261

"module": "charts"

39262

},

39263

{

39264

"file": "charts/js/LeftAxisLayout.js",

39265

"line": 124,

39266

"description": "Updates the value for the `maxLabelSize` for use in calculating total size.",

39267

"itemtype": "method",

39268

"name": "updateMaxLabelSize",

39269

"params": [

39270

{

39271

"name": "label",

39272

"description": "to measure",

39273

"type": "HTMLElement"

39274

}

39275

],

39276

"access": "protected",

39277

"tagname": "",

39278

"class": "LeftAxisLayout",

39279

"module": "charts"

39280

},

39281

{

39282

"file": "charts/js/LeftAxisLayout.js",

39283

"line": 155,

39284

"description": "Determines the available label width when the axis width has been explicitly set.",

39285

"itemtype": "method",

39286

"name": "getExplicitlySized",

39287

"return": {

39288

"description": "Boolean"

39289

},

39290

"access": "protected",

39291

"tagname": "",

39292

"class": "LeftAxisLayout",

39293

"module": "charts"

39294

},

39295

{

39296

"file": "charts/js/LeftAxisLayout.js",

39297

"line": 177,

39298

"description": "Rotate and position title.",

39299

"itemtype": "method",

39300

"name": "positionTitle",

39301

"params": [

39302

{

39303

"name": "label",

39304

"description": "to rotate position",

39305

"type": "HTMLElement"

39306

}

39307

],

39308

"access": "protected",

39309

"tagname": "",

39310

"class": "LeftAxisLayout",

39311

"module": "charts"

39312

},

39313

{

39314

"file": "charts/js/LeftAxisLayout.js",

39315

"line": 207,

39316

"description": "Rotate and position labels.",

39317

"itemtype": "method",

39318

"name": "positionLabel",

39319

"params": [

39320

{

39321

"name": "label",

39322

"description": "to rotate position",

39323

"type": "HTMLElement"

39324

},

39325

{

39326

"name": "pt",

39327

"description": "hash containing the x and y coordinates in which the label will be positioned\nagainst.",

39328

"type": "Object"

39329

}

39330

],

39331

"access": "protected",

39332

"tagname": "",

39333

"class": "LeftAxisLayout",

39334

"module": "charts"

39335

},

39336

{

39337

"file": "charts/js/LeftAxisLayout.js",

39338

"line": 255,

39339

"description": "Adjusts the coordinates of an axis label based on the rotation.",

39340

"itemtype": "method",

39341

"name": "_setRotationCoords",

39342

"params": [

39343

{

39344

"name": "props",

39345

"description": "Coordinates, dimension and rotation properties of the label.",

39346

"type": "Object"

39347

}

39348

],

39349

"access": "protected",

39350

"tagname": "",

39351

"class": "LeftAxisLayout",

39352

"module": "charts"

39353

},

39354

{

39355

"file": "charts/js/LeftAxisLayout.js",

39356

"line": 294,

39357

"description": "Returns the transformOrigin to use for an axis label based on the position of the axis \nand the rotation of the label.",

39358

"itemtype": "method",

39359

"name": "_getTransformOrigin",

39360

"params": [

39361

{

39362

"name": "rot",

39363

"description": "The rotation (in degrees) of the label.",

39364

"type": "Number"

39365

}

39366

],

39367

"return": {

39368

"description": "Array"

39369

},

39370

"access": "protected",

39371

"tagname": "",

39372

"class": "LeftAxisLayout",

39373

"module": "charts"

39374

},

39375

{

39376

"file": "charts/js/LeftAxisLayout.js",

39377

"line": 325,

39378

"description": "Adjust the position of the Axis widget's content box for internal axes.",

39379

"itemtype": "method",

39380

"name": "offsetNodeForTick",

39381

"params": [

39382

{

39383

"name": "cb",

39384

"description": "Content box of the Axis.",

39385

"type": "Node"

39386

}

39387

],

39388

"access": "protected",

39389

"tagname": "",

39390

"class": "LeftAxisLayout",

39391

"module": "charts"

39392

},

39393

{

39394

"file": "charts/js/LeftAxisLayout.js",

39395

"line": 336,

39396

"description": "Sets the width of the axis based on its contents.",

39397

"itemtype": "method",

39398

"name": "setCalculatedSize",

39399

"access": "protected",

39400

"tagname": "",

39401

"class": "LeftAxisLayout",

39402

"module": "charts"

39403

},

39404

{

39405

"file": "charts/js/LineSeries.js",

39406

"line": 11,

39407

"access": "protected",

39408

"tagname": "",

39409

"itemtype": "method",

39410

"name": "drawSeries",

39411

"class": "LineSeries",

39412

"module": "charts"

39413

},

39414

{

39415

"file": "charts/js/LineSeries.js",

39416

"line": 21,

39417

"access": "protected",

39418

"tagname": "Method used by `styles` setter. Overrides base implementation.",

39419

"itemtype": "method",

39420

"name": "_setStyles",

39421

"params": [

39422

{

39423

"name": "newStyles",

39424

"description": "Hash of properties to update.",

39425

"type": "Object"

39426

}

39427

],

39428

"return": {

39429

"description": "Object"

39430

},

39431

"class": "LineSeries",

39432

"module": "charts"

39433

},

39434

{

39435

"file": "charts/js/LineSeries.js",

39436

"line": 39,

39437

"access": "protected",

39438

"tagname": "Gets the default value for the `styles` attribute. Overrides\nbase implementation.",

39439

"itemtype": "method",

39440

"name": "_getDefaultStyles",

39441

"return": {

39442

"description": "Object"

39443

},

39444

"class": "LineSeries",

39445

"module": "charts"

39446

},

39447

{

39448

"file": "charts/js/LineSeries.js",

39449

"line": 56,

39450

"description": "Read-only attribute indicating the type of series.",

39451

"itemtype": "attribute",

39452

"name": "type",

39453

"type": "String",

39454

"default": "line",

39455

"class": "LineSeries",

39456

"module": "charts"

39457

},

39458

{

39459

"file": "charts/js/LineSeries.js",

39460

"line": 67,

39461

"description": "Style properties used for drawing lines. This attribute is inherited from `Renderer`. Below are the default values:\n <dl>\n <dt>color</dt><dd>The color of the line. The default value is determined by the order of the series on the graph. The color will be\n retrieved from the following array: \n `[\"#426ab3\", \"#d09b2c\", \"#000000\", \"#b82837\", \"#b384b5\", \"#ff7200\", \"#779de3\", \"#cbc8ba\", \"#7ed7a6\", \"#007a6c\"]`\n <dt>weight</dt><dd>Number that indicates the width of the line. The default value is 6.</dd>\n <dt>alpha</dt><dd>Number between 0 and 1 that indicates the opacity of the line. The default value is 1.</dd>\n <dt>lineType</dt><dd>Indicates whether the line is solid or dashed. The default value is solid.</dd> \n <dt>dashLength</dt><dd>When the `lineType` is dashed, indicates the length of the dash. The default value is 10.</dd>\n <dt>gapSpace</dt><dd>When the `lineType` is dashed, indicates the distance between dashes. The default value is 10.</dd>\n <dt>connectDiscontinuousPoints</dt><dd>Indicates whether or not to connect lines when there is a missing or null value between points. The default value is true.</dd> \n <dt>discontinuousType</dt><dd>Indicates whether the line between discontinuous points is solid or dashed. The default value is solid.</dd>\n <dt>discontinuousDashLength</dt><dd>When the `discontinuousType` is dashed, indicates the length of the dash. The default value is 10.</dd>\n <dt>discontinuousGapSpace</dt><dd>When the `discontinuousType` is dashed, indicates the distance between dashes. The default value is 10.</dd>\n </dl>",

39462

"itemtype": "attribute",

39463

"name": "styles",

39464

"type": "Object",

39465

"class": "LineSeries",

39466

"module": "charts"

39467

},

39468

{

39469

"file": "charts/js/Lines.js",

39470

"line": 11,

39471

"itemtype": "property",

39472

"name": "_lineDefaults",

39473

"type": "Object",

39474

"access": "private",

39475

"tagname": "",

39476

"class": "Lines",

39477

"module": "charts"

39478

},

39479

{

39480

"file": "charts/js/Lines.js",

39481

"line": 18,

39482

"description": "Creates a graphic in which to draw a series.",

39483

"itemtype": "method",

39484

"name": "_getGraphic",

39485

"return": {

39486

"description": "Graphic"

39487

},

39488

"access": "private",

39489

"tagname": "",

39490

"class": "Lines",

39491

"module": "charts"

39492

},

39493

{

39494

"file": "charts/js/Lines.js",

39495

"line": 36,

39496

"description": "Toggles visibility",

39497

"itemtype": "method",

39498

"name": "_toggleVisible",

39499

"params": [

39500

{

39501

"name": "visible",

39502

"description": "indicates visibilitye",

39503

"type": "Boolean"

39504

}

39505

],

39506

"access": "private",

39507

"tagname": "",

39508

"class": "Lines",

39509

"module": "charts"

39510

},

39511

{

39512

"file": "charts/js/Lines.js",

39513

"line": 51,

39514

"description": "Draws lines for the series.",

39515

"itemtype": "method",

39516

"name": "drawLines",

39517

"access": "protected",

39518

"tagname": "",

39519

"class": "Lines",

39520

"module": "charts"

39521

},

39522

{

39523

"file": "charts/js/Lines.js",

39524

"line": 144,

39525

"description": "Connects data points with a consistent curve for a series.",

39526

"itemtype": "method",

39527

"name": "drawSpline",

39528

"access": "protected",

39529

"tagname": "",

39530

"class": "Lines",

39531

"module": "charts"

39532

},

39533

{

39534

"file": "charts/js/Lines.js",

39535

"line": 190,

39536

"description": "Draws a dashed line between two points.",

39537

"itemtype": "method",

39538

"name": "drawDashedLine",

39539

"params": [

39540

{

39541

"name": "xStart",

39542

"description": "The x position of the start of the line",

39543

"type": "Number"

39544

},

39545

{

39546

"name": "yStart",

39547

"description": "The y position of the start of the line",

39548

"type": "Number"

39549

},

39550

{

39551

"name": "xEnd",

39552

"description": "The x position of the end of the line",

39553

"type": "Number"

39554

},

39555

{

39556

"name": "yEnd",

39557

"description": "The y position of the end of the line",

39558

"type": "Number"

39559

},

39560

{

39561

"name": "dashSize",

39562

"description": "the size of dashes, in pixels",

39563

"type": "Number"

39564

},

39565

{

39566

"name": "gapSize",

39567

"description": "the size of gaps between dashes, in pixels",

39568

"type": "Number"

39569

}

39570

],

39571

"access": "private",

39572

"tagname": "",

39573

"class": "Lines",

39574

"module": "charts"

39575

},

39576

{

39577

"file": "charts/js/Lines.js",

39578

"line": 241,

39579

"description": "Default values for `styles` attribute.",

39580

"itemtype": "method",

39581

"name": "_getLineDefaults",

39582

"return": {

39583

"description": "Object"

39584

},

39585

"access": "protected",

39586

"tagname": "",

39587

"class": "Lines",

39588

"module": "charts"

39589

},

39590

{

39591

"file": "charts/js/MarkerSeries.js",

39592

"line": 12,

39593

"access": "protected",

39594

"tagname": "Draws the series.",

39595

"itemtype": "method",

39596

"name": "drawSeries",

39597

"class": "MarkerSeries",

39598

"module": "charts"

39599

},

39600

{

39601

"file": "charts/js/MarkerSeries.js",

39602

"line": 24,

39603

"access": "protected",

39604

"tagname": "Method used by `styles` setter. Overrides base implementation.",

39605

"itemtype": "method",

39606

"name": "_setStyles",

39607

"params": [

39608

{

39609

"name": "newStyles",

39610

"description": "Hash of properties to update.",

39611

"type": "Object"

39612

}

39613

],

39614

"return": {

39615

"description": "Object"

39616

},

39617

"class": "MarkerSeries",

39618

"module": "charts"

39619

},

39620

{

39621

"file": "charts/js/MarkerSeries.js",

39622

"line": 43,

39623

"access": "protected",

39624

"tagname": "Gets the default value for the `styles` attribute. Overrides\nbase implementation.",

39625

"itemtype": "method",

39626

"name": "_getDefaultStyles",

39627

"return": {

39628

"description": "Object"

39629

},

39630

"class": "MarkerSeries",

39631

"module": "charts"

39632

},

39633

{

39634

"file": "charts/js/MarkerSeries.js",

39635

"line": 59,

39636

"description": "Read-only attribute indicating the type of series.",

39637

"itemtype": "attribute",

39638

"name": "type",

39639

"type": "String",

39640

"default": "marker",

39641

"class": "MarkerSeries",

39642

"module": "charts"

39643

},

39644

{

39645

"file": "charts/js/MarkerSeries.js",

39646

"line": 70,

39647

"description": "Style properties used for drawing markers. This attribute is inherited from `Renderer`. Below are the default values:\n <dl>\n <dt>fill</dt><dd>A hash containing the following values:\n <dl>\n <dt>color</dt><dd>Color of the fill. The default value is determined by the order of the series on the graph. The color\n will be retrieved from the below array: \n `[\"#6084d0\", \"#eeb647\", \"#6c6b5f\", \"#d6484f\", \"#ce9ed1\", \"#ff9f3b\", \"#93b7ff\", \"#e0ddd0\", \"#94ecba\", \"#309687\"]`\n </dd>\n <dt>alpha</dt><dd>Number from 0 to 1 indicating the opacity of the marker fill. The default value is 1.</dd>\n </dl>\n </dd>\n <dt>border</dt><dd>A hash containing the following values:\n <dl>\n <dt>color</dt><dd>Color of the border. The default value is determined by the order of the series on the graph. The color\n will be retrieved from the below array: \n `[\"#205096\", \"#b38206\", \"#000000\", \"#94001e\", \"#9d6fa0\", \"#e55b00\", \"#5e85c9\", \"#adab9e\", \"#6ac291\", \"#006457\"]`\n <dt>alpha</dt><dd>Number from 0 to 1 indicating the opacity of the marker border. The default value is 1.</dd>\n <dt>weight</dt><dd>Number indicating the width of the border. The default value is 1.</dd>\n </dl>\n </dd>\n <dt>width</dt><dd>indicates the width of the marker. The default value is 10.</dd>\n <dt>height</dt><dd>indicates the height of the marker The default value is 10.</dd>\n <dt>over</dt><dd>hash containing styles for markers when highlighted by a `mouseover` event. The default \n values for each style is null. When an over style is not set, the non-over value will be used. For example,\n the default value for `marker.over.fill.color` is equivalent to `marker.fill.color`.</dd>\n </dl>",

39648

"itemtype": "attribute",

39649

"name": "styles",

39650

"type": "Object",

39651

"class": "MarkerSeries",

39652

"module": "charts"

39653

},

39654

{

39655

"file": "charts/js/NumericAxis.js",

39656

"line": 18,

39657

"description": "Indicates whether 0 should always be displayed.",

39658

"itemtype": "attribute",

39659

"name": "alwaysShowZero",

39660

"type": "Boolean",

39661

"class": "NumericAxis",

39662

"module": "charts"

39663

},

39664

{

39665

"file": "charts/js/NumericAxis.js",

39666

"line": 28,

39667

"description": "Method used for formatting a label. This attribute allows for the default label formatting method to overridden. The method use would need\nto implement the arguments below and return a `String` or an `HTMLElement`. The default implementation of the method returns a `String`. The output of this method\nwill be rendered to the DOM using `appendChild`. If you override the `labelFunction` method and return an html string, you will also need to override the Axis' \n`appendLabelFunction` to accept html as a `String`.\n<dl>\n <dt>val</dt><dd>Label to be formatted. (`String`)</dd>\n <dt>format</dt><dd>Object containing properties used to format the label. (optional)</dd>\n</dl>",

39668

"itemtype": "attribute",

39669

"name": "labelFunction",

39670

"type": "Function",

39671

"class": "NumericAxis",

39672

"module": "charts"

39673

},

39674

{

39675

"file": "charts/js/NumericAxis.js",

39676

"line": 52,

39677

"description": "Object containing properties used by the `labelFunction` to format a\nlabel.",

39678

"itemtype": "attribute",

39679

"name": "labelFormat",

39680

"type": "Object",

39681

"class": "NumericAxis",

39682

"module": "charts"

39683

},

39684

{

39685

"file": "charts/js/NumericAxis.js",

39686

"line": 72,

39687

"description": "Formats a label based on the axis type and optionally specified format.",

39688

"itemtype": "method",

39689

"name": "formatLabel",

39690

"params": [

39691

{

39692

"name": "value",

39693

"description": "",

39694

"type": "Object"

39695

},

39696

{

39697

"name": "format",

39698

"description": "Pattern used to format the value.",

39699

"type": "Object"

39700

}

39701

],

39702

"return": {

39703

"description": "String"

39704

},

39705

"class": "NumericAxis",

39706

"module": "charts"

39707

},

39708

{

39709

"file": "charts/js/NumericAxis.js",

39710

"line": 89,

39711

"description": "Returns the sum of all values per key.",

39712

"itemtype": "method",

39713

"name": "getTotalByKey",

39714

"params": [

39715

{

39716

"name": "key",

39717

"description": "The identifier for the array whose values will be calculated.",

39718

"type": "String"

39719

}

39720

],

39721

"return": {

39722

"description": "Number"

39723

},

39724

"class": "NumericAxis",

39725

"module": "charts"

39726

},

39727

{

39728

"file": "charts/js/NumericAxis.js",

39729

"line": 114,

39730

"description": "Type of data used in `Axis`.",

39731

"itemtype": "property",

39732

"name": "_type",

39733

"readonly": "",

39734

"access": "private",

39735

"tagname": "",

39736

"class": "NumericAxis",

39737

"module": "charts"

39738

},

39739

{

39740

"file": "charts/js/NumericAxis.js",

39741

"line": 123,

39742

"description": "Helper method for getting a `roundingUnit` when calculating the minimum and maximum values.",

39743

"itemtype": "method",

39744

"name": "_getMinimumUnit",

39745

"params": [

39746

{

39747

"name": "max",

39748

"description": "Maximum number",

39749

"type": "Number"

39750

},

39751

{

39752

"name": "min",

39753

"description": "Minimum number",

39754

"type": "Number"

39755

},

39756

{

39757

"name": "units",

39758

"description": "Number of units on the axis",

39759

"type": "Number"

39760

}

39761

],

39762

"return": {

39763

"description": "Number"

39764

},

39765

"access": "private",

39766

"tagname": "",

39767

"class": "NumericAxis",

39768

"module": "charts"

39769

},

39770

{

39771

"file": "charts/js/NumericAxis.js",

39772

"line": 138,

39773

"description": "Calculates a nice rounding unit based on the range.",

39774

"itemtype": "method",

39775

"name": "_getNiceNumber",

39776

"params": [

39777

{

39778

"name": "roundingUnit",

39779

"description": "The calculated rounding unit.",

39780

"type": "Number"

39781

}

39782

],

39783

"return": {

39784

"description": "Number"

39785

},

39786

"access": "private",

39787

"tagname": "",

39788

"class": "NumericAxis",

39789

"module": "charts"

39790

},

39791

{

39792

"file": "charts/js/NumericAxis.js",

39793

"line": 170,

39794

"description": "Calculates the maximum and minimum values for the `Axis`.",

39795

"itemtype": "method",

39796

"name": "_updateMinAndMax",

39797

"access": "private",

39798

"tagname": "",

39799

"class": "NumericAxis",

39800

"module": "charts"

39801

},

39802

{

39803

"file": "charts/js/NumericAxis.js",

39804

"line": 248,

39805

"description": "Rounds the mimimum and maximum values based on the `roundingUnit` attribute.",

39806

"itemtype": "method",

39807

"name": "_roundMinAndMax",

39808

"params": [

39809

{

39810

"name": "min",

39811

"description": "Minimum value",

39812

"type": "Number"

39813

},

39814

{

39815

"name": "max",

39816

"description": "Maximum value",

39817

"type": "Number"

39818

}

39819

],

39820

"access": "private",

39821

"tagname": "",

39822

"class": "NumericAxis",

39823

"module": "charts"

39824

},

39825

{

39826

"file": "charts/js/NumericAxis.js",

39827

"line": 537,

39828

"description": "Calculates and returns a value based on the number of labels and the index of\nthe current label.",

39829

"itemtype": "method",

39830

"name": "getLabelByIndex",

39831

"params": [

39832

{

39833

"name": "i",

39834

"description": "Index of the label.",

39835

"type": "Number"

39836

},

39837

{

39838

"name": "l",

39839

"description": "Total number of labels.",

39840

"type": "Number"

39841

}

39842

],

39843

"return": {

39844

"description": "String"

39845

},

39846

"class": "NumericAxis",

39847

"module": "charts"

39848

},

39849

{

39850

"file": "charts/js/NumericAxis.js",

39851

"line": 575,

39852

"description": "Rounds a Number to the nearest multiple of an input. For example, by rounding\n16 to the nearest 10, you will receive 20. Similar to the built-in function Math.round().",

39853

"itemtype": "method",

39854

"name": "_roundToNearest",

39855

"params": [

39856

{

39857

"name": "number",

39858

"description": "Number to round",

39859

"type": "Number"

39860

},

39861

{

39862

"name": "nearest",

39863

"description": "Multiple to round towards.",

39864

"type": "Number"

39865

}

39866

],

39867

"return": {

39868

"description": "Number"

39869

},

39870

"access": "private",

39871

"tagname": "",

39872

"class": "NumericAxis",

39873

"module": "charts"

39874

},

39875

{

39876

"file": "charts/js/NumericAxis.js",

39877

"line": 596,

39878

"description": "Rounds a Number up to the nearest multiple of an input. For example, by rounding\n16 up to the nearest 10, you will receive 20. Similar to the built-in function Math.ceil().",

39879

"itemtype": "method",

39880

"name": "_roundUpToNearest",

39881

"params": [

39882

{

39883

"name": "number",

39884

"description": "Number to round",

39885

"type": "Number"

39886

},

39887

{

39888

"name": "nearest",

39889

"description": "Multiple to round towards.",

39890

"type": "Number"

39891

}

39892

],

39893

"return": {

39894

"description": "Number"

39895

},

39896

"access": "private",

39897

"tagname": "",

39898

"class": "NumericAxis",

39899

"module": "charts"

39900

},

39901

{

39902

"file": "charts/js/NumericAxis.js",

39903

"line": 616,

39904

"description": "Rounds a Number down to the nearest multiple of an input. For example, by rounding\n16 down to the nearest 10, you will receive 10. Similar to the built-in function Math.floor().",

39905

"itemtype": "method",

39906

"name": "_roundDownToNearest",

39907

"params": [

39908

{

39909

"name": "number",

39910

"description": "Number to round",

39911

"type": "Number"

39912

},

39913

{

39914

"name": "nearest",

39915

"description": "Multiple to round towards.",

39916

"type": "Number"

39917

}

39918

],

39919

"return": {

39920

"description": "Number"

39921

},

39922

"access": "private",

39923

"tagname": "",

39924

"class": "NumericAxis",

39925

"module": "charts"

39926

},

39927

{

39928

"file": "charts/js/NumericAxis.js",

39929

"line": 636,

39930

"description": "Rounds a number to a certain level of precision. Useful for limiting the number of\ndecimal places on a fractional number.",

39931

"itemtype": "method",

39932

"name": "_roundToPrecision",

39933

"params": [

39934

{

39935

"name": "number",

39936

"description": "Number to round",

39937

"type": "Number"

39938

},

39939

{

39940

"name": "precision",

39941

"description": "Multiple to round towards.",

39942

"type": "Number"

39943

}

39944

],

39945

"return": {

39946

"description": "Number"

39947

},

39948

"access": "private",

39949

"tagname": "",

39950

"class": "NumericAxis",

39951

"module": "charts"

39952

},

39953

{

39954

"file": "charts/js/NumericAxis.js",

39955

"line": 653,

39956

"description": "Checks to see if data extends beyond the range of the axis. If so,\nthat data will need to be hidden. This method is internal, temporary and subject\nto removal in the future.",

39957

"itemtype": "method",

39958

"name": "_hasDataOverflow",

39959

"access": "protected",

39960

"tagname": "",

39961

"return": {

39962

"description": "Boolean"

39963

},

39964

"class": "NumericAxis",

39965

"module": "charts"

39966

},

39967

{

39968

"file": "charts/js/PieChart.js",

39969

"line": 10,

39970

"description": "Calculates and returns a `seriesCollection`.",

39971

"itemtype": "method",

39972

"name": "_getSeriesCollection",

39973

"return": {

39974

"description": "Array"

39975

},

39976

"access": "private",

39977

"tagname": "",

39978

"class": "PieChart",

39979

"module": "charts"

39980

},

39981

{

39982

"file": "charts/js/PieChart.js",

39983

"line": 52,

39984

"description": "Creates `Axis` instances.",

39985

"itemtype": "method",

39986

"name": "_parseAxes",

39987

"params": [

39988

{

39989

"name": "val",

39990

"description": "Object containing `Axis` instances or objects in which to construct `Axis` instances.",

39991

"type": "Object"

39992

}

39993

],

39994

"return": {

39995

"description": "Object"

39996

},

39997

"access": "private",

39998

"tagname": "",

39999

"class": "PieChart",

40000

"module": "charts"

40001

},

40002

{

40003

"file": "charts/js/PieChart.js",

40004

"line": 105,

40005

"description": "Adds axes to the chart.",

40006

"itemtype": "method",

40007

"name": "_addAxes",

40008

"access": "private",

40009

"tagname": "",

40010

"class": "PieChart",

40011

"module": "charts"

40012

},

40013

{

40014

"file": "charts/js/PieChart.js",

40015

"line": 145,

40016

"description": "Renders the Graph.",

40017

"itemtype": "method",

40018

"name": "_addSeries",

40019

"access": "private",

40020

"tagname": "",

40021

"class": "PieChart",

40022

"module": "charts"

40023

},

40024

{

40025

"file": "charts/js/PieChart.js",

40026

"line": 164,

40027

"description": "Parse and sets the axes for the chart.",

40028

"itemtype": "method",

40029

"name": "_parseSeriesAxes",

40030

"params": [

40031

{

40032

"name": "c",

40033

"description": "A collection `PieSeries` instance.",

40034

"type": "Array"

40035

}

40036

],

40037

"access": "private",

40038

"tagname": "",

40039

"class": "PieChart",

40040

"module": "charts"

40041

},

40042

{

40043

"file": "charts/js/PieChart.js",

40044

"line": 209,

40045

"description": "Generates and returns a key-indexed object containing `Axis` instances or objects used to create `Axis` instances.",

40046

"itemtype": "method",

40047

"name": "_getDefaultAxes",

40048

"return": {

40049

"description": "Object"

40050

},

40051

"access": "private",

40052

"tagname": "",

40053

"class": "PieChart",

40054

"module": "charts"

40055

},

40056

{

40057

"file": "charts/js/PieChart.js",

40058

"line": 249,

40059

"description": "Returns an object literal containing a categoryItem and a valueItem for a given series index.",

40060

"itemtype": "method",

40061

"name": "getSeriesItem",

40062

"params": [

40063

{

40064

"name": "series",

40065

"description": "Reference to a series."

40066

},

40067

{

40068

"name": "index",

40069

"description": "Index of the specified item within a series."

40070

}

40071

],

40072

"return": {

40073

"description": "Object"

40074

},

40075

"class": "PieChart",

40076

"module": "charts"

40077

},

40078

{

40079

"file": "charts/js/PieChart.js",

40080

"line": 274,

40081

"description": "Handler for sizeChanged event.",

40082

"itemtype": "method",

40083

"name": "_sizeChanged",

40084

"params": [

40085

{

40086

"name": "e",

40087

"description": "Event object.",

40088

"type": "Object"

40089

}

40090

],

40091

"access": "private",

40092

"tagname": "",

40093

"class": "PieChart",

40094

"module": "charts"

40095

},

40096

{

40097

"file": "charts/js/PieChart.js",

40098

"line": 286,

40099

"description": "Redraws the chart instance.",

40100

"itemtype": "method",

40101

"name": "_redraw",

40102

"access": "private",

40103

"tagname": "",

40104

"class": "PieChart",

40105

"module": "charts"

40106

},

40107

{

40108

"file": "charts/js/PieChart.js",

40109

"line": 306,

40110

"description": "Formats tooltip text for a pie chart.",

40111

"itemtype": "method",

40112

"name": "_tooltipLabelFunction",

40113

"params": [

40114

{

40115

"name": "categoryItem",

40116

"description": "An object containing the following:\n <dl>\n <dt>axis</dt><dd>The axis to which the category is bound.</dd>\n <dt>displayName</dt><dd>The display name set to the category (defaults to key if not provided)</dd>\n <dt>key</dt><dd>The key of the category.</dd>\n <dt>value</dt><dd>The value of the category</dd>\n </dl>",

40117

"type": "Object"

40118

},

40119

{

40120

"name": "valueItem",

40121

"description": "An object containing the following:\n <dl>\n <dt>axis</dt><dd>The axis to which the item's series is bound.</dd>\n <dt>displayName</dt><dd>The display name of the series. (defaults to key if not provided)</dd>\n <dt>key</dt><dd>The key for the series.</dd>\n <dt>value</dt><dd>The value for the series item.</dd> \n </dl>",

40122

"type": "Object"

40123

},

40124

{

40125

"name": "itemIndex",

40126

"description": "The index of the item within the series.",

40127

"type": "Number"

40128

},

40129

{

40130

"name": "series",

40131

"description": "The `PieSeries` instance of the item.",

40132

"type": "CartesianSeries"

40133

},

40134

{

40135

"name": "seriesIndex",

40136

"description": "The index of the series in the `seriesCollection`.",

40137

"type": "Number"

40138

}

40139

],

40140

"return": {

40141

"description": "",

40142

"type": "HTML"

40143

},

40144

"access": "private",

40145

"tagname": "",

40146

"class": "PieChart",

40147

"module": "charts"

40148

},

40149

{

40150

"file": "charts/js/PieChart.js",

40151

"line": 345,

40152

"description": "Returns the appropriate message based on the key press.",

40153

"itemtype": "method",

40154

"name": "_getAriaMessage",

40155

"params": [

40156

{

40157

"name": "key",

40158

"description": "The keycode that was pressed.",

40159

"type": "Number"

40160

}

40161

],

40162

"return": {

40163

"description": "String"

40164

},

40165

"class": "PieChart",

40166

"module": "charts"

40167

},

40168

{

40169

"file": "charts/js/PieChart.js",

40170

"line": 398,

40171

"description": "Sets the aria description for the chart.",

40172

"itemtype": "attribute",

40173

"name": "ariaDescription",

40174

"type": "String",

40175

"class": "PieChart",

40176

"module": "charts"

40177

},

40178

{

40179

"file": "charts/js/PieChart.js",

40180

"line": 418,

40181

"description": "Axes to appear in the chart.",

40182

"itemtype": "attribute",

40183

"name": "axes",

40184

"type": "Object",

40185

"class": "PieChart",

40186

"module": "charts"

40187

},

40188

{

40189

"file": "charts/js/PieChart.js",

40190

"line": 436,

40191

"description": "Collection of series to appear on the chart. This can be an array of Series instances or object literals\nused to describe a Series instance.",

40192

"itemtype": "attribute",

40193

"name": "seriesCollection",

40194

"type": "Array",

40195

"class": "PieChart",

40196

"module": "charts"

40197

},

40198

{

40199

"file": "charts/js/PieChart.js",

40200

"line": 455,

40201

"description": "Type of chart when there is no series collection specified.",

40202

"itemtype": "attribute",

40203

"name": "type",

40204

"type": "String",

40205

"class": "PieChart",

40206

"module": "charts"

40207

},

40208

{

40209

"file": "charts/js/PieChartLegend.js",

40210

"line": 2,

40211

"description": "Redraws the chart instance.",

40212

"itemtype": "method",

40213

"name": "_redraw",

40214

"access": "private",

40215

"tagname": "",

40216

"class": "PieSeries",

40217

"module": "charts"

40218

},

40219

{

40220

"file": "charts/js/PieChartLegend.js",

40221

"line": 123,

40222

"description": "The legend for the chart.",

40223

"itemtype": "attribute",

40224

"name": "",

40225

"type": "Legend",

40226

"class": "PieSeries",

40227

"module": "charts"

40228

},

40229

{

40230

"file": "charts/js/PieSeries.js",

40231

"line": 11,

40232

"description": "Image map used for interactivity when rendered with canvas.",

40233

"itemtype": "property",

40234

"name": "_map",

40235

"type": "HTMLElement",

40236

"access": "private",

40237

"tagname": "",

40238

"class": "PieSeries",

40239

"module": "charts"

40240

},

40241

{

40242

"file": "charts/js/PieSeries.js",

40243

"line": 20,

40244

"description": "Image used for image map when rendered with canvas.",

40245

"itemtype": "property",

40246

"name": "_image",

40247

"type": "HTMLElement",

40248

"access": "private",

40249

"tagname": "",

40250

"class": "PieSeries",

40251

"module": "charts"

40252

},

40253

{

40254

"file": "charts/js/PieSeries.js",

40255

"line": 29,

40256

"description": "Creates or updates the image map when rendered with canvas.",

40257

"itemtype": "method",

40258

"name": "_setMap",

40259

"access": "private",

40260

"tagname": "",

40261

"class": "PieSeries",

40262

"module": "charts"

40263

},

40264

{

40265

"file": "charts/js/PieSeries.js",

40266

"line": 65,

40267

"description": "Storage for `categoryDisplayName` attribute.",

40268

"itemtype": "property",

40269

"name": "_categoryDisplayName",

40270

"access": "private",

40271

"tagname": "",

40272

"class": "PieSeries",

40273

"module": "charts"

40274

},

40275

{

40276

"file": "charts/js/PieSeries.js",

40277

"line": 73,

40278

"description": "Storage for `valueDisplayName` attribute.",

40279

"itemtype": "property",

40280

"name": "_valueDisplayName",

40281

"access": "private",

40282

"tagname": "",

40283

"class": "PieSeries",

40284

"module": "charts"

40285

},

40286

{

40287

"file": "charts/js/PieSeries.js",

40288

"line": 81,

40289

"description": "Adds event listeners.",

40290

"itemtype": "method",

40291

"name": "addListeners",

40292

"access": "private",

40293

"tagname": "",

40294

"class": "PieSeries",

40295

"module": "charts"

40296

},

40297

{

40298

"file": "charts/js/PieSeries.js",

40299

"line": 106,

40300

"description": "Draws the series.",

40301

"itemtype": "method",

40302

"name": "validate",

40303

"access": "private",

40304

"tagname": "",

40305

"class": "PieSeries",

40306

"module": "charts"

40307

},

40308

{

40309

"file": "charts/js/PieSeries.js",

40310

"line": 118,

40311

"description": "Event handler for the categoryAxisChange event.",

40312

"itemtype": "method",

40313

"name": "_categoryAxisChangeHandler",

40314

"params": [

40315

{

40316

"name": "e",

40317

"description": "Event object.",

40318

"type": "Object"

40319

}

40320

],

40321

"access": "private",

40322

"tagname": "",

40323

"class": "PieSeries",

40324

"module": "charts"

40325

},

40326

{

40327

"file": "charts/js/PieSeries.js",

40328

"line": 132,

40329

"description": "Event handler for the valueAxisChange event.",

40330

"itemtype": "method",

40331

"name": "_valueAxisChangeHandler",

40332

"params": [

40333

{

40334

"name": "e",

40335

"description": "Event object.",

40336

"type": "Object"

40337

}

40338

],

40339

"access": "private",

40340

"tagname": "",

40341

"class": "PieSeries",

40342

"module": "charts"

40343

},

40344

{

40345

"file": "charts/js/PieSeries.js",

40346

"line": 146,

40347

"description": "Constant used to generate unique id.",

40348

"itemtype": "property",

40349

"name": "GUID",

40350

"type": "String",

40351

"access": "private",

40352

"tagname": "",

40353

"class": "PieSeries",

40354

"module": "charts"

40355

},

40356

{

40357

"file": "charts/js/PieSeries.js",

40358

"line": 155,

40359

"description": "Event handler for categoryDataChange event.",

40360

"itemtype": "method",

40361

"name": "_categoryDataChangeHandler",

40362

"params": [

40363

{

40364

"name": "event",

40365

"description": "Event object.",

40366

"type": "Object"

40367

}

40368

],

40369

"access": "private",

40370

"tagname": "",

40371

"class": "PieSeries",

40372

"module": "charts"

40373

},

40374

{

40375

"file": "charts/js/PieSeries.js",

40376

"line": 170,

40377

"description": "Event handler for valueDataChange event.",

40378

"itemtype": "method",

40379

"name": "_valueDataChangeHandler",

40380

"params": [

40381

{

40382

"name": "event",

40383

"description": "Event object.",

40384

"type": "Object"

40385

}

40386

],

40387

"access": "private",

40388

"tagname": "",

40389

"class": "PieSeries",

40390

"module": "charts"

40391

},

40392

{

40393

"file": "charts/js/PieSeries.js",

40394

"line": 185,

40395

"description": "Draws the series. Overrides the base implementation.",

40396

"itemtype": "method",

40397

"name": "draw",

40398

"access": "protected",

40399

"tagname": "",

40400

"class": "PieSeries",

40401

"module": "charts"

40402

},

40403

{

40404

"file": "charts/js/PieSeries.js",

40405

"line": 219,

40406

"description": "Draws the markers",

40407

"itemtype": "method",

40408

"name": "drawPlots",

40409

"access": "protected",

40410

"tagname": "",

40411

"class": "PieSeries",

40412

"module": "charts"

40413

},

40414

{

40415

"file": "charts/js/PieSeries.js",

40416

"line": 345,

40417

"description": "Adds an interactive map when rendering in canvas.",

40418

"itemtype": "method",

40419

"name": "_addHotspot",

40420

"params": [

40421

{

40422

"name": "cfg",

40423

"description": "Object containing data used to draw the hotspot",

40424

"type": "Object"

40425

},

40426

{

40427

"name": "seriesIndex",

40428

"description": "Index of series in the `seriesCollection`.",

40429

"type": "Number"

40430

},

40431

{

40432

"name": "index",

40433

"description": "Index of the marker using the hotspot.",

40434

"type": "Number"

40435

}

40436

],

40437

"access": "private",

40438

"tagname": "",

40439

"class": "PieSeries",

40440

"module": "charts"

40441

},

40442

{

40443

"file": "charts/js/PieSeries.js",

40444

"line": 402,

40445

"description": "Resizes and positions markers based on a mouse interaction.",

40446

"itemtype": "method",

40447

"name": "updateMarkerState",

40448

"params": [

40449

{

40450

"name": "type",

40451

"description": "state of the marker",

40452

"type": "String"

40453

},

40454

{

40455

"name": "i",

40456

"description": "index of the marker",

40457

"type": "Number"

40458

}

40459

],

40460

"access": "protected",

40461

"tagname": "",

40462

"class": "PieSeries",

40463

"module": "charts"

40464

},

40465

{

40466

"file": "charts/js/PieSeries.js",

40467

"line": 427,

40468

"description": "Creates a shape to be used as a marker.",

40469

"itemtype": "method",

40470

"name": "_createMarker",

40471

"params": [

40472

{

40473

"name": "styles",

40474

"description": "Hash of style properties.",

40475

"type": "Object"

40476

},

40477

{

40478

"name": "order",

40479

"description": "Order of the series.",

40480

"type": "Number"

40481

},

40482

{

40483

"name": "index",

40484

"description": "Index within the series associated with the marker.",

40485

"type": "Number"

40486

}

40487

],

40488

"return": {

40489

"description": "Shape"

40490

},

40491

"access": "private",

40492

"tagname": "",

40493

"class": "PieSeries",

40494

"module": "charts"

40495

},

40496

{

40497

"file": "charts/js/PieSeries.js",

40498

"line": 448,

40499

"description": "Creates a cache of markers for reuse.",

40500

"itemtype": "method",

40501

"name": "_createMarkerCache",

40502

"access": "private",

40503

"tagname": "",

40504

"class": "PieSeries",

40505

"module": "charts"

40506

},

40507

{

40508

"file": "charts/js/PieSeries.js",

40509

"line": 470,

40510

"description": "Gets the default style values for the markers.",

40511

"itemtype": "method",

40512

"name": "_getPlotDefaults",

40513

"return": {

40514

"description": "Object"

40515

},

40516

"access": "private",

40517

"tagname": "",

40518

"class": "PieSeries",

40519

"module": "charts"

40520

},

40521

{

40522

"file": "charts/js/PieSeries.js",

40523

"line": 499,

40524

"description": "Collection of default colors used for lines in a series when not specified by user.",

40525

"itemtype": "property",

40526

"name": "_defaultLineColors",

40527

"type": "Array",

40528

"access": "protected",

40529

"tagname": "",

40530

"class": "PieSeries",

40531

"module": "charts"

40532

},

40533

{

40534

"file": "charts/js/PieSeries.js",

40535

"line": 508,

40536

"description": "Collection of default colors used for marker fills in a series when not specified by user.",

40537

"itemtype": "property",

40538

"name": "_defaultFillColors",

40539

"type": "Array",

40540

"access": "protected",

40541

"tagname": "",

40542

"class": "PieSeries",

40543

"module": "charts"

40544

},

40545

{

40546

"file": "charts/js/PieSeries.js",

40547

"line": 517,

40548

"description": "Collection of default colors used for marker borders in a series when not specified by user.",

40549

"itemtype": "property",

40550

"name": "_defaultBorderColors",

40551

"type": "Array",

40552

"access": "protected",

40553

"tagname": "",

40554

"class": "PieSeries",

40555

"module": "charts"

40556

},

40557

{

40558

"file": "charts/js/PieSeries.js",

40559

"line": 526,

40560

"description": "Collection of default colors used for area fills, histogram fills and pie fills in a series when not specified by user.",

40561

"itemtype": "property",

40562

"name": "_defaultSliceColors",

40563

"type": "Array",

40564

"access": "protected",

40565

"tagname": "",

40566

"class": "PieSeries",

40567

"module": "charts"

40568

},

40569

{

40570

"file": "charts/js/PieSeries.js",

40571

"line": 535,

40572

"description": "Colors used if style colors are not specified",

40573

"itemtype": "method",

40574

"name": "_getDefaultColor",

40575

"params": [

40576

{

40577

"name": "index",

40578

"description": "Index indicating the series order.",

40579

"type": "Number"

40580

},

40581

{

40582

"name": "type",

40583

"description": "Indicates which type of object needs the color.",

40584

"type": "String"

40585

}

40586

],

40587

"return": {

40588

"description": "String"

40589

},

40590

"access": "protected",

40591

"tagname": "",

40592

"class": "PieSeries",

40593

"module": "charts"

40594

},

40595

{

40596

"file": "charts/js/PieSeries.js",

40597

"line": 564,

40598

"description": "Read-only attribute indicating the type of series.",

40599

"itemtype": "attribute",

40600

"name": "type",

40601

"type": "String",

40602

"default": "pie",

40603

"class": "PieSeries",

40604

"module": "charts"

40605

},

40606

{

40607

"file": "charts/js/PieSeries.js",

40608

"line": 575,

40609

"description": "Order of this instance of this `type`.",

40610

"itemtype": "attribute",

40611

"name": "order",

40612

"type": "Number",

40613

"class": "PieSeries",

40614

"module": "charts"

40615

},

40616

{

40617

"file": "charts/js/PieSeries.js",

40618

"line": 583,

40619

"description": "Reference to the `Graph` in which the series is drawn into.",

40620

"itemtype": "attribute",

40621

"name": "graph",

40622

"type": "Graph",

40623

"class": "PieSeries",

40624

"module": "charts"

40625

},

40626

{

40627

"file": "charts/js/PieSeries.js",

40628

"line": 591,

40629

"description": "Reference to the `Axis` instance used for assigning \ncategory values to the graph.",

40630

"itemtype": "attribute",

40631

"name": "categoryAxis",

40632

"type": "Axis",

40633

"class": "PieSeries",

40634

"module": "charts"

40635

},

40636

{

40637

"file": "charts/js/PieSeries.js",

40638

"line": 607,

40639

"description": "Reference to the `Axis` instance used for assigning \nseries values to the graph.",

40640

"itemtype": "attribute",

40641

"name": "categoryAxis",

40642

"type": "Axis",

40643

"class": "PieSeries",

40644

"module": "charts"

40645

},

40646

{

40647

"file": "charts/js/PieSeries.js",

40648

"line": 623,

40649

"description": "Indicates which array to from the hash of value arrays in \nthe category `Axis` instance.",

40650

"itemtype": "attribute",

40651

"name": "categoryKey",

40652

"type": "String",

40653

"class": "PieSeries",

40654

"module": "charts"

40655

},

40656

{

40657

"file": "charts/js/PieSeries.js",

40658

"line": 638,

40659

"description": "Indicates which array to from the hash of value arrays in \nthe value `Axis` instance.",

40660

"itemtype": "attribute",

40661

"name": "valueKey",

40662

"type": "String",

40663

"class": "PieSeries",

40664

"module": "charts"

40665

},

40666

{

40667

"file": "charts/js/PieSeries.js",

40668

"line": 654,

40669

"description": "Name used for for displaying category data",

40670

"itemtype": "attribute",

40671

"name": "categoryDisplayName",

40672

"type": "String",

40673

"class": "PieSeries",

40674

"module": "charts"

40675

},

40676

{

40677

"file": "charts/js/PieSeries.js",

40678

"line": 673,

40679

"description": "Name used for for displaying value data",

40680

"itemtype": "attribute",

40681

"name": "valueDisplayName",

40682

"type": "String",

40683

"class": "PieSeries",

40684

"module": "charts"

40685

},

40686

{

40687

"file": "charts/js/PieSeries.js",

40688

"line": 692,

40689

"itemtype": "attribute",

40690

"name": "slices",

40691

"type": "Array",

40692

"access": "private",

40693

"tagname": "",

40694

"class": "PieSeries",

40695

"module": "charts"

40696

},

40697

{

40698

"file": "charts/js/PieSeries.js",

40699

"line": 699,

40700

"description": "Style properties used for drawing markers. This attribute is inherited from `MarkerSeries`. Below are the default values:\n <dl>\n <dt>fill</dt><dd>A hash containing the following values:\n <dl>\n <dt>colors</dt><dd>An array of colors to be used for the marker fills. The color for each marker is retrieved from the \n array below: \n `[\"#66007f\", \"#a86f41\", \"#295454\", \"#996ab2\", \"#e8cdb7\", \"#90bdbd\",\"#000000\",\"#c3b8ca\", \"#968373\", \"#678585\"]`\n </dd>\n <dt>alphas</dt><dd>An array of alpha references (Number from 0 to 1) indicating the opacity of each marker fill. The default value is [1].</dd>\n </dl>\n </dd>\n <dt>border</dt><dd>A hash containing the following values:\n <dl>\n <dt>color</dt><dd>An array of colors to be used for the marker borders. The color for each marker is retrieved from the\n array below: \n `[\"#205096\", \"#b38206\", \"#000000\", \"#94001e\", \"#9d6fa0\", \"#e55b00\", \"#5e85c9\", \"#adab9e\", \"#6ac291\", \"#006457\"]`\n <dt>alpha</dt><dd>Number from 0 to 1 indicating the opacity of the marker border. The default value is 1.</dd>\n <dt>weight</dt><dd>Number indicating the width of the border. The default value is 1.</dd>\n </dl>\n </dd>\n <dt>over</dt><dd>hash containing styles for markers when highlighted by a `mouseover` event. The default \n values for each style is null. When an over style is not set, the non-over value will be used. For example,\n the default value for `marker.over.fill.color` is equivalent to `marker.fill.color`.</dd>\n </dl>",

40701

"itemtype": "attribute",

40702

"name": "styles",

40703

"type": "Object",

40704

"class": "PieSeries",

40705

"module": "charts"

40706

},

40707

{

40708

"file": "charts/js/Plots.js",

40709

"line": 22,

40710

"description": "Storage for default marker styles.",

40711

"itemtype": "property",

40712

"name": "_plotDefaults",

40713

"type": "Object",

40714

"access": "private",

40715

"tagname": "",

40716

"class": "Plots",

40717

"module": "charts"

40718

},

40719

{

40720

"file": "charts/js/Plots.js",

40721

"line": 31,

40722

"description": "Draws the markers",

40723

"itemtype": "method",

40724

"name": "drawPlots",

40725

"access": "protected",

40726

"tagname": "",

40727

"class": "Plots",

40728

"module": "charts"

40729

},

40730

{

40731

"file": "charts/js/Plots.js",

40732

"line": 119,

40733

"description": "Pre-defined group shapes.",

40734

"itemtype": "property",

40735

"name": "_groupShapes",

40736

"access": "private",

40737

"tagname": "",

40738

"class": "Plots",

40739

"module": "charts"

40740

},

40741

{

40742

"file": "charts/js/Plots.js",

40743

"line": 132,

40744

"description": "Returns the correct group shape class.",

40745

"itemtype": "method",

40746

"name": "_getGroupShape",

40747

"params": [

40748

{

40749

"name": "shape",

40750

"description": "Indicates which shape class.",

40751

"type": "Shape | String"

40752

}

40753

],

40754

"return": {

40755

"description": "Function"

40756

},

40757

"access": "protected",

40758

"tagname": "",

40759

"class": "Plots",

40760

"module": "charts"

40761

},

40762

{

40763

"file": "charts/js/Plots.js",

40764

"line": 149,

40765

"description": "Gets the default values for series that use the utility. This method is used by\nthe class' `styles` attribute's getter to get build default values.",

40766

"itemtype": "method",

40767

"name": "_getPlotDefaults",

40768

"return": {

40769

"description": "Object"

40770

},

40771

"access": "protected",

40772

"tagname": "",

40773

"class": "Plots",

40774

"module": "charts"

40775

},

40776

{

40777

"file": "charts/js/Plots.js",

40778

"line": 180,

40779

"description": "Collection of markers to be used in the series.",

40780

"itemtype": "property",

40781

"name": "_markers",

40782

"type": "Array",

40783

"access": "private",

40784

"tagname": "",

40785

"class": "Plots",

40786

"module": "charts"

40787

},

40788

{

40789

"file": "charts/js/Plots.js",

40790

"line": 189,

40791

"description": "Collection of markers to be re-used on a series redraw.",

40792

"itemtype": "property",

40793

"name": "_markerCache",

40794

"type": "Array",

40795

"access": "private",

40796

"tagname": "",

40797

"class": "Plots",

40798

"module": "charts"

40799

},

40800

{

40801

"file": "charts/js/Plots.js",

40802

"line": 198,

40803

"description": "Gets and styles a marker. If there is a marker in cache, it will use it. Otherwise\nit will create one.",

40804

"itemtype": "method",

40805

"name": "getMarker",

40806

"params": [

40807

{

40808

"name": "styles",

40809

"description": "Hash of style properties.",

40810

"type": "Object"

40811

},

40812

{

40813

"name": "order",

40814

"description": "Order of the series.",

40815

"type": "Number"

40816

},

40817

{

40818

"name": "index",

40819

"description": "Index within the series associated with the marker.",

40820

"type": "Number"

40821

}

40822

],

40823

"return": {

40824

"description": "Shape"

40825

},

40826

"access": "protected",

40827

"tagname": "",

40828

"class": "Plots",

40829

"module": "charts"

40830

},

40831

{

40832

"file": "charts/js/Plots.js",

40833

"line": 240,

40834

"description": "Creates a shape to be used as a marker.",

40835

"itemtype": "method",

40836

"name": "_createMarker",

40837

"params": [

40838

{

40839

"name": "styles",

40840

"description": "Hash of style properties.",

40841

"type": "Object"

40842

},

40843

{

40844

"name": "order",

40845

"description": "Order of the series.",

40846

"type": "Number"

40847

},

40848

{

40849

"name": "index",

40850

"description": "Index within the series associated with the marker.",

40851

"type": "Number"

40852

}

40853

],

40854

"return": {

40855

"description": "Shape"

40856

},

40857

"access": "private",

40858

"tagname": "",

40859

"class": "Plots",

40860

"module": "charts"

40861

},

40862

{

40863

"file": "charts/js/Plots.js",

40864

"line": 262,

40865

"description": "Creates a cache of markers for reuse.",

40866

"itemtype": "method",

40867

"name": "_createMarkerCache",

40868

"access": "private",

40869

"tagname": "",

40870

"class": "Plots",

40871

"module": "charts"

40872

},

40873

{

40874

"file": "charts/js/Plots.js",

40875

"line": 286,

40876

"description": "Draws a series of markers in a single shape instance.",

40877

"itemtype": "method",

40878

"name": "_createGroupMarkers",

40879

"params": [

40880

{

40881

"name": "styles",

40882

"description": "Set of configuration properties used to create the markers.",

40883

"type": "Object"

40884

}

40885

],

40886

"access": "protected",

40887

"tagname": "",

40888

"class": "Plots",

40889

"module": "charts"

40890

},

40891

{

40892

"file": "charts/js/Plots.js",

40893

"line": 339,

40894

"description": "Toggles visibility",

40895

"itemtype": "method",

40896

"name": "_toggleVisible",

40897

"params": [

40898

{

40899

"name": "visible",

40900

"description": "indicates visibilitye",

40901

"type": "Boolean"

40902

}

40903

],

40904

"access": "private",

40905

"tagname": "",

40906

"class": "Plots",

40907

"module": "charts"

40908

},

40909

{

40910

"file": "charts/js/Plots.js",

40911

"line": 366,

40912

"description": "Removes unused markers from the marker cache",

40913

"itemtype": "method",

40914

"name": "_clearMarkerCache",

40915

"access": "private",

40916

"tagname": "",

40917

"class": "Plots",

40918

"module": "charts"

40919

},

40920

{

40921

"file": "charts/js/Plots.js",

40922

"line": 385,

40923

"description": "Resizes and positions markers based on a mouse interaction.",

40924

"itemtype": "method",

40925

"name": "updateMarkerState",

40926

"params": [

40927

{

40928

"name": "type",

40929

"description": "state of the marker",

40930

"type": "String"

40931

},

40932

{

40933

"name": "i",

40934

"description": "index of the marker",

40935

"type": "Number"

40936

}

40937

],

40938

"access": "protected",

40939

"tagname": "",

40940

"class": "Plots",

40941

"module": "charts"

40942

},

40943

{

40944

"file": "charts/js/Plots.js",

40945

"line": 417,

40946

"description": "Parses a color from an array.",

40947

"itemtype": "method",

40948

"name": "_getItemColor",

40949

"params": [

40950

{

40951

"name": "val",

40952

"description": "collection of colors",

40953

"type": "Array"

40954

},

40955

{

40956

"name": "i",

40957

"description": "index of the item",

40958

"type": "Number"

40959

}

40960

],

40961

"return": {

40962

"description": "String"

40963

},

40964

"access": "protected",

40965

"tagname": "",

40966

"class": "Plots",

40967

"module": "charts"

40968

},

40969

{

40970

"file": "charts/js/Plots.js",

40971

"line": 435,

40972

"description": "Method used by `styles` setter. Overrides base implementation.",

40973

"itemtype": "method",

40974

"name": "_setStyles",

40975

"params": [

40976

{

40977

"name": "newStyles",

40978

"description": "Hash of properties to update.",

40979

"type": "Object"

40980

}

40981

],

40982

"return": {

40983

"description": "Object"

40984

},

40985

"access": "protected",

40986

"tagname": "",

40987

"class": "Plots",

40988

"module": "charts"

40989

},

40990

{

40991

"file": "charts/js/Plots.js",

40992

"line": 449,

40993

"description": "Combines new styles with existing styles.",

40994

"itemtype": "method",

40995

"name": "_parseMarkerStyles",

40996

"params": [

40997

{

40998

"name": "Object",

40999

"description": "containing style properties for the marker.",

41000

"type": "Object"

41001

}

41002

],

41003

"return": {

41004

"description": "Object"

41005

},

41006

"access": "private",

41007

"tagname": "",

41008

"class": "Plots",

41009

"module": "charts"

41010

},

41011

{

41012

"file": "charts/js/Plots.js",

41013

"line": 475,

41014

"description": "Returns marker state based on event type",

41015

"itemtype": "method",

41016

"name": "_getState",

41017

"params": [

41018

{

41019

"name": "type",

41020

"description": "event type",

41021

"type": "String"

41022

}

41023

],

41024

"return": {

41025

"description": "String"

41026

},

41027

"access": "protected",

41028

"tagname": "",

41029

"class": "Plots",

41030

"module": "charts"

41031

},

41032

{

41033

"file": "charts/js/Plots.js",

41034

"line": 504,

41035

"itemtype": "property",

41036

"name": "_statSyles",

41037

"type": "Object",

41038

"access": "private",

41039

"tagname": "",

41040

"class": "Plots",

41041

"module": "charts"

41042

},

41043

{

41044

"file": "charts/js/RectGroup.js",

41045

"line": 16,

41046

"description": "Updates the rect.",

41047

"itemtype": "method",

41048

"name": "_draw",

41049

"access": "private",

41050

"tagname": "",

41051

"class": "GroupRect",

41052

"module": "graphics"

41053

},

41054

{

41055

"file": "charts/js/Renderer.js",

41056

"line": 12,

41057

"description": "Style properties for class",

41058

"itemtype": "attribute",

41059

"name": "styles",

41060

"type": "Object",

41061

"class": "Renderer",

41062

"module": "charts"

41063

},

41064

{

41065

"file": "charts/js/Renderer.js",

41066

"line": 32,

41067

"description": "The graphic in which drawings will be rendered.",

41068

"itemtype": "attribute",

41069

"name": "graphic",

41070

"type": "Graphic",

41071

"class": "Renderer",

41072

"module": "charts"

41073

},

41074

{

41075

"file": "charts/js/Renderer.js",

41076

"line": 43,

41077

"description": "Storage for `styles` attribute.",

41078

"itemtype": "property",

41079

"name": "_styles",

41080

"type": "Object",

41081

"access": "private",

41082

"tagname": "",

41083

"class": "Renderer",

41084

"module": "charts"

41085

},

41086

{

41087

"file": "charts/js/Renderer.js",

41088

"line": 52,

41089

"description": "Method used by `styles` setter.",

41090

"itemtype": "method",

41091

"name": "_setStyles",

41092

"params": [

41093

{

41094

"name": "newStyles",

41095

"description": "Hash of properties to update.",

41096

"type": "Object"

41097

}

41098

],

41099

"return": {

41100

"description": "Object"

41101

},

41102

"access": "protected",

41103

"tagname": "",

41104

"class": "Renderer",

41105

"module": "charts"

41106

},

41107

{

41108

"file": "charts/js/Renderer.js",

41109

"line": 66,

41110

"description": "Merges to object literals so that only specified properties are \noverwritten.",

41111

"itemtype": "method",

41112

"name": "_mergeStyles",

41113

"params": [

41114

{

41115

"name": "a",

41116

"description": "Hash of new styles",

41117

"type": "Object"

41118

},

41119

{

41120

"name": "b",

41121

"description": "Hash of original styles",

41122

"type": "Object"

41123

}

41124

],

41125

"return": {

41126

"description": "Object"

41127

},

41128

"access": "protected",

41129

"tagname": "",

41130

"class": "Renderer",

41131

"module": "charts"

41132

},

41133

{

41134

"file": "charts/js/Renderer.js",

41135

"line": 97,

41136

"description": "Gets the default value for the `styles` attribute.",

41137

"itemtype": "method",

41138

"name": "_getDefaultStyles",

41139

"return": {

41140

"description": "Object"

41141

},

41142

"access": "protected",

41143

"tagname": "",

41144

"class": "Renderer",

41145

"module": "charts"

41146

},

41147

{

41148

"file": "charts/js/RightAxisLayout.js",

41149

"line": 11,

41150

"description": "Default margins for text fields.",

41151

"access": "private",

41152

"tagname": "",

41153

"itemtype": "method",

41154

"name": "_getDefaultMargins",

41155

"return": {

41156

"description": "Object"

41157

},

41158

"class": "RightAxisLayout",

41159

"module": "charts"

41160

},

41161

{

41162

"file": "charts/js/RightAxisLayout.js",

41163

"line": 28,

41164

"description": "Sets the length of the tick on either side of the axis line.",

41165

"itemtype": "method",

41166

"name": "setTickOffset",

41167

"access": "protected",

41168

"tagname": "",

41169

"class": "RightAxisLayout",

41170

"module": "charts"

41171

},

41172

{

41173

"file": "charts/js/RightAxisLayout.js",

41174

"line": 65,

41175

"description": "Draws a tick",

41176

"itemtype": "method",

41177

"name": "drawTick",

41178

"params": [

41179

{

41180

"name": "path",

41181

"description": "reference to the path `Path` element in which to draw the tick.",

41182

"type": "Path"

41183

},

41184

{

41185

"name": "pt",

41186

"description": "Point on the axis in which the tick will intersect.",

41187

"type": "Object"

41188

},

41189

{

41190

"name": "{Object)",

41191

"description": "tickStyle Hash of properties to apply to the tick."

41192

}

41193

],

41194

"access": "protected",

41195

"tagname": "",

41196

"class": "RightAxisLayout",

41197

"module": "charts"

41198

},

41199

{

41200

"file": "charts/js/RightAxisLayout.js",

41201

"line": 85,

41202

"description": "Calculates the coordinates for the first point on an axis.",

41203

"itemtype": "method",

41204

"name": "getLineStart",

41205

"return": {

41206

"description": "",

41207

"type": "Object"

41208

},

41209

"access": "protected",

41210

"tagname": "",

41211

"class": "RightAxisLayout",

41212

"module": "charts"

41213

},

41214

{

41215

"file": "charts/js/RightAxisLayout.js",

41216

"line": 112,

41217

"description": "Calculates the point for a label.",

41218

"itemtype": "method",

41219

"name": "getLabelPoint",

41220

"params": [

41221

{

41222

"name": "point",

41223

"description": "Point on the axis in which the tick will intersect.",

41224

"type": "Object"

41225

}

41226

],

41227

"return": {

41228

"description": "",

41229

"type": "Object"

41230

},

41231

"access": "protected",

41232

"tagname": "",

41233

"class": "RightAxisLayout",

41234

"module": "charts"

41235

},

41236

{

41237

"file": "charts/js/RightAxisLayout.js",

41238

"line": 125,

41239

"description": "Updates the value for the `maxLabelSize` for use in calculating total size.",

41240

"itemtype": "method",

41241

"name": "updateMaxLabelSize",

41242

"params": [

41243

{

41244

"name": "label",

41245

"description": "to measure",

41246

"type": "HTMLElement"

41247

}

41248

],

41249

"access": "protected",

41250

"tagname": "",

41251

"class": "RightAxisLayout",

41252

"module": "charts"

41253

},

41254

{

41255

"file": "charts/js/RightAxisLayout.js",

41256

"line": 156,

41257

"description": "Determines the available label width when the axis width has been explicitly set.",

41258

"itemtype": "method",

41259

"name": "getExplicitlySized",

41260

"return": {

41261

"description": "Boolean"

41262

},

41263

"access": "protected",

41264

"tagname": "",

41265

"class": "RightAxisLayout",

41266

"module": "charts"

41267

},

41268

{

41269

"file": "charts/js/RightAxisLayout.js",

41270

"line": 178,

41271

"description": "Rotate and position title.",

41272

"itemtype": "method",

41273

"name": "positionTitle",

41274

"params": [

41275

{

41276

"name": "label",

41277

"description": "to rotate position",

41278

"type": "HTMLElement"

41279

}

41280

],

41281

"access": "protected",

41282

"tagname": "",

41283

"class": "RightAxisLayout",

41284

"module": "charts"

41285

},

41286

{

41287

"file": "charts/js/RightAxisLayout.js",

41288

"line": 208,

41289

"description": "Rotate and position labels.",

41290

"itemtype": "method",

41291

"name": "positionLabel",

41292

"params": [

41293

{

41294

"name": "label",

41295

"description": "to rotate position",

41296

"type": "HTMLElement"

41297

},

41298

{

41299

"name": "pt",

41300

"description": "hash containing the x and y coordinates in which the label will be positioned\nagainst.",

41301

"type": "Object"

41302

}

41303

],

41304

"access": "protected",

41305

"tagname": "",

41306

"class": "RightAxisLayout",

41307

"module": "charts"

41308

},

41309

{

41310

"file": "charts/js/RightAxisLayout.js",

41311

"line": 261,

41312

"description": "Adjusts the coordinates of an axis label based on the rotation.",

41313

"itemtype": "method",

41314

"name": "_setRotationCoords",

41315

"params": [

41316

{

41317

"name": "props",

41318

"description": "Coordinates, dimension and rotation properties of the label.",

41319

"type": "Object"

41320

}

41321

],

41322

"access": "protected",

41323

"tagname": "",

41324

"class": "RightAxisLayout",

41325

"module": "charts"

41326

},

41327

{

41328

"file": "charts/js/RightAxisLayout.js",

41329

"line": 298,

41330

"description": "Returns the transformOrigin to use for an axis label based on the position of the axis \nand the rotation of the label.",

41331

"itemtype": "method",

41332

"name": "_getTransformOrigin",

41333

"params": [

41334

{

41335

"name": "rot",

41336

"description": "The rotation (in degrees) of the label.",

41337

"type": "Number"

41338

}

41339

],

41340

"return": {

41341

"description": "Array"

41342

},

41343

"access": "protected",

41344

"tagname": "",

41345

"class": "RightAxisLayout",

41346

"module": "charts"

41347

},

41348

{

41349

"file": "charts/js/RightAxisLayout.js",

41350

"line": 329,

41351

"description": "Adjusts position for inner ticks.",

41352

"itemtype": "method",

41353

"name": "offsetNodeForTick",

41354

"params": [

41355

{

41356

"name": "cb",

41357

"description": "contentBox of the axis",

41358

"type": "Node"

41359

}

41360

],

41361

"access": "protected",

41362

"tagname": "",

41363

"class": "RightAxisLayout",

41364

"module": "charts"

41365

},

41366

{

41367

"file": "charts/js/RightAxisLayout.js",

41368

"line": 344,

41369

"description": "Assigns a height based on the size of the contents.",

41370

"itemtype": "method",

41371

"name": "setCalculatedSize",

41372

"access": "protected",

41373

"tagname": "",

41374

"class": "RightAxisLayout",

41375

"module": "charts"

41376

},

41377

{

41378

"file": "charts/js/ShapeGroup.js",

41379

"line": 40,

41380

"description": "Updates the shape.",

41381

"itemtype": "method",

41382

"name": "_draw",

41383

"access": "private",

41384

"tagname": "",

41385

"class": "ShapeGroup",

41386

"module": "graphics"

41387

},

41388

{

41389

"file": "charts/js/ShapeGroup.js",

41390

"line": 102,

41391

"description": "Parses and array of lengths into radii",

41392

"itemtype": "method",

41393

"name": "_getRadiusCollection",

41394

"params": [

41395

{

41396

"name": "val",

41397

"description": "Array of lengths",

41398

"type": "Array"

41399

}

41400

],

41401

"return": {

41402

"description": "Array"

41403

},

41404

"access": "private",

41405

"tagname": "",

41406

"class": "ShapeGroup",

41407

"module": "graphics"

41408

},

41409

{

41410

"file": "charts/js/SplineSeries.js",

41411

"line": 12,

41412

"access": "protected",

41413

"tagname": "Draws the series.",

41414

"itemtype": "method",

41415

"name": "drawSeries",

41416

"class": "SplineSeries",

41417

"module": "charts"

41418

},

41419

{

41420

"file": "charts/js/SplineSeries.js",

41421

"line": 25,

41422

"description": "Read-only attribute indicating the type of series.",

41423

"itemtype": "attribute",

41424

"name": "type",

41425

"type": "String",

41426

"default": "spline",

41427

"class": "SplineSeries",

41428

"module": "charts"

41429

},

41430

{

41431

"file": "charts/js/SplineSeries.js",

41432

"line": 36,

41433

"description": "Style properties used for drawing lines. This attribute is inherited from `Renderer`. Below are the default values:\n <dl>\n <dt>color</dt><dd>The color of the line. The default value is determined by the order of the series on the graph. The color will be\n retrieved from the following array: \n `[\"#426ab3\", \"#d09b2c\", \"#000000\", \"#b82837\", \"#b384b5\", \"#ff7200\", \"#779de3\", \"#cbc8ba\", \"#7ed7a6\", \"#007a6c\"]`\n <dt>weight</dt><dd>Number that indicates the width of the line. The default value is 6.</dd>\n <dt>alpha</dt><dd>Number between 0 and 1 that indicates the opacity of the line. The default value is 1.</dd>\n <dt>lineType</dt><dd>Indicates whether the line is solid or dashed. The default value is solid.</dd> \n <dt>dashLength</dt><dd>When the `lineType` is dashed, indicates the length of the dash. The default value is 10.</dd>\n <dt>gapSpace</dt><dd>When the `lineType` is dashed, indicates the distance between dashes. The default value is 10.</dd>\n <dt>connectDiscontinuousPoints</dt><dd>Indicates whether or not to connect lines when there is a missing or null value between points. The default value is true.</dd> \n <dt>discontinuousType</dt><dd>Indicates whether the line between discontinuous points is solid or dashed. The default value is solid.</dd>\n <dt>discontinuousDashLength</dt><dd>When the `discontinuousType` is dashed, indicates the length of the dash. The default value is 10.</dd>\n <dt>discontinuousGapSpace</dt><dd>When the `discontinuousType` is dashed, indicates the distance between dashes. The default value is 10.</dd>\n </dl>",

41434

"itemtype": "attribute",

41435

"name": "styles",

41436

"type": "Object",

41437

"class": "SplineSeries",

41438

"module": "charts"

41439

},

41440

{

41441

"file": "charts/js/StackedAreaSeries.js",

41442

"line": 12,

41443

"access": "protected",

41444

"tagname": "Calculates the coordinates for the series. Overrides base implementation.",

41445

"itemtype": "method",

41446

"name": "setAreaData",

41447

"class": "StackedAreaSeries",

41448

"module": "charts"

41449

},

41450

{

41451

"file": "charts/js/StackedAreaSeries.js",

41452

"line": 25,

41453

"access": "protected",

41454

"tagname": "Draws the series",

41455

"itemtype": "method",

41456

"name": "drawSeries",

41457

"class": "StackedAreaSeries",

41458

"module": "charts"

41459

},

41460

{

41461

"file": "charts/js/StackedAreaSeries.js",

41462

"line": 38,

41463

"description": "Read-only attribute indicating the type of series.",

41464

"itemtype": "attribute",

41465

"name": "type",

41466

"type": "String",

41467

"default": "stackedArea",

41468

"class": "StackedAreaSeries",

41469

"module": "charts"

41470

},

41471

{

41472

"file": "charts/js/StackedAreaSplineSeries.js",

41473

"line": 12,

41474

"access": "protected",

41475

"tagname": "Draws the series.",

41476

"itemtype": "method",

41477

"name": "drawSeries",

41478

"class": "StackedAreaSplineSeries",

41479

"module": "charts"

41480

},

41481

{

41482

"file": "charts/js/StackedAreaSplineSeries.js",

41483

"line": 26,

41484

"description": "Read-only attribute indicating the type of series.",

41485

"itemtype": "attribute",

41486

"name": "type",

41487

"type": "String",

41488

"default": "stackedAreaSpline",

41489

"class": "StackedAreaSplineSeries",

41490

"module": "charts"

41491

},

41492

{

41493

"file": "charts/js/StackedAxis.js",

41494

"line": 20,

41495

"description": "Calculates the maximum and minimum values for the `Axis`.",

41496

"itemtype": "method",

41497

"name": "_updateMinAndMax",

41498

"access": "private",

41499

"tagname": "",

41500

"class": "StackedAxis",

41501

"module": "charts"

41502

},

41503

{

41504

"file": "charts/js/StackedBarSeries.js",

41505

"line": 12,

41506

"access": "protected",

41507

"tagname": "Draws the series.",

41508

"itemtype": "method",

41509

"name": "drawSeries",

41510

"class": "StackedBarSeries",

41511

"module": "charts"

41512

},

41513

{

41514

"file": "charts/js/StackedBarSeries.js",

41515

"line": 190,

41516

"access": "protected",

41517

"tagname": "Resizes and positions markers based on a mouse interaction.",

41518

"itemtype": "method",

41519

"name": "updateMarkerState",

41520

"params": [

41521

{

41522

"name": "type",

41523

"description": "state of the marker",

41524

"type": "String"

41525

},

41526

{

41527

"name": "i",

41528

"description": "index of the marker",

41529

"type": "Number"

41530

}

41531

],

41532

"class": "StackedBarSeries",

41533

"module": "charts"

41534

},

41535

{

41536

"file": "charts/js/StackedBarSeries.js",

41537

"line": 237,

41538

"access": "protected",

41539

"tagname": "Returns default values for the `styles` attribute.",

41540

"itemtype": "method",

41541

"name": "_getPlotDefaults",

41542

"return": {

41543

"description": "Object"

41544

},

41545

"class": "StackedBarSeries",

41546

"module": "charts"

41547

},

41548

{

41549

"file": "charts/js/StackedBarSeries.js",

41550

"line": 276,

41551

"description": "Read-only attribute indicating the type of series.",

41552

"itemtype": "attribute",

41553

"name": "type",

41554

"type": "String",

41555

"default": "stackedBar",

41556

"class": "StackedBarSeries",

41557

"module": "charts"

41558

},

41559

{

41560

"file": "charts/js/StackedBarSeries.js",

41561

"line": 287,

41562

"description": "Direction of the series",

41563

"itemtype": "attribute",

41564

"name": "direction",

41565

"type": "String",

41566

"default": "vertical",

41567

"class": "StackedBarSeries",

41568

"module": "charts"

41569

},

41570

{

41571

"file": "charts/js/StackedBarSeries.js",

41572

"line": 298,

41573

"access": "private",

41574

"tagname": "",

41575

"itemtype": "attribute",

41576

"name": "negativeBaseValues",

41577

"type": "Array",

41578

"default": "null",

41579

"class": "StackedBarSeries",

41580

"module": "charts"

41581

},

41582

{

41583

"file": "charts/js/StackedBarSeries.js",

41584

"line": 309,

41585

"access": "private",

41586

"tagname": "",

41587

"itemtype": "attribute",

41588

"name": "positiveBaseValues",

41589

"type": "Array",

41590

"default": "null",

41591

"class": "StackedBarSeries",

41592

"module": "charts"

41593

},

41594

{

41595

"file": "charts/js/StackedBarSeries.js",

41596

"line": 320,

41597

"description": "Style properties used for drawing markers. This attribute is inherited from `BarSeries`. Below are the default values:\n <dl>\n <dt>fill</dt><dd>A hash containing the following values:\n <dl>\n <dt>color</dt><dd>Color of the fill. The default value is determined by the order of the series on the graph. The color\n will be retrieved from the below array: \n `[\"#66007f\", \"#a86f41\", \"#295454\", \"#996ab2\", \"#e8cdb7\", \"#90bdbd\",\"#000000\",\"#c3b8ca\", \"#968373\", \"#678585\"]`\n </dd>\n <dt>alpha</dt><dd>Number from 0 to 1 indicating the opacity of the marker fill. The default value is 1.</dd>\n </dl>\n </dd>\n <dt>border</dt><dd>A hash containing the following values:\n <dl>\n <dt>color</dt><dd>Color of the border. The default value is determined by the order of the series on the graph. The color\n will be retrieved from the below array: \n `[\"#205096\", \"#b38206\", \"#000000\", \"#94001e\", \"#9d6fa0\", \"#e55b00\", \"#5e85c9\", \"#adab9e\", \"#6ac291\", \"#006457\"]`\n <dt>alpha</dt><dd>Number from 0 to 1 indicating the opacity of the marker border. The default value is 1.</dd>\n <dt>weight</dt><dd>Number indicating the width of the border. The default value is 1.</dd>\n </dl>\n </dd>\n <dt>height</dt><dd>indicates the width of the marker. The default value is 24.</dd>\n <dt>over</dt><dd>hash containing styles for markers when highlighted by a `mouseover` event. The default \n values for each style is null. When an over style is not set, the non-over value will be used. For example,\n the default value for `marker.over.fill.color` is equivalent to `marker.fill.color`.</dd>\n </dl>",

41598

"itemtype": "attribute",

41599

"name": "styles",

41600

"type": "Object",

41601

"class": "StackedBarSeries",

41602

"module": "charts"

41603

},

41604

{

41605

"file": "charts/js/StackedColumnSeries.js",

41606

"line": 12,

41607

"description": "Draws the series.",

41608

"itemtype": "method",

41609

"name": "drawSeries",

41610

"access": "protected",

41611

"tagname": "",

41612

"class": "StackedColumnSeries",

41613

"module": "charts"

41614

},

41615

{

41616

"file": "charts/js/StackedColumnSeries.js",

41617

"line": 189,

41618

"description": "Resizes and positions markers based on a mouse interaction.",

41619

"itemtype": "method",

41620

"name": "updateMarkerState",

41621

"params": [

41622

{

41623

"name": "type",

41624

"description": "state of the marker",

41625

"type": "String"

41626

},

41627

{

41628

"name": "i",

41629

"description": "index of the marker",

41630

"type": "Number"

41631

}

41632

],

41633

"access": "protected",

41634

"tagname": "",

41635

"class": "StackedColumnSeries",

41636

"module": "charts"

41637

},

41638

{

41639

"file": "charts/js/StackedColumnSeries.js",

41640

"line": 238,

41641

"description": "Gets the default values for the markers.",

41642

"itemtype": "method",

41643

"name": "_getPlotDefaults",

41644

"return": {

41645

"description": "Object"

41646

},

41647

"access": "protected",

41648

"tagname": "",

41649

"class": "StackedColumnSeries",

41650

"module": "charts"

41651

},

41652

{

41653

"file": "charts/js/StackedColumnSeries.js",

41654

"line": 276,

41655

"description": "Read-only attribute indicating the type of series.",

41656

"itemtype": "attribute",

41657

"name": "type",

41658

"type": "String",

41659

"default": "stackedColumn",

41660

"class": "StackedColumnSeries",

41661

"module": "charts"

41662

},

41663

{

41664

"file": "charts/js/StackedColumnSeries.js",

41665

"line": 287,

41666

"itemtype": "attribute",

41667

"name": "negativeBaseValues",

41668

"type": "Array",

41669

"default": "null",

41670

"access": "private",

41671

"tagname": "",

41672

"class": "StackedColumnSeries",

41673

"module": "charts"

41674

},

41675

{

41676

"file": "charts/js/StackedColumnSeries.js",

41677

"line": 297,

41678

"itemtype": "attribute",

41679

"name": "positiveBaseValues",

41680

"type": "Array",

41681

"default": "null",

41682

"access": "private",

41683

"tagname": "",

41684

"class": "StackedColumnSeries",

41685

"module": "charts"

41686

},

41687

{

41688

"file": "charts/js/StackedColumnSeries.js",

41689

"line": 307,

41690

"description": "Style properties used for drawing markers. This attribute is inherited from `ColumnSeries`. Below are the default values:\n <dl>\n <dt>fill</dt><dd>A hash containing the following values:\n <dl>\n <dt>color</dt><dd>Color of the fill. The default value is determined by the order of the series on the graph. The color\n will be retrieved from the below array: \n `[\"#66007f\", \"#a86f41\", \"#295454\", \"#996ab2\", \"#e8cdb7\", \"#90bdbd\",\"#000000\",\"#c3b8ca\", \"#968373\", \"#678585\"]`\n </dd>\n <dt>alpha</dt><dd>Number from 0 to 1 indicating the opacity of the marker fill. The default value is 1.</dd>\n </dl>\n </dd>\n <dt>border</dt><dd>A hash containing the following values:\n <dl>\n <dt>color</dt><dd>Color of the border. The default value is determined by the order of the series on the graph. The color\n will be retrieved from the below array: \n `[\"#205096\", \"#b38206\", \"#000000\", \"#94001e\", \"#9d6fa0\", \"#e55b00\", \"#5e85c9\", \"#adab9e\", \"#6ac291\", \"#006457\"]`\n <dt>alpha</dt><dd>Number from 0 to 1 indicating the opacity of the marker border. The default value is 1.</dd>\n <dt>weight</dt><dd>Number indicating the width of the border. The default value is 1.</dd>\n </dl>\n </dd>\n <dt>width</dt><dd>indicates the width of the marker. The default value is 24.</dd>\n <dt>over</dt><dd>hash containing styles for markers when highlighted by a `mouseover` event. The default \n values for each style is null. When an over style is not set, the non-over value will be used. For example,\n the default value for `marker.over.fill.color` is equivalent to `marker.fill.color`.</dd>\n </dl>",

41691

"itemtype": "attribute",

41692

"name": "styles",

41693

"type": "Object",

41694

"class": "StackedColumnSeries",

41695

"module": "charts"

41696

},

41697

{

41698

"file": "charts/js/StackedComboSeries.js",

41699

"line": 14,

41700

"access": "protected",

41701

"tagname": "Calculates the coordinates for the series. Overrides base implementation.",

41702

"itemtype": "method",

41703

"name": "setAreaData",

41704

"class": "StackedComboSeries",

41705

"module": "charts"

41706

},

41707

{

41708

"file": "charts/js/StackedComboSeries.js",

41709

"line": 27,

41710

"access": "protected",

41711

"tagname": "Draws the series.",

41712

"itemtype": "method",

41713

"name": "drawSeries",

41714

"class": "StackedComboSeries",

41715

"module": "charts"

41716

},

41717

{

41718

"file": "charts/js/StackedComboSeries.js",

41719

"line": 52,

41720

"description": "Read-only attribute indicating the type of series.",

41721

"itemtype": "attribute",

41722

"name": "type",

41723

"type": "String",

41724

"default": "stackedCombo",

41725

"class": "StackedComboSeries",

41726

"module": "charts"

41727

},

41728

{

41729

"file": "charts/js/StackedComboSeries.js",

41730

"line": 63,

41731

"description": "Indicates whether a fill is displayed.",

41732

"itemtype": "attribute",

41733

"name": "showAreaFill",

41734

"type": "Boolean",

41735

"default": "true",

41736

"class": "StackedComboSeries",

41737

"module": "charts"

41738

},

41739

{

41740

"file": "charts/js/StackedComboSplineSeries.js",

41741

"line": 14,

41742

"access": "protected",

41743

"tagname": "Draws the series.",

41744

"itemtype": "method",

41745

"name": "drawSeries",

41746

"class": "StackedComboSplineSeries",

41747

"module": "charts"

41748

},

41749

{

41750

"file": "charts/js/StackedComboSplineSeries.js",

41751

"line": 38,

41752

"description": "Read-only attribute indicating the type of series.",

41753

"itemtype": "attribute",

41754

"name": "type",

41755

"type": "String",

41756

"default": "stackedComboSpline",

41757

"class": "StackedComboSplineSeries",

41758

"module": "charts"

41759

},

41760

{

41761

"file": "charts/js/StackedComboSplineSeries.js",

41762

"line": 49,

41763

"description": "Indicates whether a fill is displayed.",

41764

"itemtype": "attribute",

41765

"name": "showAreaFill",

41766

"type": "Boolean",

41767

"default": "true",

41768

"class": "StackedComboSplineSeries",

41769

"module": "charts"

41770

},

41771

{

41772

"file": "charts/js/StackedLineSeries.js",

41773

"line": 12,

41774

"access": "protected",

41775

"tagname": "Calculates the coordinates for the series. Overrides base implementation.",

41776

"itemtype": "method",

41777

"name": "setAreaData",

41778

"class": "StackedLineSeries",

41779

"module": "charts"

41780

},

41781

{

41782

"file": "charts/js/StackedLineSeries.js",

41783

"line": 26,

41784

"description": "Read-only attribute indicating the type of series.",

41785

"itemtype": "attribute",

41786

"name": "type",

41787

"type": "String",

41788

"default": "stackedLine",

41789

"class": "StackedLineSeries",

41790

"module": "charts"

41791

},

41792

{

41793

"file": "charts/js/StackedMarkerSeries.js",

41794

"line": 12,

41795

"access": "protected",

41796

"tagname": "Calculates the coordinates for the series. Overrides base implementation.",

41797

"itemtype": "method",

41798

"name": "setAreaData",

41799

"class": "StackedMarkerSeries",

41800

"module": "charts"

41801

},

41802

{

41803

"file": "charts/js/StackedMarkerSeries.js",

41804

"line": 26,

41805

"description": "Read-only attribute indicating the type of series.",

41806

"itemtype": "attribute",

41807

"name": "type",

41808

"type": "String",

41809

"default": "stackedMarker",

41810

"class": "StackedMarkerSeries",

41811

"module": "charts"

41812

},

41813

{

41814

"file": "charts/js/StackedSplineSeries.js",

41815

"line": 12,

41816

"access": "protected",

41817

"tagname": "Calculates the coordinates for the series. Overrides base implementation.",

41818

"itemtype": "method",

41819

"name": "setAreaData",

41820

"class": "StackedSplineSeries",

41821

"module": "charts"

41822

},

41823

{

41824

"file": "charts/js/StackedSplineSeries.js",

41825

"line": 26,

41826

"description": "Read-only attribute indicating the type of series.",

41827

"itemtype": "attribute",

41828

"name": "type",

41829

"type": "String",

41830

"default": "stackedSpline",

41831

"class": "StackedSplineSeries",

41832

"module": "charts"

41833

},

41834

{

41835

"file": "charts/js/StackingUtil.js",

41836

"line": 11,

41837

"access": "protected",

41838

"tagname": "Adjusts coordinate values for stacked series.",

41839

"itemtype": "method",

41840

"name": "_stackCoordinates",

41841

"class": "StackingUtil",

41842

"module": "charts"

41843

},

41844

{

41845

"file": "charts/js/TimeAxis.js",

41846

"line": 19,

41847

"description": "Indicates whether the maximum is calculated or explicitly set.",

41848

"itemtype": "attribute",

41849

"name": "setMax",

41850

"readonly": "",

41851

"type": "Boolean",

41852

"access": "private",

41853

"tagname": "",

41854

"class": "TimeAxis",

41855

"module": "charts"

41856

},

41857

{

41858

"file": "charts/js/TimeAxis.js",

41859

"line": 37,

41860

"description": "Indicates whether the minimum is calculated or explicitly set.",

41861

"itemtype": "attribute",

41862

"name": "setMin",

41863

"readonly": "",

41864

"type": "Boolean",

41865

"access": "private",

41866

"tagname": "",

41867

"class": "TimeAxis",

41868

"module": "charts"

41869

},

41870

{

41871

"file": "charts/js/TimeAxis.js",

41872

"line": 55,

41873

"description": "The maximum value that will appear on an axis. Unless explicitly set, this value is calculated by the `Axis`.",

41874

"itemtype": "attribute",

41875

"name": "maximum",

41876

"type": "Number",

41877

"class": "TimeAxis",

41878

"module": "charts"

41879

},

41880

{

41881

"file": "charts/js/TimeAxis.js",

41882

"line": 78,

41883

"description": "The minimum value that will appear on an axis. Unless explicitly set, this value is calculated by the `Axis`.",

41884

"itemtype": "attribute",

41885

"name": "minimum",

41886

"type": "Number",

41887

"class": "TimeAxis",

41888

"module": "charts"

41889

},

41890

{

41891

"file": "charts/js/TimeAxis.js",

41892

"line": 101,

41893

"description": "Method used for formatting a label. This attribute allows for the default label formatting method to overridden. The method use would need\nto implement the arguments below and return a `String` or an `HTMLElement`. The default implementation of the method returns a `String`. The output of this method\nwill be rendered to the DOM using `appendChild`. If you override the `labelFunction` method and return an html string, you will also need to override the Axis' \n`appendLabelFunction` to accept html as a `String`.\n<dl>\n <dt>val</dt><dd>Label to be formatted. (`String`)</dd>\n <dt>format</dt><dd>STRFTime string used to format the label. (optional)</dd>\n</dl>",

41894

"itemtype": "attribute",

41895

"name": "labelFunction",

41896

"type": "Function",

41897

"class": "TimeAxis",

41898

"module": "charts"

41899

},

41900

{

41901

"file": "charts/js/TimeAxis.js",

41902

"line": 126,

41903

"description": "Pattern used by the `labelFunction` to format a label.",

41904

"itemtype": "attribute",

41905

"name": "labelFormat",

41906

"type": "String",

41907

"class": "TimeAxis",

41908

"module": "charts"

41909

},

41910

{

41911

"file": "charts/js/TimeAxis.js",

41912

"line": 138,

41913

"description": "Formats a label based on the axis type and optionally specified format.",

41914

"itemtype": "method",

41915

"name": "formatLabel",

41916

"params": [

41917

{

41918

"name": "value",

41919

"description": "",

41920

"type": "Object"

41921

},

41922

{

41923

"name": "format",

41924

"description": "Pattern used to format the value.",

41925

"type": "Object"

41926

}

41927

],

41928

"return": {

41929

"description": "String"

41930

},

41931

"class": "TimeAxis",

41932

"module": "charts"

41933

},

41934

{

41935

"file": "charts/js/TimeAxis.js",

41936

"line": 156,

41937

"description": "Constant used to generate unique id.",

41938

"itemtype": "property",

41939

"name": "GUID",

41940

"type": "String",

41941

"access": "private",

41942

"tagname": "",

41943

"class": "TimeAxis",

41944

"module": "charts"

41945

},

41946

{

41947

"file": "charts/js/TimeAxis.js",

41948

"line": 165,

41949

"description": "Type of data used in `Axis`.",

41950

"itemtype": "property",

41951

"name": "_dataType",

41952

"readonly": "",

41953

"access": "private",

41954

"tagname": "",

41955

"class": "TimeAxis",

41956

"module": "charts"

41957

},

41958

{

41959

"file": "charts/js/TimeAxis.js",

41960

"line": 174,

41961

"description": "Calculates and returns a value based on the number of labels and the index of\nthe current label.",

41962

"itemtype": "method",

41963

"name": "getLabelByIndex",

41964

"params": [

41965

{

41966

"name": "i",

41967

"description": "Index of the label.",

41968

"type": "Number"

41969

},

41970

{

41971

"name": "l",

41972

"description": "Total number of labels.",

41973

"type": "Number"

41974

}

41975

],

41976

"return": {

41977

"description": "String"

41978

},

41979

"class": "TimeAxis",

41980

"module": "charts"

41981

},

41982

{

41983

"file": "charts/js/TimeAxis.js",

41984

"line": 203,

41985

"description": "Gets an array of values based on a key.",

41986

"itemtype": "method",

41987

"name": "_getKeyArray",

41988

"params": [

41989

{

41990

"name": "key",

41991

"description": "Value key associated with the data array.",

41992

"type": "String"

41993

},

41994

{

41995

"name": "data",

41996

"description": "Array in which the data resides.",

41997

"type": "Array"

41998

}

41999

],

42000

"return": {

42001

"description": "Array"

42002

},

42003

"access": "private",

42004

"tagname": "",

42005

"class": "TimeAxis",

42006

"module": "charts"

42007

},

42008

{

42009

"file": "charts/js/TimeAxis.js",

42010

"line": 258,

42011

"description": "Sets data by key",

42012

"itemtype": "method",

42013

"name": "_setDataByKey",

42014

"params": [

42015

{

42016

"name": "key",

42017

"description": "Key value to use.",

42018

"type": "String"

42019

},

42020

{

42021

"name": "data",

42022

"description": "Array to use.",

42023

"type": "Array"

42024

}

42025

],

42026

"access": "private",

42027

"tagname": "",

42028

"class": "TimeAxis",

42029

"module": "charts"

42030

},

42031

{

42032

"file": "charts/js/TimeAxis.js",

42033

"line": 314,

42034

"description": "Parses value into a number.",

42035

"itemtype": "method",

42036

"name": "_getNumber",

42037

"params": [

42038

{

42039

"name": "val",

42040

"description": "Value to parse into a number",

42041

"type": "Object"

42042

}

42043

],

42044

"return": {

42045

"description": "Number"

42046

},

42047

"access": "private",

42048

"tagname": "",

42049

"class": "TimeAxis",

42050

"module": "charts"

42051

},

42052

{

42053

"file": "charts/js/TopAxisLayout.js",

42054

"line": 11,

42055

"description": "Default margins for text fields.",

42056

"access": "private",

42057

"tagname": "",

42058

"itemtype": "method",

42059

"name": "_getDefaultMargins",

42060

"return": {

42061

"description": "Object"

42062

},

42063

"class": "TopAxisLayout",

42064

"module": "charts"

42065

},

42066

{

42067

"file": "charts/js/TopAxisLayout.js",

42068

"line": 28,

42069

"description": "Sets the length of the tick on either side of the axis line.",

42070

"itemtype": "method",

42071

"name": "setTickOffsets",

42072

"access": "protected",

42073

"tagname": "",

42074

"class": "TopAxisLayout",

42075

"module": "charts"

42076

},

42077

{

42078

"file": "charts/js/TopAxisLayout.js",

42079

"line": 64,

42080

"description": "Calculates the coordinates for the first point on an axis.",

42081

"itemtype": "method",

42082

"name": "getLineStart",

42083

"access": "protected",

42084

"tagname": "",

42085

"class": "TopAxisLayout",

42086

"module": "charts"

42087

},

42088

{

42089

"file": "charts/js/TopAxisLayout.js",

42090

"line": 90,

42091

"description": "Draws a tick",

42092

"itemtype": "method",

42093

"name": "drawTick",

42094

"params": [

42095

{

42096

"name": "path",

42097

"description": "reference to the path `Path` element in which to draw the tick.",

42098

"type": "Path"

42099

},

42100

{

42101

"name": "pt",

42102

"description": "hash containing x and y coordinates",

42103

"type": "Object"

42104

},

42105

{

42106

"name": "tickStyles",

42107

"description": "hash of properties used to draw the tick",

42108

"type": "Object"

42109

}

42110

],

42111

"access": "protected",

42112

"tagname": "",

42113

"class": "TopAxisLayout",

42114

"module": "charts"

42115

},

42116

{

42117

"file": "charts/js/TopAxisLayout.js",

42118

"line": 110,

42119

"description": "Calculates the point for a label.",

42120

"itemtype": "method",

42121

"name": "getLabelPoint",

42122

"params": [

42123

{

42124

"name": "pt",

42125

"description": "hash containing x and y coordinates",

42126

"type": "Object"

42127

}

42128

],

42129

"return": {

42130

"description": "Object"

42131

},

42132

"access": "protected",

42133

"tagname": "",

42134

"class": "TopAxisLayout",

42135

"module": "charts"

42136

},

42137

{

42138

"file": "charts/js/TopAxisLayout.js",

42139

"line": 123,

42140

"description": "Updates the value for the `maxLabelSize` for use in calculating total size.",

42141

"itemtype": "method",

42142

"name": "updateMaxLabelSize",

42143

"params": [

42144

{

42145

"name": "label",

42146

"description": "to measure",

42147

"type": "HTMLElement"

42148

}

42149

],

42150

"access": "protected",

42151

"tagname": "",

42152

"class": "TopAxisLayout",

42153

"module": "charts"

42154

},

42155

{

42156

"file": "charts/js/TopAxisLayout.js",

42157

"line": 154,

42158

"description": "Determines the available label height when the axis width has been explicitly set.",

42159

"itemtype": "method",

42160

"name": "getExplicitlySized",

42161

"return": {

42162

"description": "Boolean"

42163

},

42164

"access": "protected",

42165

"tagname": "",

42166

"class": "TopAxisLayout",

42167

"module": "charts"

42168

},

42169

{

42170

"file": "charts/js/TopAxisLayout.js",

42171

"line": 176,

42172

"description": "Rotate and position title.",

42173

"itemtype": "method",

42174

"name": "positionTitle",

42175

"params": [

42176

{

42177

"name": "label",

42178

"description": "to rotate position",

42179

"type": "HTMLElement"

42180

}

42181

],

42182

"access": "protected",

42183

"tagname": "",

42184

"class": "TopAxisLayout",

42185

"module": "charts"

42186

},

42187

{

42188

"file": "charts/js/TopAxisLayout.js",

42189

"line": 206,

42190

"description": "Rotate and position labels.",

42191

"itemtype": "method",

42192

"name": "positionLabel",

42193

"params": [

42194

{

42195

"name": "label",

42196

"description": "to rotate position",

42197

"type": "HTMLElement"

42198

},

42199

{

42200

"name": "pt",

42201

"description": "hash containing the x and y coordinates in which the label will be positioned\nagainst.",

42202

"type": "Object"

42203

}

42204

],

42205

"access": "protected",

42206

"tagname": "",

42207

"class": "TopAxisLayout",

42208

"module": "charts"

42209

},

42210

{

42211

"file": "charts/js/TopAxisLayout.js",

42212

"line": 260,

42213

"description": "Adjusts the coordinates of an axis label based on the rotation.",

42214

"itemtype": "method",

42215

"name": "_setRotationCoords",

42216

"params": [

42217

{

42218

"name": "props",

42219

"description": "Coordinates, dimension and rotation properties of the label.",

42220

"type": "Object"

42221

}

42222

],

42223

"access": "protected",

42224

"tagname": "",

42225

"class": "TopAxisLayout",

42226

"module": "charts"

42227

},

42228

{

42229

"file": "charts/js/TopAxisLayout.js",

42230

"line": 305,

42231

"description": "Returns the transformOrigin to use for an axis label based on the position of the axis \nand the rotation of the label.",

42232

"itemtype": "method",

42233

"name": "_getTransformOrigin",

42234

"params": [

42235

{

42236

"name": "rot",

42237

"description": "The rotation (in degrees) of the label.",

42238

"type": "Number"

42239

}

42240

],

42241

"return": {

42242

"description": "Array"

42243

},

42244

"access": "protected",

42245

"tagname": "",

42246

"class": "TopAxisLayout",

42247

"module": "charts"

42248

},

42249

{

42250

"file": "charts/js/TopAxisLayout.js",

42251

"line": 343,

42252

"description": "Adjusts position for inner ticks.",

42253

"itemtype": "method",

42254

"name": "offsetNodeForTick",

42255

"params": [

42256

{

42257

"name": "cb",

42258

"description": "contentBox of the axis",

42259

"type": "Node"

42260

}

42261

],

42262

"access": "protected",

42263

"tagname": "",

42264

"class": "TopAxisLayout",

42265

"module": "charts"

42266

},

42267

{

42268

"file": "charts/js/TopAxisLayout.js",

42269

"line": 354,

42270

"description": "Assigns a height based on the size of the contents.",

42271

"itemtype": "method",

42272

"name": "setCalculatedSize",

42273

"access": "protected",

42274

"tagname": "",

42275

"class": "TopAxisLayout",

42276

"module": "charts"

42277

},

42278

{

42279

"file": "classnamemanager/js/classnamemanager.js",

42280

"line": 26,

42281

"description": "Configuration property indicating the prefix for all CSS class names in this YUI instance.",

42282

"itemtype": "property",

42283

"name": "classNamePrefix",

42284

"type": "{String}",

42285

"default": "\"yui\"",

42286

"static": 1,

42287

"class": "ClassNameManager",

42288

"module": "classnamemanager"

42289

},

42290

{

42291

"file": "classnamemanager/js/classnamemanager.js",

42292

"line": 36,

42293

"description": "Configuration property indicating the delimiter used to compose all CSS class names in\nthis YUI instance.",

42294

"itemtype": "property",

42295

"name": "classNameDelimiter",

42296

"type": "{String}",

42297

"default": "\"-\"",

42298

"static": 1,

42299

"class": "ClassNameManager",

42300

"module": "classnamemanager"

42301

},

42302

{

42303

"file": "classnamemanager/js/classnamemanager.js",

42304

"line": 54,

42305

"description": "Returns a class name prefixed with the the value of the \n<code>Y.config.classNamePrefix</code> attribute + the provided strings.\nUses the <code>Y.config.classNameDelimiter</code> attribute to delimit the \nprovided strings. E.g. Y.ClassNameManager.getClassName('foo','bar'); // yui-foo-bar",

42306

"itemtype": "method",

42307

"name": "getClassName",

42308

"params": [

42309

{

42310

"name": "+",

42311

"description": "classnameSection one or more classname sections to be joined",

42312

"type": "String"

42313

},

42314

{

42315

"name": "skipPrefix",

42316

"description": "If set to true, the classname will not be prefixed with the default Y.config.classNameDelimiter value.",

42317

"type": "Boolean"

42318

}

42319

],

42320

"class": "ClassNameManager",

42321

"module": "classnamemanager"

42322

},

42323

{

42324

"file": "collection/js/array-extras.js",

42325

"line": 12,

42326

"description": "Returns the index of the last item in the array that contains the specified\nvalue, or `-1` if the value isn't found.",

42327

"itemtype": "method",

42328

"name": "lastIndexOf",

42329

"params": [

42330

{

42331

"name": "a",

42332

"description": "Array to search in.",

42333

"type": "Array"

42334

},

42335

{

42336

"name": "val",

42337

"description": "Value to search for.",

42338

"type": "Any"

42339

},

42340

{

42341

"name": "fromIndex",

42342

"description": "Index at which to start searching backwards.\n Defaults to the array's length - 1. If negative, it will be taken as an offset\n from the end of the array. If the calculated index is less than 0, the array\n will not be searched and `-1` will be returned.",

42343

"type": "Number",

42344

"optional": true

42345

}

42346

],

42347

"return": {

42348

"description": "Index of the item that contains the value, or `-1` if not\n found.",

42349

"type": "Number"

42350

},

42351

"static": 1,

42352

"class": "Array",

42353

"module": "collection",

42354

"submodule": "array-extras"

42355

},

42356

{

42357

"file": "collection/js/array-extras.js",

42358

"line": 55,

42359

"description": "Returns a copy of the specified array with duplicate items removed.",

42360

"itemtype": "method",

42361

"name": "unique",

42362

"params": [

42363

{

42364

"name": "a",

42365

"description": "Array to dedupe.",

42366

"type": "Array"

42367

}

42368

],

42369

"return": {

42370

"description": "Copy of the array with duplicate items removed.",

42371

"type": "Array"

42372

},

42373

"static": 1,

42374

"class": "Array",

42375

"module": "collection",

42376

"submodule": "array-extras"

42377

},

42378

{

42379

"file": "collection/js/array-extras.js",

42380

"line": 107,

42381

"description": "Executes the supplied function on each item in the array. Returns a new array\ncontaining the items for which the supplied function returned a truthy value.",

42382

"itemtype": "method",

42383

"name": "filter",

42384

"params": [

42385

{

42386

"name": "a",

42387

"description": "Array to filter.",

42388

"type": "Array"

42389

},

42390

{

42391

"name": "f",

42392

"description": "Function to execute on each item.",

42393

"type": "Function"

42394

},

42395

{

42396

"name": "o",

42397

"description": "Optional context object.",

42398

"type": "Object",

42399

"optional": true

42400

}

42401

],

42402

"return": {

42403

"description": "Array of items for which the supplied function returned a\n truthy value (empty if it never returned a truthy value).",

42404

"type": "Array"

42405

},

42406

"static": 1,

42407

"class": "Array",

42408

"module": "collection",

42409

"submodule": "array-extras"

42410

},

42411

{

42412

"file": "collection/js/array-extras.js",

42413

"line": 142,

42414

"description": "The inverse of `Array.filter()`. Executes the supplied function on each item.\nReturns a new array containing the items for which the supplied function\nreturned `false`.",

42415

"itemtype": "method",

42416

"name": "reject",

42417

"params": [

42418

{

42419

"name": "a",

42420

"description": "the array to iterate.",

42421

"type": "Array"

42422

},

42423

{

42424

"name": "f",

42425

"description": "the function to execute on each item.",

42426

"type": "Function"

42427

},

42428

{

42429

"name": "o",

42430

"description": "Optional context object.",

42431

"type": "Object",

42432

"optional": true

42433

}

42434

],

42435

"return": {

42436

"description": "The items for which the supplied function returned `false`.",

42437

"type": "Array"

42438

},

42439

"static": 1,

42440

"class": "Array",

42441

"module": "collection",

42442

"submodule": "array-extras"

42443

},

42444

{

42445

"file": "collection/js/array-extras.js",

42446

"line": 160,

42447

"description": "Executes the supplied function on each item in the array. Iteration stops if the\nsupplied function does not return a truthy value.",

42448

"itemtype": "method",

42449

"name": "every",

42450

"params": [

42451

{

42452

"name": "a",

42453

"description": "the array to iterate.",

42454

"type": "Array"

42455

},

42456

{

42457

"name": "f",

42458

"description": "the function to execute on each item.",

42459

"type": "Function"

42460

},

42461

{

42462

"name": "o",

42463

"description": "Optional context object.",

42464

"type": "Object",

42465

"optional": true

42466

}

42467

],

42468

"return": {

42469

"description": "`true` if every item in the array returns `true` from the\n supplied function, `false` otherwise.",

42470

"type": "Boolean"

42471

},

42472

"static": 1,

42473

"class": "Array",

42474

"module": "collection",

42475

"submodule": "array-extras"

42476

},

42477

{

42478

"file": "collection/js/array-extras.js",

42479

"line": 186,

42480

"description": "Executes the supplied function on each item in the array and returns a new array\ncontaining all the values returned by the supplied function.",

42481

"example": [

42482

"\n\n // Convert an array of numbers into an array of strings.\n Y.Array.map([1, 2, 3, 4], function (item) {\n return '' + item;\n });\n // => ['1', '2', '3', '4']"

42483

],

42484

"itemtype": "method",

42485

"name": "map",

42486

"params": [

42487

{

42488

"name": "a",

42489

"description": "the array to iterate.",

42490

"type": "Array"

42491

},

42492

{

42493

"name": "f",

42494

"description": "the function to execute on each item.",

42495

"type": "Function"

42496

},

42497

{

42498

"name": "o",

42499

"description": "Optional context object.",

42500

"type": "Object",

42501

"optional": true

42502

}

42503

],

42504

"return": {

42505

"description": "A new array containing the return value of the supplied function\n for each item in the original array.",

42506

"type": "Array"

42507

},

42508

"static": 1,

42509

"class": "Array",

42510

"module": "collection",

42511

"submodule": "array-extras"

42512

},

42513

{

42514

"file": "collection/js/array-extras.js",

42515

"line": 225,

42516

"description": "Executes the supplied function on each item in the array, \"folding\" the array\ninto a single value.",

42517

"itemtype": "method",

42518

"name": "reduce",

42519

"params": [

42520

{

42521

"name": "a",

42522

"description": "Array to iterate.",

42523

"type": "Array"

42524

},

42525

{

42526

"name": "init",

42527

"description": "Initial value to start with.",

42528

"type": "Any"

42529

},

42530

{

42531

"name": "f",

42532

"description": "Function to execute on each item. This function should\n update and return the value of the computation. It will receive the following\n arguments:",

42533

"type": "Function",

42534

"props": [

42535

{

42536

"name": "previousValue",

42537

"description": "Value returned from the previous iteration,\n or the initial value if this is the first iteration.",

42538

"type": "Any"

42539

},

42540

{

42541

"name": "currentValue",

42542

"description": "Value of the current item being iterated.",

42543

"type": "Any"

42544

},

42545

{

42546

"name": "index",

42547

"description": "Index of the current item.",

42548

"type": "Number"

42549

},

42550

{

42551

"name": "array",

42552

"description": "Array being iterated.",

42553

"type": "Array"

42554

}

42555

]

42556

},

42557

{

42558

"name": "o",

42559

"description": "Optional context object.",

42560

"type": "Object",

42561

"optional": true

42562

}

42563

],

42564

"return": {

42565

"description": "Final result from iteratively applying the given function to each\n element in the array.",

42566

"type": "Any"

42567

},

42568

"static": 1,

42569

"class": "Array",

42570

"module": "collection",

42571

"submodule": "array-extras"

42572

},

42573

{

42574

"file": "collection/js/array-extras.js",

42575

"line": 267,

42576

"description": "Executes the supplied function on each item in the array, searching for the\nfirst item that matches the supplied function.",

42577

"itemtype": "method",

42578

"name": "find",

42579

"params": [

42580

{

42581

"name": "a",

42582

"description": "the array to search.",

42583

"type": "Array"

42584

},

42585

{

42586

"name": "f",

42587

"description": "the function to execute on each item. Iteration is stopped\n as soon as this function returns `true`.",

42588

"type": "Function"

42589

},

42590

{

42591

"name": "o",

42592

"description": "Optional context object.",

42593

"type": "Object",

42594

"optional": true

42595

}

42596

],

42597

"return": {

42598

"description": "the first item that the supplied function returns `true` for,\n or `null` if it never returns `true`.",

42599

"type": "Object"

42600

},

42601

"static": 1,

42602

"class": "Array",

42603

"module": "collection",

42604

"submodule": "array-extras"

42605

},

42606

{

42607

"file": "collection/js/array-extras.js",

42608

"line": 289,

42609

"description": "Iterates over an array, returning a new array of all the elements that match the\nsupplied regular expression.",

42610

"itemtype": "method",

42611

"name": "grep",

42612

"params": [

42613

{

42614

"name": "a",

42615

"description": "Array to iterate over.",

42616

"type": "Array"

42617

},

42618

{

42619

"name": "pattern",

42620

"description": "Regular expression to test against each item.",

42621

"type": "RegExp"

42622

}

42623

],

42624

"return": {

42625

"description": "All the items in the array that produce a match against the\n supplied regular expression. If no items match, an empty array is returned.",

42626

"type": "Array"

42627

},

42628

"static": 1,

42629

"class": "Array",

42630

"module": "collection",

42631

"submodule": "array-extras"

42632

},

42633

{

42634

"file": "collection/js/array-extras.js",

42635

"line": 306,

42636

"description": "Partitions an array into two new arrays, one with the items for which the\nsupplied function returns `true`, and one with the items for which the function\nreturns `false`.",

42637

"itemtype": "method",

42638

"name": "partition",

42639

"params": [

42640

{

42641

"name": "a",

42642

"description": "Array to iterate over.",

42643

"type": "Array"

42644

},

42645

{

42646

"name": "f",

42647

"description": "Function to execute for each item in the array. It will\n receive the following arguments:",

42648

"type": "Function",

42649

"props": [

42650

{

42651

"name": "item",

42652

"description": "Current item.",

42653

"type": "Any"

42654

},

42655

{

42656

"name": "index",

42657

"description": "Index of the current item.",

42658

"type": "Number"

42659

},

42660

{

42661

"name": "array",

42662

"description": "The array being iterated.",

42663

"type": "Array"

42664

}

42665

]

42666

},

42667

{

42668

"name": "o",

42669

"description": "Optional execution context.",

42670

"type": "Object",

42671

"optional": true

42672

}

42673

],

42674

"return": {

42675

"description": "An object with two properties: `matches` and `rejects`. Each is\n an array containing the items that were selected or rejected by the test\n function (or an empty array if none).",

42676

"type": "Object"

42677

},

42678

"static": 1,

42679

"class": "Array",

42680

"module": "collection",

42681

"submodule": "array-extras"

42682

},

42683

{

42684

"file": "collection/js/array-extras.js",

42685

"line": 338,

42686

"description": "Creates an array of arrays by pairing the corresponding elements of two arrays\ntogether into a new array.",

42687

"itemtype": "method",

42688

"name": "zip",

42689

"params": [

42690

{

42691

"name": "a",

42692

"description": "Array to iterate over.",

42693

"type": "Array"

42694

},

42695

{

42696

"name": "a2",

42697

"description": "Another array whose values will be paired with values of the\n first array.",

42698

"type": "Array"

42699

}

42700

],

42701

"return": {

42702

"description": "An array of arrays formed by pairing each element of the first\n array with an item in the second array having the corresponding index.",

42703

"type": "Array"

42704

},

42705

"static": 1,

42706

"class": "Array",

42707

"module": "collection",

42708

"submodule": "array-extras"

42709

},

42710

{

42711

"file": "collection/js/arraylist-add.js",

42712

"line": 13,

42713

"description": "Add a single item to the ArrayList. Does not prevent duplicates.",

42714

"itemtype": "method",

42715

"name": "add",

42716

"params": [

42717

{

42718

"name": "item",

42719

"description": "Item presumably of the same type as others in the\n ArrayList.",

42720

"type": "Mixed"

42721

},

42722

{

42723

"name": "index",

42724

"description": "(Optional.) Number representing the position at\nwhich the item should be inserted.",

42725

"type": "Number"

42726

}

42727

],

42728

"return": {

42729

"description": "the instance.",

42730

"type": "ArrayList"

42731

},

42732

"deprecated": true,

42733

"deprecationMessage": "Use ModelList or a custom ArrayList subclass",

42734

"chainable": 1,

42735

"class": "ArrayList",

42736

"module": "collection",

42737

"submodule": "arraylist-add"

42738

},

42739

{

42740

"file": "collection/js/arraylist-add.js",

42741

"line": 39,

42742

"description": "Removes first or all occurrences of an item to the ArrayList. If a\ncomparator is not provided, uses itemsAreEqual method to determine\nmatches.",

42743

"itemtype": "method",

42744

"name": "remove",

42745

"params": [

42746

{

42747

"name": "needle",

42748

"description": "Item to find and remove from the list.",

42749

"type": "Mixed"

42750

},

42751

{

42752

"name": "all",

42753

"description": "If true, remove all occurrences.",

42754

"type": "Boolean"

42755

},

42756

{

42757

"name": "comparator",

42758

"description": "optional a/b function to test equivalence.",

42759

"type": "Function"

42760

}

42761

],

42762

"return": {

42763

"description": "the instance.",

42764

"type": "ArrayList"

42765

},

42766

"deprecated": true,

42767

"deprecationMessage": "Use ModelList or a custom ArrayList subclass",

42768

"chainable": 1,

42769

"class": "ArrayList",

42770

"module": "collection",

42771

"submodule": "arraylist-add"

42772

},

42773

{

42774

"file": "collection/js/arraylist-add.js",

42775

"line": 68,

42776

"description": "Default comparator for items stored in this list. Used by remove().",

42777

"itemtype": "method",

42778

"name": "itemsAreEqual",

42779

"params": [

42780

{

42781

"name": "a",

42782

"description": "item to test equivalence with.",

42783

"type": "Mixed"

42784

},

42785

{

42786

"name": "b",

42787

"description": "other item to test equivalance.",

42788

"type": "Mixed"

42789

}

42790

],

42791

"return": {

42792

"description": "true if items are deemed equivalent.",

42793

"type": "Boolean"

42794

},

42795

"deprecated": true,

42796

"deprecationMessage": "Use ModelList or a custom ArrayList subclass",

42797

"class": "ArrayList",

42798

"module": "collection",

42799

"submodule": "arraylist-add"

42800

},

42801

{

42802

"file": "collection/js/arraylist-filter.js",

42803

"line": 13,

42804

"description": "Create a new ArrayList (or augmenting class instance) from a subset\nof items as determined by the boolean function passed as the\nargument. The original ArrayList is unchanged.\n\nThe validator signature is <code>validator( item )</code>.",

42805

"itemtype": "method",

42806

"name": "filter",

42807

"params": [

42808

{

42809

"name": "validator",

42810

"description": "Boolean function to determine in or out.",

42811

"type": "Function"

42812

}

42813

],

42814

"return": {

42815

"description": "New instance based on who passed the validator.",

42816

"type": "ArrayList"

42817

},

42818

"deprecated": true,

42819

"deprecationMessage": "Use ModelList or a custom subclass implementation",

42820

"class": "ArrayList",

42821

"module": "collection",

42822

"submodule": "arraylist-filter"

42823

},

42824

{

42825

"file": "collection/js/arraylist.js",

42826

"line": 37,

42827

"description": "Get an item by index from the list. Override this method if managing a\nlist of objects that have a different public representation (e.g. Node\ninstances vs DOM nodes). The iteration methods that accept a user\nfunction will use this method for access list items for operation.",

42828

"itemtype": "method",

42829

"name": "item",

42830

"params": [

42831

{

42832

"name": "i",

42833

"description": "index to fetch",

42834

"type": "Integer"

42835

}

42836

],

42837

"return": {

42838

"description": "the item at the requested index",

42839

"type": "Mixed"

42840

},

42841

"class": "ArrayList",

42842

"module": "collection",

42843

"submodule": "arraylist"

42844

},

42845

{

42846

"file": "collection/js/arraylist.js",

42847

"line": 51,

42848

"description": "Execute a function on each item of the list, optionally providing a\ncustom execution context. Default context is the item.\n\nThe callback signature is <code>callback( item, index )</code>.",

42849

"itemtype": "method",

42850

"name": "each",

42851

"params": [

42852

{

42853

"name": "fn",

42854

"description": "the function to execute",

42855

"type": "Function"

42856

},

42857

{

42858

"name": "context",

42859

"description": "optional override 'this' in the function",

42860

"type": "Mixed"

42861

}

42862

],

42863

"return": {

42864

"description": "this instance",

42865

"type": "ArrayList"

42866

},

42867

"chainable": 1,

42868

"class": "ArrayList",

42869

"module": "collection",

42870

"submodule": "arraylist"

42871

},

42872

{

42873

"file": "collection/js/arraylist.js",

42874

"line": 73,

42875

"description": "Execute a function on each item of the list, optionally providing a\ncustom execution context. Default context is the item.\n\nThe callback signature is <code>callback( item, index )</code>.\n\nUnlike <code>each</code>, if the callback returns true, the\niteratation will stop.",

42876

"itemtype": "method",

42877

"name": "some",

42878

"params": [

42879

{

42880

"name": "fn",

42881

"description": "the function to execute",

42882

"type": "Function"

42883

},

42884

{

42885

"name": "context",

42886

"description": "optional override 'this' in the function",

42887

"type": "Mixed"

42888

}

42889

],

42890

"return": {

42891

"description": "True if the function returned true on an item",

42892

"type": "Boolean"

42893

},

42894

"class": "ArrayList",

42895

"module": "collection",

42896

"submodule": "arraylist"

42897

},

42898

{

42899

"file": "collection/js/arraylist.js",

42900

"line": 95,

42901

"description": "Finds the first index of the needle in the managed array of items.",

42902

"itemtype": "method",

42903

"name": "indexOf",

42904

"params": [

42905

{

42906

"name": "needle",

42907

"description": "The item to search for",

42908

"type": "Mixed"

42909

}

42910

],

42911

"return": {

42912

"description": "Array index if found. Otherwise -1",

42913

"type": "Integer"

42914

},

42915

"class": "ArrayList",

42916

"module": "collection",

42917

"submodule": "arraylist"

42918

},

42919

{

42920

"file": "collection/js/arraylist.js",

42921

"line": 106,

42922

"description": "How many items are in this list?",

42923

"itemtype": "method",

42924

"name": "size",

42925

"return": {

42926

"description": "Number of items in the list",

42927

"type": "Integer"

42928

},

42929

"class": "ArrayList",

42930

"module": "collection",

42931

"submodule": "arraylist"

42932

},

42933

{

42934

"file": "collection/js/arraylist.js",

42935

"line": 116,

42936

"description": "Is this instance managing any items?",

42937

"itemtype": "method",

42938

"name": "isEmpty",

42939

"return": {

42940

"description": "true if 1 or more items are being managed",

42941

"type": "Boolean"

42942

},

42943

"class": "ArrayList",

42944

"module": "collection",

42945

"submodule": "arraylist"

42946

},

42947

{

42948

"file": "collection/js/arraylist.js",

42949

"line": 126,

42950

"description": "Provides an array-like representation for JSON.stringify.",

42951

"itemtype": "method",

42952

"name": "toJSON",

42953

"return": {

42954

"description": "an array representation of the ArrayList",

42955

"type": "Array"

42956

},

42957

"class": "ArrayList",

42958

"module": "collection",

42959

"submodule": "arraylist"

42960

},

42961

{

42962

"file": "collection/js/arraylist.js",

42963

"line": 138,

42964

"description": "Protected method for optimizations that may be appropriate for API\nmirroring. Similar in functionality to <code>item</code>, but is used by\nmethods added with <code>ArrayList.addMethod()</code>.",

42965

"itemtype": "method",

42966

"name": "_item",

42967

"access": "protected",

42968

"tagname": "",

42969

"params": [

42970

{

42971

"name": "i",

42972

"description": "Index of item to fetch",

42973

"type": "Integer"

42974

}

42975

],

42976

"return": {

42977

"description": "The item appropriate for pass through API methods",

42978

"type": "Mixed"

42979

},

42980

"class": "ArrayList",

42981

"module": "collection",

42982

"submodule": "arraylist"

42983

},

42984

{

42985

"file": "collection/js/arraylist.js",

42986

"line": 156,

42987

"description": "Adds a pass through method to dest (typically the prototype of a list\nclass) that calls the named method on each item in the list with\nwhatever parameters are passed in. Allows for API indirection via list\ninstances.\n\nAccepts a single string name or an array of string names.\n\n<pre><code>list.each( function ( item ) {\n item.methodName( 1, 2, 3 );\n} );\n// becomes\nlist.methodName( 1, 2, 3 );</code></pre>\n\nAdditionally, the pass through methods use the item retrieved by the\n<code>_item</code> method in case there is any special behavior that is\nappropriate for API mirroring.\n\nIf the iterated method returns a value, the return value from the\nadded method will be an array of values with each value being at the\ncorresponding index for that item. If the iterated method does not\nreturn a value, the added method will be chainable.",

42988

"itemtype": "method",

42989

"name": "addMethod",

42990

"static": 1,

42991

"params": [

42992

{

42993

"name": "dest",

42994

"description": "Object or prototype to receive the iterator method",

42995

"type": "Object"

42996

},

42997

{

42998

"name": "name",

42999

"description": "Name of method of methods to create",

43000

"type": "String|String[]"

43001

}

43002

],

43003

"class": "ArrayList",

43004

"module": "collection",

43005

"submodule": "arraylist"

43006

},

43007

{

43008

"file": "collection/js/invoke.js",

43009

"line": 6,

43010

"description": "Executes a named method on each item in an array of objects. Items in the array\nthat do not have a function by that name will be skipped.",

43011

"example": [

43012

"\n\n Y.Array.invoke(arrayOfDrags, 'plug', Y.Plugin.DDProxy);"

43013

],

43014

"itemtype": "method",

43015

"name": "invoke",

43016

"params": [

43017

{

43018

"name": "items",

43019

"description": "Array of objects supporting the named method.",

43020

"type": "Array"

43021

},

43022

{

43023

"name": "name",

43024

"description": "the name of the method to execute on each item.",

43025

"type": "String"

43026

},

43027

{

43028

"name": "args*",

43029

"description": "Any number of additional args are passed as parameters to\n the execution of the named method.",

43030

"type": "Any",

43031

"optional": true

43032

}

43033

],

43034

"return": {

43035

"description": "All return values, indexed according to the item index.",

43036

"type": "Array"

43037

},

43038

"static": 1,

43039

"class": "Array",

43040

"module": "collection",

43041

"submodule": "array-invoke"

43042

},

43043

{

43044

"file": "console-filters/js/console-filters.js",

43045

"line": 43,

43046

"description": "Collection of all log messages passed through since the plugin's\ninstantiation. This holds all messages regardless of filter status.\nUsed as a single source of truth for repopulating the Console body when\nfilters are changed.",

43047

"itemtype": "property",

43048

"name": "_entries",

43049

"type": "Array",

43050

"access": "protected",

43051

"tagname": "",

43052

"class": "Plugin.ConsoleFilters",

43053

"module": "console-filters",

43054

"namespace": "Plugin"

43055

},

43056

{

43057

"file": "console-filters/js/console-filters.js",

43058

"line": 55,

43059

"description": "Maximum number of entries to store in the message cache.",

43060

"itemtype": "property",

43061

"name": "_cacheLimit",

43062

"type": "{Number}",

43063

"default": "Infinity",

43064

"access": "protected",

43065

"tagname": "",

43066

"class": "Plugin.ConsoleFilters",

43067

"module": "console-filters",

43068

"namespace": "Plugin"

43069

},

43070

{

43071

"file": "console-filters/js/console-filters.js",

43072

"line": 65,

43073

"description": "The container node created to house the category filters.",

43074

"itemtype": "property",

43075

"name": "_categories",

43076

"type": "Node",

43077

"access": "protected",

43078

"tagname": "",

43079

"class": "Plugin.ConsoleFilters",

43080

"module": "console-filters",

43081

"namespace": "Plugin"

43082

},

43083

{

43084

"file": "console-filters/js/console-filters.js",

43085

"line": 74,

43086

"description": "The container node created to house the source filters.",

43087

"itemtype": "property",

43088

"name": "_sources",

43089

"type": "Node",

43090

"access": "protected",

43091

"tagname": "",

43092

"class": "Plugin.ConsoleFilters",

43093

"module": "console-filters",

43094

"namespace": "Plugin"

43095

},

43096

{

43097

"file": "console-filters/js/console-filters.js",

43098

"line": 83,

43099

"description": "Initialize entries collection and attach listeners to host events and\nmethods.",

43100

"itemtype": "method",

43101

"name": "initializer",

43102

"access": "protected",

43103

"tagname": "",

43104

"class": "Plugin.ConsoleFilters",

43105

"module": "console-filters",

43106

"namespace": "Plugin"

43107

},

43108

{

43109

"file": "console-filters/js/console-filters.js",

43110

"line": 110,

43111

"description": "Removes the plugin UI and unwires events.",

43112

"itemtype": "method",

43113

"name": "destructor",

43114

"access": "protected",

43115

"tagname": "",

43116

"class": "Plugin.ConsoleFilters",

43117

"module": "console-filters",

43118

"namespace": "Plugin"

43119

},

43120

{

43121

"file": "console-filters/js/console-filters.js",

43122

"line": 129,

43123

"description": "Adds the category and source filter sections to the Console footer.",

43124

"itemtype": "method",

43125

"name": "renderUI",

43126

"access": "protected",

43127

"tagname": "",

43128

"class": "Plugin.ConsoleFilters",

43129

"module": "console-filters",

43130

"namespace": "Plugin"

43131

},

43132

{

43133

"file": "console-filters/js/console-filters.js",

43134

"line": 154,

43135

"description": "Binds to checkbox click events and internal attribute change events to\nmaintain the UI state.",

43136

"itemtype": "method",

43137

"name": "bindUI",

43138

"access": "protected",

43139

"tagname": "",

43140

"class": "Plugin.ConsoleFilters",

43141

"module": "console-filters",

43142

"namespace": "Plugin"

43143

},

43144

{

43145

"file": "console-filters/js/console-filters.js",

43146

"line": 170,

43147

"description": "Updates the UI to be in accordance with the current state of the plugin.",

43148

"itemtype": "method",

43149

"name": "syncUI",

43150

"class": "Plugin.ConsoleFilters",

43151

"module": "console-filters",

43152

"namespace": "Plugin"

43153

},

43154

{

43155

"file": "console-filters/js/console-filters.js",

43156

"line": 187,

43157

"description": "Ensures a filter is set up for any new categories or sources and\ncollects the messages in _entries. If the message is stamped with a\ncategory or source that is currently being filtered out, the message\nwill not pass to the Console's print buffer.",

43158

"itemtype": "method",

43159

"name": "_onEntry",

43160

"params": [

43161

{

43162

"name": "e",

43163

"description": "the custom event object",

43164

"type": "Event"

43165

}

43166

],

43167

"access": "protected",

43168

"tagname": "",

43169

"class": "Plugin.ConsoleFilters",

43170

"module": "console-filters",

43171

"namespace": "Plugin"

43172

},

43173

{

43174

"file": "console-filters/js/console-filters.js",

43175

"line": 228,

43176

"description": "Flushes the cached entries after a call to the Console's clearConsole().",

43177

"itemtype": "method",

43178

"name": "_afterClearConsole",

43179

"access": "protected",

43180

"tagname": "",

43181

"class": "Plugin.ConsoleFilters",

43182

"module": "console-filters",

43183

"namespace": "Plugin"

43184

},

43185

{

43186

"file": "console-filters/js/console-filters.js",

43187

"line": 238,

43188

"description": "Triggers the Console to update if a known category filter\nchanges value (e.g. visible => hidden). Updates the appropriate\ncheckbox's checked state if necessary.",

43189

"itemtype": "method",

43190

"name": "_afterCategoryChange",

43191

"params": [

43192

{

43193

"name": "e",

43194

"description": "the attribute change event object",

43195

"type": "Event"

43196

}

43197

],

43198

"access": "protected",

43199

"tagname": "",

43200

"class": "Plugin.ConsoleFilters",

43201

"module": "console-filters",

43202

"namespace": "Plugin"

43203

},

43204

{

43205

"file": "console-filters/js/console-filters.js",

43206

"line": 264,

43207

"description": "Triggers the Console to update if a known source filter\nchanges value (e.g. visible => hidden). Updates the appropriate\ncheckbox's checked state if necessary.",

43208

"itemtype": "method",

43209

"name": "_afterSourceChange",

43210

"params": [

43211

{

43212

"name": "e",

43213

"description": "the attribute change event object",

43214

"type": "Event"

43215

}

43216

],

43217

"access": "protected",

43218

"tagname": "",

43219

"class": "Plugin.ConsoleFilters",

43220

"module": "console-filters",

43221

"namespace": "Plugin"

43222

},

43223

{

43224

"file": "console-filters/js/console-filters.js",

43225

"line": 290,

43226

"description": "Flushes the Console's print buffer of any entries that have a category\nor source that is currently being excluded.",

43227

"itemtype": "method",

43228

"name": "_filterBuffer",

43229

"access": "protected",

43230

"tagname": "",

43231

"class": "Plugin.ConsoleFilters",

43232

"module": "console-filters",

43233

"namespace": "Plugin"

43234

},

43235

{

43236

"file": "console-filters/js/console-filters.js",

43237

"line": 317,

43238

"description": "Trims the cache of entries to the appropriate new length.",

43239

"itemtype": "method",

43240

"name": "_afterCacheLimitChange",

43241

"params": [

43242

{

43243

"name": "e",

43244

"description": "the attribute change event object",

43245

"type": "Event"

43246

}

43247

],

43248

"access": "protected",

43249

"tagname": "",

43250

"class": "Plugin.ConsoleFilters",

43251

"module": "console-filters",

43252

"namespace": "Plugin"

43253

},

43254

{

43255

"file": "console-filters/js/console-filters.js",

43256

"line": 334,

43257

"description": "Repopulates the Console with entries appropriate to the current filter\nsettings.",

43258

"itemtype": "method",

43259

"name": "refreshConsole",

43260

"class": "Plugin.ConsoleFilters",

43261

"module": "console-filters",

43262

"namespace": "Plugin"

43263

},

43264

{

43265

"file": "console-filters/js/console-filters.js",

43266

"line": 368,

43267

"description": "Updates the checked property of a filter checkbox of the specified type.\nIf no checkbox is found for the input params, one is created.",

43268

"itemtype": "method",

43269

"name": "_uiSetCheckbox",

43270

"params": [

43271

{

43272

"name": "type",

43273

"description": "'category' or 'source'",

43274

"type": "String"

43275

},

43276

{

43277

"name": "item",

43278

"description": "the name of the filter (e.g. 'info', 'event')",

43279

"type": "String"

43280

},

43281

{

43282

"name": "checked",

43283

"description": "value to set the checkbox's checked property",

43284

"type": "Boolean"

43285

}

43286

],

43287

"access": "protected",

43288

"tagname": "",

43289

"class": "Plugin.ConsoleFilters",

43290

"module": "console-filters",

43291

"namespace": "Plugin"

43292

},

43293

{

43294

"file": "console-filters/js/console-filters.js",

43295

"line": 401,

43296

"description": "Passes checkbox clicks on to the category attribute.",

43297

"itemtype": "method",

43298

"name": "_onCategoryCheckboxClick",

43299

"params": [

43300

{

43301

"name": "e",

43302

"description": "the DOM event",

43303

"type": "Event"

43304

}

43305

],

43306

"access": "protected",

43307

"tagname": "",

43308

"class": "Plugin.ConsoleFilters",

43309

"module": "console-filters",

43310

"namespace": "Plugin"

43311

},

43312

{

43313

"file": "console-filters/js/console-filters.js",

43314

"line": 419,

43315

"description": "Passes checkbox clicks on to the source attribute.",

43316

"itemtype": "method",

43317

"name": "_onSourceCheckboxClick",

43318

"params": [

43319

{

43320

"name": "e",

43321

"description": "the DOM event",

43322

"type": "Event"

43323

}

43324

],

43325

"access": "protected",

43326

"tagname": "",

43327

"class": "Plugin.ConsoleFilters",

43328

"module": "console-filters",

43329

"namespace": "Plugin"

43330

},

43331

{

43332

"file": "console-filters/js/console-filters.js",

43333

"line": 437,

43334

"description": "Hides any number of categories from the UI. Convenience method for\nmyConsole.filter.set('category.foo', false); set('category.bar', false);\nand so on.",

43335

"itemtype": "method",

43336

"name": "hideCategory",

43337

"params": [

43338

{

43339

"name": "cat",

43340

"description": "1..n categories to filter out of the UI",

43341

"type": "String",

43342

"multiple": true

43343

}

43344

],

43345

"class": "Plugin.ConsoleFilters",

43346

"module": "console-filters",

43347

"namespace": "Plugin"

43348

},

43349

{

43350

"file": "console-filters/js/console-filters.js",

43351

"line": 453,

43352

"description": "Shows any number of categories in the UI. Convenience method for\nmyConsole.filter.set('category.foo', true); set('category.bar', true);\nand so on.",

43353

"itemtype": "method",

43354

"name": "showCategory",

43355

"params": [

43356

{

43357

"name": "cat",

43358

"description": "1..n categories to allow to display in the UI",

43359

"type": "String",

43360

"multiple": true

43361

}

43362

],

43363

"class": "Plugin.ConsoleFilters",

43364

"module": "console-filters",

43365

"namespace": "Plugin"

43366

},

43367

{

43368

"file": "console-filters/js/console-filters.js",

43369

"line": 469,

43370

"description": "Hides any number of sources from the UI. Convenience method for\nmyConsole.filter.set('source.foo', false); set('source.bar', false);\nand so on.",

43371

"itemtype": "method",

43372

"name": "hideSource",

43373

"params": [

43374

{

43375

"name": "src",

43376

"description": "1..n sources to filter out of the UI",

43377

"type": "String",

43378

"multiple": true

43379

}

43380

],

43381

"class": "Plugin.ConsoleFilters",

43382

"module": "console-filters",

43383

"namespace": "Plugin"

43384

},

43385

{

43386

"file": "console-filters/js/console-filters.js",

43387

"line": 485,

43388

"description": "Shows any number of sources in the UI. Convenience method for\nmyConsole.filter.set('source.foo', true); set('source.bar', true);\nand so on.",

43389

"itemtype": "method",

43390

"name": "showSource",

43391

"params": [

43392

{

43393

"name": "src",

43394

"description": "1..n sources to allow to display in the UI",

43395

"type": "String",

43396

"multiple": true

43397

}

43398

],

43399

"class": "Plugin.ConsoleFilters",

43400

"module": "console-filters",

43401

"namespace": "Plugin"

43402

},

43403

{

43404

"file": "console-filters/js/console-filters.js",

43405

"line": 501,

43406

"description": "Creates a checkbox and label from the ConsoleFilters.FILTER_TEMPLATE for\nthe provided type and name. The checkbox and label are appended to the\ncontainer node passes as the first arg.",

43407

"itemtype": "method",

43408

"name": "_createCheckbox",

43409

"params": [

43410

{

43411

"name": "container",

43412

"description": "the parentNode of the new checkbox and label",

43413

"type": "Node"

43414

},

43415

{

43416

"name": "name",

43417

"description": "the identifier of the filter",

43418

"type": "String"

43419

}

43420

],

43421

"access": "protected",

43422

"tagname": "",

43423

"class": "Plugin.ConsoleFilters",

43424

"module": "console-filters",

43425

"namespace": "Plugin"

43426

},

43427

{

43428

"file": "console-filters/js/console-filters.js",

43429

"line": 522,

43430

"description": "Validates category updates are objects and the subattribute is not too\ndeep.",

43431

"itemtype": "method",

43432

"name": "_validateCategory",

43433

"params": [

43434

{

43435

"name": "cat",

43436

"description": "the new category:visibility map",

43437

"type": "String"

43438

},

43439

{

43440

"name": "v",

43441

"description": "the subattribute path updated",

43442

"type": "String"

43443

}

43444

],

43445

"return": {

43446

"description": "Boolean"

43447

},

43448

"access": "protected",

43449

"tagname": "",

43450

"class": "Plugin.ConsoleFilters",

43451

"module": "console-filters",

43452

"namespace": "Plugin"

43453

},

43454

{

43455

"file": "console-filters/js/console-filters.js",

43456

"line": 536,

43457

"description": "Validates source updates are objects and the subattribute is not too\ndeep.",

43458

"itemtype": "method",

43459

"name": "_validateSource",

43460

"params": [

43461

{

43462

"name": "cat",

43463

"description": "the new source:visibility map",

43464

"type": "String"

43465

},

43466

{

43467

"name": "v",

43468

"description": "the subattribute path updated",

43469

"type": "String"

43470

}

43471

],

43472

"return": {

43473

"description": "Boolean"

43474

},

43475

"access": "protected",

43476

"tagname": "",

43477

"class": "Plugin.ConsoleFilters",

43478

"module": "console-filters",

43479

"namespace": "Plugin"

43480

},

43481

{

43482

"file": "console-filters/js/console-filters.js",

43483

"line": 550,

43484

"description": "Setter method for cacheLimit attribute. Basically a validator to ensure\nnumeric input.",

43485

"itemtype": "method",

43486

"name": "_setCacheLimit",

43487

"params": [

43488

{

43489

"name": "v",

43490

"description": "Maximum number of entries",

43491

"type": "Number"

43492

}

43493

],

43494

"return": {

43495

"description": "",

43496

"type": "Number"

43497

},

43498

"access": "protected",

43499

"tagname": "",

43500

"class": "Plugin.ConsoleFilters",

43501

"module": "console-filters",

43502

"namespace": "Plugin"

43503

},

43504

{

43505

"file": "console-filters/js/console-filters.js",

43506

"line": 571,

43507

"description": "Plugin name.",

43508

"itemtype": "property",

43509

"name": "NAME",

43510

"type": "String",

43511

"static": 1,

43512

"default": "'consoleFilters'",

43513

"class": "Plugin.ConsoleFilters",

43514

"module": "console-filters",

43515

"namespace": "Plugin"

43516

},

43517

{

43518

"file": "console-filters/js/console-filters.js",

43519

"line": 581,

43520

"description": "The namespace hung off the host object that this plugin will inhabit.",

43521

"itemtype": "property",

43522

"name": "NS",

43523

"type": "String",

43524

"static": 1,

43525

"default": "'filter'",

43526

"class": "Plugin.ConsoleFilters",

43527

"module": "console-filters",

43528

"namespace": "Plugin"

43529

},

43530

{

43531

"file": "console-filters/js/console-filters.js",

43532

"line": 591,

43533

"description": "Markup template used to create the container for the category filters.",

43534

"itemtype": "property",

43535

"name": "CATEGORIES_TEMPLATE",

43536

"type": "String",

43537

"static": 1,

43538

"class": "Plugin.ConsoleFilters",

43539

"module": "console-filters",

43540

"namespace": "Plugin"

43541

},

43542

{

43543

"file": "console-filters/js/console-filters.js",

43544

"line": 601,

43545

"description": "Markup template used to create the container for the source filters.",

43546

"itemtype": "property",

43547

"name": "SOURCES_TEMPLATE",

43548

"type": "String",

43549

"static": 1,

43550

"class": "Plugin.ConsoleFilters",

43551

"module": "console-filters",

43552

"namespace": "Plugin"

43553

},

43554

{

43555

"file": "console-filters/js/console-filters.js",

43556

"line": 611,

43557

"description": "Markup template used to create the category and source filter checkboxes.",

43558

"itemtype": "property",

43559

"name": "FILTER_TEMPLATE",

43560

"type": "String",

43561

"static": 1,

43562

"class": "Plugin.ConsoleFilters",

43563

"module": "console-filters",

43564

"namespace": "Plugin"

43565

},

43566

{

43567

"file": "console-filters/js/console-filters.js",

43568

"line": 628,

43569

"description": "Classnames used by the templates when creating nodes.",

43570

"itemtype": "property",

43571

"name": "CHROME_CLASSES",

43572

"type": "Object",

43573

"static": 1,

43574

"access": "protected",

43575

"tagname": "",

43576

"class": "Plugin.ConsoleFilters",

43577

"module": "console-filters",

43578

"namespace": "Plugin"

43579

},

43580

{

43581

"file": "console-filters/js/console-filters.js",

43582

"line": 646,

43583

"description": "Default visibility applied to new categories and sources.",

43584

"itemtype": "attribute",

43585

"name": "defaultVisibility",

43586

"type": "{Boolean}",

43587

"default": "true",

43588

"class": "Plugin.ConsoleFilters",

43589

"module": "console-filters",

43590

"namespace": "Plugin"

43591

},

43592

{

43593

"file": "console-filters/js/console-filters.js",

43594

"line": 658,

43595

"description": "Map of entry categories to their visibility status. Update a\nparticular category's visibility by setting the subattribute to true\n(visible) or false (hidden).\n\nFor example, yconsole.filter.set('category.info', false) to hide\nlog entries with the category/logLevel of 'info'.\n\nSimilarly, yconsole.filter.get('category.warn') will return a\nboolean indicating whether that category is currently being included\nin the UI.\n\nUnlike the YUI instance configuration's logInclude and logExclude\nproperties, filtered entries are only hidden from the UI, but\ncan be made visible again.",

43596

"itemtype": "attribute",

43597

"name": "category",

43598

"type": "Object",

43599

"class": "Plugin.ConsoleFilters",

43600

"module": "console-filters",

43601

"namespace": "Plugin"

43602

},

43603

{

43604

"file": "console-filters/js/console-filters.js",

43605

"line": 684,

43606

"description": "Map of entry sources to their visibility status. Update a\nparticular sources's visibility by setting the subattribute to true\n(visible) or false (hidden).\n\nFor example, yconsole.filter.set('sources.slider', false) to hide\nlog entries originating from Y.Slider.",

43607

"itemtype": "attribute",

43608

"name": "source",

43609

"type": "Object",

43610

"class": "Plugin.ConsoleFilters",

43611

"module": "console-filters",

43612

"namespace": "Plugin"

43613

},

43614

{

43615

"file": "console-filters/js/console-filters.js",

43616

"line": 702,

43617

"description": "Maximum number of entries to store in the message cache. Use this to\nlimit the memory footprint in environments with heavy log usage.\nBy default, there is no limit (Number.POSITIVE_INFINITY).",

43618

"itemtype": "attribute",

43619

"name": "cacheLimit",

43620

"type": "{Number}",

43621

"default": "Number.POSITIVE_INFINITY",

43622

"class": "Plugin.ConsoleFilters",

43623

"module": "console-filters",

43624

"namespace": "Plugin"

43625

},

43626

{

43627

"file": "console/js/console.js",

43628

"line": 100,

43629

"description": "Category to prefix all event subscriptions to allow for ease of detach\nduring destroy.",

43630

"itemtype": "property",

43631

"name": "_evtCat",

43632

"type": "string",

43633

"access": "protected",

43634

"tagname": "",

43635

"class": "Console",

43636

"module": "console"

43637

},

43638

{

43639

"file": "console/js/console.js",

43640

"line": 110,

43641

"description": "Reference to the Node instance containing the header contents.",

43642

"itemtype": "property",

43643

"name": "_head",

43644

"type": "Node",

43645

"default": "null",

43646

"access": "protected",

43647

"tagname": "",

43648

"class": "Console",

43649

"module": "console"

43650

},

43651

{

43652

"file": "console/js/console.js",

43653

"line": 120,

43654

"description": "Reference to the Node instance that will house the console messages.",

43655

"itemtype": "property",

43656

"name": "_body",

43657

"type": "Node",

43658

"default": "null",

43659

"access": "protected",

43660

"tagname": "",

43661

"class": "Console",

43662

"module": "console"

43663

},

43664

{

43665

"file": "console/js/console.js",

43666

"line": 130,

43667

"description": "Reference to the Node instance containing the footer contents.",

43668

"itemtype": "property",

43669

"name": "_foot",

43670

"type": "Node",

43671

"default": "null",

43672

"access": "protected",

43673

"tagname": "",

43674

"class": "Console",

43675

"module": "console"

43676

},

43677

{

43678

"file": "console/js/console.js",

43679

"line": 140,

43680

"description": "Holds the object API returned from <code>Y.later</code> for the print\nloop interval.",

43681

"itemtype": "property",

43682

"name": "_printLoop",

43683

"type": "Object",

43684

"default": "null",

43685

"access": "protected",

43686

"tagname": "",

43687

"class": "Console",

43688

"module": "console"

43689

},

43690

{

43691

"file": "console/js/console.js",

43692

"line": 151,

43693

"description": "Array of normalized message objects awaiting printing.",

43694

"itemtype": "property",

43695

"name": "buffer",

43696

"type": "Array",

43697

"default": "null",

43698

"access": "protected",

43699

"tagname": "",

43700

"class": "Console",

43701

"module": "console"

43702

},

43703

{

43704

"file": "console/js/console.js",

43705

"line": 161,

43706

"description": "Wrapper for <code>Y.log</code>.",

43707

"itemtype": "method",

43708

"name": "log",

43709

"params": [

43710

{

43711

"name": "arg",

43712

"description": "(all arguments passed through to <code>Y.log</code>)",

43713

"type": "MIXED",

43714

"multiple": true

43715

}

43716

],

43717

"chainable": 1,

43718

"class": "Console",

43719

"module": "console"

43720

},

43721

{

43722

"file": "console/js/console.js",

43723

"line": 174,

43724

"description": "Clear the console of messages and flush the buffer of pending messages.",

43725

"itemtype": "method",

43726

"name": "clearConsole",

43727

"chainable": 1,

43728

"class": "Console",

43729

"module": "console"

43730

},

43731

{

43732

"file": "console/js/console.js",

43733

"line": 191,

43734

"description": "Clears the console and resets internal timers.",

43735

"itemtype": "method",

43736

"name": "reset",

43737

"chainable": 1,

43738

"class": "Console",

43739

"module": "console"

43740

},

43741

{

43742

"file": "console/js/console.js",

43743

"line": 203,

43744

"description": "Collapses the body and footer.",

43745

"itemtype": "method",

43746

"name": "collapse",

43747

"chainable": 1,

43748

"class": "Console",

43749

"module": "console"

43750

},

43751

{

43752

"file": "console/js/console.js",

43753

"line": 215,

43754

"description": "Expands the body and footer if collapsed.",

43755

"itemtype": "method",

43756

"name": "expand",

43757

"chainable": 1,

43758

"class": "Console",

43759

"module": "console"

43760

},

43761

{

43762

"file": "console/js/console.js",

43763

"line": 227,

43764

"description": "Outputs buffered messages to the console UI. This is typically called\nfrom a scheduled interval until the buffer is empty (referred to as the\nprint loop). The number of buffered messages output to the Console is\nlimited to the number provided as an argument. If no limit is passed,\nall buffered messages are rendered.",

43765

"itemtype": "method",

43766

"name": "printBuffer",

43767

"params": [

43768

{

43769

"name": "limit",

43770

"description": "(optional) max number of buffered entries to write",

43771

"type": "Number"

43772

}

43773

],

43774

"chainable": 1,

43775

"class": "Console",

43776

"module": "console"

43777

},

43778

{

43779

"file": "console/js/console.js",

43780

"line": 288,

43781

"description": "Constructor code. Set up the buffer and entry template, publish\ninternal events, and subscribe to the configured logEvent.",

43782

"itemtype": "method",

43783

"name": "initializer",

43784

"access": "protected",

43785

"tagname": "",

43786

"class": "Console",

43787

"module": "console"

43788

},

43789

{

43790

"file": "console/js/console.js",

43791

"line": 303,

43792

"description": "Transfers a received message to the print loop buffer. Default\nbehavior defined in _defEntryFn.",

43793

"itemtype": "event",

43794

"name": "entry",

43795

"params": [

43796

{

43797

"name": "event",

43798

"description": "An Event Facade object with the following attribute specific properties added:\n <dl>\n <dt>message</dt>\n <dd>The message data normalized into an object literal (see _normalizeMessage)</dd>\n </dl>",

43799

"type": "Event.Facade"

43800

}

43801

],

43802

"preventable": "_defEntryFn",

43803

"class": "Console",

43804

"module": "console"

43805

},

43806

{

43807

"file": "console/js/console.js",

43808

"line": 317,

43809

"description": "Triggers the reset behavior via the default logic in _defResetFn.",

43810

"itemtype": "event",

43811

"name": "reset",

43812

"params": [

43813

{

43814

"name": "event",

43815

"description": "Event Facade object",

43816

"type": "Event.Facade"

43817

}

43818

],

43819

"preventable": "_defResetFn",

43820

"class": "Console",

43821

"module": "console"

43822

},

43823

{

43824

"file": "console/js/console.js",

43825

"line": 329,

43826

"description": "Tears down the instance, flushing event subscriptions and purging the UI.",

43827

"itemtype": "method",

43828

"name": "destructor",

43829

"access": "protected",

43830

"tagname": "",

43831

"class": "Console",

43832

"module": "console"

43833

},

43834

{

43835

"file": "console/js/console.js",

43836

"line": 345,

43837

"description": "Generate the Console UI.",

43838

"itemtype": "method",

43839

"name": "renderUI",

43840

"access": "protected",

43841

"tagname": "",

43842

"class": "Console",

43843

"module": "console"

43844

},

43845

{

43846

"file": "console/js/console.js",

43847

"line": 363,

43848

"description": "Sync the UI state to the current attribute state.",

43849

"itemtype": "method",

43850

"name": "syncUI",

43851

"class": "Console",

43852

"module": "console"

43853

},

43854

{

43855

"file": "console/js/console.js",

43856

"line": 374,

43857

"description": "Set up event listeners to wire up the UI to the internal state.",

43858

"itemtype": "method",

43859

"name": "bindUI",

43860

"access": "protected",

43861

"tagname": "",

43862

"class": "Console",

43863

"module": "console"

43864

},

43865

{

43866

"file": "console/js/console.js",

43867

"line": 402,

43868

"description": "Create the DOM structure for the header elements.",

43869

"itemtype": "method",

43870

"name": "_initHead",

43871

"access": "protected",

43872

"tagname": "",

43873

"class": "Console",

43874

"module": "console"

43875

},

43876

{

43877

"file": "console/js/console.js",

43878

"line": 420,

43879

"description": "Create the DOM structure for the console body—where messages are\nrendered.",

43880

"itemtype": "method",

43881

"name": "_initBody",

43882

"access": "protected",

43883

"tagname": "",

43884

"class": "Console",

43885

"module": "console"

43886

},

43887

{

43888

"file": "console/js/console.js",

43889

"line": 435,

43890

"description": "Create the DOM structure for the footer elements.",

43891

"itemtype": "method",

43892

"name": "_initFoot",

43893

"access": "protected",

43894

"tagname": "",

43895

"class": "Console",

43896

"module": "console"

43897

},

43898

{

43899

"file": "console/js/console.js",

43900

"line": 453,

43901

"description": "Determine if incoming log messages are within the configured logLevel\nto be buffered for printing.",

43902

"itemtype": "method",

43903

"name": "_isInLogLevel",

43904

"access": "protected",

43905

"tagname": "",

43906

"class": "Console",

43907

"module": "console"

43908

},

43909

{

43910

"file": "console/js/console.js",

43911

"line": 479,

43912

"description": "Create a log entry message from the inputs including the following keys:\n<ul>\n <li>time - this moment</li>\n <li>message - leg message</li>\n <li>category - logLevel or custom category for the message</li>\n <li>source - when provided, the widget or util calling Y.log</li>\n <li>sourceAndDetail - same as source but can include instance info</li>\n <li>localTime - readable version of time</li>\n <li>elapsedTime - ms since last entry</li>\n <li>totalTime - ms since Console was instantiated or reset</li>\n</ul>",

43913

"itemtype": "method",

43914

"name": "_normalizeMessage",

43915

"params": [

43916

{

43917

"name": "e",

43918

"description": "custom event containing the log message",

43919

"type": "Event"

43920

}

43921

],

43922

"return": {

43923

"description": "Object the message object"

43924

},

43925

"access": "protected",

43926

"tagname": "",

43927

"class": "Console",

43928

"module": "console"

43929

},

43930

{

43931

"file": "console/js/console.js",

43932

"line": 527,

43933

"description": "Sets an interval for buffered messages to be output to the console.",

43934

"itemtype": "method",

43935

"name": "_schedulePrint",

43936

"access": "protected",

43937

"tagname": "",

43938

"class": "Console",

43939

"module": "console"

43940

},

43941

{

43942

"file": "console/js/console.js",

43943

"line": 542,

43944

"description": "Translates message meta into the markup for a console entry.",

43945

"itemtype": "method",

43946

"name": "_createEntryHTML",

43947

"params": [

43948

{

43949

"name": "m",

43950

"description": "object literal containing normalized message metadata",

43951

"type": "Object"

43952

}

43953

],

43954

"return": {

43955

"description": "String"

43956

},

43957

"access": "protected",

43958

"tagname": "",

43959

"class": "Console",

43960

"module": "console"

43961

},

43962

{

43963

"file": "console/js/console.js",

43964

"line": 565,

43965

"description": "Scrolls to the most recent entry",

43966

"itemtype": "method",

43967

"name": "scrollToLatest",

43968

"chainable": 1,

43969

"class": "Console",

43970

"module": "console"

43971

},

43972

{

43973

"file": "console/js/console.js",

43974

"line": 579,

43975

"description": "Performs HTML escaping on strings in the message object.",

43976

"itemtype": "method",

43977

"name": "_htmlEscapeMessage",

43978

"params": [

43979

{

43980

"name": "m",

43981

"description": "the normalized message object",

43982

"type": "Object"

43983

}

43984

],

43985

"return": {

43986

"description": "Object the message object with proper escapement"

43987

},

43988

"access": "protected",

43989

"tagname": "",

43990

"class": "Console",

43991

"module": "console"

43992

},

43993

{

43994

"file": "console/js/console.js",

43995

"line": 596,

43996

"description": "Removes the oldest message entries from the UI to maintain the limit\nspecified in the consoleLimit configuration.",

43997

"itemtype": "method",

43998

"name": "_trimOldEntries",

43999

"access": "protected",

44000

"tagname": "",

44001

"class": "Console",

44002

"module": "console"

44003

},

44004

{

44005

"file": "console/js/console.js",

44006

"line": 642,

44007

"description": "Returns the input string with ampersands (&), &lt, and > encoded\nas HTML entities.",

44008

"itemtype": "method",

44009

"name": "_encodeHTML",

44010

"params": [

44011

{

44012

"name": "s",

44013

"description": "the raw string",

44014

"type": "String"

44015

}

44016

],

44017

"return": {

44018

"description": "String the encoded string"

44019

},

44020

"access": "protected",

44021

"tagname": "",

44022

"class": "Console",

44023

"module": "console"

44024

},

44025

{

44026

"file": "console/js/console.js",

44027

"line": 659,

44028

"description": "Clears the timeout for printing buffered messages.",

44029

"itemtype": "method",

44030

"name": "_cancelPrintLoop",

44031

"access": "protected",

44032

"tagname": "",

44033

"class": "Console",

44034

"module": "console"

44035

},

44036

{

44037

"file": "console/js/console.js",

44038

"line": 672,

44039

"description": "Validates input value for style attribute. Accepts only values 'inline',\n'block', and 'separate'.",

44040

"itemtype": "method",

44041

"name": "_validateStyle",

44042

"params": [

44043

{

44044

"name": "style",

44045

"description": "the proposed value",

44046

"type": "String"

44047

}

44048

],

44049

"return": {

44050

"description": "pass/fail",

44051

"type": "Boolean"

44052

},

44053

"access": "protected",

44054

"tagname": "",

44055

"class": "Console",

44056

"module": "console"

44057

},

44058

{

44059

"file": "console/js/console.js",

44060

"line": 685,

44061

"description": "Event handler for clicking on the Pause checkbox to update the paused\nattribute.",

44062

"itemtype": "method",

44063

"name": "_onPauseClick",

44064

"params": [

44065

{

44066

"name": "e",

44067

"description": "DOM event facade for the click event",

44068

"type": "Event"

44069

}

44070

],

44071

"access": "protected",

44072

"tagname": "",

44073

"class": "Console",

44074

"module": "console"

44075

},

44076

{

44077

"file": "console/js/console.js",

44078

"line": 697,

44079

"description": "Event handler for clicking on the Clear button. Pass-through to\n<code>this.clearConsole()</code>.",

44080

"itemtype": "method",

44081

"name": "_onClearClick",

44082

"params": [

44083

{

44084

"name": "e",

44085

"description": "DOM event facade for the click event",

44086

"type": "Event"

44087

}

44088

],

44089

"access": "protected",

44090

"tagname": "",

44091

"class": "Console",

44092

"module": "console"

44093

},

44094

{

44095

"file": "console/js/console.js",

44096

"line": 709,

44097

"description": "Event handler for clicking on the Collapse/Expand button. Sets the\n"collapsed" attribute accordingly.",

44098

"itemtype": "method",

44099

"name": "_onCollapseClick",

44100

"params": [

44101

{

44102

"name": "e",

44103

"description": "DOM event facade for the click event",

44104

"type": "Event"

44105

}

44106

],

44107

"access": "protected",

44108

"tagname": "",

44109

"class": "Console",

44110

"module": "console"

44111

},

44112

{

44113

"file": "console/js/console.js",

44114

"line": 722,

44115

"description": "Validator for logSource attribute.",

44116

"itemtype": "method",

44117

"name": "_validateLogSource",

44118

"params": [

44119

{

44120

"name": "v",

44121

"description": "the desired logSource",

44122

"type": "Object"

44123

}

44124

],

44125

"return": {

44126

"description": "true if the input is an object with an <code>on</code>\n method",

44127

"type": "Boolean"

44128

},

44129

"access": "protected",

44130

"tagname": "",

44131

"class": "Console",

44132

"module": "console"

44133

},

44134

{

44135

"file": "console/js/console.js",

44136

"line": 735,

44137

"description": "Setter method for logLevel attribute. Acceptable values are\n"error&quot, "warn&quot, and "info&quot (case\ninsensitive). Other values are treated as "info".",

44138

"itemtype": "method",

44139

"name": "_setLogLevel",

44140

"params": [

44141

{

44142

"name": "v",

44143

"description": "the desired log level",

44144

"type": "String"

44145

}

44146

],

44147

"return": {

44148

"description": "String One of Console.LOG_LEVEL_INFO, _WARN, or _ERROR"

44149

},

44150

"access": "protected",

44151

"tagname": "",

44152

"class": "Console",

44153

"module": "console"

44154

},

44155

{

44156

"file": "console/js/console.js",

44157

"line": 753,

44158

"description": "Getter method for useBrowserConsole attribute. Just a pass through to\nthe YUI instance configuration setting.",

44159

"itemtype": "method",

44160

"name": "_getUseBrowserConsole",

44161

"return": {

44162

"description": "or null if logSource is not a YUI instance",

44163

"type": "Boolean"

44164

},

44165

"access": "protected",

44166

"tagname": "",

44167

"class": "Console",

44168

"module": "console"

44169

},

44170

{

44171

"file": "console/js/console.js",

44172

"line": 767,

44173

"description": "Setter method for useBrowserConsole attributes. Only functional if the\nlogSource attribute points to a YUI instance. Passes the value down to\nthe YUI instance. NOTE: multiple Console instances cannot maintain\nindependent useBrowserConsole values, since it is just a pass through to\nthe YUI instance configuration.",

44174

"itemtype": "method",

44175

"name": "_setUseBrowserConsole",

44176

"params": [

44177

{

44178

"name": "v",

44179

"description": "false to disable browser console printing (default)",

44180

"type": "Boolean"

44181

}

44182

],

44183

"return": {

44184

"description": "true|false if logSource is a YUI instance",

44185

"type": "Boolean"

44186

},

44187

"access": "protected",

44188

"tagname": "",

44189

"class": "Console",

44190

"module": "console"

44191

},

44192

{

44193

"file": "console/js/console.js",

44194

"line": 790,

44195

"description": "Set the height of the Console container. Set the body height to the\ndifference between the configured height and the calculated heights of\nthe header and footer.\nOverrides Widget.prototype._uiSetHeight.",

44196

"itemtype": "method",

44197

"name": "_uiSetHeight",

44198

"params": [

44199

{

44200

"name": "v",

44201

"description": "the new height",

44202

"type": "String|Number"

44203

}

44204

],

44205

"access": "protected",

44206

"tagname": "",

44207

"class": "Console",

44208

"module": "console"

44209

},

44210

{

44211

"file": "console/js/console.js",

44212

"line": 812,

44213

"description": "Over-ride default content box sizing to do nothing, since we're sizing\nthe body section to fill out height ourselves.",

44214

"itemtype": "method",

44215

"name": "_uiSizeCB",

44216

"access": "protected",

44217

"tagname": "",

44218

"class": "Console",

44219

"module": "console"

44220

},

44221

{

44222

"file": "console/js/console.js",

44223

"line": 824,

44224

"description": "Updates the UI if changes are made to any of the strings in the strings\nattribute.",

44225

"itemtype": "method",

44226

"name": "_afterStringsChange",

44227

"params": [

44228

{

44229

"name": "e",

44230

"description": "Custom event for the attribute change",

44231

"type": "Event"

44232

}

44233

],

44234

"access": "protected",

44235

"tagname": "",

44236

"class": "Console",

44237

"module": "console"

44238

},

44239

{

44240

"file": "console/js/console.js",

44241

"line": 851,

44242

"description": "Updates the UI and schedules or cancels the print loop.",

44243

"itemtype": "method",

44244

"name": "_afterPausedChange",

44245

"params": [

44246

{

44247

"name": "e",

44248

"description": "Custom event for the attribute change",

44249

"type": "Event"

44250

}

44251

],

44252

"access": "protected",

44253

"tagname": "",

44254

"class": "Console",

44255

"module": "console"

44256

},

44257

{

44258

"file": "console/js/console.js",

44259

"line": 872,

44260

"description": "Checks or unchecks the paused checkbox",

44261

"itemtype": "method",

44262

"name": "_uiUpdatePaused",

44263

"params": [

44264

{

44265

"name": "on",

44266

"description": "the new checked state",

44267

"type": "Boolean"

44268

}

44269

],

44270

"access": "protected",

44271

"tagname": "",

44272

"class": "Console",

44273

"module": "console"

44274

},

44275

{

44276

"file": "console/js/console.js",

44277

"line": 887,

44278

"description": "Calls this._trimOldEntries() in response to changes in the configured\nconsoleLimit attribute.",

44279

"itemtype": "method",

44280

"name": "_afterConsoleLimitChange",

44281

"params": [

44282

{

44283

"name": "e",

44284

"description": "Custom event for the attribute change",

44285

"type": "Event"

44286

}

44287

],

44288

"access": "protected",

44289

"tagname": "",

44290

"class": "Console",

44291

"module": "console"

44292

},

44293

{

44294

"file": "console/js/console.js",

44295

"line": 900,

44296

"description": "Updates the className of the contentBox, which should trigger CSS to\nhide or show the body and footer sections depending on the new value.",

44297

"itemtype": "method",

44298

"name": "_afterCollapsedChange",

44299

"params": [

44300

{

44301

"name": "e",

44302

"description": "Custom event for the attribute change",

44303

"type": "Event"

44304

}

44305

],

44306

"access": "protected",

44307

"tagname": "",

44308

"class": "Console",

44309

"module": "console"

44310

},

44311

{

44312

"file": "console/js/console.js",

44313

"line": 912,

44314

"description": "Updates the UI to reflect the new Collapsed state",

44315

"itemtype": "method",

44316

"name": "_uiUpdateCollapsed",

44317

"params": [

44318

{

44319

"name": "v",

44320

"description": "true for collapsed, false for expanded",

44321

"type": "Boolean"

44322

}

44323

],

44324

"access": "protected",

44325

"tagname": "",

44326

"class": "Console",

44327

"module": "console"

44328

},

44329

{

44330

"file": "console/js/console.js",

44331

"line": 934,

44332

"description": "Makes adjustments to the UI if needed when the Console is hidden or shown",

44333

"itemtype": "method",

44334

"name": "_afterVisibleChange",

44335

"params": [

44336

{

44337

"name": "e",

44338

"description": "the visibleChange event",

44339

"type": "Event"

44340

}

44341

],

44342

"access": "protected",

44343

"tagname": "",

44344

"class": "Console",

44345

"module": "console"

44346

},

44347

{

44348

"file": "console/js/console.js",

44349

"line": 947,

44350

"description": "Recalculates dimensions and updates appropriately when shown",

44351

"itemtype": "method",

44352

"name": "_uiUpdateFromHideShow",

44353

"params": [

44354

{

44355

"name": "v",

44356

"description": "true for visible, false for hidden",

44357

"type": "Boolean"

44358

}

44359

],

44360

"access": "protected",

44361

"tagname": "",

44362

"class": "Console",

44363

"module": "console"

44364

},

44365

{

44366

"file": "console/js/console.js",

44367

"line": 960,

44368

"description": "Responds to log events by normalizing qualifying messages and passing\nthem along through the entry event for buffering etc.",

44369

"itemtype": "method",

44370

"name": "_onLogEvent",

44371

"params": [

44372

{

44373

"name": "msg",

44374

"description": "the log message",

44375

"type": "String"

44376

},

44377

{

44378

"name": "cat",

44379

"description": "OPTIONAL the category or logLevel of the message",

44380

"type": "String"

44381

},

44382

{

44383

"name": "src",

44384

"description": "OPTIONAL the source of the message (e.g. widget name)",

44385

"type": "String"

44386

}

44387

],

44388

"access": "protected",

44389

"tagname": "",

44390

"class": "Console",

44391

"module": "console"

44392

},

44393

{

44394

"file": "console/js/console.js",

44395

"line": 987,

44396

"description": "Clears the console, resets the startTime attribute, enables and\nunpauses the widget.",

44397

"itemtype": "method",

44398

"name": "_defResetFn",

44399

"access": "protected",

44400

"tagname": "",

44401

"class": "Console",

44402

"module": "console"

44403

},

44404

{

44405

"file": "console/js/console.js",

44406

"line": 1001,

44407

"description": "Buffers incoming message objects and schedules the printing.",

44408

"itemtype": "method",

44409

"name": "_defEntryFn",

44410

"params": [

44411

{

44412

"name": "e",

44413

"description": "The Custom event carrying the message in its payload",

44414

"type": "Event"

44415

}

44416

],

44417

"access": "protected",

44418

"tagname": "",

44419

"class": "Console",

44420

"module": "console"

44421

},

44422

{

44423

"file": "console/js/console.js",

44424

"line": 1019,

44425

"description": "The identity of the widget.",

44426

"itemtype": "property",

44427

"name": "NAME",

44428

"type": "String",

44429

"static": 1,

44430

"class": "Console",

44431

"module": "console"

44432

},

44433

{

44434

"file": "console/js/console.js",

44435

"line": 1028,

44436

"description": "Static identifier for logLevel configuration setting to allow all\nincoming messages to generate Console entries.",

44437

"itemtype": "property",

44438

"name": "LOG_LEVEL_INFO",

44439

"type": "String",

44440

"static": 1,

44441

"class": "Console",

44442

"module": "console"

44443

},

44444

{

44445

"file": "console/js/console.js",

44446

"line": 1038,

44447

"description": "Static identifier for logLevel configuration setting to allow only\nincoming messages of logLevel "warn" or "error"\nto generate Console entries.",

44448

"itemtype": "property",

44449

"name": "LOG_LEVEL_WARN",

44450

"type": "String",

44451

"static": 1,

44452

"class": "Console",

44453

"module": "console"

44454

},

44455

{

44456

"file": "console/js/console.js",

44457

"line": 1049,

44458

"description": "Static identifier for logLevel configuration setting to allow only\nincoming messages of logLevel "error" to generate\nConsole entries.",

44459

"itemtype": "property",

44460

"name": "LOG_LEVEL_ERROR",

44461

"type": "String",

44462

"static": 1,

44463

"class": "Console",

44464

"module": "console"

44465

},

44466

{

44467

"file": "console/js/console.js",

44468

"line": 1060,

44469

"description": "Map (object) of classNames used to populate the placeholders in the\nConsole.ENTRY_TEMPLATE markup when rendering a new Console entry.\n\nBy default, the keys contained in the object are:\n<ul>\n <li>entry_class</li>\n <li>entry_meta_class</li>\n <li>entry_cat_class</li>\n <li>entry_src_class</li>\n <li>entry_time_class</li>\n <li>entry_content_class</li>\n</ul>",

44470

"itemtype": "property",

44471

"name": "ENTRY_CLASSES",

44472

"type": "Object",

44473

"static": 1,

44474

"class": "Console",

44475

"module": "console"

44476

},

44477

{

44478

"file": "console/js/console.js",

44479

"line": 1087,

44480

"description": "Map (object) of classNames used to populate the placeholders in the\nConsole.HEADER_TEMPLATE, Console.BODY_TEMPLATE, and\nConsole.FOOTER_TEMPLATE markup when rendering the Console UI.\n\nBy default, the keys contained in the object are:\n<ul>\n <li>console_hd_class</li>\n <li>console_bd_class</li>\n <li>console_ft_class</li>\n <li>console_controls_class</li>\n <li>console_checkbox_class</li>\n <li>console_pause_class</li>\n <li>console_pause_label_class</li>\n <li>console_button_class</li>\n <li>console_clear_class</li>\n <li>console_collapse_class</li>\n <li>console_title_class</li>\n</ul>",

44481

"itemtype": "property",

44482

"name": "CHROME_CLASSES",

44483

"type": "Object",

44484

"static": 1,

44485

"class": "Console",

44486

"module": "console"

44487

},

44488

{

44489

"file": "console/js/console.js",

44490

"line": 1125,

44491

"description": "Markup template used to generate the DOM structure for the header\nsection of the Console when it is rendered. The template includes\nthese {placeholder}s:\n\n<ul>\n <li>console_button_class - contributed by Console.CHROME_CLASSES</li>\n <li>console_collapse_class - contributed by Console.CHROME_CLASSES</li>\n <li>console_hd_class - contributed by Console.CHROME_CLASSES</li>\n <li>console_title_class - contributed by Console.CHROME_CLASSES</li>\n <li>str_collapse - pulled from attribute strings.collapse</li>\n <li>str_title - pulled from attribute strings.title</li>\n</ul>",

44492

"itemtype": "property",

44493

"name": "HEADER_TEMPLATE",

44494

"type": "String",

44495

"static": 1,

44496

"class": "Console",

44497

"module": "console"

44498

},

44499

{

44500

"file": "console/js/console.js",

44501

"line": 1151,

44502

"description": "Markup template used to generate the DOM structure for the Console body\n(where the messages are inserted) when it is rendered. The template\nincludes only the {placeholder} "console_bd_class", which is\nconstributed by Console.CHROME_CLASSES.",

44503

"itemtype": "property",

44504

"name": "BODY_TEMPLATE",

44505

"type": "String",

44506

"static": 1,

44507

"class": "Console",

44508

"module": "console"

44509

},

44510

{

44511

"file": "console/js/console.js",

44512

"line": 1163,

44513

"description": "Markup template used to generate the DOM structure for the footer\nsection of the Console when it is rendered. The template includes\nmany of the {placeholder}s from Console.CHROME_CLASSES as well as:\n\n<ul>\n <li>id_guid - generated unique id, relates the label and checkbox</li>\n <li>str_pause - pulled from attribute strings.pause</li>\n <li>str_clear - pulled from attribute strings.clear</li>\n</ul>",

44514

"itemtype": "property",

44515

"name": "FOOTER_TEMPLATE",

44516

"type": "String",

44517

"static": 1,

44518

"class": "Console",

44519

"module": "console"

44520

},

44521

{

44522

"file": "console/js/console.js",

44523

"line": 1191,

44524

"description": "Default markup template used to create the DOM structure for Console\nentries. The markup contains {placeholder}s for content and classes\nthat are replaced via Y.substitute. The default template contains\nthe {placeholder}s identified in Console.ENTRY_CLASSES as well as the\nfollowing placeholders that will be populated by the log entry data:\n\n<ul>\n <li>cat_class</li>\n <li>src_class</li>\n <li>totalTime</li>\n <li>elapsedTime</li>\n <li>localTime</li>\n <li>sourceAndDetail</li>\n <li>message</li>\n</ul>",

44525

"itemtype": "property",

44526

"name": "ENTRY_TEMPLATE",

44527

"type": "String",

44528

"static": 1,

44529

"class": "Console",

44530

"module": "console"

44531

},

44532

{

44533

"file": "console/js/console.js",

44534

"line": 1214,

44535

"description": "Static property used to define the default attribute configuration of\nthe Widget.",

44536

"itemtype": "property",

44537

"name": "ATTRS",

44538

"type": "Object",

44539

"static": 1,

44540

"class": "Console",

44541

"module": "console"

44542

},

44543

{

44544

"file": "console/js/console.js",

44545

"line": 1224,

44546

"description": "Name of the custom event that will communicate log messages.",

44547

"itemtype": "attribute",

44548

"name": "logEvent",

44549

"type": "String",

44550

"default": "\"yui:log\"",

44551

"class": "Console",

44552

"module": "console"

44553

},

44554

{

44555

"file": "console/js/console.js",

44556

"line": 1237,

44557

"description": "Object that will emit the log events. By default the YUI instance.\nTo have a single Console capture events from all YUI instances, set\nthis to the Y.Global object.",

44558

"itemtype": "attribute",

44559

"name": "logSource",

44560

"type": "EventTarget",

44561

"default": "Y",

44562

"class": "Console",

44563

"module": "console"

44564

},

44565

{

44566

"file": "console/js/console.js",

44567

"line": 1254,

44568

"description": "Collection of strings used to label elements in the Console UI.\nDefault collection contains the following name:value pairs:\n\n<ul>\n <li>title : "Log Console"</li>\n <li>pause : "Pause"</li>\n <li>clear : "Clear"</li>\n <li>collapse : "Collapse"</li>\n <li>expand : "Expand"</li>\n</ul>",

44569

"itemtype": "attribute",

44570

"name": "strings",

44571

"type": "Object",

44572

"class": "Console",

44573

"module": "console"

44574

},

44575

{

44576

"file": "console/js/console.js",

44577

"line": 1273,

44578

"description": "Boolean to pause the outputting of new messages to the console.\nWhen paused, messages will accumulate in the buffer.",

44579

"itemtype": "attribute",

44580

"name": "paused",

44581

"type": "boolean",

44582

"default": "false",

44583

"class": "Console",

44584

"module": "console"

44585

},

44586

{

44587

"file": "console/js/console.js",

44588

"line": 1286,

44589

"description": "If a category is not specified in the Y.log(..) statement, this\ncategory will be used. Categories "info",\n"warn", and "error" are also called log level.",

44590

"itemtype": "attribute",

44591

"name": "defaultCategory",

44592

"type": "String",

44593

"default": "\"info\"",

44594

"class": "Console",

44595

"module": "console"

44596

},

44597

{

44598

"file": "console/js/console.js",

44599

"line": 1300,

44600

"description": "If a source is not specified in the Y.log(..) statement, this\nsource will be used.",

44601

"itemtype": "attribute",

44602

"name": "defaultSource",

44603

"type": "String",

44604

"default": "\"global\"",

44605

"class": "Console",

44606

"module": "console"

44607

},

44608

{

44609

"file": "console/js/console.js",

44610

"line": 1313,

44611

"description": "Markup template used to create the DOM structure for Console entries.",

44612

"itemtype": "attribute",

44613

"name": "entryTemplate",

44614

"type": "String",

44615

"default": "Console.ENTRY_TEMPLATE",

44616

"class": "Console",

44617

"module": "console"

44618

},

44619

{

44620

"file": "console/js/console.js",

44621

"line": 1325,

44622

"description": "Minimum entry log level to render into the Console. The initial\nlogLevel value for all Console instances defaults from the\nY.config.logLevel YUI configuration, or Console.LOG_LEVEL_INFO if\nthat configuration is not set.\n\nPossible values are "info", "warn",\n"error" (case insensitive), or their corresponding statics\nConsole.LOG_LEVEL_INFO and so on.",

44623

"itemtype": "attribute",

44624

"name": "logLevel",

44625

"type": "String",

44626

"default": "Y.config.logLevel or Console.LOG_LEVEL_INFO",

44627

"class": "Console",

44628

"module": "console"

44629

},

44630

{

44631

"file": "console/js/console.js",

44632

"line": 1346,

44633

"description": "Millisecond timeout between iterations of the print loop, moving\nentries from the buffer to the UI.",

44634

"itemtype": "attribute",

44635

"name": "printTimeout",

44636

"type": "Number",

44637

"default": "100",

44638

"class": "Console",

44639

"module": "console"

44640

},

44641

{

44642

"file": "console/js/console.js",

44643

"line": 1359,

44644

"description": "Maximum number of entries printed in each iteration of the print\nloop. This is used to prevent excessive logging locking the page UI.",

44645

"itemtype": "attribute",

44646

"name": "printLimit",

44647

"type": "Number",

44648

"default": "50",

44649

"class": "Console",

44650

"module": "console"

44651

},

44652

{

44653

"file": "console/js/console.js",

44654

"line": 1372,

44655

"description": "Maximum number of Console entries allowed in the Console body at one\ntime. This is used to keep acquired messages from exploding the\nDOM tree and impacting page performance.",

44656

"itemtype": "attribute",

44657

"name": "consoleLimit",

44658

"type": "Number",

44659

"default": "300",

44660

"class": "Console",

44661

"module": "console"

44662

},

44663

{

44664

"file": "console/js/console.js",

44665

"line": 1386,

44666

"description": "New entries should display at the top of the Console or the bottom?",

44667

"itemtype": "attribute",

44668

"name": "newestOnTop",

44669

"type": "Boolean",

44670

"default": "true",

44671

"class": "Console",

44672

"module": "console"

44673

},

44674

{

44675

"file": "console/js/console.js",

44676

"line": 1397,

44677

"description": "When new entries are added to the Console UI, should they be\nscrolled into view?",

44678

"itemtype": "attribute",

44679

"name": "scrollIntoView",

44680

"type": "Boolean",

44681

"default": "true",

44682

"class": "Console",

44683

"module": "console"

44684

},

44685

{

44686

"file": "console/js/console.js",

44687

"line": 1409,

44688

"description": "The baseline time for this Console instance, used to measure elapsed\ntime from the moment the console module is <code>use</code>d to the\nmoment each new entry is logged (not rendered).\n\nThis value is reset by the instance method myConsole.reset().",

44689

"itemtype": "attribute",

44690

"name": "startTime",

44691

"type": "Date",

44692

"default": "The moment the console module is <code>use</code>d",

44693

"class": "Console",

44694

"module": "console"

44695

},

44696

{

44697

"file": "console/js/console.js",

44698

"line": 1424,

44699

"description": "The precise time the last entry was logged. Used to measure elapsed\ntime between log messages.",

44700

"itemtype": "attribute",

44701

"name": "lastTime",

44702

"type": "Date",

44703

"default": "The moment the console module is <code>use</code>d",

44704

"class": "Console",

44705

"module": "console"

44706

},

44707

{

44708

"file": "console/js/console.js",

44709

"line": 1437,

44710

"description": "Controls the collapsed state of the Console",

44711

"itemtype": "attribute",

44712

"name": "collapsed",

44713

"type": "Boolean",

44714

"default": "false",

44715

"class": "Console",

44716

"module": "console"

44717

},

44718

{

44719

"file": "console/js/console.js",

44720

"line": 1448,

44721

"description": "String with units, or number, representing the height of the Console,\ninclusive of header and footer. If a number is provided, the default\nunit, defined by Widget's DEF_UNIT, property is used.",

44722

"itemtype": "attribute",

44723

"name": "height",

44724

"default": "\"300px\"",

44725

"type": "{String | Number}",

44726

"class": "Console",

44727

"module": "console"

44728

},

44729

{

44730

"file": "console/js/console.js",

44731

"line": 1461,

44732

"description": "String with units, or number, representing the width of the Console.\nIf a number is provided, the default unit, defined by Widget's\nDEF_UNIT, property is used.",

44733

"itemtype": "attribute",

44734

"name": "width",

44735

"default": "\"300px\"",

44736

"type": "{String | Number}",

44737

"class": "Console",

44738

"module": "console"

44739

},

44740

{

44741

"file": "console/js/console.js",

44742

"line": 1474,

44743

"description": "Pass through to the YUI instance useBrowserConsole configuration.\nBy default this is set to false, which will disable logging to the\nbrowser console when a Console instance is created. If the\nlogSource is not a YUI instance, this has no effect.",

44744

"itemtype": "attribute",

44745

"name": "useBrowserConsole",

44746

"type": "{Boolean}",

44747

"default": "false",

44748

"class": "Console",

44749

"module": "console"

44750

},

44751

{

44752

"file": "console/js/console.js",

44753

"line": 1495,

44754

"description": "Allows the Console to flow in the document. Available values are\n'inline', 'block', and 'separate' (the default).",

44755

"itemtype": "attribute",

44756

"name": "style",

44757

"type": "{String}",

44758

"default": "'separate'",

44759

"class": "Console",

44760

"module": "console"

44761

},

44762

{

44763

"file": "cookie/js/Cookie.js",

44764

"line": 58,

44765

"description": "Creates a cookie string that can be assigned into document.cookie.",

44766

"params": [

44767

{

44768

"name": "name",

44769

"description": "The name of the cookie.",

44770

"type": "String"

44771

},

44772

{

44773

"name": "value",

44774

"description": "The value of the cookie.",

44775

"type": "String"

44776

},

44777

{

44778

"name": "encodeValue",

44779

"description": "True to encode the value, false to leave as-is.",

44780

"type": "Boolean"

44781

},

44782

{

44783

"name": "options",

44784

"description": "(Optional) Options for the cookie.",

44785

"type": "Object"

44786

}

44787

],

44788

"return": {

44789

"description": "The formatted cookie string.",

44790

"type": "String"

44791

},

44792

"itemtype": "method",

44793

"name": "_createCookieString",

44794

"access": "private",

44795

"tagname": "",

44796

"static": 1,

44797

"class": "Cookie",

44798

"module": "cookie"

44799

},

44800

{

44801

"file": "cookie/js/Cookie.js",

44802

"line": 104,

44803

"description": "Formats a cookie value for an object containing multiple values.",

44804

"params": [

44805

{

44806

"name": "hash",

44807

"description": "An object of key-value pairs to create a string for.",

44808

"type": "Object"

44809

}

44810

],

44811

"return": {

44812

"description": "A string suitable for use as a cookie value.",

44813

"type": "String"

44814

},

44815

"itemtype": "method",

44816

"name": "_createCookieHashString",

44817

"access": "private",

44818

"tagname": "",

44819

"static": 1,

44820

"class": "Cookie",

44821

"module": "cookie"

44822

},

44823

{

44824

"file": "cookie/js/Cookie.js",

44825

"line": 128,

44826

"description": "Parses a cookie hash string into an object.",

44827

"params": [

44828

{

44829

"name": "text",

44830

"description": "The cookie hash string to parse (format: n1=v1&n2=v2).",

44831

"type": "String"

44832

}

44833

],

44834

"return": {

44835

"description": "An object containing entries for each cookie value.",

44836

"type": "Object"

44837

},

44838

"itemtype": "method",

44839

"name": "_parseCookieHash",

44840

"access": "private",

44841

"tagname": "",

44842

"static": 1,

44843

"class": "Cookie",

44844

"module": "cookie"

44845

},

44846

{

44847

"file": "cookie/js/Cookie.js",

44848

"line": 152,

44849

"description": "Parses a cookie string into an object representing all accessible cookies.",

44850

"params": [

44851

{

44852

"name": "text",

44853

"description": "The cookie string to parse.",

44854

"type": "String"

44855

},

44856

{

44857

"name": "shouldDecode",

44858

"description": "(Optional) Indicates if the cookie values should be decoded or not. Default is true.",

44859

"type": "Boolean"

44860

}

44861

],

44862

"return": {

44863

"description": "An object containing entries for each accessible cookie.",

44864

"type": "Object"

44865

},

44866

"itemtype": "method",

44867

"name": "_parseCookieString",

44868

"access": "private",

44869

"tagname": "",

44870

"static": 1,

44871

"class": "Cookie",

44872

"module": "cookie"

44873

},

44874

{

44875

"file": "cookie/js/Cookie.js",

44876

"line": 197,

44877

"description": "Sets the document object that the cookie utility uses for setting\ncookies. This method is necessary to ensure that the cookie utility\nunit tests can pass even when run on a domain instead of locally.\nThis method should not be used otherwise; you should use \n<code>Y.config.doc</code> to change the document that the cookie\nutility uses for everyday purposes.",

44878

"params": [

44879

{

44880

"name": "newDoc",

44881

"description": "The object to use as the document.",

44882

"type": "Object"

44883

}

44884

],

44885

"return": {

44886

"description": "",

44887

"type": "Void"

44888

},

44889

"itemtype": "method",

44890

"name": "_setDoc",

44891

"access": "private",

44892

"tagname": "",

44893

"class": "Cookie",

44894

"module": "cookie"

44895

},

44896

{

44897

"file": "cookie/js/Cookie.js",

44898

"line": 217,

44899

"description": "Determines if the cookie with the given name exists. This is useful for\nBoolean cookies (those that do not follow the name=value convention).",

44900

"params": [

44901

{

44902

"name": "name",

44903

"description": "The name of the cookie to check.",

44904

"type": "String"

44905

}

44906

],

44907

"return": {

44908

"description": "True if the cookie exists, false if not.",

44909

"type": "Boolean"

44910

},

44911

"itemtype": "method",

44912

"name": "exists",

44913

"static": 1,

44914

"class": "Cookie",

44915

"module": "cookie"

44916

},

44917

{

44918

"file": "cookie/js/Cookie.js",

44919

"line": 234,

44920

"description": "Returns the cookie value for the given name.",

44921

"params": [

44922

{

44923

"name": "name",

44924

"description": "The name of the cookie to retrieve.",

44925

"type": "String"

44926

},

44927

{

44928

"name": "options",

44929

"description": "(Optional) An object containing one or more\n cookie options: raw (true/false) and converter (a function).\n The converter function is run on the value before returning it. The\n function is not used if the cookie doesn't exist. The function can be\n passed instead of the options object for backwards compatibility. When\n raw is set to true, the cookie value is not URI decoded.",

44930

"type": "Function|Object"

44931

}

44932

],

44933

"return": {

44934

"description": "If no converter is specified, returns a string or null if\n the cookie doesn't exist. If the converter is specified, returns the value\n returned from the converter or null if the cookie doesn't exist.",

44935

"type": "Variant"

44936

},

44937

"itemtype": "method",

44938

"name": "get",

44939

"static": 1,

44940

"class": "Cookie",

44941

"module": "cookie"

44942

},

44943

{

44944

"file": "cookie/js/Cookie.js",

44945

"line": 282,

44946

"description": "Returns the value of a subcookie.",

44947

"params": [

44948

{

44949

"name": "name",

44950

"description": "The name of the cookie to retrieve.",

44951

"type": "String"

44952

},

44953

{

44954

"name": "subName",

44955

"description": "The name of the subcookie to retrieve.",

44956

"type": "String"

44957

},

44958

{

44959

"name": "converter",

44960

"description": "(Optional) A function to run on the value before returning\n it. The function is not used if the cookie doesn't exist.",

44961

"type": "Function"

44962

}

44963

],

44964

"return": {

44965

"description": "If the cookie doesn't exist, null is returned. If the subcookie\n doesn't exist, null if also returned. If no converter is specified and the\n subcookie exists, a string is returned. If a converter is specified and the\n subcookie exists, the value returned from the converter is returned.",

44966

"type": "Variant"

44967

},

44968

"itemtype": "method",

44969

"name": "getSub",

44970

"static": 1,

44971

"class": "Cookie",

44972

"module": "cookie"

44973

},

44974

{

44975

"file": "cookie/js/Cookie.js",

44976

"line": 318,

44977

"description": "Returns an object containing name-value pairs stored in the cookie with the given name.",

44978

"params": [

44979

{

44980

"name": "name",

44981

"description": "The name of the cookie to retrieve.",

44982

"type": "String"

44983

}

44984

],

44985

"return": {

44986

"description": "An object of name-value pairs if the cookie with the given name\n exists, null if it does not.",

44987

"type": "Object"

44988

},

44989

"itemtype": "method",

44990

"name": "getSubs",

44991

"static": 1,

44992

"class": "Cookie",

44993

"module": "cookie"

44994

},

44995

{

44996

"file": "cookie/js/Cookie.js",

44997

"line": 337,

44998

"description": "Removes a cookie from the machine by setting its expiration date to\nsometime in the past.",

44999

"params": [

45000

{

45001

"name": "name",

45002

"description": "The name of the cookie to remove.",

45003

"type": "String"

45004

},

45005

{

45006

"name": "options",

45007

"description": "(Optional) An object containing one or more\n cookie options: path (a string), domain (a string), \n and secure (true/false). The expires option will be overwritten\n by the method.",

45008

"type": "Object"

45009

}

45010

],

45011

"return": {

45012

"description": "The created cookie string.",

45013

"type": "String"

45014

},

45015

"itemtype": "method",

45016

"name": "remove",

45017

"static": 1,

45018

"class": "Cookie",

45019

"module": "cookie"

45020

},

45021

{

45022

"file": "cookie/js/Cookie.js",

45023

"line": 362,

45024

"description": "Removes a sub cookie with a given name.",

45025

"params": [

45026

{

45027

"name": "name",

45028

"description": "The name of the cookie in which the subcookie exists.",

45029

"type": "String"

45030

},

45031

{

45032

"name": "subName",

45033

"description": "The name of the subcookie to remove.",

45034

"type": "String"

45035

},

45036

{

45037

"name": "options",

45038

"description": "(Optional) An object containing one or more\n cookie options: path (a string), domain (a string), expires (a Date object),\n removeIfEmpty (true/false), and secure (true/false). This must be the same\n settings as the original subcookie.",

45039

"type": "Object"

45040

}

45041

],

45042

"return": {

45043

"description": "The created cookie string.",

45044

"type": "String"

45045

},

45046

"itemtype": "method",

45047

"name": "removeSub",

45048

"static": 1,

45049

"class": "Cookie",

45050

"module": "cookie"

45051

},

45052

{

45053

"file": "cookie/js/Cookie.js",

45054

"line": 409,

45055

"description": "Sets a cookie with a given name and value.",

45056

"params": [

45057

{

45058

"name": "name",

45059

"description": "The name of the cookie to set.",

45060

"type": "String"

45061

},

45062

{

45063

"name": "value",

45064

"description": "The value to set for the cookie.",

45065

"type": "Variant"

45066

},

45067

{

45068

"name": "options",

45069

"description": "(Optional) An object containing one or more\n cookie options: path (a string), domain (a string), expires (a Date object),\n secure (true/false), and raw (true/false). Setting raw to true indicates\n that the cookie should not be URI encoded before being set.",

45070

"type": "Object"

45071

}

45072

],

45073

"return": {

45074

"description": "The created cookie string.",

45075

"type": "String"

45076

},

45077

"itemtype": "method",

45078

"name": "set",

45079

"static": 1,

45080

"class": "Cookie",

45081

"module": "cookie"

45082

},

45083

{

45084

"file": "cookie/js/Cookie.js",

45085

"line": 436,

45086

"description": "Sets a sub cookie with a given name to a particular value.",

45087

"params": [

45088

{

45089

"name": "name",

45090

"description": "The name of the cookie to set.",

45091

"type": "String"

45092

},

45093

{

45094

"name": "subName",

45095

"description": "The name of the subcookie to set.",

45096

"type": "String"

45097

},

45098

{

45099

"name": "value",

45100

"description": "The value to set.",

45101

"type": "Variant"

45102

},

45103

{

45104

"name": "options",

45105

"description": "(Optional) An object containing one or more\n cookie options: path (a string), domain (a string), expires (a Date object),\n and secure (true/false).",

45106

"type": "Object"

45107

}

45108

],

45109

"return": {

45110

"description": "The created cookie string.",

45111

"type": "String"

45112

},

45113

"itemtype": "method",

45114

"name": "setSub",

45115

"static": 1,

45116

"class": "Cookie",

45117

"module": "cookie"

45118

},

45119

{

45120

"file": "cookie/js/Cookie.js",

45121

"line": 470,

45122

"description": "Sets a cookie with a given name to contain a hash of name-value pairs.",

45123

"params": [

45124

{

45125

"name": "name",

45126

"description": "The name of the cookie to set.",

45127

"type": "String"

45128

},

45129

{

45130

"name": "value",

45131

"description": "An object containing name-value pairs.",

45132

"type": "Object"

45133

},

45134

{

45135

"name": "options",

45136

"description": "(Optional) An object containing one or more\n cookie options: path (a string), domain (a string), expires (a Date object),\n and secure (true/false).",

45137

"type": "Object"

45138

}

45139

],

45140

"return": {

45141

"description": "The created cookie string.",

45142

"type": "String"

45143

},

45144

"itemtype": "method",

45145

"name": "setSubs",

45146

"static": 1,

45147

"class": "Cookie",

45148

"module": "cookie"

45149

},

45150

{

45151

"file": "dataschema/js/dataschema-array.js",

45152

"line": 29,

45153

"description": "Applies a schema to an array of data, returning a normalized object\nwith results in the `results` property. The `meta` property of the\nresponse object is present for consistency, but is assigned an empty\nobject. If the input data is absent or not an array, an `error`\nproperty will be added.\n\nThe input array is expected to contain objects, arrays, or strings.\n\nIf _schema_ is not specified or _schema.resultFields_ is not an array,\n`response.results` will be assigned the input array unchanged.\n\nWhen a _schema_ is specified, the following will occur:\n\nIf the input array contains strings, they will be copied as-is into the\n`response.results` array.\n\nIf the input array contains arrays, `response.results` will contain an\narray of objects with key:value pairs assuming the fields in\n_schema.resultFields_ are ordered in accordance with the data array\nvalues.\n\nIf the input array contains objects, the identified\n_schema.resultFields_ will be used to extract a value from those\nobjects for the output result.\n\n_schema.resultFields_ field identifiers are objects with the following properties:\n\n * `key` : (required) The locator name (String)\n * `parser`: A function or the name of a function on `Y.Parsers` used\n to convert the input value into a normalized type. Parser\n functions are passed the value as input and are expected to\n return a value.\n\nIf no value parsing is needed, you can use strings as identifiers\ninstead of objects (see example below).",

45154

"example": [

45155

"\n // Process array of arrays\n var schema = { resultFields: [ 'fruit', 'color' ] },\n data = [\n [ 'Banana', 'yellow' ],\n [ 'Orange', 'orange' ],\n [ 'Eggplant', 'purple' ]\n ];\n\n var response = Y.DataSchema.Array.apply(schema, data);\n\n // response.results[0] is { fruit: \"Banana\", color: \"yellow\" }\n\n \n // Process array of objects\n data = [\n { fruit: 'Banana', color: 'yellow', price: '1.96' },\n { fruit: 'Orange', color: 'orange', price: '2.04' },\n { fruit: 'Eggplant', color: 'purple', price: '4.31' }\n ];\n\n response = Y.DataSchema.Array.apply(schema, data);\n\n // response.results[0] is { fruit: \"Banana\", color: \"yellow\" }\n\n\n // Use parsers\n schema.resultFields = [\n {\n key: 'fruit',\n parser: function (val) { return val.toUpperCase(); }\n },\n {\n key: 'price',\n parser: 'number' // Uses Y.Parsers.number\n }\n ];\n\n response = Y.DataSchema.Array.apply(schema, data);\n\n // Note price was converted from a numeric string to a number\n // response.results[0] looks like { fruit: \"BANANA\", price: 1.96 }"

45156

],

45157

"itemtype": "method",

45158

"name": "apply",

45159

"params": [

45160

{

45161

"name": "schema",

45162

"description": "Schema to apply. Supported configuration\n properties are:",

45163

"type": "Object",

45164

"optional": true,

45165

"props": [

45166

{

45167

"name": "resultFields",

45168

"description": "Field identifiers to\n locate/assign values in the response records. See above for\n details.",

45169

"type": "Array",

45170

"optional": true

45171

}

45172

]

45173

},

45174

{

45175

"name": "data",

45176

"description": "Array data.",

45177

"type": "Array"

45178

}

45179

],

45180

"return": {

45181

"description": "An Object with properties `results` and `meta`",

45182

"type": "Object"

45183

},

45184

"static": 1,

45185

"class": "DataSchema.Array",

45186

"module": "dataschema",

45187

"submodule": "dataschema-array"

45188

},

45189

{

45190

"file": "dataschema/js/dataschema-array.js",

45191

"line": 141,

45192

"description": "Schema-parsed list of results from full data",

45193

"itemtype": "method",

45194

"name": "_parseResults",

45195

"params": [

45196

{

45197

"name": "fields",

45198

"description": "Schema to parse against.",

45199

"type": "Array"

45200

},

45201

{

45202

"name": "array_in",

45203

"description": "Array to parse.",

45204

"type": "Array"

45205

},

45206

{

45207

"name": "data_out",

45208

"description": "In-progress parsed data to update.",

45209

"type": "Object"

45210

}

45211

],

45212

"return": {

45213

"description": "Parsed data object.",

45214

"type": "Object"

45215

},

45216

"static": 1,

45217

"access": "protected",

45218

"tagname": "",

45219

"class": "DataSchema.Array",

45220

"module": "dataschema",

45221

"submodule": "dataschema-array"

45222

},

45223

{

45224

"file": "dataschema/js/dataschema-base.js",

45225

"line": 25,

45226

"description": "Overridable method returns data as-is.",

45227

"itemtype": "method",

45228

"name": "apply",

45229

"params": [

45230

{

45231

"name": "schema",

45232

"description": "Schema to apply.",

45233

"type": "Object"

45234

},

45235

{

45236

"name": "data",

45237

"description": "Data.",

45238

"type": "Object"

45239

}

45240

],

45241

"return": {

45242

"description": "Schema-parsed data.",

45243

"type": "Object"

45244

},

45245

"static": 1,

45246

"class": "DataSchema.Base",

45247

"module": "dataschema",

45248

"submodule": "dataschema-base"

45249

},

45250

{

45251

"file": "dataschema/js/dataschema-base.js",

45252

"line": 38,

45253

"description": "Applies field parser, if defined",

45254

"itemtype": "method",

45255

"name": "parse",

45256

"params": [

45257

{

45258

"name": "value",

45259

"description": "Original value.",

45260

"type": "Object"

45261

},

45262

{

45263

"name": "field",

45264

"description": "Field.",

45265

"type": "Object"

45266

}

45267

],

45268

"return": {

45269

"description": "Type-converted value.",

45270

"type": "Object"

45271

},

45272

"class": "DataSchema.Base",

45273

"module": "dataschema",

45274

"submodule": "dataschema-base"

45275

},

45276

{

45277

"file": "dataschema/js/dataschema-json.js",

45278

"line": 34,

45279

"description": "Utility function converts JSON locator strings into walkable paths",

45280

"itemtype": "method",

45281

"name": "getPath",

45282

"params": [

45283

{

45284

"name": "locator",

45285

"description": "JSON value locator.",

45286

"type": "String"

45287

}

45288

],

45289

"return": {

45290

"description": "Walkable path to data value.",

45291

"type": "String[]"

45292

},

45293

"static": 1,

45294

"class": "DataSchema.JSON",

45295

"module": "dataschema",

45296

"submodule": "dataschema-json"

45297

},

45298

{

45299

"file": "dataschema/js/dataschema-json.js",

45300

"line": 78,

45301

"description": "Utility function to walk a path and return the value located there.",

45302

"itemtype": "method",

45303

"name": "getLocationValue",

45304

"params": [

45305

{

45306

"name": "path",

45307

"description": "Locator path.",

45308

"type": "String[]"

45309

},

45310

{

45311

"name": "data",

45312

"description": "Data to traverse.",

45313

"type": "String"

45314

}

45315

],

45316

"return": {

45317

"description": "Data value at location.",

45318

"type": "Object"

45319

},

45320

"static": 1,

45321

"class": "DataSchema.JSON",

45322

"module": "dataschema",

45323

"submodule": "dataschema-json"

45324

},

45325

{

45326

"file": "dataschema/js/dataschema-json.js",

45327

"line": 101,

45328

"description": "Applies a schema to an array of data located in a JSON structure, returning\na normalized object with results in the `results` property. Additional\ninformation can be parsed out of the JSON for inclusion in the `meta`\nproperty of the response object. If an error is encountered during\nprocessing, an `error` property will be added.\n\nThe input _data_ is expected to be an object or array. If it is a string,\nit will be passed through `Y.JSON.parse()`.\n\nIf _data_ contains an array of data records to normalize, specify the\n_schema.resultListLocator_ as a dot separated path string just as you would\nreference it in JavaScript. So if your _data_ object has a record array at\n_data.response.results_, use _schema.resultListLocator_ =\n\"response.results\". Bracket notation can also be used for array indices or\nobject properties (e.g. \"response['results']\"); This is called a \"path\nlocator\"\n\nField data in the result list is extracted with field identifiers in\n_schema.resultFields_. Field identifiers are objects with the following\nproperties:\n\n * `key` : (required) The path locator (String)\n * `parser`: A function or the name of a function on `Y.Parsers` used\n to convert the input value into a normalized type. Parser\n functions are passed the value as input and are expected to\n return a value.\n\nIf no value parsing is needed, you can use path locators (strings) \ninstead of field identifiers (objects) -- see example below.\n\nIf no processing of the result list array is needed, _schema.resultFields_\ncan be omitted; the `response.results` will point directly to the array.\n\nIf the result list contains arrays, `response.results` will contain an\narray of objects with key:value pairs assuming the fields in\n_schema.resultFields_ are ordered in accordance with the data array\nvalues.\n\nIf the result list contains objects, the identified _schema.resultFields_\nwill be used to extract a value from those objects for the output result.\n\nTo extract additional information from the JSON, include an array of\npath locators in _schema.metaFields_. The collected values will be\nstored in `response.meta`.",

45329

"example": [

45330

"\n // Process array of arrays\n var schema = {\n resultListLocator: 'produce.fruit',\n resultFields: [ 'name', 'color' ]\n },\n data = {\n produce: {\n fruit: [\n [ 'Banana', 'yellow' ],\n [ 'Orange', 'orange' ],\n [ 'Eggplant', 'purple' ]\n ]\n }\n };\n\n var response = Y.DataSchema.JSON.apply(schema, data);\n\n // response.results[0] is { name: \"Banana\", color: \"yellow\" }\n\n \n // Process array of objects + some metadata\n schema.metaFields = [ 'lastInventory' ];\n\n data = {\n produce: {\n fruit: [\n { name: 'Banana', color: 'yellow', price: '1.96' },\n { name: 'Orange', color: 'orange', price: '2.04' },\n { name: 'Eggplant', color: 'purple', price: '4.31' }\n ]\n },\n lastInventory: '2011-07-19'\n };\n\n response = Y.DataSchema.JSON.apply(schema, data);\n\n // response.results[0] is { name: \"Banana\", color: \"yellow\" }\n // response.meta.lastInventory is '2001-07-19'\n\n\n // Use parsers\n schema.resultFields = [\n {\n key: 'name',\n parser: function (val) { return val.toUpperCase(); }\n },\n {\n key: 'price',\n parser: 'number' // Uses Y.Parsers.number\n }\n ];\n\n response = Y.DataSchema.JSON.apply(schema, data);\n\n // Note price was converted from a numeric string to a number\n // response.results[0] looks like { fruit: \"BANANA\", price: 1.96 }"

45331

],

45332

"itemtype": "method",

45333

"name": "apply",

45334

"params": [

45335

{

45336

"name": "schema",

45337

"description": "Schema to apply. Supported configuration\n properties are:",

45338

"type": "Object",

45339

"optional": true,

45340

"props": [

45341

{

45342

"name": "resultListLocator",

45343

"description": "Path locator for the\n location of the array of records to flatten into `response.results`",

45344

"type": "String",

45345

"optional": true

45346

},

45347

{

45348

"name": "resultFields",

45349

"description": "Field identifiers to\n locate/assign values in the response records. See above for\n details.",

45350

"type": "Array",

45351

"optional": true

45352

},

45353

{

45354

"name": "metaFields",

45355

"description": "Path locators to extract extra\n non-record related information from the data object.",

45356

"type": "Array",

45357

"optional": true

45358

}

45359

]

45360

},

45361

{

45362

"name": "data",

45363

"description": "JSON data or its string serialization.",

45364

"type": "Object|Array|String"

45365

}

45366

],

45367

"return": {

45368

"description": "An Object with properties `results` and `meta`",

45369

"type": "Object"

45370

},

45371

"static": 1,

45372

"class": "DataSchema.JSON",

45373

"module": "dataschema",

45374

"submodule": "dataschema-json"

45375

},

45376

{

45377

"file": "dataschema/js/dataschema-json.js",

45378

"line": 252,

45379

"description": "Schema-parsed list of results from full data",

45380

"itemtype": "method",

45381

"name": "_parseResults",

45382

"params": [

45383

{

45384

"name": "schema",

45385

"description": "Schema to parse against.",

45386

"type": "Object"

45387

},

45388

{

45389

"name": "json_in",

45390

"description": "JSON to parse.",

45391

"type": "Object"

45392

},

45393

{

45394

"name": "data_out",

45395

"description": "In-progress parsed data to update.",

45396

"type": "Object"

45397

}

45398

],

45399

"return": {

45400

"description": "Parsed data object.",

45401

"type": "Object"

45402

},

45403

"static": 1,

45404

"access": "protected",

45405

"tagname": "",

45406

"class": "DataSchema.JSON",

45407

"module": "dataschema",

45408

"submodule": "dataschema-json"

45409

},

45410

{

45411

"file": "dataschema/js/dataschema-json.js",

45412

"line": 293,

45413

"description": "Get field data values out of list of full results",

45414

"itemtype": "method",

45415

"name": "_getFieldValues",

45416

"params": [

45417

{

45418

"name": "fields",

45419

"description": "Fields to find.",

45420

"type": "Array"

45421

},

45422

{

45423

"name": "array_in",

45424

"description": "Results to parse.",

45425

"type": "Array"

45426

},

45427

{

45428

"name": "data_out",

45429

"description": "In-progress parsed data to update.",

45430

"type": "Object"

45431

}

45432

],

45433

"return": {

45434

"description": "Parsed data object.",

45435

"type": "Object"

45436

},

45437

"static": 1,

45438

"access": "protected",

45439

"tagname": "",

45440

"class": "DataSchema.JSON",

45441

"module": "dataschema",

45442

"submodule": "dataschema-json"

45443

},

45444

{

45445

"file": "dataschema/js/dataschema-json.js",

45446

"line": 407,

45447

"description": "Parses results data according to schema",

45448

"itemtype": "method",

45449

"name": "_parseMeta",

45450

"params": [

45451

{

45452

"name": "metaFields",

45453

"description": "Metafields definitions.",

45454

"type": "Object"

45455

},

45456

{

45457

"name": "json_in",

45458

"description": "JSON to parse.",

45459

"type": "Object"

45460

},

45461

{

45462

"name": "data_out",

45463

"description": "In-progress parsed data to update.",

45464

"type": "Object"

45465

}

45466

],

45467

"return": {

45468

"description": "Schema-parsed meta data.",

45469

"type": "Object"

45470

},

45471

"static": 1,

45472

"access": "protected",

45473

"tagname": "",

45474

"class": "DataSchema.JSON",

45475

"module": "dataschema",

45476

"submodule": "dataschema-json"

45477

},

45478

{

45479

"file": "dataschema/js/dataschema-text.js",

45480

"line": 31,

45481

"description": "Applies a schema to a string of delimited data, returning a normalized\nobject with results in the `results` property. The `meta` property of\nthe response object is present for consistency, but is assigned an\nempty object. If the input data is absent or not a string, an `error`\nproperty will be added.\n\nUse _schema.resultDelimiter_ and _schema.fieldDelimiter_ to instruct\n`apply` how to split up the string into an array of data arrays for\nprocessing.\n\nUse _schema.resultFields_ to specify the keys in the generated result\nobjects in `response.results`. The key:value pairs will be assigned\nin the order of the _schema.resultFields_ array, assuming the values\nin the data records are defined in the same order.\n\n_schema.resultFields_ field identifiers are objects with the following\nproperties:\n\n * `key` : (required) The property name you want\n the data value assigned to in the result object (String)\n * `parser`: A function or the name of a function on `Y.Parsers` used\n to convert the input value into a normalized type. Parser\n functions are passed the value as input and are expected to\n return a value.\n\nIf no value parsing is needed, you can use just the desired property\nname string as the field identifier instead of an object (see example\nbelow).",

45482

"example": [

45483

"\n // Process simple csv\n var schema = {\n resultDelimiter: \"\\n\",\n fieldDelimiter: \",\",\n resultFields: [ 'fruit', 'color' ]\n },\n data = \"Banana,yellow\\nOrange,orange\\nEggplant,purple\";\n\n var response = Y.DataSchema.Text.apply(schema, data);\n\n // response.results[0] is { fruit: \"Banana\", color: \"yellow\" }\n\n\n // Use parsers\n schema.resultFields = [\n {\n key: 'fruit',\n parser: function (val) { return val.toUpperCase(); }\n },\n 'color' // mix and match objects and strings\n ];\n\n response = Y.DataSchema.Text.apply(schema, data);\n\n // response.results[0] is { fruit: \"BANANA\", color: \"yellow\" }"

45484

],

45485

"itemtype": "method",

45486

"name": "apply",

45487

"params": [

45488

{

45489

"name": "schema",

45490

"description": "Schema to apply. Supported configuration\n properties are:",

45491

"type": "Object",

45492

"props": [

45493

{

45494

"name": "resultDelimiter",

45495

"description": "Character or character\n sequence that marks the end of one record and the start of\n another.",

45496

"type": "String"

45497

},

45498

{

45499

"name": "fieldDelimiter",

45500

"description": "Character or character\n sequence that marks the end of a field and the start of\n another within the same record.",

45501

"type": "String",

45502

"optional": true

45503

},

45504

{

45505

"name": "resultFields",

45506

"description": "Field identifiers to\n assign values in the response records. See above for details.",

45507

"type": "Array",

45508

"optional": true

45509

}

45510

]

45511

},

45512

{

45513

"name": "data",

45514

"description": "Text data.",

45515

"type": "String"

45516

}

45517

],

45518

"return": {

45519

"description": "An Object with properties `results` and `meta`",

45520

"type": "Object"

45521

},

45522

"static": 1,

45523

"class": "DataSchema.Text",

45524

"module": "dataschema",

45525

"submodule": "dataschema-text"

45526

},

45527

{

45528

"file": "dataschema/js/dataschema-text.js",

45529

"line": 118,

45530

"description": "Schema-parsed list of results from full data",

45531

"itemtype": "method",

45532

"name": "_parseResults",

45533

"params": [

45534

{

45535

"name": "schema",

45536

"description": "Schema to parse against.",

45537

"type": "Array"

45538

},

45539

{

45540

"name": "text_in",

45541

"description": "Text to parse.",

45542

"type": "String"

45543

},

45544

{

45545

"name": "data_out",

45546

"description": "In-progress parsed data to update.",

45547

"type": "Object"

45548

}

45549

],

45550

"return": {

45551

"description": "Parsed data object.",

45552

"type": "Object"

45553

},

45554

"static": 1,

45555

"access": "protected",

45556

"tagname": "",

45557

"class": "DataSchema.Text",

45558

"module": "dataschema",

45559

"submodule": "dataschema-text"

45560

},

45561

{

45562

"file": "dataschema/js/dataschema-xml.js",

45563

"line": 34,

45564

"description": "Applies a schema to an XML data tree, returning a normalized object with\nresults in the `results` property. Additional information can be parsed out\nof the XML for inclusion in the `meta` property of the response object. If\nan error is encountered during processing, an `error` property will be\nadded.\n\nField data in the nodes captured by the XPath in _schema.resultListLocator_\nis extracted with the field identifiers described in _schema.resultFields_.\nField identifiers are objects with the following properties:\n\n * `key` : (required) The desired property name to use\n store the retrieved value in the result object. If `locator` is\n not specified, `key` is also used as the XPath locator (String)\n * `locator`: The XPath locator to the node or attribute within each\n result node found by _schema.resultListLocator_ containing the\n desired field data (String)\n * `parser` : A function or the name of a function on `Y.Parsers` used\n to convert the input value into a normalized type. Parser\n functions are passed the value as input and are expected to\n return a value.\n * `schema` : Used to retrieve nested field data into an array for\n assignment as the result field value. This object follows the same\n conventions as _schema_.\n\nIf no value parsing or nested parsing is needed, you can use XPath locators\n(strings) instead of field identifiers (objects) -- see example below.\n\n`response.results` will contain an array of objects with key:value pairs.\nThe keys are the field identifier `key`s, and the values are the data\nvalues extracted from the nodes or attributes found by the field `locator`\n(or `key` fallback).\n\nTo extract additional information from the XML, include an array of\nXPath locators in _schema.metaFields_. The collected values will be\nstored in `response.meta` with the XPath locator as keys.",

45565

"example": [

45566

"\n var schema = {\n resultListLocator: '//produce/item',\n resultFields: [\n {\n locator: 'name',\n key: 'name'\n },\n {\n locator: 'color',\n key: 'color',\n parser: function (val) { return val.toUpperCase(); }\n }\n ]\n };\n\n // Assumes data like\n // <inventory>\n // <produce>\n // <item><name>Banana</name><color>yellow</color></item>\n // <item><name>Orange</name><color>orange</color></item>\n // <item><name>Eggplant</name><color>purple</color></item>\n // </produce>\n // </inventory>\n\n var response = Y.DataSchema.JSON.apply(schema, data);\n\n // response.results[0] is { name: \"Banana\", color: \"YELLOW\" }"

45567

],

45568

"itemtype": "method",

45569

"name": "apply",

45570

"params": [

45571

{

45572

"name": "schema",

45573

"description": "Schema to apply. Supported configuration\n properties are:",

45574

"type": "Object",

45575

"props": [

45576

{

45577

"name": "resultListLocator",

45578

"description": "XPath locator for the\n XML nodes that contain the data to flatten into `response.results`",

45579

"type": "String",

45580

"optional": true

45581

},

45582

{

45583

"name": "resultFields",

45584

"description": "Field identifiers to\n locate/assign values in the response records. See above for\n details.",

45585

"type": "Array",

45586

"optional": true

45587

},

45588

{

45589

"name": "metaFields",

45590

"description": "XPath locators to extract extra\n non-record related information from the XML data",

45591

"type": "Array",

45592

"optional": true

45593

}

45594

]

45595

},

45596

{

45597

"name": "data",

45598

"description": "XML data to parse",

45599

"type": "XMLDoc"

45600

}

45601

],

45602

"return": {

45603

"description": "An Object with properties `results` and `meta`",

45604

"type": "Object"

45605

},

45606

"static": 1,

45607

"class": "DataSchema.XML",

45608

"module": "dataschema",

45609

"submodule": "dataschema-xml"

45610

},

45611

{

45612

"file": "dataschema/js/dataschema-xml.js",

45613

"line": 132,

45614

"description": "Get an XPath-specified value for a given field from an XML node or document.",

45615

"itemtype": "method",

45616

"name": "_getLocationValue",

45617

"params": [

45618

{

45619

"name": "field",

45620

"description": "Field definition.",

45621

"type": "String | Object"

45622

},

45623

{

45624

"name": "context",

45625

"description": "XML node or document to search within.",

45626

"type": "Object"

45627

}

45628

],

45629

"return": {

45630

"description": "Data value or null.",

45631

"type": "Object"

45632

},

45633

"static": 1,

45634

"access": "protected",

45635

"tagname": "",

45636

"class": "DataSchema.XML",

45637

"module": "dataschema",

45638

"submodule": "dataschema-xml"

45639

},

45640

{

45641

"file": "dataschema/js/dataschema-xml.js",

45642

"line": 168,

45643

"description": "Fetches the XPath-specified result for a given location in an XML node\nor document.",

45644

"itemtype": "method",

45645

"name": "_getXPathResult",

45646

"params": [

45647

{

45648

"name": "locator",

45649

"description": "The XPath location.",

45650

"type": "String"

45651

},

45652

{

45653

"name": "context",

45654

"description": "XML node or document to search within.",

45655

"type": "Object"

45656

},

45657

{

45658

"name": "xmldoc",

45659

"description": "XML document to resolve namespace.",

45660

"type": "Object"

45661

}

45662

],

45663

"return": {

45664

"description": "Data collection or null.",

45665

"type": "Object"

45666

},

45667

"static": 1,

45668

"access": "protected",

45669

"tagname": "",

45670

"class": "DataSchema.XML",

45671

"module": "dataschema",

45672

"submodule": "dataschema-xml"

45673

},

45674

{

45675

"file": "dataschema/js/dataschema-xml.js",

45676

"line": 262,

45677

"description": "Schema-parsed result field.",

45678

"itemtype": "method",

45679

"name": "_parseField",

45680

"params": [

45681

{

45682

"name": "field",

45683

"description": "Required. Field definition.",

45684

"type": "String | Object"

45685

},

45686

{

45687

"name": "result",

45688

"description": "Required. Schema parsed data object.",

45689

"type": "Object"

45690

},

45691

{

45692

"name": "context",

45693

"description": "Required. XML node or document to search within.",

45694

"type": "Object"

45695

}

45696

],

45697

"static": 1,

45698

"access": "protected",

45699

"tagname": "",

45700

"class": "DataSchema.XML",

45701

"module": "dataschema",

45702

"submodule": "dataschema-xml"

45703

},

45704

{

45705

"file": "dataschema/js/dataschema-xml.js",

45706

"line": 286,

45707

"description": "Parses results data according to schema",

45708

"itemtype": "method",

45709

"name": "_parseMeta",

45710

"params": [

45711

{

45712

"name": "xmldoc_in",

45713

"description": "XML document parse.",

45714

"type": "Object"

45715

},

45716

{

45717

"name": "data_out",

45718

"description": "In-progress schema-parsed data to update.",

45719

"type": "Object"

45720

}

45721

],

45722

"return": {

45723

"description": "Schema-parsed data.",

45724

"type": "Object"

45725

},

45726

"static": 1,

45727

"access": "protected",

45728

"tagname": "",

45729

"class": "DataSchema.XML",

45730

"module": "dataschema",

45731

"submodule": "dataschema-xml"

45732

},

45733

{

45734

"file": "dataschema/js/dataschema-xml.js",

45735

"line": 310,

45736

"description": "Schema-parsed result to add to results list.",

45737

"itemtype": "method",

45738

"name": "_parseResult",

45739

"params": [

45740

{

45741

"name": "fields",

45742

"description": "Required. A collection of field definition.",

45743

"type": "Array"

45744

},

45745

{

45746

"name": "context",

45747

"description": "Required. XML node or document to search within.",

45748

"type": "Object"

45749

}

45750

],

45751

"return": {

45752

"description": "Schema-parsed data.",

45753

"type": "Object"

45754

},

45755

"static": 1,

45756

"access": "protected",

45757

"tagname": "",

45758

"class": "DataSchema.XML",

45759

"module": "dataschema",

45760

"submodule": "dataschema-xml"

45761

},

45762

{

45763

"file": "dataschema/js/dataschema-xml.js",

45764

"line": 331,

45765

"description": "Schema-parsed list of results from full data",

45766

"itemtype": "method",

45767

"name": "_parseResults",

45768

"params": [

45769

{

45770

"name": "schema",

45771

"description": "Schema to parse against.",

45772

"type": "Object"

45773

},

45774

{

45775

"name": "context",

45776

"description": "XML node or document to parse.",

45777

"type": "Object"

45778

},

45779

{

45780

"name": "data_out",

45781

"description": "In-progress schema-parsed data to update.",

45782

"type": "Object"

45783

}

45784

],

45785

"return": {

45786

"description": "Schema-parsed data.",

45787

"type": "Object"

45788

},

45789

"static": 1,

45790

"access": "protected",

45791

"tagname": "",

45792

"class": "DataSchema.XML",

45793

"module": "dataschema",

45794

"submodule": "dataschema-xml"

45795

},

45796

{

45797

"file": "datasource/js/datasource-arrayschema.js",

45798

"line": 18,

45799

"description": "The namespace for the plugin. This will be the property on the host which\nreferences the plugin instance.",

45800

"itemtype": "property",

45801

"name": "NS",

45802

"type": "String",

45803

"static": 1,

45804

"final": 1,

45805

"value": "\"schema\"",

45806

"class": "DataSourceArraySchema",

45807

"module": "datasource",

45808

"submodule": "datasource-arrayschema"

45809

},

45810

{

45811

"file": "datasource/js/datasource-arrayschema.js",

45812

"line": 30,

45813

"description": "Class name.",

45814

"itemtype": "property",

45815

"name": "NAME",

45816

"type": "String",

45817

"static": 1,

45818

"final": 1,

45819

"value": "\"dataSourceArraySchema\"",

45820

"class": "DataSourceArraySchema",

45821

"module": "datasource",

45822

"submodule": "datasource-arrayschema"

45823

},

45824

{

45825

"file": "datasource/js/datasource-arrayschema.js",

45826

"line": 55,

45827

"description": "Internal init() handler.",

45828

"itemtype": "method",

45829

"name": "initializer",

45830

"params": [

45831

{

45832

"name": "config",

45833

"description": "Config object.",

45834

"type": "Object"

45835

}

45836

],

45837

"access": "private",

45838

"tagname": "",

45839

"class": "DataSourceArraySchema",

45840

"module": "datasource",

45841

"submodule": "datasource-arrayschema"

45842

},

45843

{

45844

"file": "datasource/js/datasource-arrayschema.js",

45845

"line": 66,

45846

"description": "Parses raw data into a normalized response.",

45847

"itemtype": "method",

45848

"name": "_beforeDefDataFn",

45849

"params": [

45850

{

45851

"name": "tId",

45852

"description": "Unique transaction ID.",

45853

"type": "Number"

45854

},

45855

{

45856

"name": "request",

45857

"description": "The request.",

45858

"type": "Object"

45859

},

45860

{

45861

"name": "callback",

45862

"description": "The callback object with the following properties:\n <dl>\n <dt>success (Function)</dt> <dd>Success handler.</dd>\n <dt>failure (Function)</dt> <dd>Failure handler.</dd>\n </dl>",

45863

"type": "Object"

45864

},

45865

{

45866

"name": "data",

45867

"description": "Raw data.",

45868

"type": "Object"

45869

}

45870

],

45871

"access": "protected",

45872

"tagname": "",

45873

"class": "DataSourceArraySchema",

45874

"module": "datasource",

45875

"submodule": "datasource-arrayschema"

45876

},

45877

{

45878

"file": "datasource/js/datasource-cache.js",

45879

"line": 16,

45880

"description": "The namespace for the plugin. This will be the property on the host which\nreferences the plugin instance.",

45881

"itemtype": "property",

45882

"name": "NS",

45883

"type": "String",

45884

"static": 1,

45885

"final": 1,

45886

"value": "\"cache\"",

45887

"class": "DataSourceCacheExtension",

45888

"module": "datasource",

45889

"submodule": "datasource-cache"

45890

},

45891

{

45892

"file": "datasource/js/datasource-cache.js",

45893

"line": 28,

45894

"description": "Class name.",

45895

"itemtype": "property",

45896

"name": "NAME",

45897

"type": "String",

45898

"static": 1,

45899

"final": 1,

45900

"value": "\"dataSourceCacheExtension\"",

45901

"class": "DataSourceCacheExtension",

45902

"module": "datasource",

45903

"submodule": "datasource-cache"

45904

},

45905

{

45906

"file": "datasource/js/datasource-cache.js",

45907

"line": 41,

45908

"description": "Internal init() handler.",

45909

"itemtype": "method",

45910

"name": "initializer",

45911

"params": [

45912

{

45913

"name": "config",

45914

"description": "Config object.",

45915

"type": "Object"

45916

}

45917

],

45918

"access": "private",

45919

"tagname": "",

45920

"class": "DataSourceCacheExtension",

45921

"module": "datasource",

45922

"submodule": "datasource-cache"

45923

},

45924

{

45925

"file": "datasource/js/datasource-cache.js",

45926

"line": 53,

45927

"description": "First look for cached response, then send request to live data.",

45928

"itemtype": "method",

45929

"name": "_beforeDefRequestFn",

45930

"params": [

45931

{

45932

"name": "e",

45933

"description": "Event Facade with the following properties:\n<dl>\n<dt>tId (Number)</dt> <dd>Unique transaction ID.</dd>\n<dt>request (Object)</dt> <dd>The request.</dd>\n<dt>callback (Object)</dt> <dd>The callback object.</dd>\n<dt>cfg (Object)</dt> <dd>Configuration object.</dd>\n</dl>",

45934

"type": "Event.Facade"

45935

}

45936

],

45937

"access": "protected",

45938

"tagname": "",

45939

"class": "DataSourceCacheExtension",

45940

"module": "datasource",

45941

"submodule": "datasource-cache"

45942

},

45943

{

45944

"file": "datasource/js/datasource-cache.js",

45945

"line": 82,

45946

"description": "Adds data to cache before returning data.",

45947

"itemtype": "method",

45948

"name": "_beforeDefResponseFn",

45949

"params": [

45950

{

45951

"name": "e",

45952

"description": "Event Facade with the following properties:\n<dl>\n<dt>tId (Number)</dt> <dd>Unique transaction ID.</dd>\n<dt>request (Object)</dt> <dd>The request.</dd>\n<dt>callback (Object)</dt> <dd>The callback object with the following properties:\n <dl>\n <dt>success (Function)</dt> <dd>Success handler.</dd>\n <dt>failure (Function)</dt> <dd>Failure handler.</dd>\n </dl>\n</dd>\n<dt>data (Object)</dt> <dd>Raw data.</dd>\n<dt>response (Object)</dt> <dd>Normalized response object with the following properties:\n <dl>\n <dt>cached (Object)</dt> <dd>True when response is cached.</dd>\n <dt>results (Object)</dt> <dd>Parsed results.</dd>\n <dt>meta (Object)</dt> <dd>Parsed meta data.</dd>\n <dt>error (Object)</dt> <dd>Error object.</dd>\n </dl>\n</dd>\n<dt>cfg (Object)</dt> <dd>Configuration object.</dd>\n</dl>",

45953

"type": "Event.Facade"

45954

}

45955

],

45956

"access": "protected",

45957

"tagname": "",

45958

"class": "DataSourceCacheExtension",

45959

"module": "datasource",

45960

"submodule": "datasource-cache"

45961

},

45962

{

45963

"file": "datasource/js/datasource-cache.js",

45964

"line": 136,

45965

"description": "The namespace for the plugin. This will be the property on the host which\nreferences the plugin instance.",

45966

"itemtype": "property",

45967

"name": "NS",

45968

"type": "String",

45969

"static": 1,

45970

"final": 1,

45971

"value": "\"cache\"",

45972

"class": "DataSourceCache",

45973

"module": "datasource",

45974

"submodule": "datasource-cache"

45975

},

45976

{

45977

"file": "datasource/js/datasource-cache.js",

45978

"line": 148,

45979

"description": "Class name.",

45980

"itemtype": "property",

45981

"name": "NAME",

45982

"type": "String",

45983

"static": 1,

45984

"final": 1,

45985

"value": "\"dataSourceCache\"",

45986

"class": "DataSourceCache",

45987

"module": "datasource",

45988

"submodule": "datasource-cache"

45989

},

45990

{

45991

"file": "datasource/js/datasource-function.js",

45992

"line": 27,

45993

"description": "Class name.",

45994

"itemtype": "property",

45995

"name": "NAME",

45996

"type": "String",

45997

"static": 1,

45998

"final": 1,

45999

"value": "\"dataSourceFunction\"",

46000

"class": "DataSource.Function",

46001

"module": "datasource",

46002

"submodule": "datasource-function"

46003

},

46004

{

46005

"file": "datasource/js/datasource-function.js",

46006

"line": 46,

46007

"itemtype": "attribute",

46008

"name": "source",

46009

"description": "Pointer to live data.",

46010

"type": "MIXED",

46011

"default": "null",

46012

"class": "DataSource.Function",

46013

"module": "datasource",

46014

"submodule": "datasource-function"

46015

},

46016

{

46017

"file": "datasource/js/datasource-function.js",

46018

"line": 59,

46019

"description": "Passes query string to IO. Fires <code>response</code> event when\nresponse is received asynchronously.",

46020

"itemtype": "method",

46021

"name": "_defRequestFn",

46022

"params": [

46023

{

46024

"name": "e",

46025

"description": "Event Facade with the following properties:\n<dl>\n<dt>tId (Number)</dt> <dd>Unique transaction ID.</dd>\n<dt>request (Object)</dt> <dd>The request.</dd>\n<dt>callback (Object)</dt> <dd>The callback object with the following properties:\n <dl>\n <dt>success (Function)</dt> <dd>Success handler.</dd>\n <dt>failure (Function)</dt> <dd>Failure handler.</dd>\n </dl>\n</dd>\n<dt>cfg (Object)</dt> <dd>Configuration object.</dd>\n</dl>",

46026

"type": "Event.Facade"

46027

}

46028

],

46029

"access": "protected",

46030

"tagname": "",

46031

"class": "DataSource.Function",

46032

"module": "datasource",

46033

"submodule": "datasource-function"

46034

},

46035

{

46036

"file": "datasource/js/datasource-get.js",

46037

"line": 20,

46038

"description": "Passes query string to Get Utility. Fires <code>response</code> event when\nresponse is received asynchronously.",

46039

"itemtype": "method",

46040

"name": "_defRequestFn",

46041

"params": [

46042

{

46043

"name": "e",

46044

"description": "Event Facade with the following properties:\n<dl>\n<dt>tId (Number)</dt> <dd>Unique transaction ID.</dd>\n<dt>request (Object)</dt> <dd>The request.</dd>\n<dt>callback (Object)</dt> <dd>The callback object with the following properties:\n <dl>\n <dt>success (Function)</dt> <dd>Success handler.</dd>\n <dt>failure (Function)</dt> <dd>Failure handler.</dd>\n </dl>\n</dd>\n<dt>cfg (Object)</dt> <dd>Configuration object.</dd>\n</dl>",

46045

"type": "Event.Facade"

46046

}

46047

],

46048

"access": "protected",

46049

"tagname": "",

46050

"class": "DataSource.Get",

46051

"module": "datasource",

46052

"submodule": "datasource-get"

46053

},

46054

{

46055

"file": "datasource/js/datasource-get.js",

46056

"line": 47,

46057

"description": "Stores the most recent request id for validation against stale\nresponse handling.",

46058

"itemtype": "property",

46059

"name": "_last",

46060

"type": "{String}",

46061

"access": "protected",

46062

"tagname": "",

46063

"class": "DataSource.Get",

46064

"module": "datasource",

46065

"submodule": "datasource-get"

46066

},

46067

{

46068

"file": "datasource/js/datasource-get.js",

46069

"line": 110,

46070

"description": "Default method for adding callback param to url. See\ngenerateRequestCallback attribute.",

46071

"itemtype": "method",

46072

"name": "_generateRequest",

46073

"params": [

46074

{

46075

"name": "guid",

46076

"description": "unique identifier for callback function wrapper",

46077

"type": "String"

46078

}

46079

],

46080

"access": "protected",

46081

"tagname": "",

46082

"class": "DataSource.Get",

46083

"module": "datasource",

46084

"submodule": "datasource-get"

46085

},

46086

{

46087

"file": "datasource/js/datasource-get.js",

46088

"line": 125,

46089

"description": "Class name.",

46090

"itemtype": "property",

46091

"name": "NAME",

46092

"type": "String",

46093

"static": 1,

46094

"final": 1,

46095

"value": "\"dataSourceGet\"",

46096

"class": "DataSource.Get",

46097

"module": "datasource",

46098

"submodule": "datasource-get"

46099

},

46100

{

46101

"file": "datasource/js/datasource-get.js",

46102

"line": 143,

46103

"description": "Pointer to Get Utility.",

46104

"itemtype": "attribute",

46105

"name": "get",

46106

"type": "Y.Get",

46107

"default": "Y.Get",

46108

"class": "DataSource.Get",

46109

"module": "datasource",

46110

"submodule": "datasource-get"

46111

},

46112

{

46113

"file": "datasource/js/datasource-get.js",

46114

"line": 155,

46115

"description": "Defines request/response management in the following manner:\n<dl>\n \n <dt>ignoreStaleResponses</dt>\n <dd>Send all requests, but handle only the response for the most\n recently sent request.</dd>\n <dt>allowAll</dt>\n <dd>Send all requests and handle all responses.</dd>\n</dl>",

46116

"itemtype": "attribute",

46117

"name": "asyncMode",

46118

"type": "String",

46119

"default": "\"allowAll\"",

46120

"class": "DataSource.Get",

46121

"module": "datasource",

46122

"submodule": "datasource-get"

46123

},

46124

{

46125

"file": "datasource/js/datasource-get.js",

46126

"line": 179,

46127

"description": "Callback string parameter name sent to the remote script. By default,\nrequests are sent to\n<URI>?<scriptCallbackParam>=callbackFunction",

46128

"itemtype": "attribute",

46129

"name": "scriptCallbackParam",

46130

"type": "String",

46131

"default": "\"callback\"",

46132

"class": "DataSource.Get",

46133

"module": "datasource",

46134

"submodule": "datasource-get"

46135

},

46136

{

46137

"file": "datasource/js/datasource-get.js",

46138

"line": 192,

46139

"description": "Accepts the DataSource instance and a callback ID, and returns a callback\nparam/value string that gets appended to the script URI. Implementers\ncan customize this string to match their server's query syntax.",

46140

"itemtype": "attribute",

46141

"name": "generateRequestCallback",

46142

"type": "Function",

46143

"class": "DataSource.Get",

46144

"module": "datasource",

46145

"submodule": "datasource-get"

46146

},

46147

{

46148

"file": "datasource/js/datasource-io.js",

46149

"line": 25,

46150

"description": "Class name.",

46151

"itemtype": "property",

46152

"name": "NAME",

46153

"type": "String",

46154

"static": 1,

46155

"final": 1,

46156

"value": "\"dataSourceIO\"",

46157

"class": "DataSource.IO",

46158

"module": "datasource",

46159

"submodule": "datasource-io"

46160

},

46161

{

46162

"file": "datasource/js/datasource-io.js",

46163

"line": 44,

46164

"description": "Pointer to IO Utility.",

46165

"itemtype": "attribute",

46166

"name": "io",

46167

"type": "Y.io",

46168

"default": "Y.io",

46169

"class": "DataSource.IO",

46170

"module": "datasource",

46171

"submodule": "datasource-io"

46172

},

46173

{

46174

"file": "datasource/js/datasource-io.js",

46175

"line": 56,

46176

"description": "Default IO Config.",

46177

"itemtype": "attribute",

46178

"name": "ioConfig",

46179

"type": "Object",

46180

"default": "null",

46181

"class": "DataSource.IO",

46182

"module": "datasource",

46183

"submodule": "datasource-io"

46184

},

46185

{

46186

"file": "datasource/js/datasource-io.js",

46187

"line": 70,

46188

"description": "Internal init() handler.",

46189

"itemtype": "method",

46190

"name": "initializer",

46191

"params": [

46192

{

46193

"name": "config",

46194

"description": "Config object.",

46195

"type": "Object"

46196

}

46197

],

46198

"access": "private",

46199

"tagname": "",

46200

"class": "DataSource.IO",

46201

"module": "datasource",

46202

"submodule": "datasource-io"

46203

},

46204

{

46205

"file": "datasource/js/datasource-io.js",

46206

"line": 81,

46207

"description": "IO success callback.",

46208

"itemtype": "method",

46209

"name": "successHandler",

46210

"params": [

46211

{

46212

"name": "id",

46213

"description": "Transaction ID.",

46214

"type": "String"

46215

},

46216

{

46217

"name": "response",

46218

"description": "Response.",

46219

"type": "String"

46220

},

46221

{

46222

"name": "e",

46223

"description": "Event facade.",

46224

"type": "Event.Facade"

46225

}

46226

],

46227

"access": "private",

46228

"tagname": "",

46229

"class": "DataSource.IO",

46230

"module": "datasource",

46231

"submodule": "datasource-io"

46232

},

46233

{

46234

"file": "datasource/js/datasource-io.js",

46235

"line": 106,

46236

"description": "IO failure callback.",

46237

"itemtype": "method",

46238

"name": "failureHandler",

46239

"params": [

46240

{

46241

"name": "id",

46242

"description": "Transaction ID.",

46243

"type": "String"

46244

},

46245

{

46246

"name": "response",

46247

"description": "Response.",

46248

"type": "String"

46249

},

46250

{

46251

"name": "e",

46252

"description": "Event facade.",

46253

"type": "Event.Facade"

46254

}

46255

],

46256

"access": "private",

46257

"tagname": "",

46258

"class": "DataSource.IO",

46259

"module": "datasource",

46260

"submodule": "datasource-io"

46261

},

46262

{

46263

"file": "datasource/js/datasource-io.js",

46264

"line": 134,

46265

"itemtype": "property",

46266

"name": "_queue",

46267

"description": "Object literal to manage asynchronous request/response\ncycles enabled if queue needs to be managed (asyncMode/ioConnMode):\n<dl>\n <dt>interval {Number}</dt>\n <dd>Interval ID of in-progress queue.</dd>\n <dt>conn</dt>\n <dd>In-progress connection identifier (if applicable).</dd>\n <dt>requests {Object[]}</dt>\n <dd>Array of queued request objects: {request:request, callback:callback}.</dd>\n</dl>",

46268

"type": "Object",

46269

"default": "{interval:null, conn:null, requests:[]}",

46270

"access": "private",

46271

"tagname": "",

46272

"class": "DataSource.IO",

46273

"module": "datasource",

46274

"submodule": "datasource-io"

46275

},

46276

{

46277

"file": "datasource/js/datasource-io.js",

46278

"line": 152,

46279

"description": "Passes query string to IO. Fires <code>response</code> event when\nresponse is received asynchronously.",

46280

"itemtype": "method",

46281

"name": "_defRequestFn",

46282

"params": [

46283

{

46284

"name": "e",

46285

"description": "Event Facade with the following properties:\n<dl>\n<dt>tId (Number)</dt> <dd>Unique transaction ID.</dd>\n<dt>request (Object)</dt> <dd>The request.</dd>\n<dt>callback (Object)</dt> <dd>The callback object with the following properties:\n <dl>\n <dt>success (Function)</dt> <dd>Success handler.</dd>\n <dt>failure (Function)</dt> <dd>Failure handler.</dd>\n </dl>\n</dd>\n<dt>cfg (Object)</dt> <dd>Configuration object.</dd>\n</dl>",

46286

"type": "Event.Facade"

46287

}

46288

],

46289

"access": "protected",

46290

"tagname": "",

46291

"class": "DataSource.IO",

46292

"module": "datasource",

46293

"submodule": "datasource-io"

46294

},

46295

{

46296

"file": "datasource/js/datasource-jsonschema.js",

46297

"line": 18,

46298

"description": "The namespace for the plugin. This will be the property on the host which\nreferences the plugin instance.",

46299

"itemtype": "property",

46300

"name": "NS",

46301

"type": "String",

46302

"static": 1,

46303

"final": 1,

46304

"value": "\"schema\"",

46305

"class": "DataSourceJSONSchema",

46306

"module": "datasource",

46307

"submodule": "datasource-jsonschema"

46308

},

46309

{

46310

"file": "datasource/js/datasource-jsonschema.js",

46311

"line": 30,

46312

"description": "Class name.",

46313

"itemtype": "property",

46314

"name": "NAME",

46315

"type": "String",

46316

"static": 1,

46317

"final": 1,

46318

"value": "\"dataSourceJSONSchema\"",

46319

"class": "DataSourceJSONSchema",

46320

"module": "datasource",

46321

"submodule": "datasource-jsonschema"

46322

},

46323

{

46324

"file": "datasource/js/datasource-jsonschema.js",

46325

"line": 55,

46326

"description": "Internal init() handler.",

46327

"itemtype": "method",

46328

"name": "initializer",

46329

"params": [

46330

{

46331

"name": "config",

46332

"description": "Config object.",

46333

"type": "Object"

46334

}

46335

],

46336

"access": "private",

46337

"tagname": "",

46338

"class": "DataSourceJSONSchema",

46339

"module": "datasource",

46340

"submodule": "datasource-jsonschema"

46341

},

46342

{

46343

"file": "datasource/js/datasource-jsonschema.js",

46344

"line": 66,

46345

"description": "Parses raw data into a normalized response. To accommodate XHR responses,\nwill first look for data in data.responseText. Otherwise will just work\nwith data.",

46346

"itemtype": "method",

46347

"name": "_beforeDefDataFn",

46348

"params": [

46349

{

46350

"name": "tId",

46351

"description": "Unique transaction ID.",

46352

"type": "Number"

46353

},

46354

{

46355

"name": "request",

46356

"description": "The request.",

46357

"type": "Object"

46358

},

46359

{

46360

"name": "callback",

46361

"description": "The callback object with the following properties:\n <dl>\n <dt>success (Function)</dt> <dd>Success handler.</dd>\n <dt>failure (Function)</dt> <dd>Failure handler.</dd>\n </dl>",

46362

"type": "Object"

46363

},

46364

{

46365

"name": "data",

46366

"description": "Raw data.",

46367

"type": "Object"

46368

}

46369

],

46370

"access": "protected",

46371

"tagname": "",

46372

"class": "DataSourceJSONSchema",

46373

"module": "datasource",

46374

"submodule": "datasource-jsonschema"

46375

},

46376

{

46377

"file": "datasource/js/datasource-local.js",

46378

"line": 36,

46379

"description": "Class name.",

46380

"itemtype": "property",

46381

"name": "NAME",

46382

"type": "String",

46383

"static": 1,

46384

"final": 1,

46385

"value": "\"dataSourceLocal\"",

46386

"class": "DataSource.Local",

46387

"module": "datasource",

46388

"submodule": "datasource-local"

46389

},

46390

{

46391

"file": "datasource/js/datasource-local.js",

46392

"line": 54,

46393

"itemtype": "attribute",

46394

"name": "source",

46395

"description": "Pointer to live data.",

46396

"type": "MIXED",

46397

"default": "null",

46398

"class": "DataSource.Local",

46399

"module": "datasource",

46400

"submodule": "datasource-local"

46401

},

46402

{

46403

"file": "datasource/js/datasource-local.js",

46404

"line": 65,

46405

"description": "Global transaction counter.",

46406

"itemtype": "property",

46407

"name": "_tId",

46408

"type": "Number",

46409

"static": 1,

46410

"access": "private",

46411

"tagname": "",

46412

"default": "0",

46413

"class": "DataSource.Local",

46414

"module": "datasource",

46415

"submodule": "datasource-local"

46416

},

46417

{

46418

"file": "datasource/js/datasource-local.js",

46419

"line": 76,

46420

"description": "Global in-progress transaction objects.",

46421

"itemtype": "property",

46422

"name": "transactions",

46423

"type": "Object",

46424

"static": 1,

46425

"class": "DataSource.Local",

46426

"module": "datasource",

46427

"submodule": "datasource-local"

46428

},

46429

{

46430

"file": "datasource/js/datasource-local.js",

46431

"line": 85,

46432

"description": "Returns data to callback.",

46433

"itemtype": "method",

46434

"name": "issueCallback",

46435

"params": [

46436

{

46437

"name": "e",

46438

"description": "Event Facade.",

46439

"type": "EventFacade"

46440

},

46441

{

46442

"name": "caller",

46443

"description": "Calling DataSource instance.",

46444

"type": "DataSource"

46445

}

46446

],

46447

"static": 1,

46448

"class": "DataSource.Local",

46449

"module": "datasource",

46450

"submodule": "datasource-local"

46451

},

46452

{

46453

"file": "datasource/js/datasource-local.js",

46454

"line": 113,

46455

"description": "Internal init() handler.",

46456

"itemtype": "method",

46457

"name": "initializer",

46458

"params": [

46459

{

46460

"name": "config",

46461

"description": "Config object.",

46462

"type": "Object"

46463

}

46464

],

46465

"access": "private",

46466

"tagname": "",

46467

"class": "DataSource.Local",

46468

"module": "datasource",

46469

"submodule": "datasource-local"

46470

},

46471

{

46472

"file": "datasource/js/datasource-local.js",

46473

"line": 124,

46474

"description": "This method creates all the events for this module.",

46475

"itemtype": "method",

46476

"name": "_initEvents",

46477

"access": "private",

46478

"tagname": "",

46479

"class": "DataSource.Local",

46480

"module": "datasource",

46481

"submodule": "datasource-local"

46482

},

46483

{

46484

"file": "datasource/js/datasource-local.js",

46485

"line": 130,

46486

"description": "Fired when a data request is received.",

46487

"itemtype": "event",

46488

"name": "request",

46489

"params": [

46490

{

46491

"name": "e",

46492

"description": "Event Facade with the following properties:\n<dl> \n<dt>tId (Number)</dt> <dd>Unique transaction ID.</dd>\n<dt>request (Object)</dt> <dd>The request.</dd>\n<dt>callback (Object)</dt> <dd>The callback object\n (deprecated, refer to on</dd>\n<dt>on (Object)</dt> <dd>The map of configured callback\n functions.</dd>\n<dt>cfg (Object)</dt> <dd>Configuration object.</dd>\n</dl>",

46493

"type": "Event.Facade"

46494

}

46495

],

46496

"preventable": "_defRequestFn",

46497

"class": "DataSource.Local",

46498

"module": "datasource",

46499

"submodule": "datasource-local"

46500

},

46501

{

46502

"file": "datasource/js/datasource-local.js",

46503

"line": 148,

46504

"description": "Fired when raw data is received.",

46505

"itemtype": "event",

46506

"name": "data",

46507

"params": [

46508

{

46509

"name": "e",

46510

"description": "Event Facade with the following properties:\n<dl>\n<dt>tId (Number)</dt> <dd>Unique transaction ID.</dd>\n<dt>request (Object)</dt> <dd>The request.</dd>\n<dt>callback (Object)</dt> <dd>Deprecated alias for the\n on property</dd>\n<dt>on (Object)</dt> <dd>The map of configured transaction\n callbacks. An object with the following properties:\n <dl>\n <dt>success (Function)</dt> <dd>Success handler.</dd>\n <dt>failure (Function)</dt> <dd>Failure handler.</dd>\n </dl>\n</dd>\n<dt>cfg (Object)</dt> <dd>Configuration object.</dd>\n<dt>data (Object)</dt> <dd>Raw data.</dd>\n</dl>",

46511

"type": "Event.Facade"

46512

}

46513

],

46514

"preventable": "_defDataFn",

46515

"class": "DataSource.Local",

46516

"module": "datasource",

46517

"submodule": "datasource-local"

46518

},

46519

{

46520

"file": "datasource/js/datasource-local.js",

46521

"line": 172,

46522

"description": "Fired when response is returned.",

46523

"itemtype": "event",

46524

"name": "response",

46525

"params": [

46526

{

46527

"name": "e",

46528

"description": "Event Facade with the following properties:\n<dl>\n<dt>tId (Number)</dt> <dd>Unique transaction ID.</dd>\n<dt>request (Object)</dt> <dd>The request.</dd>\n<dt>callback (Object)</dt> <dd>Deprecated alias for the\n on property</dd>\n<dt>on (Object)</dt> <dd>The map of configured transaction\n callbacks. An object with the following properties:\n <dl>\n <dt>success (Function)</dt> <dd>Success handler.</dd>\n <dt>failure (Function)</dt> <dd>Failure handler.</dd>\n </dl>\n</dd>\n<dt>cfg (Object)</dt> <dd>Configuration object.</dd>\n<dt>data (Object)</dt> <dd>Raw data.</dd>\n<dt>response (Object)</dt>\n <dd>Normalized response object with the following properties:\n <dl>\n <dt>results (Object)</dt> <dd>Parsed results.</dd>\n <dt>meta (Object)</dt> <dd>Parsed meta data.</dd>\n <dt>error (Boolean)</dt> <dd>Error flag.</dd>\n </dl>\n </dd>\n<dt>error</dt>\n <dd>Any error that occurred along the transaction lifecycle.</dd>\n</dl>",

46529

"type": "Event.Facade"

46530

}

46531

],

46532

"preventable": "_defResponseFn",

46533

"class": "DataSource.Local",

46534

"module": "datasource",

46535

"submodule": "datasource-local"

46536

},

46537

{

46538

"file": "datasource/js/datasource-local.js",

46539

"line": 206,

46540

"description": "Fired when an error is encountered.",

46541

"itemtype": "event",

46542

"name": "error",

46543

"params": [

46544

{

46545

"name": "e",

46546

"description": "Event Facade with the following properties:\n<dl>\n<dt>tId (Number)</dt> <dd>Unique transaction ID.</dd>\n<dt>request (Object)</dt> <dd>The request.</dd>\n<dt>callback (Object)</dt> <dd>Deprecated alias for the\n on property</dd>\n<dt>on (Object)</dt> <dd>The map of configured transaction\n callbacks. An object with the following properties:\n <dl>\n <dt>success (Function)</dt> <dd>Success handler.</dd>\n <dt>failure (Function)</dt> <dd>Failure handler.</dd>\n </dl>\n</dd>\n<dt>cfg (Object)</dt> <dd>Configuration object.</dd>\n<dt>data (Object)</dt> <dd>Raw data.</dd>\n<dt>response (Object)</dt>\n <dd>Normalized response object with the following properties:\n <dl>\n <dt>results (Object)</dt> <dd>Parsed results.</dd>\n <dt>meta (Object)</dt> <dd>Parsed meta data.</dd>\n <dt>error (Object)</dt> <dd>Error object.</dd>\n </dl>\n </dd>\n<dt>error</dt>\n <dd>Any error that occurred along the transaction lifecycle.</dd>\n</dl>",

46547

"type": "Event.Facade"

46548

}

46549

],

46550

"class": "DataSource.Local",

46551

"module": "datasource",

46552

"submodule": "datasource-local"

46553

},

46554

{

46555

"file": "datasource/js/datasource-local.js",

46556

"line": 240,

46557

"description": "Manages request/response transaction. Must fire <code>response</code>\nevent when response is received. This method should be implemented by\nsubclasses to achieve more complex behavior such as accessing remote data.",

46558

"itemtype": "method",

46559

"name": "_defRequestFn",

46560

"params": [

46561

{

46562

"name": "e",

46563

"description": "Event Facadewith the following properties:\n<dl>\n<dt>tId (Number)</dt> <dd>Unique transaction ID.</dd>\n<dt>request (Object)</dt> <dd>The request.</dd>\n<dt>callback (Object)</dt> <dd>Deprecated alias for the\n on property</dd>\n<dt>on (Object)</dt> <dd>The map of configured transaction\n callbacks. An object with the following properties:\n <dl>\n <dt>success (Function)</dt> <dd>Success handler.</dd>\n <dt>failure (Function)</dt> <dd>Failure handler.</dd>\n </dl>\n</dd>\n<dt>cfg (Object)</dt> <dd>Configuration object.</dd>\n</dl>",

46564

"type": "Event.Facade"

46565

}

46566

],

46567

"access": "protected",

46568

"tagname": "",

46569

"class": "DataSource.Local",

46570

"module": "datasource",

46571

"submodule": "datasource-local"

46572

},

46573

{

46574

"file": "datasource/js/datasource-local.js",

46575

"line": 279,

46576

"description": "Normalizes raw data into a response that includes results and meta properties.",

46577

"itemtype": "method",

46578

"name": "_defDataFn",

46579

"params": [

46580

{

46581

"name": "e",

46582

"description": "Event Facade with the following properties:\n<dl>\n<dt>tId (Number)</dt> <dd>Unique transaction ID.</dd>\n<dt>request (Object)</dt> <dd>The request.</dd>\n<dt>callback (Object)</dt> <dd>Deprecated alias for the\n on property</dd>\n<dt>on (Object)</dt> <dd>The map of configured transaction\n callbacks. An object with the following properties:\n <dl>\n <dt>success (Function)</dt> <dd>Success handler.</dd>\n <dt>failure (Function)</dt> <dd>Failure handler.</dd>\n </dl>\n</dd>\n<dt>cfg (Object)</dt> <dd>Configuration object.</dd>\n<dt>data (Object)</dt> <dd>Raw data.</dd>\n</dl>",

46583

"type": "Event.Facade"

46584

}

46585

],

46586

"access": "protected",

46587

"tagname": "",

46588

"class": "DataSource.Local",

46589

"module": "datasource",

46590

"submodule": "datasource-local"

46591

},

46592

{

46593

"file": "datasource/js/datasource-local.js",

46594

"line": 314,

46595

"description": "Sends data as a normalized response to callback.",

46596

"itemtype": "method",

46597

"name": "_defResponseFn",

46598

"params": [

46599

{

46600

"name": "e",

46601

"description": "Event Facade with the following properties:\n<dl>\n<dt>tId (Number)</dt> <dd>Unique transaction ID.</dd>\n<dt>request (Object)</dt> <dd>The request.</dd>\n<dt>callback (Object)</dt> <dd>Deprecated alias for the\n on property</dd>\n<dt>on (Object)</dt> <dd>The map of configured transaction\n callbacks. An object with the following properties:\n <dl>\n <dt>success (Function)</dt> <dd>Success handler.</dd>\n <dt>failure (Function)</dt> <dd>Failure handler.</dd>\n </dl>\n</dd>\n<dt>cfg (Object)</dt> <dd>Configuration object.</dd>\n<dt>data (Object)</dt> <dd>Raw data.</dd>\n<dt>response (Object)</dt> <dd>Normalized response object with the following properties:\n <dl>\n <dt>results (Object)</dt> <dd>Parsed results.</dd>\n <dt>meta (Object)</dt> <dd>Parsed meta data.</dd>\n <dt>error (Boolean)</dt> <dd>Error flag.</dd>\n </dl>\n</dd>\n</dl>",

46602

"type": "Event.Facade"

46603

}

46604

],

46605

"access": "protected",

46606

"tagname": "",

46607

"class": "DataSource.Local",

46608

"module": "datasource",

46609

"submodule": "datasource-local"

46610

},

46611

{

46612

"file": "datasource/js/datasource-local.js",

46613

"line": 348,

46614

"description": "Generates a unique transaction ID and fires <code>request</code> event.\nNote: the property <code>callback</code> is a\ndeprecated alias for the <code>on</code> transaction configuration\nproperty described below.",

46615

"itemtype": "method",

46616

"name": "sendRequest",

46617

"params": [

46618

{

46619

"name": "request",

46620

"description": "An object literal with the following properties:\n <dl>\n <dt><code>request</code></dt>\n <dd>The request to send to the live data source, if any.</dd>\n <dt><code>on</code></dt>\n <dd>An object literal with the following properties:\n <dl>\n <dt><code>success</code></dt>\n <dd>The function to call when the data is ready.</dd>\n <dt><code>failure</code></dt>\n <dd>The function to call upon a response failure condition.</dd>\n <dt><code>argument</code></dt>\n <dd>Arbitrary data payload that will be passed back to the success and failure handlers.</dd>\n </dl>\n </dd>\n <dt><code>cfg</code></dt>\n <dd>Configuration object, if any.</dd>\n </dl>",

46621

"type": "Object"

46622

}

46623

],

46624

"return": {

46625

"description": "Transaction ID.",

46626

"type": "Number"

46627

},

46628

"class": "DataSource.Local",

46629

"module": "datasource",

46630

"submodule": "datasource-local"

46631

},

46632

{

46633

"file": "datasource/js/datasource-polling.js",

46634

"line": 19,

46635

"itemtype": "property",

46636

"name": "_intervals",

46637

"description": "Hash of polling interval IDs that have been enabled,\nstored here to be able to clear all intervals.",

46638

"access": "private",

46639

"tagname": "",

46640

"class": "Pollable",

46641

"module": "datasource",

46642

"submodule": "datasource-polling"

46643

},

46644

{

46645

"file": "datasource/js/datasource-polling.js",

46646

"line": 27,

46647

"description": "Sets up a polling mechanism to send requests at set intervals and\nforward responses to given callback.",

46648

"itemtype": "method",

46649

"name": "setInterval",

46650

"params": [

46651

{

46652

"name": "msec",

46653

"description": "Length of interval in milliseconds.",

46654

"type": "Number"

46655

},

46656

{

46657

"name": "request",

46658

"description": "An object literal with the following properties:\n <dl>\n <dt><code>request</code></dt>\n <dd>The request to send to the live data source, if any.</dd>\n <dt><code>callback</code></dt>\n <dd>An object literal with the following properties:\n <dl>\n <dt><code>success</code></dt>\n <dd>The function to call when the data is ready.</dd>\n <dt><code>failure</code></dt>\n <dd>The function to call upon a response failure condition.</dd>\n <dt><code>argument</code></dt>\n <dd>Arbitrary data payload that will be passed back to the success and failure handlers.</dd>\n </dl>\n </dd>\n <dt><code>cfg</code></dt>\n <dd>Configuration object, if any.</dd>\n </dl>",

46659

"type": "Object"

46660

}

46661

],

46662

"return": {

46663

"description": "Interval ID.",

46664

"type": "Number"

46665

},

46666

"class": "Pollable",

46667

"module": "datasource",

46668

"submodule": "datasource-polling"

46669

},

46670

{

46671

"file": "datasource/js/datasource-polling.js",

46672

"line": 61,

46673

"description": "Disables polling mechanism associated with the given interval ID.",

46674

"itemtype": "method",

46675

"name": "clearInterval",

46676

"params": [

46677

{

46678

"name": "id",

46679

"description": "Interval ID.",

46680

"type": "Number"

46681

}

46682

],

46683

"class": "Pollable",

46684

"module": "datasource",

46685

"submodule": "datasource-polling"

46686

},

46687

{

46688

"file": "datasource/js/datasource-polling.js",

46689

"line": 78,

46690

"description": "Clears all intervals.",

46691

"itemtype": "method",

46692

"name": "clearAllIntervals",

46693

"class": "Pollable",

46694

"module": "datasource",

46695

"submodule": "datasource-polling"

46696

},

46697

{

46698

"file": "datasource/js/datasource-textschema.js",

46699

"line": 18,

46700

"description": "The namespace for the plugin. This will be the property on the host which\nreferences the plugin instance.",

46701

"itemtype": "property",

46702

"name": "NS",

46703

"type": "String",

46704

"static": 1,

46705

"final": 1,

46706

"value": "\"schema\"",

46707

"class": "DataSourceTextSchema",

46708

"module": "datasource",

46709

"submodule": "datasource-textschema"

46710

},

46711

{

46712

"file": "datasource/js/datasource-textschema.js",

46713

"line": 30,

46714

"description": "Class name.",

46715

"itemtype": "property",

46716

"name": "NAME",

46717

"type": "String",

46718

"static": 1,

46719

"final": 1,

46720

"value": "\"dataSourceTextSchema\"",

46721

"class": "DataSourceTextSchema",

46722

"module": "datasource",

46723

"submodule": "datasource-textschema"

46724

},

46725

{

46726

"file": "datasource/js/datasource-textschema.js",

46727

"line": 55,

46728

"description": "Internal init() handler.",

46729

"itemtype": "method",

46730

"name": "initializer",

46731

"params": [

46732

{

46733

"name": "config",

46734

"description": "Config object.",

46735

"type": "Object"

46736

}

46737

],

46738

"access": "private",

46739

"tagname": "",

46740

"class": "DataSourceTextSchema",

46741

"module": "datasource",

46742

"submodule": "datasource-textschema"

46743

},

46744

{

46745

"file": "datasource/js/datasource-textschema.js",

46746

"line": 66,

46747

"description": "Parses raw data into a normalized response.",

46748

"itemtype": "method",

46749

"name": "_beforeDefDataFn",

46750

"params": [

46751

{

46752

"name": "tId",

46753

"description": "Unique transaction ID.",

46754

"type": "Number"

46755

},

46756

{

46757

"name": "request",

46758

"description": "The request.",

46759

"type": "Object"

46760

},

46761

{

46762

"name": "callback",

46763

"description": "The callback object with the following properties:\n <dl>\n <dt>success (Function)</dt> <dd>Success handler.</dd>\n <dt>failure (Function)</dt> <dd>Failure handler.</dd>\n </dl>",

46764

"type": "Object"

46765

},

46766

{

46767

"name": "data",

46768

"description": "Raw data.",

46769

"type": "Object"

46770

}

46771

],

46772

"access": "protected",

46773

"tagname": "",

46774

"class": "DataSourceTextSchema",

46775

"module": "datasource",

46776

"submodule": "datasource-textschema"

46777

},

46778

{

46779

"file": "datasource/js/datasource-xmlschema.js",

46780

"line": 18,

46781

"description": "The namespace for the plugin. This will be the property on the host which\nreferences the plugin instance.",

46782

"itemtype": "property",

46783

"name": "NS",

46784

"type": "String",

46785

"static": 1,

46786

"final": 1,

46787

"value": "\"schema\"",

46788

"class": "DataSourceXMLSchema",

46789

"module": "datasource",

46790

"submodule": "datasource-xmlschema"

46791

},

46792

{

46793

"file": "datasource/js/datasource-xmlschema.js",

46794

"line": 30,

46795

"description": "Class name.",

46796

"itemtype": "property",

46797

"name": "NAME",

46798

"type": "String",

46799

"static": 1,

46800

"final": 1,

46801

"value": "\"dataSourceXMLSchema\"",

46802

"class": "DataSourceXMLSchema",

46803

"module": "datasource",

46804

"submodule": "datasource-xmlschema"

46805

},

46806

{

46807

"file": "datasource/js/datasource-xmlschema.js",

46808

"line": 55,

46809

"description": "Internal init() handler.",

46810

"itemtype": "method",

46811

"name": "initializer",

46812

"params": [

46813

{

46814

"name": "config",

46815

"description": "Config object.",

46816

"type": "Object"

46817

}

46818

],

46819

"access": "private",

46820

"tagname": "",

46821

"class": "DataSourceXMLSchema",

46822

"module": "datasource",

46823

"submodule": "datasource-xmlschema"

46824

},

46825

{

46826

"file": "datasource/js/datasource-xmlschema.js",

46827

"line": 66,

46828

"description": "Parses raw data into a normalized response.",

46829

"itemtype": "method",

46830

"name": "_beforeDefDataFn",

46831

"params": [

46832

{

46833

"name": "tId",

46834

"description": "Unique transaction ID.",

46835

"type": "Number"

46836

},

46837

{

46838

"name": "request",

46839

"description": "The request.",

46840

"type": "Object"

46841

},

46842

{

46843

"name": "callback",

46844

"description": "The callback object with the following properties:\n <dl>\n <dt>success (Function)</dt> <dd>Success handler.</dd>\n <dt>failure (Function)</dt> <dd>Failure handler.</dd>\n </dl>",

46845

"type": "Object"

46846

},

46847

{

46848

"name": "data",

46849

"description": "Raw data.",

46850

"type": "Object"

46851

}

46852

],

46853

"access": "protected",

46854

"tagname": "",

46855

"class": "DataSourceXMLSchema",

46856

"module": "datasource",

46857

"submodule": "datasource-xmlschema"

46858

},

46859

{

46860

"file": "datatable/js/body.js",

46861

"line": 106,

46862

"description": "HTML template used to create table cells.",

46863

"itemtype": "property",

46864

"name": "CELL_TEMPLATE",

46865

"type": "{HTML}",

46866

"default": "'<td {headers} class=\"{className}\">{content}</td>'",

46867

"since": "3.5.0",

46868

"class": "DataTable.BodyView",

46869

"module": "datatable",

46870

"submodule": "datatable-body",

46871

"namespace": "DataTable"

46872

},

46873

{

46874

"file": "datatable/js/body.js",

46875

"line": 116,

46876

"description": "CSS class applied to even rows. This is assigned at instantiation after\nsetting up the `_cssPrefix` for the instance.\n\nFor DataTable, this will be `yui3-datatable-even`.",

46877

"itemtype": "property",

46878

"name": "CLASS_EVEN",

46879

"type": "{String}",

46880

"default": "'yui3-table-even'",

46881

"since": "3.5.0",

46882

"class": "DataTable.BodyView",

46883

"module": "datatable",

46884

"submodule": "datatable-body",

46885

"namespace": "DataTable"

46886

},

46887

{

46888

"file": "datatable/js/body.js",

46889

"line": 129,

46890

"description": "CSS class applied to odd rows. This is assigned at instantiation after\nsetting up the `_cssPrefix` for the instance.\n\nWhen used by DataTable instances, this will be `yui3-datatable-odd`.",

46891

"itemtype": "property",

46892

"name": "CLASS_ODD",

46893

"type": "{String}",

46894

"default": "'yui3-table-odd'",

46895

"since": "3.5.0",

46896

"class": "DataTable.BodyView",

46897

"module": "datatable",

46898

"submodule": "datatable-body",

46899

"namespace": "DataTable"

46900

},

46901

{

46902

"file": "datatable/js/body.js",

46903

"line": 142,

46904

"description": "HTML template used to create table rows.",

46905

"itemtype": "property",

46906

"name": "ROW_TEMPLATE",

46907

"type": "{HTML}",

46908

"default": "'<tr id=\"{rowId}\" data-yui3-record=\"{clientId}\" class=\"{rowClass}\">{content}</tr>'",

46909

"since": "3.5.0",

46910

"class": "DataTable.BodyView",

46911

"module": "datatable",

46912

"submodule": "datatable-body",

46913

"namespace": "DataTable"

46914

},

46915

{

46916

"file": "datatable/js/body.js",

46917

"line": 152,

46918

"description": "The object that serves as the source of truth for column and row data.\nThis property is assigned at instantiation from the `source` property of\nthe configuration object passed to the constructor.",

46919

"itemtype": "property",

46920

"name": "source",

46921

"type": "{Object}",

46922

"default": "(initially unset)",

46923

"since": "3.5.0",

46924

"class": "DataTable.BodyView",

46925

"module": "datatable",

46926

"submodule": "datatable-body",

46927

"namespace": "DataTable"

46928

},

46929

{

46930

"file": "datatable/js/body.js",

46931

"line": 167,

46932

"description": "Returns the `<td>` Node from the given row and column index. Alternately,\nthe `seed` can be a Node. If so, the nearest ancestor cell is returned.\nIf the `seed` is a cell, it is returned. If there is no cell at the given\ncoordinates, `null` is returned.\n\nOptionally, include an offset array or string to return a cell near the\ncell identified by the `seed`. The offset can be an array containing the\nnumber of rows to shift followed by the number of columns to shift, or one\nof \"above\", \"below\", \"next\", or \"previous\".\n\n<pre><code>// Previous cell in the previous row\nvar cell = table.getCell(e.target, [-1, -1]);\n\n// Next cell\nvar cell = table.getCell(e.target, 'next');\nvar cell = table.getCell(e.taregt, [0, 1];</pre></code>",

46933

"itemtype": "method",

46934

"name": "getCell",

46935

"params": [

46936

{

46937

"name": "seed",

46938

"description": "Array of row and column indexes, or a Node that\n is either the cell itself or a descendant of one.",

46939

"type": "Number[]|Node"

46940

},

46941

{

46942

"name": "shift",

46943

"description": "Offset by which to identify the returned\n cell Node",

46944

"type": "Number[]|String",

46945

"optional": true

46946

}

46947

],

46948

"return": {

46949

"description": "",

46950

"type": "Node"

46951

},

46952

"since": "3.5.0",

46953

"class": "DataTable.BodyView",

46954

"module": "datatable",

46955

"submodule": "datatable-body",

46956

"namespace": "DataTable"

46957

},

46958

{

46959

"file": "datatable/js/body.js",

46960

"line": 231,

46961

"description": "Builds a CSS class name from the provided tokens. If the instance is\ncreated with `cssPrefix` or `source` in the configuration, it will use this\nprefix (the `_cssPrefix` of the `source` object) as the base token. This\nallows class instances to generate markup with class names that correspond\nto the parent class that is consuming them.",

46962

"itemtype": "method",

46963

"name": "getClassName",

46964

"params": [

46965

{

46966

"name": "token",

46967

"description": "Any number of tokens to include in the class name",

46968

"type": "String",

46969

"multiple": true

46970

}

46971

],

46972

"return": {

46973

"description": "The generated class name",

46974

"type": "String"

46975

},

46976

"since": "3.5.0",

46977

"class": "DataTable.BodyView",

46978

"module": "datatable",

46979

"submodule": "datatable-body",

46980

"namespace": "DataTable"

46981

},

46982

{

46983

"file": "datatable/js/body.js",

46984

"line": 251,

46985

"description": "Returns the Model associated to the row Node or id provided. Passing the\nNode or id for a descendant of the row also works.\n\nIf no Model can be found, `null` is returned.",

46986

"itemtype": "method",

46987

"name": "getRecord",

46988

"params": [

46989

{

46990

"name": "seed",

46991

"description": "Row Node or `id`, or one for a descendant of a row",

46992

"type": "String|Node"

46993

}

46994

],

46995

"return": {

46996

"description": "",

46997

"type": "Model"

46998

},

46999

"since": "3.5.0",

47000

"class": "DataTable.BodyView",

47001

"module": "datatable",

47002

"submodule": "datatable-body",

47003

"namespace": "DataTable"

47004

},

47005

{

47006

"file": "datatable/js/body.js",

47007

"line": 286,

47008

"description": "Returns the `<tr>` Node from the given row index, Model, or Model's\n`clientId`. If the rows haven't been rendered yet, or if the row can't be\nfound by the input, `null` is returned.",

47009

"itemtype": "method",

47010

"name": "getRow",

47011

"params": [

47012

{

47013

"name": "id",

47014

"description": "Row index, Model instance, or clientId",

47015

"type": "Number|String|Model"

47016

}

47017

],

47018

"return": {

47019

"description": "",

47020

"type": "Node"

47021

},

47022

"since": "3.5.0",

47023

"class": "DataTable.BodyView",

47024

"module": "datatable",

47025

"submodule": "datatable-body",

47026

"namespace": "DataTable"

47027

},

47028

{

47029

"file": "datatable/js/body.js",

47030

"line": 307,

47031

"description": "Creates the table's `<tbody>` content by assembling markup generated by\npopulating the `ROW\\_TEMPLATE`, and `CELL\\_TEMPLATE` templates with content\nfrom the `columns` property and `modelList` attribute.\n\nThe rendering process happens in three stages:\n\n1. A row template is assembled from the `columns` property (see\n `_createRowTemplate`)\n\n2. An HTML string is built up by concatening the application of the data in\n each Model in the `modelList` to the row template. For cells with\n `formatter`s, the function is called to generate cell content. Cells\n with `nodeFormatter`s are ignored. For all other cells, the data value\n from the Model attribute for the given column key is used. The\n accumulated row markup is then inserted into the container.\n\n3. If any column is configured with a `nodeFormatter`, the `modelList` is\n iterated again to apply the `nodeFormatter`s.\n\nSupported properties of the column objects include:\n\n * `key` - Used to link a column to an attribute in a Model.\n * `name` - Used for columns that don't relate to an attribute in the Model\n (`formatter` or `nodeFormatter` only) if the implementer wants a\n predictable name to refer to in their CSS.\n * `cellTemplate` - Overrides the instance's `CELL_TEMPLATE` for cells in\n this column only.\n * `formatter` - Used to customize or override the content value from the\n Model. These do not have access to the cell or row Nodes and should\n return string (HTML) content.\n * `nodeFormatter` - Used to provide content for a cell as well as perform\n any custom modifications on the cell or row Node that could not be\n performed by `formatter`s. Should be used sparingly for better\n performance.\n * `emptyCellValue` - String (HTML) value to use if the Model data for a\n column, or the content generated by a `formatter`, is the empty string,\n `null`, or `undefined`.\n * `allowHTML` - Set to `true` if a column value, `formatter`, or\n `emptyCellValue` can contain HTML. This defaults to `false` to protect\n against XSS.\n * `className` - Space delimited CSS classes to add to all `<td>`s in a\n column.\n\nColumn `formatter`s are passed an object (`o`) with the following\nproperties:\n\n * `value` - The current value of the column's associated attribute, if\n any.\n * `data` - An object map of Model keys to their current values.\n * `record` - The Model instance.\n * `column` - The column configuration object for the current column.\n * `className` - Initially empty string to allow `formatter`s to add CSS \n classes to the cell's `<td>`.\n * `rowIndex` - The zero-based row number.\n * `rowClass` - Initially empty string to allow `formatter`s to add CSS\n classes to the cell's containing row `<tr>`.\n\nThey may return a value or update `o.value` to assign specific HTML\ncontent. A returned value has higher precedence.\n\nColumn `nodeFormatter`s are passed an object (`o`) with the following\nproperties:\n\n * `value` - The current value of the column's associated attribute, if\n any.\n * `td` - The `<td>` Node instance.\n * `cell` - The `<div>` liner Node instance if present, otherwise, the\n `<td>`. When adding content to the cell, prefer appending into this\n property.\n * `data` - An object map of Model keys to their current values.\n * `record` - The Model instance.\n * `column` - The column configuration object for the current column.\n * `rowIndex` - The zero-based row number.\n\nThey are expected to inject content into the cell's Node directly, including\nany \"empty\" cell content. Each `nodeFormatter` will have access through the\nNode API to all cells and rows in the `<tbody>`, but not to the `<table>`,\nas it will not be attached yet.\n\nIf a `nodeFormatter` returns `false`, the `o.td` and `o.cell` Nodes will be\n`destroy()`ed to remove them from the Node cache and free up memory. The\nDOM elements will remain as will any content added to them. _It is highly\nadvisable to always return `false` from your `nodeFormatter`s_.",

47032

"itemtype": "method",

47033

"name": "render",

47034

"return": {

47035

"description": "The instance",

47036

"type": "BodyView"

47037

},

47038

"chainable": 1,

47039

"since": "3.5.0",

47040

"class": "DataTable.BodyView",

47041

"module": "datatable",

47042

"submodule": "datatable-body",

47043

"namespace": "DataTable"

47044

},

47045

{

47046

"file": "datatable/js/body.js",

47047

"line": 417,

47048

"description": "Handles changes in the source's columns attribute. Redraws the table data.",

47049

"itemtype": "method",

47050

"name": "_afterColumnsChange",

47051

"params": [

47052

{

47053

"name": "e",

47054

"description": "The `columnsChange` event object",

47055

"type": "EventFacade"

47056

}

47057

],

47058

"access": "protected",

47059

"tagname": "",

47060

"since": "3.5.0",

47061

"class": "DataTable.BodyView",

47062

"module": "datatable",

47063

"submodule": "datatable-body",

47064

"namespace": "DataTable"

47065

},

47066

{

47067

"file": "datatable/js/body.js",

47068

"line": 438,

47069

"description": "Handles modelList changes, including additions, deletions, and updates.\n\nModifies the existing table DOM accordingly.",

47070

"itemtype": "method",

47071

"name": "_afterDataChange",

47072

"params": [

47073

{

47074

"name": "e",

47075

"description": "The `change` event from the ModelList",

47076

"type": "EventFacade"

47077

}

47078

],

47079

"access": "protected",

47080

"tagname": "",

47081

"since": "3.5.0",

47082

"class": "DataTable.BodyView",

47083

"module": "datatable",

47084

"submodule": "datatable-body",

47085

"namespace": "DataTable"

47086

},

47087

{

47088

"file": "datatable/js/body.js",

47089

"line": 453,

47090

"description": "Reacts to a change in the instance's `modelList` attribute by breaking\ndown the bubbling relationship with the previous `modelList` and setting up\nthat relationship with the new one.",

47091

"itemtype": "method",

47092

"name": "_afterModelListChange",

47093

"params": [

47094

{

47095

"name": "e",

47096

"description": "The `modelListChange` event",

47097

"type": "EventFacade"

47098

}

47099

],

47100

"access": "protected",

47101

"tagname": "",

47102

"since": "3.5.0",

47103

"class": "DataTable.BodyView",

47104

"module": "datatable",

47105

"submodule": "datatable-body",

47106

"namespace": "DataTable"

47107

},

47108

{

47109

"file": "datatable/js/body.js",

47110

"line": 478,

47111

"description": "Iterates the `modelList`, and calls any `nodeFormatter`s found in the\n`columns` param on the appropriate cell Nodes in the `tbody`.",

47112

"itemtype": "method",

47113

"name": "_applyNodeFormatters",

47114

"params": [

47115

{

47116

"name": "tbody",

47117

"description": "The `<tbody>` Node whose columns to update",

47118

"type": "Node"

47119

},

47120

{

47121

"name": "columns",

47122

"description": "The column configurations",

47123

"type": "Object[]"

47124

}

47125

],

47126

"access": "protected",

47127

"tagname": "",

47128

"since": "3.5.0",

47129

"class": "DataTable.BodyView",

47130

"module": "datatable",

47131

"submodule": "datatable-body",

47132

"namespace": "DataTable"

47133

},

47134

{

47135

"file": "datatable/js/body.js",

47136

"line": 545,

47137

"description": "Binds event subscriptions from the UI and the source (if assigned).",

47138

"itemtype": "method",

47139

"name": "bindUI",

47140

"access": "protected",

47141

"tagname": "",

47142

"since": "3.5.0",

47143

"class": "DataTable.BodyView",

47144

"module": "datatable",

47145

"submodule": "datatable-body",

47146

"namespace": "DataTable"

47147

},

47148

{

47149

"file": "datatable/js/body.js",

47150

"line": 567,

47151

"description": "The base token for classes created with the `getClassName` method.",

47152

"itemtype": "property",

47153

"name": "_cssPrefix",

47154

"type": "{String}",

47155

"default": "'yui3-table'",

47156

"access": "protected",

47157

"tagname": "",

47158

"since": "3.5.0",

47159

"class": "DataTable.BodyView",

47160

"module": "datatable",

47161

"submodule": "datatable-body",

47162

"namespace": "DataTable"

47163

},

47164

{

47165

"file": "datatable/js/body.js",

47166

"line": 578,

47167

"description": "Iterates the `modelList` and applies each Model to the `_rowTemplate`,\nallowing any column `formatter` or `emptyCellValue` to override cell\ncontent for the appropriate column. The aggregated HTML string is\nreturned.",

47168

"itemtype": "method",

47169

"name": "_createDataHTML",

47170

"params": [

47171

{

47172

"name": "columns",

47173

"description": "The column configurations to customize the\n generated cell content or class names",

47174

"type": "Object[]"

47175

}

47176

],

47177

"return": {

47178

"description": "The markup for all Models in the `modelList`, each applied\n to the `_rowTemplate`",

47179

"type": "HTML"

47180

},

47181

"access": "protected",

47182

"tagname": "",

47183

"since": "3.5.0",

47184

"class": "DataTable.BodyView",

47185

"module": "datatable",

47186

"submodule": "datatable-body",

47187

"namespace": "DataTable"

47188

},

47189

{

47190

"file": "datatable/js/body.js",

47191

"line": 605,

47192

"description": "Applies the data of a given Model, modified by any column formatters and\nsupplemented by other template values to the instance's `_rowTemplate` (see\n`_createRowTemplate`). The generated string is then returned.\n\nThe data from Model's attributes is fetched by `toJSON` and this data\nobject is appended with other properties to supply values to {placeholders}\nin the template. For a template generated from a Model with 'foo' and 'bar'\nattributes, the data object would end up with the following properties\nbefore being used to populate the `_rowTemplate`:\n\n * `clientID` - From Model, used the assign the `<tr>`'s 'id' attribute.\n * `foo` - The value to populate the 'foo' column cell content. This\n value will be the value stored in the Model's `foo` attribute, or the\n result of the column's `formatter` if assigned. If the value is '', \n `null`, or `undefined`, and the column's `emptyCellValue` is assigned,\n that value will be used.\n * `bar` - Same for the 'bar' column cell content.\n * `foo-className` - String of CSS classes to apply to the `<td>`.\n * `bar-className` - Same.\n * `rowClass` - String of CSS classes to apply to the `<tr>`. This\n will be the odd/even class per the specified index plus any additional\n classes assigned by column formatters (via `o.rowClass`).\n\nBecause this object is available to formatters, any additional properties\ncan be added to fill in custom {placeholders} in the `_rowTemplate`.",

47193

"itemtype": "method",

47194

"name": "_createRowHTML",

47195

"params": [

47196

{

47197

"name": "model",

47198

"description": "The Model instance to apply to the row template",

47199

"type": "Model"

47200

},

47201

{

47202

"name": "index",

47203

"description": "The index the row will be appearing",

47204

"type": "Number"

47205

}

47206

],

47207

"return": {

47208

"description": "The markup for the provided Model, less any `nodeFormatter`s",

47209

"type": "HTML"

47210

},

47211

"access": "protected",

47212

"tagname": "",

47213

"since": "3.5.0",

47214

"class": "DataTable.BodyView",

47215

"module": "datatable",

47216

"submodule": "datatable-body",

47217

"namespace": "DataTable"

47218

},

47219

{

47220

"file": "datatable/js/body.js",

47221

"line": 700,

47222

"description": "Creates a custom HTML template string for use in generating the markup for\nindividual table rows with {placeholder}s to capture data from the Models\nin the `modelList` attribute or from column `formatter`s.\n\nAssigns the `_rowTemplate` property.",

47223

"itemtype": "method",

47224

"name": "_createRowTemplate",

47225

"params": [

47226

{

47227

"name": "columns",

47228

"description": "Array of column configuration objects",

47229

"type": "Object[]"

47230

}

47231

],

47232

"access": "protected",

47233

"tagname": "",

47234

"since": "3.5.0",

47235

"class": "DataTable.BodyView",

47236

"module": "datatable",

47237

"submodule": "datatable-body",

47238

"namespace": "DataTable"

47239

},

47240

{

47241

"file": "datatable/js/body.js",

47242

"line": 747,

47243

"description": "Destroys the instance.",

47244

"itemtype": "method",

47245

"name": "destructor",

47246

"access": "protected",

47247

"tagname": "",

47248

"since": "3.5.0",

47249

"class": "DataTable.BodyView",

47250

"module": "datatable",

47251

"submodule": "datatable-body",

47252

"namespace": "DataTable"

47253

},

47254

{

47255

"file": "datatable/js/body.js",

47256

"line": 761,

47257

"description": "Holds the event subscriptions needing to be detached when the instance is\n`destroy()`ed.",

47258

"itemtype": "property",

47259

"name": "_eventHandles",

47260

"type": "{Object}",

47261

"default": "undefined (initially unset)",

47262

"access": "protected",

47263

"tagname": "",

47264

"since": "3.5.0",

47265

"class": "DataTable.BodyView",

47266

"module": "datatable",

47267

"submodule": "datatable-body",

47268

"namespace": "DataTable"

47269

},

47270

{

47271

"file": "datatable/js/body.js",

47272

"line": 773,

47273

"description": "Returns the row ID associated with a Model's clientId.",

47274

"itemtype": "method",

47275

"name": "_getRowId",

47276

"params": [

47277

{

47278

"name": "clientId",

47279

"description": "The Model clientId",

47280

"type": "String"

47281

}

47282

],

47283

"return": {

47284

"description": "",

47285

"type": "String"

47286

},

47287

"access": "protected",

47288

"tagname": "",

47289

"class": "DataTable.BodyView",

47290

"module": "datatable",

47291

"submodule": "datatable-body",

47292

"namespace": "DataTable"

47293

},

47294

{

47295

"file": "datatable/js/body.js",

47296

"line": 785,

47297

"description": "Map of Model clientIds to row ids.",

47298

"itemtype": "property",

47299

"name": "_idMap",

47300

"type": "{Object}",

47301

"access": "protected",

47302

"tagname": "",

47303

"class": "DataTable.BodyView",

47304

"module": "datatable",

47305

"submodule": "datatable-body",

47306

"namespace": "DataTable"

47307

},

47308

{

47309

"file": "datatable/js/body.js",

47310

"line": 794,

47311

"description": "Initializes the instance. Reads the following configuration properties in\naddition to the instance attributes:\n\n * `columns` - (REQUIRED) The initial column information\n * `cssPrefix` - The base string for classes generated by `getClassName`\n * `source` - The object to serve as source of truth for column info",

47312

"itemtype": "method",

47313

"name": "initializer",

47314

"params": [

47315

{

47316

"name": "config",

47317

"description": "Configuration data",

47318

"type": "Object"

47319

}

47320

],

47321

"access": "protected",

47322

"tagname": "",

47323

"since": "3.5.0",

47324

"class": "DataTable.BodyView",

47325

"module": "datatable",

47326

"submodule": "datatable-body",

47327

"namespace": "DataTable"

47328

},

47329

{

47330

"file": "datatable/js/body.js",

47331

"line": 831,

47332

"description": "Flattens an array of potentially nested column configurations into a single\ndepth array of data columns. Columns that have children are disregarded in\nfavor of searching their child columns. The resulting array corresponds 1:1\nwith columns that will contain data in the `<tbody>`.",

47333

"itemtype": "method",

47334

"name": "_parseColumns",

47335

"params": [

47336

{

47337

"name": "data",

47338

"description": "Array of unfiltered column configuration objects",

47339

"type": "Object[]"

47340

},

47341

{

47342

"name": "columns",

47343

"description": "Working array of data columns. Used for recursion.",

47344

"type": "Object[]"

47345

}

47346

],

47347

"return": {

47348

"description": "Only those columns that will be rendered.",

47349

"type": "Object[]"

47350

},

47351

"access": "protected",

47352

"tagname": "",

47353

"since": "3.5.0",

47354

"class": "DataTable.BodyView",

47355

"module": "datatable",

47356

"submodule": "datatable-body",

47357

"namespace": "DataTable"

47358

},

47359

{

47360

"file": "datatable/js/body.js",

47361

"line": 869,

47362

"description": "The HTML template used to create a full row of markup for a single Model in\nthe `modelList` plus any customizations defined in the column\nconfigurations.",

47363

"itemtype": "property",

47364

"name": "_rowTemplate",

47365

"type": "{HTML}",

47366

"default": "(initially unset)",

47367

"access": "protected",

47368

"tagname": "",

47369

"since": "3.5.0",

47370

"class": "DataTable.BodyView",

47371

"module": "datatable",

47372

"submodule": "datatable-body",

47373

"namespace": "DataTable"

47374

},

47375

{

47376

"file": "datatable/js/colwidths.js",

47377

"line": 118,

47378

"description": "The HTML template used to create the table's `<col>`s.",

47379

"itemtype": "property",

47380

"name": "COL_TEMPLATE",

47381

"type": "{HTML}",

47382

"default": "'<col/>'",

47383

"since": "3.5.0",

47384

"class": "DataTable",

47385

"module": "datatable",

47386

"submodule": "datatable-column-widths"

47387

},

47388

{

47389

"file": "datatable/js/colwidths.js",

47390

"line": 128,

47391

"description": "The HTML template used to create the table's `<colgroup>`.",

47392

"itemtype": "property",

47393

"name": "COLGROUP_TEMPLATE",

47394

"type": "{HTML}",

47395

"default": "'<colgroup/>'",

47396

"since": "3.5.0",

47397

"class": "DataTable",

47398

"module": "datatable",

47399

"submodule": "datatable-column-widths"

47400

},

47401

{

47402

"file": "datatable/js/colwidths.js",

47403

"line": 138,

47404

"description": "Assigns the style width of the `<col>` representing the column identifed by\n`id` and updates the column configuration.\n\nPass the empty string for `width` to return a column to auto sizing.\n\nThis does not trigger a `columnsChange` event today, but I can be convinced\nthat it should.",

47405

"itemtype": "method",

47406

"name": "setColumnWidth",

47407

"params": [

47408

{

47409

"name": "id",

47410

"description": "The column config object or key, name, or\n index of a column in the host's `_displayColumns` array.",

47411

"type": "Number|String|Object"

47412

},

47413

{

47414

"name": "width",

47415

"description": "CSS width value. Numbers are treated as pixels",

47416

"type": "Number|String"

47417

}

47418

],

47419

"return": {

47420

"description": "",

47421

"type": "DataTable"

47422

},

47423

"chainable": 1,

47424

"since": "3.5.0",

47425

"class": "DataTable",

47426

"module": "datatable",

47427

"submodule": "datatable-column-widths"

47428

},

47429

{

47430

"file": "datatable/js/colwidths.js",

47431

"line": 176,

47432

"description": "Renders the table's `<colgroup>` and populates the `_colgroupNode` property.",

47433

"itemtype": "method",

47434

"name": "_createColumnGroup",

47435

"access": "protected",

47436

"tagname": "",

47437

"since": "3.5.0",

47438

"class": "DataTable",

47439

"module": "datatable",

47440

"submodule": "datatable-column-widths"

47441

},

47442

{

47443

"file": "datatable/js/colwidths.js",

47444

"line": 187,

47445

"description": "Hooks up to the rendering lifecycle to also render the `<colgroup>` and\nsubscribe to `columnChange` events.",

47446

"itemtype": "method",

47447

"name": "initializer",

47448

"access": "protected",

47449

"tagname": "",

47450

"since": "3.5.0",

47451

"class": "DataTable",

47452

"module": "datatable",

47453

"submodule": "datatable-column-widths"

47454

},

47455

{

47456

"file": "datatable/js/colwidths.js",

47457

"line": 203,

47458

"description": "Sets a columns's `<col>` element width style. This is needed to get around\nbrowser rendering differences.\n\nThe colIndex corresponds to the item index of the `<col>` in the table's\n`<colgroup>`.\n\nTo unset the width, pass a falsy value for the `width`.",

47459

"itemtype": "method",

47460

"name": "_setColumnWidth",

47461

"params": [

47462

{

47463

"name": "colIndex",

47464

"description": "The display column index",

47465

"type": "Number"

47466

},

47467

{

47468

"name": "width",

47469

"description": "The desired width",

47470

"type": "Number|String"

47471

}

47472

],

47473

"access": "protected",

47474

"tagname": "",

47475

"since": "3.5.0",

47476

"class": "DataTable",

47477

"module": "datatable",

47478

"submodule": "datatable-column-widths"

47479

},

47480

{

47481

"file": "datatable/js/colwidths.js",

47482

"line": 260,

47483

"description": "Populates the table's `<colgroup>` with a `<col>` per item in the `columns`\nattribute without children. It is assumed that these are the columns that\nhave data cells renderered for them.",

47484

"itemtype": "method",

47485

"name": "_uiSetColumns",

47486

"access": "protected",

47487

"tagname": "",

47488

"since": "3.5.0",

47489

"class": "DataTable",

47490

"module": "datatable",

47491

"submodule": "datatable-column-widths"

47492

},

47493

{

47494

"file": "datatable/js/core.js",

47495

"line": 59,

47496

"description": "Columns to include in the rendered table.\n\nIf omitted, the attributes on the configured `recordType` or the first item\nin the `data` collection will be used as a source.\n\nThis attribute takes an array of strings or objects (mixing the two is\nfine). Each string or object is considered a column to be rendered.\nStrings are converted to objects, so `columns: ['first', 'last']` becomes\n`columns: [{ key: 'first' }, { key: 'last' }]`.\n\nDataTable.Core only concerns itself with a few properties of columns.\nAll other properties are for use by the `headerView`, `bodyView`,\n`footerView`, and any class extensions or plugins on the final class or\ninstance. See the descriptions of the view classes and feature class\nextensions and plugins for details on the specific properties they read or\nadd to column definitions.\n\nThe properties that are referenced or assigned are:\n\n* `key` - Used to identify the record field/attribute containing content for\n this column. Also used to create a default Model if no `recordType` or\n `data` are provided during construction. If `name` is not specified, this\n is assigned to the `_id` property (with added incrementer if the key is\n used by multiple columns).\n* `children` - Traversed to initialize nested column objects\n* `name` - Used in place of, or in addition to, the `key`. Useful for\n columns that aren't bound to a field/attribute in the record data. This\n is assigned to the `_id` property.\n* `id` - For backward compatibility. Implementers can specify the id of\n the header cell. This should be avoided, if possible, to avoid the\n potential for creating DOM elements with duplicate IDs.\n* `field` - For backward compatibility. Implementers should use `name`.\n* `_id` - Assigned unique-within-this-instance id for a column. By order\n of preference, assumes the value of `name`, `key`, `id`, or `_yuid`.\n This is used by the `bodyView` and `headerView` as well as feature module\n as a means to identify a specific column without ambiguity (such as\n multiple columns using the same `key`.\n* `_yuid` - Guid stamp assigned to the column object.\n* `_parent` - Assigned to all child columns, referencing their parent\n column.",

47497

"itemtype": "attribute",

47498

"name": "columns",

47499

"type": "{Object[]|String[]}",

47500

"default": "(from `recordType` ATTRS or first item in the `data`)",

47501

"since": "3.5.0",

47502

"class": "DataTable",

47503

"module": "datatable",

47504

"submodule": "datatable-core"

47505

},

47506

{

47507

"file": "datatable/js/core.js",

47508

"line": 112,

47509

"description": "Model subclass to use as the `model` for the ModelList stored in the `data`\nattribute.\n\nIf not provided, it will try really hard to figure out what to use. The\nfollowing attempts will be made to set a default value:\n\n1. If the `data` attribute is set with a ModelList instance and its `model`\n property is set, that will be used.\n2. If the `data` attribute is set with a ModelList instance, and its\n `model` property is unset, but it is populated, the `ATTRS` of the\n `constructor of the first item will be used.\n3. If the `data` attribute is set with a non-empty array, a Model subclass\n will be generated using the keys of the first item as its `ATTRS` (see\n the `_createRecordClass` method).\n4. If the `columns` attribute is set, a Model subclass will be generated\n using the columns defined with a `key`. This is least desirable because\n columns can be duplicated or nested in a way that's not parsable.\n5. If neither `data` nor `columns` is set or populated, a change event\n subscriber will listen for the first to be changed and try all over\n again.",

47510

"itemtype": "attribute",

47511

"name": "recordType",

47512

"type": "{Function}",

47513

"default": "(see description)",

47514

"since": "3.5.0",

47515

"class": "DataTable",

47516

"module": "datatable",

47517

"submodule": "datatable-core"

47518

},

47519

{

47520

"file": "datatable/js/core.js",

47521

"line": 144,

47522

"description": "The collection of data records to display. This attribute is a pass\nthrough to a `data` property, which is a ModelList instance.\n\nIf this attribute is passed a ModelList or subclass, it will be assigned to\nthe property directly. If an array of objects is passed, a new ModelList\nwill be created using the configured `recordType` as its `model` property\nand seeded with the array.\n\nRetrieving this attribute will return the ModelList stored in the `data`\nproperty.",

47523

"itemtype": "attribute",

47524

"name": "data",

47525

"type": "{ModelList|Object[]}",

47526

"default": "`new ModelList()`",

47527

"since": "3.5.0",

47528

"class": "DataTable",

47529

"module": "datatable",

47530

"submodule": "datatable-core"

47531

},

47532

{

47533

"file": "datatable/js/core.js",

47534

"line": 167,

47535

"description": "The class or object to use for rendering the `<thead>` and column headers\nfor the table. This attribute is responsible for populating the the\ninstance's `head` property.\n\nIf a class constructor (function) is passed, an instance of that clas will\nbe created at `render()` time and assigned to `this.head`. If an object is\npassed, `head` will be set immediately.\n\nValid objects or classes will have a `render()` method, though it is\nrecommended that they be subclasses of `Y.Base` or `Y.View`. If the object\nor class supports events, its `addTarget()` method will be called to bubble\nits events to this instance.\n\nThe core implementaion does not define a default `headerView`. Classes\nbuilt from this extension should define a default.",

47536

"itemtype": "attribute",

47537

"name": "headerView",

47538

"type": "{Function|Object}",

47539

"since": "3.5.0",

47540

"class": "DataTable",

47541

"module": "datatable",

47542

"submodule": "datatable-core"

47543

},

47544

{

47545

"file": "datatable/js/core.js",

47546

"line": 193,

47547

"description": "The class or object to use for rendering the `<tfoot>` and any relevant\ncontent for it. This attribute is responsible for populating the the\ninstance's `foot` property.\n\nIf a class constructor (function) is passed, an instance of that clas will\nbe created at `render()` time and assigned to `this.foot`. If an object is\npassed, `foot` will be set immediately.\n\nValid objects or classes will have a `render()` method, though it is\nrecommended that they be subclasses of `Y.Base` or `Y.View`. If the object\nor class supports events, its `addTarget()` method will be called to bubble\nits events to this instance.\n\nThe core implementaion does not define a default `footerView`. Classes\nbuilt from this extension should define a default if appropriate.",

47548

"itemtype": "attribute",

47549

"name": "footerView",

47550

"type": "{Function|Object}",

47551

"since": "3.5.0",

47552

"class": "DataTable",

47553

"module": "datatable",

47554

"submodule": "datatable-core"

47555

},

47556

{

47557

"file": "datatable/js/core.js",

47558

"line": 219,

47559

"description": "The class or object to use for rendering the `<tbody>` or `<tbody>`s and\nall data row content for the table. This attribute is responsible for\npopulating the the instance's `body` property.\n\nIf a class constructor (function) is passed, an instance of that clas will\nbe created at `render()` time and assigned to `this.body`. If an object is\npassed, `body` will be set immediately.\n\nValid objects or classes will have a `render()` method, though it is\nrecommended that they be subclasses of `Y.Base` or `Y.View`. If the object\nor class supports events, its `addTarget()` method will be called to bubble\nits events to this instance.\n\nThe core implementaion does not define a default `bodyView`. Classes\nbuilt from this extension should define a default.",

47560

"itemtype": "attribute",

47561

"name": "bodyView",

47562

"type": "{Function|Object}",

47563

"since": "3.5.0",

47564

"class": "DataTable",

47565

"module": "datatable",

47566

"submodule": "datatable-core"

47567

},

47568

{

47569

"file": "datatable/js/core.js",

47570

"line": 245,

47571

"description": "Content for the `<table summary=\"ATTRIBUTE VALUE HERE\">`. Values assigned\nto this attribute will be HTML escaped for security.",

47572

"itemtype": "attribute",

47573

"name": "summary",

47574

"type": "{String}",

47575

"default": "'' (empty string)",

47576

"since": "3.5.0",

47577

"class": "DataTable",

47578

"module": "datatable",

47579

"submodule": "datatable-core"

47580

},

47581

{

47582

"file": "datatable/js/core.js",

47583

"line": 261,

47584

"description": "HTML content of an optional `<caption>` element to appear above the table.\nLeave this config unset or set to a falsy value to remove the caption.",

47585

"itemtype": "attribute",

47586

"name": "caption",

47587

"type": "HTML",

47588

"default": "'' (empty string)",

47589

"since": "3.5.0",

47590

"class": "DataTable",

47591

"module": "datatable",

47592

"submodule": "datatable-core"

47593

},

47594

{

47595

"file": "datatable/js/core.js",

47596

"line": 274,

47597

"description": "Deprecated as of 3.5.0. Passes through to the `data` attribute.\n\nWARNING: `get('recordset')` will NOT return a Recordset instance as of\n3.5.0. This is a break in backward compatibility.",

47598

"itemtype": "attribute",

47599

"name": "recordset",

47600

"type": "{Object[]|Recordset}",

47601

"deprecated": true,

47602

"deprecationMessage": "Use the `data` attribute",

47603

"since": "3.5.0",

47604

"class": "DataTable",

47605

"module": "datatable",

47606

"submodule": "datatable-core"

47607

},

47608

{

47609

"file": "datatable/js/core.js",

47610

"line": 291,

47611

"description": "Deprecated as of 3.5.0. Passes through to the `columns` attribute.\n\nIf a Columnset object is passed, its raw object and array column data will\nbe extracted for use.\n\nWARNING: `get('columnset')` will NOT return a Columnset instance as of\n3.5.0. This is a break in backward compatibility.",

47612

"itemtype": "attribute",

47613

"name": "columnset",

47614

"type": "{Object[]|Columnset}",

47615

"deprecated": true,

47616

"deprecationMessage": "Use the `columns` attribute",

47617

"since": "3.5.0",

47618

"class": "DataTable",

47619

"module": "datatable",

47620

"submodule": "datatable-core"

47621

},

47622

{

47623

"file": "datatable/js/core.js",

47624

"line": 315,

47625

"description": "The HTML template used to create the caption Node if the `caption`\nattribute is set.",

47626

"itemtype": "property",

47627

"name": "CAPTION_TEMPLATE",

47628

"type": "{HTML}",

47629

"default": "'<caption class=\"{className}\"/>'",

47630

"since": "3.5.0",

47631

"class": "DataTable",

47632

"module": "datatable",

47633

"submodule": "datatable-core"

47634

},

47635

{

47636

"file": "datatable/js/core.js",

47637

"line": 326,

47638

"description": "The HTML template used to create the table Node.",

47639

"itemtype": "property",

47640

"name": "TABLE_TEMPLATE",

47641

"type": "{HTML}",

47642

"default": "'<table cellspacing=\"0\" class=\"{className}\"/>'",

47643

"since": "3.5.0",

47644

"class": "DataTable",

47645

"module": "datatable",

47646

"submodule": "datatable-core"

47647

},

47648

{

47649

"file": "datatable/js/core.js",

47650

"line": 336,

47651

"description": "HTML template used to create table's `<tbody>` if configured with a\n`bodyView`.",

47652

"itemtype": "property",

47653

"name": "TBODY_TEMPLATE",

47654

"type": "{HTML}",

47655

"default": "'<tbody class=\"{className}\"/>'",

47656

"since": "3.5.0",

47657

"class": "DataTable",

47658

"module": "datatable",

47659

"submodule": "datatable-core"

47660

},

47661

{

47662

"file": "datatable/js/core.js",

47663

"line": 347,

47664

"description": "Template used to create the table's `<tfoot>` if configured with a\n`footerView`.",

47665

"itemtype": "property",

47666

"name": "TFOOT_TEMPLATE",

47667

"type": "{HTML}",

47668

"default": "'<tfoot class=\"{className}\"/>'",

47669

"since": "3.5.0",

47670

"class": "DataTable",

47671

"module": "datatable",

47672

"submodule": "datatable-core"

47673

},

47674

{

47675

"file": "datatable/js/core.js",

47676

"line": 359,

47677

"description": "Template used to create the table's `<thead>` if configured with a\n`headerView`.",

47678

"itemtype": "property",

47679

"name": "THEAD_TEMPLATE",

47680

"type": "{HTML}",

47681

"default": "'<thead class=\"{className}\"/>'",

47682

"since": "3.5.0",

47683

"class": "DataTable",

47684

"module": "datatable",

47685

"submodule": "datatable-core"

47686

},

47687

{

47688

"file": "datatable/js/core.js",

47689

"line": 371,

47690

"description": "The object or instance of the class assigned to `bodyView` that is\nresponsible for rendering and managing the table's `<tbody>`(s) and its\ncontent.",

47691

"itemtype": "property",

47692

"name": "body",

47693

"type": "{Object}",

47694

"default": "undefined (initially unset)",

47695

"since": "3.5.0",

47696

"class": "DataTable",

47697

"module": "datatable",

47698

"submodule": "datatable-core"

47699

},

47700

{

47701

"file": "datatable/js/core.js",

47702

"line": 383,

47703

"description": "The object or instance of the class assigned to `footerView` that is\nresponsible for rendering and managing the table's `<tfoot>` and its\ncontent.",

47704

"itemtype": "property",

47705

"name": "foot",

47706

"type": "{Object}",

47707

"default": "undefined (initially unset)",

47708

"since": "3.5.0",

47709

"class": "DataTable",

47710

"module": "datatable",

47711

"submodule": "datatable-core"

47712

},

47713

{

47714

"file": "datatable/js/core.js",

47715

"line": 395,

47716

"description": "The object or instance of the class assigned to `headerView` that is\nresponsible for rendering and managing the table's `<thead>` and its\ncontent.",

47717

"itemtype": "property",

47718

"name": "head",

47719

"type": "{Object}",

47720

"default": "undefined (initially unset)",

47721

"since": "3.5.0",

47722

"class": "DataTable",

47723

"module": "datatable",

47724

"submodule": "datatable-core"

47725

},

47726

{

47727

"file": "datatable/js/core.js",

47728

"line": 407,

47729

"description": "The ModelList that manages the table's data.",

47730

"itemtype": "property",

47731

"name": "data",

47732

"type": "{ModelList}",

47733

"default": "undefined (initially unset)",

47734

"since": "3.5.0",

47735

"class": "DataTable",

47736

"module": "datatable",

47737

"submodule": "datatable-core"

47738

},

47739

{

47740

"file": "datatable/js/core.js",

47741

"line": 418,

47742

"description": "Pass through to `delegate()` called from the `contentBox`.",

47743

"itemtype": "method",

47744

"name": "delegate",

47745

"params": [

47746

{

47747

"name": "type",

47748

"description": "the event type to delegate",

47749

"type": "String"

47750

},

47751

{

47752

"name": "fn",

47753

"description": "the callback function to execute. This function\n will be provided the event object for the delegated event.",

47754

"type": "Function"

47755

},

47756

{

47757

"name": "spec",

47758

"description": "a selector that must match the target of the\n event or a function to test target and its parents for a match",

47759

"type": "String|Function"

47760

},

47761

{

47762

"name": "context",

47763

"description": "optional argument that specifies what 'this' refers to",

47764

"type": "Object"

47765

},

47766

{

47767

"name": "args",

47768

"description": "0..n additional arguments to pass on to the callback\n function. These arguments will be added after the event object.",

47769

"type": "Any",

47770

"multiple": true

47771

}

47772

],

47773

"return": {

47774

"description": "the detach handle",

47775

"type": "EventHandle"

47776

},

47777

"since": "3.5.0",

47778

"class": "DataTable",

47779

"module": "datatable",

47780

"submodule": "datatable-core"

47781

},

47782

{

47783

"file": "datatable/js/core.js",

47784

"line": 439,

47785

"description": "Returns the `<td>` Node from the given row and column index. Alternately,\nthe `seed` can be a Node. If so, the nearest ancestor cell is returned.\nIf the `seed` is a cell, it is returned. If there is no cell at the given\ncoordinates, `null` is returned.\n\nOptionally, include an offset array or string to return a cell near the\ncell identified by the `seed`. The offset can be an array containing the\nnumber of rows to shift followed by the number of columns to shift, or one\nof \"above\", \"below\", \"next\", or \"previous\".\n\n<pre><code>// Previous cell in the previous row\nvar cell = table.getCell(e.target, [-1, -1]);\n\n// Next cell\nvar cell = table.getCell(e.target, 'next');\nvar cell = table.getCell(e.taregt, [0, 1];</pre></code>\n\nThis is actually just a pass through to the `bodyView` instance's method\nby the same name.",

47786

"itemtype": "method",

47787

"name": "getCell",

47788

"params": [

47789

{

47790

"name": "seed",

47791

"description": "Array of row and column indexes, or a Node that\n is either the cell itself or a descendant of one.",

47792

"type": "Number[]|Node"

47793

},

47794

{

47795

"name": "shift",

47796

"description": "Offset by which to identify the returned\n cell Node",

47797

"type": "Number[]|String",

47798

"optional": true

47799

}

47800

],

47801

"return": {

47802

"description": "",

47803

"type": "Node"

47804

},

47805

"since": "3.5.0",

47806

"class": "DataTable",

47807

"module": "datatable",

47808

"submodule": "datatable-core"

47809

},

47810

{

47811

"file": "datatable/js/core.js",

47812

"line": 473,

47813

"description": "Gets the column configuration object for the given key, name, or index. For\nnested columns, `name` can be an array of indexes, each identifying the index\nof that column in the respective parent's \"children\" array.\n\nIf you pass a column object, it will be returned.\n\nFor columns with keys, you can also fetch the column with\n`instance.get('columns.foo')`.",

47814

"itemtype": "method",

47815

"name": "getColumn",

47816

"params": [

47817

{

47818

"name": "name",

47819

"description": "Key, \"name\", index, or index array to\n identify the column",

47820

"type": "String|Number|Number[]"

47821

}

47822

],

47823

"return": {

47824

"description": "the column configuration object",

47825

"type": "Object"

47826

},

47827

"since": "3.5.0",

47828

"class": "DataTable",

47829

"module": "datatable",

47830

"submodule": "datatable-core"

47831

},

47832

{

47833

"file": "datatable/js/core.js",

47834

"line": 522,

47835

"description": "Returns the Model associated to the record `id`, `clientId`, or index (not\nrow index). If none of those yield a Model from the `data` ModelList, the\narguments will be passed to the `bodyView` instance's `getRecord` method\nif it has one.\n\nIf no Model can be found, `null` is returned.",

47836

"itemtype": "method",

47837

"name": "getRecord",

47838

"params": [

47839

{

47840

"name": "seed",

47841

"description": "Record `id`, `clientId`, index, Node, or\n identifier for a row or child element",

47842

"type": "Number|String|Node"

47843

}

47844

],

47845

"return": {

47846

"description": "",

47847

"type": "Model"

47848

},

47849

"since": "3.5.0",

47850

"class": "DataTable",

47851

"module": "datatable",

47852

"submodule": "datatable-core"

47853

},

47854

{

47855

"file": "datatable/js/core.js",

47856

"line": 552,

47857

"description": "Returns the `<tr>` Node from the given row index, Model, or Model's\n`clientId`. If the rows haven't been rendered yet, or if the row can't be\nfound by the input, `null` is returned.\n\nThis is actually just a pass through to the `bodyView` instance's method\nby the same name.",

47858

"itemtype": "method",

47859

"name": "getRow",

47860

"params": [

47861

{

47862

"name": "id",

47863

"description": "Row index, Model instance, or clientId",

47864

"type": "Number|String|Model"

47865

}

47866

],

47867

"return": {

47868

"description": "",

47869

"type": "Node"

47870

},

47871

"since": "3.5.0",

47872

"class": "DataTable",

47873

"module": "datatable",

47874

"submodule": "datatable-core"

47875

},

47876

{

47877

"file": "datatable/js/core.js",

47878

"line": 570,

47879

"description": "Updates the UI with the current attribute state. Fires the `renderHeader`,\n`renderBody`, and `renderFooter` events;",

47880

"itemtype": "method",

47881

"name": "syncUI",

47882

"since": "3.5.0",

47883

"class": "DataTable",

47884

"module": "datatable",

47885

"submodule": "datatable-core"

47886

},

47887

{

47888

"file": "datatable/js/core.js",

47889

"line": 594,

47890

"description": "Configuration object passed to the class constructor in `bodyView` during\nrender.\n\nThis property is set by the `_initViewConfig` method at instantiation.",

47891

"itemtype": "property",

47892

"name": "_bodyConfig",

47893

"type": "{Object}",

47894

"default": "undefined (initially unset)",

47895

"access": "protected",

47896

"tagname": "",

47897

"since": "3.5.0",

47898

"class": "DataTable",

47899

"module": "datatable",

47900

"submodule": "datatable-core"

47901

},

47902

{

47903

"file": "datatable/js/core.js",

47904

"line": 608,

47905

"description": "A map of column key to column configuration objects parsed from the\n`columns` attribute.",

47906

"itemtype": "property",

47907

"name": "_columnMap",

47908

"type": "{Object}",

47909

"default": "undefined (initially unset)",

47910

"access": "protected",

47911

"tagname": "",

47912

"since": "3.5.0",

47913

"class": "DataTable",

47914

"module": "datatable",

47915

"submodule": "datatable-core"

47916

},

47917

{

47918

"file": "datatable/js/core.js",

47919

"line": 620,

47920

"description": "Configuration object passed to the class constructor in `footerView` during\nrender.\n\nThis property is set by the `_initViewConfig` method at instantiation.",

47921

"itemtype": "property",

47922

"name": "_footerConfig",

47923

"type": "{Object}",

47924

"default": "undefined (initially unset)",

47925

"access": "protected",

47926

"tagname": "",

47927

"since": "3.5.0",

47928

"class": "DataTable",

47929

"module": "datatable",

47930

"submodule": "datatable-core"

47931

},

47932

{

47933

"file": "datatable/js/core.js",

47934

"line": 634,

47935

"description": "Configuration object passed to the class constructor in `headerView` during\nrender.\n\nThis property is set by the `_initViewConfig` method at instantiation.",

47936

"itemtype": "property",

47937

"name": "_headerConfig",

47938

"type": "{Object}",

47939

"default": "undefined (initially unset)",

47940

"access": "protected",

47941

"tagname": "",

47942

"since": "3.5.0",

47943

"class": "DataTable",

47944

"module": "datatable",

47945

"submodule": "datatable-core"

47946

},

47947

{

47948

"file": "datatable/js/core.js",

47949

"line": 648,

47950

"description": "The Node instance of the table containing the data rows. This is set when\nthe table is rendered. It may also be set by progressive enhancement,\nthough this extension does not provide the logic to parse from source.",

47951

"itemtype": "property",

47952

"name": "_tableNode",

47953

"type": "{Node}",

47954

"default": "undefined (initially unset)",

47955

"access": "protected",

47956

"tagname": "",

47957

"since": "3.5.0",

47958

"class": "DataTable",

47959

"module": "datatable",

47960

"submodule": "datatable-core"

47961

},

47962

{

47963

"file": "datatable/js/core.js",

47964

"line": 661,

47965

"description": "Configuration object used as the prototype of `_headerConfig`,\n`_bodyConfig`, and `_footerConfig`. Add properties to this object if you\nwant them in all three of the other config objects.\n\nThis property is set by the `_initViewConfig` method at instantiation.",

47966

"itemtype": "property",

47967

"name": "_viewConfig",

47968

"type": "{Object}",

47969

"default": "undefined (initially unset)",

47970

"access": "protected",

47971

"tagname": "",

47972

"since": "3.5.0",

47973

"class": "DataTable",

47974

"module": "datatable",

47975

"submodule": "datatable-core"

47976

},

47977

{

47978

"file": "datatable/js/core.js",

47979

"line": 676,

47980

"description": "Updates the `_columnMap` property in response to changes in the `columns`\nattribute.",

47981

"itemtype": "method",

47982

"name": "_afterColumnsChange",

47983

"params": [

47984

{

47985

"name": "e",

47986

"description": "The `columnsChange` event object",

47987

"type": "EventFacade"

47988

}

47989

],

47990

"access": "protected",

47991

"tagname": "",

47992

"since": "3.5.0",

47993

"class": "DataTable",

47994

"module": "datatable",

47995

"submodule": "datatable-core"

47996

},

47997

{

47998

"file": "datatable/js/core.js",

47999

"line": 690,

48000

"description": "Updates the `modelList` attributes of the rendered views in response to the\n`data` attribute being assigned a new ModelList.",

48001

"itemtype": "method",

48002

"name": "_afterDataChange",

48003

"params": [

48004

{

48005

"name": "e",

48006

"description": "the `dataChange` event",

48007

"type": "EventFacade"

48008

}

48009

],

48010

"access": "protected",

48011

"tagname": "",

48012

"since": "3.5.0",

48013

"class": "DataTable",

48014

"module": "datatable",

48015

"submodule": "datatable-core"

48016

},

48017

{

48018

"file": "datatable/js/core.js",

48019

"line": 713,

48020

"description": "Subscribes to attribute change events to update the UI.",

48021

"itemtype": "method",

48022

"name": "bindUI",

48023

"access": "protected",

48024

"tagname": "",

48025

"since": "3.5.0",

48026

"class": "DataTable",

48027

"module": "datatable",

48028

"submodule": "datatable-core"

48029

},

48030

{

48031

"file": "datatable/js/core.js",

48032

"line": 725,

48033

"description": "Creates a Model subclass from an array of attribute names or an object of\nattribute definitions. This is used to generate a class suitable to\nrepresent the data passed to the `data` attribute if no `recordType` is\nset.",

48034

"itemtype": "method",

48035

"name": "_createRecordClass",

48036

"params": [

48037

{

48038

"name": "attrs",

48039

"description": "Names assigned to the Model subclass's\n `ATTRS` or its entire `ATTRS` definition object",

48040

"type": "String[]|Object"

48041

}

48042

],

48043

"return": {

48044

"description": "",

48045

"type": "Model"

48046

},

48047

"access": "protected",

48048

"tagname": "",

48049

"since": "3.5.0",

48050

"class": "DataTable",

48051

"module": "datatable",

48052

"submodule": "datatable-core"

48053

},

48054

{

48055

"file": "datatable/js/core.js",

48056

"line": 754,

48057

"description": "Creates the `<table>`.",

48058

"itemtype": "method",

48059

"name": "_createTable",

48060

"return": {

48061

"description": "The `<table>` node",

48062

"type": "Node"

48063

},

48064

"access": "protected",

48065

"tagname": "",

48066

"since": "3.5.0",

48067

"class": "DataTable",

48068

"module": "datatable",

48069

"submodule": "datatable-core"

48070

},

48071

{

48072

"file": "datatable/js/core.js",

48073

"line": 768,

48074

"description": "Creates a `<tbody>` node from the `TBODY_TEMPLATE`.",

48075

"itemtype": "method",

48076

"name": "_createTBody",

48077

"access": "protected",

48078

"tagname": "",

48079

"since": "3.5.0",

48080

"class": "DataTable",

48081

"module": "datatable",

48082

"submodule": "datatable-core"

48083

},

48084

{

48085

"file": "datatable/js/core.js",

48086

"line": 781,

48087

"description": "Creates a `<tfoot>` node from the `TFOOT_TEMPLATE`.",

48088

"itemtype": "method",

48089

"name": "_createTFoot",

48090

"access": "protected",

48091

"tagname": "",

48092

"since": "3.5.0",

48093

"class": "DataTable",

48094

"module": "datatable",

48095

"submodule": "datatable-core"

48096

},

48097

{

48098

"file": "datatable/js/core.js",

48099

"line": 794,

48100

"description": "Creates a `<thead>` node from the `THEAD_TEMPLATE`.",

48101

"itemtype": "method",

48102

"name": "_createTHead",

48103

"access": "protected",

48104

"tagname": "",

48105

"since": "3.5.0",

48106

"class": "DataTable",

48107

"module": "datatable",

48108

"submodule": "datatable-core"

48109

},

48110

{

48111

"file": "datatable/js/core.js",

48112

"line": 807,

48113

"description": "Calls `render()` on the `bodyView` class instance.",

48114

"itemtype": "method",

48115

"name": "_defRenderBodyFn",

48116

"params": [

48117

{

48118

"name": "e",

48119

"description": "The renderBody event",

48120

"type": "EventFacade"

48121

}

48122

],

48123

"access": "protected",

48124

"tagname": "",

48125

"since": "3.5.0",

48126

"class": "DataTable",

48127

"module": "datatable",

48128

"submodule": "datatable-core"

48129

},

48130

{

48131

"file": "datatable/js/core.js",

48132

"line": 819,

48133

"description": "Calls `render()` on the `footerView` class instance.",

48134

"itemtype": "method",

48135

"name": "_defRenderFooterFn",

48136

"params": [

48137

{

48138

"name": "e",

48139

"description": "The renderFooter event",

48140

"type": "EventFacade"

48141

}

48142

],

48143

"access": "protected",

48144

"tagname": "",

48145

"since": "3.5.0",

48146

"class": "DataTable",

48147

"module": "datatable",

48148

"submodule": "datatable-core"

48149

},

48150

{

48151

"file": "datatable/js/core.js",

48152

"line": 831,

48153

"description": "Calls `render()` on the `headerView` class instance.",

48154

"itemtype": "method",

48155

"name": "_defRenderHeaderFn",

48156

"params": [

48157

{

48158

"name": "e",

48159

"description": "The renderHeader event",

48160

"type": "EventFacade"

48161

}

48162

],

48163

"access": "protected",

48164

"tagname": "",

48165

"since": "3.5.0",

48166

"class": "DataTable",

48167

"module": "datatable",

48168

"submodule": "datatable-core"

48169

},

48170

{

48171

"file": "datatable/js/core.js",

48172

"line": 843,

48173

"description": "Renders the `<table>` and, if there are associated Views, the `<thead>`,\n`<tfoot>`, and `<tbody>` (empty until `syncUI`).\n\nAssigns the generated table nodes to the `_tableNode`, `_theadNode`,\n`_tfootNode`, and `_tbodyNode` properties. Assigns the instantiated Views\nto the `head`, `foot`, and `body` properties.",

48174

"itemtype": "method",

48175

"name": "_defRenderTableFn",

48176

"params": [

48177

{

48178

"name": "e",

48179

"description": "The renderTable event",

48180

"type": "EventFacade"

48181

}

48182

],

48183

"access": "protected",

48184

"tagname": "",

48185

"since": "3.5.0",

48186

"class": "DataTable",

48187

"module": "datatable",

48188

"submodule": "datatable-core"

48189

},

48190

{

48191

"file": "datatable/js/core.js",

48192

"line": 895,

48193

"description": "Contains column configuration objects for those columns believed to be intended for display in the `<tbody>`. Populated by `_setDisplayColumns`.",

48194

"itemtype": "property",

48195

"name": "_displayColumns",

48196

"type": "{Object[]}",

48197

"value": "undefined (initially not set)",

48198

"access": "protected",

48199

"tagname": "",

48200

"since": "3.5.0",

48201

"class": "DataTable",

48202

"module": "datatable",

48203

"submodule": "datatable-core"

48204

},

48205

{

48206

"file": "datatable/js/core.js",

48207

"line": 906,

48208

"description": "The getter for the `columns` attribute. Returns the array of column\nconfiguration objects if `instance.get('columns')` is called, or the\nspecific column object if `instance.get('columns.columnKey')` is called.",

48209

"itemtype": "method",

48210

"name": "_getColumns",

48211

"params": [

48212

{

48213

"name": "columns",

48214

"description": "The full array of column objects",

48215

"type": "Object[]"

48216

},

48217

{

48218

"name": "name",

48219

"description": "The attribute name requested\n (e.g. 'columns' or 'columns.foo');",

48220

"type": "String"

48221

}

48222

],

48223

"access": "protected",

48224

"tagname": "",

48225

"since": "3.5.0",

48226

"class": "DataTable",

48227

"module": "datatable",

48228

"submodule": "datatable-core"

48229

},

48230

{

48231

"file": "datatable/js/core.js",

48232

"line": 925,

48233

"description": "Relays the `get()` request for the deprecated `columnset` attribute to the\n`columns` attribute.\n\nTHIS BREAKS BACKWARD COMPATIBILITY. 3.4.1 and prior implementations will\nexpect a Columnset instance returned from `get('columnset')`.",

48234

"itemtype": "method",

48235

"name": "_getColumnset",

48236

"params": [

48237

{

48238

"name": "ignored",

48239

"description": "The current value stored in the `columnset` state",

48240

"type": "Object"

48241

},

48242

{

48243

"name": "name",

48244

"description": "The attribute name requested\n (e.g. 'columnset' or 'columnset.foo');",

48245

"type": "String"

48246

}

48247

],

48248

"deprecated": true,

48249

"deprecationMessage": "This will be removed with the `columnset` attribute in a future\n version.",

48250

"access": "protected",

48251

"tagname": "",

48252

"since": "3.5.0",

48253

"class": "DataTable",

48254

"module": "datatable",

48255

"submodule": "datatable-core"

48256

},

48257

{

48258

"file": "datatable/js/core.js",

48259

"line": 945,

48260

"description": "The getter for the `data` attribute. Returns the ModelList stored in the\n`data` property. If the ModelList is not yet set, it returns the current\nraw data (presumably an empty array or `undefined`).",

48261

"itemtype": "method",

48262

"name": "_getData",

48263

"params": [

48264

{

48265

"name": "val",

48266

"description": "The current data stored in the attribute",

48267

"type": "Object[]|ModelList"

48268

}

48269

],

48270

"access": "protected",

48271

"tagname": "",

48272

"since": "3.5.0",

48273

"class": "DataTable",

48274

"module": "datatable",

48275

"submodule": "datatable-core"

48276

},

48277

{

48278

"file": "datatable/js/core.js",

48279

"line": 959,

48280

"description": "Initializes the `_columnMap` property from the configured `columns`\nattribute. If `columns` is not set, but `recordType` is, it uses the\n`ATTRS` of that class. If neither are set, it temporarily falls back to an\nempty array. `_initRecordType` will call back into this method if it finds\nthe `columnMap` empty.",

48281

"itemtype": "method",

48282

"name": "_initColumns",

48283

"access": "protected",

48284

"tagname": "",

48285

"since": "3.5.0",

48286

"class": "DataTable",

48287

"module": "datatable",

48288

"submodule": "datatable-core"

48289

},

48290

{

48291

"file": "datatable/js/core.js",

48292

"line": 988,

48293

"description": "Initializes the instance's `data` property from the value of the `data`\nattribute. If the attribute value is a ModelList, it is assigned directly\nto `this.data`. If it is an array, a ModelList is created, its `model`\nproperty is set to the configured `recordType` class, and it is seeded with\nthe array data. This ModelList is then assigned to `this.data`.",

48294

"itemtype": "method",

48295

"name": "_initData",

48296

"access": "protected",

48297

"tagname": "",

48298

"since": "3.5.0",

48299

"class": "DataTable",

48300

"module": "datatable",

48301

"submodule": "datatable-core"

48302

},

48303

{

48304

"file": "datatable/js/core.js",

48305

"line": 1027,

48306

"description": "Publishes core events.",

48307

"itemtype": "method",

48308

"name": "_initEvents",

48309

"access": "protected",

48310

"tagname": "",

48311

"since": "3.5.0",

48312

"class": "DataTable",

48313

"module": "datatable",

48314

"submodule": "datatable-core"

48315

},

48316

{

48317

"file": "datatable/js/core.js",

48318

"line": 1053,

48319

"description": "Initializes the columns, `recordType` and data ModelList.",

48320

"itemtype": "method",

48321

"name": "initializer",

48322

"access": "protected",

48323

"tagname": "",

48324

"since": "3.5.0",

48325

"class": "DataTable",

48326

"module": "datatable",

48327

"submodule": "datatable-core"

48328

},

48329

{

48330

"file": "datatable/js/core.js",

48331

"line": 1080,

48332

"description": "If the `recordType` attribute is not set, this method attempts to set a\ndefault value.\n\nIt tries the following methods to determine a default:\n\n1. If the `data` attribute is set with a ModelList with a `model` property,\n that class is used.\n2. If the `data` attribute is set with a non-empty ModelList, the\n `constructor` of the first item is used.\n3. If the `data` attribute is set with a non-empty array and the first item\n is a Base subclass, its constructor is used.\n4. If the `data` attribute is set with a non-empty array a custom Model\n subclass is generated using the keys of the first item as its `ATTRS`.\n5. If the `_columnMap` property has keys, a custom Model subclass is\n generated using those keys as its `ATTRS`.\n\nOf none of those are successful, it subscribes to the change events for\n`columns`, `recordType`, and `data` to try again.\n\nIf defaulting the `recordType` and the current `_columnMap` property is\nempty, it will call `_initColumns`.",

48333

"itemtype": "method",

48334

"name": "_initRecordType",

48335

"access": "protected",

48336

"tagname": "",

48337

"since": "3.5.0",

48338

"class": "DataTable",

48339

"module": "datatable",

48340

"submodule": "datatable-core"

48341

},

48342

{

48343

"file": "datatable/js/core.js",

48344

"line": 1176,

48345

"description": "Initializes the `_viewConfig`, `_headerConfig`, `_bodyConfig`, and\n`_footerConfig` properties with the configuration objects that will be\npassed to the constructors of the `headerView`, `bodyView`, and\n`footerView`.\n\nExtensions can add to the config objects to deliver custom parameters at\nview instantiation. `_viewConfig` is used as the prototype of the other\nthree config objects, so properties added here will be inherited by all\nconfigs.",

48346

"itemtype": "method",

48347

"name": "_initViewConfig",

48348

"access": "protected",

48349

"tagname": "",

48350

"since": "3.5.0",

48351

"class": "DataTable",

48352

"module": "datatable",

48353

"submodule": "datatable-core"

48354

},

48355

{

48356

"file": "datatable/js/core.js",

48357

"line": 1203,

48358

"description": "Iterates the array of column configurations to capture all columns with a\n`key` property. Columns that are represented as strings will be replaced\nwith objects with the string assigned as the `key` property. If a column\nhas a `children` property, it will be iterated, adding any nested column\nkeys to the returned map. There is no limit to the levels of nesting.\n\nAll columns are assigned a `_yuid` stamp and `_id` property corresponding\nto the column's configured `name` or `key` property with any spaces\nreplaced with dashes. If the same `name` or `key` appears in multiple\ncolumns, subsequent appearances will have their `_id` appended with an\nincrementing number (e.g. if column \"foo\" is included in the `columns`\nattribute twice, the first will get `_id` of \"foo\", and the second an `_id`\nof \"foo1\"). Columns that are children of other columns will have the\n`_parent` property added, assigned the column object to which they belong.\n\nThe result is an object map with column keys as the property name and the\ncorresponding column object as the associated value.",

48359

"itemtype": "method",

48360

"name": "_parseColumns",

48361

"params": [

48362

{

48363

"name": "columns",

48364

"description": "The array of column names or\n configuration objects to scan",

48365

"type": "Object[]|String[]"

48366

}

48367

],

48368

"access": "protected",

48369

"tagname": "",

48370

"since": "3.5.0",

48371

"class": "DataTable",

48372

"module": "datatable",

48373

"submodule": "datatable-core"

48374

},

48375

{

48376

"file": "datatable/js/core.js",

48377

"line": 1313,

48378

"description": "Builds the table and attaches it to the DOM. This requires the host class\nto provide a `contentBox` attribute. This is typically provided by Widget.",

48379

"itemtype": "method",

48380

"name": "renderUI",

48381

"access": "protected",

48382

"tagname": "",

48383

"since": "3.5.0",

48384

"class": "DataTable",

48385

"module": "datatable",

48386

"submodule": "datatable-core"

48387

},

48388

{

48389

"file": "datatable/js/core.js",

48390

"line": 1354,

48391

"description": "Assigns the `_columnMap` property with the parsed results of the array of\ncolumn definitions passed.",

48392

"itemtype": "method",

48393

"name": "_setColumnMap",

48394

"params": [

48395

{

48396

"name": "columns",

48397

"description": "the raw column configuration objects or\n key names",

48398

"type": "Object[]|String[]"

48399

}

48400

],

48401

"access": "protected",

48402

"tagname": "",

48403

"since": "3.5.0",

48404

"class": "DataTable",

48405

"module": "datatable",

48406

"submodule": "datatable-core"

48407

},

48408

{

48409

"file": "datatable/js/core.js",

48410

"line": 1368,

48411

"description": "Relays attribute assignments of the deprecated `columnset` attribute to the\n`columns` attribute. If a Columnset is object is passed, its basic object\nstructure is mined.",

48412

"itemtype": "method",

48413

"name": "_setColumnset",

48414

"params": [

48415

{

48416

"name": "val",

48417

"description": "The columnset value to relay",

48418

"type": "Array|Columnset"

48419

}

48420

],

48421

"deprecated": true,

48422

"deprecationMessage": "This will be removed with the deprecated `columnset` attribute\n in a later version.",

48423

"access": "protected",

48424

"tagname": "",

48425

"since": "3.5.0",

48426

"class": "DataTable",

48427

"module": "datatable",

48428

"submodule": "datatable-core"

48429

},

48430

{

48431

"file": "datatable/js/core.js",

48432

"line": 1390,

48433

"description": "Accepts an object with `each` and `getAttrs` (preferably a ModelList or\nsubclass) or an array of data objects. If an array is passes, it will\ncreate a ModelList to wrap the data. In doing so, it will set the created\nModelList's `model` property to the class in the `recordType` attribute,\nwhich will be defaulted if not yet set.\n\nIf the `data` property is already set with a ModelList, passing an array as\nthe value will call the ModelList's `reset()` method with that array rather\nthan replacing the stored ModelList wholesale.\n\nAny non-ModelList-ish and non-array value is invalid.",

48434

"itemtype": "method",

48435

"name": "_setData",

48436

"access": "protected",

48437

"tagname": "",

48438

"since": "3.5.0",

48439

"class": "DataTable",

48440

"module": "datatable",

48441

"submodule": "datatable-core"

48442

},

48443

{

48444

"file": "datatable/js/core.js",

48445

"line": 1440,

48446

"description": "Stores an array of columns intended for display in the `_displayColumns`\nproperty. This method assumes that if a column configuration object does\nnot have children, it is a display column.",

48447

"itemtype": "method",

48448

"name": "_setDisplayColumns",

48449

"params": [

48450

{

48451

"name": "columns",

48452

"description": "Column config array to extract display columns from",

48453

"type": "Object[]"

48454

}

48455

],

48456

"access": "protected",

48457

"tagname": "",

48458

"since": "3.5.0",

48459

"class": "DataTable",

48460

"module": "datatable",

48461

"submodule": "datatable-core"

48462

},

48463

{

48464

"file": "datatable/js/core.js",

48465

"line": 1471,

48466

"description": "Relays the value assigned to the deprecated `recordset` attribute to the\n`data` attribute. If a Recordset instance is passed, the raw object data\nwill be culled from it.",

48467

"itemtype": "method",

48468

"name": "_setRecordset",

48469

"params": [

48470

{

48471

"name": "val",

48472

"description": "The recordset value to relay",

48473

"type": "Object[]|Recordset"

48474

}

48475

],

48476

"deprecated": true,

48477

"deprecationMessage": "This will be removed with the deprecated `recordset` attribute\n in a later version.",

48478

"access": "protected",

48479

"tagname": "",

48480

"since": "3.5.0",

48481

"class": "DataTable",

48482

"module": "datatable",

48483

"submodule": "datatable-core"

48484

},

48485

{

48486

"file": "datatable/js/core.js",

48487

"line": 1499,

48488

"description": "Accepts a Base subclass (preferably a Model subclass). Alternately, it will\ngenerate a custom Model subclass from an array of attribute names or an\nobject defining attributes and their respective configurations (it is\nassigned as the `ATTRS` of the new class).\n\nAny other value is invalid.",

48489

"itemtype": "method",

48490

"name": "_setRecordType",

48491

"params": [

48492

{

48493

"name": "val",

48494

"description": "The Model subclass, array of\n attribute names, or the `ATTRS` definition for a custom model\n subclass",

48495

"type": "Function|String[]|Object"

48496

}

48497

],

48498

"return": {

48499

"description": "A Base/Model subclass",

48500

"type": "Function"

48501

},

48502

"access": "protected",

48503

"tagname": "",

48504

"since": "3.5.0",

48505

"class": "DataTable",

48506

"module": "datatable",

48507

"submodule": "datatable-core"

48508

},

48509

{

48510

"file": "datatable/js/core.js",

48511

"line": 1528,

48512

"description": "Creates, removes, or updates the table's `<caption>` element per the input\nvalue. Empty values result in the caption being removed.",

48513

"itemtype": "method",

48514

"name": "_uiSetCaption",

48515

"params": [

48516

{

48517

"name": "htmlContent",

48518

"description": "The content to populate the table caption",

48519

"type": "HTML"

48520

}

48521

],

48522

"access": "protected",

48523

"tagname": "",

48524

"since": "3.5.0",

48525

"class": "DataTable",

48526

"module": "datatable",

48527

"submodule": "datatable-core"

48528

},

48529

{

48530

"file": "datatable/js/core.js",

48531

"line": 1560,

48532

"description": "Updates the table's `summary` attribute with the input value.",

48533

"itemtype": "method",

48534

"name": "_uiSetSummary",

48535

"access": "protected",

48536

"tagname": "",

48537

"since": "3.5.0",

48538

"class": "DataTable",

48539

"module": "datatable",

48540

"submodule": "datatable-core"

48541

},

48542

{

48543

"file": "datatable/js/core.js",

48544

"line": 1575,

48545

"description": "Sets the `boundingBox` and table width per the input value.",

48546

"itemtype": "method",

48547

"name": "_uiSetWidth",

48548

"params": [

48549

{

48550

"name": "width",

48551

"description": "The width to make the table",

48552

"type": "Number|String"

48553

}

48554

],

48555

"access": "protected",

48556

"tagname": "",

48557

"since": "3.5.0",

48558

"class": "DataTable",

48559

"module": "datatable",

48560

"submodule": "datatable-core"

48561

},

48562

{

48563

"file": "datatable/js/core.js",

48564

"line": 1605,

48565

"description": "Verifies the input value is a function with a `render` method on its\nprototype. `null` is also accepted to remove the default View.",

48566

"itemtype": "method",

48567

"name": "_validateView",

48568

"access": "protected",

48569

"tagname": "",

48570

"since": "3.5.0",

48571

"class": "DataTable",

48572

"module": "datatable",

48573

"submodule": "datatable-core"

48574

},

48575

{

48576

"file": "datatable/js/datatable-datasource.js",

48577

"line": 23,

48578

"description": "The namespace for the plugin. This will be the property on the host which\nreferences the plugin instance.",

48579

"itemtype": "property",

48580

"name": "NS",

48581

"type": "String",

48582

"static": 1,

48583

"final": 1,

48584

"value": "\"datasource\"",

48585

"class": "Plugin.DataTableDataSource",

48586

"module": "datatable",

48587

"submodule": "datatable-datasource"

48588

},

48589

{

48590

"file": "datatable/js/datatable-datasource.js",

48591

"line": 35,

48592

"description": "Class name.",

48593

"itemtype": "property",

48594

"name": "NAME",

48595

"type": "String",

48596

"static": 1,

48597

"final": 1,

48598

"value": "\"dataTableDataSource\"",

48599

"class": "Plugin.DataTableDataSource",

48600

"module": "datatable",

48601

"submodule": "datatable-datasource"

48602

},

48603

{

48604

"file": "datatable/js/datatable-datasource.js",

48605

"line": 52,

48606

"itemtype": "attribute",

48607

"name": "datasource",

48608

"description": "Pointer to DataSource instance.",

48609

"type": "{DataSource}",

48610

"class": "Plugin.DataTableDataSource",

48611

"module": "datatable",

48612

"submodule": "datatable-datasource"

48613

},

48614

{

48615

"file": "datatable/js/datatable-datasource.js",

48616

"line": 61,

48617

"itemtype": "attribute",

48618

"name": "initialRequest",

48619

"description": "Request sent to DataSource immediately upon initialization.",

48620

"type": "Object",

48621

"class": "Plugin.DataTableDataSource",

48622

"module": "datatable",

48623

"submodule": "datatable-datasource"

48624

},

48625

{

48626

"file": "datatable/js/datatable-datasource.js",

48627

"line": 83,

48628

"itemtype": "method",

48629

"name": "_setDataSource",

48630

"description": "Creates new DataSource instance if one is not provided.",

48631

"params": [

48632

{

48633

"name": "ds",

48634

"description": "",

48635

"type": "Object | Y.DataSource"

48636

}

48637

],

48638

"return": {

48639

"description": "",

48640

"type": "DataSource"

48641

},

48642

"access": "private",

48643

"tagname": "",

48644

"class": "Plugin.DataTableDataSource",

48645

"module": "datatable",

48646

"submodule": "datatable-datasource"

48647

},

48648

{

48649

"file": "datatable/js/datatable-datasource.js",

48650

"line": 94,

48651

"itemtype": "method",

48652

"name": "_setInitialRequest",

48653

"description": "Sends request to DataSource.",

48654

"params": [

48655

{

48656

"name": "request",

48657

"description": "DataSource request.",

48658

"type": "Object"

48659

}

48660

],

48661

"access": "private",

48662

"tagname": "",

48663

"class": "Plugin.DataTableDataSource",

48664

"module": "datatable",

48665

"submodule": "datatable-datasource"

48666

},

48667

{

48668

"file": "datatable/js/datatable-datasource.js",

48669

"line": 108,

48670

"description": "Initializer.",

48671

"itemtype": "method",

48672

"name": "initializer",

48673

"params": [

48674

{

48675

"name": "config",

48676

"description": "Config object.",

48677

"type": "Object"

48678

}

48679

],

48680

"access": "private",

48681

"tagname": "",

48682

"class": "Plugin.DataTableDataSource",

48683

"module": "datatable",

48684

"submodule": "datatable-datasource"

48685

},

48686

{

48687

"file": "datatable/js/datatable-datasource.js",

48688

"line": 127,

48689

"description": "Load data by calling DataSource's sendRequest() method under the hood.",

48690

"itemtype": "method",

48691

"name": "load",

48692

"params": [

48693

{

48694

"name": "config",

48695

"description": "Optional configuration parameters:\n\n<dl>\n<dt>request</dt><dd>Pass in a new request, or initialRequest is used.</dd>\n<dt>callback</dt><dd>Pass in DataSource callback object, or the following default is used:\n <dl>\n <dt>success</dt><dd>datatable.onDataReturnInitializeTable</dd>\n <dt>failure</dt><dd>datatable.onDataReturnInitializeTable</dd>\n <dt>scope</dt><dd>datatable</dd>\n <dt>argument</dt><dd>datatable.getState()</dd>\n </dl>\n</dd>\n<dt>datasource</dt><dd>Pass in a new DataSource instance to override the current DataSource for this transaction.</dd>\n</dl>",

48696

"type": "Object"

48697

}

48698

],

48699

"class": "Plugin.DataTableDataSource",

48700

"module": "datatable",

48701

"submodule": "datatable-datasource"

48702

},

48703

{

48704

"file": "datatable/js/datatable-datasource.js",

48705

"line": 161,

48706

"description": "Callback function passed to DataSource's sendRequest() method populates\nan entire DataTable with new data, clearing previous data, if any.",

48707

"itemtype": "method",

48708

"name": "onDataReturnInitializeTable",

48709

"params": [

48710

{

48711

"name": "e",

48712

"description": "DataSource Event Facade object.",

48713

"type": "Event.Facade"

48714

}

48715

],

48716

"class": "Plugin.DataTableDataSource",

48717

"module": "datatable",

48718

"submodule": "datatable-datasource"

48719

},

48720

{

48721

"file": "datatable/js/head.js",

48722

"line": 85,

48723

"description": "Template used to create the table's header cell markup. Override this to\ncustomize how header cell markup is created.",

48724

"itemtype": "property",

48725

"name": "CELL_TEMPLATE",

48726

"type": "{HTML}",

48727

"default": "'<th id=\"{id}\" colspan=\"{_colspan}\" rowspan=\"{_rowspan}\" class=\"{className}\" scope=\"col\" {_id}{abbr}>{content}</th>'",

48728

"since": "3.5.0",

48729

"class": "DataTable.HeaderView",

48730

"module": "datatable",

48731

"submodule": "datatable-head",

48732

"namespace": "DataTable"

48733

},

48734

{

48735

"file": "datatable/js/head.js",

48736

"line": 97,

48737

"description": "The data representation of the header rows to render. This is assigned by\nparsing the `columns` configuration array, and is used by the render()\nmethod.",

48738

"itemtype": "property",

48739

"name": "columns",

48740

"type": "{Array[]}",

48741

"default": "(initially unset)",

48742

"since": "3.5.0",

48743

"class": "DataTable.HeaderView",

48744

"module": "datatable",

48745

"submodule": "datatable-head",

48746

"namespace": "DataTable"

48747

},

48748

{

48749

"file": "datatable/js/head.js",

48750

"line": 110,

48751

"description": "Template used to create the table's header row markup. Override this to\ncustomize the row markup.",

48752

"itemtype": "property",

48753

"name": "ROW_TEMPLATE",

48754

"type": "{HTML}",

48755

"default": "'<tr>{content}</tr>'",

48756

"since": "3.5.0",

48757

"class": "DataTable.HeaderView",

48758

"module": "datatable",

48759

"submodule": "datatable-head",

48760

"namespace": "DataTable"

48761

},

48762

{

48763

"file": "datatable/js/head.js",

48764

"line": 122,

48765

"description": "The object that serves as the source of truth for column and row data.\nThis property is assigned at instantiation from the `source` property of\nthe configuration object passed to the constructor.",

48766

"itemtype": "property",

48767

"name": "source",

48768

"type": "{Object}",

48769

"default": "(initially unset)",

48770

"since": "3.5.0",

48771

"class": "DataTable.HeaderView",

48772

"module": "datatable",

48773

"submodule": "datatable-head",

48774

"namespace": "DataTable"

48775

},

48776

{

48777

"file": "datatable/js/head.js",

48778

"line": 138,

48779

"description": "Builds a CSS class name from the provided tokens. If the instance is\ncreated with `cssPrefix` or `source` in the configuration, it will use this\nprefix (the `_cssPrefix` of the `source` object) as the base token. This\nallows class instances to generate markup with class names that correspond\nto the parent class that is consuming them.",

48780

"itemtype": "method",

48781

"name": "getClassName",

48782

"params": [

48783

{

48784

"name": "token",

48785

"description": "Any number of tokens to include in the class name",

48786

"type": "String",

48787

"multiple": true

48788

}

48789

],

48790

"return": {

48791

"description": "The generated class name",

48792

"type": "String"

48793

},

48794

"since": "3.5.0",

48795

"class": "DataTable.HeaderView",

48796

"module": "datatable",

48797

"submodule": "datatable-head",

48798

"namespace": "DataTable"

48799

},

48800

{

48801

"file": "datatable/js/head.js",

48802

"line": 158,

48803

"description": "Creates the `<thead>` Node content by assembling markup generated by\npopulating the `ROW_TEMPLATE` and `CELL_TEMPLATE` templates with content\nfrom the `columns` property.",

48804

"itemtype": "method",

48805

"name": "render",

48806

"return": {

48807

"description": "The instance",

48808

"type": "HeaderView"

48809

},

48810

"chainable": 1,

48811

"since": "3.5.0",

48812

"class": "DataTable.HeaderView",

48813

"module": "datatable",

48814

"submodule": "datatable-head",

48815

"namespace": "DataTable"

48816

},

48817

{

48818

"file": "datatable/js/head.js",

48819

"line": 235,

48820

"description": "The base token for classes created with the `getClassName` method.",

48821

"itemtype": "property",

48822

"name": "_cssPrefix",

48823

"type": "{String}",

48824

"default": "'yui3-table'",

48825

"access": "protected",

48826

"tagname": "",

48827

"since": "3.5.0",

48828

"class": "DataTable.HeaderView",

48829

"module": "datatable",

48830

"submodule": "datatable-head",

48831

"namespace": "DataTable"

48832

},

48833

{

48834

"file": "datatable/js/head.js",

48835

"line": 246,

48836

"description": "Handles changes in the source's columns attribute. Redraws the headers.",

48837

"itemtype": "method",

48838

"name": "_afterColumnsChange",

48839

"params": [

48840

{

48841

"name": "e",

48842

"description": "The `columnsChange` event object",

48843

"type": "EventFacade"

48844

}

48845

],

48846

"access": "protected",

48847

"tagname": "",

48848

"since": "3.5.0",

48849

"class": "DataTable.HeaderView",

48850

"module": "datatable",

48851

"submodule": "datatable-head",

48852

"namespace": "DataTable"

48853

},

48854

{

48855

"file": "datatable/js/head.js",

48856

"line": 260,

48857

"description": "Binds event subscriptions from the UI and the source (if assigned).",

48858

"itemtype": "method",

48859

"name": "bindUI",

48860

"access": "protected",

48861

"tagname": "",

48862

"since": "3.5.0",

48863

"class": "DataTable.HeaderView",

48864

"module": "datatable",

48865

"submodule": "datatable-head",

48866

"namespace": "DataTable"

48867

},

48868

{

48869

"file": "datatable/js/head.js",

48870

"line": 276,

48871

"description": "Destroys the instance.",

48872

"itemtype": "method",

48873

"name": "destructor",

48874

"access": "protected",

48875

"tagname": "",

48876

"since": "3.5.0",

48877

"class": "DataTable.HeaderView",

48878

"module": "datatable",

48879

"submodule": "datatable-head",

48880

"namespace": "DataTable"

48881

},

48882

{

48883

"file": "datatable/js/head.js",

48884

"line": 287,

48885

"description": "Holds the event subscriptions needing to be detached when the instance is\n`destroy()`ed.",

48886

"itemtype": "property",

48887

"name": "_eventHandles",

48888

"type": "{Object}",

48889

"default": "undefined (initially unset)",

48890

"access": "protected",

48891

"tagname": "",

48892

"since": "3.5.0",

48893

"class": "DataTable.HeaderView",

48894

"module": "datatable",

48895

"submodule": "datatable-head",

48896

"namespace": "DataTable"

48897

},

48898

{

48899

"file": "datatable/js/head.js",

48900

"line": 299,

48901

"description": "Initializes the instance. Reads the following configuration properties:\n\n * `columns` - (REQUIRED) The initial column information\n * `cssPrefix` - The base string for classes generated by `getClassName`\n * `source` - The object to serve as source of truth for column info",

48902

"itemtype": "method",

48903

"name": "initializer",

48904

"params": [

48905

{

48906

"name": "config",

48907

"description": "Configuration data",

48908

"type": "Object"

48909

}

48910

],

48911

"access": "protected",

48912

"tagname": "",

48913

"since": "3.5.0",

48914

"class": "DataTable.HeaderView",

48915

"module": "datatable",

48916

"submodule": "datatable-head",

48917

"namespace": "DataTable"

48918

},

48919

{

48920

"file": "datatable/js/head.js",

48921

"line": 326,

48922

"description": "Translate the input column format into a structure useful for rendering a\n`<thead>`, rows, and cells. The structure of the input is expected to be a\nsingle array of objects, where each object corresponds to a `<th>`. Those\nobjects may contain a `children` property containing a similarly structured\narray to indicate the nested cells should be grouped under the parent\ncolumn's colspan in a separate row of header cells. E.g.\n\n<pre><code>\n[\n { key: 'id' }, // no nesting\n { key: 'name', children: [\n { key: 'firstName', label: 'First' },\n { key: 'lastName', label: 'Last' } ] }\n]\n</code></pre>\n\nwould indicate two header rows with the first column 'id' being assigned a\n`rowspan` of `2`, the 'name' column appearing in the first row with a\n`colspan` of `2`, and the 'firstName' and 'lastName' columns appearing in\nthe second row, below the 'name' column.\n\n<pre>\n---------------------\n| | name |\n| |---------------\n| id | First | Last |\n---------------------\n</pre>\n\nSupported properties of the column objects include:\n\n * `label` - The HTML content of the header cell.\n * `key` - If `label` is not specified, the `key` is used for content.\n * `children` - Array of columns to appear below this column in the next\n row.\n * `abbr` - The content of the 'abbr' attribute of the `<th>`\n * `headerTemplate` - Overrides the instance's `CELL_TEMPLATE` for cells\n in this column only.\n\nThe output structure is basically a simulation of the `<thead>` structure\nwith arrays for rows and objects for cells. Column objects have the\nfollowing properties added to them:\n\n * `id` - (Defaulted by DataTable) The id to assign the rendered\n column\n * `_colspan` - Per the `<th>` attribute\n * `_rowspan` - Per the `<th>` attribute\n * `_parent` - (Added by DataTable) If the column is a child of another\n column, this points to its parent column\n\nThe column object is also used to provide values for {placeholder}\nreplacement in the `CELL_TEMPLATE`, so you can modify the template and\ninclude other column object properties to populate them.",

48923

"itemtype": "method",

48924

"name": "_parseColumns",

48925

"params": [

48926

{

48927

"name": "data",

48928

"description": "Array of column object data",

48929

"type": "Object[]"

48930

}

48931

],

48932

"return": {

48933

"description": "An array of arrays corresponding to the header row\n structure to render",

48934

"type": "Array[]"

48935

},

48936

"access": "protected",

48937

"tagname": "",

48938

"since": "3.5.0",

48939

"class": "DataTable.HeaderView",

48940

"module": "datatable",

48941

"submodule": "datatable-head",

48942

"namespace": "DataTable"

48943

},

48944

{

48945

"file": "datatable/js/message.js",

48946

"line": 29,

48947

"description": "Enables the display of messages in the table. Setting this to false will\nprevent the message Node from being created and `showMessage` from doing\nanything.",

48948

"itemtype": "attribute",

48949

"name": "showMessages",

48950

"type": "{Boolean}",

48951

"default": "true",

48952

"since": "3.5.0",

48953

"class": "DataTable",

48954

"module": "datatable",

48955

"submodule": "datatable-message"

48956

},

48957

{

48958

"file": "datatable/js/message.js",

48959

"line": 46,

48960

"description": "Template used to generate the node that will be used to report messages.",

48961

"itemtype": "property",

48962

"name": "MESSAGE_TEMPLATE",

48963

"type": "{HTML}",

48964

"default": "<tbody class=\"{className}\"><td class=\"{contentClass}\" colspan=\"{colspan}\"></td></tbody>",

48965

"since": "3.5.0",

48966

"class": "DataTable",

48967

"module": "datatable",

48968

"submodule": "datatable-message"

48969

},

48970

{

48971

"file": "datatable/js/message.js",

48972

"line": 56,

48973

"description": "Hides the message node.",

48974

"itemtype": "method",

48975

"name": "hideMessage",

48976

"return": {

48977

"description": "",

48978

"type": "DataTable"

48979

},

48980

"chainable": 1,

48981

"since": "3.5.0",

48982

"class": "DataTable",

48983

"module": "datatable",

48984

"submodule": "datatable-message"

48985

},

48986

{

48987

"file": "datatable/js/message.js",

48988

"line": 71,

48989

"description": "Display the message node and set its content to `message`. If there is a\nlocalized `strings` entry for the value of `message`, that string will be\nused.",

48990

"itemtype": "method",

48991

"name": "showMessage",

48992

"params": [

48993

{

48994

"name": "message",

48995

"description": "The message name or message itself to display",

48996

"type": "String"

48997

}

48998

],

48999

"return": {

49000

"description": "",

49001

"type": "DataTable"

49002

},

49003

"chainable": 1,

49004

"since": "3.5.0",

49005

"class": "DataTable",

49006

"module": "datatable",

49007

"submodule": "datatable-message"

49008

},

49009

{

49010

"file": "datatable/js/message.js",

49011

"line": 110,

49012

"description": "Updates the colspan of the `<td>` used to display the messages.",

49013

"itemtype": "method",

49014

"name": "_afterMessageColumnsChange",

49015

"params": [

49016

{

49017

"name": "e",

49018

"description": "The columnsChange event",

49019

"type": "EventFacade"

49020

}

49021

],

49022

"access": "protected",

49023

"tagname": "",

49024

"since": "3.5.0",

49025

"class": "DataTable",

49026

"module": "datatable",

49027

"submodule": "datatable-message"

49028

},

49029

{

49030

"file": "datatable/js/message.js",

49031

"line": 131,

49032

"description": "Relays to `_uiSetMessage` to hide or show the message node.",

49033

"itemtype": "method",

49034

"name": "_afterMessageDataChange",

49035

"params": [

49036

{

49037

"name": "e",

49038

"description": "The dataChange event",

49039

"type": "EventFacade"

49040

}

49041

],

49042

"access": "protected",

49043

"tagname": "",

49044

"since": "3.5.0",

49045

"class": "DataTable",

49046

"module": "datatable",

49047

"submodule": "datatable-message"

49048

},

49049

{

49050

"file": "datatable/js/message.js",

49051

"line": 143,

49052

"description": "Removes the message node if `showMessages` is `false`, or relays to\n`_uiSetMessage` if `true`.",

49053

"itemtype": "method",

49054

"name": "_afterShowMessagesChange",

49055

"params": [

49056

{

49057

"name": "e",

49058

"description": "The showMessagesChange event",

49059

"type": "EventFacade"

49060

}

49061

],

49062

"access": "protected",

49063

"tagname": "",

49064

"since": "3.5.0",

49065

"class": "DataTable",

49066

"module": "datatable",

49067

"submodule": "datatable-message"

49068

},

49069

{

49070

"file": "datatable/js/message.js",

49071

"line": 164,

49072

"description": "Binds the events necessary to keep the message node in sync with the current\ntable and configuration state.",

49073

"itemtype": "method",

49074

"name": "_bindMessageUI",

49075

"access": "protected",

49076

"tagname": "",

49077

"since": "3.5.0",

49078

"class": "DataTable",

49079

"module": "datatable",

49080

"submodule": "datatable-message"

49081

},

49082

{

49083

"file": "datatable/js/message.js",

49084

"line": 182,

49085

"description": "Merges in the message related strings and hooks into the rendering cycle to\nalso render and bind the message node.",

49086

"itemtype": "method",

49087

"name": "initializer",

49088

"access": "protected",

49089

"tagname": "",

49090

"since": "3.5.0",

49091

"class": "DataTable",

49092

"module": "datatable",

49093

"submodule": "datatable-message"

49094

},

49095

{

49096

"file": "datatable/js/message.js",

49097

"line": 201,

49098

"description": "Creates the `_messageNode` property from the configured `MESSAGE_TEMPLATE`\nand inserts it before the `<table>`'s `<tbody>` node.",

49099

"itemtype": "method",

49100

"name": "_initMessageNode",

49101

"access": "protected",

49102

"tagname": "",

49103

"since": "3.5.0",

49104

"class": "DataTable",

49105

"module": "datatable",

49106

"submodule": "datatable-message"

49107

},

49108

{

49109

"file": "datatable/js/message.js",

49110

"line": 222,

49111

"description": "Add the messaging related strings to the `strings` map.",

49112

"itemtype": "method",

49113

"name": "_initMessageStrings",

49114

"access": "protected",

49115

"tagname": "",

49116

"since": "3.5.0",

49117

"class": "DataTable",

49118

"module": "datatable",

49119

"submodule": "datatable-message"

49120

},

49121

{

49122

"file": "datatable/js/message.js",

49123

"line": 235,

49124

"description": "Node used to display messages from `showMessage`.",

49125

"itemtype": "property",

49126

"name": "_messageNode",

49127

"type": "{Node}",

49128

"value": "`undefined` (not initially set)",

49129

"since": "3.5.0",

49130

"class": "DataTable",

49131

"module": "datatable",

49132

"submodule": "datatable-message"

49133

},

49134

{

49135

"file": "datatable/js/message.js",

49136

"line": 245,

49137

"description": "Synchronizes the message UI with the table state.",

49138

"itemtype": "method",

49139

"name": "_syncMessageUI",

49140

"access": "protected",

49141

"tagname": "",

49142

"since": "3.5.0",

49143

"class": "DataTable",

49144

"module": "datatable",

49145

"submodule": "datatable-message"

49146

},

49147

{

49148

"file": "datatable/js/message.js",

49149

"line": 256,

49150

"description": "Calls `hideMessage` or `showMessage` as appropriate based on the presence of\nrecords in the `data` ModelList.\n\nThis is called when `data` is reset or records are added or removed. Also,\nif the `showMessages` attribute is updated. In either case, if the\ntriggering event has a `message` property on the EventFacade, it will be\npassed to `showMessage` (if appropriate). If no such property is on the\nfacade, the `emptyMessage` will be used (see the strings).",

49151

"itemtype": "method",

49152

"name": "_uiSetMessage",

49153

"params": [

49154

{

49155

"name": "e",

49156

"description": "The columnsChange event",

49157

"type": "EventFacade"

49158

}

49159

],

49160

"access": "protected",

49161

"tagname": "",

49162

"since": "3.5.0",

49163

"class": "DataTable",

49164

"module": "datatable",

49165

"submodule": "datatable-message"

49166

},

49167

{

49168

"file": "datatable/js/mutable.js",

49169

"line": 40,

49170

"description": "Controls whether `addRow`, `removeRow`, and `modifyRow` should trigger the\nunderlying Model's sync layer by default.\n\nWhen `true`, it is unnecessary to pass the \"sync\" configuration property to\nthose methods to trigger per-operation sync.",

49171

"itemtype": "attribute",

49172

"name": "autoSync",

49173

"type": "{Boolean}",

49174

"default": "`false`",

49175

"since": "3.5.0",

49176

"class": "DataTable",

49177

"module": "datatable",

49178

"submodule": "datatable-mutable"

49179

},

49180

{

49181

"file": "datatable/js/mutable.js",

49182

"line": 60,

49183

"description": "Adds the column configuration to the DataTable's `columns` configuration.\nIf the `index` parameter is supplied, it is injected at that index. If the\ntable has nested headers, inject a subcolumn by passing an array of indexes\nto identify the new column's final location.\n\nThe `index` parameter is required if adding a nested column.\n\nThis method is a convienience method for fetching the DataTable's `columns`\nattribute, updating it, and calling \n`table.set('columns', _updatedColumnsDefs_)`\n\nFor example:\n\n<pre><code>// Becomes last column\ntable.addColumn('name');\n\n// Inserted after the current second column, moving the current third column\n// to index 4\ntable.addColumn({ key: 'price', formatter: currencyFormatter }, 2 );\n\n// Insert a new column in a set of headers three rows deep. The index array\n// translates to\n// [ 2, -- in the third column's children\n// 1, -- in the second child's children\n// 3 ] -- as the fourth child column\ntable.addColumn({ key: 'age', sortable: true }, [ 2, 1, 3 ]);\n</code></pre>",

49184

"itemtype": "method",

49185

"name": "addColumn",

49186

"params": [

49187

{

49188

"name": "config",

49189

"description": "The new column configuration object",

49190

"type": "Object|String"

49191

},

49192

{

49193

"name": "index",

49194

"description": "the insertion index",

49195

"type": "Number|Number[]",

49196

"optional": true

49197

}

49198

],

49199

"return": {

49200

"description": "",

49201

"type": "DataTable"

49202

},

49203

"chainable": 1,

49204

"since": "3.5.0",

49205

"class": "DataTable",

49206

"module": "datatable",

49207

"submodule": "datatable-mutable"

49208

},

49209

{

49210

"file": "datatable/js/mutable.js",

49211

"line": 114,

49212

"description": "Updates an existing column definition. Fires the `modifyColumn` event.\n\nFor example:\n\n<pre><code>// Add a formatter to the existing 'price' column definition\ntable.modifyColumn('price', { formatter: currencyFormatter });\n\n// Change the label on a header cell in a set of nested headers three rows\n// deep. The index array translates to\n// [ 2, -- in the third column's children\n// 1, -- the second child\n// 3 ] -- the fourth child column\ntable.modifyColumn([2, 1, 3], { label: 'Experience' });\n</code></pre>",

49213

"itemtype": "method",

49214

"name": "modifyColumn",

49215

"params": [

49216

{

49217

"name": "name",

49218

"description": "The column key, name, index, or\n current configuration object",

49219

"type": "String|Number|Number[]|Object"

49220

},

49221

{

49222

"name": "config",

49223

"description": "The new column configuration properties",

49224

"type": "Object"

49225

}

49226

],

49227

"return": {

49228

"description": "",

49229

"type": "DataTable"

49230

},

49231

"chainable": 1,

49232

"since": "3.5.0",

49233

"class": "DataTable",

49234

"module": "datatable",

49235

"submodule": "datatable-mutable"

49236

},

49237

{

49238

"file": "datatable/js/mutable.js",

49239

"line": 153,

49240

"description": "Moves an existing column to a new location. Fires the `moveColumn` event.\n\nThe destination index can be a number or array of numbers to place a column\nheader in a nested header row.",

49241

"itemtype": "method",

49242

"name": "moveColumn",

49243

"params": [

49244

{

49245

"name": "name",

49246

"description": "The column key, name, index, or\n current configuration object",

49247

"type": "String|Number|Number[]|Object"

49248

},

49249

{

49250

"name": "index",

49251

"description": "The destination index of the column",

49252

"type": "Number|Number[]"

49253

}

49254

],

49255

"return": {

49256

"description": "",

49257

"type": "DataTable"

49258

},

49259

"chainable": 1,

49260

"since": "3.5.0",

49261

"class": "DataTable",

49262

"module": "datatable",

49263

"submodule": "datatable-mutable"

49264

},

49265

{

49266

"file": "datatable/js/mutable.js",

49267

"line": 178,

49268

"description": "Removes an existing column. Fires the `removeColumn` event.",

49269

"itemtype": "method",

49270

"name": "removeColumn",

49271

"params": [

49272

{

49273

"name": "name",

49274

"description": "The column key, name, index, or\n current configuration object",

49275

"type": "String|Number|Number[]|Object"

49276

}

49277

],

49278

"return": {

49279

"description": "",

49280

"type": "DataTable"

49281

},

49282

"chainable": 1,

49283

"since": "3.5.0",

49284

"class": "DataTable",

49285

"module": "datatable",

49286

"submodule": "datatable-mutable"

49287

},

49288

{

49289

"file": "datatable/js/mutable.js",

49290

"line": 198,

49291

"description": "Adds a new record to the DataTable's `data` ModelList. Record data can be\nan object of field values or an instance of the DataTable's configured\n`recordType` class.\n\nThis relays all parameters to the `data` ModelList's `add` method.\n\nIf a configuration object is passed as a second argument, and that object\nhas `sync: true` set, the underlying Model will be `save()`d.\n\nIf the DataTable's `autoSync` attribute is set to `true`, the additional\nargument is not needed.\n\nIf syncing and the last argument is a function, that function will be used\nas a callback to the Model's `save()` method.",

49292

"itemtype": "method",

49293

"name": "addRow",

49294

"params": [

49295

{

49296

"name": "data",

49297

"description": "The data or Model instance for the new record",

49298

"type": "Object"

49299

},

49300

{

49301

"name": "config",

49302

"description": "Configuration to pass along",

49303

"type": "Object",

49304

"optional": true

49305

},

49306

{

49307

"name": "callback",

49308

"description": "Callback function for Model's `save()`",

49309

"type": "Function",

49310

"optional": true,

49311

"props": [

49312

{

49313

"name": "err",

49314

"description": "If an error occurred or validation\n failed, this parameter will contain the error. If the sync operation\n succeeded, _err_ will be `null`.",

49315

"type": "Error|null"

49316

},

49317

{

49318

"name": "response",

49319

"description": "The server's response. This value will\n be passed to the `parse()` method, which is expected to parse it and\n return an attribute hash.",

49320

"type": "Any"

49321

}

49322

]

49323

}

49324

],

49325

"return": {

49326

"description": "",

49327

"type": "DataTable"

49328

},

49329

"chainable": 1,

49330

"since": "3.5.0",

49331

"class": "DataTable",

49332

"module": "datatable",

49333

"submodule": "datatable-mutable"

49334

},

49335

{

49336

"file": "datatable/js/mutable.js",

49337

"line": 255,

49338

"description": "Removes a record from the DataTable's `data` ModelList. The record can be\nprovided explicitly or targeted by it's `id` (see ModelList's `getById`\nmethod), `clientId`, or index in the ModelList.\n\nAfter locating the target Model, this relays the Model and all other passed\narguments to the `data` ModelList's `remove` method.\n\nIf a configuration object is passed as a second argument, and that object\nhas `sync: true` set, the underlying Model will be destroyed, passing\n`{ delete: true }` to trigger calling the Model's sync layer.\n\nIf the DataTable's `autoSync` attribute is set to `true`, the additional\nargument is not needed.\n\nIf syncing and the last argument is a function, that function will be used\nas a callback to the Model's `destroy()` method.",

49339

"itemtype": "method",

49340

"name": "removeRow",

49341

"params": [

49342

{

49343

"name": "id",

49344

"description": "The Model instance or identifier",

49345

"type": "Object|String|Number"

49346

},

49347

{

49348

"name": "config",

49349

"description": "Configuration to pass along",

49350

"type": "Object",

49351

"optional": true

49352

},

49353

{

49354

"name": "callback",

49355

"description": "Callback function for Model's `save()`",

49356

"type": "Function",

49357

"optional": true,

49358

"props": [

49359

{

49360

"name": "err",

49361

"description": "If an error occurred or validation\n failed, this parameter will contain the error. If the sync operation\n succeeded, _err_ will be `null`.",

49362

"type": "Error|null"

49363

},

49364

{

49365

"name": "response",

49366

"description": "The server's response. This value will\n be passed to the `parse()` method, which is expected to parse it and\n return an attribute hash.",

49367

"type": "Any"

49368

}

49369

]

49370

}

49371

],

49372

"return": {

49373

"description": "",

49374

"type": "DataTable"

49375

},

49376

"chainable": 1,

49377

"since": "3.5.0",

49378

"class": "DataTable",

49379

"module": "datatable",

49380

"submodule": "datatable-mutable"

49381

},

49382

{

49383

"file": "datatable/js/mutable.js",

49384

"line": 329,

49385

"description": "Updates an existing record in the DataTable's `data` ModelList. The record\ncan be provided explicitly or targeted by it's `id` (see ModelList's\n`getById` method), `clientId`, or index in the ModelList.\n\nAfter locating the target Model, this relays the all other passed\narguments to the Model's `setAttrs` method.\n\nIf a configuration object is passed as a second argument, and that object\nhas `sync: true` set, the underlying Model will be `save()`d.\n\nIf the DataTable's `autoSync` attribute is set to `true`, the additional\nargument is not needed.\n\nIf syncing and the last argument is a function, that function will be used\nas a callback to the Model's `save()` method.",

49386

"itemtype": "method",

49387

"name": "modifyRow",

49388

"params": [

49389

{

49390

"name": "id",

49391

"description": "The Model instance or identifier",

49392

"type": "Object|String|Number"

49393

},

49394

{

49395

"name": "data",

49396

"description": "New data values for the Model",

49397

"type": "Object"

49398

},

49399

{

49400

"name": "config",

49401

"description": "Configuration to pass along to `setAttrs()`",

49402

"type": "Object",

49403

"optional": true

49404

},

49405

{

49406

"name": "callback",

49407

"description": "Callback function for Model's `save()`",

49408

"type": "Function",

49409

"optional": true,

49410

"props": [

49411

{

49412

"name": "err",

49413

"description": "If an error occurred or validation\n failed, this parameter will contain the error. If the sync operation\n succeeded, _err_ will be `null`.",

49414

"type": "Error|null"

49415

},

49416

{

49417

"name": "response",

49418

"description": "The server's response. This value will\n be passed to the `parse()` method, which is expected to parse it and\n return an attribute hash.",

49419

"type": "Any"

49420

}

49421

]

49422

}

49423

],

49424

"return": {

49425

"description": "",

49426

"type": "DataTable"

49427

},

49428

"chainable": 1,

49429

"since": "3.5.0",

49430

"class": "DataTable",

49431

"module": "datatable",

49432

"submodule": "datatable-mutable"

49433

},

49434

{

49435

"file": "datatable/js/mutable.js",

49436

"line": 394,

49437

"description": "Default function for the `addColumn` event.\n\nInserts the specified column at the provided index.",

49438

"itemtype": "method",

49439

"name": "_defAddColumnFn",

49440

"params": [

49441

{

49442

"name": "e",

49443

"description": "The `addColumn` event",

49444

"type": "EventFacade",

49445

"props": [

49446

{

49447

"name": "column",

49448

"description": "The new column definition object",

49449

"type": "Object"

49450

},

49451

{

49452

"name": "index",

49453

"description": "The array index to insert the new column",

49454

"type": "Number|Number[]"

49455

}

49456

]

49457

}

49458

],

49459

"access": "protected",

49460

"tagname": "",

49461

"since": "3.5.0",

49462

"class": "DataTable",

49463

"module": "datatable",

49464

"submodule": "datatable-mutable"

49465

},

49466

{

49467

"file": "datatable/js/mutable.js",

49468

"line": 424,

49469

"description": "Default function for the `modifyColumn` event.\n\nMixes the new column properties into the specified column definition.",

49470

"itemtype": "method",

49471

"name": "_defModifyColumnFn",

49472

"params": [

49473

{

49474

"name": "e",

49475

"description": "The `modifyColumn` event",

49476

"type": "EventFacade",

49477

"props": [

49478

{

49479

"name": "column",

49480

"description": "The column definition object or identifier",

49481

"type": "Object|String|Number|Number[]"

49482

},

49483

{

49484

"name": "newColumnDef",

49485

"description": "The properties to assign to the column",

49486

"type": "Object"

49487

}

49488

]

49489

}

49490

],

49491

"access": "protected",

49492

"tagname": "",

49493

"since": "3.5.0",

49494

"class": "DataTable",

49495

"module": "datatable",

49496

"submodule": "datatable-mutable"

49497

},

49498

{

49499

"file": "datatable/js/mutable.js",

49500

"line": 448,

49501

"description": "Default function for the `moveColumn` event.\n\nRemoves the specified column from its current location and inserts it at the\nspecified array index (may be an array of indexes for nested headers).",

49502

"itemtype": "method",

49503

"name": "_defMoveColumnFn",

49504

"params": [

49505

{

49506

"name": "e",

49507

"description": "The `moveColumn` event",

49508

"type": "EventFacade",

49509

"props": [

49510

{

49511

"name": "column",

49512

"description": "The column definition object or identifier",

49513

"type": "Object|String|Number|Number[]"

49514

},

49515

{

49516

"name": "index",

49517

"description": "The destination index to move to",

49518

"type": "Object"

49519

}

49520

]

49521

}

49522

],

49523

"access": "protected",

49524

"tagname": "",

49525

"since": "3.5.0",

49526

"class": "DataTable",

49527

"module": "datatable",

49528

"submodule": "datatable-mutable"

49529

},

49530

{

49531

"file": "datatable/js/mutable.js",

49532

"line": 501,

49533

"description": "Default function for the `removeColumn` event.\n\nSplices the specified column from its containing columns array.",

49534

"itemtype": "method",

49535

"name": "_defRemoveColumnFn",

49536

"params": [

49537

{

49538

"name": "e",

49539

"description": "The `removeColumn` event",

49540

"type": "EventFacade",

49541

"props": [

49542

{

49543

"name": "column",

49544

"description": "The column definition object or identifier",

49545

"type": "Object|String|Number|Number[]"

49546

}

49547

]

49548

}

49549

],

49550

"access": "protected",

49551

"tagname": "",

49552

"since": "3.5.0",

49553

"class": "DataTable",

49554

"module": "datatable",

49555

"submodule": "datatable-mutable"

49556

},

49557

{

49558

"file": "datatable/js/mutable.js",

49559

"line": 530,

49560

"description": "Publishes the events used by the mutation methods:\n\n * addColumn\n * removeColumn\n * modifyColumn\n * moveColumn",

49561

"itemtype": "method",

49562

"name": "initializer",

49563

"access": "protected",

49564

"tagname": "",

49565

"since": "3.5.0",

49566

"class": "DataTable",

49567

"module": "datatable",

49568

"submodule": "datatable-mutable"

49569

},

49570

{

49571

"file": "datatable/js/mutable.js",

49572

"line": 552,

49573

"description": "Adds an array of new records to the DataTable's `data` ModelList. Record data\ncan be an array of objects containing field values or an array of instance of\nthe DataTable's configured `recordType` class.\n\nThis relays all parameters to the `data` ModelList's `add` method.\n\nTechnically, this is an alias to `addRow`, but please use the appropriately\nnamed method for readability.\n\nIf a configuration object is passed as a second argument, and that object\nhas `sync: true` set, the underlying Models will be `save()`d.\n\nIf the DataTable's `autoSync` attribute is set to `true`, the additional\nargument is not needed.\n\nIf syncing and the last argument is a function, that function will be used\nas a callback to each Model's `save()` method.",

49574

"itemtype": "method",

49575

"name": "addRows",

49576

"params": [

49577

{

49578

"name": "data",

49579

"description": "The data or Model instances to add",

49580

"type": "Object[]"

49581

},

49582

{

49583

"name": "config",

49584

"description": "Configuration to pass along",

49585

"type": "Object",

49586

"optional": true

49587

},

49588

{

49589

"name": "callback",

49590

"description": "Callback function for each Model's `save()`",

49591

"type": "Function",

49592

"optional": true,

49593

"props": [

49594

{

49595

"name": "err",

49596

"description": "If an error occurred or validation\n failed, this parameter will contain the error. If the sync operation\n succeeded, _err_ will be `null`.",

49597

"type": "Error|null"

49598

},

49599

{

49600

"name": "response",

49601

"description": "The server's response. This value will\n be passed to the `parse()` method, which is expected to parse it and\n return an attribute hash.",

49602

"type": "Any"

49603

}

49604

]

49605

}

49606

],

49607

"return": {

49608

"description": "",

49609

"type": "DataTable"

49610

},

49611

"chainable": 1,

49612

"since": "3.5.0",

49613

"class": "DataTable",

49614

"module": "datatable",

49615

"submodule": "datatable-mutable"

49616

},

49617

{

49618

"file": "datatable/js/mutable.js",

49619

"line": 592,

49620

"description": "Fired by the `addColumn` method.",

49621

"itemtype": "event",

49622

"name": "addColumn",

49623

"preventable": "_defAddColumnFn",

49624

"params": [

49625

{

49626

"name": "column",

49627

"description": "The new column definition object",

49628

"type": "Object"

49629

},

49630

{

49631

"name": "index",

49632

"description": "The array index to insert the new column",

49633

"type": "Number|Number[]"

49634

}

49635

],

49636

"since": "3.5.0",

49637

"class": "DataTable",

49638

"module": "datatable",

49639

"submodule": "datatable-mutable"

49640

},

49641

{

49642

"file": "datatable/js/mutable.js",

49643

"line": 602,

49644

"description": "Fired by the `removeColumn` method.",

49645

"itemtype": "event",

49646

"name": "removeColumn",

49647

"preventable": "_defRemoveColumnFn",

49648

"params": [

49649

{

49650

"name": "column",

49651

"description": "The column definition object or identifier",

49652

"type": "Object|String|Number|Number[]"

49653

}

49654

],

49655

"since": "3.5.0",

49656

"class": "DataTable",

49657

"module": "datatable",

49658

"submodule": "datatable-mutable"

49659

},

49660

{

49661

"file": "datatable/js/mutable.js",

49662

"line": 611,

49663

"description": "Fired by the `modifyColumn` method.",

49664

"itemtype": "event",

49665

"name": "modifyColumn",

49666

"preventable": "_defModifyColumnFn",

49667

"params": [

49668

{

49669

"name": "column",

49670

"description": "The column definition object or identifier",

49671

"type": "Object|String|Number|Number[]"

49672

},

49673

{

49674

"name": "newColumnDef",

49675

"description": "The properties to assign to the column",

49676

"type": "Object"

49677

}

49678

],

49679

"since": "3.5.0",

49680

"class": "DataTable",

49681

"module": "datatable",

49682

"submodule": "datatable-mutable"

49683

},

49684

{

49685

"file": "datatable/js/mutable.js",

49686

"line": 621,

49687

"description": "Fired by the `moveColumn` method.",

49688

"itemtype": "event",

49689

"name": "moveColumn",

49690

"preventable": "_defMoveColumnFn",

49691

"params": [

49692

{

49693

"name": "column",

49694

"description": "The column definition object or identifier",

49695

"type": "Object|String|Number|Number[]"

49696

},

49697

{

49698

"name": "index",

49699

"description": "The destination index to move to",

49700

"type": "Object"

49701

}

49702

],

49703

"since": "3.5.0",

49704

"class": "DataTable",

49705

"module": "datatable",

49706

"submodule": "datatable-mutable"

49707

},

49708

{

49709

"file": "datatable/js/scroll.js",

49710

"line": 54,

49711

"description": "Activates or deactivates scrolling in the table. Acceptable values are:\n\n * `false` - (default) Scrolling is disabled.\n * `true` or 'xy' - If `height` is set, vertical scrolling will be\n activated, if `width` is set, horizontal scrolling will be activated.\n * 'x' - Activate horizontal scrolling only. Requires the `width` attribute\n is also set.\n * 'y' - Activate vertical scrolling only. Requires the `height` attribute\n is also set.",

49712

"itemtype": "attribute",

49713

"name": "scrollable",

49714

"type": "{String|Boolean}",

49715

"value": "false",

49716

"since": "3.5.0",

49717

"class": "DataTable",

49718

"module": "datatable-scroll"

49719

},

49720

{

49721

"file": "datatable/js/scroll.js",

49722

"line": 78,

49723

"description": "Scrolls a given row or cell into view if the table is scrolling. Pass the\n`clientId` of a Model from the DataTable's `data` ModelList or its row\nindex to scroll to a row or a [row index, column index] array to scroll to\na cell. Alternately, to scroll to any element contained within the table's\nscrolling areas, pass its ID, or the Node itself (though you could just as\nwell call `node.scrollIntoView()` yourself, but hey, whatever).",

49724

"itemtype": "method",

49725

"name": "scrollTo",

49726

"params": [

49727

{

49728

"name": "id",

49729

"description": "A row clientId, row index, cell\n coordinate array, id string, or Node",

49730

"type": "String|Number|Number[]|Node"

49731

}

49732

],

49733

"return": {

49734

"description": "",

49735

"type": "DataTable"

49736

},

49737

"chainable": 1,

49738

"since": "3.5.0",

49739

"class": "DataTable",

49740

"module": "datatable-scroll"

49741

},

49742

{

49743

"file": "datatable/js/scroll.js",

49744

"line": 119,

49745

"description": "Template for the `<table>` that is used to fix the caption in place when\nthe table is horizontally scrolling.",

49746

"itemtype": "property",

49747

"name": "_CAPTION_TABLE_TEMPLATE",

49748

"type": "{HTML}",

49749

"value": "'<table class=\"{className}\" role=\"presentation\"></table>'",

49750

"access": "protected",

49751

"tagname": "",

49752

"since": "3.5.0",

49753

"class": "DataTable",

49754

"module": "datatable-scroll"

49755

},

49756

{

49757

"file": "datatable/js/scroll.js",

49758

"line": 131,

49759

"description": "Template used to create sizable element liners around header content to\nsynchronize fixed header column widths.",

49760

"itemtype": "property",

49761

"name": "_SCROLL_LINER_TEMPLATE",

49762

"type": "{HTML}",

49763

"value": "'<div class=\"{className}\"></div>'",

49764

"access": "protected",

49765

"tagname": "",

49766

"since": "3.5.0",

49767

"class": "DataTable",

49768

"module": "datatable-scroll"

49769

},

49770

{

49771

"file": "datatable/js/scroll.js",

49772

"line": 143,

49773

"description": "Template for the virtual scrollbar needed in \"y\" and \"xy\" scrolling setups.",

49774

"itemtype": "property",

49775

"name": "_SCROLLBAR_TEMPLATE",

49776

"type": "{HTML}",

49777

"value": "'<div class=\"{className}\"><div></div></div>'",

49778

"access": "protected",

49779

"tagname": "",

49780

"since": "3.5.0",

49781

"class": "DataTable",

49782

"module": "datatable-scroll"

49783

},

49784

{

49785

"file": "datatable/js/scroll.js",

49786

"line": 154,

49787

"description": "Template for the `<div>` that is used to contain the table when the table is\nhorizontally scrolling.",

49788

"itemtype": "property",

49789

"name": "_X_SCROLLER_TEMPLATE",

49790

"type": "{HTML}",

49791

"value": "'<div class=\"{className}\"></div>'",

49792

"access": "protected",

49793

"tagname": "",

49794

"since": "3.5.0",

49795

"class": "DataTable",

49796

"module": "datatable-scroll"

49797

},

49798

{

49799

"file": "datatable/js/scroll.js",

49800

"line": 166,

49801

"description": "Template for the `<table>` used to contain the fixed column headers for\nvertically scrolling tables.",

49802

"itemtype": "property",

49803

"name": "_Y_SCROLL_HEADER_TEMPLATE",

49804

"type": "{HTML}",

49805

"value": "'<table cellspacing=\"0\" role=\"presentation\" aria-hidden=\"true\" class=\"{className}\"></table>'",

49806

"access": "protected",

49807

"tagname": "",

49808

"since": "3.5.0",

49809

"class": "DataTable",

49810

"module": "datatable-scroll"

49811

},

49812

{

49813

"file": "datatable/js/scroll.js",

49814

"line": 178,

49815

"description": "Template for the `<div>` that is used to contain the rows when the table is\nvertically scrolling.",

49816

"itemtype": "property",

49817

"name": "_Y_SCROLLER_TEMPLATE",

49818

"type": "{HTML}",

49819

"value": "'<div class=\"{className}\"><div class=\"{scrollerClassName}\"></div></div>'",

49820

"access": "protected",

49821

"tagname": "",

49822

"since": "3.5.0",

49823

"class": "DataTable",

49824

"module": "datatable-scroll"

49825

},

49826

{

49827

"file": "datatable/js/scroll.js",

49828

"line": 190,

49829

"description": "Adds padding to the last cells in the fixed header for vertically scrolling\ntables. This padding is equal in width to the scrollbar, so can't be\nrelegated to a stylesheet.",

49830

"itemtype": "method",

49831

"name": "_addScrollbarPadding",

49832

"access": "protected",

49833

"tagname": "",

49834

"since": "3.5.0",

49835

"class": "DataTable",

49836

"module": "datatable-scroll"

49837

},

49838

{

49839

"file": "datatable/js/scroll.js",

49840

"line": 215,

49841

"description": "Reacts to changes in the `scrollable` attribute by updating the `_xScroll`\nand `_yScroll` properties and syncing the scrolling structure accordingly.",

49842

"itemtype": "method",

49843

"name": "_afterScrollableChange",

49844

"params": [

49845

{

49846

"name": "e",

49847

"description": "The relevant change event (ignored)",

49848

"type": "EventFacade"

49849

}

49850

],

49851

"access": "protected",

49852

"tagname": "",

49853

"since": "3.5.0",

49854

"class": "DataTable",

49855

"module": "datatable-scroll"

49856

},

49857

{

49858

"file": "datatable/js/scroll.js",

49859

"line": 239,

49860

"description": "Reacts to changes in the `caption` attribute by adding, removing, or\nsyncing the caption table when the table is set to scroll.",

49861

"itemtype": "method",

49862

"name": "_afterScrollCaptionChange",

49863

"params": [

49864

{

49865

"name": "e",

49866

"description": "The relevant change event (ignored)",

49867

"type": "EventFacade"

49868

}

49869

],

49870

"access": "protected",

49871

"tagname": "",

49872

"since": "3.5.0",

49873

"class": "DataTable",

49874

"module": "datatable-scroll"

49875

},

49876

{

49877

"file": "datatable/js/scroll.js",

49878

"line": 254,

49879

"description": "Reacts to changes in the `columns` attribute of vertically scrolling tables\nby refreshing the fixed headers, scroll container, and virtual scrollbar\nposition.",

49880

"itemtype": "method",

49881

"name": "_afterScrollColumnsChange",

49882

"params": [

49883

{

49884

"name": "e",

49885

"description": "The relevant change event (ignored)",

49886

"type": "EventFacade"

49887

}

49888

],

49889

"access": "protected",

49890

"tagname": "",

49891

"since": "3.5.0",

49892

"class": "DataTable",

49893

"module": "datatable-scroll"

49894

},

49895

{

49896

"file": "datatable/js/scroll.js",

49897

"line": 274,

49898

"description": "Reacts to changes in vertically scrolling table's `data` ModelList by\nsynchronizing the fixed column header widths and virtual scrollbar height.",

49899

"itemtype": "method",

49900

"name": "_afterScrollDataChange",

49901

"params": [

49902

{

49903

"name": "e",

49904

"description": "The relevant change event (ignored)",

49905

"type": "EventFacade"

49906

}

49907

],

49908

"access": "protected",

49909

"tagname": "",

49910

"since": "3.5.0",

49911

"class": "DataTable",

49912

"module": "datatable-scroll"

49913

},

49914

{

49915

"file": "datatable/js/scroll.js",

49916

"line": 289,

49917

"description": "Reacts to changes in the `height` attribute of vertically scrolling tables\nby updating the height of the `<div>` wrapping the data table and the\nvirtual scrollbar. If `scrollable` was set to \"y\" or \"xy\" but lacking a\ndeclared `height` until the received change, `_syncScrollUI` is called to\ncreate the fixed headers etc.",

49918

"itemtype": "method",

49919

"name": "_afterScrollHeightChange",

49920

"params": [

49921

{

49922

"name": "e",

49923

"description": "The relevant change event (ignored)",

49924

"type": "EventFacade"

49925

}

49926

],

49927

"access": "protected",

49928

"tagname": "",

49929

"since": "3.5.0",

49930

"class": "DataTable",

49931

"module": "datatable-scroll"

49932

},

49933

{

49934

"file": "datatable/js/scroll.js",

49935

"line": 328,

49936

"description": "Reacts to changes in the width of scrolling tables by expanding the width of\nthe `<div>` wrapping the data table for horizontally scrolling tables or\nupding the position of the virtual scrollbar for vertically scrolling\ntables.",

49937

"itemtype": "method",

49938

"name": "_afterScrollWidthChange",

49939

"params": [

49940

{

49941

"name": "e",

49942

"description": "The relevant change event (ignored)",

49943

"type": "EventFacade"

49944

}

49945

],

49946

"access": "protected",

49947

"tagname": "",

49948

"since": "3.5.0",

49949

"class": "DataTable",

49950

"module": "datatable-scroll"

49951

},

49952

{

49953

"file": "datatable/js/scroll.js",

49954

"line": 345,

49955

"description": "Binds virtual scrollbar interaction to the `_yScrollNode`'s `scrollTop` and\nvice versa.",

49956

"itemtype": "method",

49957

"name": "_bindScrollbar",

49958

"access": "protected",

49959

"tagname": "",

49960

"since": "3.5.0",

49961

"class": "DataTable",

49962

"module": "datatable-scroll"

49963

},

49964

{

49965

"file": "datatable/js/scroll.js",

49966

"line": 365,

49967

"description": "Binds to the window resize event to update the vertical scrolling table\nheaders and wrapper `<div>` dimensions.",

49968

"itemtype": "method",

49969

"name": "_bindScrollResize",

49970

"access": "protected",

49971

"tagname": "",

49972

"since": "3.5.0",

49973

"class": "DataTable",

49974

"module": "datatable-scroll"

49975

},

49976

{

49977

"file": "datatable/js/scroll.js",

49978

"line": 382,

49979

"description": "Attaches internal subscriptions to keep the scrolling structure up to date\nwith changes in the table's `data`, `columns`, `caption`, or `height`. The\n`width` is taken care of already.\n\nThis executes after the table's native `bindUI` method.",

49980

"itemtype": "method",

49981

"name": "_bindScrollUI",

49982

"access": "protected",

49983

"tagname": "",

49984

"since": "3.5.0",

49985

"class": "DataTable",

49986

"module": "datatable-scroll"

49987

},

49988

{

49989

"file": "datatable/js/scroll.js",

49990

"line": 410,

49991

"description": "Clears the lock and timer used to manage synchronizing the scroll position\nbetween the vertical scroll container and the virtual scrollbar.",

49992

"itemtype": "method",

49993

"name": "_clearScrollLock",

49994

"access": "protected",

49995

"tagname": "",

49996

"since": "3.5.0",

49997

"class": "DataTable",

49998

"module": "datatable-scroll"

49999

},

50000

{

50001

"file": "datatable/js/scroll.js",

50002

"line": 425,

50003

"description": "Creates a virtual scrollbar from the `_SCROLLBAR_TEMPLATE`, assigning it to\nthe `_scrollbarNode` property.",

50004

"itemtype": "method",

50005

"name": "_createScrollbar",

50006

"return": {

50007

"description": "The created Node",

50008

"type": "Node"

50009

},

50010

"access": "protected",

50011

"tagname": "",

50012

"since": "3.5.0",

50013

"class": "DataTable",

50014

"module": "datatable-scroll"

50015

},

50016

{

50017

"file": "datatable/js/scroll.js",

50018

"line": 451,

50019

"description": "Creates a separate table to contain the caption when the table is\nconfigured to scroll vertically or horizontally.",

50020

"itemtype": "method",

50021

"name": "_createScrollCaptionTable",

50022

"return": {

50023

"description": "The created Node",

50024

"type": "Node"

50025

},

50026

"access": "protected",

50027

"tagname": "",

50028

"since": "3.5.0",

50029

"class": "DataTable",

50030

"module": "datatable-scroll"

50031

},

50032

{

50033

"file": "datatable/js/scroll.js",

50034

"line": 473,

50035

"description": "Populates the `_xScrollNode` property by creating the `<div>` Node described\nby the `_X_SCROLLER_TEMPLATE`.",

50036

"itemtype": "method",

50037

"name": "_createXScrollNode",

50038

"return": {

50039

"description": "The created Node",

50040

"type": "Node"

50041

},

50042

"access": "protected",

50043

"tagname": "",

50044

"since": "3.5.0",

50045

"class": "DataTable",

50046

"module": "datatable-scroll"

50047

},

50048

{

50049

"file": "datatable/js/scroll.js",

50050

"line": 493,

50051

"description": "Populates the `_yScrollHeader` property by creating the `<table>` Node\ndescribed by the `_Y_SCROLL_HEADER_TEMPLATE`.",

50052

"itemtype": "method",

50053

"name": "_createYScrollHeader",

50054

"return": {

50055

"description": "The created Node",

50056

"type": "Node"

50057

},

50058

"access": "protected",

50059

"tagname": "",

50060

"since": "3.5.0",

50061

"class": "DataTable",

50062

"module": "datatable-scroll"

50063

},

50064

{

50065

"file": "datatable/js/scroll.js",

50066

"line": 515,

50067

"description": "Populates the `_yScrollNode` property by creating the `<div>` Node described\nby the `_Y_SCROLLER_TEMPLATE`.",

50068

"itemtype": "method",

50069

"name": "_createYScrollNode",

50070

"return": {

50071

"description": "The created Node",

50072

"type": "Node"

50073

},

50074

"access": "protected",

50075

"tagname": "",

50076

"since": "3.5.0",

50077

"class": "DataTable",

50078

"module": "datatable-scroll"

50079

},

50080

{

50081

"file": "datatable/js/scroll.js",

50082

"line": 543,

50083

"description": "Removes the nodes used to create horizontal and vertical scrolling and\nrejoins the caption to the main table if needed.",

50084

"itemtype": "method",

50085

"name": "_disableScrolling",

50086

"access": "protected",

50087

"tagname": "",

50088

"since": "3.5.0",

50089

"class": "DataTable",

50090

"module": "datatable-scroll"

50091

},

50092

{

50093

"file": "datatable/js/scroll.js",

50094

"line": 560,

50095

"description": "Removes the nodes used to allow horizontal scrolling.",

50096

"itemtype": "method",

50097

"name": "_disableXScrolling",

50098

"access": "protected",

50099

"tagname": "",

50100

"since": "3.5.0",

50101

"class": "DataTable",

50102

"module": "datatable-scroll"

50103

},

50104

{

50105

"file": "datatable/js/scroll.js",

50106

"line": 571,

50107

"description": "Removes the nodes used to allow vertical scrolling.",

50108

"itemtype": "method",

50109

"name": "_disableYScrolling",

50110

"access": "protected",

50111

"tagname": "",

50112

"since": "3.5.0",

50113

"class": "DataTable",

50114

"module": "datatable-scroll"

50115

},

50116

{

50117

"file": "datatable/js/scroll.js",

50118

"line": 585,

50119

"description": "Cleans up external event subscriptions.",

50120

"itemtype": "method",

50121

"name": "destructor",

50122

"access": "protected",

50123

"tagname": "",

50124

"since": "3.5.0",

50125

"class": "DataTable",

50126

"module": "datatable-scroll"

50127

},

50128

{

50129

"file": "datatable/js/scroll.js",

50130

"line": 598,

50131

"description": "Sets up event handlers and AOP advice methods to bind the DataTable's natural\nbehaviors with the scrolling APIs and state.",

50132

"itemtype": "method",

50133

"name": "initializer",

50134

"params": [

50135

{

50136

"name": "config",

50137

"description": "The config object passed to the constructor (ignored)",

50138

"type": "Object"

50139

}

50140

],

50141

"access": "protected",

50142

"tagname": "",

50143

"since": "3.5.0",

50144

"class": "DataTable",

50145

"module": "datatable-scroll"

50146

},

50147

{

50148

"file": "datatable/js/scroll.js",

50149

"line": 617,

50150

"description": "Removes the table used to house the caption when the table is scrolling.",

50151

"itemtype": "method",

50152

"name": "_removeScrollCaptionTable",

50153

"access": "protected",

50154

"tagname": "",

50155

"since": "3.5.0",

50156

"class": "DataTable",

50157

"module": "datatable-scroll"

50158

},

50159

{

50160

"file": "datatable/js/scroll.js",

50161

"line": 636,

50162

"description": "Removes the `<div>` wrapper used to contain the data table when the table\nis horizontally scrolling.",

50163

"itemtype": "method",

50164

"name": "_removeXScrollNode",

50165

"access": "protected",

50166

"tagname": "",

50167

"since": "3.5.0",

50168

"class": "DataTable",

50169

"module": "datatable-scroll"

50170

},

50171

{

50172

"file": "datatable/js/scroll.js",

50173

"line": 655,

50174

"description": "Removes the `<div>` wrapper used to contain the data table and fixed header\nwhen the table is vertically scrolling.",

50175

"itemtype": "method",

50176

"name": "_removeYScrollContainer",

50177

"access": "protected",

50178

"tagname": "",

50179

"since": "3.5.0",

50180

"class": "DataTable",

50181

"module": "datatable-scroll"

50182

},

50183

{

50184

"file": "datatable/js/scroll.js",

50185

"line": 674,

50186

"description": "Removes the `<table>` used to contain the fixed column headers when the\ntable is vertically scrolling.",

50187

"itemtype": "method",

50188

"name": "_removeYScrollHeader",

50189

"access": "protected",

50190

"tagname": "",

50191

"since": "3.5.0",

50192

"class": "DataTable",

50193

"module": "datatable-scroll"

50194

},

50195

{

50196

"file": "datatable/js/scroll.js",

50197

"line": 690,

50198

"description": "Removes the `<div>` wrapper used to contain the data table when the table\nis vertically scrolling.",

50199

"itemtype": "method",

50200

"name": "_removeYScrollNode",

50201

"access": "protected",

50202

"tagname": "",

50203

"since": "3.5.0",

50204

"class": "DataTable",

50205

"module": "datatable-scroll"

50206

},

50207

{

50208

"file": "datatable/js/scroll.js",

50209

"line": 709,

50210

"description": "Removes the virtual scrollbar used by scrolling tables.",

50211

"itemtype": "method",

50212

"name": "_removeScrollbar",

50213

"access": "protected",

50214

"tagname": "",

50215

"since": "3.5.0",

50216

"class": "DataTable",

50217

"module": "datatable-scroll"

50218

},

50219

{

50220

"file": "datatable/js/scroll.js",

50221

"line": 729,

50222

"description": "Accepts (case insensitive) values \"x\", \"y\", \"xy\", `true`, and `false`.\n`true` is translated to \"xy\" and upper case values are converted to lower\ncase. All other values are invalid.",

50223

"itemtype": "method",

50224

"name": "_setScrollable",

50225

"params": [

50226

{

50227

"name": "val",

50228

"description": "Incoming value for the `scrollable` attribute",

50229

"type": "String|Boolea"

50230

}

50231

],

50232

"return": {

50233

"description": "",

50234

"type": "String"

50235

},

50236

"access": "protected",

50237

"tagname": "",

50238

"since": "3.5.0",

50239

"class": "DataTable",

50240

"module": "datatable-scroll"

50241

},

50242

{

50243

"file": "datatable/js/scroll.js",

50244

"line": 754,

50245

"description": "Assigns the `_xScroll` and `_yScroll` properties to true if an\nappropriate value is set in the `scrollable` attribute and the `height`\nand/or `width` is set.",

50246

"itemtype": "method",

50247

"name": "_setScrollProperties",

50248

"access": "protected",

50249

"tagname": "",

50250

"since": "3.5.0",

50251

"class": "DataTable",

50252

"module": "datatable-scroll"

50253

},

50254

{

50255

"file": "datatable/js/scroll.js",

50256

"line": 772,

50257

"description": "Keeps the virtual scrollbar and the scrolling `<div>` wrapper around the\ndata table in vertically scrolling tables in sync.",

50258

"itemtype": "method",

50259

"name": "_syncScrollPosition",

50260

"params": [

50261

{

50262

"name": "e",

50263

"description": "The scroll event",

50264

"type": "DOMEventFacade"

50265

},

50266

{

50267

"name": "source",

50268

"description": "The string \"virtual\" if the event originated from\n the virtual scrollbar",

50269

"type": "String",

50270

"optional": true

50271

}

50272

],

50273

"access": "protected",

50274

"tagname": "",

50275

"since": "3.5.0",

50276

"class": "DataTable",

50277

"module": "datatable-scroll"

50278

},

50279

{

50280

"file": "datatable/js/scroll.js",

50281

"line": 804,

50282

"description": "Splits the caption from the data `<table>` if the table is configured to\nscroll. If not, rejoins the caption to the data `<table>` if it needs to\nbe.",

50283

"itemtype": "method",

50284

"name": "_syncScrollCaptionUI",

50285

"access": "protected",

50286

"tagname": "",

50287

"since": "3.5.0",

50288

"class": "DataTable",

50289

"module": "datatable-scroll"

50290

},

50291

{

50292

"file": "datatable/js/scroll.js",

50293

"line": 843,

50294

"description": "Assigns widths to the fixed header columns to match the columns in the data\ntable.",

50295

"itemtype": "method",

50296

"name": "_syncScrollColumnWidths",

50297

"access": "protected",

50298

"tagname": "",

50299

"since": "3.5.0",

50300

"class": "DataTable",

50301

"module": "datatable-scroll"

50302

},

50303

{

50304

"file": "datatable/js/scroll.js",

50305

"line": 885,

50306

"description": "Creates matching headers in the fixed header table for vertically scrolling\ntables and synchronizes the column widths.",

50307

"itemtype": "method",

50308

"name": "_syncScrollHeaders",

50309

"access": "protected",

50310

"tagname": "",

50311

"since": "3.5.0",

50312

"class": "DataTable",

50313

"module": "datatable-scroll"

50314

},

50315

{

50316

"file": "datatable/js/scroll.js",

50317

"line": 933,

50318

"description": "Wraps the table for X and Y scrolling, if necessary, if the `scrollable`\nattribute is set. Synchronizes dimensions and DOM placement of all\nscrolling related nodes.",

50319

"itemtype": "method",

50320

"name": "_syncScrollUI",

50321

"access": "protected",

50322

"tagname": "",

50323

"since": "3.5.0",

50324

"class": "DataTable",

50325

"module": "datatable-scroll"

50326

},

50327

{

50328

"file": "datatable/js/scroll.js",

50329

"line": 994,

50330

"description": "Wraps the table in a scrolling `<div>` of the configured width for \"x\"\nscrolling.",

50331

"itemtype": "method",

50332

"name": "_syncXScrollUI",

50333

"params": [

50334

{

50335

"name": "xy",

50336

"description": "True if the table is configured with scrollable =\"xy\"",

50337

"type": "Boolean"

50338

}

50339

],

50340

"access": "protected",

50341

"tagname": "",

50342

"since": "3.5.0",

50343

"class": "DataTable",

50344

"module": "datatable-scroll"

50345

},

50346

{

50347

"file": "datatable/js/scroll.js",

50348

"line": 1063,

50349

"description": "Wraps the table in a scrolling `<div>` of the configured height (accounting\nfor the caption if there is one) if \"y\" scrolling is enabled. Otherwise,\nunwraps the table if necessary.",

50350

"itemtype": "method",

50351

"name": "_syncYScrollUI",

50352

"params": [

50353

{

50354

"name": "xy",

50355

"description": "True if the table is configured with scrollable = \"xy\"",

50356

"type": "Boolean"

50357

}

50358

],

50359

"access": "protected",

50360

"tagname": "",

50361

"since": "3.5.0",

50362

"class": "DataTable",

50363

"module": "datatable-scroll"

50364

},

50365

{

50366

"file": "datatable/js/scroll.js",

50367

"line": 1163,

50368

"description": "Assigns the appropriate class to the `boundingBox` to identify the DataTable\nas horizontally scrolling, vertically scrolling, or both (adds both classes).\n\nClasses added are \"yui3-datatable-scrollable-x\" or \"...-y\"",

50369

"itemtype": "method",

50370

"name": "_uiSetScrollable",

50371

"access": "protected",

50372

"tagname": "",

50373

"since": "3.5.0",

50374

"class": "DataTable",

50375

"module": "datatable-scroll"

50376

},

50377

{

50378

"file": "datatable/js/scroll.js",

50379

"line": 1179,

50380

"description": "Updates the virtual scrollbar's height to avoid overlapping with the fixed\nheaders.",

50381

"itemtype": "method",

50382

"name": "_uiSetScrollbarHeight",

50383

"access": "protected",

50384

"tagname": "",

50385

"since": "3.5.0",

50386

"class": "DataTable",

50387

"module": "datatable-scroll"

50388

},

50389

{

50390

"file": "datatable/js/scroll.js",

50391

"line": 1202,

50392

"description": "Updates the virtual scrollbar's placement to avoid overlapping the fixed\nheaders or the data table.",

50393

"itemtype": "method",

50394

"name": "_uiSetScrollbarPosition",

50395

"params": [

50396

{

50397

"name": "scroller",

50398

"description": "Reference node to position the scrollbar over",

50399

"type": "Node"

50400

}

50401

],

50402

"access": "protected",

50403

"tagname": "",

50404

"since": "3.5.0",

50405

"class": "DataTable",

50406

"module": "datatable-scroll"

50407

},

50408

{

50409

"file": "datatable/js/scroll.js",

50410

"line": 1237,

50411

"description": "Assigns the width of the `<div>` wrapping the data table in vertically\nscrolling tables.\n\nIf the table can't compress to the specified width, the container is\nexpanded accordingly.",

50412

"itemtype": "method",

50413

"name": "_uiSetYScrollWidth",

50414

"params": [

50415

{

50416

"name": "width",

50417

"description": "The CSS width to attempt to set",

50418

"type": "String"

50419

}

50420

],

50421

"access": "protected",

50422

"tagname": "",

50423

"since": "3.5.0",

50424

"class": "DataTable",

50425

"module": "datatable-scroll"

50426

},

50427

{

50428

"file": "datatable/js/scroll.js",

50429

"line": 1293,

50430

"description": "Detaches the scroll event subscriptions used to maintain scroll position\nparity between the scrollable `<div>` wrapper around the data table and the\nvirtual scrollbar for vertically scrolling tables.",

50431

"itemtype": "method",

50432

"name": "_unbindScrollbar",

50433

"access": "protected",

50434

"tagname": "",

50435

"since": "3.5.0",

50436

"class": "DataTable",

50437

"module": "datatable-scroll"

50438

},

50439

{

50440

"file": "datatable/js/scroll.js",

50441

"line": 1308,

50442

"description": "Detaches the resize event subscription used to maintain column parity for\nvertically scrolling tables with percentage widths.",

50443

"itemtype": "method",

50444

"name": "_unbindScrollResize",

50445

"access": "protected",

50446

"tagname": "",

50447

"since": "3.5.0",

50448

"class": "DataTable",

50449

"module": "datatable-scroll"

50450

},

50451

{

50452

"file": "datatable/js/scroll.js",

50453

"line": 1323,

50454

"description": "Indicates horizontal table scrolling is enabled.",

50455

"itemtype": "property",

50456

"name": "_xScroll",

50457

"type": "{Boolean}",

50458

"default": "undefined (not initially set)",

50459

"access": "private",

50460

"tagname": "",

50461

"since": "3.5.0",

50462

"class": "DataTable",

50463

"module": "datatable-scroll"

50464

},

50465

{

50466

"file": "datatable/js/scroll.js",

50467

"line": 1334,

50468

"description": "Indicates vertical table scrolling is enabled.",

50469

"itemtype": "property",

50470

"name": "_yScroll",

50471

"type": "{Boolean}",

50472

"default": "undefined (not initially set)",

50473

"access": "private",

50474

"tagname": "",

50475

"since": "3.5.0",

50476

"class": "DataTable",

50477

"module": "datatable-scroll"

50478

},

50479

{

50480

"file": "datatable/js/scroll.js",

50481

"line": 1345,

50482

"description": "Fixed column header `<table>` Node for vertical scrolling tables.",

50483

"itemtype": "property",

50484

"name": "_yScrollHeader",

50485

"type": "{Node}",

50486

"default": "undefined (not initially set)",

50487

"access": "protected",

50488

"tagname": "",

50489

"since": "3.5.0",

50490

"class": "DataTable",

50491

"module": "datatable-scroll"

50492

},

50493

{

50494

"file": "datatable/js/scroll.js",

50495

"line": 1356,

50496

"description": "Overflow Node used to contain the data rows in a vertically scrolling table.",

50497

"itemtype": "property",

50498

"name": "_yScrollNode",

50499

"type": "{Node}",

50500

"default": "undefined (not initially set)",

50501

"access": "protected",

50502

"tagname": "",

50503

"since": "3.5.0",

50504

"class": "DataTable",

50505

"module": "datatable-scroll"

50506

},

50507

{

50508

"file": "datatable/js/scroll.js",

50509

"line": 1367,

50510

"description": "Overflow Node used to contain the table headers and data in a horizontally\nscrolling table.",

50511

"itemtype": "property",

50512

"name": "_xScrollNode",

50513

"type": "{Node}",

50514

"default": "undefined (not initially set)",

50515

"access": "protected",

50516

"tagname": "",

50517

"since": "3.5.0",

50518

"class": "DataTable",

50519

"module": "datatable-scroll"

50520

},

50521

{

50522

"file": "datatable/js/sort.js",

50523

"line": 112,

50524

"description": "Controls which column headers can trigger sorting by user clicks.\n\nAcceptable values are:\n\n * \"auto\" - (default) looks for `sortable: true` in the column configurations\n * `true` - all columns are enabled\n * `false - no UI sortable is enabled\n * {String[]} - array of key names to give sortable headers",

50525

"itemtype": "attribute",

50526

"name": "sortable",

50527

"type": "{String|String[]|Boolean}",

50528

"default": "\"auto\"",

50529

"since": "3.5.0",

50530

"class": "DataTable",

50531

"module": "datatable",

50532

"submodule": "datatable-sort"

50533

},

50534

{

50535

"file": "datatable/js/sort.js",

50536

"line": 132,

50537

"description": "The current sort configuration to maintain in the data.\n\nAccepts column `key` strings or objects with a single property, the column\n`key`, with a value of 1, -1, \"asc\", or \"desc\". E.g. `{ username: 'asc'\n}`. String values are assumed to be ascending.\n\nExample values would be:\n\n * `\"username\"` - sort by the data's `username` field or the `key`\n associated to a column with that `name`.\n * `{ username: \"desc\" }` - sort by `username` in descending order.\n Alternately, use values \"asc\", 1 (same as \"asc\"), or -1 (same as \"desc\").\n * `[\"lastName\", \"firstName\"]` - ascending sort by `lastName`, but for\n records with the same `lastName`, ascending subsort by `firstName`.\n Array can have as many items as you want.\n * `[{ lastName: -1 }, \"firstName\"]` - descending sort by `lastName`,\n ascending subsort by `firstName`. Mixed types are ok.",

50538

"itemtype": "attribute",

50539

"name": "sortBy",

50540

"type": "{String|String[]|Object|Object[]}",

50541

"since": "3.5.0",

50542

"class": "DataTable",

50543

"module": "datatable",

50544

"submodule": "datatable-sort"

50545

},

50546

{

50547

"file": "datatable/js/sort.js",

50548

"line": 160,

50549

"description": "Strings containing language for sorting tooltips.",

50550

"itemtype": "attribute",

50551

"name": "strings",

50552

"type": "{Object}",

50553

"default": "(strings for current lang configured in the YUI instance config)",

50554

"since": "3.5.0",

50555

"class": "DataTable",

50556

"module": "datatable",

50557

"submodule": "datatable-sort"

50558

},

50559

{

50560

"file": "datatable/js/sort.js",

50561

"line": 173,

50562

"description": "Sort the data in the `data` ModelList and refresh the table with the new\norder.\n\nAcceptable values for `fields` are `key` strings or objects with a single\nproperty, the column `key`, with a value of 1, -1, \"asc\", or \"desc\". E.g.\n`{ username: 'asc' }`. String values are assumed to be ascending.\n\nExample values would be:\n\n * `\"username\"` - sort by the data's `username` field or the `key`\n associated to a column with that `name`.\n * `{ username: \"desc\" }` - sort by `username` in descending order.\n Alternately, use values \"asc\", 1 (same as \"asc\"), or -1 (same as \"desc\").\n * `[\"lastName\", \"firstName\"]` - ascending sort by `lastName`, but for\n records with the same `lastName`, ascending subsort by `firstName`.\n Array can have as many items as you want.\n * `[{ lastName: -1 }, \"firstName\"]` - descending sort by `lastName`,\n ascending subsort by `firstName`. Mixed types are ok.",

50563

"itemtype": "method",

50564

"name": "sort",

50565

"params": [

50566

{

50567

"name": "fields",

50568

"description": "The field(s) to sort by",

50569

"type": "String|String[]|Object|Object[]"

50570

},

50571

{

50572

"name": "payload",

50573

"description": "Extra `sort` event payload you want to send along",

50574

"type": "Object",

50575

"optional": true

50576

}

50577

],

50578

"return": {

50579

"description": "",

50580

"type": "DataTable"

50581

},

50582

"chainable": 1,

50583

"since": "3.5.0",

50584

"class": "DataTable",

50585

"module": "datatable",

50586

"submodule": "datatable-sort"

50587

},

50588

{

50589

"file": "datatable/js/sort.js",

50590

"line": 201,

50591

"description": "Notifies of an impending sort, either from clicking on a column\nheader, or from a call to the `sort` or `toggleSort` method.\n\nThe requested sort is available in the `sortBy` property of the event.\n\nThe default behavior of this event sets the table's `sortBy` attribute.",

50592

"itemtype": "event",

50593

"name": "sort",

50594

"params": [

50595

{

50596

"name": "sortBy",

50597

"description": "The requested sort",

50598

"type": "String|String[]|Object|Object[]"

50599

}

50600

],

50601

"preventable": "_defSortFn",

50602

"class": "DataTable",

50603

"module": "datatable",

50604

"submodule": "datatable-sort"

50605

},

50606

{

50607

"file": "datatable/js/sort.js",

50608

"line": 218,

50609

"description": "Template for the node that will wrap the header content for sortable\ncolumns.",

50610

"itemtype": "property",

50611

"name": "SORTABLE_HEADER_TEMPLATE",

50612

"type": "{HTML}",

50613

"value": "'<div class=\"{className}\" tabindex=\"0\"></div>'",

50614

"since": "3.5.0",

50615

"class": "DataTable",

50616

"module": "datatable",

50617

"submodule": "datatable-sort"

50618

},

50619

{

50620

"file": "datatable/js/sort.js",

50621

"line": 229,

50622

"description": "Reverse the current sort direction of one or more fields currently being\nsorted by.\n\nPass the `key` of the column or columns you want the sort order reversed\nfor.",

50623

"itemtype": "method",

50624

"name": "toggleSort",

50625

"params": [

50626

{

50627

"name": "fields",

50628

"description": "The field(s) to reverse sort order for",

50629

"type": "String|String[]"

50630

},

50631

{

50632

"name": "payload",

50633

"description": "Extra `sort` event payload you want to send along",

50634

"type": "Object",

50635

"optional": true

50636

}

50637

],

50638

"return": {

50639

"description": "",

50640

"type": "DataTable"

50641

},

50642

"chainable": 1,

50643

"since": "3.5.0",

50644

"class": "DataTable",

50645

"module": "datatable",

50646

"submodule": "datatable-sort"

50647

},

50648

{

50649

"file": "datatable/js/sort.js",

50650

"line": 288,

50651

"description": "Sorts the `data` ModelList based on the new `sortBy` configuration.",

50652

"itemtype": "method",

50653

"name": "_afterSortByChange",

50654

"params": [

50655

{

50656

"name": "e",

50657

"description": "The `sortByChange` event",

50658

"type": "EventFacade"

50659

}

50660

],

50661

"access": "protected",

50662

"tagname": "",

50663

"since": "3.5.0",

50664

"class": "DataTable",

50665

"module": "datatable",

50666

"submodule": "datatable-sort"

50667

},

50668

{

50669

"file": "datatable/js/sort.js",

50670

"line": 313,

50671

"description": "Applies the sorting logic to the new ModelList if the `newVal` is a new\nModelList.",

50672

"itemtype": "method",

50673

"name": "_afterSortDataChange",

50674

"params": [

50675

{

50676

"name": "e",

50677

"description": "the `dataChange` event",

50678

"type": "EventFacade"

50679

}

50680

],

50681

"access": "protected",

50682

"tagname": "",

50683

"since": "3.5.0",

50684

"class": "DataTable",

50685

"module": "datatable",

50686

"submodule": "datatable-sort"

50687

},

50688

{

50689

"file": "datatable/js/sort.js",

50690

"line": 332,

50691

"description": "Checks if any of the fields in the modified record are fields that are\ncurrently being sorted by, and if so, resorts the `data` ModelList.",

50692

"itemtype": "method",

50693

"name": "_afterSortRecordChange",

50694

"params": [

50695

{

50696

"name": "e",

50697

"description": "The Model's `change` event",

50698

"type": "EventFacade"

50699

}

50700

],

50701

"access": "protected",

50702

"tagname": "",

50703

"since": "3.5.0",

50704

"class": "DataTable",

50705

"module": "datatable",

50706

"submodule": "datatable-sort"

50707

},

50708

{

50709

"file": "datatable/js/sort.js",

50710

"line": 352,

50711

"description": "Subscribes to state changes that warrant updating the UI, and adds the\nclick handler for triggering the sort operation from the UI.",

50712

"itemtype": "method",

50713

"name": "_bindSortUI",

50714

"access": "protected",

50715

"tagname": "",

50716

"since": "3.5.0",

50717

"class": "DataTable",

50718

"module": "datatable",

50719

"submodule": "datatable-sort"

50720

},

50721

{

50722

"file": "datatable/js/sort.js",

50723

"line": 371,

50724

"description": "Sets the `sortBy` attribute from the `sort` event's `e.sortBy` value.",

50725

"itemtype": "method",

50726

"name": "_defSortFn",

50727

"params": [

50728

{

50729

"name": "e",

50730

"description": "The `sort` event",

50731

"type": "EventFacade"

50732

}

50733

],

50734

"access": "protected",

50735

"tagname": "",

50736

"since": "3.5.0",

50737

"class": "DataTable",

50738

"module": "datatable",

50739

"submodule": "datatable-sort"

50740

},

50741

{

50742

"file": "datatable/js/sort.js",

50743

"line": 383,

50744

"description": "Removes the click subscription from the header for sorting.",

50745

"itemtype": "method",

50746

"name": "destructor",

50747

"access": "protected",

50748

"tagname": "",

50749

"since": "3.5.0",

50750

"class": "DataTable",

50751

"module": "datatable",

50752

"submodule": "datatable-sort"

50753

},

50754

{

50755

"file": "datatable/js/sort.js",

50756

"line": 396,

50757

"description": "Getter for the `sortBy` attribute.\n\nSupports the special subattribute \"sortBy.state\" to get a normalized JSON\nversion of the current sort state. Otherwise, returns the last assigned\nvalue.\n\nFor example:\n\n<pre><code>var table = new Y.DataTable({\n columns: [ ... ],\n data: [ ... ],\n sortBy: 'username'\n});\n\ntable.get('sortBy'); // 'username'\ntable.get('sortBy.state'); // { key: 'username', dir: 1 }\n\ntable.sort(['lastName', { firstName: \"desc\" }]);\ntable.get('sortBy'); // ['lastName', { firstName: \"desc\" }]\ntable.get('sortBy.state'); // [{ key: \"lastName\", dir: 1 }, { key: \"firstName\", dir: -1 }]\n</code></pre>",

50758

"itemtype": "method",

50759

"name": "_getSortBy",

50760

"params": [

50761

{

50762

"name": "val",

50763

"description": "The current sortBy value",

50764

"type": "String|String[]|Object|Object[]"

50765

},

50766

{

50767

"name": "detail",

50768

"description": "String passed to `get(HERE)`. to parse subattributes",

50769

"type": "String"

50770

}

50771

],

50772

"access": "protected",

50773

"tagname": "",

50774

"since": "3.5.0",

50775

"class": "DataTable",

50776

"module": "datatable",

50777

"submodule": "datatable-sort"

50778

},

50779

{

50780

"file": "datatable/js/sort.js",

50781

"line": 450,

50782

"description": "Sets up the initial sort state and instance properties. Publishes events\nand subscribes to attribute change events to maintain internal state.",

50783

"itemtype": "method",

50784

"name": "initializer",

50785

"access": "protected",

50786

"tagname": "",

50787

"since": "3.5.0",

50788

"class": "DataTable",

50789

"module": "datatable",

50790

"submodule": "datatable-sort"

50791

},

50792

{

50793

"file": "datatable/js/sort.js",

50794

"line": 483,

50795

"description": "Creates a `_compare` function for the `data` ModelList to allow custom\nsorting by multiple fields.",

50796

"itemtype": "method",

50797

"name": "_initSortFn",

50798

"access": "protected",

50799

"tagname": "",

50800

"since": "3.5.0",

50801

"class": "DataTable",

50802

"module": "datatable",

50803

"submodule": "datatable-sort"

50804

},

50805

{

50806

"file": "datatable/js/sort.js",

50807

"line": 534,

50808

"description": "Add the sort related strings to the `strings` map.",

50809

"itemtype": "method",

50810

"name": "_initSortStrings",

50811

"access": "protected",

50812

"tagname": "",

50813

"since": "3.5.0",

50814

"class": "DataTable",

50815

"module": "datatable",

50816

"submodule": "datatable-sort"

50817

},

50818

{

50819

"file": "datatable/js/sort.js",

50820

"line": 547,

50821

"description": "Fires the `sort` event in response to user clicks on sortable column\nheaders.",

50822

"itemtype": "method",

50823

"name": "_onUITriggerSort",

50824

"params": [

50825

{

50826

"name": "e",

50827

"description": "The `click` event",

50828

"type": "DOMEventFacade"

50829

}

50830

],

50831

"access": "protected",

50832

"tagname": "",

50833

"since": "3.5.0",

50834

"class": "DataTable",

50835

"module": "datatable",

50836

"submodule": "datatable-sort"

50837

},

50838

{

50839

"file": "datatable/js/sort.js",

50840

"line": 597,

50841

"description": "Normalizes the possible input values for the `sortable` attribute, storing\nthe results in the `_sortable` property.",

50842

"itemtype": "method",

50843

"name": "_parseSortable",

50844

"access": "protected",

50845

"tagname": "",

50846

"since": "3.5.0",

50847

"class": "DataTable",

50848

"module": "datatable",

50849

"submodule": "datatable-sort"

50850

},

50851

{

50852

"file": "datatable/js/sort.js",

50853

"line": 639,

50854

"description": "Initial application of the sortable UI.",

50855

"itemtype": "method",

50856

"name": "_renderSortable",

50857

"access": "protected",

50858

"tagname": "",

50859

"since": "3.5.0",

50860

"class": "DataTable",

50861

"module": "datatable",

50862

"submodule": "datatable-sort"

50863

},

50864

{

50865

"file": "datatable/js/sort.js",

50866

"line": 652,

50867

"description": "Parses the current `sortBy` attribute into a normalized structure for the\n`data` ModelList's `_compare` method. Also updates the column\nconfigurations' `sortDir` properties.",

50868

"itemtype": "method",

50869

"name": "_setSortBy",

50870

"access": "protected",

50871

"tagname": "",

50872

"since": "3.5.0",

50873

"class": "DataTable",

50874

"module": "datatable",

50875

"submodule": "datatable-sort"

50876

},

50877

{

50878

"file": "datatable/js/sort.js",

50879

"line": 720,

50880

"description": "Array of column configuration objects of those columns that need UI setup\nfor user interaction.",

50881

"itemtype": "property",

50882

"name": "_sortable",

50883

"type": "{Object[]}",

50884

"access": "protected",

50885

"tagname": "",

50886

"since": "3.5.0",

50887

"class": "DataTable",

50888

"module": "datatable",

50889

"submodule": "datatable-sort"

50890

},

50891

{

50892

"file": "datatable/js/sort.js",

50893

"line": 731,

50894

"description": "Array of column configuration objects for those columns that are currently\nbeing used to sort the data. Fake column objects are used for fields that\nare not rendered as columns.",

50895

"itemtype": "property",

50896

"name": "_sortBy",

50897

"type": "{Object[]}",

50898

"access": "protected",

50899

"tagname": "",

50900

"since": "3.5.0",

50901

"class": "DataTable",

50902

"module": "datatable",

50903

"submodule": "datatable-sort"

50904

},

50905

{

50906

"file": "datatable/js/sort.js",

50907

"line": 743,

50908

"description": "Replacement `comparator` for the `data` ModelList that defers sorting logic\nto the `_compare` method. The deferral is accomplished by returning `this`.",

50909

"itemtype": "method",

50910

"name": "_sortComparator",

50911

"params": [

50912

{

50913

"name": "item",

50914

"description": "The record being evaluated for sort position",

50915

"type": "Model"

50916

}

50917

],

50918

"return": {

50919

"description": "The record",

50920

"type": "Model"

50921

},

50922

"access": "protected",

50923

"tagname": "",

50924

"since": "3.5.0",

50925

"class": "DataTable",

50926

"module": "datatable",

50927

"submodule": "datatable-sort"

50928

},

50929

{

50930

"file": "datatable/js/sort.js",

50931

"line": 758,

50932

"description": "Applies the appropriate classes to the `boundingBox` and column headers to\nindicate sort state and sortability.\n\nAlso currently wraps the header content of sortable columns in a `<div>`\nliner to give a CSS anchor for sort indicators.",

50933

"itemtype": "method",

50934

"name": "_uiSetSortable",

50935

"access": "protected",

50936

"tagname": "",

50937

"since": "3.5.0",

50938

"class": "DataTable",

50939

"module": "datatable",

50940

"submodule": "datatable-sort"

50941

},

50942

{

50943

"file": "datatable/js/sort.js",

50944

"line": 860,

50945

"description": "Allows values `true`, `false`, \"auto\", or arrays of column names through.",

50946

"itemtype": "method",

50947

"name": "_validateSortable",

50948

"params": [

50949

{

50950

"name": "val",

50951

"description": "The input value to `set(\"sortable\", VAL)`",

50952

"type": "Any"

50953

}

50954

],

50955

"return": {

50956

"description": "",

50957

"type": "Boolean"

50958

},

50959

"access": "protected",

50960

"tagname": "",

50961

"since": "3.5.0",

50962

"class": "DataTable",

50963

"module": "datatable",

50964

"submodule": "datatable-sort"

50965

},

50966

{

50967

"file": "datatable/js/sort.js",

50968

"line": 873,

50969

"description": "Allows strings, arrays of strings, objects, or arrays of objects.",

50970

"itemtype": "method",

50971

"name": "_validateSortBy",

50972

"params": [

50973

{

50974

"name": "val",

50975

"description": "The new `sortBy` value",

50976

"type": "String|String[]|Object|Object[]"

50977

}

50978

],

50979

"return": {

50980

"description": "",

50981

"type": "Boolean"

50982

},

50983

"access": "protected",

50984

"tagname": "",

50985

"since": "3.5.0",

50986

"class": "DataTable",

50987

"module": "datatable",

50988

"submodule": "datatable-sort"

50989

},

50990

{

50991

"file": "datatype/js/datatype-date-format.js",

50992

"line": 33,

50993

"description": "Pad a number with leading spaces, zeroes or something else",

50994

"itemtype": "method",

50995

"name": "xPad",

50996

"params": [

50997

{

50998

"name": "x",

50999

"description": "The number to be padded",

51000

"type": "Number"

51001

},

51002

{

51003

"name": "pad",

51004

"description": "The character to pad the number with",

51005

"type": "String"

51006

},

51007

{

51008

"name": "r",

51009

"description": "(optional) The base of the pad, eg, 10 implies to two digits, 100 implies to 3 digits.",

51010

"type": "Number"

51011

}

51012

],

51013

"access": "private",

51014

"tagname": "",

51015

"class": "DataType.Date",

51016

"module": "datatype",

51017

"submodule": "datatype-date-format"

51018

},

51019

{

51020

"file": "datatype/js/datatype-date-format.js",

51021

"line": 161,

51022

"description": "Takes a native JavaScript Date and formats it as a string for display to user.",

51023

"itemtype": "method",

51024

"name": "format",

51025

"params": [

51026

{

51027

"name": "oDate",

51028

"description": "Date.",

51029

"type": "Date"

51030

},

51031

{

51032

"name": "oConfig",

51033

"description": "(Optional) Object literal of configuration values:\n <dl>\n <dt>format {HTML} (Optional)</dt>\n <dd>\n \n Any strftime string is supported, such as \"%I:%M:%S %p\". strftime has several format specifiers defined by the Open group at \n <a href=\"http://www.opengroup.org/onlinepubs/007908799/xsh/strftime.html\">http://www.opengroup.org/onlinepubs/007908799/xsh/strftime.html</a>\n PHP added a few of its own, defined at <a href=\"http://www.php.net/strftime\">http://www.php.net/strftime</a>\n \n \n This javascript implementation supports all the PHP specifiers and a few more. The full list is below.\n \n \n If not specified, it defaults to the ISO 8601 standard date format: %Y-%m-%d.\n This may be overridden by the deprecated Y.config.dateFormat property.\n \n <dl>\n\t<dt>%a</dt> <dd>abbreviated weekday name according to the current locale</dd>\n\t<dt>%A</dt> <dd>full weekday name according to the current locale</dd>\n\t<dt>%b</dt> <dd>abbreviated month name according to the current locale</dd>\n\t<dt>%B</dt> <dd>full month name according to the current locale</dd>\n\t<dt>%c</dt> <dd>preferred date and time representation for the current locale</dd>\n\t<dt>%C</dt> <dd>century number (the year divided by 100 and truncated to an integer, range 00 to 99)</dd>\n\t<dt>%d</dt> <dd>day of the month as a decimal number (range 01 to 31)</dd>\n\t<dt>%D</dt> <dd>same as %m/%d/%y</dd>\n\t<dt>%e</dt> <dd>day of the month as a decimal number, a single digit is preceded by a space (range \" 1\" to \"31\")</dd>\n\t<dt>%F</dt> <dd>same as %Y-%m-%d (ISO 8601 date format)</dd>\n\t<dt>%g</dt> <dd>like %G, but without the century</dd>\n\t<dt>%G</dt> <dd>The 4-digit year corresponding to the ISO week number</dd>\n\t<dt>%h</dt> <dd>same as %b</dd>\n\t<dt>%H</dt> <dd>hour as a decimal number using a 24-hour clock (range 00 to 23)</dd>\n\t<dt>%I</dt> <dd>hour as a decimal number using a 12-hour clock (range 01 to 12)</dd>\n\t<dt>%j</dt> <dd>day of the year as a decimal number (range 001 to 366)</dd>\n\t<dt>%k</dt> <dd>hour as a decimal number using a 24-hour clock (range 0 to 23); single digits are preceded by a blank. (See also %H.)</dd>\n\t<dt>%l</dt> <dd>hour as a decimal number using a 12-hour clock (range 1 to 12); single digits are preceded by a blank. (See also %I.) </dd>\n\t<dt>%m</dt> <dd>month as a decimal number (range 01 to 12)</dd>\n\t<dt>%M</dt> <dd>minute as a decimal number</dd>\n\t<dt>%n</dt> <dd>newline character</dd>\n\t<dt>%p</dt> <dd>either \"AM\" or \"PM\" according to the given time value, or the corresponding strings for the current locale</dd>\n\t<dt>%P</dt> <dd>like %p, but lower case</dd>\n\t<dt>%r</dt> <dd>time in a.m. and p.m. notation equal to %I:%M:%S %p</dd>\n\t<dt>%R</dt> <dd>time in 24 hour notation equal to %H:%M</dd>\n\t<dt>%s</dt> <dd>number of seconds since the Epoch, ie, since 1970-01-01 00:00:00 UTC</dd>\n\t<dt>%S</dt> <dd>second as a decimal number</dd>\n\t<dt>%t</dt> <dd>tab character</dd>\n\t<dt>%T</dt> <dd>current time, equal to %H:%M:%S</dd>\n\t<dt>%u</dt> <dd>weekday as a decimal number [1,7], with 1 representing Monday</dd>\n\t<dt>%U</dt> <dd>week number of the current year as a decimal number, starting with the\n\t\t\tfirst Sunday as the first day of the first week</dd>\n\t<dt>%V</dt> <dd>The ISO 8601:1988 week number of the current year as a decimal number,\n\t\t\trange 01 to 53, where week 1 is the first week that has at least 4 days\n\t\t\tin the current year, and with Monday as the first day of the week.</dd>\n\t<dt>%w</dt> <dd>day of the week as a decimal, Sunday being 0</dd>\n\t<dt>%W</dt> <dd>week number of the current year as a decimal number, starting with the\n\t\t\tfirst Monday as the first day of the first week</dd>\n\t<dt>%x</dt> <dd>preferred date representation for the current locale without the time</dd>\n\t<dt>%X</dt> <dd>preferred time representation for the current locale without the date</dd>\n\t<dt>%y</dt> <dd>year as a decimal number without a century (range 00 to 99)</dd>\n\t<dt>%Y</dt> <dd>year as a decimal number including the century</dd>\n\t<dt>%z</dt> <dd>numerical time zone representation</dd>\n\t<dt>%Z</dt> <dd>time zone name or abbreviation</dd>\n\t<dt>%%</dt> <dd>a literal \"%\" character</dd>\n </dl>\n </dd>\n <dt>locale {String} (Deprecated, optional)</dt>\n <dd>\n Deprecated - use Y.config.lang instead, which provides access to a much larger set of built-in languages.\n The locale to use when displaying days of week, months of the year, and other locale specific\n strings. If not specified, this defaults to \"en\" (though this may be overridden by the deprecated Y.config.locale).\n The following locales are built in:\n <dl>\n <dt>en</dt>\n <dd>English</dd>\n <dt>en-US</dt>\n <dd>US English</dd>\n <dt>en-GB</dt>\n <dd>British English</dd>\n <dt>en-AU</dt>\n <dd>Australian English (identical to British English)</dd>\n </dl>\n More locales may be added by subclassing of the deprecated Y.DataType.Date.Locale[\"en\"].\n See Y.DataType.Date.Locale for more information.\n </dd>\n</dl>",

51034

"type": "Object"

51035

}

51036

],

51037

"return": {

51038

"description": "Formatted date for display.",

51039

"type": "HTML"

51040

},

51041

"class": "DataType.Date",

51042

"module": "datatype",

51043

"submodule": "datatype-date-format"

51044

},

51045

{

51046

"file": "datatype/js/datatype-date-math.js",

51047

"line": 12,

51048

"description": "Checks whether a native JavaScript Date contains a valid value.",

51049

"itemtype": "method",

51050

"name": "isValidDate",

51051

"params": [

51052

{

51053

"name": "oDate",

51054

"description": "Date in the month for which the number of days is desired.",

51055

"type": "Date"

51056

}

51057

],

51058

"return": {

51059

"description": "True if the date argument contains a valid value.",

51060

"type": "Boolean"

51061

},

51062

"class": "DataType.Date",

51063

"module": "datatype",

51064

"submodule": "datatype-date-math"

51065

},

51066

{

51067

"file": "datatype/js/datatype-date-math.js",

51068

"line": 29,

51069

"description": "Checks whether two dates correspond to the same date and time.",

51070

"itemtype": "method",

51071

"name": "areEqual",

51072

"params": [

51073

{

51074

"name": "aDate",

51075

"description": "The first date to compare.",

51076

"type": "Date"

51077

},

51078

{

51079

"name": "bDate",

51080

"description": "The second date to compare.",

51081

"type": "Date"

51082

}

51083

],

51084

"return": {

51085

"description": "True if the two dates correspond to the same\ndate and time.",

51086

"type": "Boolean"

51087

},

51088

"class": "DataType.Date",

51089

"module": "datatype",

51090

"submodule": "datatype-date-math"

51091

},

51092

{

51093

"file": "datatype/js/datatype-date-math.js",

51094

"line": 42,

51095

"description": "Checks whether the first date comes later than the second.",

51096

"itemtype": "method",

51097

"name": "isGreater",

51098

"params": [

51099

{

51100

"name": "aDate",

51101

"description": "The first date to compare.",

51102

"type": "Date"

51103

},

51104

{

51105

"name": "bDate",

51106

"description": "The second date to compare.",

51107

"type": "Date"

51108

}

51109

],

51110

"return": {

51111

"description": "True if the first date is later than the second.",

51112

"type": "Boolean"

51113

},

51114

"class": "DataType.Date",

51115

"module": "datatype",

51116

"submodule": "datatype-date-math"

51117

},

51118

{

51119

"file": "datatype/js/datatype-date-math.js",

51120

"line": 54,

51121

"description": "Checks whether the first date comes later than or is the same as\nthe second.",

51122

"itemtype": "method",

51123

"name": "isGreaterOrEqual",

51124

"params": [

51125

{

51126

"name": "aDate",

51127

"description": "The first date to compare.",

51128

"type": "Date"

51129

},

51130

{

51131

"name": "bDate",

51132

"description": "The second date to compare.",

51133

"type": "Date"

51134

}

51135

],

51136

"return": {

51137

"description": "True if the first date is later than or \nthe same as the second.",

51138

"type": "Boolean"

51139

},

51140

"class": "DataType.Date",

51141

"module": "datatype",

51142

"submodule": "datatype-date-math"

51143

},

51144

{

51145

"file": "datatype/js/datatype-date-math.js",

51146

"line": 69,

51147

"description": "Checks whether the date is between two other given dates.",

51148

"itemtype": "method",

51149

"name": "isInRange",

51150

"params": [

51151

{

51152

"name": "aDate",

51153

"description": "The date to check",

51154

"type": "Date"

51155

},

51156

{

51157

"name": "bDate",

51158

"description": "Lower bound of the range.",

51159

"type": "Date"

51160

},

51161

{

51162

"name": "cDate",

51163

"description": "Higher bound of the range.",

51164

"type": "Date"

51165

}

51166

],

51167

"return": {

51168

"description": "True if the date is between the two other given dates.",

51169

"type": "Boolean"

51170

},

51171

"class": "DataType.Date",

51172

"module": "datatype",

51173

"submodule": "datatype-date-math"

51174

},

51175

{

51176

"file": "datatype/js/datatype-date-math.js",

51177

"line": 82,

51178

"description": "Adds a specified number of days to the given date.",

51179

"itemtype": "method",

51180

"name": "addDays",

51181

"params": [

51182

{

51183

"name": "oDate",

51184

"description": "The date to add days to.",

51185

"type": "Date"

51186

},

51187

{

51188

"name": "numMonths",

51189

"description": "The number of days to add (can be negative)",

51190

"type": "Number"

51191

}

51192

],

51193

"return": {

51194

"description": "A new Date with the specified number of days\nadded to the original date.",

51195

"type": "Date"

51196

},

51197

"class": "DataType.Date",

51198

"module": "datatype",

51199

"submodule": "datatype-date-math"

51200

},

51201

{

51202

"file": "datatype/js/datatype-date-math.js",

51203

"line": 96,

51204

"description": "Adds a specified number of months to the given date.",

51205

"itemtype": "method",

51206

"name": "addMonths",

51207

"params": [

51208

{

51209

"name": "oDate",

51210

"description": "The date to add months to.",

51211

"type": "Date"

51212

},

51213

{

51214

"name": "numMonths",

51215

"description": "The number of months to add (can be negative)",

51216

"type": "Number"

51217

}

51218

],

51219

"return": {

51220

"description": "A new Date with the specified number of months\nadded to the original date.",

51221

"type": "Date"

51222

},

51223

"class": "DataType.Date",

51224

"module": "datatype",

51225

"submodule": "datatype-date-math"

51226

},

51227

{

51228

"file": "datatype/js/datatype-date-math.js",

51229

"line": 119,

51230

"description": "Adds a specified number of years to the given date.",

51231

"itemtype": "method",

51232

"name": "addYears",

51233

"params": [

51234

{

51235

"name": "oDate",

51236

"description": "The date to add years to.",

51237

"type": "Date"

51238

},

51239

{

51240

"name": "numYears",

51241

"description": "The number of years to add (can be negative)",

51242

"type": "Number"

51243

}

51244

],

51245

"return": {

51246

"description": "A new Date with the specified number of years\nadded to the original date.",

51247

"type": "Date"

51248

},

51249

"class": "DataType.Date",

51250

"module": "datatype",

51251

"submodule": "datatype-date-math"

51252

},

51253

{

51254

"file": "datatype/js/datatype-date-math.js",

51255

"line": 136,

51256

"description": "Lists all dates in a given month.",

51257

"itemtype": "method",

51258

"name": "listOfDatesInMonth",

51259

"params": [

51260

{

51261

"name": "oDate",

51262

"description": "The date corresponding to the month for\nwhich a list of dates is required.",

51263

"type": "Date"

51264

}

51265

],

51266

"return": {

51267

"description": "An `Array` of `Date`s from a given month.",

51268

"type": "Array"

51269

},

51270

"class": "DataType.Date",

51271

"module": "datatype",

51272

"submodule": "datatype-date-math"

51273

},

51274

{

51275

"file": "datatype/js/datatype-date-math.js",

51276

"line": 161,

51277

"description": "Takes a native JavaScript Date and returns the number of days\nin the month that the given date belongs to.",

51278

"itemtype": "method",

51279

"name": "daysInMonth",

51280

"params": [

51281

{

51282

"name": "oDate",

51283

"description": "Date in the month for which the number \nof days is desired.",

51284

"type": "Date"

51285

}

51286

],

51287

"return": {

51288

"description": "A number (either 28, 29, 30 or 31) of days \nin the given month.",

51289

"type": "Number"

51290

},

51291

"class": "DataType.Date",

51292

"module": "datatype",

51293

"submodule": "datatype-date-math"

51294

},

51295

{

51296

"file": "datatype/js/datatype-date-parse.js",

51297

"line": 11,

51298

"description": "Converts data to type Date.",

51299

"itemtype": "method",

51300

"name": "parse",

51301

"params": [

51302

{

51303

"name": "data",

51304

"description": "Data to convert. Values supported by the Date constructor are supported.",

51305

"type": "String | Number"

51306

}

51307

],

51308

"return": {

51309

"description": "A Date, or null.",

51310

"type": "Date"

51311

},

51312

"class": "DataType.Date",

51313

"module": "datatype",

51314

"submodule": "datatype-date-parse"

51315

},

51316

{

51317

"file": "datatype/js/datatype-number-format.js",

51318

"line": 24,

51319

"description": "Takes a Number and formats to string for display to user.",

51320

"itemtype": "method",

51321

"name": "format",

51322

"params": [

51323

{

51324

"name": "data",

51325

"description": "Number.",

51326

"type": "Number"

51327

},

51328

{

51329

"name": "config",

51330

"description": "(Optional) Optional configuration values:\n <dl>\n <dt>prefix {HTML}</dd>\n <dd>String prepended before each number, like a currency designator \"$\"</dd>\n <dt>decimalPlaces {Number}</dd>\n <dd>Number of decimal places to round. Must be a number 0 to 20.</dd>\n <dt>decimalSeparator {HTML}</dd>\n <dd>Decimal separator</dd>\n <dt>thousandsSeparator {HTML}</dd>\n <dd>Thousands separator</dd>\n <dt>suffix {HTML}</dd>\n <dd>String appended after each number, like \" items\" (note the space)</dd>\n </dl>",

51331

"type": "Object"

51332

}

51333

],

51334

"return": {

51335

"description": "Formatted number for display. Note, the following values\nreturn as \"\": null, undefined, NaN, \"\".",

51336

"type": "HTML"

51337

},

51338

"class": "DataType.Number",

51339

"module": "datatype",

51340

"submodule": "datatype-number-format"

51341

},

51342

{

51343

"file": "datatype/js/datatype-number-parse.js",

51344

"line": 12,

51345

"description": "Converts data to type Number.",

51346

"itemtype": "method",

51347

"name": "parse",

51348

"params": [

51349

{

51350

"name": "data",

51351

"description": "Data to convert. The following\nvalues return as null: null, undefined, NaN, \"\".",

51352

"type": "String | Number | Boolean"

51353

}

51354

],

51355

"return": {

51356

"description": "A number, or null.",

51357

"type": "Number"

51358

},

51359

"class": "DataType.Number",

51360

"module": "datatype",

51361

"submodule": "datatype-number-parse"

51362

},

51363

{

51364

"file": "datatype/js/datatype-xml-format.js",

51365

"line": 24,

51366

"description": "Converts data to type XMLDocument.",

51367

"itemtype": "method",

51368

"name": "format",

51369

"params": [

51370

{

51371

"name": "data",

51372

"description": "Data to convert.",

51373

"type": "XMLDoc"

51374

}

51375

],

51376

"return": {

51377

"description": "String.",

51378

"type": "String"

51379

},

51380

"class": "DataType.XML",

51381

"module": "datatype",

51382

"submodule": "datatype-xml"

51383

},

51384

{

51385

"file": "datatype/js/datatype-xml-parse.js",

51386

"line": 12,

51387

"description": "Converts data to type XMLDocument.",

51388

"itemtype": "method",

51389

"name": "parse",

51390

"params": [

51391

{

51392

"name": "data",

51393

"description": "Data to convert.",

51394

"type": "String"

51395

}

51396

],

51397

"return": {

51398

"description": "XML Document.",

51399

"type": "XMLDoc"

51400

},

51401

"class": "DataType.XML",

51402

"module": "datatype",

51403

"submodule": "datatype-xml-parse"

51404

},

51405

{

51406

"file": "dd/js/constrain.js",

51407

"line": 30,

51408

"itemtype": "event",

51409

"name": "drag:tickAlignX",

51410

"description": "Fires when this node is aligned with the tickX value.",

51411

"params": [

51412

{

51413

"name": "event",

51414

"description": "An Event Facade object",

51415

"type": "EventFacade"

51416

}

51417

],

51418

"type": "{CustomEvent}",

51419

"class": "Plugin.DDConstrained",

51420

"module": "dd",

51421

"submodule": "dd-constrain",

51422

"namespace": "Plugin"

51423

},

51424

{

51425

"file": "dd/js/constrain.js",

51426

"line": 38,

51427

"itemtype": "event",

51428

"name": "drag:tickAlignY",

51429

"description": "Fires when this node is aligned with the tickY value.",

51430

"params": [

51431

{

51432

"name": "event",

51433

"description": "An Event Facade object",

51434

"type": "EventFacade"

51435

}

51436

],

51437

"type": "{CustomEvent}",

51438

"class": "Plugin.DDConstrained",

51439

"module": "dd",

51440

"submodule": "dd-constrain",

51441

"namespace": "Plugin"

51442

},

51443

{

51444

"file": "dd/js/constrain.js",

51445

"line": 52,

51446

"itemtype": "property",

51447

"name": "NS",

51448

"default": "con",

51449

"readonly": "",

51450

"access": "protected",

51451

"tagname": "",

51452

"static": 1,

51453

"description": "The Constrained instance will be placed on the Drag instance under the con namespace.",

51454

"type": "{String}",

51455

"class": "Plugin.DDConstrained",

51456

"module": "dd",

51457

"submodule": "dd-constrain",

51458

"namespace": "Plugin"

51459

},

51460

{

51461

"file": "dd/js/constrain.js",

51462

"line": 66,

51463

"itemtype": "attribute",

51464

"name": "stickX",

51465

"description": "Stick the drag movement to the X-Axis. Default: false",

51466

"type": "Boolean",

51467

"class": "Plugin.DDConstrained",

51468

"module": "dd",

51469

"submodule": "dd-constrain",

51470

"namespace": "Plugin"

51471

},

51472

{

51473

"file": "dd/js/constrain.js",

51474

"line": 74,

51475

"itemtype": "attribute",

51476

"name": "stickY",

51477

"description": "Stick the drag movement to the Y-Axis",

51478

"type": "Boolean",

51479

"class": "Plugin.DDConstrained",

51480

"module": "dd",

51481

"submodule": "dd-constrain",

51482

"namespace": "Plugin"

51483

},

51484

{

51485

"file": "dd/js/constrain.js",

51486

"line": 82,

51487

"itemtype": "attribute",

51488

"name": "tickX",

51489

"description": "The X tick offset the drag node should snap to on each drag move. False for no ticks. Default: false",

51490

"type": "Number/false",

51491

"class": "Plugin.DDConstrained",

51492

"module": "dd",

51493

"submodule": "dd-constrain",

51494

"namespace": "Plugin"

51495

},

51496

{

51497

"file": "dd/js/constrain.js",

51498

"line": 90,

51499

"itemtype": "attribute",

51500

"name": "tickY",

51501

"description": "The Y tick offset the drag node should snap to on each drag move. False for no ticks. Default: false",

51502

"type": "Number/false",

51503

"class": "Plugin.DDConstrained",

51504

"module": "dd",

51505

"submodule": "dd-constrain",

51506

"namespace": "Plugin"

51507

},

51508

{

51509

"file": "dd/js/constrain.js",

51510

"line": 98,

51511

"itemtype": "attribute",

51512

"name": "tickXArray",

51513

"description": "An array of page coordinates to use as X ticks for drag movement.",

51514

"type": "Array",

51515

"class": "Plugin.DDConstrained",

51516

"module": "dd",

51517

"submodule": "dd-constrain",

51518

"namespace": "Plugin"

51519

},

51520

{

51521

"file": "dd/js/constrain.js",

51522

"line": 106,

51523

"itemtype": "attribute",

51524

"name": "tickYArray",

51525

"description": "An array of page coordinates to use as Y ticks for drag movement.",

51526

"type": "Array",

51527

"class": "Plugin.DDConstrained",

51528

"module": "dd",

51529

"submodule": "dd-constrain",

51530

"namespace": "Plugin"

51531

},

51532

{

51533

"file": "dd/js/constrain.js",

51534

"line": 114,

51535

"itemtype": "attribute",

51536

"name": "gutter",

51537

"description": "CSS style string for the gutter of a region (supports negative values): '5 0' (sets top and bottom to 5px, left and right to 0px), '1 2 3 4' (top 1px, right 2px, bottom 3px, left 4px)",

51538

"type": "String",

51539

"class": "Plugin.DDConstrained",

51540

"module": "dd",

51541

"submodule": "dd-constrain",

51542

"namespace": "Plugin"

51543

},

51544

{

51545

"file": "dd/js/constrain.js",

51546

"line": 125,

51547

"itemtype": "attribute",

51548

"name": "constrain",

51549

"description": "Will attempt to constrain the drag node to the boundaries. Arguments: \n'view': Contrain to Viewport \n'#selector_string': Constrain to this node \n'{Region Object}': An Object Literal containing a valid region (top, right, bottom, left) of page positions",

51550

"type": "{String/Object/Node}",

51551

"class": "Plugin.DDConstrained",

51552

"module": "dd",

51553

"submodule": "dd-constrain",

51554

"namespace": "Plugin"

51555

},

51556

{

51557

"file": "dd/js/constrain.js",

51558

"line": 143,

51559

"deprecated": true,

51560

"itemtype": "attribute",

51561

"name": "constrain2region",

51562

"description": "An Object Literal containing a valid region (top, right, bottom, left) of page positions to constrain the drag node to.",

51563

"type": "Object",

51564

"class": "Plugin.DDConstrained",

51565

"module": "dd",

51566

"submodule": "dd-constrain",

51567

"namespace": "Plugin"

51568

},

51569

{

51570

"file": "dd/js/constrain.js",

51571

"line": 154,

51572

"deprecated": true,

51573

"itemtype": "attribute",

51574

"name": "constrain2node",

51575

"description": "Will attempt to constrain the drag node to the boundaries of this node.",

51576

"type": "Object",

51577

"class": "Plugin.DDConstrained",

51578

"module": "dd",

51579

"submodule": "dd-constrain",

51580

"namespace": "Plugin"

51581

},

51582

{

51583

"file": "dd/js/constrain.js",

51584

"line": 165,

51585

"deprecated": true,

51586

"itemtype": "attribute",

51587

"name": "constrain2view",

51588

"description": "Will attempt to constrain the drag node to the boundaries of the viewport region.",

51589

"type": "Object",

51590

"class": "Plugin.DDConstrained",

51591

"module": "dd",

51592

"submodule": "dd-constrain",

51593

"namespace": "Plugin"

51594

},

51595

{

51596

"file": "dd/js/constrain.js",

51597

"line": 176,

51598

"itemtype": "attribute",

51599

"name": "cacheRegion",

51600

"description": "Should the region be cached for performace. Default: true",

51601

"type": "Boolean",

51602

"class": "Plugin.DDConstrained",

51603

"module": "dd",

51604

"submodule": "dd-constrain",

51605

"namespace": "Plugin"

51606

},

51607

{

51608

"file": "dd/js/constrain.js",

51609

"line": 204,

51610

"access": "private",

51611

"tagname": "",

51612

"itemtype": "method",

51613

"name": "_createEvents",

51614

"description": "This method creates all the events for this Event Target and publishes them so we get Event Bubbling.",

51615

"class": "Plugin.DDConstrained",

51616

"module": "dd",

51617

"submodule": "dd-constrain",

51618

"namespace": "Plugin"

51619

},

51620

{

51621

"file": "dd/js/constrain.js",

51622

"line": 227,

51623

"access": "private",

51624

"tagname": "",

51625

"itemtype": "method",

51626

"name": "_handleEnd",

51627

"description": "Fires on drag:end",

51628

"class": "Plugin.DDConstrained",

51629

"module": "dd",

51630

"submodule": "dd-constrain",

51631

"namespace": "Plugin"

51632

},

51633

{

51634

"file": "dd/js/constrain.js",

51635

"line": 236,

51636

"access": "private",

51637

"tagname": "",

51638

"itemtype": "method",

51639

"name": "_handleStart",

51640

"description": "Fires on drag:start and clears the _regionCache",

51641

"class": "Plugin.DDConstrained",

51642

"module": "dd",

51643

"submodule": "dd-constrain",

51644

"namespace": "Plugin"

51645

},

51646

{

51647

"file": "dd/js/constrain.js",

51648

"line": 244,

51649

"access": "private",

51650

"tagname": "",

51651

"itemtype": "property",

51652

"name": "_regionCache",

51653

"description": "Store a cache of the region that we are constraining to",

51654

"type": "Object",

51655

"class": "Plugin.DDConstrained",

51656

"module": "dd",

51657

"submodule": "dd-constrain",

51658

"namespace": "Plugin"

51659

},

51660

{

51661

"file": "dd/js/constrain.js",

51662

"line": 251,

51663

"description": "Event handle for window resize event.",

51664

"access": "private",

51665

"tagname": "",

51666

"itemtype": "property",

51667

"name": "_cacheHandle",

51668

"type": "{Event}",

51669

"class": "Plugin.DDConstrained",

51670

"module": "dd",

51671

"submodule": "dd-constrain",

51672

"namespace": "Plugin"

51673

},

51674

{

51675

"file": "dd/js/constrain.js",

51676

"line": 258,

51677

"access": "private",

51678

"tagname": "",

51679

"itemtype": "method",

51680

"name": "_cacheRegion",

51681

"description": "Get's the region and caches it, called from window.resize and when the cache is null",

51682

"class": "Plugin.DDConstrained",

51683

"module": "dd",

51684

"submodule": "dd-constrain",

51685

"namespace": "Plugin"

51686

},

51687

{

51688

"file": "dd/js/constrain.js",

51689

"line": 266,

51690

"itemtype": "method",

51691

"name": "resetCache",

51692

"description": "Reset the internal region cache.",

51693

"class": "Plugin.DDConstrained",

51694

"module": "dd",

51695

"submodule": "dd-constrain",

51696

"namespace": "Plugin"

51697

},

51698

{

51699

"file": "dd/js/constrain.js",

51700

"line": 273,

51701

"access": "private",

51702

"tagname": "",

51703

"itemtype": "method",

51704

"name": "_getConstraint",

51705

"description": "Standardizes the 'constraint' attribute",

51706

"class": "Plugin.DDConstrained",

51707

"module": "dd",

51708

"submodule": "dd-constrain",

51709

"namespace": "Plugin"

51710

},

51711

{

51712

"file": "dd/js/constrain.js",

51713

"line": 314,

51714

"itemtype": "method",

51715

"name": "getRegion",

51716

"description": "Get the active region: viewport, node, custom region",

51717

"params": [

51718

{

51719

"name": "inc",

51720

"description": "Include the node's height and width",

51721

"type": "Boolean"

51722

}

51723

],

51724

"return": {

51725

"description": "The active region.",

51726

"type": "Object"

51727

},

51728

"class": "Plugin.DDConstrained",

51729

"module": "dd",

51730

"submodule": "dd-constrain",

51731

"namespace": "Plugin"

51732

},

51733

{

51734

"file": "dd/js/constrain.js",

51735

"line": 334,

51736

"access": "private",

51737

"tagname": "",

51738

"itemtype": "method",

51739

"name": "_checkRegion",

51740

"description": "Check if xy is inside a given region, if not change to it be inside.",

51741

"params": [

51742

{

51743

"name": "_xy",

51744

"description": "The XY to check if it's in the current region, if it isn't inside the region, it will reset the xy array to be inside the region.",

51745

"type": "Array"

51746

}

51747

],

51748

"return": {

51749

"description": "The new XY that is inside the region",

51750

"type": "Array"

51751

},

51752

"class": "Plugin.DDConstrained",

51753

"module": "dd",

51754

"submodule": "dd-constrain",

51755

"namespace": "Plugin"

51756

},

51757

{

51758

"file": "dd/js/constrain.js",

51759

"line": 364,

51760

"itemtype": "method",

51761

"name": "inRegion",

51762

"description": "Checks if the XY passed or the dragNode is inside the active region.",

51763

"params": [

51764

{

51765

"name": "xy",

51766

"description": "Optional XY to check, if not supplied this.get('dragNode').getXY() is used.",

51767

"type": "Array"

51768

}

51769

],

51770

"return": {

51771

"description": "True if the XY is inside the region, false otherwise.",

51772

"type": "Boolean"

51773

},

51774

"class": "Plugin.DDConstrained",

51775

"module": "dd",

51776

"submodule": "dd-constrain",

51777

"namespace": "Plugin"

51778

},

51779

{

51780

"file": "dd/js/constrain.js",

51781

"line": 380,

51782

"itemtype": "method",

51783

"name": "align",

51784

"description": "Modifies the Drag.actXY method from the after drag:align event. This is where the constraining happens.",

51785

"class": "Plugin.DDConstrained",

51786

"module": "dd",

51787

"submodule": "dd-constrain",

51788

"namespace": "Plugin"

51789

},

51790

{

51791

"file": "dd/js/constrain.js",

51792

"line": 404,

51793

"itemtype": "method",

51794

"name": "drag",

51795

"description": "Fires after drag:drag. Handle the tickX and tickX align events.",

51796

"class": "Plugin.DDConstrained",

51797

"module": "dd",

51798

"submodule": "dd-constrain",

51799

"namespace": "Plugin"

51800

},

51801

{

51802

"file": "dd/js/constrain.js",

51803

"line": 424,

51804

"access": "private",

51805

"tagname": "",

51806

"itemtype": "method",

51807

"name": "_checkTicks",

51808

"description": "This method delegates the proper helper method for tick calculations",

51809

"params": [

51810

{

51811

"name": "xy",

51812

"description": "The XY coords for the Drag",

51813

"type": "Array"

51814

},

51815

{

51816

"name": "r",

51817

"description": "The optional region that we are bound to.",

51818

"type": "Object"

51819

}

51820

],

51821

"return": {

51822

"description": "The calced XY coords",

51823

"type": "Array"

51824

},

51825

"class": "Plugin.DDConstrained",

51826

"module": "dd",

51827

"submodule": "dd-constrain",

51828

"namespace": "Plugin"

51829

},

51830

{

51831

"file": "dd/js/constrain.js",

51832

"line": 453,

51833

"access": "private",

51834

"tagname": "",

51835

"itemtype": "method",

51836

"name": "_tickAlignX",

51837

"description": "Fires when the actXY[0] reach a new value respecting the tickX gap.",

51838

"class": "Plugin.DDConstrained",

51839

"module": "dd",

51840

"submodule": "dd-constrain",

51841

"namespace": "Plugin"

51842

},

51843

{

51844

"file": "dd/js/constrain.js",

51845

"line": 461,

51846

"access": "private",

51847

"tagname": "",

51848

"itemtype": "method",

51849

"name": "_tickAlignY",

51850

"description": "Fires when the actXY[1] reach a new value respecting the tickY gap.",

51851

"class": "Plugin.DDConstrained",

51852

"module": "dd",

51853

"submodule": "dd-constrain",

51854

"namespace": "Plugin"

51855

},

51856

{

51857

"file": "dd/js/constrain.js",

51858

"line": 476,

51859

"access": "private",

51860

"tagname": "",

51861

"itemtype": "method",

51862

"name": "_calcTicks",

51863

"description": "Helper method to calculate the tick offsets for a given position",

51864

"params": [

51865

{

51866

"name": "pos",

51867

"description": "The current X or Y position",

51868

"type": "Number"

51869

},

51870

{

51871

"name": "start",

51872

"description": "The start X or Y position",

51873

"type": "Number"

51874

},

51875

{

51876

"name": "tick",

51877

"description": "The X or Y tick increment",

51878

"type": "Number"

51879

},

51880

{

51881

"name": "off1",

51882

"description": "The min offset that we can't pass (region)",

51883

"type": "Number"

51884

},

51885

{

51886

"name": "off2",

51887

"description": "The max offset that we can't pass (region)",

51888

"type": "Number"

51889

}

51890

],

51891

"return": {

51892

"description": "The new position based on the tick calculation",

51893

"type": "Number"

51894

},

51895

"class": "DD.DDM",

51896

"module": "dd",

51897

"submodule": "dd-constrain",

51898

"namespace": "DD"

51899

},

51900

{

51901

"file": "dd/js/constrain.js",

51902

"line": 508,

51903

"access": "private",

51904

"tagname": "",

51905

"itemtype": "method",

51906

"name": "_calcTickArray",

51907

"description": "This method is used with the tickXArray and tickYArray config options",

51908

"params": [

51909

{

51910

"name": "pos",

51911

"description": "The current X or Y position",

51912

"type": "Number"

51913

},

51914

{

51915

"name": "ticks",

51916

"description": "The array containing our custom tick positions.",

51917

"type": "Number"

51918

},

51919

{

51920

"name": "off1",

51921

"description": "The min offset that we can't pass (region)",

51922

"type": "Number"

51923

},

51924

{

51925

"name": "off2",

51926

"description": "The max offset that we can't pass (region)",

51927

"type": "Number"

51928

}

51929

],

51930

"return": {

51931

"description": "The tick position"

51932

},

51933

"class": "DD.DDM",

51934

"module": "dd",

51935

"submodule": "dd-constrain",

51936

"namespace": "DD"

51937

},

51938

{

51939

"file": "dd/js/dd-drop-plugin.js",

51940

"line": 21,

51941

"itemtype": "property",

51942

"name": "NAME",

51943

"description": "dd-drop-plugin",

51944

"type": "{String}",

51945

"class": "Plugin.Drop",

51946

"module": "dd",

51947

"submodule": "dd-drop-plugin",

51948

"namespace": "Plugin"

51949

},

51950

{

51951

"file": "dd/js/dd-drop-plugin.js",

51952

"line": 27,

51953

"itemtype": "property",

51954

"name": "NS",

51955

"description": "The Drop instance will be placed on the Node instance under the drop namespace. It can be accessed via Node.drop;",

51956

"type": "{String}",

51957

"class": "Plugin.Drop",

51958

"module": "dd",

51959

"submodule": "dd-drop-plugin",

51960

"namespace": "Plugin"

51961

},

51962

{

51963

"file": "dd/js/dd-plugin.js",

51964

"line": 30,

51965

"itemtype": "property",

51966

"name": "NAME",

51967

"description": "dd-plugin",

51968

"type": "{String}",

51969

"class": "Plugin.Drag",

51970

"module": "dd",

51971

"submodule": "dd-plugin",

51972

"namespace": "Plugin"

51973

},

51974

{

51975

"file": "dd/js/dd-plugin.js",

51976

"line": 37,

51977

"itemtype": "property",

51978

"name": "NS",

51979

"description": "The Drag instance will be placed on the Node instance under the dd namespace. It can be accessed via Node.dd;",

51980

"type": "{String}",

51981

"class": "Plugin.Drag",

51982

"module": "dd",

51983

"submodule": "dd-plugin",

51984

"namespace": "Plugin"

51985

},

51986

{

51987

"file": "dd/js/dd-plugin.js",

51988

"line": 48,

51989

"description": "refers to a Y.Widget if its the host, otherwise = false.",

51990

"itemtype": "attribute",

51991

"name": "_widget",

51992

"access": "private",

51993

"tagname": "",

51994

"class": "Plugin.Drag",

51995

"module": "dd",

51996

"submodule": "dd-plugin",

51997

"namespace": "Plugin"

51998

},

51999

{

52000

"file": "dd/js/dd-plugin.js",

52001

"line": 57,

52002

"description": "refers to the [x,y] coordinate where the drag was stopped last",

52003

"itemtype": "attribute",

52004

"name": "_stoppedPosition",

52005

"access": "private",

52006

"tagname": "",

52007

"class": "Plugin.Drag",

52008

"module": "dd",

52009

"submodule": "dd-plugin",

52010

"namespace": "Plugin"

52011

},

52012

{

52013

"file": "dd/js/dd-plugin.js",

52014

"line": 66,

52015

"description": "Returns true if widget uses widgetPosition, otherwise returns false",

52016

"itemtype": "method",

52017

"name": "_usesWidgetPosition",

52018

"access": "private",

52019

"tagname": "",

52020

"class": "Plugin.Drag",

52021

"module": "dd",

52022

"submodule": "dd-plugin",

52023

"namespace": "Plugin"

52024

},

52025

{

52026

"file": "dd/js/dd-plugin.js",

52027

"line": 79,

52028

"description": "Attached to the `drag:start` event, it checks if this plugin needs\nto attach or detach listeners for widgets. If `dd-proxy` is plugged\nthe default widget positioning should be ignored.",

52029

"itemtype": "method",

52030

"name": "_checkEvents",

52031

"access": "private",

52032

"tagname": "",

52033

"class": "Plugin.Drag",

52034

"module": "dd",

52035

"submodule": "dd-plugin",

52036

"namespace": "Plugin"

52037

},

52038

{

52039

"file": "dd/js/dd-plugin.js",

52040

"line": 105,

52041

"description": "Remove the attached widget listeners",

52042

"itemtype": "method",

52043

"name": "_removeWidgetListeners",

52044

"access": "private",

52045

"tagname": "",

52046

"class": "Plugin.Drag",

52047

"module": "dd",

52048

"submodule": "dd-plugin",

52049

"namespace": "Plugin"

52050

},

52051

{

52052

"file": "dd/js/dd-plugin.js",

52053

"line": 117,

52054

"description": "If this is a Widget, then attach the positioning listeners",

52055

"itemtype": "method",

52056

"name": "_attachWidgetListeners",

52057

"access": "private",

52058

"tagname": "",

52059

"class": "Plugin.Drag",

52060

"module": "dd",

52061

"submodule": "dd-plugin",

52062

"namespace": "Plugin"

52063

},

52064

{

52065

"file": "dd/js/dd-plugin.js",

52066

"line": 134,

52067

"description": "Sets up event listeners on drag events if interacting with a widget",

52068

"itemtype": "method",

52069

"name": "initializer",

52070

"access": "protected",

52071

"tagname": "",

52072

"class": "Plugin.Drag",

52073

"module": "dd",

52074

"submodule": "dd-plugin",

52075

"namespace": "Plugin"

52076

},

52077

{

52078

"file": "dd/js/dd-plugin.js",

52079

"line": 152,

52080

"description": "Updates x,y or xy attributes on widget based on where the widget is dragged",

52081

"itemtype": "method",

52082

"name": "initializer",

52083

"params": [

52084

{

52085

"name": "e",

52086

"description": "Event Facade",

52087

"type": "EventFacade"

52088

}

52089

],

52090

"access": "private",

52091

"tagname": "",

52092

"class": "Plugin.Drag",

52093

"module": "dd",

52094

"submodule": "dd-plugin",

52095

"namespace": "Plugin"

52096

},

52097

{

52098

"file": "dd/js/dd-plugin.js",

52099

"line": 184,

52100

"description": "Updates the last position where the widget was stopped.",

52101

"itemtype": "method",

52102

"name": "_updateStopPosition",

52103

"params": [

52104

{

52105

"name": "e",

52106

"description": "Event Facade",

52107

"type": "EventFacade"

52108

}

52109

],

52110

"access": "private",

52111

"tagname": "",

52112

"class": "Plugin.Drag",

52113

"module": "dd",

52114

"submodule": "dd-plugin",

52115

"namespace": "Plugin"

52116

},

52117

{

52118

"file": "dd/js/ddm-base.js",

52119

"line": 22,

52120

"itemtype": "attribute",

52121

"name": "dragCursor",

52122

"description": "The cursor to apply when dragging, if shimmed the shim will get the cursor.",

52123

"type": "String",

52124

"class": "DD.DDM",

52125

"module": "dd",

52126

"submodule": "dd-ddm-base",

52127

"namespace": "DD"

52128

},

52129

{

52130

"file": "dd/js/ddm-base.js",

52131

"line": 30,

52132

"itemtype": "attribute",

52133

"name": "clickPixelThresh",

52134

"description": "The number of pixels to move to start a drag operation, default is 3.",

52135

"type": "Number",

52136

"class": "DD.DDM",

52137

"module": "dd",

52138

"submodule": "dd-ddm-base",

52139

"namespace": "DD"

52140

},

52141

{

52142

"file": "dd/js/ddm-base.js",

52143

"line": 38,

52144

"itemtype": "attribute",

52145

"name": "clickTimeThresh",

52146

"description": "The number of milliseconds a mousedown has to pass to start a drag operation, default is 1000.",

52147

"type": "Number",

52148

"class": "DD.DDM",

52149

"module": "dd",

52150

"submodule": "dd-ddm-base",

52151

"namespace": "DD"

52152

},

52153

{

52154

"file": "dd/js/ddm-base.js",

52155

"line": 46,

52156

"itemtype": "attribute",

52157

"name": "throttleTime",

52158

"description": "The number of milliseconds to throttle the mousemove event. Default: 150",

52159

"type": "Number",

52160

"class": "DD.DDM",

52161

"module": "dd",

52162

"submodule": "dd-ddm-base",

52163

"namespace": "DD"

52164

},

52165

{

52166

"file": "dd/js/ddm-base.js",

52167

"line": 55,

52168

"itemtype": "attribute",

52169

"name": "dragMode",

52170

"description": "This attribute only works if the dd-drop module is active. It will set the dragMode (point, intersect, strict) of all future Drag instances.",

52171

"type": "String",

52172

"class": "DD.DDM",

52173

"module": "dd",

52174

"submodule": "dd-ddm-base",

52175

"namespace": "DD"

52176

},

52177

{

52178

"file": "dd/js/ddm-base.js",

52179

"line": 72,

52180

"itemtype": "property",

52181

"name": "_active",

52182

"description": "flag set when we activate our first drag, so DDM can start listening for events.",

52183

"type": "{Boolean}",

52184

"class": "DD.DDM",

52185

"module": "dd",

52186

"submodule": "dd-ddm-base",

52187

"namespace": "DD"

52188

},

52189

{

52190

"file": "dd/js/ddm-base.js",

52191

"line": 78,

52192

"access": "private",

52193

"tagname": "",

52194

"itemtype": "method",

52195

"name": "_setDragMode",

52196

"description": "Handler for dragMode attribute setter.",

52197

"params": [

52198

{

52199

"name": "String/Number",

52200

"description": "The Number value or the String for the DragMode to default all future drag instances to."

52201

}

52202

],

52203

"return": {

52204

"description": "Number The Mode to be set"

52205

},

52206

"class": "DD.DDM",

52207

"module": "dd",

52208

"submodule": "dd-ddm-base",

52209

"namespace": "DD"

52210

},

52211

{

52212

"file": "dd/js/ddm-base.js",

52213

"line": 102,

52214

"itemtype": "property",

52215

"name": "CSS_PREFIX",

52216

"description": "The PREFIX to attach to all DD CSS class names",

52217

"type": "{String}",

52218

"class": "DD.DDM",

52219

"module": "dd",

52220

"submodule": "dd-ddm-base",

52221

"namespace": "DD"

52222

},

52223

{

52224

"file": "dd/js/ddm-base.js",

52225

"line": 109,

52226

"access": "private",

52227

"tagname": "",

52228

"itemtype": "property",

52229

"name": "_drags",

52230

"description": "Holder for all registered drag elements.",

52231

"type": "{Array}",

52232

"class": "DD.DDM",

52233

"module": "dd",

52234

"submodule": "dd-ddm-base",

52235

"namespace": "DD"

52236

},

52237

{

52238

"file": "dd/js/ddm-base.js",

52239

"line": 116,

52240

"itemtype": "property",

52241

"name": "activeDrag",

52242

"description": "A reference to the currently active draggable object.",

52243

"type": "{Drag}",

52244

"class": "DD.DDM",

52245

"module": "dd",

52246

"submodule": "dd-ddm-base",

52247

"namespace": "DD"

52248

},

52249

{

52250

"file": "dd/js/ddm-base.js",

52251

"line": 122,

52252

"access": "private",

52253

"tagname": "",

52254

"itemtype": "method",

52255

"name": "_regDrag",

52256

"description": "Adds a reference to the drag object to the DDM._drags array, called in the constructor of Drag.",

52257

"params": [

52258

{

52259

"name": "d",

52260

"description": "The Drag object",

52261

"type": "Drag"

52262

}

52263

],

52264

"class": "DD.DDM",

52265

"module": "dd",

52266

"submodule": "dd-ddm-base",

52267

"namespace": "DD"

52268

},

52269

{

52270

"file": "dd/js/ddm-base.js",

52271

"line": 139,

52272

"access": "private",

52273

"tagname": "",

52274

"itemtype": "method",

52275

"name": "_unregDrag",

52276

"description": "Remove this drag object from the DDM._drags array.",

52277

"params": [

52278

{

52279

"name": "d",

52280

"description": "The drag object.",

52281

"type": "Drag"

52282

}

52283

],

52284

"class": "DD.DDM",

52285

"module": "dd",

52286

"submodule": "dd-ddm-base",

52287

"namespace": "DD"

52288

},

52289

{

52290

"file": "dd/js/ddm-base.js",

52291

"line": 154,

52292

"access": "private",

52293

"tagname": "",

52294

"itemtype": "method",

52295

"name": "_setupListeners",

52296

"description": "Add the document listeners.",

52297

"class": "DD.DDM",

52298

"module": "dd",

52299

"submodule": "dd-ddm-base",

52300

"namespace": "DD"

52301

},

52302

{

52303

"file": "dd/js/ddm-base.js",

52304

"line": 167,

52305

"access": "private",

52306

"tagname": "",

52307

"itemtype": "method",

52308

"name": "_start",

52309

"description": "Internal method used by Drag to signal the start of a drag operation",

52310

"class": "DD.DDM",

52311

"module": "dd",

52312

"submodule": "dd-ddm-base",

52313

"namespace": "DD"

52314

},

52315

{

52316

"file": "dd/js/ddm-base.js",

52317

"line": 176,

52318

"access": "private",

52319

"tagname": "",

52320

"itemtype": "method",

52321

"name": "_startDrag",

52322

"description": "Factory method to be overwritten by other DDM's",

52323

"params": [

52324

{

52325

"name": "x",

52326

"description": "The x position of the drag element",

52327

"type": "Number"

52328

},

52329

{

52330

"name": "y",

52331

"description": "The y position of the drag element",

52332

"type": "Number"

52333

},

52334

{

52335

"name": "w",

52336

"description": "The width of the drag element",

52337

"type": "Number"

52338

},

52339

{

52340

"name": "h",

52341

"description": "The height of the drag element",

52342

"type": "Number"

52343

}

52344

],

52345

"class": "DD.DDM",

52346

"module": "dd",

52347

"submodule": "dd-ddm-base",

52348

"namespace": "DD"

52349

},

52350

{

52351

"file": "dd/js/ddm-base.js",

52352

"line": 186,

52353

"access": "private",

52354

"tagname": "",

52355

"itemtype": "method",

52356

"name": "_endDrag",

52357

"description": "Factory method to be overwritten by other DDM's",

52358

"class": "DD.DDM",

52359

"module": "dd",

52360

"submodule": "dd-ddm-base",

52361

"namespace": "DD"

52362

},

52363

{

52364

"file": "dd/js/ddm-base.js",

52365

"line": 193,

52366

"access": "private",

52367

"tagname": "",

52368

"itemtype": "method",

52369

"name": "_end",

52370

"description": "Internal method used by Drag to signal the end of a drag operation",

52371

"class": "DD.DDM",

52372

"module": "dd",

52373

"submodule": "dd-ddm-base",

52374

"namespace": "DD"

52375

},

52376

{

52377

"file": "dd/js/ddm-base.js",

52378

"line": 206,

52379

"itemtype": "method",

52380

"name": "stopDrag",

52381

"description": "Method will forcefully stop a drag operation. For example calling this from inside an ESC keypress handler will stop this drag.",

52382

"return": {

52383

"description": "",

52384

"type": "Self"

52385

},

52386

"chainable": 1,

52387

"class": "DD.DDM",

52388

"module": "dd",

52389

"submodule": "dd-ddm-base",

52390

"namespace": "DD"

52391

},

52392

{

52393

"file": "dd/js/ddm-base.js",

52394

"line": 218,

52395

"access": "private",

52396

"tagname": "",

52397

"itemtype": "method",

52398

"name": "_move",

52399

"description": "Internal listener for the mousemove DOM event to pass to the Drag's move method.",

52400

"params": [

52401

{

52402

"name": "ev",

52403

"description": "The Dom mousemove Event",

52404

"type": "Event.Facade"

52405

}

52406

],

52407

"class": "DD.DDM",

52408

"module": "dd",

52409

"submodule": "dd-ddm-base",

52410

"namespace": "DD"

52411

},

52412

{

52413

"file": "dd/js/ddm-base.js",

52414

"line": 230,

52415

"description": "Helper method to use to set the gutter from the attribute setter.",

52416

"access": "private",

52417

"tagname": "",

52418

"itemtype": "method",

52419

"name": "cssSizestoObject",

52420

"params": [

52421

{

52422

"name": "gutter",

52423

"description": "CSS style string for gutter: '5 0' (sets top and bottom to 5px, left and right to 0px), '1 2 3 4' (top 1px, right 2px, bottom 3px, left 4px)",

52424

"type": "String"

52425

}

52426

],

52427

"return": {

52428

"description": "The gutter Object Literal.",

52429

"type": "Object"

52430

},

52431

"class": "DD.DDM",

52432

"module": "dd",

52433

"submodule": "dd-ddm-base",

52434

"namespace": "DD"

52435

},

52436

{

52437

"file": "dd/js/ddm-base.js",

52438

"line": 254,

52439

"itemtype": "method",

52440

"name": "getDrag",

52441

"description": "Get a valid Drag instance back from a Node or a selector string, false otherwise",

52442

"params": [

52443

{

52444

"name": "node",

52445

"description": "The Node instance or Selector string to check for a valid Drag Object",

52446

"type": "String/Object"

52447

}

52448

],

52449

"return": {

52450

"description": "",

52451

"type": "Object"

52452

},

52453

"class": "DD.DDM",

52454

"module": "dd",

52455

"submodule": "dd-ddm-base",

52456

"namespace": "DD"

52457

},

52458

{

52459

"file": "dd/js/ddm-base.js",

52460

"line": 272,

52461

"itemtype": "method",

52462

"name": "swapPosition",

52463

"description": "Swap the position of 2 nodes based on their CSS positioning.",

52464

"params": [

52465

{

52466

"name": "n1",

52467

"description": "The first node to swap",

52468

"type": "Node"

52469

},

52470

{

52471

"name": "n2",

52472

"description": "The first node to swap",

52473

"type": "Node"

52474

}

52475

],

52476

"return": {

52477

"description": "",

52478

"type": "Node"

52479

},

52480

"class": "DD.DDM",

52481

"module": "dd",

52482

"submodule": "dd-ddm-base",

52483

"namespace": "DD"

52484

},

52485

{

52486

"file": "dd/js/ddm-base.js",

52487

"line": 289,

52488

"itemtype": "method",

52489

"name": "getNode",

52490

"description": "Return a node instance from the given node, selector string or Y.Base extended object.",

52491

"params": [

52492

{

52493

"name": "n",

52494

"description": "The node to resolve.",

52495

"type": "Node/Object/String"

52496

}

52497

],

52498

"return": {

52499

"description": "",

52500

"type": "Node"

52501

},

52502

"class": "DD.DDM",

52503

"module": "dd",

52504

"submodule": "dd-ddm-base",

52505

"namespace": "DD"

52506

},

52507

{

52508

"file": "dd/js/ddm-base.js",

52509

"line": 310,

52510

"itemtype": "method",

52511

"name": "swapNode",

52512

"description": "Swap the position of 2 nodes based on their DOM location.",

52513

"params": [

52514

{

52515

"name": "n1",

52516

"description": "The first node to swap",

52517

"type": "Node"

52518

},

52519

{

52520

"name": "n2",

52521

"description": "The first node to swap",

52522

"type": "Node"

52523

}

52524

],

52525

"return": {

52526

"description": "",

52527

"type": "Node"

52528

},

52529

"class": "DD.DDM",

52530

"module": "dd",

52531

"submodule": "dd-ddm-base",

52532

"namespace": "DD"

52533

},

52534

{

52535

"file": "dd/js/ddm-base.js",

52536

"line": 338,

52537

"itemtype": "event",

52538

"name": "ddm:start",

52539

"description": "Fires from the DDM before all drag events fire.",

52540

"type": "{CustomEvent}",

52541

"class": "DD.DDM",

52542

"module": "dd",

52543

"submodule": "dd-ddm-base",

52544

"namespace": "DD"

52545

},

52546

{

52547

"file": "dd/js/ddm-base.js",

52548

"line": 343,

52549

"itemtype": "event",

52550

"name": "ddm:end",

52551

"description": "Fires from the DDM after the DDM finishes, before the drag end events.",

52552

"type": "{CustomEvent}",

52553

"class": "DD.DDM",

52554

"module": "dd",

52555

"submodule": "dd-ddm-base",

52556

"namespace": "DD"

52557

},

52558

{

52559

"file": "dd/js/ddm-drop.js",

52560

"line": 12,

52561

"access": "private",

52562

"tagname": "",

52563

"itemtype": "property",

52564

"name": "_noShim",

52565

"description": "This flag turns off the use of the mouseover/mouseout shim. It should not be used unless you know what you are doing.",

52566

"type": "{Boolean}",

52567

"class": "DD.DDM",

52568

"module": "dd",

52569

"submodule": "dd-ddm-drop",

52570

"namespace": "DD"

52571

},

52572

{

52573

"file": "dd/js/ddm-drop.js",

52574

"line": 19,

52575

"access": "private",

52576

"tagname": "",

52577

"itemtype": "property",

52578

"name": "_activeShims",

52579

"description": "Placeholder for all active shims on the page",

52580

"type": "{Array}",

52581

"class": "DD.DDM",

52582

"module": "dd",

52583

"submodule": "dd-ddm-drop",

52584

"namespace": "DD"

52585

},

52586

{

52587

"file": "dd/js/ddm-drop.js",

52588

"line": 26,

52589

"access": "private",

52590

"tagname": "",

52591

"itemtype": "method",

52592

"name": "_hasActiveShim",

52593

"description": "This method checks the _activeShims Object to see if there is a shim active.",

52594

"return": {

52595

"description": "",

52596

"type": "Boolean"

52597

},

52598

"class": "DD.DDM",

52599

"module": "dd",

52600

"submodule": "dd-ddm-drop",

52601

"namespace": "DD"

52602

},

52603

{

52604

"file": "dd/js/ddm-drop.js",

52605

"line": 38,

52606

"access": "private",

52607

"tagname": "",

52608

"itemtype": "method",

52609

"name": "_addActiveShim",

52610

"description": "Adds a Drop Target to the list of active shims",

52611

"params": [

52612

{

52613

"name": "d",

52614

"description": "The Drop instance to add to the list.",

52615

"type": "Object"

52616

}

52617

],

52618

"class": "DD.DDM",

52619

"module": "dd",

52620

"submodule": "dd-ddm-drop",

52621

"namespace": "DD"

52622

},

52623

{

52624

"file": "dd/js/ddm-drop.js",

52625

"line": 47,

52626

"access": "private",

52627

"tagname": "",

52628

"itemtype": "method",

52629

"name": "_removeActiveShim",

52630

"description": "Removes a Drop Target to the list of active shims",

52631

"params": [

52632

{

52633

"name": "d",

52634

"description": "The Drop instance to remove from the list.",

52635

"type": "Object"

52636

}

52637

],

52638

"class": "DD.DDM",

52639

"module": "dd",

52640

"submodule": "dd-ddm-drop",

52641

"namespace": "DD"

52642

},

52643

{

52644

"file": "dd/js/ddm-drop.js",

52645

"line": 63,

52646

"itemtype": "method",

52647

"name": "syncActiveShims",

52648

"description": "This method will sync the position of the shims on the Drop Targets that are currently active.",

52649

"params": [

52650

{

52651

"name": "force",

52652

"description": "Resize/sync all Targets.",

52653

"type": "Boolean"

52654

}

52655

],

52656

"class": "DD.DDM",

52657

"module": "dd",

52658

"submodule": "dd-ddm-drop",

52659

"namespace": "DD"

52660

},

52661

{

52662

"file": "dd/js/ddm-drop.js",

52663

"line": 76,

52664

"access": "private",

52665

"tagname": "",

52666

"itemtype": "property",

52667

"name": "mode",

52668

"description": "The mode that the drag operations will run in 0 for Point, 1 for Intersect, 2 for Strict",

52669

"type": "Number",

52670

"class": "DD.DDM",

52671

"module": "dd",

52672

"submodule": "dd-ddm-drop",

52673

"namespace": "DD"

52674

},

52675

{

52676

"file": "dd/js/ddm-drop.js",

52677

"line": 83,

52678

"access": "private",

52679

"tagname": "",

52680

"itemtype": "property",

52681

"name": "POINT",

52682

"description": "In point mode, a Drop is targeted by the cursor being over the Target",

52683

"type": "Number",

52684

"class": "DD.DDM",

52685

"module": "dd",

52686

"submodule": "dd-ddm-drop",

52687

"namespace": "DD"

52688

},

52689

{

52690

"file": "dd/js/ddm-drop.js",

52691

"line": 90,

52692

"access": "private",

52693

"tagname": "",

52694

"itemtype": "property",

52695

"name": "INTERSECT",

52696

"description": "In intersect mode, a Drop is targeted by \"part\" of the drag node being over the Target",

52697

"type": "Number",

52698

"class": "DD.DDM",

52699

"module": "dd",

52700

"submodule": "dd-ddm-drop",

52701

"namespace": "DD"

52702

},

52703

{

52704

"file": "dd/js/ddm-drop.js",

52705

"line": 97,

52706

"access": "private",

52707

"tagname": "",

52708

"itemtype": "property",

52709

"name": "STRICT",

52710

"description": "In strict mode, a Drop is targeted by the \"entire\" drag node being over the Target",

52711

"type": "Number",

52712

"class": "DD.DDM",

52713

"module": "dd",

52714

"submodule": "dd-ddm-drop",

52715

"namespace": "DD"

52716

},

52717

{

52718

"file": "dd/js/ddm-drop.js",

52719

"line": 104,

52720

"itemtype": "property",

52721

"name": "useHash",

52722

"description": "Should we only check targets that are in the viewport on drags (for performance), default: true",

52723

"type": "{Boolean}",

52724

"class": "DD.DDM",

52725

"module": "dd",

52726

"submodule": "dd-ddm-drop",

52727

"namespace": "DD"

52728

},

52729

{

52730

"file": "dd/js/ddm-drop.js",

52731

"line": 110,

52732

"itemtype": "property",

52733

"name": "activeDrop",

52734

"description": "A reference to the active Drop Target",

52735

"type": "{Object}",

52736

"class": "DD.DDM",

52737

"module": "dd",

52738

"submodule": "dd-ddm-drop",

52739

"namespace": "DD"

52740

},

52741

{

52742

"file": "dd/js/ddm-drop.js",

52743

"line": 116,

52744

"itemtype": "property",

52745

"name": "validDrops",

52746

"description": "An array of the valid Drop Targets for this interaction.",

52747

"type": "{Array}",

52748

"class": "DD.DDM",

52749

"module": "dd",

52750

"submodule": "dd-ddm-drop",

52751

"namespace": "DD"

52752

},

52753

{

52754

"file": "dd/js/ddm-drop.js",

52755

"line": 123,

52756

"itemtype": "property",

52757

"name": "otherDrops",

52758

"description": "An object literal of Other Drop Targets that we encountered during this interaction (in the case of overlapping Drop Targets)",

52759

"type": "{Object}",

52760

"class": "DD.DDM",

52761

"module": "dd",

52762

"submodule": "dd-ddm-drop",

52763

"namespace": "DD"

52764

},

52765

{

52766

"file": "dd/js/ddm-drop.js",

52767

"line": 129,

52768

"itemtype": "property",

52769

"name": "targets",

52770

"description": "All of the Targets",

52771

"type": "{Array}",

52772

"class": "DD.DDM",

52773

"module": "dd",

52774

"submodule": "dd-ddm-drop",

52775

"namespace": "DD"

52776

},

52777

{

52778

"file": "dd/js/ddm-drop.js",

52779

"line": 135,

52780

"access": "private",

52781

"tagname": "",

52782

"itemtype": "method",

52783

"name": "_addValid",

52784

"description": "Add a Drop Target to the list of Valid Targets. This list get's regenerated on each new drag operation.",

52785

"params": [

52786

{

52787

"name": "drop",

52788

"description": "",

52789

"type": "Object"

52790

}

52791

],

52792

"return": {

52793

"description": "",

52794

"type": "Self"

52795

},

52796

"chainable": 1,

52797

"class": "DD.DDM",

52798

"module": "dd",

52799

"submodule": "dd-ddm-drop",

52800

"namespace": "DD"

52801

},

52802

{

52803

"file": "dd/js/ddm-drop.js",

52804

"line": 147,

52805

"access": "private",

52806

"tagname": "",

52807

"itemtype": "method",

52808

"name": "_removeValid",

52809

"description": "Removes a Drop Target from the list of Valid Targets. This list get's regenerated on each new drag operation.",

52810

"params": [

52811

{

52812

"name": "drop",

52813

"description": "",

52814

"type": "Object"

52815

}

52816

],

52817

"return": {

52818

"description": "",

52819

"type": "Self"

52820

},

52821

"chainable": 1,

52822

"class": "DD.DDM",

52823

"module": "dd",

52824

"submodule": "dd-ddm-drop",

52825

"namespace": "DD"

52826

},

52827

{

52828

"file": "dd/js/ddm-drop.js",

52829

"line": 166,

52830

"itemtype": "method",

52831

"name": "isOverTarget",

52832

"description": "Check to see if the Drag element is over the target, method varies on current mode",

52833

"params": [

52834

{

52835

"name": "drop",

52836

"description": "The drop to check against",

52837

"type": "Object"

52838

}

52839

],

52840

"return": {

52841

"description": "",

52842

"type": "Boolean"

52843

},

52844

"class": "DD.DDM",

52845

"module": "dd",

52846

"submodule": "dd-ddm-drop",

52847

"namespace": "DD"

52848

},

52849

{

52850

"file": "dd/js/ddm-drop.js",

52851

"line": 207,

52852

"itemtype": "method",

52853

"name": "clearCache",

52854

"description": "Clears the cache data used for this interaction.",

52855

"class": "DD.DDM",

52856

"module": "dd",

52857

"submodule": "dd-ddm-drop",

52858

"namespace": "DD"

52859

},

52860

{

52861

"file": "dd/js/ddm-drop.js",

52862

"line": 216,

52863

"access": "private",

52864

"tagname": "",

52865

"itemtype": "method",

52866

"name": "_activateTargets",

52867

"description": "Clear the cache and activate the shims of all the targets",

52868

"class": "DD.DDM",

52869

"module": "dd",

52870

"submodule": "dd-ddm-drop",

52871

"namespace": "DD"

52872

},

52873

{

52874

"file": "dd/js/ddm-drop.js",

52875

"line": 233,

52876

"itemtype": "method",

52877

"name": "getBestMatch",

52878

"description": "This method will gather the area for all potential targets and see which has the hightest covered area and return it.",

52879

"params": [

52880

{

52881

"name": "drops",

52882

"description": "An Array of drops to scan for the best match.",

52883

"type": "Array"

52884

},

52885

{

52886

"name": "all",

52887

"description": "If present, it returns an Array. First item is best match, second is an Array of the other items in the original Array.",

52888

"type": "Boolean"

52889

}

52890

],

52891

"return": {

52892

"description": "",

52893

"type": "Object or Array"

52894

},

52895

"class": "DD.DDM",

52896

"module": "dd",

52897

"submodule": "dd-ddm-drop",

52898

"namespace": "DD"

52899

},

52900

{

52901

"file": "dd/js/ddm-drop.js",

52902

"line": 267,

52903

"access": "private",

52904

"tagname": "",

52905

"itemtype": "method",

52906

"name": "_deactivateTargets",

52907

"description": "This method fires the drop:hit, drag:drophit, drag:dropmiss methods and deactivates the shims..",

52908

"class": "DD.DDM",

52909

"module": "dd",

52910

"submodule": "dd-ddm-drop",

52911

"namespace": "DD"

52912

},

52913

{

52914

"file": "dd/js/ddm-drop.js",

52915

"line": 305,

52916

"access": "private",

52917

"tagname": "",

52918

"itemtype": "method",

52919

"name": "_dropMove",

52920

"description": "This method is called when the move method is called on the Drag Object.",

52921

"class": "DD.DDM",

52922

"module": "dd",

52923

"submodule": "dd-ddm-drop",

52924

"namespace": "DD"

52925

},

52926

{

52927

"file": "dd/js/ddm-drop.js",

52928

"line": 319,

52929

"access": "private",

52930

"tagname": "",

52931

"itemtype": "method",

52932

"name": "_lookup",

52933

"description": "Filters the list of Drops down to those in the viewport.",

52934

"return": {

52935

"description": "The valid Drop Targets that are in the viewport.",

52936

"type": "Array"

52937

},

52938

"class": "DD.DDM",

52939

"module": "dd",

52940

"submodule": "dd-ddm-drop",

52941

"namespace": "DD"

52942

},

52943

{

52944

"file": "dd/js/ddm-drop.js",

52945

"line": 339,

52946

"access": "private",

52947

"tagname": "",

52948

"itemtype": "method",

52949

"name": "_handleTargetOver",

52950

"description": "This method execs _handleTargetOver on all valid Drop Targets",

52951

"class": "DD.DDM",

52952

"module": "dd",

52953

"submodule": "dd-ddm-drop",

52954

"namespace": "DD"

52955

},

52956

{

52957

"file": "dd/js/ddm-drop.js",

52958

"line": 350,

52959

"access": "private",

52960

"tagname": "",

52961

"itemtype": "method",

52962

"name": "_regTarget",

52963

"description": "Add the passed in Target to the targets collection",

52964

"params": [

52965

{

52966

"name": "t",

52967

"description": "The Target to add to the targets collection",

52968

"type": "Object"

52969

}

52970

],

52971

"class": "DD.DDM",

52972

"module": "dd",

52973

"submodule": "dd-ddm-drop",

52974

"namespace": "DD"

52975

},

52976

{

52977

"file": "dd/js/ddm-drop.js",

52978

"line": 359,

52979

"access": "private",

52980

"tagname": "",

52981

"itemtype": "method",

52982

"name": "_unregTarget",

52983

"description": "Remove the passed in Target from the targets collection",

52984

"params": [

52985

{

52986

"name": "drop",

52987

"description": "The Target to remove from the targets collection",

52988

"type": "Object"

52989

}

52990

],

52991

"class": "DD.DDM",

52992

"module": "dd",

52993

"submodule": "dd-ddm-drop",

52994

"namespace": "DD"

52995

},

52996

{

52997

"file": "dd/js/ddm-drop.js",

52998

"line": 383,

52999

"itemtype": "method",

53000

"name": "getDrop",

53001

"description": "Get a valid Drop instance back from a Node or a selector string, false otherwise",

53002

"params": [

53003

{

53004

"name": "node",

53005

"description": "The Node instance or Selector string to check for a valid Drop Object",

53006

"type": "String/Object"

53007

}

53008

],

53009

"return": {

53010

"description": "",

53011

"type": "Object"

53012

},

53013

"class": "DD.DDM",

53014

"module": "dd",

53015

"submodule": "dd-ddm-drop",

53016

"namespace": "DD"

53017

},

53018

{

53019

"file": "dd/js/ddm.js",

53020

"line": 11,

53021

"access": "private",

53022

"tagname": "",

53023

"itemtype": "property",

53024

"name": "_pg",

53025

"description": "The shim placed over the screen to track the mousemove event.",

53026

"type": "{Node}",

53027

"class": "DD.DDM",

53028

"module": "dd",

53029

"submodule": "dd-ddm",

53030

"namespace": "DD"

53031

},

53032

{

53033

"file": "dd/js/ddm.js",

53034

"line": 18,

53035

"access": "private",

53036

"tagname": "",

53037

"itemtype": "property",

53038

"name": "_debugShim",

53039

"description": "Set this to true to set the shims opacity to .5 for debugging it, default: false.",

53040

"type": "{Boolean}",

53041

"class": "DD.DDM",

53042

"module": "dd",

53043

"submodule": "dd-ddm",

53044

"namespace": "DD"

53045

},

53046

{

53047

"file": "dd/js/ddm.js",

53048

"line": 37,

53049

"access": "private",

53050

"tagname": "",

53051

"itemtype": "method",

53052

"name": "_pg_deactivate",

53053

"description": "Deactivates the shim",

53054

"class": "DD.DDM",

53055

"module": "dd",

53056

"submodule": "dd-ddm",

53057

"namespace": "DD"

53058

},

53059

{

53060

"file": "dd/js/ddm.js",

53061

"line": 45,

53062

"access": "private",

53063

"tagname": "",

53064

"itemtype": "method",

53065

"name": "_pg_activate",

53066

"description": "Activates the shim",

53067

"class": "DD.DDM",

53068

"module": "dd",

53069

"submodule": "dd-ddm",

53070

"namespace": "DD"

53071

},

53072

{

53073

"file": "dd/js/ddm.js",

53074

"line": 71,

53075

"access": "private",

53076

"tagname": "",

53077

"itemtype": "method",

53078

"name": "_pg_size",

53079

"description": "Sizes the shim on: activatation, window:scroll, window:resize",

53080

"class": "DD.DDM",

53081

"module": "dd",

53082

"submodule": "dd-ddm",

53083

"namespace": "DD"

53084

},

53085

{

53086

"file": "dd/js/ddm.js",

53087

"line": 87,

53088

"access": "private",

53089

"tagname": "",

53090

"itemtype": "method",

53091

"name": "_createPG",

53092

"description": "Creates the shim and adds it's listeners to it.",

53093

"class": "DD.DDM",

53094

"module": "dd",

53095

"submodule": "dd-ddm",

53096

"namespace": "DD"

53097

},

53098

{

53099

"file": "dd/js/delegate.js",

53100

"line": 25,

53101

"access": "private",

53102

"tagname": "",

53103

"itemtype": "property",

53104

"name": "_bubbleTargets",

53105

"description": "The default bubbleTarget for this object. Default: Y.DD.DDM",

53106

"class": "DD.Delegate",

53107

"module": "dd",

53108

"submodule": "dd-delegate",

53109

"namespace": "DD"

53110

},

53111

{

53112

"file": "dd/js/delegate.js",

53113

"line": 31,

53114

"itemtype": "property",

53115

"name": "dd",

53116

"description": "A reference to the temporary dd instance used under the hood.",

53117

"class": "DD.Delegate",

53118

"module": "dd",

53119

"submodule": "dd-delegate",

53120

"namespace": "DD"

53121

},

53122

{

53123

"file": "dd/js/delegate.js",

53124

"line": 36,

53125

"itemtype": "property",

53126

"name": "_shimState",

53127

"access": "private",

53128

"tagname": "",

53129

"description": "The state of the Y.DD.DDM._noShim property to it can be reset.",

53130

"class": "DD.Delegate",

53131

"module": "dd",

53132

"submodule": "dd-delegate",

53133

"namespace": "DD"

53134

},

53135

{

53136

"file": "dd/js/delegate.js",

53137

"line": 42,

53138

"access": "private",

53139

"tagname": "",

53140

"itemtype": "property",

53141

"name": "_handles",

53142

"description": "Array of event handles to be destroyed",

53143

"class": "DD.Delegate",

53144

"module": "dd",

53145

"submodule": "dd-delegate",

53146

"namespace": "DD"

53147

},

53148

{

53149

"file": "dd/js/delegate.js",

53150

"line": 48,

53151

"access": "private",

53152

"tagname": "",

53153

"itemtype": "method",

53154

"name": "_onNodeChange",

53155

"description": "Listens to the nodeChange event and sets the dragNode on the temp dd instance.",

53156

"params": [

53157

{

53158

"name": "e",

53159

"description": "The Event.",

53160

"type": "Event"

53161

}

53162

],

53163

"class": "DD.Delegate",

53164

"module": "dd",

53165

"submodule": "dd-delegate",

53166

"namespace": "DD"

53167

},

53168

{

53169

"file": "dd/js/delegate.js",

53170

"line": 57,

53171

"access": "private",

53172

"tagname": "",

53173

"itemtype": "method",

53174

"name": "_afterDragEnd",

53175

"description": "Listens for the drag:end event and updates the temp dd instance.",

53176

"params": [

53177

{

53178

"name": "e",

53179

"description": "The Event.",

53180

"type": "Event"

53181

}

53182

],

53183

"class": "DD.Delegate",

53184

"module": "dd",

53185

"submodule": "dd-delegate",

53186

"namespace": "DD"

53187

},

53188

{

53189

"file": "dd/js/delegate.js",

53190

"line": 71,

53191

"access": "private",

53192

"tagname": "",

53193

"itemtype": "method",

53194

"name": "_delMouseDown",

53195

"description": "The callback for the Y.DD.Delegate instance used",

53196

"params": [

53197

{

53198

"name": "e",

53199

"description": "The MouseDown Event.",

53200

"type": "Event"

53201

}

53202

],

53203

"class": "DD.Delegate",

53204

"module": "dd",

53205

"submodule": "dd-delegate",

53206

"namespace": "DD"

53207

},

53208

{

53209

"file": "dd/js/delegate.js",

53210

"line": 96,

53211

"access": "private",

53212

"tagname": "",

53213

"itemtype": "method",

53214

"name": "_onMouseEnter",

53215

"description": "Sets the target shim state",

53216

"params": [

53217

{

53218

"name": "e",

53219

"description": "The MouseEnter Event",

53220

"type": "Event"

53221

}

53222

],

53223

"class": "DD.Delegate",

53224

"module": "dd",

53225

"submodule": "dd-delegate",

53226

"namespace": "DD"

53227

},

53228

{

53229

"file": "dd/js/delegate.js",

53230

"line": 106,

53231

"access": "private",

53232

"tagname": "",

53233

"itemtype": "method",

53234

"name": "_onMouseLeave",

53235

"description": "Resets the target shim state",

53236

"params": [

53237

{

53238

"name": "e",

53239

"description": "The MouseLeave Event",

53240

"type": "Event"

53241

}

53242

],

53243

"class": "DD.Delegate",

53244

"module": "dd",

53245

"submodule": "dd-delegate",

53246

"namespace": "DD"

53247

},

53248

{

53249

"file": "dd/js/delegate.js",

53250

"line": 148,

53251

"itemtype": "method",

53252

"name": "syncTargets",

53253

"description": "Applies the Y.Plugin.Drop to all nodes matching the cont + nodes selector query.",

53254

"return": {

53255

"description": "",

53256

"type": "Self"

53257

},

53258

"chainable": 1,

53259

"class": "DD.Delegate",

53260

"module": "dd",

53261

"submodule": "dd-delegate",

53262

"namespace": "DD"

53263

},

53264

{

53265

"file": "dd/js/delegate.js",

53266

"line": 175,

53267

"itemtype": "method",

53268

"name": "createDrop",

53269

"description": "Apply the Drop plugin to this node",

53270

"params": [

53271

{

53272

"name": "node",

53273

"description": "The Node to apply the plugin to",

53274

"type": "Node"

53275

},

53276

{

53277

"name": "groups",

53278

"description": "The default groups to assign this target to.",

53279

"type": "Array"

53280

}

53281

],

53282

"return": {

53283

"description": "Node"

53284

},

53285

"class": "DD.Delegate",

53286

"module": "dd",

53287

"submodule": "dd-delegate",

53288

"namespace": "DD"

53289

},

53290

{

53291

"file": "dd/js/delegate.js",

53292

"line": 209,

53293

"itemtype": "attribute",

53294

"name": "container",

53295

"description": "A selector query to get the container to listen for mousedown events on. All \"nodes\" should be a child of this container.",

53296

"type": "String",

53297

"class": "DD.Delegate",

53298

"module": "dd",

53299

"submodule": "dd-delegate",

53300

"namespace": "DD"

53301

},

53302

{

53303

"file": "dd/js/delegate.js",

53304

"line": 217,

53305

"itemtype": "attribute",

53306

"name": "nodes",

53307

"description": "A selector query to get the children of the \"container\" to make draggable elements from.",

53308

"type": "String",

53309

"class": "DD.Delegate",

53310

"module": "dd",

53311

"submodule": "dd-delegate",

53312

"namespace": "DD"

53313

},

53314

{

53315

"file": "dd/js/delegate.js",

53316

"line": 225,

53317

"itemtype": "attribute",

53318

"name": "invalid",

53319

"description": "A selector query to test a node to see if it's an invalid item.",

53320

"type": "String",

53321

"class": "DD.Delegate",

53322

"module": "dd",

53323

"submodule": "dd-delegate",

53324

"namespace": "DD"

53325

},

53326

{

53327

"file": "dd/js/delegate.js",

53328

"line": 233,

53329

"itemtype": "attribute",

53330

"name": "lastNode",

53331

"description": "Y.Node instance of the last item dragged.",

53332

"type": "Node",

53333

"class": "DD.Delegate",

53334

"module": "dd",

53335

"submodule": "dd-delegate",

53336

"namespace": "DD"

53337

},

53338

{

53339

"file": "dd/js/delegate.js",

53340

"line": 241,

53341

"itemtype": "attribute",

53342

"name": "currentNode",

53343

"description": "Y.Node instance of the dd node.",

53344

"type": "Node",

53345

"class": "DD.Delegate",

53346

"module": "dd",

53347

"submodule": "dd-delegate",

53348

"namespace": "DD"

53349

},

53350

{

53351

"file": "dd/js/delegate.js",

53352

"line": 249,

53353

"itemtype": "attribute",

53354

"name": "dragNode",

53355

"description": "Y.Node instance of the dd dragNode.",

53356

"type": "Node",

53357

"class": "DD.Delegate",

53358

"module": "dd",

53359

"submodule": "dd-delegate",

53360

"namespace": "DD"

53361

},

53362

{

53363

"file": "dd/js/delegate.js",

53364

"line": 257,

53365

"itemtype": "attribute",

53366

"name": "over",

53367

"description": "Is the mouse currently over the container",

53368

"type": "Boolean",

53369

"class": "DD.Delegate",

53370

"module": "dd",

53371

"submodule": "dd-delegate",

53372

"namespace": "DD"

53373

},

53374

{

53375

"file": "dd/js/delegate.js",

53376

"line": 265,

53377

"itemtype": "attribute",

53378

"name": "target",

53379

"description": "Should the items also be a drop target.",

53380

"type": "Boolean",

53381

"class": "DD.Delegate",

53382

"module": "dd",

53383

"submodule": "dd-delegate",

53384

"namespace": "DD"

53385

},

53386

{

53387

"file": "dd/js/delegate.js",

53388

"line": 273,

53389

"itemtype": "attribute",

53390

"name": "dragConfig",

53391

"description": "The default config to be used when creating the DD instance.",

53392

"type": "Object",

53393

"class": "DD.Delegate",

53394

"module": "dd",

53395

"submodule": "dd-delegate",

53396

"namespace": "DD"

53397

},

53398

{

53399

"file": "dd/js/delegate.js",

53400

"line": 281,

53401

"itemtype": "attribute",

53402

"name": "handles",

53403

"description": "The handles config option added to the temp DD instance.",

53404

"type": "Array",

53405

"class": "DD.Delegate",

53406

"module": "dd",

53407

"submodule": "dd-delegate",

53408

"namespace": "DD"

53409

},

53410

{

53411

"file": "dd/js/delegate.js",

53412

"line": 293,

53413

"access": "private",

53414

"tagname": "",

53415

"itemtype": "property",

53416

"name": "_delegates",

53417

"description": "Holder for all Y.DD.Delegate instances",

53418

"type": "Array",

53419

"class": "DD.DDM",

53420

"module": "dd",

53421

"submodule": "dd-delegate",

53422

"namespace": "DD"

53423

},

53424

{

53425

"file": "dd/js/delegate.js",

53426

"line": 301,

53427

"itemtype": "method",

53428

"name": "regDelegate",

53429

"description": "Register a Delegate with the DDM",

53430

"class": "DD.DDM",

53431

"module": "dd",

53432

"submodule": "dd-delegate",

53433

"namespace": "DD"

53434

},

53435

{

53436

"file": "dd/js/delegate.js",

53437

"line": 309,

53438

"itemtype": "method",

53439

"name": "getDelegate",

53440

"description": "Get a delegate instance from a container node",

53441

"return": {

53442

"description": "Y.DD.Delegate"

53443

},

53444

"class": "DD.DDM",

53445

"module": "dd",

53446

"submodule": "dd-delegate",

53447

"namespace": "DD"

53448

},

53449

{

53450

"file": "dd/js/drag.js",

53451

"line": 21,

53452

"itemtype": "event",

53453

"name": "drag:mouseup",

53454

"description": "Handles the mouseup DOM event, does nothing internally just fires.",

53455

"bubbles": "DDM",

53456

"type": "{CustomEvent}",

53457

"class": "DD.Drag",

53458

"module": "dd",

53459

"submodule": "dd-drag",

53460

"namespace": "DD"

53461

},

53462

{

53463

"file": "dd/js/drag.js",

53464

"line": 27,

53465

"itemtype": "event",

53466

"name": "drag:mouseDown",

53467

"description": "Handles the mousedown DOM event, checks to see if you have a valid handle then starts the drag timers.",

53468

"preventable": "_defMouseDownFn",

53469

"params": [

53470

{

53471

"name": "event",

53472

"description": "An Event Facade object with the following specific property added:\n<dl><dt>ev</dt><dd>The original mousedown event.</dd></dl>",

53473

"type": "EventFacade"

53474

}

53475

],

53476

"bubbles": "DDM",

53477

"type": "{CustomEvent}",

53478

"class": "DD.Drag",

53479

"module": "dd",

53480

"submodule": "dd-drag",

53481

"namespace": "DD"

53482

},

53483

{

53484

"file": "dd/js/drag.js",

53485

"line": 37,

53486

"itemtype": "event",

53487

"name": "drag:afterMouseDown",

53488

"description": "Fires after the mousedown event has been cleared.",

53489

"params": [

53490

{

53491

"name": "event",

53492

"description": "An Event Facade object with the following specific property added:\n<dl><dt>ev</dt><dd>The original mousedown event.</dd></dl>",

53493

"type": "EventFacade"

53494

}

53495

],

53496

"bubbles": "DDM",

53497

"type": "{CustomEvent}",

53498

"class": "DD.Drag",

53499

"module": "dd",

53500

"submodule": "dd-drag",

53501

"namespace": "DD"

53502

},

53503

{

53504

"file": "dd/js/drag.js",

53505

"line": 46,

53506

"itemtype": "event",

53507

"name": "drag:removeHandle",

53508

"description": "Fires after a handle is removed.",

53509

"params": [

53510

{

53511

"name": "event",

53512

"description": "An Event Facade object with the following specific property added:\n<dl><dt>handle</dt><dd>The handle that was removed.</dd></dl>",

53513

"type": "EventFacade"

53514

}

53515

],

53516

"bubbles": "DDM",

53517

"type": "{CustomEvent}",

53518

"class": "DD.Drag",

53519

"module": "dd",

53520

"submodule": "dd-drag",

53521

"namespace": "DD"

53522

},

53523

{

53524

"file": "dd/js/drag.js",

53525

"line": 55,

53526

"itemtype": "event",

53527

"name": "drag:addHandle",

53528

"description": "Fires after a handle is added.",

53529

"params": [

53530

{

53531

"name": "event",

53532

"description": "An Event Facade object with the following specific property added:\n<dl><dt>handle</dt><dd>The handle that was added.</dd></dl>",

53533

"type": "EventFacade"

53534

}

53535

],

53536

"bubbles": "DDM",

53537

"type": "{CustomEvent}",

53538

"class": "DD.Drag",

53539

"module": "dd",

53540

"submodule": "dd-drag",

53541

"namespace": "DD"

53542

},

53543

{

53544

"file": "dd/js/drag.js",

53545

"line": 64,

53546

"itemtype": "event",

53547

"name": "drag:removeInvalid",

53548

"description": "Fires after an invalid selector is removed.",

53549

"params": [

53550

{

53551

"name": "event",

53552

"description": "An Event Facade object with the following specific property added:\n<dl><dt>handle</dt><dd>The handle that was removed.</dd></dl>",

53553

"type": "EventFacade"

53554

}

53555

],

53556

"bubbles": "DDM",

53557

"type": "{CustomEvent}",

53558

"class": "DD.Drag",

53559

"module": "dd",

53560

"submodule": "dd-drag",

53561

"namespace": "DD"

53562

},

53563

{

53564

"file": "dd/js/drag.js",

53565

"line": 73,

53566

"itemtype": "event",

53567

"name": "drag:addInvalid",

53568

"description": "Fires after an invalid selector is added.",

53569

"params": [

53570

{

53571

"name": "event",

53572

"description": "An Event Facade object with the following specific property added:\n<dl><dt>handle</dt><dd>The handle that was added.</dd></dl>",

53573

"type": "EventFacade"

53574

}

53575

],

53576

"bubbles": "DDM",

53577

"type": "{CustomEvent}",

53578

"class": "DD.Drag",

53579

"module": "dd",

53580

"submodule": "dd-drag",

53581

"namespace": "DD"

53582

},

53583

{

53584

"file": "dd/js/drag.js",

53585

"line": 82,

53586

"itemtype": "event",

53587

"name": "drag:start",

53588

"description": "Fires at the start of a drag operation.",

53589

"params": [

53590

{

53591

"name": "event",

53592

"description": "An Event Facade object with the following specific property added:\n<dl>\n<dt>pageX</dt><dd>The original node position X.</dd>\n<dt>pageY</dt><dd>The original node position Y.</dd>\n<dt>startTime</dt><dd>The startTime of the event. getTime on the current Date object.</dd>\n</dl>",

53593

"type": "EventFacade"

53594

}

53595

],

53596

"bubbles": "DDM",

53597

"type": "{CustomEvent}",

53598

"class": "DD.Drag",

53599

"module": "dd",

53600

"submodule": "dd-drag",

53601

"namespace": "DD"

53602

},

53603

{

53604

"file": "dd/js/drag.js",

53605

"line": 95,

53606

"itemtype": "event",

53607

"name": "drag:end",

53608

"description": "Fires at the end of a drag operation.",

53609

"params": [

53610

{

53611

"name": "event",

53612

"description": "An Event Facade object with the following specific property added:\n<dl>\n<dt>pageX</dt><dd>The current node position X.</dd>\n<dt>pageY</dt><dd>The current node position Y.</dd>\n<dt>startTime</dt><dd>The startTime of the event, from the start event.</dd>\n<dt>endTime</dt><dd>The endTime of the event. getTime on the current Date object.</dd>\n</dl>",

53613

"type": "EventFacade"

53614

}

53615

],

53616

"bubbles": "DDM",

53617

"type": "{CustomEvent}",

53618

"class": "DD.Drag",

53619

"module": "dd",

53620

"submodule": "dd-drag",

53621

"namespace": "DD"

53622

},

53623

{

53624

"file": "dd/js/drag.js",

53625

"line": 109,

53626

"itemtype": "event",

53627

"name": "drag:drag",

53628

"description": "Fires every mousemove during a drag operation.",

53629

"params": [

53630

{

53631

"name": "event",

53632

"description": "An Event Facade object with the following specific property added:\n<dl>\n<dt>pageX</dt><dd>The current node position X.</dd>\n<dt>pageY</dt><dd>The current node position Y.</dd>\n<dt>scroll</dt><dd>Should a scroll action occur.</dd>\n<dt>info</dt><dd>Object hash containing calculated XY arrays: start, xy, delta, offset</dd>\n</dl>",

53633

"type": "EventFacade"

53634

}

53635

],

53636

"bubbles": "DDM",

53637

"type": "{CustomEvent}",

53638

"class": "DD.Drag",

53639

"module": "dd",

53640

"submodule": "dd-drag",

53641

"namespace": "DD"

53642

},

53643

{

53644

"file": "dd/js/drag.js",

53645

"line": 123,

53646

"itemtype": "event",

53647

"name": "drag:align",

53648

"preventable": "_defAlignFn",

53649

"description": "Fires when this node is aligned.",

53650

"params": [

53651

{

53652

"name": "event",

53653

"description": "An Event Facade object with the following specific property added:\n<dl>\n<dt>pageX</dt><dd>The current node position X.</dd>\n<dt>pageY</dt><dd>The current node position Y.</dd>\n</dl>",

53654

"type": "EventFacade"

53655

}

53656

],

53657

"bubbles": "DDM",

53658

"type": "{CustomEvent}",

53659

"class": "DD.Drag",

53660

"module": "dd",

53661

"submodule": "dd-drag",

53662

"namespace": "DD"

53663

},

53664

{

53665

"file": "dd/js/drag.js",

53666

"line": 136,

53667

"itemtype": "event",

53668

"name": "drag:over",

53669

"description": "Fires when this node is over a Drop Target. (Fired from dd-drop)",

53670

"params": [

53671

{

53672

"name": "event",

53673

"description": "An Event Facade object with the following specific property added:\n<dl>\n<dt>drop</dt><dd>The drop object at the time of the event.</dd>\n<dt>drag</dt><dd>The drag object at the time of the event.</dd>\n</dl>",

53674

"type": "EventFacade"

53675

}

53676

],

53677

"bubbles": "DDM",

53678

"type": "{CustomEvent}",

53679

"class": "DD.Drag",

53680

"module": "dd",

53681

"submodule": "dd-drag",

53682

"namespace": "DD"

53683

},

53684

{

53685

"file": "dd/js/drag.js",

53686

"line": 147,

53687

"itemtype": "event",

53688

"name": "drag:enter",

53689

"description": "Fires when this node enters a Drop Target. (Fired from dd-drop)",

53690

"params": [

53691

{

53692

"name": "event",

53693

"description": "An Event Facade object with the following specific property added:\n<dl>\n<dt>drop</dt><dd>The drop object at the time of the event.</dd>\n<dt>drag</dt><dd>The drag object at the time of the event.</dd>\n</dl>",

53694

"type": "EventFacade"

53695

}

53696

],

53697

"bubbles": "DDM",

53698

"type": "{CustomEvent}",

53699

"class": "DD.Drag",

53700

"module": "dd",

53701

"submodule": "dd-drag",

53702

"namespace": "DD"

53703

},

53704

{

53705

"file": "dd/js/drag.js",

53706

"line": 158,

53707

"itemtype": "event",

53708

"name": "drag:exit",

53709

"description": "Fires when this node exits a Drop Target. (Fired from dd-drop)",

53710

"params": [

53711

{

53712

"name": "event",

53713

"description": "An Event Facade object with the following specific property added:\n<dl>\n<dt>drop</dt><dd>The drop object at the time of the event.</dd>\n</dl>",

53714

"type": "EventFacade"

53715

}

53716

],

53717

"bubbles": "DDM",

53718

"type": "{CustomEvent}",

53719

"class": "DD.Drag",

53720

"module": "dd",

53721

"submodule": "dd-drag",

53722

"namespace": "DD"

53723

},

53724

{

53725

"file": "dd/js/drag.js",

53726

"line": 168,

53727

"itemtype": "event",

53728

"name": "drag:drophit",

53729

"description": "Fires when this node is dropped on a valid Drop Target. (Fired from dd-ddm-drop)",

53730

"params": [

53731

{

53732

"name": "event",

53733

"description": "An Event Facade object with the following specific property added:\n<dl>\n<dt>drop</dt><dd>The best guess on what was dropped on.</dd>\n<dt>drag</dt><dd>The drag object at the time of the event.</dd>\n<dt>others</dt><dd>An array of all the other drop targets that was dropped on.</dd>\n</dl>",

53734

"type": "EventFacade"

53735

}

53736

],

53737

"bubbles": "DDM",

53738

"type": "{CustomEvent}",

53739

"class": "DD.Drag",

53740

"module": "dd",

53741

"submodule": "dd-drag",

53742

"namespace": "DD"

53743

},

53744

{

53745

"file": "dd/js/drag.js",

53746

"line": 180,

53747

"itemtype": "event",

53748

"name": "drag:dropmiss",

53749

"description": "Fires when this node is dropped on an invalid Drop Target. (Fired from dd-ddm-drop)",

53750

"params": [

53751

{

53752

"name": "event",

53753

"description": "An Event Facade object with the following specific property added:\n<dl>\n<dt>pageX</dt><dd>The current node position X.</dd>\n<dt>pageY</dt><dd>The current node position Y.</dd>\n</dl>",

53754

"type": "EventFacade"

53755

}

53756

],

53757

"bubbles": "DDM",

53758

"type": "{CustomEvent}",

53759

"class": "DD.Drag",

53760

"module": "dd",

53761

"submodule": "dd-drag",

53762

"namespace": "DD"

53763

},

53764

{

53765

"file": "dd/js/drag.js",

53766

"line": 204,

53767

"description": "This property defaults to \"mousedown\", but when drag-gestures is loaded, it is changed to \"gesturemovestart\"",

53768

"static": 1,

53769

"itemtype": "property",

53770

"name": "START_EVENT",

53771

"class": "DD.Drag",

53772

"module": "dd",

53773

"submodule": "dd-drag",

53774

"namespace": "DD"

53775

},

53776

{

53777

"file": "dd/js/drag.js",

53778

"line": 212,

53779

"itemtype": "attribute",

53780

"name": "node",

53781

"description": "Y.Node instance to use as the element to initiate a drag operation",

53782

"type": "Node",

53783

"class": "DD.Drag",

53784

"module": "dd",

53785

"submodule": "dd-drag",

53786

"namespace": "DD"

53787

},

53788

{

53789

"file": "dd/js/drag.js",

53790

"line": 229,

53791

"itemtype": "attribute",

53792

"name": "dragNode",

53793

"description": "Y.Node instance to use as the draggable element, defaults to node",

53794

"type": "Node",

53795

"class": "DD.Drag",

53796

"module": "dd",

53797

"submodule": "dd-drag",

53798

"namespace": "DD"

53799

},

53800

{

53801

"file": "dd/js/drag.js",

53802

"line": 246,

53803

"itemtype": "attribute",

53804

"name": "offsetNode",

53805

"description": "Offset the drag element by the difference in cursor position: default true",

53806

"type": "Boolean",

53807

"class": "DD.Drag",

53808

"module": "dd",

53809

"submodule": "dd-drag",

53810

"namespace": "DD"

53811

},

53812

{

53813

"file": "dd/js/drag.js",

53814

"line": 254,

53815

"itemtype": "attribute",

53816

"name": "startCentered",

53817

"description": "Center the dragNode to the mouse position on drag:start: default false",

53818

"type": "Boolean",

53819

"class": "DD.Drag",

53820

"module": "dd",

53821

"submodule": "dd-drag",

53822

"namespace": "DD"

53823

},

53824

{

53825

"file": "dd/js/drag.js",

53826

"line": 262,

53827

"itemtype": "attribute",

53828

"name": "clickPixelThresh",

53829

"description": "The number of pixels to move to start a drag operation, default is 3.",

53830

"type": "Number",

53831

"class": "DD.Drag",

53832

"module": "dd",

53833

"submodule": "dd-drag",

53834

"namespace": "DD"

53835

},

53836

{

53837

"file": "dd/js/drag.js",

53838

"line": 270,

53839

"itemtype": "attribute",

53840

"name": "clickTimeThresh",

53841

"description": "The number of milliseconds a mousedown has to pass to start a drag operation, default is 1000.",

53842

"type": "Number",

53843

"class": "DD.Drag",

53844

"module": "dd",

53845

"submodule": "dd-drag",

53846

"namespace": "DD"

53847

},

53848

{

53849

"file": "dd/js/drag.js",

53850

"line": 278,

53851

"itemtype": "attribute",

53852

"name": "lock",

53853

"description": "Set to lock this drag element so that it can't be dragged: default false.",

53854

"type": "Boolean",

53855

"class": "DD.Drag",

53856

"module": "dd",

53857

"submodule": "dd-drag",

53858

"namespace": "DD"

53859

},

53860

{

53861

"file": "dd/js/drag.js",

53862

"line": 294,

53863

"itemtype": "attribute",

53864

"name": "data",

53865

"description": "A payload holder to store arbitrary data about this drag object, can be used to store any value.",

53866

"type": "Mixed",

53867

"class": "DD.Drag",

53868

"module": "dd",

53869

"submodule": "dd-drag",

53870

"namespace": "DD"

53871

},

53872

{

53873

"file": "dd/js/drag.js",

53874

"line": 302,

53875

"itemtype": "attribute",

53876

"name": "move",

53877

"description": "If this is false, the drag element will not move with the cursor: default true. Can be used to \"resize\" the element.",

53878

"type": "Boolean",

53879

"class": "DD.Drag",

53880

"module": "dd",

53881

"submodule": "dd-drag",

53882

"namespace": "DD"

53883

},

53884

{

53885

"file": "dd/js/drag.js",

53886

"line": 310,

53887

"itemtype": "attribute",

53888

"name": "useShim",

53889

"description": "Use the protective shim on all drag operations: default true. Only works with dd-ddm, not dd-ddm-base.",

53890

"type": "Boolean",

53891

"class": "DD.Drag",

53892

"module": "dd",

53893

"submodule": "dd-drag",

53894

"namespace": "DD"

53895

},

53896

{

53897

"file": "dd/js/drag.js",

53898

"line": 318,

53899

"itemtype": "attribute",

53900

"name": "activeHandle",

53901

"description": "This config option is set by Drag to inform you of which handle fired the drag event (in the case that there are several handles): default false.",

53902

"type": "Node",

53903

"class": "DD.Drag",

53904

"module": "dd",

53905

"submodule": "dd-drag",

53906

"namespace": "DD"

53907

},

53908

{

53909

"file": "dd/js/drag.js",

53910

"line": 326,

53911

"itemtype": "attribute",

53912

"name": "primaryButtonOnly",

53913

"description": "By default a drag operation will only begin if the mousedown occurred with the primary mouse button. Setting this to false will allow for all mousedown events to trigger a drag.",

53914

"type": "Boolean",

53915

"class": "DD.Drag",

53916

"module": "dd",

53917

"submodule": "dd-drag",

53918

"namespace": "DD"

53919

},

53920

{

53921

"file": "dd/js/drag.js",

53922

"line": 334,

53923

"itemtype": "attribute",

53924

"name": "dragging",

53925

"description": "This attribute is not meant to be used by the implementor, it is meant to be used as an Event tracker so you can listen for it to change.",

53926

"type": "Boolean",

53927

"class": "DD.Drag",

53928

"module": "dd",

53929

"submodule": "dd-drag",

53930

"namespace": "DD"

53931

},

53932

{

53933

"file": "dd/js/drag.js",

53934

"line": 345,

53935

"itemtype": "attribute",

53936

"name": "target",

53937

"description": "This attribute only works if the dd-drop module has been loaded. It will make this node a drop target as well as draggable.",

53938

"type": "Boolean",

53939

"class": "DD.Drag",

53940

"module": "dd",

53941

"submodule": "dd-drag",

53942

"namespace": "DD"

53943

},

53944

{

53945

"file": "dd/js/drag.js",

53946

"line": 357,

53947

"itemtype": "attribute",

53948

"name": "dragMode",

53949

"description": "This attribute only works if the dd-drop module is active. It will set the dragMode (point, intersect, strict) of this Drag instance.",

53950

"type": "String",

53951

"class": "DD.Drag",

53952

"module": "dd",

53953

"submodule": "dd-drag",

53954

"namespace": "DD"

53955

},

53956

{

53957

"file": "dd/js/drag.js",

53958

"line": 368,

53959

"itemtype": "attribute",

53960

"name": "groups",

53961

"description": "Array of groups to add this drag into.",

53962

"type": "Array",

53963

"class": "DD.Drag",

53964

"module": "dd",

53965

"submodule": "dd-drag",

53966

"namespace": "DD"

53967

},

53968

{

53969

"file": "dd/js/drag.js",

53970

"line": 393,

53971

"itemtype": "attribute",

53972

"name": "handles",

53973

"description": "Array of valid handles to add. Adding something here will set all handles, even if previously added with addHandle",

53974

"type": "Array",

53975

"class": "DD.Drag",

53976

"module": "dd",

53977

"submodule": "dd-drag",

53978

"namespace": "DD"

53979

},

53980

{

53981

"file": "dd/js/drag.js",

53982

"line": 416,

53983

"deprecated": true,

53984

"itemtype": "attribute",

53985

"name": "bubbles",

53986

"description": "Controls the default bubble parent for this Drag instance. Default: Y.DD.DDM. Set to false to disable bubbling. Use bubbleTargets in config",

53987

"type": "Object",

53988

"class": "DD.Drag",

53989

"module": "dd",

53990

"submodule": "dd-drag",

53991

"namespace": "DD"

53992

},

53993

{

53994

"file": "dd/js/drag.js",

53995

"line": 429,

53996

"itemtype": "attribute",

53997

"name": "haltDown",

53998

"description": "Should the mousedown event be halted. Default: true",

53999

"type": "Boolean",

54000

"class": "DD.Drag",

54001

"module": "dd",

54002

"submodule": "dd-drag",

54003

"namespace": "DD"

54004

},

54005

{

54006

"file": "dd/js/drag.js",

54007

"line": 440,

54008

"description": "Checks the object for the methods needed to drag the object around. \nNormally this would be a node instance, but in the case of Graphics, it\nmay be an SVG node or something similar.",

54009

"itemtype": "method",

54010

"name": "_canDrag",

54011

"access": "private",

54012

"tagname": "",

54013

"params": [

54014

{

54015

"name": "n",

54016

"description": "The object to check",

54017

"type": "Object"

54018

}

54019

],

54020

"return": {

54021

"description": "True or false if the Object contains the methods needed to Drag",

54022

"type": "Boolean"

54023

},

54024

"class": "DD.Drag",

54025

"module": "dd",

54026

"submodule": "dd-drag",

54027

"namespace": "DD"

54028

},

54029

{

54030

"file": "dd/js/drag.js",

54031

"line": 455,

54032

"access": "private",

54033

"tagname": "",

54034

"itemtype": "property",

54035

"name": "_bubbleTargets",

54036

"description": "The default bubbleTarget for this object. Default: Y.DD.DDM",

54037

"class": "DD.Drag",

54038

"module": "dd",

54039

"submodule": "dd-drag",

54040

"namespace": "DD"

54041

},

54042

{

54043

"file": "dd/js/drag.js",

54044

"line": 461,

54045

"itemtype": "method",

54046

"name": "addToGroup",

54047

"description": "Add this Drag instance to a group, this should be used for on-the-fly group additions.",

54048

"params": [

54049

{

54050

"name": "g",

54051

"description": "The group to add this Drag Instance to.",

54052

"type": "String"

54053

}

54054

],

54055

"return": {

54056

"description": "",

54057

"type": "Self"

54058

},

54059

"chainable": 1,

54060

"class": "DD.Drag",

54061

"module": "dd",

54062

"submodule": "dd-drag",

54063

"namespace": "DD"

54064

},

54065

{

54066

"file": "dd/js/drag.js",

54067

"line": 473,

54068

"itemtype": "method",

54069

"name": "removeFromGroup",

54070

"description": "Remove this Drag instance from a group, this should be used for on-the-fly group removals.",

54071

"params": [

54072

{

54073

"name": "g",

54074

"description": "The group to remove this Drag Instance from.",

54075

"type": "String"

54076

}

54077

],

54078

"return": {

54079

"description": "",

54080

"type": "Self"

54081

},

54082

"chainable": 1,

54083

"class": "DD.Drag",

54084

"module": "dd",

54085

"submodule": "dd-drag",

54086

"namespace": "DD"

54087

},

54088

{

54089

"file": "dd/js/drag.js",

54090

"line": 485,

54091

"itemtype": "property",

54092

"name": "target",

54093

"description": "This will be a reference to the Drop instance associated with this drag if the target: true config attribute is set..",

54094

"type": "{Object}",

54095

"class": "DD.Drag",

54096

"module": "dd",

54097

"submodule": "dd-drag",

54098

"namespace": "DD"

54099

},

54100

{

54101

"file": "dd/js/drag.js",

54102

"line": 491,

54103

"access": "private",

54104

"tagname": "",

54105

"itemtype": "method",

54106

"name": "_handleTarget",

54107

"description": "Attribute handler for the target config attribute.",

54108

"params": [

54109

{

54110

"name": "config",

54111

"description": "The Config",

54112

"type": "Boolean/Object"

54113

}

54114

],

54115

"class": "DD.Drag",

54116

"module": "dd",

54117

"submodule": "dd-drag",

54118

"namespace": "DD"

54119

},

54120

{

54121

"file": "dd/js/drag.js",

54122

"line": 518,

54123

"access": "private",

54124

"tagname": "",

54125

"itemtype": "property",

54126

"name": "_groups",

54127

"description": "Storage Array for the groups this drag belongs to.",

54128

"type": "{Array}",

54129

"class": "DD.Drag",

54130

"module": "dd",

54131

"submodule": "dd-drag",

54132

"namespace": "DD"

54133

},

54134

{

54135

"file": "dd/js/drag.js",

54136

"line": 525,

54137

"access": "private",

54138

"tagname": "",

54139

"itemtype": "method",

54140

"name": "_createEvents",

54141

"description": "This method creates all the events for this Event Target and publishes them so we get Event Bubbling.",

54142

"class": "DD.Drag",

54143

"module": "dd",

54144

"submodule": "dd-drag",

54145

"namespace": "DD"

54146

},

54147

{

54148

"file": "dd/js/drag.js",

54149

"line": 590,

54150

"access": "private",

54151

"tagname": "",

54152

"itemtype": "property",

54153

"name": "_ev_md",

54154

"description": "A private reference to the mousedown DOM event",

54155

"type": "{EventFacade}",

54156

"class": "DD.Drag",

54157

"module": "dd",

54158

"submodule": "dd-drag",

54159

"namespace": "DD"

54160

},

54161

{

54162

"file": "dd/js/drag.js",

54163

"line": 597,

54164

"access": "private",

54165

"tagname": "",

54166

"itemtype": "property",

54167

"name": "_startTime",

54168

"description": "The getTime of the mousedown event. Not used, just here in case someone wants/needs to use it.",

54169

"type": "Date",

54170

"class": "DD.Drag",

54171

"module": "dd",

54172

"submodule": "dd-drag",

54173

"namespace": "DD"

54174

},

54175

{

54176

"file": "dd/js/drag.js",

54177

"line": 604,

54178

"access": "private",

54179

"tagname": "",

54180

"itemtype": "property",

54181

"name": "_endTime",

54182

"description": "The getTime of the mouseup event. Not used, just here in case someone wants/needs to use it.",

54183

"type": "Date",

54184

"class": "DD.Drag",

54185

"module": "dd",

54186

"submodule": "dd-drag",

54187

"namespace": "DD"

54188

},

54189

{

54190

"file": "dd/js/drag.js",

54191

"line": 611,

54192

"access": "private",

54193

"tagname": "",

54194

"itemtype": "property",

54195

"name": "_handles",

54196

"description": "A private hash of the valid drag handles",

54197

"type": "{Object}",

54198

"class": "DD.Drag",

54199

"module": "dd",

54200

"submodule": "dd-drag",

54201

"namespace": "DD"

54202

},

54203

{

54204

"file": "dd/js/drag.js",

54205

"line": 618,

54206

"access": "private",

54207

"tagname": "",

54208

"itemtype": "property",

54209

"name": "_invalids",

54210

"description": "A private hash of the invalid selector strings",

54211

"type": "{Object}",

54212

"class": "DD.Drag",

54213

"module": "dd",

54214

"submodule": "dd-drag",

54215

"namespace": "DD"

54216

},

54217

{

54218

"file": "dd/js/drag.js",

54219

"line": 625,

54220

"access": "private",

54221

"tagname": "",

54222

"itemtype": "property",

54223

"name": "_invalidsDefault",

54224

"description": "A private hash of the default invalid selector strings: {'textarea': true, 'input': true, 'a': true, 'button': true, 'select': true}",

54225

"type": "{Object}",

54226

"class": "DD.Drag",

54227

"module": "dd",

54228

"submodule": "dd-drag",

54229

"namespace": "DD"

54230

},

54231

{

54232

"file": "dd/js/drag.js",

54233

"line": 632,

54234

"access": "private",

54235

"tagname": "",

54236

"itemtype": "property",

54237

"name": "_dragThreshMet",

54238

"description": "Private flag to see if the drag threshhold was met",

54239

"type": "{Boolean}",

54240

"class": "DD.Drag",

54241

"module": "dd",

54242

"submodule": "dd-drag",

54243

"namespace": "DD"

54244

},

54245

{

54246

"file": "dd/js/drag.js",

54247

"line": 639,

54248

"access": "private",

54249

"tagname": "",

54250

"itemtype": "property",

54251

"name": "_fromTimeout",

54252

"description": "Flag to determine if the drag operation came from a timeout",

54253

"type": "{Boolean}",

54254

"class": "DD.Drag",

54255

"module": "dd",

54256

"submodule": "dd-drag",

54257

"namespace": "DD"

54258

},

54259

{

54260

"file": "dd/js/drag.js",

54261

"line": 646,

54262

"access": "private",

54263

"tagname": "",

54264

"itemtype": "property",

54265

"name": "_clickTimeout",

54266

"description": "Holder for the setTimeout call",

54267

"type": "{Boolean}",

54268

"class": "DD.Drag",

54269

"module": "dd",

54270

"submodule": "dd-drag",

54271

"namespace": "DD"

54272

},

54273

{

54274

"file": "dd/js/drag.js",

54275

"line": 653,

54276

"itemtype": "property",

54277

"name": "deltaXY",

54278

"description": "The offset of the mouse position to the element's position",

54279

"type": "{Array}",

54280

"class": "DD.Drag",

54281

"module": "dd",

54282

"submodule": "dd-drag",

54283

"namespace": "DD"

54284

},

54285

{

54286

"file": "dd/js/drag.js",

54287

"line": 659,

54288

"itemtype": "property",

54289

"name": "startXY",

54290

"description": "The initial mouse position",

54291

"type": "{Array}",

54292

"class": "DD.Drag",

54293

"module": "dd",

54294

"submodule": "dd-drag",

54295

"namespace": "DD"

54296

},

54297

{

54298

"file": "dd/js/drag.js",

54299

"line": 665,

54300

"itemtype": "property",

54301

"name": "nodeXY",

54302

"description": "The initial element position",

54303

"type": "{Array}",

54304

"class": "DD.Drag",

54305

"module": "dd",

54306

"submodule": "dd-drag",

54307

"namespace": "DD"

54308

},

54309

{

54310

"file": "dd/js/drag.js",

54311

"line": 671,

54312

"itemtype": "property",

54313

"name": "lastXY",

54314

"description": "The position of the element as it's moving (for offset calculations)",

54315

"type": "{Array}",

54316

"class": "DD.Drag",

54317

"module": "dd",

54318

"submodule": "dd-drag",

54319

"namespace": "DD"

54320

},

54321

{

54322

"file": "dd/js/drag.js",

54323

"line": 677,

54324

"itemtype": "property",

54325

"name": "actXY",

54326

"description": "The xy that the node will be set to. Changing this will alter the position as it's dragged.",

54327

"type": "{Array}",

54328

"class": "DD.Drag",

54329

"module": "dd",

54330

"submodule": "dd-drag",

54331

"namespace": "DD"

54332

},

54333

{

54334

"file": "dd/js/drag.js",

54335

"line": 683,

54336

"itemtype": "property",

54337

"name": "realXY",

54338

"description": "The real xy position of the node.",

54339

"type": "{Array}",

54340

"class": "DD.Drag",

54341

"module": "dd",

54342

"submodule": "dd-drag",

54343

"namespace": "DD"

54344

},

54345

{

54346

"file": "dd/js/drag.js",

54347

"line": 689,

54348

"itemtype": "property",

54349

"name": "mouseXY",

54350

"description": "The XY coords of the mousemove",

54351

"type": "{Array}",

54352

"class": "DD.Drag",

54353

"module": "dd",

54354

"submodule": "dd-drag",

54355

"namespace": "DD"

54356

},

54357

{

54358

"file": "dd/js/drag.js",

54359

"line": 695,

54360

"itemtype": "property",

54361

"name": "region",

54362

"description": "A region object associated with this drag, used for checking regions while dragging.",

54363

"type": "Object",

54364

"class": "DD.Drag",

54365

"module": "dd",

54366

"submodule": "dd-drag",

54367

"namespace": "DD"

54368

},

54369

{

54370

"file": "dd/js/drag.js",

54371

"line": 701,

54372

"access": "private",

54373

"tagname": "",

54374

"itemtype": "method",

54375

"name": "_handleMouseUp",

54376

"description": "Handler for the mouseup DOM event",

54377

"params": [

54378

{

54379

"name": "ev",

54380

"description": "The Event",

54381

"type": "EventFacade"

54382

}

54383

],

54384

"class": "DD.Drag",

54385

"module": "dd",

54386

"submodule": "dd-drag",

54387

"namespace": "DD"

54388

},

54389

{

54390

"file": "dd/js/drag.js",

54391

"line": 714,

54392

"access": "private",

54393

"tagname": "",

54394

"itemtype": "method",

54395

"name": "_fixDragStart",

54396

"description": "The function we use as the ondragstart handler when we start a drag in Internet Explorer. This keeps IE from blowing up on images as drag handles.",

54397

"params": [

54398

{

54399

"name": "e",

54400

"description": "The Event",

54401

"type": "Event"

54402

}

54403

],

54404

"class": "DD.Drag",

54405

"module": "dd",

54406

"submodule": "dd-drag",

54407

"namespace": "DD"

54408

},

54409

{

54410

"file": "dd/js/drag.js",

54411

"line": 723,

54412

"access": "private",

54413

"tagname": "",

54414

"itemtype": "method",

54415

"name": "_ieSelectFix",

54416

"description": "The function we use as the onselectstart handler when we start a drag in Internet Explorer",

54417

"class": "DD.Drag",

54418

"module": "dd",

54419

"submodule": "dd-drag",

54420

"namespace": "DD"

54421

},

54422

{

54423

"file": "dd/js/drag.js",

54424

"line": 731,

54425

"access": "private",

54426

"tagname": "",

54427

"itemtype": "property",

54428

"name": "_ieSelectBack",

54429

"description": "We will hold a copy of the current \"onselectstart\" method on this property, and reset it after we are done using it.",

54430

"class": "DD.Drag",

54431

"module": "dd",

54432

"submodule": "dd-drag",

54433

"namespace": "DD"

54434

},

54435

{

54436

"file": "dd/js/drag.js",

54437

"line": 737,

54438

"access": "private",

54439

"tagname": "",

54440

"itemtype": "method",

54441

"name": "_fixIEMouseDown",

54442

"description": "This method copies the onselectstart listner on the document to the _ieSelectFix property",

54443

"class": "DD.Drag",

54444

"module": "dd",

54445

"submodule": "dd-drag",

54446

"namespace": "DD"

54447

},

54448

{

54449

"file": "dd/js/drag.js",

54450

"line": 748,

54451

"access": "private",

54452

"tagname": "",

54453

"itemtype": "method",

54454

"name": "_fixIEMouseUp",

54455

"description": "This method copies the _ieSelectFix property back to the onselectstart listner on the document.",

54456

"class": "DD.Drag",

54457

"module": "dd",

54458

"submodule": "dd-drag",

54459

"namespace": "DD"

54460

},

54461

{

54462

"file": "dd/js/drag.js",

54463

"line": 758,

54464

"access": "private",

54465

"tagname": "",

54466

"itemtype": "method",

54467

"name": "_handleMouseDownEvent",

54468

"description": "Handler for the mousedown DOM event",

54469

"params": [

54470

{

54471

"name": "ev",

54472

"description": "The Event",

54473

"type": "EventFacade"

54474

}

54475

],

54476

"class": "DD.Drag",

54477

"module": "dd",

54478

"submodule": "dd-drag",

54479

"namespace": "DD"

54480

},

54481

{

54482

"file": "dd/js/drag.js",

54483

"line": 767,

54484

"access": "private",

54485

"tagname": "",

54486

"itemtype": "method",

54487

"name": "_defMouseDownFn",

54488

"description": "Handler for the mousedown DOM event",

54489

"params": [

54490

{

54491

"name": "e",

54492

"description": "The Event",

54493

"type": "EventFacade"

54494

}

54495

],

54496

"class": "DD.Drag",

54497

"module": "dd",

54498

"submodule": "dd-drag",

54499

"namespace": "DD"

54500

},

54501

{

54502

"file": "dd/js/drag.js",

54503

"line": 800,

54504

"itemtype": "method",

54505

"name": "validClick",

54506

"description": "Method first checks to see if we have handles, if so it validates the click against the handle. Then if it finds a valid handle, it checks it against the invalid handles list. Returns true if a good handle was used, false otherwise.",

54507

"params": [

54508

{

54509

"name": "ev",

54510

"description": "The Event",

54511

"type": "EventFacade"

54512

}

54513

],

54514

"return": {

54515

"description": "",

54516

"type": "Boolean"

54517

},

54518

"class": "DD.Drag",

54519

"module": "dd",

54520

"submodule": "dd-drag",

54521

"namespace": "DD"

54522

},

54523

{

54524

"file": "dd/js/drag.js",

54525

"line": 869,

54526

"access": "private",

54527

"tagname": "",

54528

"itemtype": "method",

54529

"name": "_setStartPosition",

54530

"description": "Sets the current position of the Element and calculates the offset",

54531

"params": [

54532

{

54533

"name": "xy",

54534

"description": "The XY coords to set the position to.",

54535

"type": "Array"

54536

}

54537

],

54538

"class": "DD.Drag",

54539

"module": "dd",

54540

"submodule": "dd-drag",

54541

"namespace": "DD"

54542

},

54543

{

54544

"file": "dd/js/drag.js",

54545

"line": 886,

54546

"access": "private",

54547

"tagname": "",

54548

"itemtype": "method",

54549

"name": "_timeoutCheck",

54550

"description": "The method passed to setTimeout to determine if the clickTimeThreshold was met.",

54551

"class": "DD.Drag",

54552

"module": "dd",

54553

"submodule": "dd-drag",

54554

"namespace": "DD"

54555

},

54556

{

54557

"file": "dd/js/drag.js",

54558

"line": 898,

54559

"itemtype": "method",

54560

"name": "removeHandle",

54561

"description": "Remove a Selector added by addHandle",

54562

"params": [

54563

{

54564

"name": "str",

54565

"description": "The selector for the handle to be removed.",

54566

"type": "String"

54567

}

54568

],

54569

"return": {

54570

"description": "",

54571

"type": "Self"

54572

},

54573

"chainable": 1,

54574

"class": "DD.Drag",

54575

"module": "dd",

54576

"submodule": "dd-drag",

54577

"namespace": "DD"

54578

},

54579

{

54580

"file": "dd/js/drag.js",

54581

"line": 916,

54582

"itemtype": "method",

54583

"name": "addHandle",

54584

"description": "Add a handle to a drag element. Drag only initiates when a mousedown happens on this element.",

54585

"params": [

54586

{

54587

"name": "str",

54588

"description": "The selector to test for a valid handle. Must be a child of the element.",

54589

"type": "String"

54590

}

54591

],

54592

"return": {

54593

"description": "",

54594

"type": "Self"

54595

},

54596

"chainable": 1,

54597

"class": "DD.Drag",

54598

"module": "dd",

54599

"submodule": "dd-drag",

54600

"namespace": "DD"

54601

},

54602

{

54603

"file": "dd/js/drag.js",

54604

"line": 935,

54605

"itemtype": "method",

54606

"name": "removeInvalid",

54607

"description": "Remove an invalid handle added by addInvalid",

54608

"params": [

54609

{

54610

"name": "str",

54611

"description": "The invalid handle to remove from the internal list.",

54612

"type": "String"

54613

}

54614

],

54615

"return": {

54616

"description": "",

54617

"type": "Self"

54618

},

54619

"chainable": 1,

54620

"class": "DD.Drag",

54621

"module": "dd",

54622

"submodule": "dd-drag",

54623

"namespace": "DD"

54624

},

54625

{

54626

"file": "dd/js/drag.js",

54627

"line": 950,

54628

"itemtype": "method",

54629

"name": "addInvalid",

54630

"description": "Add a selector string to test the handle against. If the test passes the drag operation will not continue.",

54631

"params": [

54632

{

54633

"name": "str",

54634

"description": "The selector to test against to determine if this is an invalid drag handle.",

54635

"type": "String"

54636

}

54637

],

54638

"return": {

54639

"description": "",

54640

"type": "Self"

54641

},

54642

"chainable": 1,

54643

"class": "DD.Drag",

54644

"module": "dd",

54645

"submodule": "dd-drag",

54646

"namespace": "DD"

54647

},

54648

{

54649

"file": "dd/js/drag.js",

54650

"line": 964,

54651

"access": "private",

54652

"tagname": "",

54653

"itemtype": "method",

54654

"name": "initializer",

54655

"description": "Internal init handler",

54656

"class": "DD.Drag",

54657

"module": "dd",

54658

"submodule": "dd-drag",

54659

"namespace": "DD"

54660

},

54661

{

54662

"file": "dd/js/drag.js",

54663

"line": 995,

54664

"access": "private",

54665

"tagname": "",

54666

"itemtype": "method",

54667

"name": "_prep",

54668

"description": "Attach event listners and add classname",

54669

"class": "DD.Drag",

54670

"module": "dd",

54671

"submodule": "dd-drag",

54672

"namespace": "DD"

54673

},

54674

{

54675

"file": "dd/js/drag.js",

54676

"line": 1008,

54677

"access": "private",

54678

"tagname": "",

54679

"itemtype": "method",

54680

"name": "_unprep",

54681

"description": "Detach event listeners and remove classname",

54682

"class": "DD.Drag",

54683

"module": "dd",

54684

"submodule": "dd-drag",

54685

"namespace": "DD"

54686

},

54687

{

54688

"file": "dd/js/drag.js",

54689

"line": 1027,

54690

"itemtype": "method",

54691

"name": "start",

54692

"description": "Starts the drag operation",

54693

"return": {

54694

"description": "",

54695

"type": "Self"

54696

},

54697

"chainable": 1,

54698

"class": "DD.Drag",

54699

"module": "dd",

54700

"submodule": "dd-drag",

54701

"namespace": "DD"

54702

},

54703

{

54704

"file": "dd/js/drag.js",

54705

"line": 1069,

54706

"itemtype": "method",

54707

"name": "end",

54708

"description": "Ends the drag operation",

54709

"return": {

54710

"description": "",

54711

"type": "Self"

54712

},

54713

"chainable": 1,

54714

"class": "DD.Drag",

54715

"module": "dd",

54716

"submodule": "dd-drag",

54717

"namespace": "DD"

54718

},

54719

{

54720

"file": "dd/js/drag.js",

54721

"line": 1096,

54722

"access": "private",

54723

"tagname": "",

54724

"itemtype": "method",

54725

"name": "_defEndFn",

54726

"description": "Handler for fixing the selection in IE",

54727

"class": "DD.Drag",

54728

"module": "dd",

54729

"submodule": "dd-drag",

54730

"namespace": "DD"

54731

},

54732

{

54733

"file": "dd/js/drag.js",

54734

"line": 1105,

54735

"access": "private",

54736

"tagname": "",

54737

"itemtype": "method",

54738

"name": "_prevEndFn",

54739

"description": "Handler for preventing the drag:end event. It will reset the node back to it's start position",

54740

"class": "DD.Drag",

54741

"module": "dd",

54742

"submodule": "dd-drag",

54743

"namespace": "DD"

54744

},

54745

{

54746

"file": "dd/js/drag.js",

54747

"line": 1117,

54748

"access": "private",

54749

"tagname": "",

54750

"itemtype": "method",

54751

"name": "_align",

54752

"description": "Calculates the offsets and set's the XY that the element will move to.",

54753

"params": [

54754

{

54755

"name": "xy",

54756

"description": "The xy coords to align with.",

54757

"type": "Array"

54758

}

54759

],

54760

"class": "DD.Drag",

54761

"module": "dd",

54762

"submodule": "dd-drag",

54763

"namespace": "DD"

54764

},

54765

{

54766

"file": "dd/js/drag.js",

54767

"line": 1126,

54768

"access": "private",

54769

"tagname": "",

54770

"itemtype": "method",

54771

"name": "_defAlignFn",

54772

"description": "Calculates the offsets and set's the XY that the element will move to.",

54773

"params": [

54774

{

54775

"name": "e",

54776

"description": "The drag:align event.",

54777

"type": "EventFacade"

54778

}

54779

],

54780

"class": "DD.Drag",

54781

"module": "dd",

54782

"submodule": "dd-drag",

54783

"namespace": "DD"

54784

},

54785

{

54786

"file": "dd/js/drag.js",

54787

"line": 1135,

54788

"access": "private",

54789

"tagname": "",

54790

"itemtype": "method",

54791

"name": "_alignNode",

54792

"description": "This method performs the alignment before the element move.",

54793

"params": [

54794

{

54795

"name": "eXY",

54796

"description": "The XY to move the element to, usually comes from the mousemove DOM event.",

54797

"type": "Array"

54798

}

54799

],

54800

"class": "DD.Drag",

54801

"module": "dd",

54802

"submodule": "dd-drag",

54803

"namespace": "DD"

54804

},

54805

{

54806

"file": "dd/js/drag.js",

54807

"line": 1145,

54808

"access": "private",

54809

"tagname": "",

54810

"itemtype": "method",

54811

"name": "_moveNode",

54812

"description": "This method performs the actual element move.",

54813

"class": "DD.Drag",

54814

"module": "dd",

54815

"submodule": "dd-drag",

54816

"namespace": "DD"

54817

},

54818

{

54819

"file": "dd/js/drag.js",

54820

"line": 1187,

54821

"access": "private",

54822

"tagname": "",

54823

"itemtype": "method",

54824

"name": "_defDragFn",

54825

"description": "Default function for drag:drag. Fired from _moveNode.",

54826

"params": [

54827

{

54828

"name": "ev",

54829

"description": "The drag:drag event",

54830

"type": "EventFacade"

54831

}

54832

],

54833

"class": "DD.Drag",

54834

"module": "dd",

54835

"submodule": "dd-drag",

54836

"namespace": "DD"

54837

},

54838

{

54839

"file": "dd/js/drag.js",

54840

"line": 1203,

54841

"access": "private",

54842

"tagname": "",

54843

"itemtype": "method",

54844

"name": "_move",

54845

"description": "Fired from DragDropMgr (DDM) on mousemove.",

54846

"params": [

54847

{

54848

"name": "ev",

54849

"description": "The mousemove DOM event",

54850

"type": "EventFacade"

54851

}

54852

],

54853

"class": "DD.Drag",

54854

"module": "dd",

54855

"submodule": "dd-drag",

54856

"namespace": "DD"

54857

},

54858

{

54859

"file": "dd/js/drag.js",

54860

"line": 1230,

54861

"itemtype": "method",

54862

"name": "stopDrag",

54863

"description": "Method will forcefully stop a drag operation. For example calling this from inside an ESC keypress handler will stop this drag.",

54864

"return": {

54865

"description": "",

54866

"type": "Self"

54867

},

54868

"chainable": 1,

54869

"class": "DD.Drag",

54870

"module": "dd",

54871

"submodule": "dd-drag",

54872

"namespace": "DD"

54873

},

54874

{

54875

"file": "dd/js/drag.js",

54876

"line": 1242,

54877

"access": "private",

54878

"tagname": "",

54879

"itemtype": "method",

54880

"name": "destructor",

54881

"description": "Lifecycle destructor, unreg the drag from the DDM and remove listeners",

54882

"class": "DD.Drag",

54883

"module": "dd",

54884

"submodule": "dd-drag",

54885

"namespace": "DD"

54886

},

54887

{

54888

"file": "dd/js/drop.js",

54889

"line": 19,

54890

"itemtype": "event",

54891

"name": "drop:over",

54892

"description": "Fires when a drag element is over this target.",

54893

"params": [

54894

{

54895

"name": "event",

54896

"description": "An Event Facade object with the following specific property added:\n<dl>\n<dt>drop</dt><dd>The drop object at the time of the event.</dd>\n<dt>drag</dt><dd>The drag object at the time of the event.</dd>\n</dl>",

54897

"type": "EventFacade"

54898

}

54899

],

54900

"bubbles": "DDM",

54901

"type": "{CustomEvent}",

54902

"class": "DD.Drop",

54903

"module": "dd",

54904

"submodule": "dd-drop",

54905

"namespace": "DD"

54906

},

54907

{

54908

"file": "dd/js/drop.js",

54909

"line": 31,

54910

"itemtype": "event",

54911

"name": "drop:enter",

54912

"description": "Fires when a drag element enters this target.",

54913

"params": [

54914

{

54915

"name": "event",

54916

"description": "An Event Facade object with the following specific property added:\n<dl>\n<dt>drop</dt><dd>The drop object at the time of the event.</dd>\n<dt>drag</dt><dd>The drag object at the time of the event.</dd>\n</dl>",

54917

"type": "EventFacade"

54918

}

54919

],

54920

"bubbles": "DDM",

54921

"type": "{CustomEvent}",

54922

"class": "DD.Drop",

54923

"module": "dd",

54924

"submodule": "dd-drop",

54925

"namespace": "DD"

54926

},

54927

{

54928

"file": "dd/js/drop.js",

54929

"line": 43,

54930

"itemtype": "event",

54931

"name": "drop:exit",

54932

"description": "Fires when a drag element exits this target.",

54933

"params": [

54934

{

54935

"name": "event",

54936

"description": "An Event Facade object",

54937

"type": "EventFacade"

54938

}

54939

],

54940

"bubbles": "DDM",

54941

"type": "{CustomEvent}",

54942

"class": "DD.Drop",

54943

"module": "dd",

54944

"submodule": "dd-drop",

54945

"namespace": "DD"

54946

},

54947

{

54948

"file": "dd/js/drop.js",

54949

"line": 52,

54950

"itemtype": "event",

54951

"name": "drop:hit",

54952

"description": "Fires when a draggable node is dropped on this Drop Target. (Fired from dd-ddm-drop)",

54953

"params": [

54954

{

54955

"name": "event",

54956

"description": "An Event Facade object with the following specific property added:\n<dl>\n<dt>drop</dt><dd>The best guess on what was dropped on.</dd>\n<dt>drag</dt><dd>The drag object at the time of the event.</dd>\n<dt>others</dt><dd>An array of all the other drop targets that was dropped on.</dd>\n</dl>",

54957

"type": "EventFacade"

54958

}

54959

],

54960

"bubbles": "DDM",

54961

"type": "{CustomEvent}",

54962

"class": "DD.Drop",

54963

"module": "dd",

54964

"submodule": "dd-drop",

54965

"namespace": "DD"

54966

},

54967

{

54968

"file": "dd/js/drop.js",

54969

"line": 89,

54970

"itemtype": "attribute",

54971

"name": "node",

54972

"description": "Y.Node instanace to use as the element to make a Drop Target",

54973

"type": "Node",

54974

"class": "DD.Drop",

54975

"module": "dd",

54976

"submodule": "dd-drop",

54977

"namespace": "DD"

54978

},

54979

{

54980

"file": "dd/js/drop.js",

54981

"line": 103,

54982

"itemtype": "attribute",

54983

"name": "groups",

54984

"description": "Array of groups to add this drop into.",

54985

"type": "Array",

54986

"class": "DD.Drop",

54987

"module": "dd",

54988

"submodule": "dd-drop",

54989

"namespace": "DD"

54990

},

54991

{

54992

"file": "dd/js/drop.js",

54993

"line": 128,

54994

"itemtype": "attribute",

54995

"name": "padding",

54996

"description": "CSS style padding to make the Drop Target bigger than the node.",

54997

"type": "String",

54998

"class": "DD.Drop",

54999

"module": "dd",

55000

"submodule": "dd-drop",

55001

"namespace": "DD"

55002

},

55003

{

55004

"file": "dd/js/drop.js",

55005

"line": 139,

55006

"itemtype": "attribute",

55007

"name": "lock",

55008

"description": "Set to lock this drop element.",

55009

"type": "Boolean",

55010

"class": "DD.Drop",

55011

"module": "dd",

55012

"submodule": "dd-drop",

55013

"namespace": "DD"

55014

},

55015

{

55016

"file": "dd/js/drop.js",

55017

"line": 155,

55018

"deprecated": true,

55019

"itemtype": "attribute",

55020

"name": "bubbles",

55021

"description": "Controls the default bubble parent for this Drop instance. Default: Y.DD.DDM. Set to false to disable bubbling. Use bubbleTargets in config.",

55022

"type": "Object",

55023

"class": "DD.Drop",

55024

"module": "dd",

55025

"submodule": "dd-drop",

55026

"namespace": "DD"

55027

},

55028

{

55029

"file": "dd/js/drop.js",

55030

"line": 168,

55031

"deprecated": true,

55032

"itemtype": "attribute",

55033

"name": "useShim",

55034

"description": "Use the Drop shim. Default: true",

55035

"type": "Boolean",

55036

"class": "DD.Drop",

55037

"module": "dd",

55038

"submodule": "dd-drop",

55039

"namespace": "DD"

55040

},

55041

{

55042

"file": "dd/js/drop.js",

55043

"line": 184,

55044

"access": "private",

55045

"tagname": "",

55046

"itemtype": "property",

55047

"name": "_bubbleTargets",

55048

"description": "The default bubbleTarget for this object. Default: Y.DD.DDM",

55049

"class": "DD.Drop",

55050

"module": "dd",

55051

"submodule": "dd-drop",

55052

"namespace": "DD"

55053

},

55054

{

55055

"file": "dd/js/drop.js",

55056

"line": 190,

55057

"itemtype": "method",

55058

"name": "addToGroup",

55059

"description": "Add this Drop instance to a group, this should be used for on-the-fly group additions.",

55060

"params": [

55061

{

55062

"name": "g",

55063

"description": "The group to add this Drop Instance to.",

55064

"type": "String"

55065

}

55066

],

55067

"return": {

55068

"description": "",

55069

"type": "Self"

55070

},

55071

"chainable": 1,

55072

"class": "DD.Drop",

55073

"module": "dd",

55074

"submodule": "dd-drop",

55075

"namespace": "DD"

55076

},

55077

{

55078

"file": "dd/js/drop.js",

55079

"line": 201,

55080

"itemtype": "method",

55081

"name": "removeFromGroup",

55082

"description": "Remove this Drop instance from a group, this should be used for on-the-fly group removals.",

55083

"params": [

55084

{

55085

"name": "g",

55086

"description": "The group to remove this Drop Instance from.",

55087

"type": "String"

55088

}

55089

],

55090

"return": {

55091

"description": "",

55092

"type": "Self"

55093

},

55094

"chainable": 1,

55095

"class": "DD.Drop",

55096

"module": "dd",

55097

"submodule": "dd-drop",

55098

"namespace": "DD"

55099

},

55100

{

55101

"file": "dd/js/drop.js",

55102

"line": 212,

55103

"access": "private",

55104

"tagname": "",

55105

"itemtype": "method",

55106

"name": "_createEvents",

55107

"description": "This method creates all the events for this Event Target and publishes them so we get Event Bubbling.",

55108

"class": "DD.Drop",

55109

"module": "dd",

55110

"submodule": "dd-drop",

55111

"namespace": "DD"

55112

},

55113

{

55114

"file": "dd/js/drop.js",

55115

"line": 237,

55116

"access": "private",

55117

"tagname": "",

55118

"itemtype": "property",

55119

"name": "_valid",

55120

"description": "Flag for determining if the target is valid in this operation.",

55121

"type": "Boolean",

55122

"class": "DD.Drop",

55123

"module": "dd",

55124

"submodule": "dd-drop",

55125

"namespace": "DD"

55126

},

55127

{

55128

"file": "dd/js/drop.js",

55129

"line": 244,

55130

"access": "private",

55131

"tagname": "",

55132

"itemtype": "property",

55133

"name": "_groups",

55134

"description": "The groups this target belongs to.",

55135

"type": "Array",

55136

"class": "DD.Drop",

55137

"module": "dd",

55138

"submodule": "dd-drop",

55139

"namespace": "DD"

55140

},

55141

{

55142

"file": "dd/js/drop.js",

55143

"line": 251,

55144

"itemtype": "property",

55145

"name": "shim",

55146

"description": "Node reference to the targets shim",

55147

"type": "{Object}",

55148

"class": "DD.Drop",

55149

"module": "dd",

55150

"submodule": "dd-drop",

55151

"namespace": "DD"

55152

},

55153

{

55154

"file": "dd/js/drop.js",

55155

"line": 257,

55156

"itemtype": "property",

55157

"name": "region",

55158

"description": "A region object associated with this target, used for checking regions while dragging.",

55159

"type": "Object",

55160

"class": "DD.Drop",

55161

"module": "dd",

55162

"submodule": "dd-drop",

55163

"namespace": "DD"

55164

},

55165

{

55166

"file": "dd/js/drop.js",

55167

"line": 263,

55168

"itemtype": "property",

55169

"name": "overTarget",

55170

"description": "This flag is tripped when a drag element is over this target.",

55171

"type": "Boolean",

55172

"class": "DD.Drop",

55173

"module": "dd",

55174

"submodule": "dd-drop",

55175

"namespace": "DD"

55176

},

55177

{

55178

"file": "dd/js/drop.js",

55179

"line": 269,

55180

"itemtype": "method",

55181

"name": "inGroup",

55182

"description": "Check if this target is in one of the supplied groups.",

55183

"params": [

55184

{

55185

"name": "groups",

55186

"description": "The groups to check against",

55187

"type": "Array"

55188

}

55189

],

55190

"return": {

55191

"description": "Boolean"

55192

},

55193

"class": "DD.Drop",

55194

"module": "dd",

55195

"submodule": "dd-drop",

55196

"namespace": "DD"

55197

},

55198

{

55199

"file": "dd/js/drop.js",

55200

"line": 286,

55201

"access": "private",

55202

"tagname": "",

55203

"itemtype": "method",

55204

"name": "initializer",

55205

"description": "Private lifecycle method",

55206

"class": "DD.Drop",

55207

"module": "dd",

55208

"submodule": "dd-drop",

55209

"namespace": "DD"

55210

},

55211

{

55212

"file": "dd/js/drop.js",

55213

"line": 303,

55214

"access": "private",

55215

"tagname": "",

55216

"itemtype": "method",

55217

"name": "destructor",

55218

"description": "Lifecycle destructor, unreg the drag from the DDM and remove listeners",

55219

"class": "DD.Drop",

55220

"module": "dd",

55221

"submodule": "dd-drop",

55222

"namespace": "DD"

55223

},

55224

{

55225

"file": "dd/js/drop.js",

55226

"line": 318,

55227

"access": "private",

55228

"tagname": "",

55229

"itemtype": "method",

55230

"name": "_deactivateShim",

55231

"description": "Removes classes from the target, resets some flags and sets the shims deactive position [-999, -999]",

55232

"class": "DD.Drop",

55233

"module": "dd",

55234

"submodule": "dd-drop",

55235

"namespace": "DD"

55236

},

55237

{

55238

"file": "dd/js/drop.js",

55239

"line": 340,

55240

"access": "private",

55241

"tagname": "",

55242

"itemtype": "method",

55243

"name": "_activateShim",

55244

"description": "Activates the shim and adds some interaction CSS classes",

55245

"class": "DD.Drop",

55246

"module": "dd",

55247

"submodule": "dd-drop",

55248

"namespace": "DD"

55249

},

55250

{

55251

"file": "dd/js/drop.js",

55252

"line": 373,

55253

"itemtype": "method",

55254

"name": "sizeShim",

55255

"description": "Positions and sizes the shim with the raw data from the node, this can be used to programatically adjust the Targets shim for Animation..",

55256

"class": "DD.Drop",

55257

"module": "dd",

55258

"submodule": "dd-drop",

55259

"namespace": "DD"

55260

},

55261

{

55262

"file": "dd/js/drop.js",

55263

"line": 441,

55264

"access": "private",

55265

"tagname": "",

55266

"itemtype": "method",

55267

"name": "_createShim",

55268

"description": "Creates the Target shim and adds it to the DDM's playground..",

55269

"class": "DD.Drop",

55270

"module": "dd",

55271

"submodule": "dd-drop",

55272

"namespace": "DD"

55273

},

55274

{

55275

"file": "dd/js/drop.js",

55276

"line": 481,

55277

"access": "private",

55278

"tagname": "",

55279

"itemtype": "method",

55280

"name": "_handleOverTarget",

55281

"description": "This handles the over target call made from this object or from the DDM",

55282

"class": "DD.Drop",

55283

"module": "dd",

55284

"submodule": "dd-drop",

55285

"namespace": "DD"

55286

},

55287

{

55288

"file": "dd/js/drop.js",

55289

"line": 509,

55290

"access": "private",

55291

"tagname": "",

55292

"itemtype": "method",

55293

"name": "_handleOverEvent",

55294

"description": "Handles the mouseover DOM event on the Target Shim",

55295

"class": "DD.Drop",

55296

"module": "dd",

55297

"submodule": "dd-drop",

55298

"namespace": "DD"

55299

},

55300

{

55301

"file": "dd/js/drop.js",

55302

"line": 518,

55303

"access": "private",

55304

"tagname": "",

55305

"itemtype": "method",

55306

"name": "_handleOutEvent",

55307

"description": "Handles the mouseout DOM event on the Target Shim",

55308

"class": "DD.Drop",

55309

"module": "dd",

55310

"submodule": "dd-drop",

55311

"namespace": "DD"

55312

},

55313

{

55314

"file": "dd/js/drop.js",

55315

"line": 527,

55316

"access": "private",

55317

"tagname": "",

55318

"itemtype": "method",

55319

"name": "_handleOut",

55320

"description": "Handles out of target calls/checks",

55321

"class": "DD.Drop",

55322

"module": "dd",

55323

"submodule": "dd-drop",

55324

"namespace": "DD"

55325

},

55326

{

55327

"file": "dd/js/proxy.js",

55328

"line": 24,

55329

"itemtype": "property",

55330

"name": "NS",

55331

"default": "con",

55332

"readonly": "",

55333

"access": "protected",

55334

"tagname": "",

55335

"static": 1,

55336

"description": "The Proxy instance will be placed on the Drag instance under the proxy namespace.",

55337

"type": "{String}",

55338

"class": "Plugin.DDProxy",

55339

"module": "dd",

55340

"submodule": "dd-proxy",

55341

"namespace": "Plugin"

55342

},

55343

{

55344

"file": "dd/js/proxy.js",

55345

"line": 38,

55346

"itemtype": "attribute",

55347

"name": "moveOnEnd",

55348

"description": "Move the original node at the end of the drag. Default: true",

55349

"type": "Boolean",

55350

"class": "Plugin.DDProxy",

55351

"module": "dd",

55352

"submodule": "dd-proxy",

55353

"namespace": "Plugin"

55354

},

55355

{

55356

"file": "dd/js/proxy.js",

55357

"line": 46,

55358

"itemtype": "attribute",

55359

"name": "hideOnEnd",

55360

"description": "Hide the drag node at the end of the drag. Default: true",

55361

"type": "Boolean",

55362

"class": "Plugin.DDProxy",

55363

"module": "dd",

55364

"submodule": "dd-proxy",

55365

"namespace": "Plugin"

55366

},

55367

{

55368

"file": "dd/js/proxy.js",

55369

"line": 54,

55370

"itemtype": "attribute",

55371

"name": "resizeFrame",

55372

"description": "Make the Proxy node assume the size of the original node. Default: true",

55373

"type": "Boolean",

55374

"class": "Plugin.DDProxy",

55375

"module": "dd",

55376

"submodule": "dd-proxy",

55377

"namespace": "Plugin"

55378

},

55379

{

55380

"file": "dd/js/proxy.js",

55381

"line": 62,

55382

"itemtype": "attribute",

55383

"name": "positionProxy",

55384

"description": "Make the Proxy node appear in the same place as the original node. Default: true",

55385

"type": "Boolean",

55386

"class": "Plugin.DDProxy",

55387

"module": "dd",

55388

"submodule": "dd-proxy",

55389

"namespace": "Plugin"

55390

},

55391

{

55392

"file": "dd/js/proxy.js",

55393

"line": 70,

55394

"itemtype": "attribute",

55395

"name": "borderStyle",

55396

"description": "The default border style for the border of the proxy. Default: 1px solid #808080",

55397

"type": "Boolean",

55398

"class": "Plugin.DDProxy",

55399

"module": "dd",

55400

"submodule": "dd-proxy",

55401

"namespace": "Plugin"

55402

},

55403

{

55404

"file": "dd/js/proxy.js",

55405

"line": 78,

55406

"itemtype": "attribute",

55407

"name": "cloneNode",

55408

"description": "Should the node be cloned into the proxy for you. Default: false",

55409

"type": "Boolean",

55410

"class": "Plugin.DDProxy",

55411

"module": "dd",

55412

"submodule": "dd-proxy",

55413

"namespace": "Plugin"

55414

},

55415

{

55416

"file": "dd/js/proxy.js",

55417

"line": 89,

55418

"access": "private",

55419

"tagname": "",

55420

"itemtype": "property",

55421

"name": "_hands",

55422

"description": "Holds the event handles for setting the proxy",

55423

"class": "Plugin.DDProxy",

55424

"module": "dd",

55425

"submodule": "dd-proxy",

55426

"namespace": "Plugin"

55427

},

55428

{

55429

"file": "dd/js/proxy.js",

55430

"line": 95,

55431

"access": "private",

55432

"tagname": "",

55433

"itemtype": "method",

55434

"name": "_init",

55435

"description": "Handler for the proxy config attribute",

55436

"class": "Plugin.DDProxy",

55437

"module": "dd",

55438

"submodule": "dd-proxy",

55439

"namespace": "Plugin"

55440

},

55441

{

55442

"file": "dd/js/proxy.js",

55443

"line": 169,

55444

"access": "private",

55445

"tagname": "",

55446

"itemtype": "method",

55447

"name": "_createFrame",

55448

"description": "Create the proxy element if it doesn't already exist and set the DD.DDM._proxy value",

55449

"class": "DD.DDM",

55450

"module": "dd",

55451

"submodule": "dd-proxy",

55452

"namespace": "DD"

55453

},

55454

{

55455

"file": "dd/js/proxy.js",

55456

"line": 197,

55457

"access": "private",

55458

"tagname": "",

55459

"itemtype": "method",

55460

"name": "_setFrame",

55461

"description": "If resizeProxy is set to true (default) it will resize the proxy element to match the size of the Drag Element.\nIf positionProxy is set to true (default) it will position the proxy element in the same location as the Drag Element.",

55462

"class": "DD.DDM",

55463

"module": "dd",

55464

"submodule": "dd-proxy",

55465

"namespace": "DD"

55466

},

55467

{

55468

"file": "dd/js/scroll.js",

55469

"line": 33,

55470

"itemtype": "attribute",

55471

"name": "parentScroll",

55472

"description": "Internal config option to hold the node that we are scrolling. Should not be set by the developer.",

55473

"type": "Node",

55474

"class": "DD.Scroll",

55475

"module": "dd",

55476

"submodule": "dd-scroll",

55477

"namespace": "DD"

55478

},

55479

{

55480

"file": "dd/js/scroll.js",

55481

"line": 47,

55482

"itemtype": "attribute",

55483

"name": "buffer",

55484

"description": "The number of pixels from the edge of the screen to turn on scrolling. Default: 30",

55485

"type": "Number",

55486

"class": "DD.Scroll",

55487

"module": "dd",

55488

"submodule": "dd-scroll",

55489

"namespace": "DD"

55490

},

55491

{

55492

"file": "dd/js/scroll.js",

55493

"line": 56,

55494

"itemtype": "attribute",

55495

"name": "scrollDelay",

55496

"description": "The number of milliseconds delay to pass to the auto scroller. Default: 235",

55497

"type": "Number",

55498

"class": "DD.Scroll",

55499

"module": "dd",

55500

"submodule": "dd-scroll",

55501

"namespace": "DD"

55502

},

55503

{

55504

"file": "dd/js/scroll.js",

55505

"line": 65,

55506

"itemtype": "attribute",

55507

"name": "host",

55508

"description": "The host we are plugged into.",

55509

"type": "Object",

55510

"class": "DD.Scroll",

55511

"module": "dd",

55512

"submodule": "dd-scroll",

55513

"namespace": "DD"

55514

},

55515

{

55516

"file": "dd/js/scroll.js",

55517

"line": 73,

55518

"itemtype": "attribute",

55519

"name": "windowScroll",

55520

"description": "Turn on window scroll support, default: false",

55521

"type": "Boolean",

55522

"class": "DD.Scroll",

55523

"module": "dd",

55524

"submodule": "dd-scroll",

55525

"namespace": "DD"

55526

},

55527

{

55528

"file": "dd/js/scroll.js",

55529

"line": 82,

55530

"itemtype": "attribute",

55531

"name": "vertical",

55532

"description": "Allow vertical scrolling, default: true.",

55533

"type": "Boolean",

55534

"class": "DD.Scroll",

55535

"module": "dd",

55536

"submodule": "dd-scroll",

55537

"namespace": "DD"

55538

},

55539

{

55540

"file": "dd/js/scroll.js",

55541

"line": 91,

55542

"itemtype": "attribute",

55543

"name": "horizontal",

55544

"description": "Allow horizontal scrolling, default: true.",

55545

"type": "Boolean",

55546

"class": "DD.Scroll",

55547

"module": "dd",

55548

"submodule": "dd-scroll",

55549

"namespace": "DD"

55550

},

55551

{

55552

"file": "dd/js/scroll.js",

55553

"line": 103,

55554

"access": "private",

55555

"tagname": "",

55556

"itemtype": "property",

55557

"name": "_scrolling",

55558

"description": "Tells if we are actively scrolling or not.",

55559

"type": "Boolean",

55560

"class": "DD.Scroll",

55561

"module": "dd",

55562

"submodule": "dd-scroll",

55563

"namespace": "DD"

55564

},

55565

{

55566

"file": "dd/js/scroll.js",

55567

"line": 110,

55568

"access": "private",

55569

"tagname": "",

55570

"itemtype": "property",

55571

"name": "_vpRegionCache",

55572

"description": "Cache of the Viewport dims.",

55573

"type": "Object",

55574

"class": "DD.Scroll",

55575

"module": "dd",

55576

"submodule": "dd-scroll",

55577

"namespace": "DD"

55578

},

55579

{

55580

"file": "dd/js/scroll.js",

55581

"line": 117,

55582

"access": "private",

55583

"tagname": "",

55584

"itemtype": "property",

55585

"name": "_dimCache",

55586

"description": "Cache of the dragNode dims.",

55587

"type": "Object",

55588

"class": "DD.Scroll",

55589

"module": "dd",

55590

"submodule": "dd-scroll",

55591

"namespace": "DD"

55592

},

55593

{

55594

"file": "dd/js/scroll.js",

55595

"line": 124,

55596

"access": "private",

55597

"tagname": "",

55598

"itemtype": "property",

55599

"name": "_scrollTimer",

55600

"description": "Holder for the Timer object returned from Y.later.",

55601

"type": "{Y.later}",

55602

"class": "DD.Scroll",

55603

"module": "dd",

55604

"submodule": "dd-scroll",

55605

"namespace": "DD"

55606

},

55607

{

55608

"file": "dd/js/scroll.js",

55609

"line": 131,

55610

"access": "private",

55611

"tagname": "",

55612

"itemtype": "method",

55613

"name": "_getVPRegion",

55614

"description": "Sets the _vpRegionCache property with an Object containing the dims from the viewport.",

55615

"class": "DD.Scroll",

55616

"module": "dd",

55617

"submodule": "dd-scroll",

55618

"namespace": "DD"

55619

},

55620

{

55621

"file": "dd/js/scroll.js",

55622

"line": 167,

55623

"access": "private",

55624

"tagname": "",

55625

"itemtype": "method",

55626

"name": "_checkWinScroll",

55627

"description": "Check to see if we need to fire the scroll timer. If scroll timer is running this will scroll the window.",

55628

"params": [

55629

{

55630

"name": "move",

55631

"description": "Should we move the window. From Y.later",

55632

"type": "Boolean"

55633

}

55634

],

55635

"class": "DD.Scroll",

55636

"module": "dd",

55637

"submodule": "dd-scroll",

55638

"namespace": "DD"

55639

},

55640

{

55641

"file": "dd/js/scroll.js",

55642

"line": 250,

55643

"access": "private",

55644

"tagname": "",

55645

"itemtype": "method",

55646

"name": "_initScroll",

55647

"description": "Cancel a previous scroll timer and init a new one.",

55648

"class": "DD.Scroll",

55649

"module": "dd",

55650

"submodule": "dd-scroll",

55651

"namespace": "DD"

55652

},

55653

{

55654

"file": "dd/js/scroll.js",

55655

"line": 260,

55656

"access": "private",

55657

"tagname": "",

55658

"itemtype": "method",

55659

"name": "_cancelScroll",

55660

"description": "Cancel a currently running scroll timer.",

55661

"class": "DD.Scroll",

55662

"module": "dd",

55663

"submodule": "dd-scroll",

55664

"namespace": "DD"

55665

},

55666

{

55667

"file": "dd/js/scroll.js",

55668

"line": 272,

55669

"itemtype": "method",

55670

"name": "align",

55671

"description": "Called from the drag:align event to determine if we need to scroll.",

55672

"class": "DD.Scroll",

55673

"module": "dd",

55674

"submodule": "dd-scroll",

55675

"namespace": "DD"

55676

},

55677

{

55678

"file": "dd/js/scroll.js",

55679

"line": 285,

55680

"access": "private",

55681

"tagname": "",

55682

"itemtype": "method",

55683

"name": "_setDimCache",

55684

"description": "Set the cache of the dragNode dims.",

55685

"class": "DD.Scroll",

55686

"module": "dd",

55687

"submodule": "dd-scroll",

55688

"namespace": "DD"

55689

},

55690

{

55691

"file": "dd/js/scroll.js",

55692

"line": 297,

55693

"itemtype": "method",

55694

"name": "start",

55695

"description": "Called from the drag:start event",

55696

"class": "DD.Scroll",

55697

"module": "dd",

55698

"submodule": "dd-scroll",

55699

"namespace": "DD"

55700

},

55701

{

55702

"file": "dd/js/scroll.js",

55703

"line": 304,

55704

"itemtype": "method",

55705

"name": "end",

55706

"description": "Called from the drag:end event",

55707

"class": "DD.Scroll",

55708

"module": "dd",

55709

"submodule": "dd-scroll",

55710

"namespace": "DD"

55711

},

55712

{

55713

"file": "dd/js/scroll.js",

55714

"line": 328,

55715

"itemtype": "attribute",

55716

"name": "windowScroll",

55717

"description": "Turn on window scroll support, default: true",

55718

"type": "Boolean",

55719

"class": "Plugin.DDWindowScroll",

55720

"module": "dd",

55721

"submodule": "dd-scroll",

55722

"namespace": "Plugin"

55723

},

55724

{

55725

"file": "dd/js/scroll.js",

55726

"line": 349,

55727

"itemtype": "property",

55728

"name": "NS",

55729

"default": "winscroll",

55730

"readonly": "",

55731

"access": "protected",

55732

"tagname": "",

55733

"static": 1,

55734

"description": "The Scroll instance will be placed on the Drag instance under the winscroll namespace.",

55735

"type": "{String}",

55736

"class": "Plugin.DDWindowScroll",

55737

"module": "dd",

55738

"submodule": "dd-scroll",

55739

"namespace": "Plugin"

55740

},

55741

{

55742

"file": "dd/js/scroll.js",

55743

"line": 374,

55744

"itemtype": "attribute",

55745

"name": "node",

55746

"description": "The node we want to scroll. Used to set the internal parentScroll attribute.",

55747

"type": "Node",

55748

"class": "Plugin.DDNodeScroll",

55749

"module": "dd",

55750

"submodule": "dd-scroll",

55751

"namespace": "Plugin"

55752

},

55753

{

55754

"file": "dd/js/scroll.js",

55755

"line": 400,

55756

"itemtype": "property",

55757

"name": "NS",

55758

"default": "nodescroll",

55759

"readonly": "",

55760

"access": "protected",

55761

"tagname": "",

55762

"static": 1,

55763

"description": "The NodeScroll instance will be placed on the Drag instance under the nodescroll namespace.",

55764

"type": "{String}",

55765

"class": "Plugin.DDNodeScroll",

55766

"module": "dd",

55767

"submodule": "dd-scroll",

55768

"namespace": "Plugin"

55769

},

55770

{

55771

"file": "dial/js/Dial.js",

55772

"line": 35,

55773

"description": "The identity of the widget.",

55774

"itemtype": "property",

55775

"name": "NAME",

55776

"type": "String",

55777

"default": "'dial'",

55778

"readonly": "",

55779

"access": "protected",

55780

"tagname": "",

55781

"static": 1,

55782

"class": "Dial",

55783

"module": "dial"

55784

},

55785

{

55786

"file": "dial/js/Dial.js",

55787

"line": 47,

55788

"description": "Static property used to define the default attribute configuration of\nthe Widget.",

55789

"itemtype": "property",

55790

"name": "ATTRS",

55791

"type": "{Object}",

55792

"access": "protected",

55793

"tagname": "",

55794

"static": 1,

55795

"class": "Dial",

55796

"module": "dial"

55797

},

55798

{

55799

"file": "dial/js/Dial.js",

55800

"line": 58,

55801

"description": "minimum value allowed",

55802

"itemtype": "attribute",

55803

"name": "min",

55804

"type": "{Number}",

55805

"default": "-220",

55806

"class": "Dial",

55807

"module": "dial"

55808

},

55809

{

55810

"file": "dial/js/Dial.js",

55811

"line": 69,

55812

"description": "maximum value allowed",

55813

"itemtype": "attribute",

55814

"name": "max",

55815

"type": "{Number}",

55816

"default": "220",

55817

"class": "Dial",

55818

"module": "dial"

55819

},

55820

{

55821

"file": "dial/js/Dial.js",

55822

"line": 80,

55823

"description": "diameter of the circular background object.\nOther objects scale accordingly.\nSet this only before rendering.",

55824

"itemtype": "attribute",

55825

"name": "diameter",

55826

"type": "{Number} the number of px in diameter",

55827

"default": "100",

55828

"writeonce": "",

55829

"class": "Dial",

55830

"module": "dial"

55831

},

55832

{

55833

"file": "dial/js/Dial.js",

55834

"line": 94,

55835

"description": "diameter of the handle object which users drag to change the value.\nDial sets the pixel dimension of the handle equal to handleDiameter * diameter.\nSet this only before rendering.",

55836

"itemtype": "attribute",

55837

"name": "handleDiameter",

55838

"type": "{Number}",

55839

"default": "0.2",

55840

"writeonce": "",

55841

"class": "Dial",

55842

"module": "dial"

55843

},

55844

{

55845

"file": "dial/js/Dial.js",

55846

"line": 108,

55847

"description": "diameter of the marker object which follows the angle of the handle during value changes.\nDial sets the pixel dimension of the marker equal to markerDiameter * diameter.\nSet this only before rendering.",

55848

"itemtype": "attribute",

55849

"name": "markerDiameter",

55850

"type": "{Number}",

55851

"default": "0.1",

55852

"writeonce": "",

55853

"class": "Dial",

55854

"module": "dial"

55855

},

55856

{

55857

"file": "dial/js/Dial.js",

55858

"line": 122,

55859

"description": "diameter of the center button object.\nDial sets the pixel dimension of the centerButton equal to centerButtonDiameter * diameter.\nSet this only before rendering.",

55860

"itemtype": "attribute",

55861

"name": "centerButtonDiameter",

55862

"type": "{Number}",

55863

"default": "0.1",

55864

"writeonce": "",

55865

"class": "Dial",

55866

"module": "dial"

55867

},

55868

{

55869

"file": "dial/js/Dial.js",

55870

"line": 136,

55871

"description": "initial value of the Dial",

55872

"itemtype": "attribute",

55873

"name": "value",

55874

"type": "{Number}",

55875

"default": "0",

55876

"class": "Dial",

55877

"module": "dial"

55878

},

55879

{

55880

"file": "dial/js/Dial.js",

55881

"line": 150,

55882

"description": "amount to increment/decrement the dial value\nwhen the arrow up/down/left/right keys are pressed",

55883

"itemtype": "attribute",

55884

"name": "minorStep",

55885

"type": "{Number}",

55886

"default": "1",

55887

"class": "Dial",

55888

"module": "dial"

55889

},

55890

{

55891

"file": "dial/js/Dial.js",

55892

"line": 162,

55893

"description": "amount to increment/decrement the dial value\nwhen the page up/down keys are pressed",

55894

"itemtype": "attribute",

55895

"name": "majorStep",

55896

"type": "{Number}",

55897

"default": "10",

55898

"class": "Dial",

55899

"module": "dial"

55900

},

55901

{

55902

"file": "dial/js/Dial.js",

55903

"line": 174,

55904

"description": "number of value increments in one 360 degree revolution \nof the handle around the dial",

55905

"itemtype": "attribute",

55906

"name": "stepsPerRevolution",

55907

"type": "{Number}",

55908

"default": "100",

55909

"class": "Dial",

55910

"module": "dial"

55911

},

55912

{

55913

"file": "dial/js/Dial.js",

55914

"line": 186,

55915

"description": "number of decimal places of accuracy in the value",

55916

"itemtype": "attribute",

55917

"name": "decimalPlaces",

55918

"type": "{Number}",

55919

"default": "0",

55920

"class": "Dial",

55921

"module": "dial"

55922

},

55923

{

55924

"file": "dial/js/Dial.js",

55925

"line": 197,

55926

"description": "visible strings for the dial UI. This attribute is \ndefined by the base Widget class but has an empty value. The\nDial is simply providing a default value for the attribute.\nGets localized strings in the current language",

55927

"itemtype": "attribute",

55928

"name": "strings",

55929

"type": "{Object} the values are HTML strings",

55930

"default": "{label: 'My label', resetStr: 'Reset', tooltipHandle: 'Drag to set value'}",

55931

"class": "Dial",

55932

"module": "dial"

55933

},

55934

{

55935

"file": "dial/js/Dial.js",

55936

"line": 213,

55937

"description": "distance from the center of the dial to the \ncenter of the marker and handle, when at rest. \nThe value is a percent of the radius of the dial.",

55938

"itemtype": "attribute",

55939

"name": "handleDistance",

55940

"type": "{number}",

55941

"default": "0.75",

55942

"class": "Dial",

55943

"module": "dial"

55944

},

55945

{

55946

"file": "dial/js/Dial.js",

55947

"line": 228,

55948

"description": "returns a properly formed yui class name",

55949

"itemtype": "method",

55950

"name": "",

55951

"params": [

55952

{

55953

"name": "string",

55954

"description": "to be appended at the end of class name",

55955

"type": "String"

55956

}

55957

],

55958

"return": {

55959

"description": ""

55960

},

55961

"access": "private",

55962

"tagname": "",

55963

"class": "Dial",

55964

"module": "dial"

55965

},

55966

{

55967

"file": "dial/js/Dial.js",

55968

"line": 240,

55969

"itemtype": "property",

55970

"name": "CSS_CLASSES",

55971

"type": "{Array}",

55972

"access": "private",

55973

"tagname": "",

55974

"static": 1,

55975

"class": "Dial",

55976

"module": "dial"

55977

},

55978

{

55979

"file": "dial/js/Dial.js",

55980

"line": 269,

55981

"description": "template that will contain the Dial's label.",

55982

"itemtype": "property",

55983

"name": "LABEL_TEMPLATE",

55984

"type": "{HTML}",

55985

"default": "<div class=\"[...-label]\">{label}</div>",

55986

"access": "protected",

55987

"tagname": "",

55988

"class": "Dial",

55989

"module": "dial"

55990

},

55991

{

55992

"file": "dial/js/Dial.js",

55993

"line": 281,

55994

"description": "template that will contain the Dial's background ring.",

55995

"itemtype": "property",

55996

"name": "RING_TEMPLATE",

55997

"type": "{HTML}",

55998

"default": "<div class=\"[...-ring]\"><div class=\"[...-northMark]\"></div></div>",

55999

"access": "protected",

56000

"tagname": "",

56001

"class": "Dial",

56002

"module": "dial"

56003

},

56004

{

56005

"file": "dial/js/Dial.js",

56006

"line": 291,

56007

"description": "template that will contain the Dial's current angle marker.",

56008

"itemtype": "property",

56009

"name": "MARKER_TEMPLATE",

56010

"type": "{HTML}",

56011

"default": "<div class=\"[...-marker] [...-marker-hidden]\"><div class=\"[...-markerUser]\"></div></div>",

56012

"access": "protected",

56013

"tagname": "",

56014

"class": "Dial",

56015

"module": "dial"

56016

},

56017

{

56018

"file": "dial/js/Dial.js",

56019

"line": 301,

56020

"description": "template that will contain the Dial's center button.",

56021

"itemtype": "property",

56022

"name": "CENTER_BUTTON_TEMPLATE",

56023

"type": "{HTML}",

56024

"default": "<div class=\"[...-centerButton]\"><div class=\"[...-resetString]\">' + Y.substitute('{resetStr}', Dial.ATTRS.strings.value) + '</div></div>",

56025

"access": "protected",

56026

"tagname": "",

56027

"class": "Dial",

56028

"module": "dial"

56029

},

56030

{

56031

"file": "dial/js/Dial.js",

56032

"line": 311,

56033

"description": "template that will contain the Dial's handle.",

56034

"itemtype": "property",

56035

"name": "HANDLE_TEMPLATE",

56036

"type": "{HTML}",

56037

"default": "<div class=\"[...-handle]\"><div class=\"[...-handleUser]\" aria-labelledby=\"\" aria-valuetext=\"\" aria-valuemax=\"\" aria-valuemin=\"\" aria-valuenow=\"\" role=\"slider\" tabindex=\"0\"></div></div>';// title=\"{tooltipHandle}\"",

56038

"access": "protected",

56039

"tagname": "",

56040

"class": "Dial",

56041

"module": "dial"

56042

},

56043

{

56044

"file": "dial/js/Dial.js",

56045

"line": 352,

56046

"description": "creates the DOM structure for the Dial.",

56047

"itemtype": "method",

56048

"name": "renderUI",

56049

"access": "protected",

56050

"tagname": "",

56051

"class": "Dial",

56052

"module": "dial"

56053

},

56054

{

56055

"file": "dial/js/Dial.js",

56056

"line": 387,

56057

"description": "Sets -webkit-border-radius to 50% of width/height of the ring, handle, marker, and center-button.\nThis is needed for iOS 3.x.\nThe objects render square if the radius is > 50% of the width/height",

56058

"itemtype": "method",

56059

"name": "_setBorderRadius",

56060

"access": "private",

56061

"tagname": "",

56062

"class": "Dial",

56063

"module": "dial"

56064

},

56065

{

56066

"file": "dial/js/Dial.js",

56067

"line": 413,

56068

"description": "Handles the mouseenter on the centerButton",

56069

"itemtype": "method",

56070

"name": "_handleCenterButtonEnter",

56071

"access": "protected",

56072

"tagname": "",

56073

"class": "Dial",

56074

"module": "dial"

56075

},

56076

{

56077

"file": "dial/js/Dial.js",

56078

"line": 423,

56079

"description": "Handles the mouseleave on the centerButton",

56080

"itemtype": "method",

56081

"name": "_handleCenterButtonLeave",

56082

"access": "protected",

56083

"tagname": "",

56084

"class": "Dial",

56085

"module": "dial"

56086

},

56087

{

56088

"file": "dial/js/Dial.js",

56089

"line": 433,

56090

"description": "Creates the Y.DD.Drag instance used for the handle movement and\nbinds Dial interaction to the configured value model.",

56091

"itemtype": "method",

56092

"name": "bindUI",

56093

"access": "protected",

56094

"tagname": "",

56095

"class": "Dial",

56096

"module": "dial"

56097

},

56098

{

56099

"file": "dial/js/Dial.js",

56100

"line": 478,

56101

"description": "Sets _timesWrapped based on Dial value\nto net integer revolutions the user dragged the handle around the Dial",

56102

"itemtype": "method",

56103

"name": "_setTimesWrappedFromValue",

56104

"params": [

56105

{

56106

"name": "val",

56107

"description": "current value of the Dial",

56108

"type": "Number"

56109

}

56110

],

56111

"access": "private",

56112

"tagname": "",

56113

"class": "Dial",

56114

"module": "dial"

56115

},

56116

{

56117

"file": "dial/js/Dial.js",

56118

"line": 494,

56119

"description": "gets the angle of the line from the center of the Dial to the center of the handle",

56120

"itemtype": "method",

56121

"name": "_getAngleFromHandleCenter",

56122

"params": [

56123

{

56124

"name": "handleCenterX",

56125

"description": "",

56126

"type": "Number"

56127

},

56128

{

56129

"name": "handleCenterY",

56130

"description": "",

56131

"type": "Number"

56132

}

56133

],

56134

"return": {

56135

"description": "ang the angle",

56136

"type": "Number"

56137

},

56138

"access": "protected",

56139

"tagname": "",

56140

"class": "Dial",

56141

"module": "dial"

56142

},

56143

{

56144

"file": "dial/js/Dial.js",

56145

"line": 509,

56146

"description": "calculates the XY of the center of the dial relative to the ring node. \nThis is needed for calculating the angle of the handle",

56147

"itemtype": "method",

56148

"name": "_calculateDialCenter",

56149

"access": "protected",

56150

"tagname": "",

56151

"class": "Dial",

56152

"module": "dial"

56153

},

56154

{

56155

"file": "dial/js/Dial.js",

56156

"line": 521,

56157

"description": "Handles the mouseup on the ring",

56158

"itemtype": "method",

56159

"name": "_handleRingMouseup",

56160

"access": "protected",

56161

"tagname": "",

56162

"class": "Dial",

56163

"module": "dial"

56164

},

56165

{

56166

"file": "dial/js/Dial.js",

56167

"line": 531,

56168

"description": "Handles the mouseup on the centerButton",

56169

"itemtype": "method",

56170

"name": "_handleCenterButtonMouseup",

56171

"access": "protected",

56172

"tagname": "",

56173

"class": "Dial",

56174

"module": "dial"

56175

},

56176

{

56177

"file": "dial/js/Dial.js",

56178

"line": 541,

56179

"description": "Handles the mousedown on the handle",

56180

"itemtype": "method",

56181

"name": "_handleHandleMousedown",

56182

"access": "protected",

56183

"tagname": "",

56184

"class": "Dial",

56185

"module": "dial"

56186

},

56187

{

56188

"file": "dial/js/Dial.js",

56189

"line": 553,

56190

"description": "handles the user dragging the handle around the Dial, gets the angle, \nchecks for wrapping around top center.\nSets the new value of the Dial",

56191

"itemtype": "method",

56192

"name": "_handleDrag",

56193

"params": [

56194

{

56195

"name": "e",

56196

"description": "the drag event object",

56197

"type": "DOMEvent"

56198

}

56199

],

56200

"access": "protected",

56201

"tagname": "",

56202

"class": "Dial",

56203

"module": "dial"

56204

},

56205

{

56206

"file": "dial/js/Dial.js",

56207

"line": 603,

56208

"description": "handles a mousedown or gesturemovestart event on the ring node",

56209

"itemtype": "method",

56210

"name": "_handleMousedown",

56211

"params": [

56212

{

56213

"name": "e",

56214

"description": "the event object",

56215

"type": "DOMEvent"

56216

}

56217

],

56218

"access": "private",

56219

"tagname": "",

56220

"class": "Dial",

56221

"module": "dial"

56222

},

56223

{

56224

"file": "dial/js/Dial.js",

56225

"line": 726,

56226

"description": "handles the case where the value is less than min or greater than max",

56227

"itemtype": "method",

56228

"name": "_handleValuesBeyondMinMax",

56229

"params": [

56230

{

56231

"name": "e",

56232

"description": "the event object",

56233

"type": "DOMEvent"

56234

},

56235

{

56236

"name": "newValue",

56237

"description": "current value of the dial",

56238

"type": "Number"

56239

}

56240

],

56241

"access": "protected",

56242

"tagname": "",

56243

"class": "Dial",

56244

"module": "dial"

56245

},

56246

{

56247

"file": "dial/js/Dial.js",

56248

"line": 757,

56249

"description": "handles the user starting to drag the handle around the Dial",

56250

"itemtype": "method",

56251

"name": "_handleDragStart",

56252

"params": [

56253

{

56254

"name": "e",

56255

"description": "the drag event object",

56256

"type": "DOMEvent"

56257

}

56258

],

56259

"access": "protected",

56260

"tagname": "",

56261

"class": "Dial",

56262

"module": "dial"

56263

},

56264

{

56265

"file": "dial/js/Dial.js",

56266

"line": 772,

56267

"description": "handles the end of a user dragging the handle, animates the handle returning to\nresting position.",

56268

"itemtype": "method",

56269

"name": "_handleDragEnd",

56270

"access": "protected",

56271

"tagname": "",

56272

"class": "Dial",

56273

"module": "dial"

56274

},

56275

{

56276

"file": "dial/js/Dial.js",

56277

"line": 800,

56278

"description": "returns the XY of the fixed position, handleDistance, from the center of the Dial (resting position).\nThe XY also represents the angle related to the current value.\nIf typeArray is true, [X,Y] is returned.\nIf typeArray is false, the XY of the obj node passed in is set.",

56279

"itemtype": "method",

56280

"name": "_setNodeToFixedRadius",

56281

"params": [

56282

{

56283

"name": "obj",

56284

"description": "",

56285

"type": "Node"

56286

},

56287

{

56288

"name": "typeArray",

56289

"description": "true returns an array [X,Y]",

56290

"type": "Boolean"

56291

}

56292

],

56293

"access": "protected",

56294

"tagname": "",

56295

"return": {

56296

"description": "an array of [XY] is optionally returned",

56297

"type": "Array"

56298

},

56299

"class": "Dial",

56300

"module": "dial"

56301

},

56302

{

56303

"file": "dial/js/Dial.js",

56304

"line": 829,

56305

"description": "Synchronizes the DOM state with the attribute settings.",

56306

"itemtype": "method",

56307

"name": "syncUI",

56308

"class": "Dial",

56309

"module": "dial"

56310

},

56311

{

56312

"file": "dial/js/Dial.js",

56313

"line": 846,

56314

"description": "sets the sizes of ring, center-button, marker, handle, and VML ovals in pixels.\nNeeded only because some IE versions \nignore CSS percent sizes/offsets.\nso these must be set in pixels.\nNormally these are set in % of the ring.",

56315

"itemtype": "method",

56316

"name": "_setSizes",

56317

"access": "protected",

56318

"tagname": "",

56319

"class": "Dial",

56320

"module": "dial"

56321

},

56322

{

56323

"file": "dial/js/Dial.js",

56324

"line": 894,

56325

"description": "renders the DOM object for the Dial's label",

56326

"itemtype": "method",

56327

"name": "_renderLabel",

56328

"access": "protected",

56329

"tagname": "",

56330

"class": "Dial",

56331

"module": "dial"

56332

},

56333

{

56334

"file": "dial/js/Dial.js",

56335

"line": 911,

56336

"description": "renders the DOM object for the Dial's background ring",

56337

"itemtype": "method",

56338

"name": "_renderRing",

56339

"access": "protected",

56340

"tagname": "",

56341

"class": "Dial",

56342

"module": "dial"

56343

},

56344

{

56345

"file": "dial/js/Dial.js",

56346

"line": 927,

56347

"description": "renders the DOM object for the Dial's background marker which \ntracks the angle of the user dragging the handle",

56348

"itemtype": "method",

56349

"name": "_renderMarker",

56350

"access": "protected",

56351

"tagname": "",

56352

"class": "Dial",

56353

"module": "dial"

56354

},

56355

{

56356

"file": "dial/js/Dial.js",

56357

"line": 943,

56358

"description": "renders the DOM object for the Dial's center",

56359

"itemtype": "method",

56360

"name": "_renderCenterButton",

56361

"access": "protected",

56362

"tagname": "",

56363

"class": "Dial",

56364

"module": "dial"

56365

},

56366

{

56367

"file": "dial/js/Dial.js",

56368

"line": 960,

56369

"description": "renders the DOM object for the Dial's user draggable handle",

56370

"itemtype": "method",

56371

"name": "_renderHandle",

56372

"access": "protected",

56373

"tagname": "",

56374

"class": "Dial",

56375

"module": "dial"

56376

},

56377

{

56378

"file": "dial/js/Dial.js",

56379

"line": 979,

56380

"description": "sets the visible UI label HTML string",

56381

"itemtype": "method",

56382

"name": "_setLabelString",

56383

"params": [

56384

{

56385

"name": "str",

56386

"description": "",

56387

"type": "HTML"

56388

}

56389

],

56390

"access": "protected",

56391

"tagname": "",

56392

"deprecated": true,

56393

"deprecationMessage": "Use DialObjName.set('strings',{'label':'My new label'}); before DialObjName.render();",

56394

"class": "Dial",

56395

"module": "dial"

56396

},

56397

{

56398

"file": "dial/js/Dial.js",

56399

"line": 992,

56400

"description": "sets the visible UI label HTML string",

56401

"itemtype": "method",

56402

"name": "_setResetString",

56403

"params": [

56404

{

56405

"name": "str",

56406

"description": "",

56407

"type": "HTML"

56408

}

56409

],

56410

"access": "protected",

56411

"tagname": "",

56412

"deprecated": true,

56413

"deprecationMessage": "Use DialObjName.set('strings',{'resetStr':'My new reset string'}); before DialObjName.render();",

56414

"class": "Dial",

56415

"module": "dial"

56416

},

56417

{

56418

"file": "dial/js/Dial.js",

56419

"line": 1006,

56420

"description": "sets the tooltip HTML string in the Dial's handle",

56421

"itemtype": "method",

56422

"name": "_setTooltipString",

56423

"params": [

56424

{

56425

"name": "str",

56426

"description": "",

56427

"type": "HTML"

56428

}

56429

],

56430

"access": "protected",

56431

"tagname": "",

56432

"deprecated": true,

56433

"deprecationMessage": "Use DialObjName.set('strings',{'tooltipHandle':'My new tooltip'}); before DialObjName.render();",

56434

"class": "Dial",

56435

"module": "dial"

56436

},

56437

{

56438

"file": "dial/js/Dial.js",

56439

"line": 1018,

56440

"description": "sets the Dial's value in response to key events.\nLeft and right keys are in a separate method \nin case an implementation wants to increment values\nbut needs left and right arrow keys for other purposes.",

56441

"itemtype": "method",

56442

"name": "_onDirectionKey",

56443

"params": [

56444

{

56445

"name": "e",

56446

"description": "the key event",

56447

"type": "Event"

56448

}

56449

],

56450

"access": "protected",

56451

"tagname": "",

56452

"class": "Dial",

56453

"module": "dial"

56454

},

56455

{

56456

"file": "dial/js/Dial.js",

56457

"line": 1052,

56458

"description": "sets the Dial's value in response to left or right key events",

56459

"itemtype": "method",

56460

"name": "_onLeftRightKey",

56461

"params": [

56462

{

56463

"name": "e",

56464

"description": "the key event",

56465

"type": "Event"

56466

}

56467

],

56468

"access": "protected",

56469

"tagname": "",

56470

"class": "Dial",

56471

"module": "dial"

56472

},

56473

{

56474

"file": "dial/js/Dial.js",

56475

"line": 1071,

56476

"description": "sets the Dial's value in response to left or right key events when a meta (mac command/apple) key is also pressed",

56477

"itemtype": "method",

56478

"name": "_onLeftRightKeyMeta",

56479

"params": [

56480

{

56481

"name": "e",

56482

"description": "the key event",

56483

"type": "Event"

56484

}

56485

],

56486

"access": "protected",

56487

"tagname": "",

56488

"class": "Dial",

56489

"module": "dial"

56490

},

56491

{

56492

"file": "dial/js/Dial.js",

56493

"line": 1090,

56494

"description": "increments Dial value by a minor increment",

56495

"itemtype": "method",

56496

"name": "_incrMinor",

56497

"access": "protected",

56498

"tagname": "",

56499

"class": "Dial",

56500

"module": "dial"

56501

},

56502

{

56503

"file": "dial/js/Dial.js",

56504

"line": 1106,

56505

"description": "decrements Dial value by a minor increment",

56506

"itemtype": "method",

56507

"name": "_decrMinor",

56508

"access": "protected",

56509

"tagname": "",

56510

"class": "Dial",

56511

"module": "dial"

56512

},

56513

{

56514

"file": "dial/js/Dial.js",

56515

"line": 1118,

56516

"description": "increments Dial value by a major increment",

56517

"itemtype": "method",

56518

"name": "_incrMajor",

56519

"access": "protected",

56520

"tagname": "",

56521

"class": "Dial",

56522

"module": "dial"

56523

},

56524

{

56525

"file": "dial/js/Dial.js",

56526

"line": 1130,

56527

"description": "decrements Dial value by a major increment",

56528

"itemtype": "method",

56529

"name": "_decrMajor",

56530

"access": "protected",

56531

"tagname": "",

56532

"class": "Dial",

56533

"module": "dial"

56534

},

56535

{

56536

"file": "dial/js/Dial.js",

56537

"line": 1142,

56538

"description": "sets Dial value to dial's max attr",

56539

"itemtype": "method",

56540

"name": "_setToMax",

56541

"access": "protected",

56542

"tagname": "",

56543

"class": "Dial",

56544

"module": "dial"

56545

},

56546

{

56547

"file": "dial/js/Dial.js",

56548

"line": 1152,

56549

"description": "sets Dial value to dial's min attr",

56550

"itemtype": "method",

56551

"name": "_setToMin",

56552

"access": "protected",

56553

"tagname": "",

56554

"class": "Dial",

56555

"module": "dial"

56556

},

56557

{

56558

"file": "dial/js/Dial.js",

56559

"line": 1162,

56560

"description": "resets Dial value to the orignal initial value.",

56561

"itemtype": "method",

56562

"name": "_resetDial",

56563

"access": "protected",

56564

"tagname": "",

56565

"class": "Dial",

56566

"module": "dial"

56567

},

56568

{

56569

"file": "dial/js/Dial.js",

56570

"line": 1177,

56571

"description": "returns the handle angle associated with the current value of the Dial. \nReturns a number between 0 and 360.",

56572

"itemtype": "method",

56573

"name": "_getAngleFromValue",

56574

"params": [

56575

{

56576

"name": "newVal",

56577

"description": "the current value of the Dial",

56578

"type": "Number"

56579

}

56580

],

56581

"return": {

56582

"description": "the angle associated with the current Dial value",

56583

"type": "Number"

56584

},

56585

"access": "protected",

56586

"tagname": "",

56587

"class": "Dial",

56588

"module": "dial"

56589

},

56590

{

56591

"file": "dial/js/Dial.js",

56592

"line": 1192,

56593

"description": "returns the value of the Dial calculated from the current handle angle",

56594

"itemtype": "method",

56595

"name": "_getValueFromAngle",

56596

"params": [

56597

{

56598

"name": "angle",

56599

"description": "the current angle of the Dial's handle",

56600

"type": "Number"

56601

}

56602

],

56603

"return": {

56604

"description": "the current Dial value corresponding to the handle position",

56605

"type": "Number"

56606

},

56607

"access": "protected",

56608

"tagname": "",

56609

"class": "Dial",

56610

"module": "dial"

56611

},

56612

{

56613

"file": "dial/js/Dial.js",

56614

"line": 1212,

56615

"description": "calls the method to update the UI whenever the Dial value changes",

56616

"itemtype": "method",

56617

"name": "_afterValueChange",

56618

"params": [

56619

{

56620

"name": "e",

56621

"description": "",

56622

"type": "Event"

56623

}

56624

],

56625

"access": "protected",

56626

"tagname": "",

56627

"class": "Dial",

56628

"module": "dial"

56629

},

56630

{

56631

"file": "dial/js/Dial.js",

56632

"line": 1223,

56633

"description": "Changes a value to have the correct decimal places per the attribute decimalPlaces",

56634

"itemtype": "method",

56635

"name": "_valueToDecimalPlaces",

56636

"params": [

56637

{

56638

"name": "val",

56639

"description": "a raw value to set to the Dial",

56640

"type": "Number"

56641

}

56642

],

56643

"return": {

56644

"description": "the input val changed to have the correct decimal places",

56645

"type": "Number"

56646

},

56647

"access": "protected",

56648

"tagname": "",

56649

"class": "Dial",

56650

"module": "dial"

56651

},

56652

{

56653

"file": "dial/js/Dial.js",

56654

"line": 1235,

56655

"description": "Updates the UI display value of the Dial to reflect \nthe value passed in.\nMakes all other needed UI display changes",

56656

"itemtype": "method",

56657

"name": "_uiSetValue",

56658

"params": [

56659

{

56660

"name": "val",

56661

"description": "value of the Dial",

56662

"type": "Number"

56663

}

56664

],

56665

"access": "protected",

56666

"tagname": "",

56667

"class": "Dial",

56668

"module": "dial"

56669

},

56670

{

56671

"file": "dial/js/Dial.js",

56672

"line": 1272,

56673

"description": "value attribute default validator. Verifies that\nthe value being set lies between the min/max value",

56674

"itemtype": "method",

56675

"name": "_validateValue",

56676

"params": [

56677

{

56678

"name": "val",

56679

"description": "value of the Dial",

56680

"type": "Number"

56681

}

56682

],

56683

"access": "protected",

56684

"tagname": "",

56685

"class": "Dial",

56686

"module": "dial"

56687

},

56688

{

56689

"file": "dom/js/dom-attrs.js",

56690

"line": 14,

56691

"description": "Returns the text content of the HTMLElement.",

56692

"itemtype": "method",

56693

"name": "getText",

56694

"params": [

56695

{

56696

"name": "element",

56697

"description": "The html element.",

56698

"type": "HTMLElement"

56699

}

56700

],

56701

"return": {

56702

"description": "The text content of the element (includes text of any descending elements).",

56703

"type": "String"

56704

},

56705

"class": "DOM",

56706

"module": "dom"

56707

},

56708

{

56709

"file": "dom/js/dom-attrs.js",

56710

"line": 35,

56711

"description": "Sets the text content of the HTMLElement.",

56712

"itemtype": "method",

56713

"name": "setText",

56714

"params": [

56715

{

56716

"name": "element",

56717

"description": "The html element.",

56718

"type": "HTMLElement"

56719

},

56720

{

56721

"name": "content",

56722

"description": "The content to add.",

56723

"type": "String"

56724

}

56725

],

56726

"class": "DOM",

56727

"module": "dom"

56728

},

56729

{

56730

"file": "dom/js/dom-attrs.js",

56731

"line": 62,

56732

"description": "Provides a normalized attribute interface.",

56733

"itemtype": "method",

56734

"name": "setAttribute",

56735

"params": [

56736

{

56737

"name": "el",

56738

"description": "The target element for the attribute.",

56739

"type": "HTMLElement"

56740

},

56741

{

56742

"name": "attr",

56743

"description": "The attribute to set.",

56744

"type": "String"

56745

},

56746

{

56747

"name": "val",

56748

"description": "The value of the attribute.",

56749

"type": "String"

56750

}

56751

],

56752

"class": "DOM",

56753

"module": "dom"

56754

},

56755

{

56756

"file": "dom/js/dom-attrs.js",

56757

"line": 78,

56758

"description": "Provides a normalized attribute interface.",

56759

"itemtype": "method",

56760

"name": "getAttribute",

56761

"params": [

56762

{

56763

"name": "el",

56764

"description": "The target element for the attribute.",

56765

"type": "HTMLElement"

56766

},

56767

{

56768

"name": "attr",

56769

"description": "The attribute to get.",

56770

"type": "String"

56771

}

56772

],

56773

"return": {

56774

"description": "The current value of the attribute.",

56775

"type": "String"

56776

},

56777

"class": "DOM",

56778

"module": "dom"

56779

},

56780

{

56781

"file": "dom/js/dom-class.js",

56782

"line": 4,

56783

"description": "Determines whether a DOM element has the given className.",

56784

"itemtype": "method",

56785

"name": "hasClass",

56786

"params": [

56787

{

56788

"name": "element",

56789

"description": "The DOM element.",

56790

"type": "HTMLElement"

56791

},

56792

{

56793

"name": "className",

56794

"description": "the class name to search for",

56795

"type": "String"

56796

}

56797

],

56798

"return": {

56799

"description": "Whether or not the element has the given class.",

56800

"type": "Boolean"

56801

},

56802

"class": "DOM",

56803

"module": "dom"

56804

},

56805

{

56806

"file": "dom/js/dom-class.js",

56807

"line": 17,

56808

"description": "Adds a class name to a given DOM element.",

56809

"itemtype": "method",

56810

"name": "addClass",

56811

"params": [

56812

{

56813

"name": "element",

56814

"description": "The DOM element.",

56815

"type": "HTMLElement"

56816

},

56817

{

56818

"name": "className",

56819

"description": "the class name to add to the class attribute",

56820

"type": "String"

56821

}

56822

],

56823

"class": "DOM",

56824

"module": "dom"

56825

},

56826

{

56827

"file": "dom/js/dom-class.js",

56828

"line": 30,

56829

"description": "Removes a class name from a given element.",

56830

"itemtype": "method",

56831

"name": "removeClass",

56832

"params": [

56833

{

56834

"name": "element",

56835

"description": "The DOM element.",

56836

"type": "HTMLElement"

56837

},

56838

{

56839

"name": "className",

56840

"description": "the class name to remove from the class attribute",

56841

"type": "String"

56842

}

56843

],

56844

"class": "DOM",

56845

"module": "dom"

56846

},

56847

{

56848

"file": "dom/js/dom-class.js",

56849

"line": 48,

56850

"description": "Replace a class with another class for a given element.\nIf no oldClassName is present, the newClassName is simply added.",

56851

"itemtype": "method",

56852

"name": "replaceClass",

56853

"params": [

56854

{

56855

"name": "element",

56856

"description": "The DOM element",

56857

"type": "HTMLElement"

56858

},

56859

{

56860

"name": "oldClassName",

56861

"description": "the class name to be replaced",

56862

"type": "String"

56863

},

56864

{

56865

"name": "newClassName",

56866

"description": "the class name that will be replacing the old class name",

56867

"type": "String"

56868

}

56869

],

56870

"class": "DOM",

56871

"module": "dom"

56872

},

56873

{

56874

"file": "dom/js/dom-class.js",

56875

"line": 63,

56876

"description": "If the className exists on the node it is removed, if it doesn't exist it is added.",

56877

"itemtype": "method",

56878

"name": "toggleClass",

56879

"params": [

56880

{

56881

"name": "element",

56882

"description": "The DOM element",

56883

"type": "HTMLElement"

56884

},

56885

{

56886

"name": "className",

56887

"description": "the class name to be toggled",

56888

"type": "String"

56889

},

56890

{

56891

"name": "addClass",

56892

"description": "optional boolean to indicate whether class\nshould be added or removed regardless of current state",

56893

"type": "Boolean"

56894

}

56895

],

56896

"class": "DOM",

56897

"module": "dom"

56898

},

56899

{

56900

"file": "dom/js/dom-core.js",

56901

"line": 32,

56902

"description": "Returns the HTMLElement with the given ID (Wrapper for document.getElementById).",

56903

"itemtype": "method",

56904

"name": "byId",

56905

"params": [

56906

{

56907

"name": "id",

56908

"description": "the id attribute",

56909

"type": "String"

56910

},

56911

{

56912

"name": "doc",

56913

"description": "optional The document to search. Defaults to current document",

56914

"type": "Object"

56915

}

56916

],

56917

"return": {

56918

"description": "The HTMLElement with the id, or null if none found.",

56919

"type": "HTMLElement | null"

56920

},

56921

"class": "DOM",

56922

"module": "dom",

56923

"submodule": "dom-base"

56924

},

56925

{

56926

"file": "dom/js/dom-core.js",

56927

"line": 113,

56928

"description": "Searches the element by the given axis for the first matching element.",

56929

"itemtype": "method",

56930

"name": "elementByAxis",

56931

"params": [

56932

{

56933

"name": "element",

56934

"description": "The html element.",

56935

"type": "HTMLElement"

56936

},

56937

{

56938

"name": "axis",

56939

"description": "The axis to search (parentNode, nextSibling, previousSibling).",

56940

"type": "String"

56941

},

56942

{

56943

"name": "fn",

56944

"description": "optional An optional boolean test to apply.",

56945

"type": "Function"

56946

},

56947

{

56948

"name": "all",

56949

"description": "optional Whether all node types should be returned, or just element nodes.\nThe optional function is passed the current HTMLElement being tested as its only argument.\nIf no function is given, the first element is returned.",

56950

"type": "Boolean"

56951

}

56952

],

56953

"return": {

56954

"description": "The matching element or null if none found.",

56955

"type": "HTMLElement | null"

56956

},

56957

"class": "DOM",

56958

"module": "dom",

56959

"submodule": "dom-base"

56960

},

56961

{

56962

"file": "dom/js/dom-core.js",

56963

"line": 137,

56964

"description": "Determines whether or not one HTMLElement is or contains another HTMLElement.",

56965

"itemtype": "method",

56966

"name": "contains",

56967

"params": [

56968

{

56969

"name": "element",

56970

"description": "The containing html element.",

56971

"type": "HTMLElement"

56972

},

56973

{

56974

"name": "needle",

56975

"description": "The html element that may be contained.",

56976

"type": "HTMLElement"

56977

}

56978

],

56979

"return": {

56980

"description": "Whether or not the element is or contains the needle.",

56981

"type": "Boolean"

56982

},

56983

"class": "DOM",

56984

"module": "dom",

56985

"submodule": "dom-base"

56986

},

56987

{

56988

"file": "dom/js/dom-core.js",

56989

"line": 164,

56990

"description": "Determines whether or not the HTMLElement is part of the document.",

56991

"itemtype": "method",

56992

"name": "inDoc",

56993

"params": [

56994

{

56995

"name": "element",

56996

"description": "The containing html element.",

56997

"type": "HTMLElement"

56998

},

56999

{

57000

"name": "doc",

57001

"description": "optional The document to check.",

57002

"type": "HTMLElement"

57003

}

57004

],

57005

"return": {

57006

"description": "Whether or not the element is attached to the document.",

57007

"type": "Boolean"

57008

},

57009

"class": "DOM",

57010

"module": "dom",

57011

"submodule": "dom-base"

57012

},

57013

{

57014

"file": "dom/js/dom-core.js",

57015

"line": 266,

57016

"description": "Brute force version of contains.\nUsed for browsers without contains support for non-HTMLElement Nodes (textNodes, etc).",

57017

"itemtype": "method",

57018

"name": "_bruteContains",

57019

"access": "private",

57020

"tagname": "",

57021

"params": [

57022

{

57023

"name": "element",

57024

"description": "The containing html element.",

57025

"type": "HTMLElement"

57026

},

57027

{

57028

"name": "needle",

57029

"description": "The html element that may be contained.",

57030

"type": "HTMLElement"

57031

}

57032

],

57033

"return": {

57034

"description": "Whether or not the element is or contains the needle.",

57035

"type": "Boolean"

57036

},

57037

"class": "DOM",

57038

"module": "dom",

57039

"submodule": "dom-base"

57040

},

57041

{

57042

"file": "dom/js/dom-core.js",

57043

"line": 286,

57044

"description": "Memoizes dynamic regular expressions to boost runtime performance.",

57045

"itemtype": "method",

57046

"name": "_getRegExp",

57047

"access": "private",

57048

"tagname": "",

57049

"params": [

57050

{

57051

"name": "str",

57052

"description": "The string to convert to a regular expression.",

57053

"type": "String"

57054

},

57055

{

57056

"name": "flags",

57057

"description": "optional An optinal string of flags.",

57058

"type": "String"

57059

}

57060

],

57061

"return": {

57062

"description": "An instance of RegExp",

57063

"type": "RegExp"

57064

},

57065

"class": "DOM",

57066

"module": "dom",

57067

"submodule": "dom-base"

57068

},

57069

{

57070

"file": "dom/js/dom-core.js",

57071

"line": 304,

57072

"description": "returns the appropriate document.",

57073

"itemtype": "method",

57074

"name": "_getDoc",

57075

"access": "private",

57076

"tagname": "",

57077

"params": [

57078

{

57079

"name": "element",

57080

"description": "optional Target element.",

57081

"type": "HTMLElement"

57082

}

57083

],

57084

"return": {

57085

"description": "The document for the given element or the default document.",

57086

"type": "Object"

57087

},

57088

"class": "DOM",

57089

"module": "dom",

57090

"submodule": "dom-base"

57091

},

57092

{

57093

"file": "dom/js/dom-core.js",

57094

"line": 323,

57095

"description": "returns the appropriate window.",

57096

"itemtype": "method",

57097

"name": "_getWin",

57098

"access": "private",

57099

"tagname": "",

57100

"params": [

57101

{

57102

"name": "element",

57103

"description": "optional Target element.",

57104

"type": "HTMLElement"

57105

}

57106

],

57107

"return": {

57108

"description": "The window for the given element or the default window.",

57109

"type": "Object"

57110

},

57111

"class": "DOM",

57112

"module": "dom",

57113

"submodule": "dom-base"

57114

},

57115

{

57116

"file": "dom/js/dom-create.js",

57117

"line": 73,

57118

"description": "Creates a new dom node using the provided markup string.",

57119

"itemtype": "method",

57120

"name": "create",

57121

"params": [

57122

{

57123

"name": "html",

57124

"description": "The markup used to create the element",

57125

"type": "String"

57126

},

57127

{

57128

"name": "doc",

57129

"description": "An optional document context",

57130

"type": "HTMLDocument"

57131

}

57132

],

57133

"return": {

57134

"description": "returns a single HTMLElement \nwhen creating one node, and a documentFragment when creating\nmultiple nodes.",

57135

"type": "HTMLElement|DocumentFragment"

57136

},

57137

"class": "DOM",

57138

"module": "dom"

57139

},

57140

{

57141

"file": "dom/js/dom-create.js",

57142

"line": 145,

57143

"description": "Inserts content in a node at the given location",

57144

"itemtype": "method",

57145

"name": "addHTML",

57146

"params": [

57147

{

57148

"name": "node",

57149

"description": "The node to insert into",

57150

"type": "HTMLElement"

57151

},

57152

{

57153

"name": "content",

57154

"description": "The content to be inserted",

57155

"type": "HTMLElement | Array | HTMLCollection"

57156

},

57157

{

57158

"name": "where",

57159

"description": "Where to insert the content\nIf no \"where\" is given, content is appended to the node\nPossible values for \"where\"\n<dl>\n<dt>HTMLElement</dt>\n<dd>The element to insert before</dd>\n<dt>\"replace\"</dt>\n<dd>Replaces the existing HTML</dd>\n<dt>\"before\"</dt>\n<dd>Inserts before the existing HTML</dd>\n<dt>\"before\"</dt>\n<dd>Inserts content before the node</dd>\n<dt>\"after\"</dt>\n<dd>Inserts content after the node</dd>\n</dl>",

57160

"type": "HTMLElement"

57161

}

57162

],

57163

"class": "DOM",

57164

"module": "dom"

57165

},

57166

{

57167

"file": "dom/js/dom-region.js",

57168

"line": 24,

57169

"description": "Returns an Object literal containing the following about this element: (top, right, bottom, left)",

57170

"itemtype": "method",

57171

"name": "region",

57172

"params": [

57173

{

57174

"name": "element",

57175

"description": "The DOM element.",

57176

"type": "HTMLElement"

57177

}

57178

],

57179

"return": {

57180

"description": "Object literal containing the following about this element: (top, right, bottom, left)",

57181

"type": "Object"

57182

},

57183

"class": "DOM",

57184

"module": "dom"

57185

},

57186

{

57187

"file": "dom/js/dom-region.js",

57188

"line": 47,

57189

"description": "Find the intersect information for the passed nodes.",

57190

"itemtype": "method",

57191

"name": "intersect",

57192

"params": [

57193

{

57194

"name": "element",

57195

"description": "The first element",

57196

"type": "HTMLElement"

57197

},

57198

{

57199

"name": "element2",

57200

"description": "The element or region to check the interect with",

57201

"type": "HTMLElement | Object"

57202

},

57203

{

57204

"name": "altRegion",

57205

"description": "An object literal containing the region for the first element if we already have the data (for performance e.g. DragDrop)",

57206

"type": "Object"

57207

}

57208

],

57209

"return": {

57210

"description": "Object literal containing the following intersection data: (top, right, bottom, left, area, yoff, xoff, inRegion)",

57211

"type": "Object"

57212

},

57213

"class": "DOM",

57214

"module": "dom"

57215

},

57216

{

57217

"file": "dom/js/dom-region.js",

57218

"line": 82,

57219

"description": "Check if any part of this node is in the passed region",

57220

"itemtype": "method",

57221

"name": "inRegion",

57222

"params": [

57223

{

57224

"name": "node",

57225

"description": "The node to get the region from",

57226

"type": "Object"

57227

},

57228

{

57229

"name": "node2",

57230

"description": "The second node to get the region from or an Object literal of the region",

57231

"type": "Object"

57232

},

57233

{

57234

"name": "all",

57235

"description": "Should all of the node be inside the region",

57236

"type": "Boolean"

57237

},

57238

{

57239

"name": "altRegion",

57240

"description": "An object literal containing the region for this node if we already have the data (for performance e.g. DragDrop)",

57241

"type": "Object"

57242

}

57243

],

57244

"return": {

57245

"description": "True if in region, false if not.",

57246

"type": "Boolean"

57247

},

57248

"class": "DOM",

57249

"module": "dom"

57250

},

57251

{

57252

"file": "dom/js/dom-region.js",

57253

"line": 123,

57254

"description": "Check if any part of this element is in the viewport",

57255

"itemtype": "method",

57256

"name": "inViewportRegion",

57257

"params": [

57258

{

57259

"name": "element",

57260

"description": "The DOM element.",

57261

"type": "HTMLElement"

57262

},

57263

{

57264

"name": "all",

57265

"description": "Should all of the node be inside the region",

57266

"type": "Boolean"

57267

},

57268

{

57269

"name": "altRegion",

57270

"description": "An object literal containing the region for this node if we already have the data (for performance e.g. DragDrop)",

57271

"type": "Object"

57272

}

57273

],

57274

"return": {

57275

"description": "True if in region, false if not.",

57276

"type": "Boolean"

57277

},

57278

"class": "DOM",

57279

"module": "dom"

57280

},

57281

{

57282

"file": "dom/js/dom-region.js",

57283

"line": 150,

57284

"description": "Returns an Object literal containing the following about the visible region of viewport: (top, right, bottom, left)",

57285

"itemtype": "method",

57286

"name": "viewportRegion",

57287

"return": {

57288

"description": "Object literal containing the following about the visible region of the viewport: (top, right, bottom, left)",

57289

"type": "Object"

57290

},

57291

"class": "DOM",

57292

"module": "dom"

57293

},

57294

{

57295

"file": "dom/js/dom-screen.js",

57296

"line": 41,

57297

"description": "Returns the inner height of the viewport (exludes scrollbar).",

57298

"itemtype": "method",

57299

"name": "winHeight",

57300

"return": {

57301

"description": "The current height of the viewport.",

57302

"type": "Number"

57303

},

57304

"class": "DOM",

57305

"module": "dom",

57306

"submodule": "dom-screen"

57307

},

57308

{

57309

"file": "dom/js/dom-screen.js",

57310

"line": 52,

57311

"description": "Returns the inner width of the viewport (exludes scrollbar).",

57312

"itemtype": "method",

57313

"name": "winWidth",

57314

"return": {

57315

"description": "The current width of the viewport.",

57316

"type": "Number"

57317

},

57318

"class": "DOM",

57319

"module": "dom",

57320

"submodule": "dom-screen"

57321

},

57322

{

57323

"file": "dom/js/dom-screen.js",

57324

"line": 63,

57325

"description": "Document height",

57326

"itemtype": "method",

57327

"name": "docHeight",

57328

"return": {

57329

"description": "The current height of the document.",

57330

"type": "Number"

57331

},

57332

"class": "DOM",

57333

"module": "dom",

57334

"submodule": "dom-screen"

57335

},

57336

{

57337

"file": "dom/js/dom-screen.js",

57338

"line": 74,

57339

"description": "Document width",

57340

"itemtype": "method",

57341

"name": "docWidth",

57342

"return": {

57343

"description": "The current width of the document.",

57344

"type": "Number"

57345

},

57346

"class": "DOM",

57347

"module": "dom",

57348

"submodule": "dom-screen"

57349

},

57350

{

57351

"file": "dom/js/dom-screen.js",

57352

"line": 85,

57353

"description": "Amount page has been scroll horizontally",

57354

"itemtype": "method",

57355

"name": "docScrollX",

57356

"return": {

57357

"description": "The current amount the screen is scrolled horizontally.",

57358

"type": "Number"

57359

},

57360

"class": "DOM",

57361

"module": "dom",

57362

"submodule": "dom-screen"

57363

},

57364

{

57365

"file": "dom/js/dom-screen.js",

57366

"line": 97,

57367

"description": "Amount page has been scroll vertically",

57368

"itemtype": "method",

57369

"name": "docScrollY",

57370

"return": {

57371

"description": "The current amount the screen is scrolled vertically.",

57372

"type": "Number"

57373

},

57374

"class": "DOM",

57375

"module": "dom",

57376

"submodule": "dom-screen"

57377

},

57378

{

57379

"file": "dom/js/dom-screen.js",

57380

"line": 109,

57381

"description": "Gets the current position of an element based on page coordinates. \nElement must be part of the DOM tree to have page coordinates\n(display:none or elements not appended return false).",

57382

"itemtype": "method",

57383

"name": "getXY",

57384

"params": [

57385

{

57386

"name": "element",

57387

"description": "The target element"

57388

}

57389

],

57390

"return": {

57391

"description": "The XY position of the element\n\n TODO: test inDocument/display?",

57392

"type": "Array"

57393

},

57394

"class": "DOM",

57395

"module": "dom",

57396

"submodule": "dom-screen"

57397

},

57398

{

57399

"file": "dom/js/dom-screen.js",

57400

"line": 254,

57401

"description": "Gets the width of vertical scrollbars on overflowed containers in the body\ncontent.",

57402

"itemtype": "method",

57403

"name": "getScrollbarWidth",

57404

"return": {

57405

"description": "Pixel width of a scrollbar in the current browser",

57406

"type": "Number"

57407

},

57408

"class": "DOM",

57409

"module": "dom",

57410

"submodule": "dom-screen"

57411

},

57412

{

57413

"file": "dom/js/dom-screen.js",

57414

"line": 280,

57415

"description": "Gets the current X position of an element based on page coordinates. \nElement must be part of the DOM tree to have page coordinates\n(display:none or elements not appended return false).",

57416

"itemtype": "method",

57417

"name": "getX",

57418

"params": [

57419

{

57420

"name": "element",

57421

"description": "The target element"

57422

}

57423

],

57424

"return": {

57425

"description": "The X position of the element",

57426

"type": "Number"

57427

},

57428

"class": "DOM",

57429

"module": "dom",

57430

"submodule": "dom-screen"

57431

},

57432

{

57433

"file": "dom/js/dom-screen.js",

57434

"line": 293,

57435

"description": "Gets the current Y position of an element based on page coordinates. \nElement must be part of the DOM tree to have page coordinates\n(display:none or elements not appended return false).",

57436

"itemtype": "method",

57437

"name": "getY",

57438

"params": [

57439

{

57440

"name": "element",

57441

"description": "The target element"

57442

}

57443

],

57444

"return": {

57445

"description": "The Y position of the element",

57446

"type": "Number"

57447

},

57448

"class": "DOM",

57449

"module": "dom",

57450

"submodule": "dom-screen"

57451

},

57452

{

57453

"file": "dom/js/dom-screen.js",

57454

"line": 306,

57455

"description": "Set the position of an html element in page coordinates.\nThe element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).",

57456

"itemtype": "method",

57457

"name": "setXY",

57458

"params": [

57459

{

57460

"name": "element",

57461

"description": "The target element"

57462

},

57463

{

57464

"name": "xy",

57465

"description": "Contains X & Y values for new position (coordinates are page-based)",

57466

"type": "Array"

57467

},

57468

{

57469

"name": "noRetry",

57470

"description": "By default we try and set the position a second time if the first fails",

57471

"type": "Boolean"

57472

}

57473

],

57474

"class": "DOM",

57475

"module": "dom",

57476

"submodule": "dom-screen"

57477

},

57478

{

57479

"file": "dom/js/dom-screen.js",

57480

"line": 352,

57481

"description": "Set the X position of an html element in page coordinates, regardless of how the element is positioned.\nThe element(s) must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).",

57482

"itemtype": "method",

57483

"name": "setX",

57484

"params": [

57485

{

57486

"name": "element",

57487

"description": "The target element"

57488

},

57489

{

57490

"name": "x",

57491

"description": "The X values for new position (coordinates are page-based)",

57492

"type": "Number"

57493

}

57494

],

57495

"class": "DOM",

57496

"module": "dom",

57497

"submodule": "dom-screen"

57498

},

57499

{

57500

"file": "dom/js/dom-screen.js",

57501

"line": 363,

57502

"description": "Set the Y position of an html element in page coordinates, regardless of how the element is positioned.\nThe element(s) must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).",

57503

"itemtype": "method",

57504

"name": "setY",

57505

"params": [

57506

{

57507

"name": "element",

57508

"description": "The target element"

57509

},

57510

{

57511

"name": "y",

57512

"description": "The Y values for new position (coordinates are page-based)",

57513

"type": "Number"

57514

}

57515

],

57516

"class": "DOM",

57517

"module": "dom",

57518

"submodule": "dom-screen"

57519

},

57520

{

57521

"file": "dom/js/dom-screen.js",

57522

"line": 374,

57523

"itemtype": "method",

57524

"name": "swapXY",

57525

"description": "Swap the xy position with another node",

57526

"params": [

57527

{

57528

"name": "node",

57529

"description": "The node to swap with",

57530

"type": "Node"

57531

},

57532

{

57533

"name": "otherNode",

57534

"description": "The other node to swap with",

57535

"type": "Node"

57536

}

57537

],

57538

"return": {

57539

"description": "",

57540

"type": "Node"

57541

},

57542

"class": "DOM",

57543

"module": "dom",

57544

"submodule": "dom-screen"

57545

},

57546

{

57547

"file": "dom/js/dom-size.js",

57548

"line": 2,

57549

"description": "Sets the width of the element to the given size, regardless\nof box model, border, padding, etc.",

57550

"itemtype": "method",

57551

"name": "setWidth",

57552

"params": [

57553

{

57554

"name": "element",

57555

"description": "The DOM element.",

57556

"type": "HTMLElement"

57557

},

57558

{

57559

"name": "size",

57560

"description": "The pixel height to size to",

57561

"type": "String|Number"

57562

}

57563

],

57564

"class": "DOM",

57565

"module": "dom"

57566

},

57567

{

57568

"file": "dom/js/dom-size.js",

57569

"line": 14,

57570

"description": "Sets the height of the element to the given size, regardless\nof box model, border, padding, etc.",

57571

"itemtype": "method",

57572

"name": "setHeight",

57573

"params": [

57574

{

57575

"name": "element",

57576

"description": "The DOM element.",

57577

"type": "HTMLElement"

57578

},

57579

{

57580

"name": "size",

57581

"description": "The pixel height to size to",

57582

"type": "String|Number"

57583

}

57584

],

57585

"class": "DOM",

57586

"module": "dom"

57587

},

57588

{

57589

"file": "dom/js/dom-style.js",

57590

"line": 49,

57591

"description": "Sets a style property for a given element.",

57592

"itemtype": "method",

57593

"name": "setStyle",

57594

"params": [

57595

{

57596

"name": "An",

57597

"description": "HTMLElement to apply the style to.",

57598

"type": "HTMLElement"

57599

},

57600

{

57601

"name": "att",

57602

"description": "The style property to set.",

57603

"type": "String"

57604

},

57605

{

57606

"name": "val",

57607

"description": "The value.",

57608

"type": "String|Number"

57609

}

57610

],

57611

"class": "DOM",

57612

"module": "dom",

57613

"submodule": "dom-style"

57614

},

57615

{

57616

"file": "dom/js/dom-style.js",

57617

"line": 82,

57618

"description": "Returns the current style value for the given property.",

57619

"itemtype": "method",

57620

"name": "getStyle",

57621

"params": [

57622

{

57623

"name": "An",

57624

"description": "HTMLElement to get the style from.",

57625

"type": "HTMLElement"

57626

},

57627

{

57628

"name": "att",

57629

"description": "The style property to get.",

57630

"type": "String"

57631

}

57632

],

57633

"class": "DOM",

57634

"module": "dom",

57635

"submodule": "dom-style"

57636

},

57637

{

57638

"file": "dom/js/dom-style.js",

57639

"line": 110,

57640

"description": "Sets multiple style properties.",

57641

"itemtype": "method",

57642

"name": "setStyles",

57643

"params": [

57644

{

57645

"name": "node",

57646

"description": "An HTMLElement to apply the styles to.",

57647

"type": "HTMLElement"

57648

},

57649

{

57650

"name": "hash",

57651

"description": "An object literal of property:value pairs.",

57652

"type": "Object"

57653

}

57654

],

57655

"class": "DOM",

57656

"module": "dom",

57657

"submodule": "dom-style"

57658

},

57659

{

57660

"file": "dom/js/dom-style.js",

57661

"line": 123,

57662

"description": "Returns the computed style for the given node.",

57663

"itemtype": "method",

57664

"name": "getComputedStyle",

57665

"params": [

57666

{

57667

"name": "An",

57668

"description": "HTMLElement to get the style from.",

57669

"type": "HTMLElement"

57670

},

57671

{

57672

"name": "att",

57673

"description": "The style property to get.",

57674

"type": "String"

57675

}

57676

],

57677

"return": {

57678

"description": "The computed value of the style property.",

57679

"type": "String"

57680

},

57681

"class": "DOM",

57682

"module": "dom",

57683

"submodule": "dom-style"

57684

},

57685

{

57686

"file": "dom/js/selector-css2.js",

57687

"line": 30,

57688

"description": "Mapping of shorthand tokens to corresponding attribute selector",

57689

"itemtype": "property",

57690

"name": "shorthand",

57691

"type": "object",

57692

"class": "Selector",

57693

"module": "dom",

57694

"submodule": "selector-css2"

57695

},

57696

{

57697

"file": "dom/js/selector-css2.js",

57698

"line": 40,

57699

"description": "List of operators and corresponding boolean functions. \nThese functions are passed the attribute and the current node's value of the attribute.",

57700

"itemtype": "property",

57701

"name": "operators",

57702

"type": "object",

57703

"class": "Selector",

57704

"module": "dom",

57705

"submodule": "selector-css2"

57706

},

57707

{

57708

"file": "dom/js/selector-native.js",

57709

"line": 113,

57710

"description": "Retrieves a set of nodes based on a given CSS selector.",

57711

"itemtype": "method",

57712

"name": "query",

57713

"params": [

57714

{

57715

"name": "selector",

57716

"description": "The CSS Selector to test the node against.",

57717

"type": "String"

57718

},

57719

{

57720

"name": "root",

57721

"description": "optional An HTMLElement to start the query from. Defaults to Y.config.doc",

57722

"type": "HTMLElement"

57723

},

57724

{

57725

"name": "firstOnly",

57726

"description": "optional Whether or not to return only the first match.",

57727

"type": "Boolean"

57728

}

57729

],

57730

"return": {

57731

"description": "An array of nodes that match the given selector.",

57732

"type": "Array"

57733

},

57734

"static": 1,

57735

"class": "Selector",

57736

"module": "dom",

57737

"submodule": "selector-native"

57738

},

57739

{

57740

"file": "dom/js/selector-native.js",

57741

"line": 332,

57742

"description": "A convenience function to emulate Y.Node's aNode.ancestor(selector).",

57743

"params": [

57744

{

57745

"name": "element",

57746

"description": "An HTMLElement to start the query from.",

57747

"type": "HTMLElement"

57748

},

57749

{

57750

"name": "selector",

57751

"description": "The CSS selector to test the node against.",

57752

"type": "String"

57753

},

57754

{

57755

"name": "testSelf",

57756

"description": "optional Whether or not to include the element in the scan",

57757

"type": "Boolean"

57758

}

57759

],

57760

"return": {

57761

"description": "The ancestor node matching the selector, or null.",

57762

"type": "HTMLElement"

57763

},

57764

"static": 1,

57765

"itemtype": "method",

57766

"name": "ancestor",

57767

"class": "Selector",

57768

"module": "dom",

57769

"submodule": "selector-native"

57770

},

57771

{

57772

"file": "dump/js/dump.js",

57773

"line": 18,

57774

"description": "Returns a simple string representation of the object or array.\nOther types of objects will be returned unprocessed. Arrays\nare expected to be indexed.",

57775

"itemtype": "method",

57776

"name": "dump",

57777

"params": [

57778

{

57779

"name": "o",

57780

"description": "The object to dump.",

57781

"type": "Object"

57782

},

57783

{

57784

"name": "d",

57785

"description": "How deep to recurse child objects, default 3.",

57786

"type": "Number"

57787

}

57788

],

57789

"return": {

57790

"description": "the dump result.",

57791

"type": "String"

57792

},

57793

"class": "YUI",

57794

"module": "dump"

57795

},

57796

{

57797

"file": "editor/js/createlink-base.js",

57798

"line": 11,

57799

"description": "Strings used by the plugin",

57800

"itemtype": "property",

57801

"name": "STRINGS",

57802

"static": 1,

57803

"class": "Plugin.CreateLinkBase",

57804

"module": "editor"

57805

},

57806

{

57807

"file": "editor/js/createlink-base.js",

57808

"line": 17,

57809

"description": "String used for the Prompt",

57810

"itemtype": "property",

57811

"name": "PROMPT",

57812

"static": 1,

57813

"class": "Plugin.CreateLinkBase",

57814

"module": "editor"

57815

},

57816

{

57817

"file": "editor/js/createlink-base.js",

57818

"line": 23,

57819

"description": "String used as the default value of the Prompt",

57820

"itemtype": "property",

57821

"name": "DEFAULT",

57822

"static": 1,

57823

"class": "Plugin.CreateLinkBase",

57824

"module": "editor"

57825

},

57826

{

57827

"file": "editor/js/createlink-base.js",

57828

"line": 35,

57829

"description": "Override for the createlink method from the <a href=\"Plugin.CreateLinkBase.html\">CreateLinkBase</a> plugin.",

57830

"itemtype": "method",

57831

"name": "COMMANDS.createlink",

57832

"static": 1,

57833

"params": [

57834

{

57835

"name": "cmd",

57836

"description": "The command executed: createlink",

57837

"type": "String"

57838

}

57839

],

57840

"return": {

57841

"description": "Node instance of the item touched by this command.",

57842

"type": "Node"

57843

},

57844

"class": "ExecCommand",

57845

"module": "editor"

57846

},

57847

{

57848

"file": "editor/js/editor-base.js",

57849

"line": 23,

57850

"description": "Internal reference to the Y.Frame instance",

57851

"itemtype": "property",

57852

"name": "frame",

57853

"class": "EditorBase",

57854

"module": "editor",

57855

"submodule": "editor-base"

57856

},

57857

{

57858

"file": "editor/js/editor-base.js",

57859

"line": 59,

57860

"description": "Copy certain styles from one node instance to another (used for new paragraph creation mainly)",

57861

"itemtype": "method",

57862

"name": "copyStyles",

57863

"params": [

57864

{

57865

"name": "from",

57866

"description": "The Node instance to copy the styles from",

57867

"type": "Node"

57868

},

57869

{

57870

"name": "to",

57871

"description": "The Node instance to copy the styles to",

57872

"type": "Node"

57873

}

57874

],

57875

"class": "EditorBase",

57876

"module": "editor",

57877

"submodule": "editor-base"

57878

},

57879

{

57880

"file": "editor/js/editor-base.js",

57881

"line": 86,

57882

"description": "Holder for the selection bookmark in IE.",

57883

"itemtype": "property",

57884

"name": "_lastBookmark",

57885

"access": "private",

57886

"tagname": "",

57887

"class": "EditorBase",

57888

"module": "editor",

57889

"submodule": "editor-base"

57890

},

57891

{

57892

"file": "editor/js/editor-base.js",

57893

"line": 92,

57894

"description": "Resolves the e.changedNode in the nodeChange event if it comes from the document. If\nthe event came from the document, it will get the last child of the last child of the document\nand return that instead.",

57895

"itemtype": "method",

57896

"name": "_resolveChangedNode",

57897

"params": [

57898

{

57899

"name": "n",

57900

"description": "The node to resolve",

57901

"type": "Node"

57902

}

57903

],

57904

"access": "private",

57905

"tagname": "",

57906

"class": "EditorBase",

57907

"module": "editor",

57908

"submodule": "editor-base"

57909

},

57910

{

57911

"file": "editor/js/editor-base.js",

57912

"line": 141,

57913

"description": "The default handler for the nodeChange event.",

57914

"itemtype": "method",

57915

"name": "_defNodeChangeFn",

57916

"params": [

57917

{

57918

"name": "e",

57919

"description": "The event",

57920

"type": "Event"

57921

}

57922

],

57923

"access": "private",

57924

"tagname": "",

57925

"class": "EditorBase",

57926

"module": "editor",

57927

"submodule": "editor-base"

57928

},

57929

{

57930

"file": "editor/js/editor-base.js",

57931

"line": 313,

57932

"description": "Walk the dom tree from this node up to body, returning a reversed array of parents.",

57933

"itemtype": "method",

57934

"name": "getDomPath",

57935

"params": [

57936

{

57937

"name": "node",

57938

"description": "The Node to start from",

57939

"type": "Node"

57940

}

57941

],

57942

"class": "EditorBase",

57943

"module": "editor",

57944

"submodule": "editor-base"

57945

},

57946

{

57947

"file": "editor/js/editor-base.js",

57948

"line": 385,

57949

"description": "After frame ready, bind mousedown & keyup listeners",

57950

"itemtype": "method",

57951

"name": "_afterFrameReady",

57952

"access": "private",

57953

"tagname": "",

57954

"class": "EditorBase",

57955

"module": "editor",

57956

"submodule": "editor-base"

57957

},

57958

{

57959

"file": "editor/js/editor-base.js",

57960

"line": 408,

57961

"description": "Caches the current cursor position in IE.",

57962

"itemtype": "method",

57963

"name": "_beforeFrameDeactivate",

57964

"access": "private",

57965

"tagname": "",

57966

"class": "EditorBase",

57967

"module": "editor",

57968

"submodule": "editor-base"

57969

},

57970

{

57971

"file": "editor/js/editor-base.js",

57972

"line": 424,

57973

"description": "Moves the cached selection bookmark back so IE can place the cursor in the right place.",

57974

"itemtype": "method",

57975

"name": "_onFrameActivate",

57976

"access": "private",

57977

"tagname": "",

57978

"class": "EditorBase",

57979

"module": "editor",

57980

"submodule": "editor-base"

57981

},

57982

{

57983

"file": "editor/js/editor-base.js",

57984

"line": 456,

57985

"description": "Fires nodeChange event",

57986

"itemtype": "method",

57987

"name": "_onPaste",

57988

"access": "private",

57989

"tagname": "",

57990

"class": "EditorBase",

57991

"module": "editor",

57992

"submodule": "editor-base"

57993

},

57994

{

57995

"file": "editor/js/editor-base.js",

57996

"line": 464,

57997

"description": "Fires nodeChange event",

57998

"itemtype": "method",

57999

"name": "_onFrameMouseUp",

58000

"access": "private",

58001

"tagname": "",

58002

"class": "EditorBase",

58003

"module": "editor",

58004

"submodule": "editor-base"

58005

},

58006

{

58007

"file": "editor/js/editor-base.js",

58008

"line": 472,

58009

"description": "Fires nodeChange event",

58010

"itemtype": "method",

58011

"name": "_onFrameMouseDown",

58012

"access": "private",

58013

"tagname": "",

58014

"class": "EditorBase",

58015

"module": "editor",

58016

"submodule": "editor-base"

58017

},

58018

{

58019

"file": "editor/js/editor-base.js",

58020

"line": 480,

58021

"description": "Caches a copy of the selection for key events. Only creating the selection on keydown",

58022

"itemtype": "property",

58023

"name": "_currentSelection",

58024

"access": "private",

58025

"tagname": "",

58026

"class": "EditorBase",

58027

"module": "editor",

58028

"submodule": "editor-base"

58029

},

58030

{

58031

"file": "editor/js/editor-base.js",

58032

"line": 486,

58033

"description": "Holds the timer for selection clearing",

58034

"itemtype": "property",

58035

"name": "_currentSelectionTimer",

58036

"access": "private",

58037

"tagname": "",

58038

"class": "EditorBase",

58039

"module": "editor",

58040

"submodule": "editor-base"

58041

},

58042

{

58043

"file": "editor/js/editor-base.js",

58044

"line": 492,

58045

"description": "Flag to determine if we can clear the selection or not.",

58046

"itemtype": "property",

58047

"name": "_currentSelectionClear",

58048

"access": "private",

58049

"tagname": "",

58050

"class": "EditorBase",

58051

"module": "editor",

58052

"submodule": "editor-base"

58053

},

58054

{

58055

"file": "editor/js/editor-base.js",

58056

"line": 498,

58057

"description": "Fires nodeChange event",

58058

"itemtype": "method",

58059

"name": "_onFrameKeyDown",

58060

"access": "private",

58061

"tagname": "",

58062

"class": "EditorBase",

58063

"module": "editor",

58064

"submodule": "editor-base"

58065

},

58066

{

58067

"file": "editor/js/editor-base.js",

58068

"line": 534,

58069

"description": "Fires nodeChange event",

58070

"itemtype": "method",

58071

"name": "_onFrameKeyPress",

58072

"access": "private",

58073

"tagname": "",

58074

"class": "EditorBase",

58075

"module": "editor",

58076

"submodule": "editor-base"

58077

},

58078

{

58079

"file": "editor/js/editor-base.js",

58080

"line": 549,

58081

"description": "Fires nodeChange event for keyup on specific keys",

58082

"itemtype": "method",

58083

"name": "_onFrameKeyUp",

58084

"access": "private",

58085

"tagname": "",

58086

"class": "EditorBase",

58087

"module": "editor",

58088

"submodule": "editor-base"

58089

},

58090

{

58091

"file": "editor/js/editor-base.js",

58092

"line": 568,

58093

"description": "Pass through to the frame.execCommand method",

58094

"itemtype": "method",

58095

"name": "execCommand",

58096

"params": [

58097

{

58098

"name": "cmd",

58099

"description": "The command to pass: inserthtml, insertimage, bold",

58100

"type": "String"

58101

},

58102

{

58103

"name": "val",

58104

"description": "The optional value of the command: Helvetica",

58105

"type": "String"

58106

}

58107

],

58108

"return": {

58109

"description": "The Node or Nodelist affected by the command. Only returns on override commands, not browser defined commands.",

58110

"type": "Node/NodeList"

58111

},

58112

"class": "EditorBase",

58113

"module": "editor",

58114

"submodule": "editor-base"

58115

},

58116

{

58117

"file": "editor/js/editor-base.js",

58118

"line": 603,

58119

"description": "Get the YUI instance of the frame",

58120

"itemtype": "method",

58121

"name": "getInstance",

58122

"return": {

58123

"description": "The YUI instance bound to the frame.",

58124

"type": "YUI"

58125

},

58126

"class": "EditorBase",

58127

"module": "editor",

58128

"submodule": "editor-base"

58129

},

58130

{

58131

"file": "editor/js/editor-base.js",

58132

"line": 611,

58133

"description": "Renders the Y.Frame to the passed node.",

58134

"itemtype": "method",

58135

"name": "render",

58136

"params": [

58137

{

58138

"name": "node",

58139

"description": "The node to append the Editor to",

58140

"type": "Selector/HTMLElement/Node"

58141

}

58142

],

58143

"return": {

58144

"description": "",

58145

"type": "EditorBase"

58146

},

58147

"chainable": 1,

58148

"class": "EditorBase",

58149

"module": "editor",

58150

"submodule": "editor-base"

58151

},

58152

{

58153

"file": "editor/js/editor-base.js",

58154

"line": 623,

58155

"description": "Focus the contentWindow of the iframe",

58156

"itemtype": "method",

58157

"name": "focus",

58158

"params": [

58159

{

58160

"name": "fn",

58161

"description": "Callback function to execute after focus happens",

58162

"type": "Function"

58163

}

58164

],

58165

"return": {

58166

"description": "",

58167

"type": "EditorBase"

58168

},

58169

"chainable": 1,

58170

"class": "EditorBase",

58171

"module": "editor",

58172

"submodule": "editor-base"

58173

},

58174

{

58175

"file": "editor/js/editor-base.js",

58176

"line": 634,

58177

"description": "Handles the showing of the Editor instance. Currently only handles the iframe",

58178

"itemtype": "method",

58179

"name": "show",

58180

"return": {

58181

"description": "",

58182

"type": "EditorBase"

58183

},

58184

"chainable": 1,

58185

"class": "EditorBase",

58186

"module": "editor",

58187

"submodule": "editor-base"

58188

},

58189

{

58190

"file": "editor/js/editor-base.js",

58191

"line": 644,

58192

"description": "Handles the hiding of the Editor instance. Currently only handles the iframe",

58193

"itemtype": "method",

58194

"name": "hide",

58195

"return": {

58196

"description": "",

58197

"type": "EditorBase"

58198

},

58199

"chainable": 1,

58200

"class": "EditorBase",

58201

"module": "editor",

58202

"submodule": "editor-base"

58203

},

58204

{

58205

"file": "editor/js/editor-base.js",

58206

"line": 654,

58207

"description": "(Un)Filters the content of the Editor, cleaning YUI related code. //TODO better filtering",

58208

"itemtype": "method",

58209

"name": "getContent",

58210

"return": {

58211

"description": "The filtered content of the Editor",

58212

"type": "String"

58213

},

58214

"class": "EditorBase",

58215

"module": "editor",

58216

"submodule": "editor-base"

58217

},

58218

{

58219

"file": "editor/js/editor-base.js",

58220

"line": 669,

58221

"static": 1,

58222

"itemtype": "method",

58223

"name": "NORMALIZE_FONTSIZE",

58224

"description": "Pulls the fontSize from a node, then checks for string values (x-large, x-small)\nand converts them to pixel sizes. If the parsed size is different from the original, it calls\nnode.setStyle to update the node with a pixel size for normalization.",

58225

"class": "EditorBase",

58226

"module": "editor",

58227

"submodule": "editor-base"

58228

},

58229

{

58230

"file": "editor/js/editor-base.js",

58231

"line": 707,

58232

"static": 1,

58233

"itemtype": "property",

58234

"name": "TABKEY",

58235

"description": "The HTML markup to use for the tabkey",

58236

"class": "EditorBase",

58237

"module": "editor",

58238

"submodule": "editor-base"

58239

},

58240

{

58241

"file": "editor/js/editor-base.js",

58242

"line": 713,

58243

"static": 1,

58244

"itemtype": "method",

58245

"name": "FILTER_RGB",

58246

"params": [

58247

{

58248

"name": "String",

58249

"description": "css The CSS string containing rgb(#,#,#);"

58250

}

58251

],

58252

"description": "Converts an RGB color string to a hex color, example: rgb(0, 255, 0) converts to #00ff00",

58253

"return": {

58254

"description": "String"

58255

},

58256

"class": "EditorBase",

58257

"module": "editor",

58258

"submodule": "editor-base"

58259

},

58260

{

58261

"file": "editor/js/editor-base.js",

58262

"line": 739,

58263

"static": 1,

58264

"itemtype": "property",

58265

"name": "TAG2CMD",

58266

"description": "A hash table of tags to their execcomand's",

58267

"class": "EditorBase",

58268

"module": "editor",

58269

"submodule": "editor-base"

58270

},

58271

{

58272

"file": "editor/js/editor-base.js",

58273

"line": 757,

58274

"description": "Hash table of keys to fire a nodeChange event for.",

58275

"static": 1,

58276

"itemtype": "property",

58277

"name": "NC_KEYS",

58278

"type": "Object",

58279

"class": "EditorBase",

58280

"module": "editor",

58281

"submodule": "editor-base"

58282

},

58283

{

58284

"file": "editor/js/editor-base.js",

58285

"line": 778,

58286

"description": "The default modules to use inside the Frame",

58287

"static": 1,

58288

"itemtype": "property",

58289

"name": "USE",

58290

"type": "Array",

58291

"class": "EditorBase",

58292

"module": "editor",

58293

"submodule": "editor-base"

58294

},

58295

{

58296

"file": "editor/js/editor-base.js",

58297

"line": 785,

58298

"description": "The Class Name: editorBase",

58299

"static": 1,

58300

"itemtype": "property",

58301

"name": "NAME",

58302

"class": "EditorBase",

58303

"module": "editor",

58304

"submodule": "editor-base"

58305

},

58306

{

58307

"file": "editor/js/editor-base.js",

58308

"line": 791,

58309

"description": "Editor Strings. By default contains only the `title` property for the\nTitle of frame document (default \"Rich Text Editor\").",

58310

"static": 1,

58311

"itemtype": "property",

58312

"name": "STRINGS",

58313

"class": "EditorBase",

58314

"module": "editor",

58315

"submodule": "editor-base"

58316

},

58317

{

58318

"file": "editor/js/editor-base.js",

58319

"line": 802,

58320

"description": "The content to load into the Editor Frame",

58321

"itemtype": "attribute",

58322

"name": "content",

58323

"class": "EditorBase",

58324

"module": "editor",

58325

"submodule": "editor-base"

58326

},

58327

{

58328

"file": "editor/js/editor-base.js",

58329

"line": 827,

58330

"description": "The value of the dir attribute on the HTML element of the frame. Default: ltr",

58331

"itemtype": "attribute",

58332

"name": "dir",

58333

"class": "EditorBase",

58334

"module": "editor",

58335

"submodule": "editor-base"

58336

},

58337

{

58338

"file": "editor/js/editor-base.js",

58339

"line": 835,

58340

"itemtype": "attribute",

58341

"name": "linkedcss",

58342

"description": "An array of url's to external linked style sheets",

58343

"type": "String",

58344

"class": "EditorBase",

58345

"module": "editor",

58346

"submodule": "editor-base"

58347

},

58348

{

58349

"file": "editor/js/editor-base.js",

58350

"line": 849,

58351

"itemtype": "attribute",

58352

"name": "extracss",

58353

"description": "A string of CSS to add to the Head of the Editor",

58354

"type": "String",

58355

"class": "EditorBase",

58356

"module": "editor",

58357

"submodule": "editor-base"

58358

},

58359

{

58360

"file": "editor/js/editor-base.js",

58361

"line": 863,

58362

"itemtype": "attribute",

58363

"name": "defaultblock",

58364

"description": "The default tag to use for block level items, defaults to: p",

58365

"type": "String",

58366

"class": "EditorBase",

58367

"module": "editor",

58368

"submodule": "editor-base"

58369

},

58370

{

58371

"file": "editor/js/editor-base.js",

58372

"line": 876,

58373

"itemtype": "event",

58374

"name": "nodeChange",

58375

"description": "Fired from several mouse/key/paste event points.",

58376

"params": [

58377

{

58378

"name": "event",

58379

"description": "An Event Facade object with the following specific properties added:\n<dl>\n <dt>changedEvent</dt><dd>The event that caused the nodeChange</dd>\n <dt>changedNode</dt><dd>The node that was interacted with</dd>\n <dt>changedType</dt><dd>The type of change: mousedown, mouseup, right, left, backspace, tab, enter, etc..</dd>\n <dt>commands</dt><dd>The list of execCommands that belong to this change and the dompath that's associated with the changedNode</dd>\n <dt>classNames</dt><dd>An array of classNames that are applied to the changedNode and all of it's parents</dd>\n <dt>dompath</dt><dd>A sorted array of node instances that make up the DOM path from the changedNode to body.</dd>\n <dt>backgroundColor</dt><dd>The cascaded backgroundColor of the changedNode</dd>\n <dt>fontColor</dt><dd>The cascaded fontColor of the changedNode</dd>\n <dt>fontFamily</dt><dd>The cascaded fontFamily of the changedNode</dd>\n <dt>fontSize</dt><dd>The cascaded fontSize of the changedNode</dd>\n</dl>",

58380

"type": "Event.Facade"

58381

}

58382

],

58383

"type": "{Event.Custom}",

58384

"class": "EditorBase",

58385

"module": "editor",

58386

"submodule": "editor-base"

58387

},

58388

{

58389

"file": "editor/js/editor-base.js",

58390

"line": 895,

58391

"itemtype": "event",

58392

"name": "ready",

58393

"description": "Fired after the frame is ready.",

58394

"params": [

58395

{

58396

"name": "event",

58397

"description": "An Event Facade object.",

58398

"type": "Event.Facade"

58399

}

58400

],

58401

"type": "{Event.Custom}",

58402

"class": "EditorBase",

58403

"module": "editor",

58404

"submodule": "editor-base"

58405

},

58406

{

58407

"file": "editor/js/editor-bidi.js",

58408

"line": 18,

58409

"description": "Place holder for the last direction when checking for a switch",

58410

"access": "private",

58411

"tagname": "",

58412

"itemtype": "property",

58413

"name": "lastDirection",

58414

"class": "Plugin.EditorBidi",

58415

"module": "editor",

58416

"submodule": "editor-bidi"

58417

},

58418

{

58419

"file": "editor/js/editor-bidi.js",

58420

"line": 24,

58421

"description": "Tells us that an initial bidi check has already been performed",

58422

"access": "private",

58423

"tagname": "",

58424

"itemtype": "property",

58425

"name": "firstEvent",

58426

"class": "Plugin.EditorBidi",

58427

"module": "editor",

58428

"submodule": "editor-bidi"

58429

},

58430

{

58431

"file": "editor/js/editor-bidi.js",

58432

"line": 31,

58433

"description": "Method checks to see if the direction of the text has changed based on a nodeChange event.",

58434

"access": "private",

58435

"tagname": "",

58436

"itemtype": "method",

58437

"name": "_checkForChange",

58438

"class": "Plugin.EditorBidi",

58439

"module": "editor",

58440

"submodule": "editor-bidi"

58441

},

58442

{

58443

"file": "editor/js/editor-bidi.js",

58444

"line": 57,

58445

"description": "Checked for a change after a specific nodeChange event has been fired.",

58446

"access": "private",

58447

"tagname": "",

58448

"itemtype": "method",

58449

"name": "_afterNodeChange",

58450

"class": "Plugin.EditorBidi",

58451

"module": "editor",

58452

"submodule": "editor-bidi"

58453

},

58454

{

58455

"file": "editor/js/editor-bidi.js",

58456

"line": 70,

58457

"description": "Checks for a direction change after a mouseup occurs.",

58458

"access": "private",

58459

"tagname": "",

58460

"itemtype": "method",

58461

"name": "_afterMouseUp",

58462

"class": "Plugin.EditorBidi",

58463

"module": "editor",

58464

"submodule": "editor-bidi"

58465

},

58466

{

58467

"file": "editor/js/editor-bidi.js",

58468

"line": 88,

58469

"description": "The events to check for a direction change on",

58470

"itemtype": "property",

58471

"name": "EVENTS",

58472

"static": 1,

58473

"class": "Plugin.EditorBidi",

58474

"module": "editor",

58475

"submodule": "editor-bidi"

58476

},

58477

{

58478

"file": "editor/js/editor-bidi.js",

58479

"line": 106,

58480

"description": "More elements may be needed. BODY *must* be in the list to take care of the special case.\n\nblockParent could be changed to use inst.EditorSelection.BLOCKS\ninstead, but that would make Y.Plugin.EditorBidi.blockParent\nunusable in non-RTE contexts (it being usable is a nice\nside-effect).",

58481

"itemtype": "property",

58482

"name": "BLOCKS",

58483

"static": 1,

58484

"class": "Plugin.EditorBidi",

58485

"module": "editor",

58486

"submodule": "editor-bidi"

58487

},

58488

{

58489

"file": "editor/js/editor-bidi.js",

58490

"line": 118,

58491

"description": "Template for creating a block element",

58492

"static": 1,

58493

"itemtype": "property",

58494

"name": "DIV_WRAPPER",

58495

"class": "Plugin.EditorBidi",

58496

"module": "editor",

58497

"submodule": "editor-bidi"

58498

},

58499

{

58500

"file": "editor/js/editor-bidi.js",

58501

"line": 124,

58502

"description": "Returns a block parent for a given element",

58503

"static": 1,

58504

"itemtype": "method",

58505

"name": "blockParent",

58506

"class": "Plugin.EditorBidi",

58507

"module": "editor",

58508

"submodule": "editor-bidi"

58509

},

58510

{

58511

"file": "editor/js/editor-bidi.js",

58512

"line": 160,

58513

"description": "The data key to store on the node.",

58514

"static": 1,

58515

"itemtype": "property",

58516

"name": "_NODE_SELECTED",

58517

"class": "Plugin.EditorBidi",

58518

"module": "editor",

58519

"submodule": "editor-bidi"

58520

},

58521

{

58522

"file": "editor/js/editor-bidi.js",

58523

"line": 166,

58524

"description": "Generates a list of all the block parents of the current NodeList",

58525

"static": 1,

58526

"itemtype": "method",

58527

"name": "addParents",

58528

"class": "Plugin.EditorBidi",

58529

"module": "editor",

58530

"submodule": "editor-bidi"

58531

},

58532

{

58533

"file": "editor/js/editor-bidi.js",

58534

"line": 212,

58535

"description": "editorBidi",

58536

"static": 1,

58537

"itemtype": "property",

58538

"name": "NAME",

58539

"class": "Plugin.EditorBidi",

58540

"module": "editor",

58541

"submodule": "editor-bidi"

58542

},

58543

{

58544

"file": "editor/js/editor-bidi.js",

58545

"line": 218,

58546

"description": "editorBidi",

58547

"static": 1,

58548

"itemtype": "property",

58549

"name": "NS",

58550

"class": "Plugin.EditorBidi",

58551

"module": "editor",

58552

"submodule": "editor-bidi"

58553

},

58554

{

58555

"file": "editor/js/editor-bidi.js",

58556

"line": 229,

58557

"description": "Regex for testing/removing text-align style from an element",

58558

"static": 1,

58559

"itemtype": "property",

58560

"name": "RE_TEXT_ALIGN",

58561

"class": "Plugin.EditorBidi",

58562

"module": "editor",

58563

"submodule": "editor-bidi"

58564

},

58565

{

58566

"file": "editor/js/editor-bidi.js",

58567

"line": 235,

58568

"description": "Method to test a node's style attribute for text-align and removing it.",

58569

"static": 1,

58570

"itemtype": "method",

58571

"name": "removeTextAlign",

58572

"class": "Plugin.EditorBidi",

58573

"module": "editor",

58574

"submodule": "editor-bidi"

58575

},

58576

{

58577

"file": "editor/js/editor-bidi.js",

58578

"line": 257,

58579

"description": "bidi execCommand override for setting the text direction of a node.\nThis property is added to the `Y.Plugin.ExecCommands.COMMANDS`\ncollection.",

58580

"itemtype": "property",

58581

"name": "bidi",

58582

"class": "Plugin.ExecCommand",

58583

"module": "editor",

58584

"submodule": "editor-bidi"

58585

},

58586

{

58587

"file": "editor/js/editor-br.js",

58588

"line": 19,

58589

"description": "Frame keyDown handler that normalizes BR's when pressing ENTER.",

58590

"access": "private",

58591

"tagname": "",

58592

"itemtype": "method",

58593

"name": "_onKeyDown",

58594

"class": "Plugin.EditorBR",

58595

"module": "editor",

58596

"submodule": "editor-br"

58597

},

58598

{

58599

"file": "editor/js/editor-br.js",

58600

"line": 51,

58601

"description": "Adds listeners for keydown in IE and Webkit. Also fires insertbeonreturn for supporting browsers.",

58602

"access": "private",

58603

"tagname": "",

58604

"itemtype": "method",

58605

"name": "_afterEditorReady",

58606

"class": "Plugin.EditorBR",

58607

"module": "editor",

58608

"submodule": "editor-br"

58609

},

58610

{

58611

"file": "editor/js/editor-br.js",

58612

"line": 66,

58613

"description": "Adds a nodeChange listener only for FF, in the event of a backspace or delete, it creates an empy textNode\ninserts it into the DOM after the e.changedNode, then removes it. Causing FF to redraw the content.",

58614

"access": "private",

58615

"tagname": "",

58616

"itemtype": "method",

58617

"name": "_onNodeChange",

58618

"params": [

58619

{

58620

"name": "e",

58621

"description": "The nodeChange event.",

58622

"type": "Event"

58623

}

58624

],

58625

"class": "Plugin.EditorBR",

58626

"module": "editor",

58627

"submodule": "editor-br"

58628

},

58629

{

58630

"file": "editor/js/editor-br.js",

58631

"line": 104,

58632

"description": "editorBR",

58633

"static": 1,

58634

"itemtype": "property",

58635

"name": "NAME",

58636

"class": "Plugin.EditorBR",

58637

"module": "editor",

58638

"submodule": "editor-br"

58639

},

58640

{

58641

"file": "editor/js/editor-br.js",

58642

"line": 110,

58643

"description": "editorBR",

58644

"static": 1,

58645

"itemtype": "property",

58646

"name": "NS",

58647

"class": "Plugin.EditorBR",

58648

"module": "editor",

58649

"submodule": "editor-br"

58650

},

58651

{

58652

"file": "editor/js/editor-para-base.js",

58653

"line": 19,

58654

"description": "Utility method to create an empty paragraph when the document is empty.",

58655

"access": "private",

58656

"tagname": "",

58657

"itemtype": "method",

58658

"name": "_fixFirstPara",

58659

"class": "Plugin.EditorParaBase",

58660

"module": "editor",

58661

"submodule": "editor-para-base"

58662

},

58663

{

58664

"file": "editor/js/editor-para-base.js",

58665

"line": 43,

58666

"description": "Performs a block element filter when the Editor is first ready",

58667

"access": "private",

58668

"tagname": "",

58669

"itemtype": "method",

58670

"name": "_afterEditorReady",

58671

"class": "Plugin.EditorParaBase",

58672

"module": "editor",

58673

"submodule": "editor-para-base"

58674

},

58675

{

58676

"file": "editor/js/editor-para-base.js",

58677

"line": 57,

58678

"description": "Performs a block element filter when the Editor after an content change",

58679

"access": "private",

58680

"tagname": "",

58681

"itemtype": "method",

58682

"name": "_afterContentChange",

58683

"class": "Plugin.EditorParaBase",

58684

"module": "editor",

58685

"submodule": "editor-para-base"

58686

},

58687

{

58688

"file": "editor/js/editor-para-base.js",

58689

"line": 68,

58690

"description": "Performs block/paste filtering after paste.",

58691

"access": "private",

58692

"tagname": "",

58693

"itemtype": "method",

58694

"name": "_afterPaste",

58695

"class": "Plugin.EditorParaBase",

58696

"module": "editor",

58697

"submodule": "editor-para-base"

58698

},

58699

{

58700

"file": "editor/js/editor-para-base.js",

58701

"line": 96,

58702

"description": "editorPara",

58703

"static": 1,

58704

"itemtype": "property",

58705

"name": "NAME",

58706

"class": "Plugin.EditorParaBase",

58707

"module": "editor",

58708

"submodule": "editor-para-base"

58709

},

58710

{

58711

"file": "editor/js/editor-para-base.js",

58712

"line": 102,

58713

"description": "editorPara",

58714

"static": 1,

58715

"itemtype": "property",

58716

"name": "NS",

58717

"class": "Plugin.EditorParaBase",

58718

"module": "editor",

58719

"submodule": "editor-para-base"

58720

},

58721

{

58722

"file": "editor/js/editor-para-ie.js",

58723

"line": 19,

58724

"description": "nodeChange handler to handle fixing an empty document.",

58725

"access": "private",

58726

"tagname": "",

58727

"itemtype": "method",

58728

"name": "_onNodeChange",

58729

"class": "Plugin.EditorParaIE",

58730

"module": "editor",

58731

"submodule": "editor-para-ie"

58732

},

58733

{

58734

"file": "editor/js/editor-para-ie.js",

58735

"line": 97,

58736

"description": "editorPara",

58737

"static": 1,

58738

"itemtype": "property",

58739

"name": "NAME",

58740

"class": "Plugin.EditorParaIE",

58741

"module": "editor",

58742

"submodule": "editor-para-ie"

58743

},

58744

{

58745

"file": "editor/js/editor-para-ie.js",

58746

"line": 103,

58747

"description": "editorPara",

58748

"static": 1,

58749

"itemtype": "property",

58750

"name": "NS",

58751

"class": "Plugin.EditorParaIE",

58752

"module": "editor",

58753

"submodule": "editor-para-ie"

58754

},

58755

{

58756

"file": "editor/js/editor-para.js",

58757

"line": 19,

58758

"description": "nodeChange handler to handle fixing an empty document.",

58759

"access": "private",

58760

"tagname": "",

58761

"itemtype": "method",

58762

"name": "_onNodeChange",

58763

"class": "Plugin.EditorPara",

58764

"module": "editor",

58765

"submodule": "editor-para"

58766

},

58767

{

58768

"file": "editor/js/editor-para.js",

58769

"line": 273,

58770

"description": "editorPara",

58771

"static": 1,

58772

"itemtype": "property",

58773

"name": "NAME",

58774

"class": "Plugin.EditorPara",

58775

"module": "editor",

58776

"submodule": "editor-para"

58777

},

58778

{

58779

"file": "editor/js/editor-para.js",

58780

"line": 279,

58781

"description": "editorPara",

58782

"static": 1,

58783

"itemtype": "property",

58784

"name": "NS",

58785

"class": "Plugin.EditorPara",

58786

"module": "editor",

58787

"submodule": "editor-para"

58788

},

58789

{

58790

"file": "editor/js/editor-selection.js",

58791

"line": 119,

58792

"description": "Utility method to remove dead font-family styles from an element.",

58793

"static": 1,

58794

"itemtype": "method",

58795

"name": "removeFontFamily",

58796

"class": "EditorSelection",

58797

"module": "editor",

58798

"submodule": "selection"

58799

},

58800

{

58801

"file": "editor/js/editor-selection.js",

58802

"line": 136,

58803

"description": "Performs a prefilter on all nodes in the editor. Looks for nodes with a style: fontFamily or font face\nIt then creates a dynamic class assigns it and removed the property. This is so that we don't lose\nthe fontFamily when selecting nodes.",

58804

"static": 1,

58805

"itemtype": "method",

58806

"name": "filter",

58807

"class": "EditorSelection",

58808

"module": "editor",

58809

"submodule": "selection"

58810

},

58811

{

58812

"file": "editor/js/editor-selection.js",

58813

"line": 241,

58814

"description": "Method attempts to replace all \"orphined\" text nodes in the main body by wrapping them with a . Called from filter.",

58815

"static": 1,

58816

"itemtype": "method",

58817

"name": "filterBlocks",

58818

"class": "EditorSelection",

58819

"module": "editor",

58820

"submodule": "selection"

58821

},

58822

{

58823

"file": "editor/js/editor-selection.js",

58824

"line": 344,

58825

"description": "Regular Expression used to find dead font-family styles",

58826

"static": 1,

58827

"itemtype": "property",

58828

"name": "REG_FONTFAMILY",

58829

"class": "EditorSelection",

58830

"module": "editor",

58831

"submodule": "selection"

58832

},

58833

{

58834

"file": "editor/js/editor-selection.js",

58835

"line": 351,

58836

"description": "Regular Expression to determine if a string has a character in it",

58837

"static": 1,

58838

"itemtype": "property",

58839

"name": "REG_CHAR",

58840

"class": "EditorSelection",

58841

"module": "editor",

58842

"submodule": "selection"

58843

},

58844

{

58845

"file": "editor/js/editor-selection.js",

58846

"line": 358,

58847

"description": "Regular Expression to determine if a string has a non-character in it",

58848

"static": 1,

58849

"itemtype": "property",

58850

"name": "REG_NON",

58851

"class": "EditorSelection",

58852

"module": "editor",

58853

"submodule": "selection"

58854

},

58855

{

58856

"file": "editor/js/editor-selection.js",

58857

"line": 365,

58858

"description": "Regular Expression to remove all HTML from a string",

58859

"static": 1,

58860

"itemtype": "property",

58861

"name": "REG_NOHTML",

58862

"class": "EditorSelection",

58863

"module": "editor",

58864

"submodule": "selection"

58865

},

58866

{

58867

"file": "editor/js/editor-selection.js",

58868

"line": 373,

58869

"description": "Wraps an array of elements in a Block level tag",

58870

"static": 1,

58871

"access": "private",

58872

"tagname": "",

58873

"itemtype": "method",

58874

"name": "_wrapBlock",

58875

"class": "EditorSelection",

58876

"module": "editor",

58877

"submodule": "selection"

58878

},

58879

{

58880

"file": "editor/js/editor-selection.js",

58881

"line": 393,

58882

"description": "Undoes what filter does enough to return the HTML from the Editor, then re-applies the filter.",

58883

"static": 1,

58884

"itemtype": "method",

58885

"name": "unfilter",

58886

"return": {

58887

"description": "The filtered HTML",

58888

"type": "String"

58889

},

58890

"class": "EditorSelection",

58891

"module": "editor",

58892

"submodule": "selection"

58893

},

58894

{

58895

"file": "editor/js/editor-selection.js",

58896

"line": 452,

58897

"description": "Resolve a node from the selection object and return a Node instance",

58898

"static": 1,

58899

"itemtype": "method",

58900

"name": "resolve",

58901

"params": [

58902

{

58903

"name": "n",

58904

"description": "The HTMLElement to resolve. Might be a TextNode, gives parentNode.",

58905

"type": "HTMLElement"

58906

}

58907

],

58908

"return": {

58909

"description": "The Resolved node",

58910

"type": "Node"

58911

},

58912

"class": "EditorSelection",

58913

"module": "editor",

58914

"submodule": "selection"

58915

},

58916

{

58917

"file": "editor/js/editor-selection.js",

58918

"line": 473,

58919

"description": "Returns the innerHTML of a node with all HTML tags removed.",

58920

"static": 1,

58921

"itemtype": "method",

58922

"name": "getText",

58923

"params": [

58924

{

58925

"name": "node",

58926

"description": "The Node instance to remove the HTML from",

58927

"type": "Node"

58928

}

58929

],

58930

"return": {

58931

"description": "The string of text",

58932

"type": "String"

58933

},

58934

"class": "EditorSelection",

58935

"module": "editor",

58936

"submodule": "selection"

58937

},

58938

{

58939

"file": "editor/js/editor-selection.js",

58940

"line": 490,

58941

"description": "The selector to use when looking for Nodes to cache the value of: [style],font[face]",

58942

"static": 1,

58943

"itemtype": "property",

58944

"name": "ALL",

58945

"class": "EditorSelection",

58946

"module": "editor",

58947

"submodule": "selection"

58948

},

58949

{

58950

"file": "editor/js/editor-selection.js",

58951

"line": 497,

58952

"description": "The selector to use when looking for block level items.",

58953

"static": 1,

58954

"itemtype": "property",

58955

"name": "BLOCKS",

58956

"class": "EditorSelection",

58957

"module": "editor",

58958

"submodule": "selection"

58959

},

58960

{

58961

"file": "editor/js/editor-selection.js",

58962

"line": 503,

58963

"description": "The temporary fontname applied to a selection to retrieve their values: yui-tmp",

58964

"static": 1,

58965

"itemtype": "property",

58966

"name": "TMP",

58967

"class": "EditorSelection",

58968

"module": "editor",

58969

"submodule": "selection"

58970

},

58971

{

58972

"file": "editor/js/editor-selection.js",

58973

"line": 509,

58974

"description": "The default tag to use when creating elements: span",

58975

"static": 1,

58976

"itemtype": "property",

58977

"name": "DEFAULT_TAG",

58978

"class": "EditorSelection",

58979

"module": "editor",

58980

"submodule": "selection"

58981

},

58982

{

58983

"file": "editor/js/editor-selection.js",

58984

"line": 516,

58985

"description": "The id of the outer cursor wrapper",

58986

"static": 1,

58987

"itemtype": "property",

58988

"name": "DEFAULT_TAG",

58989

"class": "EditorSelection",

58990

"module": "editor",

58991

"submodule": "selection"

58992

},

58993

{

58994

"file": "editor/js/editor-selection.js",

58995

"line": 523,

58996

"description": "The id used to wrap the inner space of the cursor position",

58997

"static": 1,

58998

"itemtype": "property",

58999

"name": "CUR_WRAPID",

59000

"class": "EditorSelection",

59001

"module": "editor",

59002

"submodule": "selection"

59003

},

59004

{

59005

"file": "editor/js/editor-selection.js",

59006

"line": 530,

59007

"description": "The default HTML used to focus the cursor..",

59008

"static": 1,

59009

"itemtype": "property",

59010

"name": "CURSOR",

59011

"class": "EditorSelection",

59012

"module": "editor",

59013

"submodule": "selection"

59014

},

59015

{

59016

"file": "editor/js/editor-selection.js",

59017

"line": 543,

59018

"description": "Called from Editor keydown to remove the \"extra\" space before the cursor.",

59019

"static": 1,

59020

"itemtype": "method",

59021

"name": "cleanCursor",

59022

"class": "EditorSelection",

59023

"module": "editor",

59024

"submodule": "selection"

59025

},

59026

{

59027

"file": "editor/js/editor-selection.js",

59028

"line": 581,

59029

"description": "Range text value",

59030

"itemtype": "property",

59031

"name": "text",

59032

"type": "String",

59033

"class": "EditorSelection",

59034

"module": "editor",

59035

"submodule": "selection"

59036

},

59037

{

59038

"file": "editor/js/editor-selection.js",

59039

"line": 587,

59040

"description": "Flag to show if the range is collapsed or not",

59041

"itemtype": "property",

59042

"name": "isCollapsed",

59043

"type": "Boolean",

59044

"class": "EditorSelection",

59045

"module": "editor",

59046

"submodule": "selection"

59047

},

59048

{

59049

"file": "editor/js/editor-selection.js",

59050

"line": 593,

59051

"description": "A Node instance of the parentNode of the anchorNode of the range",

59052

"itemtype": "property",

59053

"name": "anchorNode",

59054

"type": "Node",

59055

"class": "EditorSelection",

59056

"module": "editor",

59057

"submodule": "selection"

59058

},

59059

{

59060

"file": "editor/js/editor-selection.js",

59061

"line": 599,

59062

"description": "The offset from the range object",

59063

"itemtype": "property",

59064

"name": "anchorOffset",

59065

"type": "Number",

59066

"class": "EditorSelection",

59067

"module": "editor",

59068

"submodule": "selection"

59069

},

59070

{

59071

"file": "editor/js/editor-selection.js",

59072

"line": 605,

59073

"description": "A Node instance of the actual textNode of the range.",

59074

"itemtype": "property",

59075

"name": "anchorTextNode",

59076

"type": "Node",

59077

"class": "EditorSelection",

59078

"module": "editor",

59079

"submodule": "selection"

59080

},

59081

{

59082

"file": "editor/js/editor-selection.js",

59083

"line": 611,

59084

"description": "A Node instance of the parentNode of the focusNode of the range",

59085

"itemtype": "property",

59086

"name": "focusNode",

59087

"type": "Node",

59088

"class": "EditorSelection",

59089

"module": "editor",

59090

"submodule": "selection"

59091

},

59092

{

59093

"file": "editor/js/editor-selection.js",

59094

"line": 617,

59095

"description": "The offset from the range object",

59096

"itemtype": "property",

59097

"name": "focusOffset",

59098

"type": "Number",

59099

"class": "EditorSelection",

59100

"module": "editor",

59101

"submodule": "selection"

59102

},

59103

{

59104

"file": "editor/js/editor-selection.js",

59105

"line": 623,

59106

"description": "A Node instance of the actual textNode of the range.",

59107

"itemtype": "property",

59108

"name": "focusTextNode",

59109

"type": "Node",

59110

"class": "EditorSelection",

59111

"module": "editor",

59112

"submodule": "selection"

59113

},

59114

{

59115

"file": "editor/js/editor-selection.js",

59116

"line": 629,

59117

"description": "The actual Selection/Range object",

59118

"itemtype": "property",

59119

"name": "_selection",

59120

"access": "private",

59121

"tagname": "",

59122

"class": "EditorSelection",

59123

"module": "editor",

59124

"submodule": "selection"

59125

},

59126

{

59127

"file": "editor/js/editor-selection.js",

59128

"line": 635,

59129

"description": "Wrap an element, with another element",

59130

"access": "private",

59131

"tagname": "",

59132

"itemtype": "method",

59133

"name": "_wrap",

59134

"params": [

59135

{

59136

"name": "n",

59137

"description": "The node to wrap",

59138

"type": "HTMLElement"

59139

},

59140

{

59141

"name": "tag",

59142

"description": "The tag to use when creating the new element.",

59143

"type": "String"

59144

}

59145

],

59146

"return": {

59147

"description": "The wrapped node",

59148

"type": "HTMLElement"

59149

},

59150

"class": "EditorSelection",

59151

"module": "editor",

59152

"submodule": "selection"

59153

},

59154

{

59155

"file": "editor/js/editor-selection.js",

59156

"line": 650,

59157

"description": "Swap an element, with another element",

59158

"access": "private",

59159

"tagname": "",

59160

"itemtype": "method",

59161

"name": "_swap",

59162

"params": [

59163

{

59164

"name": "n",

59165

"description": "The node to swap",

59166

"type": "HTMLElement"

59167

},

59168

{

59169

"name": "tag",

59170

"description": "The tag to use when creating the new element.",

59171

"type": "String"

59172

}

59173

],

59174

"return": {

59175

"description": "The new node",

59176

"type": "HTMLElement"

59177

},

59178

"class": "EditorSelection",

59179

"module": "editor",

59180

"submodule": "selection"

59181

},

59182

{

59183

"file": "editor/js/editor-selection.js",

59184

"line": 664,

59185

"description": "Get all the nodes in the current selection. This method will actually perform a filter first.\nThen it calls doc.execCommand('fontname', null, 'yui-tmp') to touch all nodes in the selection.\nThe it compiles a list of all nodes affected by the execCommand and builds a NodeList to return.",

59186

"itemtype": "method",

59187

"name": "getSelected",

59188

"return": {

59189

"description": "A NodeList of all items in the selection.",

59190

"type": "NodeList"

59191

},

59192

"class": "EditorSelection",

59193

"module": "editor",

59194

"submodule": "selection"

59195

},

59196

{

59197

"file": "editor/js/editor-selection.js",

59198

"line": 688,

59199

"description": "Insert HTML at the current cursor position and return a Node instance of the newly inserted element.",

59200

"itemtype": "method",

59201

"name": "insertContent",

59202

"params": [

59203

{

59204

"name": "html",

59205

"description": "The HTML to insert.",

59206

"type": "String"

59207

}

59208

],

59209

"return": {

59210

"description": "The inserted Node.",

59211

"type": "Node"

59212

},

59213

"class": "EditorSelection",

59214

"module": "editor",

59215

"submodule": "selection"

59216

},

59217

{

59218

"file": "editor/js/editor-selection.js",

59219

"line": 697,

59220

"description": "Insert HTML at the current cursor position, this method gives you control over the text node to insert into and the offset where to put it.",

59221

"itemtype": "method",

59222

"name": "insertAtCursor",

59223

"params": [

59224

{

59225

"name": "html",

59226

"description": "The HTML to insert.",

59227

"type": "String"

59228

},

59229

{

59230

"name": "node",

59231

"description": "The text node to break when inserting.",

59232

"type": "Node"

59233

},

59234

{

59235

"name": "offset",

59236

"description": "The left offset of the text node to break and insert the new content.",

59237

"type": "Number"

59238

},

59239

{

59240

"name": "collapse",

59241

"description": "Should the range be collapsed after insertion. default: false",

59242

"type": "Boolean"

59243

}

59244

],

59245

"return": {

59246

"description": "The inserted Node.",

59247

"type": "Node"

59248

},

59249

"class": "EditorSelection",

59250

"module": "editor",

59251

"submodule": "selection"

59252

},

59253

{

59254

"file": "editor/js/editor-selection.js",

59255

"line": 806,

59256

"description": "Get all elements inside a selection and wrap them with a new element and return a NodeList of all elements touched.",

59257

"itemtype": "method",

59258

"name": "wrapContent",

59259

"params": [

59260

{

59261

"name": "tag",

59262

"description": "The tag to wrap all selected items with.",

59263

"type": "String"

59264

}

59265

],

59266

"return": {

59267

"description": "A NodeList of all items in the selection.",

59268

"type": "NodeList"

59269

},

59270

"class": "EditorSelection",

59271

"module": "editor",

59272

"submodule": "selection"

59273

},

59274

{

59275

"file": "editor/js/editor-selection.js",

59276

"line": 857,

59277

"description": "Find and replace a string inside a text node and replace it with HTML focusing the node after \nto allow you to continue to type.",

59278

"itemtype": "method",

59279

"name": "replace",

59280

"params": [

59281

{

59282

"name": "se",

59283

"description": "The string to search for.",

59284

"type": "String"

59285

},

59286

{

59287

"name": "re",

59288

"description": "The string of HTML to replace it with.",

59289

"type": "String"

59290

}

59291

],

59292

"return": {

59293

"description": "The node inserted.",

59294

"type": "Node"

59295

},

59296

"class": "EditorSelection",

59297

"module": "editor",

59298

"submodule": "selection"

59299

},

59300

{

59301

"file": "editor/js/editor-selection.js",

59302

"line": 886,

59303

"description": "Destroy the range.",

59304

"itemtype": "method",

59305

"name": "remove",

59306

"chainable": 1,

59307

"return": {

59308

"description": "",

59309

"type": "EditorSelection"

59310

},

59311

"class": "EditorSelection",

59312

"module": "editor",

59313

"submodule": "selection"

59314

},

59315

{

59316

"file": "editor/js/editor-selection.js",

59317

"line": 898,

59318

"description": "Wrapper for the different range creation methods.",

59319

"itemtype": "method",

59320

"name": "createRange",

59321

"return": {

59322

"description": "",

59323

"type": "RangeObject"

59324

},

59325

"class": "EditorSelection",

59326

"module": "editor",

59327

"submodule": "selection"

59328

},

59329

{

59330

"file": "editor/js/editor-selection.js",

59331

"line": 910,

59332

"description": "Select a Node (hilighting it).",

59333

"itemtype": "method",

59334

"name": "selectNode",

59335

"params": [

59336

{

59337

"name": "node",

59338

"description": "The node to select",

59339

"type": "Node"

59340

},

59341

{

59342

"name": "collapse",

59343

"description": "Should the range be collapsed after insertion. default: false",

59344

"type": "Boolean"

59345

}

59346

],

59347

"chainable": 1,

59348

"return": {

59349

"description": "",

59350

"type": "EditorSelection"

59351

},

59352

"class": "EditorSelection",

59353

"module": "editor",

59354

"submodule": "selection"

59355

},

59356

{

59357

"file": "editor/js/editor-selection.js",

59358

"line": 951,

59359

"description": "Put a placeholder in the DOM at the current cursor position.",

59360

"itemtype": "method",

59361

"name": "setCursor",

59362

"return": {

59363

"description": "",

59364

"type": "Node"

59365

},

59366

"class": "EditorSelection",

59367

"module": "editor",

59368

"submodule": "selection"

59369

},

59370

{

59371

"file": "editor/js/editor-selection.js",

59372

"line": 960,

59373

"description": "Get the placeholder in the DOM at the current cursor position.",

59374

"itemtype": "method",

59375

"name": "getCursor",

59376

"return": {

59377

"description": "",

59378

"type": "Node"

59379

},

59380

"class": "EditorSelection",

59381

"module": "editor",

59382

"submodule": "selection"

59383

},

59384

{

59385

"file": "editor/js/editor-selection.js",

59386

"line": 968,

59387

"description": "Remove the cursor placeholder from the DOM.",

59388

"itemtype": "method",

59389

"name": "removeCursor",

59390

"params": [

59391

{

59392

"name": "keep",

59393

"description": "Setting this to true will keep the node, but remove the unique parts that make it the cursor.",

59394

"type": "Boolean"

59395

}

59396

],

59397

"return": {

59398

"description": "",

59399

"type": "Node"

59400

},

59401

"class": "EditorSelection",

59402

"module": "editor",

59403

"submodule": "selection"

59404

},

59405

{

59406

"file": "editor/js/editor-selection.js",

59407

"line": 986,

59408

"description": "Gets a stored cursor and focuses it for editing, must be called sometime after setCursor",

59409

"itemtype": "method",

59410

"name": "focusCursor",

59411

"return": {

59412

"description": "",

59413

"type": "Node"

59414

},

59415

"class": "EditorSelection",

59416

"module": "editor",

59417

"submodule": "selection"

59418

},

59419

{

59420

"file": "editor/js/editor-selection.js",

59421

"line": 1005,

59422

"description": "Generic toString for logging.",

59423

"itemtype": "method",

59424

"name": "toString",

59425

"return": {

59426

"description": "",

59427

"type": "String"

59428

},

59429

"class": "EditorSelection",

59430

"module": "editor",

59431

"submodule": "selection"

59432

},

59433

{

59434

"file": "editor/js/editor-tab.js",

59435

"line": 16,

59436

"description": "Listener for host's nodeChange event and captures the tabkey interaction.",

59437

"access": "private",

59438

"tagname": "",

59439

"itemtype": "method",

59440

"name": "_onNodeChange",

59441

"params": [

59442

{

59443

"name": "e",

59444

"description": "The Event facade passed from the host.",

59445

"type": "Event"

59446

}

59447

],

59448

"class": "Plugin.EditorTab",

59449

"module": "editor",

59450

"submodule": "editor-tab"

59451

},

59452

{

59453

"file": "editor/js/editor-tab.js",

59454

"line": 42,

59455

"description": "editorTab",

59456

"itemtype": "property",

59457

"name": "NAME",

59458

"static": 1,

59459

"class": "Plugin.EditorTab",

59460

"module": "editor",

59461

"submodule": "editor-tab"

59462

},

59463

{

59464

"file": "editor/js/editor-tab.js",

59465

"line": 48,

59466

"description": "tab",

59467

"itemtype": "property",

59468

"name": "NS",

59469

"static": 1,

59470

"class": "Plugin.EditorTab",

59471

"module": "editor",

59472

"submodule": "editor-tab"

59473

},

59474

{

59475

"file": "editor/js/exec-command.js",

59476

"line": 15,

59477

"description": "An internal reference to the keyCode of the last key that was pressed.",

59478

"access": "private",

59479

"tagname": "",

59480

"itemtype": "property",

59481

"name": "_lastKey",

59482

"class": "Plugin.ExecCommand",

59483

"module": "editor",

59484

"submodule": "exec-command"

59485

},

59486

{

59487

"file": "editor/js/exec-command.js",

59488

"line": 21,

59489

"description": "An internal reference to the instance of the frame plugged into.",

59490

"access": "private",

59491

"tagname": "",

59492

"itemtype": "property",

59493

"name": "_inst",

59494

"class": "Plugin.ExecCommand",

59495

"module": "editor",

59496

"submodule": "exec-command"

59497

},

59498

{

59499

"file": "editor/js/exec-command.js",

59500

"line": 27,

59501

"description": "Execute a command on the frame's document.",

59502

"itemtype": "method",

59503

"name": "command",

59504

"params": [

59505

{

59506

"name": "action",

59507

"description": "The action to perform (bold, italic, fontname)",

59508

"type": "String"

59509

},

59510

{

59511

"name": "value",

59512

"description": "The optional value (helvetica)",

59513

"type": "String"

59514

}

59515

],

59516

"return": {

59517

"description": "Should return the Node/Nodelist affected",

59518

"type": "Node/NodeList"

59519

},

59520

"class": "Plugin.ExecCommand",

59521

"module": "editor",

59522

"submodule": "exec-command"

59523

},

59524

{

59525

"file": "editor/js/exec-command.js",

59526

"line": 45,

59527

"description": "The private version of execCommand that doesn't filter for overrides.",

59528

"access": "private",

59529

"tagname": "",

59530

"itemtype": "method",

59531

"name": "_command",

59532

"params": [

59533

{

59534

"name": "action",

59535

"description": "The action to perform (bold, italic, fontname)",

59536

"type": "String"

59537

},

59538

{

59539

"name": "value",

59540

"description": "The optional value (helvetica)",

59541

"type": "String"

59542

}

59543

],

59544

"class": "Plugin.ExecCommand",

59545

"module": "editor",

59546

"submodule": "exec-command"

59547

},

59548

{

59549

"file": "editor/js/exec-command.js",

59550

"line": 69,

59551

"description": "Get's the instance of YUI bound to the parent frame",

59552

"itemtype": "method",

59553

"name": "getInstance",

59554

"return": {

59555

"description": "The YUI instance bound to the parent frame",

59556

"type": "YUI"

59557

},

59558

"class": "Plugin.ExecCommand",

59559

"module": "editor",

59560

"submodule": "exec-command"

59561

},

59562

{

59563

"file": "editor/js/exec-command.js",

59564

"line": 105,

59565

"description": "execCommand",

59566

"itemtype": "property",

59567

"name": "NAME",

59568

"static": 1,

59569

"class": "Plugin.ExecCommand",

59570

"module": "editor",

59571

"submodule": "exec-command"

59572

},

59573

{

59574

"file": "editor/js/exec-command.js",

59575

"line": 111,

59576

"description": "exec",

59577

"itemtype": "property",

59578

"name": "NS",

59579

"static": 1,

59580

"class": "Plugin.ExecCommand",

59581

"module": "editor",

59582

"submodule": "exec-command"

59583

},

59584

{

59585

"file": "editor/js/exec-command.js",

59586

"line": 122,

59587

"description": "Static object literal of execCommand overrides",

59588

"itemtype": "property",

59589

"name": "COMMANDS",

59590

"static": 1,

59591

"class": "Plugin.ExecCommand",

59592

"module": "editor",

59593

"submodule": "exec-command"

59594

},

59595

{

59596

"file": "editor/js/exec-command.js",

59597

"line": 128,

59598

"description": "Wraps the content with a new element of type (tag)",

59599

"itemtype": "method",

59600

"name": "COMMANDS.wrap",

59601

"static": 1,

59602

"params": [

59603

{

59604

"name": "cmd",

59605

"description": "The command executed: wrap",

59606

"type": "String"

59607

},

59608

{

59609

"name": "tag",

59610

"description": "The tag to wrap the selection with",

59611

"type": "String"

59612

}

59613

],

59614

"return": {

59615

"description": "NodeList of the items touched by this command.",

59616

"type": "NodeList"

59617

},

59618

"class": "Plugin.ExecCommand",

59619

"module": "editor",

59620

"submodule": "exec-command"

59621

},

59622

{

59623

"file": "editor/js/exec-command.js",

59624

"line": 140,

59625

"description": "Inserts the provided HTML at the cursor, should be a single element.",

59626

"itemtype": "method",

59627

"name": "COMMANDS.inserthtml",

59628

"static": 1,

59629

"params": [

59630

{

59631

"name": "cmd",

59632

"description": "The command executed: inserthtml",

59633

"type": "String"

59634

},

59635

{

59636

"name": "html",

59637

"description": "The html to insert",

59638

"type": "String"

59639

}

59640

],

59641

"return": {

59642

"description": "Node instance of the item touched by this command.",

59643

"type": "Node"

59644

},

59645

"class": "Plugin.ExecCommand",

59646

"module": "editor",

59647

"submodule": "exec-command"

59648

},

59649

{

59650

"file": "editor/js/exec-command.js",

59651

"line": 156,

59652

"description": "Inserts the provided HTML at the cursor, and focuses the cursor afterwards.",

59653

"itemtype": "method",

59654

"name": "COMMANDS.insertandfocus",

59655

"static": 1,

59656

"params": [

59657

{

59658

"name": "cmd",

59659

"description": "The command executed: insertandfocus",

59660

"type": "String"

59661

},

59662

{

59663

"name": "html",

59664

"description": "The html to insert",

59665

"type": "String"

59666

}

59667

],

59668

"return": {

59669

"description": "Node instance of the item touched by this command.",

59670

"type": "Node"

59671

},

59672

"class": "Plugin.ExecCommand",

59673

"module": "editor",

59674

"submodule": "exec-command"

59675

},

59676

{

59677

"file": "editor/js/exec-command.js",

59678

"line": 176,

59679

"description": "Inserts a BR at the current cursor position",

59680

"itemtype": "method",

59681

"name": "COMMANDS.insertbr",

59682

"static": 1,

59683

"params": [

59684

{

59685

"name": "cmd",

59686

"description": "The command executed: insertbr",

59687

"type": "String"

59688

}

59689

],

59690

"class": "Plugin.ExecCommand",

59691

"module": "editor",

59692

"submodule": "exec-command"

59693

},

59694

{

59695

"file": "editor/js/exec-command.js",

59696

"line": 223,

59697

"description": "Inserts an image at the cursor position",

59698

"itemtype": "method",

59699

"name": "COMMANDS.insertimage",

59700

"static": 1,

59701

"params": [

59702

{

59703

"name": "cmd",

59704

"description": "The command executed: insertimage",

59705

"type": "String"

59706

},

59707

{

59708

"name": "img",

59709

"description": "The url of the image to be inserted",

59710

"type": "String"

59711

}

59712

],

59713

"return": {

59714

"description": "Node instance of the item touched by this command.",

59715

"type": "Node"

59716

},

59717

"class": "Plugin.ExecCommand",

59718

"module": "editor",

59719

"submodule": "exec-command"

59720

},

59721

{

59722

"file": "editor/js/exec-command.js",

59723

"line": 234,

59724

"description": "Add a class to all of the elements in the selection",

59725

"itemtype": "method",

59726

"name": "COMMANDS.addclass",

59727

"static": 1,

59728

"params": [

59729

{

59730

"name": "cmd",

59731

"description": "The command executed: addclass",

59732

"type": "String"

59733

},

59734

{

59735

"name": "cls",

59736

"description": "The className to add",

59737

"type": "String"

59738

}

59739

],

59740

"return": {

59741

"description": "NodeList of the items touched by this command.",

59742

"type": "NodeList"

59743

},

59744

"class": "Plugin.ExecCommand",

59745

"module": "editor",

59746

"submodule": "exec-command"

59747

},

59748

{

59749

"file": "editor/js/exec-command.js",

59750

"line": 246,

59751

"description": "Remove a class from all of the elements in the selection",

59752

"itemtype": "method",

59753

"name": "COMMANDS.removeclass",

59754

"static": 1,

59755

"params": [

59756

{

59757

"name": "cmd",

59758

"description": "The command executed: removeclass",

59759

"type": "String"

59760

},

59761

{

59762

"name": "cls",

59763

"description": "The className to remove",

59764

"type": "String"

59765

}

59766

],

59767

"return": {

59768

"description": "NodeList of the items touched by this command.",

59769

"type": "NodeList"

59770

},

59771

"class": "Plugin.ExecCommand",

59772

"module": "editor",

59773

"submodule": "exec-command"

59774

},

59775

{

59776

"file": "editor/js/exec-command.js",

59777

"line": 258,

59778

"description": "Adds a forecolor to the current selection, or creates a new element and applies it",

59779

"itemtype": "method",

59780

"name": "COMMANDS.forecolor",

59781

"static": 1,

59782

"params": [

59783

{

59784

"name": "cmd",

59785

"description": "The command executed: forecolor",

59786

"type": "String"

59787

},

59788

{

59789

"name": "val",

59790

"description": "The color value to apply",

59791

"type": "String"

59792

}

59793

],

59794

"return": {

59795

"description": "NodeList of the items touched by this command.",

59796

"type": "NodeList"

59797

},

59798

"class": "Plugin.ExecCommand",

59799

"module": "editor",

59800

"submodule": "exec-command"

59801

},

59802

{

59803

"file": "editor/js/exec-command.js",

59804

"line": 290,

59805

"description": "Adds a background color to the current selection, or creates a new element and applies it",

59806

"itemtype": "method",

59807

"name": "COMMANDS.backcolor",

59808

"static": 1,

59809

"params": [

59810

{

59811

"name": "cmd",

59812

"description": "The command executed: backcolor",

59813

"type": "String"

59814

},

59815

{

59816

"name": "val",

59817

"description": "The color value to apply",

59818

"type": "String"

59819

}

59820

],

59821

"return": {

59822

"description": "NodeList of the items touched by this command.",

59823

"type": "NodeList"

59824

},

59825

"class": "Plugin.ExecCommand",

59826

"module": "editor",

59827

"submodule": "exec-command"

59828

},

59829

{

59830

"file": "editor/js/exec-command.js",

59831

"line": 325,

59832

"description": "Sugar method, calles backcolor",

59833

"itemtype": "method",

59834

"name": "COMMANDS.hilitecolor",

59835

"static": 1,

59836

"params": [

59837

{

59838

"name": "cmd",

59839

"description": "The command executed: backcolor",

59840

"type": "String"

59841

},

59842

{

59843

"name": "val",

59844

"description": "The color value to apply",

59845

"type": "String"

59846

}

59847

],

59848

"return": {

59849

"description": "NodeList of the items touched by this command.",

59850

"type": "NodeList"

59851

},

59852

"class": "Plugin.ExecCommand",

59853

"module": "editor",

59854

"submodule": "exec-command"

59855

},

59856

{

59857

"file": "editor/js/exec-command.js",

59858

"line": 336,

59859

"description": "Adds a font name to the current selection, or creates a new element and applies it",

59860

"itemtype": "method",

59861

"name": "COMMANDS.fontname2",

59862

"deprecated": true,

59863

"static": 1,

59864

"params": [

59865

{

59866

"name": "cmd",

59867

"description": "The command executed: fontname",

59868

"type": "String"

59869

},

59870

{

59871

"name": "val",

59872

"description": "The font name to apply",

59873

"type": "String"

59874

}

59875

],

59876

"return": {

59877

"description": "NodeList of the items touched by this command.",

59878

"type": "NodeList"

59879

},

59880

"class": "Plugin.ExecCommand",

59881

"module": "editor",

59882

"submodule": "exec-command"

59883

},

59884

{

59885

"file": "editor/js/exec-command.js",

59886

"line": 356,

59887

"description": "Adds a fontsize to the current selection, or creates a new element and applies it",

59888

"itemtype": "method",

59889

"name": "COMMANDS.fontsize2",

59890

"deprecated": true,

59891

"static": 1,

59892

"params": [

59893

{

59894

"name": "cmd",

59895

"description": "The command executed: fontsize",

59896

"type": "String"

59897

},

59898

{

59899

"name": "val",

59900

"description": "The font size to apply",

59901

"type": "String"

59902

}

59903

],

59904

"return": {

59905

"description": "NodeList of the items touched by this command.",

59906

"type": "NodeList"

59907

},

59908

"class": "Plugin.ExecCommand",

59909

"module": "editor",

59910

"submodule": "exec-command"

59911

},

59912

{

59913

"file": "editor/js/exec-command.js",

59914

"line": 387,

59915

"description": "Overload for COMMANDS.list",

59916

"itemtype": "method",

59917

"name": "COMMANDS.insertorderedlist",

59918

"static": 1,

59919

"params": [

59920

{

59921

"name": "cmd",

59922

"description": "The command executed: list, ul",

59923

"type": "String"

59924

}

59925

],

59926

"class": "Plugin.ExecCommand",

59927

"module": "editor",

59928

"submodule": "exec-command"

59929

},

59930

{

59931

"file": "editor/js/exec-command.js",

59932

"line": 396,

59933

"description": "Overload for COMMANDS.list",

59934

"itemtype": "method",

59935

"name": "COMMANDS.insertunorderedlist",

59936

"static": 1,

59937

"params": [

59938

{

59939

"name": "cmd",

59940

"description": "The command executed: list, ol",

59941

"type": "String"

59942

}

59943

],

59944

"class": "Plugin.ExecCommand",

59945

"module": "editor",

59946

"submodule": "exec-command"

59947

},

59948

{

59949

"file": "editor/js/exec-command.js",

59950

"line": 405,

59951

"description": "Noramlizes lists creation/destruction for IE. All others pass through to native calls",

59952

"itemtype": "method",

59953

"name": "COMMANDS.list",

59954

"static": 1,

59955

"params": [

59956

{

59957

"name": "cmd",

59958

"description": "The command executed: list (not used)",

59959

"type": "String"

59960

},

59961

{

59962

"name": "tag",

59963

"description": "The tag to deal with",

59964

"type": "String"

59965

}

59966

],

59967

"class": "Plugin.ExecCommand",

59968

"module": "editor",

59969

"submodule": "exec-command"

59970

},

59971

{

59972

"file": "editor/js/exec-command.js",

59973

"line": 581,

59974

"description": "Noramlizes alignment for Webkit Browsers",

59975

"itemtype": "method",

59976

"name": "COMMANDS.justify",

59977

"static": 1,

59978

"params": [

59979

{

59980

"name": "cmd",

59981

"description": "The command executed: justify (not used)",

59982

"type": "String"

59983

},

59984

{

59985

"name": "val",

59986

"description": "The actual command from the justify{center,all,left,right} stubs",

59987

"type": "String"

59988

}

59989

],

59990

"class": "Plugin.ExecCommand",

59991

"module": "editor",

59992

"submodule": "exec-command"

59993

},

59994

{

59995

"file": "editor/js/exec-command.js",

59996

"line": 607,

59997

"description": "Override method for COMMANDS.justify",

59998

"itemtype": "method",

59999

"name": "COMMANDS.justifycenter",

60000

"static": 1,

60001

"class": "Plugin.ExecCommand",

60002

"module": "editor",

60003

"submodule": "exec-command"

60004

},

60005

{

60006

"file": "editor/js/exec-command.js",

60007

"line": 615,

60008

"description": "Override method for COMMANDS.justify",

60009

"itemtype": "method",

60010

"name": "COMMANDS.justifyleft",

60011

"static": 1,

60012

"class": "Plugin.ExecCommand",

60013

"module": "editor",

60014

"submodule": "exec-command"

60015

},

60016

{

60017

"file": "editor/js/exec-command.js",

60018

"line": 623,

60019

"description": "Override method for COMMANDS.justify",

60020

"itemtype": "method",

60021

"name": "COMMANDS.justifyright",

60022

"static": 1,

60023

"class": "Plugin.ExecCommand",

60024

"module": "editor",

60025

"submodule": "exec-command"

60026

},

60027

{

60028

"file": "editor/js/exec-command.js",

60029

"line": 631,

60030

"description": "Override method for COMMANDS.justify",

60031

"itemtype": "method",

60032

"name": "COMMANDS.justifyfull",

60033

"static": 1,

60034

"class": "Plugin.ExecCommand",

60035

"module": "editor",

60036

"submodule": "exec-command"

60037

},

60038

{

60039

"file": "editor/js/exec-command.js",

60040

"line": 642,

60041

"description": "This method is meant to normalize IE's in ability to exec the proper command on elements with CSS styling.",

60042

"itemtype": "method",

60043

"name": "fixIETags",

60044

"access": "protected",

60045

"tagname": "",

60046

"params": [

60047

{

60048

"name": "cmd",

60049

"description": "The command to execute",

60050

"type": "String"

60051

},

60052

{

60053

"name": "tag",

60054

"description": "The tag to create",

60055

"type": "String"

60056

},

60057

{

60058

"name": "rule",

60059

"description": "The rule that we are looking for.",

60060

"type": "String"

60061

}

60062

],

60063

"class": "Plugin.ExecCommand",

60064

"module": "editor",

60065

"submodule": "exec-command"

60066

},

60067

{

60068

"file": "editor/js/frame.js",

60069

"line": 19,

60070

"access": "private",

60071

"tagname": "",

60072

"itemtype": "property",

60073

"name": "_ready",

60074

"description": "Internal reference set when the content is ready.",

60075

"type": "Boolean",

60076

"class": "Frame",

60077

"module": "editor",

60078

"submodule": "frame"

60079

},

60080

{

60081

"file": "editor/js/frame.js",

60082

"line": 26,

60083

"access": "private",

60084

"tagname": "",

60085

"itemtype": "property",

60086

"name": "_rendered",

60087

"description": "Internal reference set when render is called.",

60088

"type": "Boolean",

60089

"class": "Frame",

60090

"module": "editor",

60091

"submodule": "frame"

60092

},

60093

{

60094

"file": "editor/js/frame.js",

60095

"line": 33,

60096

"access": "private",

60097

"tagname": "",

60098

"itemtype": "property",

60099

"name": "_iframe",

60100

"description": "Internal Node reference to the iFrame or the window",

60101

"type": "Node",

60102

"class": "Frame",

60103

"module": "editor",

60104

"submodule": "frame"

60105

},

60106

{

60107

"file": "editor/js/frame.js",

60108

"line": 40,

60109

"access": "private",

60110

"tagname": "",

60111

"itemtype": "property",

60112

"name": "_instance",

60113

"description": "Internal reference to the YUI instance bound to the iFrame or window",

60114

"type": "YUI",

60115

"class": "Frame",

60116

"module": "editor",

60117

"submodule": "frame"

60118

},

60119

{

60120

"file": "editor/js/frame.js",

60121

"line": 47,

60122

"access": "private",

60123

"tagname": "",

60124

"itemtype": "method",

60125

"name": "_create",

60126

"description": "Create the iframe or Window and get references to the Document & Window",

60127

"return": {

60128

"description": "Hash table containing references to the new Document & Window",

60129

"type": "Object"

60130

},

60131

"class": "Frame",

60132

"module": "editor",

60133

"submodule": "frame"

60134

},

60135

{

60136

"file": "editor/js/frame.js",

60137

"line": 116,

60138

"access": "private",

60139

"tagname": "",

60140

"itemtype": "method",

60141

"name": "_resolveWinDoc",

60142

"description": "Resolves the document and window from an iframe or window instance",

60143

"params": [

60144

{

60145

"name": "c",

60146

"description": "The YUI Config to add the window and document to",

60147

"type": "Object"

60148

}

60149

],

60150

"return": {

60151

"description": "Object hash of window and document references, if a YUI config was passed, it is returned.",

60152

"type": "Object"

60153

},

60154

"class": "Frame",

60155

"module": "editor",

60156

"submodule": "frame"

60157

},

60158

{

60159

"file": "editor/js/frame.js",

60160

"line": 135,

60161

"access": "private",

60162

"tagname": "",

60163

"itemtype": "method",

60164

"name": "_onDomEvent",

60165

"description": "Generic handler for all DOM events fired by the iframe or window. This handler\ntakes the current EventFacade and augments it to fire on the Frame host. It adds two new properties\nto the EventFacade called frameX and frameY which adds the scroll and xy position of the iframe\nto the original pageX and pageY of the event so external nodes can be positioned over the frame.",

60166

"params": [

60167

{

60168

"name": "e",

60169

"description": "",

60170

"type": "Event.Facade"

60171

}

60172

],

60173

"class": "Frame",

60174

"module": "editor",

60175

"submodule": "frame"

60176

},

60177

{

60178

"file": "editor/js/frame.js",

60179

"line": 183,

60180

"access": "private",

60181

"tagname": "",

60182

"itemtype": "method",

60183

"name": "_DOMPaste",

60184

"description": "Simple pass thru handler for the paste event so we can do content cleanup",

60185

"params": [

60186

{

60187

"name": "e",

60188

"description": "",

60189

"type": "Event.Facade"

60190

}

60191

],

60192

"class": "Frame",

60193

"module": "editor",

60194

"submodule": "frame"

60195

},

60196

{

60197

"file": "editor/js/frame.js",

60198

"line": 229,

60199

"access": "private",

60200

"tagname": "",

60201

"itemtype": "method",

60202

"name": "_defReadyFn",

60203

"description": "Binds DOM events, sets the iframe to visible and fires the ready event",

60204

"class": "Frame",

60205

"module": "editor",

60206

"submodule": "frame"

60207

},

60208

{

60209

"file": "editor/js/frame.js",

60210

"line": 275,

60211

"description": "It appears that having a BR tag anywhere in the source \"below\" a table with a percentage width (in IE 7 & 8)\nif there is any TEXTINPUT's outside the iframe, the cursor will rapidly flickr and the CPU would occasionally \nspike. This method finds all 's below the sourceIndex of the first table. Does some checks to see if they\ncan be modified and replaces then with a so the layout will remain in tact, but the flickering will\nno longer happen.",

60212

"itemtype": "method",

60213

"name": "_fixIECursors",

60214

"access": "private",

60215

"tagname": "",

60216

"class": "Frame",

60217

"module": "editor",

60218

"submodule": "frame"

60219

},

60220

{

60221

"file": "editor/js/frame.js",

60222

"line": 315,

60223

"access": "private",

60224

"tagname": "",

60225

"itemtype": "method",

60226

"name": "_onContentReady",

60227

"description": "Called once the content is available in the frame/window and calls the final use call\non the internal instance so that the modules are loaded properly.",

60228

"class": "Frame",

60229

"module": "editor",

60230

"submodule": "frame"

60231

},

60232

{

60233

"file": "editor/js/frame.js",

60234

"line": 358,

60235

"description": "Internal method to set the height of the body to the height of the document in IE.\nWith contenteditable being set, the document becomes unresponsive to clicks, this \nmethod expands the body to be the height of the document so that doesn't happen.",

60236

"access": "private",

60237

"tagname": "",

60238

"itemtype": "method",

60239

"name": "_ieSetBodyHeight",

60240

"class": "Frame",

60241

"module": "editor",

60242

"submodule": "frame"

60243

},

60244

{

60245

"file": "editor/js/frame.js",

60246

"line": 405,

60247

"access": "private",

60248

"tagname": "",

60249

"itemtype": "method",

60250

"name": "_resolveBaseHref",

60251

"description": "Resolves the basehref of the page the frame is created on. Only applies to dynamic content.",

60252

"params": [

60253

{

60254

"name": "href",

60255

"description": "The new value to use, if empty it will be resolved from the current url.",

60256

"type": "String"

60257

}

60258

],

60259

"return": {

60260

"description": "",

60261

"type": "String"

60262

},

60263

"class": "Frame",

60264

"module": "editor",

60265

"submodule": "frame"

60266

},

60267

{

60268

"file": "editor/js/frame.js",

60269

"line": 422,

60270

"access": "private",

60271

"tagname": "",

60272

"itemtype": "method",

60273

"name": "_getHTML",

60274

"description": "Get the content from the iframe",

60275

"params": [

60276

{

60277

"name": "html",

60278

"description": "The raw HTML from the body of the iframe.",

60279

"type": "String"

60280

}

60281

],

60282

"return": {

60283

"description": "",

60284

"type": "String"

60285

},

60286

"class": "Frame",

60287

"module": "editor",

60288

"submodule": "frame"

60289

},

60290

{

60291

"file": "editor/js/frame.js",

60292

"line": 436,

60293

"access": "private",

60294

"tagname": "",

60295

"itemtype": "method",

60296

"name": "_setHTML",

60297

"description": "Set the content of the iframe",

60298

"params": [

60299

{

60300

"name": "html",

60301

"description": "The raw HTML to set the body of the iframe to.",

60302

"type": "String"

60303

}

60304

],

60305

"return": {

60306

"description": "",

60307

"type": "String"

60308

},

60309

"class": "Frame",

60310

"module": "editor",

60311

"submodule": "frame"

60312

},

60313

{

60314

"file": "editor/js/frame.js",

60315

"line": 456,

60316

"access": "private",

60317

"tagname": "",

60318

"itemtype": "method",

60319

"name": "_setLinkedCSS",

60320

"description": "Set's the linked CSS on the instance..",

60321

"class": "Frame",

60322

"module": "editor",

60323

"submodule": "frame"

60324

},

60325

{

60326

"file": "editor/js/frame.js",

60327

"line": 477,

60328

"access": "private",

60329

"tagname": "",

60330

"itemtype": "method",

60331

"name": "_setLinkedCSS",

60332

"description": "Set's the linked CSS on the instance..",

60333

"class": "Frame",

60334

"module": "editor",

60335

"submodule": "frame"

60336

},

60337

{

60338

"file": "editor/js/frame.js",

60339

"line": 489,

60340

"access": "private",

60341

"tagname": "",

60342

"itemtype": "method",

60343

"name": "_setExtraCSS",

60344

"description": "Set's the extra CSS on the instance..",

60345

"class": "Frame",

60346

"module": "editor",

60347

"submodule": "frame"

60348

},

60349

{

60350

"file": "editor/js/frame.js",

60351

"line": 504,

60352

"access": "private",

60353

"tagname": "",

60354

"itemtype": "method",

60355

"name": "_instanceLoaded",

60356

"description": "Called from the first YUI instance that sets up the internal instance.\nThis loads the content into the window/frame and attaches the contentready event.",

60357

"params": [

60358

{

60359

"name": "inst",

60360

"description": "The internal YUI instance bound to the frame/window",

60361

"type": "YUI"

60362

}

60363

],

60364

"class": "Frame",

60365

"module": "editor",

60366

"submodule": "frame"

60367

},

60368

{

60369

"file": "editor/js/frame.js",

60370

"line": 528,

60371

"itemtype": "method",

60372

"name": "use",

60373

"description": "This is a scoped version of the normal YUI.use method & is bound to this frame/window.\nAt setup, the inst.use method is mapped to this method.",

60374

"class": "Frame",

60375

"module": "editor",

60376

"submodule": "frame"

60377

},

60378

{

60379

"file": "editor/js/frame.js",

60380

"line": 551,

60381

"itemtype": "method",

60382

"name": "delegate",

60383

"description": "A delegate method passed to the instance's delegate method",

60384

"params": [

60385

{

60386

"name": "type",

60387

"description": "The type of event to listen for",

60388

"type": "String"

60389

},

60390

{

60391

"name": "fn",

60392

"description": "The method to attach",

60393

"type": "Function"

60394

},

60395

{

60396

"name": "cont",

60397

"description": "The container to act as a delegate, if no \"sel\" passed, the body is assumed as the container.",

60398

"type": "String"

60399

},

60400

{

60401

"name": "sel",

60402

"description": "The selector to match in the event (optional)",

60403

"type": "String"

60404

}

60405

],

60406

"return": {

60407

"description": "The Event handle returned from Y.delegate",

60408

"type": "EventHandle"

60409

},

60410

"class": "Frame",

60411

"module": "editor",

60412

"submodule": "frame"

60413

},

60414

{

60415

"file": "editor/js/frame.js",

60416

"line": 572,

60417

"itemtype": "method",

60418

"name": "getInstance",

60419

"description": "Get a reference to the internal YUI instance.",

60420

"return": {

60421

"description": "The internal YUI instance",

60422

"type": "YUI"

60423

},

60424

"class": "Frame",

60425

"module": "editor",

60426

"submodule": "frame"

60427

},

60428

{

60429

"file": "editor/js/frame.js",

60430

"line": 580,

60431

"itemtype": "method",

60432

"name": "render",

60433

"description": "Render the iframe into the container config option or open the window.",

60434

"params": [

60435

{

60436

"name": "node",

60437

"description": "The node to render to",

60438

"type": "String/HTMLElement/Node"

60439

}

60440

],

60441

"return": {

60442

"description": "",

60443

"type": "Frame"

60444

},

60445

"chainable": 1,

60446

"class": "Frame",

60447

"module": "editor",

60448

"submodule": "frame"

60449

},

60450

{

60451

"file": "editor/js/frame.js",

60452

"line": 641,

60453

"access": "private",

60454

"tagname": "",

60455

"itemtype": "method",

60456

"name": "_handleFocus",

60457

"description": "Does some tricks on focus to set the proper cursor position.",

60458

"class": "Frame",

60459

"module": "editor",

60460

"submodule": "frame"

60461

},

60462

{

60463

"file": "editor/js/frame.js",

60464

"line": 688,

60465

"itemtype": "method",

60466

"name": "focus",

60467

"description": "Set the focus to the iframe",

60468

"params": [

60469

{

60470

"name": "fn",

60471

"description": "Callback function to execute after focus happens",

60472

"type": "Function"

60473

}

60474

],

60475

"return": {

60476

"description": "",

60477

"type": "Frame"

60478

},

60479

"chainable": 1,

60480

"class": "Frame",

60481

"module": "editor",

60482

"submodule": "frame"

60483

},

60484

{

60485

"file": "editor/js/frame.js",

60486

"line": 735,

60487

"itemtype": "method",

60488

"name": "show",

60489

"description": "Show the iframe instance",

60490

"return": {

60491

"description": "",

60492

"type": "Frame"

60493

},

60494

"chainable": 1,

60495

"class": "Frame",

60496

"module": "editor",

60497

"submodule": "frame"

60498

},

60499

{

60500

"file": "editor/js/frame.js",

60501

"line": 756,

60502

"itemtype": "method",

60503

"name": "hide",

60504

"description": "Hide the iframe instance",

60505

"return": {

60506

"description": "",

60507

"type": "Frame"

60508

},

60509

"chainable": 1,

60510

"class": "Frame",

60511

"module": "editor",

60512

"submodule": "frame"

60513

},

60514

{

60515

"file": "editor/js/frame.js",

60516

"line": 770,

60517

"static": 1,

60518

"itemtype": "property",

60519

"name": "THROTTLE_TIME",

60520

"description": "The throttle time for key events in IE",

60521

"type": "Number",

60522

"default": "100",

60523

"class": "Frame",

60524

"module": "editor",

60525

"submodule": "frame"

60526

},

60527

{

60528

"file": "editor/js/frame.js",

60529

"line": 778,

60530

"static": 1,

60531

"itemtype": "property",

60532

"name": "DOM_EVENTS",

60533

"description": "The DomEvents that the frame automatically attaches and bubbles",

60534

"type": "Object",

60535

"class": "Frame",

60536

"module": "editor",

60537

"submodule": "frame"

60538

},

60539

{

60540

"file": "editor/js/frame.js",

60541

"line": 800,

60542

"static": 1,

60543

"itemtype": "property",

60544

"name": "DEFAULT_CSS",

60545

"description": "The default css used when creating the document.",

60546

"type": "String",

60547

"class": "Frame",

60548

"module": "editor",

60549

"submodule": "frame"

60550

},

60551

{

60552

"file": "editor/js/frame.js",

60553

"line": 808,

60554

"static": 1,

60555

"itemtype": "property",

60556

"name": "HTML",

60557

"description": "The template string used to create the iframe",

60558

"type": "String",

60559

"class": "Frame",

60560

"module": "editor",

60561

"submodule": "frame"

60562

},

60563

{

60564

"file": "editor/js/frame.js",

60565

"line": 816,

60566

"static": 1,

60567

"itemtype": "property",

60568

"name": "PAGE_HTML",

60569

"description": "The template used to create the page when created dynamically.",

60570

"type": "String",

60571

"class": "Frame",

60572

"module": "editor",

60573

"submodule": "frame"

60574

},

60575

{

60576

"file": "editor/js/frame.js",

60577

"line": 824,

60578

"static": 1,

60579

"itemtype": "method",

60580

"name": "getDocType",

60581

"description": "Parses document.doctype and generates a DocType to match the parent page, if supported.\nFor IE8, it grabs document.all[0].nodeValue and uses that. For IE < 8, it falls back to Frame.DOC_TYPE.",

60582

"return": {

60583

"description": "The normalized DocType to apply to the iframe",

60584

"type": "String"

60585

},

60586

"class": "Frame",

60587

"module": "editor",

60588

"submodule": "frame"

60589

},

60590

{

60591

"file": "editor/js/frame.js",

60592

"line": 853,

60593

"static": 1,

60594

"itemtype": "property",

60595

"name": "DOC_TYPE",

60596

"description": "The DOCTYPE to prepend to the new document when created. Should match the one on the page being served.",

60597

"type": "String",

60598

"class": "Frame",

60599

"module": "editor",

60600

"submodule": "frame"

60601

},

60602

{

60603

"file": "editor/js/frame.js",

60604

"line": 860,

60605

"static": 1,

60606

"itemtype": "property",

60607

"name": "META",

60608

"description": "The meta-tag for Content-Type to add to the dynamic document",

60609

"type": "String",

60610

"class": "Frame",

60611

"module": "editor",

60612

"submodule": "frame"

60613

},

60614

{

60615

"file": "editor/js/frame.js",

60616

"line": 868,

60617

"static": 1,

60618

"itemtype": "property",

60619

"name": "NAME",

60620

"description": "The name of the class (frame)",

60621

"type": "String",

60622

"class": "Frame",

60623

"module": "editor",

60624

"submodule": "frame"

60625

},

60626

{

60627

"file": "editor/js/frame.js",

60628

"line": 876,

60629

"itemtype": "attribute",

60630

"name": "title",

60631

"description": "The title to give the blank page.",

60632

"type": "String",

60633

"class": "Frame",

60634

"module": "editor",

60635

"submodule": "frame"

60636

},

60637

{

60638

"file": "editor/js/frame.js",

60639

"line": 884,

60640

"itemtype": "attribute",

60641

"name": "dir",

60642

"description": "The default text direction for this new frame. Default: ltr",

60643

"type": "String",

60644

"class": "Frame",

60645

"module": "editor",

60646

"submodule": "frame"

60647

},

60648

{

60649

"file": "editor/js/frame.js",

60650

"line": 892,

60651

"itemtype": "attribute",

60652

"name": "lang",

60653

"description": "The default language. Default: en-US",

60654

"type": "String",

60655

"class": "Frame",

60656

"module": "editor",

60657

"submodule": "frame"

60658

},

60659

{

60660

"file": "editor/js/frame.js",

60661

"line": 900,

60662

"itemtype": "attribute",

60663

"name": "src",

60664

"description": "The src of the iframe/window. Defaults to javascript:;",

60665

"type": "String",

60666

"class": "Frame",

60667

"module": "editor",

60668

"submodule": "frame"

60669

},

60670

{

60671

"file": "editor/js/frame.js",

60672

"line": 909,

60673

"itemtype": "attribute",

60674

"name": "designMode",

60675

"description": "Should designMode be turned on after creation.",

60676

"writeonce": "",

60677

"type": "Boolean",

60678

"class": "Frame",

60679

"module": "editor",

60680

"submodule": "frame"

60681

},

60682

{

60683

"file": "editor/js/frame.js",

60684

"line": 919,

60685

"itemtype": "attribute",

60686

"name": "content",

60687

"description": "The string to inject into the body of the new frame/window.",

60688

"type": "String",

60689

"class": "Frame",

60690

"module": "editor",

60691

"submodule": "frame"

60692

},

60693

{

60694

"file": "editor/js/frame.js",

60695

"line": 929,

60696

"itemtype": "attribute",

60697

"name": "basehref",

60698

"description": "The base href to use in the iframe.",

60699

"type": "String",

60700

"class": "Frame",

60701

"module": "editor",

60702

"submodule": "frame"

60703

},

60704

{

60705

"file": "editor/js/frame.js",

60706

"line": 938,

60707

"itemtype": "attribute",

60708

"name": "use",

60709

"description": "Array of modules to include in the scoped YUI instance at render time. Default: ['none', 'selector-css2']",

60710

"writeonce": "",

60711

"type": "Array",

60712

"class": "Frame",

60713

"module": "editor",

60714

"submodule": "frame"

60715

},

60716

{

60717

"file": "editor/js/frame.js",

60718

"line": 948,

60719

"itemtype": "attribute",

60720

"name": "container",

60721

"description": "The container to append the iFrame to on render.",

60722

"type": "String/HTMLElement/Node",

60723

"class": "Frame",

60724

"module": "editor",

60725

"submodule": "frame"

60726

},

60727

{

60728

"file": "editor/js/frame.js",

60729

"line": 959,

60730

"itemtype": "attribute",

60731

"name": "node",

60732

"description": "The Node instance of the iframe.",

60733

"type": "Node",

60734

"class": "Frame",

60735

"module": "editor",

60736

"submodule": "frame"

60737

},

60738

{

60739

"file": "editor/js/frame.js",

60740

"line": 971,

60741

"itemtype": "attribute",

60742

"name": "id",

60743

"description": "Set the id of the new Node. (optional)",

60744

"type": "String",

60745

"writeonce": "",

60746

"class": "Frame",

60747

"module": "editor",

60748

"submodule": "frame"

60749

},

60750

{

60751

"file": "editor/js/frame.js",

60752

"line": 986,

60753

"itemtype": "attribute",

60754

"name": "linkedcss",

60755

"description": "An array of url's to external linked style sheets",

60756

"type": "String",

60757

"class": "Frame",

60758

"module": "editor",

60759

"submodule": "frame"

60760

},

60761

{

60762

"file": "editor/js/frame.js",

60763

"line": 996,

60764

"itemtype": "attribute",

60765

"name": "extracss",

60766

"description": "A string of CSS to add to the Head of the Editor",

60767

"type": "String",

60768

"class": "Frame",

60769

"module": "editor",

60770

"submodule": "frame"

60771

},

60772

{

60773

"file": "editor/js/frame.js",

60774

"line": 1005,

60775

"itemtype": "attribute",

60776

"name": "host",

60777

"description": "A reference to the Editor instance",

60778

"type": "Object",

60779

"class": "Frame",

60780

"module": "editor",

60781

"submodule": "frame"

60782

},

60783

{

60784

"file": "editor/js/frame.js",

60785

"line": 1013,

60786

"itemtype": "attribute",

60787

"name": "defaultblock",

60788

"description": "The default tag to use for block level items, defaults to: p",

60789

"type": "String",

60790

"class": "Frame",

60791

"module": "editor",

60792

"submodule": "frame"

60793

},

60794

{

60795

"file": "editor/js/lists.js",

60796

"line": 16,

60797

"description": "Listener for host's nodeChange event and captures the tabkey interaction only when inside a list node.",

60798

"access": "private",

60799

"tagname": "",

60800

"itemtype": "method",

60801

"name": "_onNodeChange",

60802

"params": [

60803

{

60804

"name": "e",

60805

"description": "The Event facade passed from the host.",

60806

"type": "Event"

60807

}

60808

],

60809

"class": "Plugin.EditorLists",

60810

"module": "editor",

60811

"submodule": "editor-lists"

60812

},

60813

{

60814

"file": "editor/js/lists.js",

60815

"line": 80,

60816

"description": "The non element placeholder, used for positioning the cursor and filling empty items",

60817

"itemtype": "property",

60818

"name": "REMOVE",

60819

"static": 1,

60820

"class": "Plugin.EditorLists",

60821

"module": "editor",

60822

"submodule": "editor-lists"

60823

},

60824

{

60825

"file": "editor/js/lists.js",

60826

"line": 86,

60827

"description": "The selector query to get all non elements",

60828

"itemtype": "property",

60829

"name": "NONSEL",

60830

"static": 1,

60831

"class": "Plugin.EditorLists",

60832

"module": "editor",

60833

"submodule": "editor-lists"

60834

},

60835

{

60836

"file": "editor/js/lists.js",

60837

"line": 92,

60838

"description": "The items to removed from a list when a list item is moved, currently removes BR nodes",

60839

"itemtype": "property",

60840

"name": "REMOVE",

60841

"static": 1,

60842

"class": "Plugin.EditorLists",

60843

"module": "editor",

60844

"submodule": "editor-lists"

60845

},

60846

{

60847

"file": "editor/js/lists.js",

60848

"line": 98,

60849

"description": "editorLists",

60850

"itemtype": "property",

60851

"name": "NAME",

60852

"static": 1,

60853

"class": "Plugin.EditorLists",

60854

"module": "editor",

60855

"submodule": "editor-lists"

60856

},

60857

{

60858

"file": "editor/js/lists.js",

60859

"line": 104,

60860

"description": "lists",

60861

"itemtype": "property",

60862

"name": "NS",

60863

"static": 1,

60864

"class": "Plugin.EditorLists",

60865

"module": "editor",

60866

"submodule": "editor-lists"

60867

},

60868

{

60869

"file": "escape/js/escape.js",

60870

"line": 23,

60871

"description": "Returns a copy of the specified string with special HTML characters\nescaped. The following characters will be converted to their\ncorresponding character entities:\n\n & < > \" ' / `\n\nThis implementation is based on the [OWASP HTML escaping\nrecommendations][1]. In addition to the characters in the OWASP\nrecommendations, we also escape the <code>`</code> character, since IE\ninterprets it as an attribute delimiter.\n\nIf _string_ is not already a string, it will be coerced to a string.\n\n[1]: http://www.owasp.org/index.php/XSS_(Cross_Site_Scripting)_Prevention_Cheat_Sheet",

60872

"itemtype": "method",

60873

"name": "html",

60874

"params": [

60875

{

60876

"name": "string",

60877

"description": "String to escape.",

60878

"type": "String"

60879

}

60880

],

60881

"return": {

60882

"description": "Escaped string.",

60883

"type": "String"

60884

},

60885

"static": 1,

60886

"class": "Escape",

60887

"module": "escape"

60888

},

60889

{

60890

"file": "escape/js/escape.js",

60891

"line": 48,

60892

"description": "Returns a copy of the specified string with special regular expression\ncharacters escaped, allowing the string to be used safely inside a regex.\nThe following characters, and all whitespace characters, are escaped:\n\n - $ ^ * ( ) + [ ] { } | \\ , . ?\n\nIf _string_ is not already a string, it will be coerced to a string.",

60893

"itemtype": "method",

60894

"name": "regex",

60895

"params": [

60896

{

60897

"name": "string",

60898

"description": "String to escape.",

60899

"type": "String"

60900

}

60901

],

60902

"return": {

60903

"description": "Escaped string.",

60904

"type": "String"

60905

},

60906

"static": 1,

60907

"class": "Escape",

60908

"module": "escape"

60909

},

60910

{

60911

"file": "escape/js/escape.js",

60912

"line": 71,

60913

"description": "Regex replacer for HTML escaping.",

60914

"itemtype": "method",

60915

"name": "_htmlReplacer",

60916

"params": [

60917

{

60918

"name": "match",

60919

"description": "Matched character (must exist in HTML_CHARS).",

60920

"type": "String"

60921

}

60922

],

60923

"return": {

60924

"description": "HTML entity.",

60925

"type": "String"

60926

},

60927

"static": 1,

60928

"access": "protected",

60929

"tagname": "",

60930

"class": "Escape",

60931

"module": "escape"

60932

},

60933

{

60934

"file": "event-custom/js/event-custom.js",

60935

"line": 58,

60936

"description": "The type of event, returned to subscribers when the event fires",

60937

"itemtype": "property",

60938

"name": "type",

60939

"type": "string",

60940

"class": "CustomEvent",

60941

"module": "event-custom",

60942

"submodule": "event-custom-base"

60943

},

60944

{

60945

"file": "event-custom/js/event-custom.js",

60946

"line": 65,

60947

"description": "The context the the event will fire from by default. Defaults to the YUI\ninstance.",

60948

"itemtype": "property",

60949

"name": "context",

60950

"type": "object",

60951

"class": "CustomEvent",

60952

"module": "event-custom",

60953

"submodule": "event-custom-base"

60954

},

60955

{

60956

"file": "event-custom/js/event-custom.js",

60957

"line": 73,

60958

"description": "Monitor when an event is attached or detached.",

60959

"itemtype": "property",

60960

"name": "monitored",

60961

"type": "boolean",

60962

"class": "CustomEvent",

60963

"module": "event-custom",

60964

"submodule": "event-custom-base"

60965

},

60966

{

60967

"file": "event-custom/js/event-custom.js",

60968

"line": 83,

60969

"description": "If 0, this event does not broadcast. If 1, the YUI instance is notified\nevery time this event fires. If 2, the YUI instance and the YUI global\n(if event is enabled on the global) are notified every time this event\nfires.",

60970

"itemtype": "property",

60971

"name": "broadcast",

60972

"type": "int",

60973

"class": "CustomEvent",

60974

"module": "event-custom",

60975

"submodule": "event-custom-base"

60976

},

60977

{

60978

"file": "event-custom/js/event-custom.js",

60979

"line": 93,

60980

"description": "By default all custom events are logged in the debug build, set silent\nto true to disable debug outpu for this event.",

60981

"itemtype": "property",

60982

"name": "silent",

60983

"type": "boolean",

60984

"class": "CustomEvent",

60985

"module": "event-custom",

60986

"submodule": "event-custom-base"

60987

},

60988

{

60989

"file": "event-custom/js/event-custom.js",

60990

"line": 101,

60991

"description": "Specifies whether this event should be queued when the host is actively\nprocessing an event. This will effect exectution order of the callbacks\nfor the various events.",

60992

"itemtype": "property",

60993

"name": "queuable",

60994

"type": "boolean",

60995

"default": "false",

60996

"class": "CustomEvent",

60997

"module": "event-custom",

60998

"submodule": "event-custom-base"

60999

},

61000

{

61001

"file": "event-custom/js/event-custom.js",

61002

"line": 111,

61003

"description": "The subscribers to this event",

61004

"itemtype": "property",

61005

"name": "subscribers",

61006

"type": "Subscriber {}",

61007

"class": "CustomEvent",

61008

"module": "event-custom",

61009

"submodule": "event-custom-base"

61010

},

61011

{

61012

"file": "event-custom/js/event-custom.js",

61013

"line": 118,

61014

"description": "'After' subscribers",

61015

"itemtype": "property",

61016

"name": "afters",

61017

"type": "Subscriber {}",

61018

"class": "CustomEvent",

61019

"module": "event-custom",

61020

"submodule": "event-custom-base"

61021

},

61022

{

61023

"file": "event-custom/js/event-custom.js",

61024

"line": 125,

61025

"description": "This event has fired if true",

61026

"itemtype": "property",

61027

"name": "fired",

61028

"type": "boolean",

61029

"default": "false;",

61030

"class": "CustomEvent",

61031

"module": "event-custom",

61032

"submodule": "event-custom-base"

61033

},

61034

{

61035

"file": "event-custom/js/event-custom.js",

61036

"line": 134,

61037

"description": "An array containing the arguments the custom event\nwas last fired with.",

61038

"itemtype": "property",

61039

"name": "firedWith",

61040

"type": "Array",

61041

"class": "CustomEvent",

61042

"module": "event-custom",

61043

"submodule": "event-custom-base"

61044

},

61045

{

61046

"file": "event-custom/js/event-custom.js",

61047

"line": 142,

61048

"description": "This event should only fire one time if true, and if\nit has fired, any new subscribers should be notified\nimmediately.",

61049

"itemtype": "property",

61050

"name": "fireOnce",

61051

"type": "boolean",

61052

"default": "false;",

61053

"class": "CustomEvent",

61054

"module": "event-custom",

61055

"submodule": "event-custom-base"

61056

},

61057

{

61058

"file": "event-custom/js/event-custom.js",

61059

"line": 153,

61060

"description": "fireOnce listeners will fire syncronously unless async\nis set to true",

61061

"itemtype": "property",

61062

"name": "async",

61063

"type": "boolean",

61064

"default": "false",

61065

"class": "CustomEvent",

61066

"module": "event-custom",

61067

"submodule": "event-custom-base"

61068

},

61069

{

61070

"file": "event-custom/js/event-custom.js",

61071

"line": 162,

61072

"description": "Flag for stopPropagation that is modified during fire()\n1 means to stop propagation to bubble targets. 2 means\nto also stop additional subscribers on this target.",

61073

"itemtype": "property",

61074

"name": "stopped",

61075

"type": "int",

61076

"class": "CustomEvent",

61077

"module": "event-custom",

61078

"submodule": "event-custom-base"

61079

},

61080

{

61081

"file": "event-custom/js/event-custom.js",

61082

"line": 171,

61083

"description": "Flag for preventDefault that is modified during fire().\nif it is not 0, the default behavior for this event",

61084

"itemtype": "property",

61085

"name": "prevented",

61086

"type": "int",

61087

"class": "CustomEvent",

61088

"module": "event-custom",

61089

"submodule": "event-custom-base"

61090

},

61091

{

61092

"file": "event-custom/js/event-custom.js",

61093

"line": 179,

61094

"description": "Specifies the host for this custom event. This is used\nto enable event bubbling",

61095

"itemtype": "property",

61096

"name": "host",

61097

"type": "EventTarget",

61098

"class": "CustomEvent",

61099

"module": "event-custom",

61100

"submodule": "event-custom-base"

61101

},

61102

{

61103

"file": "event-custom/js/event-custom.js",

61104

"line": 187,

61105

"description": "The default function to execute after event listeners\nhave fire, but only if the default action was not\nprevented.",

61106

"itemtype": "property",

61107

"name": "defaultFn",

61108

"type": "Function",

61109

"class": "CustomEvent",

61110

"module": "event-custom",

61111

"submodule": "event-custom-base"

61112

},

61113

{

61114

"file": "event-custom/js/event-custom.js",

61115

"line": 196,

61116

"description": "The function to execute if a subscriber calls\nstopPropagation or stopImmediatePropagation",

61117

"itemtype": "property",

61118

"name": "stoppedFn",

61119

"type": "Function",

61120

"class": "CustomEvent",

61121

"module": "event-custom",

61122

"submodule": "event-custom-base"

61123

},

61124

{

61125

"file": "event-custom/js/event-custom.js",

61126

"line": 204,

61127

"description": "The function to execute if a subscriber calls\npreventDefault",

61128

"itemtype": "property",

61129

"name": "preventedFn",

61130

"type": "Function",

61131

"class": "CustomEvent",

61132

"module": "event-custom",

61133

"submodule": "event-custom-base"

61134

},

61135

{

61136

"file": "event-custom/js/event-custom.js",

61137

"line": 212,

61138

"description": "Specifies whether or not this event's default function\ncan be cancelled by a subscriber by executing preventDefault()\non the event facade",

61139

"itemtype": "property",

61140

"name": "preventable",

61141

"type": "boolean",

61142

"default": "true",

61143

"class": "CustomEvent",

61144

"module": "event-custom",

61145

"submodule": "event-custom-base"

61146

},

61147

{

61148

"file": "event-custom/js/event-custom.js",

61149

"line": 222,

61150

"description": "Specifies whether or not a subscriber can stop the event propagation\nvia stopPropagation(), stopImmediatePropagation(), or halt()\n\nEvents can only bubble if emitFacade is true.",

61151

"itemtype": "property",

61152

"name": "bubbles",

61153

"type": "boolean",

61154

"default": "true",

61155

"class": "CustomEvent",

61156

"module": "event-custom",

61157

"submodule": "event-custom-base"

61158

},

61159

{

61160

"file": "event-custom/js/event-custom.js",

61161

"line": 234,

61162

"description": "Supports multiple options for listener signatures in order to\nport YUI 2 apps.",

61163

"itemtype": "property",

61164

"name": "signature",

61165

"type": "int",

61166

"default": "9",

61167

"class": "CustomEvent",

61168

"module": "event-custom",

61169

"submodule": "event-custom-base"

61170

},

61171

{

61172

"file": "event-custom/js/event-custom.js",

61173

"line": 250,

61174

"description": "If set to true, the custom event will deliver an EventFacade object\nthat is similar to a DOM event object.",

61175

"itemtype": "property",

61176

"name": "emitFacade",

61177

"type": "boolean",

61178

"default": "false",

61179

"class": "CustomEvent",

61180

"module": "event-custom",

61181

"submodule": "event-custom-base"

61182

},

61183

{

61184

"file": "event-custom/js/event-custom.js",

61185

"line": 268,

61186

"description": "Returns the number of subscribers for this event as the sum of the on()\nsubscribers and after() subscribers.",

61187

"itemtype": "method",

61188

"name": "hasSubs",

61189

"return": {

61190

"description": "Number"

61191

},

61192

"class": "CustomEvent",

61193

"module": "event-custom",

61194

"submodule": "event-custom-base"

61195

},

61196

{

61197

"file": "event-custom/js/event-custom.js",

61198

"line": 290,

61199

"description": "Monitor the event state for the subscribed event. The first parameter\nis what should be monitored, the rest are the normal parameters when\nsubscribing to an event.",

61200

"itemtype": "method",

61201

"name": "monitor",

61202

"params": [

61203

{

61204

"name": "what",

61205

"description": "what to monitor ('detach', 'attach', 'publish').",

61206

"type": "String"

61207

}

61208

],

61209

"return": {

61210

"description": "return value from the monitor event subscription.",

61211

"type": "EventHandle"

61212

},

61213

"class": "CustomEvent",

61214

"module": "event-custom",

61215

"submodule": "event-custom-base"

61216

},

61217

{

61218

"file": "event-custom/js/event-custom.js",

61219

"line": 306,

61220

"description": "Get all of the subscribers to this event and any sibling event",

61221

"itemtype": "method",

61222

"name": "getSubs",

61223

"return": {

61224

"description": "first item is the on subscribers, second the after.",

61225

"type": "Array"

61226

},

61227

"class": "CustomEvent",

61228

"module": "event-custom",

61229

"submodule": "event-custom-base"

61230

},

61231

{

61232

"file": "event-custom/js/event-custom.js",

61233

"line": 322,

61234

"description": "Apply configuration properties. Only applies the CONFIG whitelist",

61235

"itemtype": "method",

61236

"name": "applyConfig",

61237

"params": [

61238

{

61239

"name": "o",

61240

"description": "hash of properties to apply."

61241

},

61242

{

61243

"name": "force",

61244

"description": "if true, properties that exist on the event\nwill be overwritten.",

61245

"type": "Boolean"

61246

}

61247

],

61248

"class": "CustomEvent",

61249

"module": "event-custom",

61250

"submodule": "event-custom-base"

61251

},

61252

{

61253

"file": "event-custom/js/event-custom.js",

61254

"line": 335,

61255

"description": "Create the Subscription for subscribing function, context, and bound\narguments. If this is a fireOnce event, the subscriber is immediately \nnotified.",

61256

"itemtype": "method",

61257

"name": "_on",

61258

"params": [

61259

{

61260

"name": "fn",

61261

"description": "Subscription callback",

61262

"type": "Function"

61263

},

61264

{

61265

"name": "context",

61266

"description": "Override `this` in the callback",

61267

"type": "Object",

61268

"optional": true

61269

},

61270

{

61271

"name": "args",

61272

"description": "bound arguments that will be passed to the callback after the arguments generated by fire()",

61273

"type": "Array",

61274

"optional": true

61275

},

61276

{

61277

"name": "when",

61278

"description": "\"after\" to slot into after subscribers",

61279

"type": "String",

61280

"optional": true

61281

}

61282

],

61283

"return": {

61284

"description": "",

61285

"type": "EventHandle"

61286

},

61287

"access": "protected",

61288

"tagname": "",

61289

"class": "CustomEvent",

61290

"module": "event-custom",

61291

"submodule": "event-custom-base"

61292

},

61293

{

61294

"file": "event-custom/js/event-custom.js",

61295

"line": 376,

61296

"description": "Listen for this event",

61297

"itemtype": "method",

61298

"name": "subscribe",

61299

"params": [

61300

{

61301

"name": "fn",

61302

"description": "The function to execute.",

61303

"type": "Function"

61304

}

61305

],

61306

"return": {

61307

"description": "Unsubscribe handle.",

61308

"type": "EventHandle"

61309

},

61310

"deprecated": true,

61311

"deprecationMessage": "use on.",

61312

"class": "CustomEvent",

61313

"module": "event-custom",

61314

"submodule": "event-custom-base"

61315

},

61316

{

61317

"file": "event-custom/js/event-custom.js",

61318

"line": 389,

61319

"description": "Listen for this event",

61320

"itemtype": "method",

61321

"name": "on",

61322

"params": [

61323

{

61324

"name": "fn",

61325

"description": "The function to execute.",

61326

"type": "Function"

61327

},

61328

{

61329

"name": "context",

61330

"description": "optional execution context.",

61331

"type": "Object"

61332

},

61333

{

61334

"name": "arg",

61335

"description": "0..n additional arguments to supply to the subscriber\nwhen the event fires.",

61336

"type": "Mixed",

61337

"multiple": true

61338

}

61339

],

61340

"return": {

61341

"description": "An object with a detach method to detch the handler(s).",

61342

"type": "EventHandle"

61343

},

61344

"class": "CustomEvent",

61345

"module": "event-custom",

61346

"submodule": "event-custom-base"

61347

},

61348

{

61349

"file": "event-custom/js/event-custom.js",

61350

"line": 408,

61351

"description": "Listen for this event after the normal subscribers have been notified and\nthe default behavior has been applied. If a normal subscriber prevents the\ndefault behavior, it also prevents after listeners from firing.",

61352

"itemtype": "method",

61353

"name": "after",

61354

"params": [

61355

{

61356

"name": "fn",

61357

"description": "The function to execute.",

61358

"type": "Function"

61359

},

61360

{

61361

"name": "context",

61362

"description": "optional execution context.",

61363

"type": "Object"

61364

},

61365

{

61366

"name": "arg",

61367

"description": "0..n additional arguments to supply to the subscriber\nwhen the event fires.",

61368

"type": "Mixed",

61369

"multiple": true

61370

}

61371

],

61372

"return": {

61373

"description": "handle Unsubscribe handle.",

61374

"type": "EventHandle"

61375

},

61376

"class": "CustomEvent",

61377

"module": "event-custom",

61378

"submodule": "event-custom-base"

61379

},

61380

{

61381

"file": "event-custom/js/event-custom.js",

61382

"line": 424,

61383

"description": "Detach listeners.",

61384

"itemtype": "method",

61385

"name": "detach",

61386

"params": [

61387

{

61388

"name": "fn",

61389

"description": "The subscribed function to remove, if not supplied\n all will be removed.",

61390

"type": "Function"

61391

},

61392

{

61393

"name": "context",

61394

"description": "The context object passed to subscribe.",

61395

"type": "Object"

61396

}

61397

],

61398

"return": {

61399

"description": "returns the number of subscribers unsubscribed.",

61400

"type": "Int"

61401

},

61402

"class": "CustomEvent",

61403

"module": "event-custom",

61404

"submodule": "event-custom-base"

61405

},

61406

{

61407

"file": "event-custom/js/event-custom.js",

61408

"line": 455,

61409

"description": "Detach listeners.",

61410

"itemtype": "method",

61411

"name": "unsubscribe",

61412

"params": [

61413

{

61414

"name": "fn",

61415

"description": "The subscribed function to remove, if not supplied\n all will be removed.",

61416

"type": "Function"

61417

},

61418

{

61419

"name": "context",

61420

"description": "The context object passed to subscribe.",

61421

"type": "Object"

61422

}

61423

],

61424

"return": {

61425

"description": "returns the number of subscribers unsubscribed.",

61426

"type": "Int|undefined"

61427

},

61428

"deprecated": true,

61429

"deprecationMessage": "use detach.",

61430

"class": "CustomEvent",

61431

"module": "event-custom",

61432

"submodule": "event-custom-base"

61433

},

61434

{

61435

"file": "event-custom/js/event-custom.js",

61436

"line": 468,

61437

"description": "Notify a single subscriber",

61438

"itemtype": "method",

61439

"name": "_notify",

61440

"params": [

61441

{

61442

"name": "s",

61443

"description": "the subscriber.",

61444

"type": "Subscriber"

61445

},

61446

{

61447

"name": "args",

61448

"description": "the arguments array to apply to the listener.",

61449

"type": "Array"

61450

}

61451

],

61452

"access": "protected",

61453

"tagname": "",

61454

"class": "CustomEvent",

61455

"module": "event-custom",

61456

"submodule": "event-custom-base"

61457

},

61458

{

61459

"file": "event-custom/js/event-custom.js",

61460

"line": 491,

61461

"description": "Logger abstraction to centralize the application of the silent flag",

61462

"itemtype": "method",

61463

"name": "log",

61464

"params": [

61465

{

61466

"name": "msg",

61467

"description": "message to log.",

61468

"type": "String"

61469

},

61470

{

61471

"name": "cat",

61472

"description": "log category.",

61473

"type": "String"

61474

}

61475

],

61476

"class": "CustomEvent",

61477

"module": "event-custom",

61478

"submodule": "event-custom-base"

61479

},

61480

{

61481

"file": "event-custom/js/event-custom.js",

61482

"line": 503,

61483

"description": "Notifies the subscribers. The callback functions will be executed\nfrom the context specified when the event was created, and with the\nfollowing parameters:\n <ul>\n <li>The type of event</li>\n <li>All of the arguments fire() was executed with as an array</li>\n <li>The custom object (if any) that was passed into the subscribe()\n method</li>\n </ul>",

61484

"itemtype": "method",

61485

"name": "fire",

61486

"params": [

61487

{

61488

"name": "arguments",

61489

"description": "an arbitrary set of parameters to pass to\n the handler.",

61490

"type": "Object*"

61491

}

61492

],

61493

"return": {

61494

"description": "false if one of the subscribers returned false,\n true otherwise.",

61495

"type": "Boolean"

61496

},

61497

"class": "CustomEvent",

61498

"module": "event-custom",

61499

"submodule": "event-custom-base"

61500

},

61501

{

61502

"file": "event-custom/js/event-custom.js",

61503

"line": 542,

61504

"description": "Set up for notifying subscribers of non-emitFacade events.",

61505

"itemtype": "method",

61506

"name": "fireSimple",

61507

"params": [

61508

{

61509

"name": "args",

61510

"description": "Arguments passed to fire()",

61511

"type": "Array"

61512

}

61513

],

61514

"return": {

61515

"description": "Boolean false if a subscriber returned false"

61516

},

61517

"access": "protected",

61518

"tagname": "",

61519

"class": "CustomEvent",

61520

"module": "event-custom",

61521

"submodule": "event-custom-base"

61522

},

61523

{

61524

"file": "event-custom/js/event-custom.js",

61525

"line": 570,

61526

"description": "Notifies a list of subscribers.",

61527

"itemtype": "method",

61528

"name": "_procSubs",

61529

"params": [

61530

{

61531

"name": "subs",

61532

"description": "List of subscribers",

61533

"type": "Array"

61534

},

61535

{

61536

"name": "args",

61537

"description": "Arguments passed to fire()",

61538

"type": "Array"

61539

},

61540

{

61541

"name": "ef",

61542

"description": ""

61543

}

61544

],

61545

"return": {

61546

"description": "Boolean false if a subscriber returns false or stops the event\n propagation via e.stopPropagation(),\n e.stopImmediatePropagation(), or e.halt()"

61547

},

61548

"access": "private",

61549

"tagname": "",

61550

"class": "CustomEvent",

61551

"module": "event-custom",

61552

"submodule": "event-custom-base"

61553

},

61554

{

61555

"file": "event-custom/js/event-custom.js",

61556

"line": 601,

61557

"description": "Notifies the YUI instance if the event is configured with broadcast = 1,\nand both the YUI instance and Y.Global if configured with broadcast = 2.",

61558

"itemtype": "method",

61559

"name": "_broadcast",

61560

"params": [

61561

{

61562

"name": "args",

61563

"description": "Arguments sent to fire()",

61564

"type": "Array"

61565

}

61566

],

61567

"access": "private",

61568

"tagname": "",

61569

"class": "CustomEvent",

61570

"module": "event-custom",

61571

"submodule": "event-custom-base"

61572

},

61573

{

61574

"file": "event-custom/js/event-custom.js",

61575

"line": 625,

61576

"description": "Removes all listeners",

61577

"itemtype": "method",

61578

"name": "unsubscribeAll",

61579

"return": {

61580

"description": "The number of listeners unsubscribed.",

61581

"type": "Int"

61582

},

61583

"deprecated": true,

61584

"deprecationMessage": "use detachAll.",

61585

"class": "CustomEvent",

61586

"module": "event-custom",

61587

"submodule": "event-custom-base"

61588

},

61589

{

61590

"file": "event-custom/js/event-custom.js",

61591

"line": 635,

61592

"description": "Removes all listeners",

61593

"itemtype": "method",

61594

"name": "detachAll",

61595

"return": {

61596

"description": "The number of listeners unsubscribed.",

61597

"type": "Int"

61598

},

61599

"class": "CustomEvent",

61600

"module": "event-custom",

61601

"submodule": "event-custom-base"

61602

},

61603

{

61604

"file": "event-custom/js/event-custom.js",

61605

"line": 644,

61606

"description": "Deletes the subscriber from the internal store of on() and after()\nsubscribers.",

61607

"itemtype": "method",

61608

"name": "_delete",

61609

"params": [

61610

{

61611

"name": "subscriber",

61612

"description": "object."

61613

}

61614

],

61615

"access": "private",

61616

"tagname": "",

61617

"class": "CustomEvent",

61618

"module": "event-custom",

61619

"submodule": "event-custom-base"

61620

},

61621

{

61622

"file": "event-custom/js/event-do.js",

61623

"line": 21,

61624

"description": "Cache of objects touched by the utility",

61625

"itemtype": "property",

61626

"name": "objs",

61627

"static": 1,

61628

"class": "Do",

61629

"module": "event-custom",

61630

"submodule": "event-custom-base"

61631

},

61632

{

61633

"file": "event-custom/js/event-do.js",

61634

"line": 28,

61635

"description": "Execute the supplied method before the specified function. Wrapping\nfunction may optionally return an instance of the following classes to\nfurther alter runtime behavior:\n<dl>\n <dt></code>Y.Do.Halt(message, returnValue)</code></dt>\n <dd>Immediatly stop execution and return\n <code>returnValue</code>. No other wrapping functions will be\n executed.</dd>\n <dt></code>Y.Do.AlterArgs(message, newArgArray)</code></dt>\n <dd>Replace the arguments that the original function will be\n called with.</dd>\n <dt></code>Y.Do.Prevent(message)</code></dt>\n <dd>Don't execute the wrapped function. Other before phase\n wrappers will be executed.</dd>\n</dl>",

61636

"itemtype": "method",

61637

"name": "before",

61638

"params": [

61639

{

61640

"name": "fn",

61641

"description": "the function to execute",

61642

"type": "Function"

61643

},

61644

{

61645

"name": "obj",

61646

"description": "the object hosting the method to displace"

61647

},

61648

{

61649

"name": "sFn",

61650

"description": "the name of the method to displace",

61651

"type": "String"

61652

},

61653

{

61654

"name": "c",

61655

"description": "The execution context for fn"

61656

},

61657

{

61658

"name": "arg",

61659

"description": "0..n additional arguments to supply to the subscriber\nwhen the event fires.",

61660

"type": "Mixed",

61661

"multiple": true

61662

}

61663

],

61664

"return": {

61665

"description": "handle for the subscription",

61666

"type": "String"

61667

},

61668

"static": 1,

61669

"class": "Do",

61670

"module": "event-custom",

61671

"submodule": "event-custom-base"

61672

},

61673

{

61674

"file": "event-custom/js/event-do.js",

61675

"line": 66,

61676

"description": "Execute the supplied method after the specified function. Wrapping\nfunction may optionally return an instance of the following classes to\nfurther alter runtime behavior:\n<dl>\n <dt></code>Y.Do.Halt(message, returnValue)</code></dt>\n <dd>Immediatly stop execution and return\n <code>returnValue</code>. No other wrapping functions will be\n executed.</dd>\n <dt></code>Y.Do.AlterReturn(message, returnValue)</code></dt>\n <dd>Return <code>returnValue</code> instead of the wrapped\n method's original return value. This can be further altered by\n other after phase wrappers.</dd>\n</dl>\n\nThe static properties <code>Y.Do.originalRetVal</code> and\n<code>Y.Do.currentRetVal</code> will be populated for reference.",

61677

"itemtype": "method",

61678

"name": "after",

61679

"params": [

61680

{

61681

"name": "fn",

61682

"description": "the function to execute",

61683

"type": "Function"

61684

},

61685

{

61686

"name": "obj",

61687

"description": "the object hosting the method to displace"

61688

},

61689

{

61690

"name": "sFn",

61691

"description": "the name of the method to displace",

61692

"type": "String"

61693

},

61694

{

61695

"name": "c",

61696

"description": "The execution context for fn"

61697

},

61698

{

61699

"name": "arg",

61700

"description": "0..n additional arguments to supply to the subscriber",

61701

"type": "Mixed",

61702

"multiple": true

61703

}

61704

],

61705

"return": {

61706

"description": "handle for the subscription",

61707

"type": "String"

61708

},

61709

"static": 1,

61710

"class": "Do",

61711

"module": "event-custom",

61712

"submodule": "event-custom-base"

61713

},

61714

{

61715

"file": "event-custom/js/event-do.js",

61716

"line": 103,

61717

"description": "Execute the supplied method before or after the specified function.\nUsed by <code>before</code> and <code>after</code>.",

61718

"itemtype": "method",

61719

"name": "_inject",

61720

"params": [

61721

{

61722

"name": "when",

61723

"description": "before or after",

61724

"type": "String"

61725

},

61726

{

61727

"name": "fn",

61728

"description": "the function to execute",

61729

"type": "Function"

61730

},

61731

{

61732

"name": "obj",

61733

"description": "the object hosting the method to displace"

61734

},

61735

{

61736

"name": "sFn",

61737

"description": "the name of the method to displace",

61738

"type": "String"

61739

},

61740

{

61741

"name": "c",

61742

"description": "The execution context for fn"

61743

}

61744

],

61745

"return": {

61746

"description": "handle for the subscription",

61747

"type": "String"

61748

},

61749

"access": "private",

61750

"tagname": "",

61751

"static": 1,

61752

"class": "Do",

61753

"module": "event-custom",

61754

"submodule": "event-custom-base"

61755

},

61756

{

61757

"file": "event-custom/js/event-do.js",

61758

"line": 150,

61759

"description": "Detach a before or after subscription.",

61760

"itemtype": "method",

61761

"name": "detach",

61762

"params": [

61763

{

61764

"name": "handle",

61765

"description": "the subscription handle",

61766

"type": "String"

61767

}

61768

],

61769

"static": 1,

61770

"class": "Do",

61771

"module": "event-custom",

61772

"submodule": "event-custom-base"

61773

},

61774

{

61775

"file": "event-custom/js/event-do.js",

61776

"line": 174,

61777

"description": "Contains the return value from the wrapped method, accessible\nby 'after' event listeners.",

61778

"itemtype": "property",

61779

"name": "originalRetVal",

61780

"static": 1,

61781

"since": "3.2.0",

61782

"class": "Do",

61783

"module": "event-custom",

61784

"submodule": "event-custom-base"

61785

},

61786

{

61787

"file": "event-custom/js/event-do.js",

61788

"line": 183,

61789

"description": "Contains the current state of the return value, consumable by\n'after' event listeners, and updated if an after subscriber\nchanges the return value generated by the wrapped function.",

61790

"itemtype": "property",

61791

"name": "currentRetVal",

61792

"static": 1,

61793

"since": "3.2.0",

61794

"class": "Do",

61795

"module": "event-custom",

61796

"submodule": "event-custom-base"

61797

},

61798

{

61799

"file": "event-custom/js/event-do.js",

61800

"line": 210,

61801

"description": "Register a aop subscriber",

61802

"itemtype": "method",

61803

"name": "register",

61804

"params": [

61805

{

61806

"name": "sid",

61807

"description": "the subscriber id",

61808

"type": "String"

61809

},

61810

{

61811

"name": "fn",

61812

"description": "the function to execute",

61813

"type": "Function"

61814

},

61815

{

61816

"name": "when",

61817

"description": "when to execute the function",

61818

"type": "String"

61819

}

61820

],

61821

"class": "Do.Method",

61822

"module": "event-custom",

61823

"submodule": "event-custom-base"

61824

},

61825

{

61826

"file": "event-custom/js/event-do.js",

61827

"line": 225,

61828

"description": "Unregister a aop subscriber",

61829

"itemtype": "method",

61830

"name": "delete",

61831

"params": [

61832

{

61833

"name": "sid",

61834

"description": "the subscriber id",

61835

"type": "String"

61836

},

61837

{

61838

"name": "fn",

61839

"description": "the function to execute",

61840

"type": "Function"

61841

},

61842

{

61843

"name": "when",

61844

"description": "when to execute the function",

61845

"type": "String"

61846

}

61847

],

61848

"class": "Do.Method",

61849

"module": "event-custom",

61850

"submodule": "event-custom-base"

61851

},

61852

{

61853

"file": "event-custom/js/event-do.js",

61854

"line": 238,

61855

"description": "Execute the wrapped method. All arguments are passed into the wrapping\nfunctions. If any of the before wrappers return an instance of\n<code>Y.Do.Halt</code> or <code>Y.Do.Prevent</code>, neither the wrapped\nfunction nor any after phase subscribers will be executed.\n\nThe return value will be the return value of the wrapped function or one\nprovided by a wrapper function via an instance of <code>Y.Do.Halt</code> or\n<code>Y.Do.AlterReturn</code>.",

61856

"itemtype": "method",

61857

"name": "exec",

61858

"params": [

61859

{

61860

"name": "arg",

61861

"description": "Arguments are passed to the wrapping and wrapped functions",

61862

"type": "Any",

61863

"multiple": true

61864

}

61865

],

61866

"return": {

61867

"description": "Return value of wrapped function unless overwritten (see above)",

61868

"type": "Any"

61869

},

61870

"class": "Do.Method",

61871

"module": "event-custom",

61872

"submodule": "event-custom-base"

61873

},

61874

{

61875

"file": "event-custom/js/event-facade.js",

61876

"line": 29,

61877

"description": "The arguments passed to fire",

61878

"itemtype": "property",

61879

"name": "details",

61880

"type": "Array",

61881

"class": "EventFacade",

61882

"module": "event-custom",

61883

"submodule": "event-custom-complex"

61884

},

61885

{

61886

"file": "event-custom/js/event-facade.js",

61887

"line": 36,

61888

"description": "The event type, this can be overridden by the fire() payload",

61889

"itemtype": "property",

61890

"name": "type",

61891

"type": "string",

61892

"class": "EventFacade",

61893

"module": "event-custom",

61894

"submodule": "event-custom-complex"

61895

},

61896

{

61897

"file": "event-custom/js/event-facade.js",

61898

"line": 43,

61899

"description": "The real event type",

61900

"itemtype": "property",

61901

"name": "_type",

61902

"type": "string",

61903

"access": "private",

61904

"tagname": "",

61905

"class": "EventFacade",

61906

"module": "event-custom",

61907

"submodule": "event-custom-complex"

61908

},

61909

{

61910

"file": "event-custom/js/event-facade.js",

61911

"line": 53,

61912

"description": "Node reference for the targeted eventtarget",

61913

"itemtype": "property",

61914

"name": "target",

61915

"type": "Node",

61916

"class": "EventFacade",

61917

"module": "event-custom",

61918

"submodule": "event-custom-complex"

61919

},

61920

{

61921

"file": "event-custom/js/event-facade.js",

61922

"line": 60,

61923

"description": "Node reference for the element that the listener was attached to.",

61924

"itemtype": "property",

61925

"name": "currentTarget",

61926

"type": "Node",

61927

"class": "EventFacade",

61928

"module": "event-custom",

61929

"submodule": "event-custom-complex"

61930

},

61931

{

61932

"file": "event-custom/js/event-facade.js",

61933

"line": 67,

61934

"description": "Node reference to the relatedTarget",

61935

"itemtype": "property",

61936

"name": "relatedTarget",

61937

"type": "Node",

61938

"class": "EventFacade",

61939

"module": "event-custom",

61940

"submodule": "event-custom-complex"

61941

},

61942

{

61943

"file": "event-custom/js/event-facade.js",

61944

"line": 78,

61945

"description": "Stops the propagation to the next bubble target",

61946

"itemtype": "method",

61947

"name": "stopPropagation",

61948

"class": "EventFacade",

61949

"module": "event-custom",

61950

"submodule": "event-custom-complex"

61951

},

61952

{

61953

"file": "event-custom/js/event-facade.js",

61954

"line": 87,

61955

"description": "Stops the propagation to the next bubble target and\nprevents any additional listeners from being exectued\non the current target.",

61956

"itemtype": "method",

61957

"name": "stopImmediatePropagation",

61958

"class": "EventFacade",

61959

"module": "event-custom",

61960

"submodule": "event-custom-complex"

61961

},

61962

{

61963

"file": "event-custom/js/event-facade.js",

61964

"line": 98,

61965

"description": "Prevents the event's default behavior",

61966

"itemtype": "method",

61967

"name": "preventDefault",

61968

"class": "EventFacade",

61969

"module": "event-custom",

61970

"submodule": "event-custom-complex"

61971

},

61972

{

61973

"file": "event-custom/js/event-facade.js",

61974

"line": 107,

61975

"description": "Stops the event propagation and prevents the default\nevent behavior.",

61976

"itemtype": "method",

61977

"name": "halt",

61978

"params": [

61979

{

61980

"name": "immediate",

61981

"description": "if true additional listeners\non the current target will not be executed",

61982

"type": "Boolean"

61983

}

61984

],

61985

"class": "EventFacade",

61986

"module": "event-custom",

61987

"submodule": "event-custom-complex"

61988

},

61989

{

61990

"file": "event-custom/js/event-facade.js",

61991

"line": 327,

61992

"description": "Stop propagation to bubble targets",

61993

"itemtype": "method",

61994

"name": "stopPropagation",

61995

"class": "CustomEvent",

61996

"module": "event-custom",

61997

"submodule": "event-custom-complex"

61998

},

61999

{

62000

"file": "event-custom/js/event-facade.js",

62001

"line": 340,

62002

"description": "Stops propagation to bubble targets, and prevents any remaining\nsubscribers on the current target from executing.",

62003

"itemtype": "method",

62004

"name": "stopImmediatePropagation",

62005

"class": "CustomEvent",

62006

"module": "event-custom",

62007

"submodule": "event-custom-complex"

62008

},

62009

{

62010

"file": "event-custom/js/event-facade.js",

62011

"line": 353,

62012

"description": "Prevents the execution of this event's defaultFn",

62013

"itemtype": "method",

62014

"name": "preventDefault",

62015

"class": "CustomEvent",

62016

"module": "event-custom",

62017

"submodule": "event-custom-complex"

62018

},

62019

{

62020

"file": "event-custom/js/event-facade.js",

62021

"line": 366,

62022

"description": "Stops the event propagation and prevents the default\nevent behavior.",

62023

"itemtype": "method",

62024

"name": "halt",

62025

"params": [

62026

{

62027

"name": "immediate",

62028

"description": "if true additional listeners\non the current target will not be executed",

62029

"type": "Boolean"

62030

}

62031

],

62032

"class": "CustomEvent",

62033

"module": "event-custom",

62034

"submodule": "event-custom-complex"

62035

},

62036

{

62037

"file": "event-custom/js/event-facade.js",

62038

"line": 382,

62039

"description": "Registers another EventTarget as a bubble target. Bubble order\nis determined by the order registered. Multiple targets can\nbe specified.\n\nEvents can only bubble if emitFacade is true.\n\nIncluded in the event-custom-complex submodule.",

62040

"itemtype": "method",

62041

"name": "addTarget",

62042

"params": [

62043

{

62044

"name": "o",

62045

"description": "the target to add",

62046

"type": "EventTarget"

62047

}

62048

],

62049

"class": "EventTarget",

62050

"module": "event-custom",

62051

"submodule": "event-custom-complex"

62052

},

62053

{

62054

"file": "event-custom/js/event-facade.js",

62055

"line": 400,

62056

"description": "Returns an array of bubble targets for this object.",

62057

"itemtype": "method",

62058

"name": "getTargets",

62059

"return": {

62060

"description": "EventTarget[]"

62061

},

62062

"class": "EventTarget",

62063

"module": "event-custom",

62064

"submodule": "event-custom-complex"

62065

},

62066

{

62067

"file": "event-custom/js/event-facade.js",

62068

"line": 409,

62069

"description": "Removes a bubble target",

62070

"itemtype": "method",

62071

"name": "removeTarget",

62072

"params": [

62073

{

62074

"name": "o",

62075

"description": "the target to remove",

62076

"type": "EventTarget"

62077

}

62078

],

62079

"class": "EventTarget",

62080

"module": "event-custom",

62081

"submodule": "event-custom-complex"

62082

},

62083

{

62084

"file": "event-custom/js/event-facade.js",

62085

"line": 419,

62086

"description": "Propagate an event. Requires the event-custom-complex module.",

62087

"itemtype": "method",

62088

"name": "bubble",

62089

"params": [

62090

{

62091

"name": "evt",

62092

"description": "the custom event to propagate",

62093

"type": "CustomEvent"

62094

}

62095

],

62096

"return": {

62097

"description": "the aggregated return value from Event.Custom.fire",

62098

"type": "Boolean"

62099

},

62100

"class": "EventTarget",

62101

"module": "event-custom",

62102

"submodule": "event-custom-complex"

62103

},

62104

{

62105

"file": "event-custom/js/event-target.js",

62106

"line": 36,

62107

"description": "If the instance has a prefix attribute and the\nevent type is not prefixed, the instance prefix is\napplied to the supplied type.",

62108

"itemtype": "method",

62109

"name": "_getType",

62110

"access": "private",

62111

"tagname": "",

62112

"class": "EventTarget",

62113

"module": "event-custom",

62114

"submodule": "event-custom-base"

62115

},

62116

{

62117

"file": "event-custom/js/event-target.js",

62118

"line": 52,

62119

"description": "Returns an array with the detach key (if provided),\nand the prefixed event name from _getType\nY.on('detachcategory| menu:click', fn)",

62120

"itemtype": "method",

62121

"name": "_parseType",

62122

"access": "private",

62123

"tagname": "",

62124

"class": "EventTarget",

62125

"module": "event-custom",

62126

"submodule": "event-custom-base"

62127

},

62128

{

62129

"file": "event-custom/js/event-target.js",

62130

"line": 128,

62131

"description": "Listen to a custom event hosted by this object one time.\nThis is the equivalent to <code>on</code> except the\nlistener is immediatelly detached when it is executed.",

62132

"itemtype": "method",

62133

"name": "once",

62134

"params": [

62135

{

62136

"name": "type",

62137

"description": "The name of the event",

62138

"type": "String"

62139

},

62140

{

62141

"name": "fn",

62142

"description": "The callback to execute in response to the event",

62143

"type": "Function"

62144

},

62145

{

62146

"name": "context",

62147

"description": "Override `this` object in callback",

62148

"type": "Object",

62149

"optional": true

62150

},

62151

{

62152

"name": "arg*",

62153

"description": "0..n additional arguments to supply to the subscriber",

62154

"type": "Any",

62155

"optional": true

62156

}

62157

],

62158

"return": {

62159

"description": "A subscription handle capable of detaching the\n subscription",

62160

"type": "EventHandle"

62161

},

62162

"class": "EventTarget",

62163

"module": "event-custom",

62164

"submodule": "event-custom-base"

62165

},

62166

{

62167

"file": "event-custom/js/event-target.js",

62168

"line": 150,

62169

"description": "Listen to a custom event hosted by this object one time.\nThis is the equivalent to <code>after</code> except the\nlistener is immediatelly detached when it is executed.",

62170

"itemtype": "method",

62171

"name": "onceAfter",

62172

"params": [

62173

{

62174

"name": "type",

62175

"description": "The name of the event",

62176

"type": "String"

62177

},

62178

{

62179

"name": "fn",

62180

"description": "The callback to execute in response to the event",

62181

"type": "Function"

62182

},

62183

{

62184

"name": "context",

62185

"description": "Override `this` object in callback",

62186

"type": "Object",

62187

"optional": true

62188

},

62189

{

62190

"name": "arg*",

62191

"description": "0..n additional arguments to supply to the subscriber",

62192

"type": "Any",

62193

"optional": true

62194

}

62195

],

62196

"return": {

62197

"description": "A subscription handle capable of detaching that\n subscription",

62198

"type": "EventHandle"

62199

},

62200

"class": "EventTarget",

62201

"module": "event-custom",

62202

"submodule": "event-custom-base"

62203

},

62204

{

62205

"file": "event-custom/js/event-target.js",

62206

"line": 172,

62207

"description": "Takes the type parameter passed to 'on' and parses out the\nvarious pieces that could be included in the type. If the\nevent type is passed without a prefix, it will be expanded\nto include the prefix one is supplied or the event target\nis configured with a default prefix.",

62208

"itemtype": "method",

62209

"name": "parseType",

62210

"params": [

62211

{

62212

"name": "type",

62213

"description": "the type",

62214

"type": "String"

62215

},

62216

{

62217

"name": "pre",

62218

"description": "the prefix",

62219

"type": "String",

62220

"optional": true,

62221

"optdefault": "this._yuievt.config.prefix"

62222

}

62223

],

62224

"since": "3.3.0",

62225

"return": {

62226

"description": "an array containing:\n * the detach category, if supplied,\n * the prefixed event type,\n * whether or not this is an after listener,\n * the supplied event type",

62227

"type": "Array"

62228

},

62229

"class": "EventTarget",

62230

"module": "event-custom",

62231

"submodule": "event-custom-base"

62232

},

62233

{

62234

"file": "event-custom/js/event-target.js",

62235

"line": 192,

62236

"description": "Subscribe a callback function to a custom event fired by this object or\nfrom an object that bubbles its events to this object.\n\nCallback functions for events published with `emitFacade = true` will\nreceive an `EventFacade` as the first argument (typically named \"e\").\nThese callbacks can then call `e.preventDefault()` to disable the\nbehavior published to that event's `defaultFn`. See the `EventFacade`\nAPI for all available properties and methods. Subscribers to\nnon-`emitFacade` events will receive the arguments passed to `fire()`\nafter the event name.\n\nTo subscribe to multiple events at once, pass an object as the first\nargument, where the key:value pairs correspond to the eventName:callback,\nor pass an array of event names as the first argument to subscribe to\nall listed events with the same callback.\n\nReturning `false` from a callback is supported as an alternative to\ncalling `e.preventDefault(); e.stopPropagation();`. However, it is\nrecommended to use the event methods whenever possible.",

62237

"itemtype": "method",

62238

"name": "on",

62239

"params": [

62240

{

62241

"name": "type",

62242

"description": "The name of the event",

62243

"type": "String"

62244

},

62245

{

62246

"name": "fn",

62247

"description": "The callback to execute in response to the event",

62248

"type": "Function"

62249

},

62250

{

62251

"name": "context",

62252

"description": "Override `this` object in callback",

62253

"type": "Object",

62254

"optional": true

62255

},

62256

{

62257

"name": "arg*",

62258

"description": "0..n additional arguments to supply to the subscriber",

62259

"type": "Any",

62260

"optional": true

62261

}

62262

],

62263

"return": {

62264

"description": "A subscription handle capable of detaching that\n subscription",

62265

"type": "EventHandle"

62266

},

62267

"class": "EventTarget",

62268

"module": "event-custom",

62269

"submodule": "event-custom-base"

62270

},

62271

{

62272

"file": "event-custom/js/event-target.js",

62273

"line": 335,

62274

"description": "subscribe to an event",

62275

"itemtype": "method",

62276

"name": "subscribe",

62277

"deprecated": true,

62278

"deprecationMessage": "use on",

62279

"class": "EventTarget",

62280

"module": "event-custom",

62281

"submodule": "event-custom-base"

62282

},

62283

{

62284

"file": "event-custom/js/event-target.js",

62285

"line": 345,

62286

"description": "Detach one or more listeners the from the specified event",

62287

"itemtype": "method",

62288

"name": "detach",

62289

"params": [

62290

{

62291

"name": "type",

62292

"description": "Either the handle to the subscriber or the\n type of event. If the type\n is not specified, it will attempt to remove\n the listener from all hosted events.",

62293

"type": "String|Object"

62294

},

62295

{

62296

"name": "fn",

62297

"description": "The subscribed function to unsubscribe, if not\n supplied, all subscribers will be removed.",

62298

"type": "Function"

62299

},

62300

{

62301

"name": "context",

62302

"description": "The custom object passed to subscribe. This is\n optional, but if supplied will be used to\n disambiguate multiple listeners that are the same\n (e.g., you subscribe many object using a function\n that lives on the prototype)",

62303

"type": "Object"

62304

}

62305

],

62306

"return": {

62307

"description": "the host",

62308

"type": "EventTarget"

62309

},

62310

"class": "EventTarget",

62311

"module": "event-custom",

62312

"submodule": "event-custom-base"

62313

},

62314

{

62315

"file": "event-custom/js/event-target.js",

62316

"line": 455,

62317

"description": "detach a listener",

62318

"itemtype": "method",

62319

"name": "unsubscribe",

62320

"deprecated": true,

62321

"deprecationMessage": "use detach",

62322

"class": "EventTarget",

62323

"module": "event-custom",

62324

"submodule": "event-custom-base"

62325

},

62326

{

62327

"file": "event-custom/js/event-target.js",

62328

"line": 465,

62329

"description": "Removes all listeners from the specified event. If the event type\nis not specified, all listeners from all hosted custom events will\nbe removed.",

62330

"itemtype": "method",

62331

"name": "detachAll",

62332

"params": [

62333

{

62334

"name": "type",

62335

"description": "The type, or name of the event",

62336

"type": "String"

62337

}

62338

],

62339

"class": "EventTarget",

62340

"module": "event-custom",

62341

"submodule": "event-custom-base"

62342

},

62343

{

62344

"file": "event-custom/js/event-target.js",

62345

"line": 476,

62346

"description": "Removes all listeners from the specified event. If the event type\nis not specified, all listeners from all hosted custom events will\nbe removed.",

62347

"itemtype": "method",

62348

"name": "unsubscribeAll",

62349

"params": [

62350

{

62351

"name": "type",

62352

"description": "The type, or name of the event",

62353

"type": "String"

62354

}

62355

],

62356

"deprecated": true,

62357

"deprecationMessage": "use detachAll",

62358

"class": "EventTarget",

62359

"module": "event-custom",

62360

"submodule": "event-custom-base"

62361

},

62362

{

62363

"file": "event-custom/js/event-target.js",

62364

"line": 489,

62365

"description": "Creates a new custom event of the specified type. If a custom event\nby that name already exists, it will not be re-created. In either\ncase the custom event is returned.",

62366

"itemtype": "method",

62367

"name": "publish",

62368

"params": [

62369

{

62370

"name": "type",

62371

"description": "the type, or name of the event",

62372

"type": "String"

62373

},

62374

{

62375

"name": "opts",

62376

"description": "optional config params. Valid properties are:\n\n <ul>\n <li>\n 'broadcast': whether or not the YUI instance and YUI global are notified when the event is fired (false)\n </li>\n <li>\n 'bubbles': whether or not this event bubbles (true)\n Events can only bubble if emitFacade is true.\n </li>\n <li>\n 'context': the default execution context for the listeners (this)\n </li>\n <li>\n 'defaultFn': the default function to execute when this event fires if preventDefault was not called\n </li>\n <li>\n 'emitFacade': whether or not this event emits a facade (false)\n </li>\n <li>\n 'prefix': the prefix for this targets events, e.g., 'menu' in 'menu:click'\n </li>\n <li>\n 'fireOnce': if an event is configured to fire once, new subscribers after\n the fire will be notified immediately.\n </li>\n <li>\n 'async': fireOnce event listeners will fire synchronously if the event has already\n fired unless async is true.\n </li>\n <li>\n 'preventable': whether or not preventDefault() has an effect (true)\n </li>\n <li>\n 'preventedFn': a function that is executed when preventDefault is called\n </li>\n <li>\n 'queuable': whether or not this event can be queued during bubbling (false)\n </li>\n <li>\n 'silent': if silent is true, debug messages are not provided for this event.\n </li>\n <li>\n 'stoppedFn': a function that is executed when stopPropagation is called\n </li>\n\n <li>\n 'monitored': specifies whether or not this event should send notifications about\n when the event has been attached, detached, or published.\n </li>\n <li>\n 'type': the event type (valid option if not provided as the first parameter to publish)\n </li>\n </ul>",

62377

"type": "Object"

62378

}

62379

],

62380

"return": {

62381

"description": "the custom event",

62382

"type": "CustomEvent"

62383

},

62384

"class": "EventTarget",

62385

"module": "event-custom",

62386

"submodule": "event-custom-base"

62387

},

62388

{

62389

"file": "event-custom/js/event-target.js",

62390

"line": 602,

62391

"description": "This is the entry point for the event monitoring system.\nYou can monitor 'attach', 'detach', 'fire', and 'publish'.\nWhen configured, these events generate an event. click ->\nclick_attach, click_detach, click_publish -- these can\nbe subscribed to like other events to monitor the event\nsystem. Inividual published events can have monitoring\nturned on or off (publish can't be turned off before it\nit published) by setting the events 'monitor' config.",

62392

"itemtype": "method",

62393

"name": "_monitor",

62394

"params": [

62395

{

62396

"name": "what",

62397

"description": "'attach', 'detach', 'fire', or 'publish'",

62398

"type": "String"

62399

},

62400

{

62401

"name": "type",

62402

"description": "Name of the event being monitored",

62403

"type": "String"

62404

},

62405

{

62406

"name": "o",

62407

"description": "Information about the event interaction, such as\n fire() args, subscription category, publish config",

62408

"type": "Object"

62409

}

62410

],

62411

"access": "private",

62412

"tagname": "",

62413

"class": "EventTarget",

62414

"module": "event-custom",

62415

"submodule": "event-custom-base"

62416

},

62417

{

62418

"file": "event-custom/js/event-target.js",

62419

"line": 629,

62420

"description": "Fire a custom event by name. The callback functions will be executed\nfrom the context specified when the event was created, and with the\nfollowing parameters.\n\nIf the custom event object hasn't been created, then the event hasn't\nbeen published and it has no subscribers. For performance sake, we\nimmediate exit in this case. This means the event won't bubble, so\nif the intention is that a bubble target be notified, the event must\nbe published on this object first.\n\nThe first argument is the event type, and any additional arguments are\npassed to the listeners as parameters. If the first of these is an\nobject literal, and the event is configured to emit an event facade,\nthat object is mixed into the event facade and the facade is provided\nin place of the original object.",

62421

"itemtype": "method",

62422

"name": "fire",

62423

"params": [

62424

{

62425

"name": "type",

62426

"description": "The type of the event, or an object that contains\na 'type' property.",

62427

"type": "String|Object"

62428

},

62429

{

62430

"name": "arguments",

62431

"description": "an arbitrary set of parameters to pass to\nthe handler. If the first of these is an object literal and the event is\nconfigured to emit an event facade, the event facade will replace that\nparameter after the properties the object literal contains are copied to\nthe event facade.",

62432

"type": "Object*"

62433

}

62434

],

62435

"return": {

62436

"description": "the event host",

62437

"type": "EventTarget"

62438

},

62439

"class": "EventTarget",

62440

"module": "event-custom",

62441

"submodule": "event-custom-base"

62442

},

62443

{

62444

"file": "event-custom/js/event-target.js",

62445

"line": 712,

62446

"description": "Returns the custom event of the provided type has been created, a\nfalsy value otherwise",

62447

"itemtype": "method",

62448

"name": "getEvent",

62449

"params": [

62450

{

62451

"name": "type",

62452

"description": "the type, or name of the event",

62453

"type": "String"

62454

},

62455

{

62456

"name": "prefixed",

62457

"description": "if true, the type is prefixed already",

62458

"type": "String"

62459

}

62460

],

62461

"return": {

62462

"description": "the custom event or null",

62463

"type": "CustomEvent"

62464

},

62465

"class": "EventTarget",

62466

"module": "event-custom",

62467

"submodule": "event-custom-base"

62468

},

62469

{

62470

"file": "event-custom/js/event-target.js",

62471

"line": 730,

62472

"description": "Subscribe to a custom event hosted by this object. The\nsupplied callback will execute after any listeners add\nvia the subscribe method, and after the default function,\nif configured for the event, has executed.",

62473

"itemtype": "method",

62474

"name": "after",

62475

"params": [

62476

{

62477

"name": "type",

62478

"description": "The name of the event",

62479

"type": "String"

62480

},

62481

{

62482

"name": "fn",

62483

"description": "The callback to execute in response to the event",

62484

"type": "Function"

62485

},

62486

{

62487

"name": "context",

62488

"description": "Override `this` object in callback",

62489

"type": "Object",

62490

"optional": true

62491

},

62492

{

62493

"name": "arg*",

62494

"description": "0..n additional arguments to supply to the subscriber",

62495

"type": "Any",

62496

"optional": true

62497

}

62498

],

62499

"return": {

62500

"description": "A subscription handle capable of detaching the\n subscription",

62501

"type": "EventHandle"

62502

},

62503

"class": "EventTarget",

62504

"module": "event-custom",

62505

"submodule": "event-custom-base"

62506

},

62507

{

62508

"file": "event-custom/js/event-target.js",

62509

"line": 767,

62510

"description": "Executes the callback before a DOM event, custom event\nor method. If the first argument is a function, it\nis assumed the target is a method. For DOM and custom\nevents, this is an alias for Y.on.\n\nFor DOM and custom events:\ntype, callback, context, 0-n arguments\n\nFor methods:\ncallback, object (method host), methodName, context, 0-n arguments",

62511

"itemtype": "method",

62512

"name": "before",

62513

"return": {

62514

"description": "detach handle"

62515

},

62516

"class": "EventTarget",

62517

"module": "event-custom",

62518

"submodule": "event-custom-base"

62519

},

62520

{

62521

"file": "event-custom/js/event-target.js",

62522

"line": 796,

62523

"description": "Hosts YUI page level events. This is where events bubble to\nwhen the broadcast config is set to 2. This property is\nonly available if the custom event module is loaded.",

62524

"itemtype": "property",

62525

"name": "Global",

62526

"type": "EventTarget",

62527

"class": "YUI",

62528

"module": "event-custom",

62529

"submodule": "event-custom-base"

62530

},

62531

{

62532

"file": "event-custom/js/event-target.js",

62533

"line": 808,

62534

"description": "`Y.on()` can do many things:\n\n<ul>\n <li>Subscribe to custom events `publish`ed and `fire`d from Y</li>\n <li>Subscribe to custom events `publish`ed with `broadcast` 1 or 2 and\n `fire`d from any object in the YUI instance sandbox</li>\n <li>Subscribe to DOM events</li>\n <li>Subscribe to the execution of a method on any object, effectively\n treating that method as an event</li>\n</ul>\n\nFor custom event subscriptions, pass the custom event name as the first argument and callback as the second. The `this` object in the callback will be `Y` unless an override is passed as the third argument.\n\n Y.on('io:complete', function () {\n Y.MyApp.updateStatus('Transaction complete');\n });\n\nTo subscribe to DOM events, pass the name of a DOM event as the first argument\nand a CSS selector string as the third argument after the callback function.\nAlternately, the third argument can be a `Node`, `NodeList`, `HTMLElement`,\narray, or simply omitted (the default is the `window` object).\n\n Y.on('click', function (e) {\n e.preventDefault();\n\n // proceed with ajax form submission\n var url = this.get('action');\n ...\n }, '#my-form');\n\nThe `this` object in DOM event callbacks will be the `Node` targeted by the CSS\nselector or other identifier.\n\n`on()` subscribers for DOM events or custom events `publish`ed with a\n`defaultFn` can prevent the default behavior with `e.preventDefault()` from the\nevent object passed as the first parameter to the subscription callback.\n\nTo subscribe to the execution of an object method, pass arguments corresponding to the call signature for \n<a href=\"../classes/Do.html#methods_before\">`Y.Do.before(...)`</a>.\n\nNOTE: The formal parameter list below is for events, not for function\ninjection. See `Y.Do.before` for that signature.",

62535

"itemtype": "method",

62536

"name": "on",

62537

"params": [

62538

{

62539

"name": "type",

62540

"description": "DOM or custom event name",

62541

"type": "String"

62542

},

62543

{

62544

"name": "fn",

62545

"description": "The callback to execute in response to the event",

62546

"type": "Function"

62547

},

62548

{

62549

"name": "context",

62550

"description": "Override `this` object in callback",

62551

"type": "Object",

62552

"optional": true

62553

},

62554

{

62555

"name": "arg*",

62556

"description": "0..n additional arguments to supply to the subscriber",

62557

"type": "Any",

62558

"optional": true

62559

}

62560

],

62561

"return": {

62562

"description": "A subscription handle capable of detaching the\n subscription",

62563

"type": "EventHandle"

62564

},

62565

"see": [

62566

"Do.before"

62567

],

62568

"class": "YUI",

62569

"module": "event-custom",

62570

"submodule": "event-custom-base"

62571

},

62572

{

62573

"file": "event-custom/js/event-target.js",

62574

"line": 863,

62575

"description": "Listen for an event one time. Equivalent to `on()`, except that\nthe listener is immediately detached when executed.\n\nSee the <a href=\"#methods_on\">`on()` method</a> for additional subscription\noptions.",

62576

"see": [

62577

"on"

62578

],

62579

"itemtype": "method",

62580

"name": "once",

62581

"params": [

62582

{

62583

"name": "type",

62584

"description": "DOM or custom event name",

62585

"type": "String"

62586

},

62587

{

62588

"name": "fn",

62589

"description": "The callback to execute in response to the event",

62590

"type": "Function"

62591

},

62592

{

62593

"name": "context",

62594

"description": "Override `this` object in callback",

62595

"type": "Object",

62596

"optional": true

62597

},

62598

{

62599

"name": "arg*",

62600

"description": "0..n additional arguments to supply to the subscriber",

62601

"type": "Any",

62602

"optional": true

62603

}

62604

],

62605

"return": {

62606

"description": "A subscription handle capable of detaching the\n subscription",

62607

"type": "EventHandle"

62608

},

62609

"class": "YUI",

62610

"module": "event-custom",

62611

"submodule": "event-custom-base"

62612

},

62613

{

62614

"file": "event-custom/js/event-target.js",

62615

"line": 881,

62616

"description": "Listen for an event one time. Equivalent to `once()`, except, like `after()`,\nthe subscription callback executes after all `on()` subscribers and the event's\n`defaultFn` (if configured) have executed. Like `after()` if any `on()` phase\nsubscriber calls `e.preventDefault()`, neither the `defaultFn` nor the `after()`\nsubscribers will execute.\n\nThe listener is immediately detached when executed.\n\nSee the <a href=\"#methods_on\">`on()` method</a> for additional subscription\noptions.",

62617

"see": [

62618

"once"

62619

],

62620

"itemtype": "method",

62621

"name": "onceAfter",

62622

"params": [

62623

{

62624

"name": "type",

62625

"description": "The custom event name",

62626

"type": "String"

62627

},

62628

{

62629

"name": "fn",

62630

"description": "The callback to execute in response to the event",

62631

"type": "Function"

62632

},

62633

{

62634

"name": "context",

62635

"description": "Override `this` object in callback",

62636

"type": "Object",

62637

"optional": true

62638

},

62639

{

62640

"name": "arg*",

62641

"description": "0..n additional arguments to supply to the subscriber",

62642

"type": "Any",

62643

"optional": true

62644

}

62645

],

62646

"return": {

62647

"description": "A subscription handle capable of detaching the\n subscription",

62648

"type": "EventHandle"

62649

},

62650

"class": "YUI",

62651

"module": "event-custom",

62652

"submodule": "event-custom-base"

62653

},

62654

{

62655

"file": "event-custom/js/event-target.js",

62656

"line": 904,

62657

"description": "Like `on()`, this method creates a subscription to a custom event or to the\nexecution of a method on an object.\n\nFor events, `after()` subscribers are executed after the event's\n`defaultFn` unless `e.preventDefault()` was called from an `on()` subscriber.\n\nSee the <a href=\"#methods_on\">`on()` method</a> for additional subscription\noptions.\n\nNOTE: The subscription signature shown is for events, not for function\ninjection. See <a href=\"../classes/Do.html#methods_after\">`Y.Do.after`</a>\nfor that signature.",

62658

"see": [

62659

"on",

62660

"Do.after"

62661

],

62662

"itemtype": "method",

62663

"name": "after",

62664

"params": [

62665

{

62666

"name": "type",

62667

"description": "The custom event name",

62668

"type": "String"

62669

},

62670

{

62671

"name": "fn",

62672

"description": "The callback to execute in response to the event",

62673

"type": "Function"

62674

},

62675

{

62676

"name": "context",

62677

"description": "Override `this` object in callback",

62678

"type": "Object",

62679

"optional": true

62680

},

62681

{

62682

"name": "args*",

62683

"description": "0..n additional arguments to supply to the subscriber",

62684

"type": "Any",

62685

"optional": true

62686

}

62687

],

62688

"return": {

62689

"description": "A subscription handle capable of detaching the\n subscription",

62690

"type": "EventHandle"

62691

},

62692

"class": "YUI",

62693

"module": "event-custom",

62694

"submodule": "event-custom-base"

62695

},

62696

{

62697

"file": "event-custom/js/handle.js",

62698

"line": 10,

62699

"description": "The custom event",

62700

"itemtype": "property",

62701

"name": "evt",

62702

"type": "CustomEvent",

62703

"class": "EventHandle",

62704

"module": "event-custom"

62705

},

62706

{

62707

"file": "event-custom/js/handle.js",

62708

"line": 18,

62709

"description": "The subscriber object",

62710

"itemtype": "property",

62711

"name": "sub",

62712

"type": "Subscriber",

62713

"class": "EventHandle",

62714

"module": "event-custom"

62715

},

62716

{

62717

"file": "event-custom/js/handle.js",

62718

"line": 37,

62719

"description": "Detaches this subscriber",

62720

"itemtype": "method",

62721

"name": "detach",

62722

"return": {

62723

"description": "the number of detached listeners",

62724

"type": "Int"

62725

},

62726

"class": "EventHandle",

62727

"module": "event-custom"

62728

},

62729

{

62730

"file": "event-custom/js/handle.js",

62731

"line": 60,

62732

"description": "Monitor the event state for the subscribed event. The first parameter\nis what should be monitored, the rest are the normal parameters when\nsubscribing to an event.",

62733

"itemtype": "method",

62734

"name": "monitor",

62735

"params": [

62736

{

62737

"name": "what",

62738

"description": "what to monitor ('attach', 'detach', 'publish').",

62739

"type": "String"

62740

}

62741

],

62742

"return": {

62743

"description": "return value from the monitor event subscription.",

62744

"type": "EventHandle"

62745

},

62746

"class": "EventHandle",

62747

"module": "event-custom"

62748

},

62749

{

62750

"file": "event-custom/js/subscriber.js",

62751

"line": 12,

62752

"description": "The callback that will be execute when the event fires\nThis is wrapped by Y.rbind if obj was supplied.",

62753

"itemtype": "property",

62754

"name": "fn",

62755

"type": "Function",

62756

"class": "Subscriber",

62757

"module": "event-custom"

62758

},

62759

{

62760

"file": "event-custom/js/subscriber.js",

62761

"line": 20,

62762

"description": "Optional 'this' keyword for the listener",

62763

"itemtype": "property",

62764

"name": "context",

62765

"type": "Object",

62766

"class": "Subscriber",

62767

"module": "event-custom"

62768

},

62769

{

62770

"file": "event-custom/js/subscriber.js",

62771

"line": 27,

62772

"description": "Unique subscriber id",

62773

"itemtype": "property",

62774

"name": "id",

62775

"type": "String",

62776

"class": "Subscriber",

62777

"module": "event-custom"

62778

},

62779

{

62780

"file": "event-custom/js/subscriber.js",

62781

"line": 34,

62782

"description": "Additional arguments to propagate to the subscriber",

62783

"itemtype": "property",

62784

"name": "args",

62785

"type": "Array",

62786

"class": "Subscriber",

62787

"module": "event-custom"

62788

},

62789

{

62790

"file": "event-custom/js/subscriber.js",

62791

"line": 41,

62792

"description": "Custom events for a given fire transaction.",

62793

"itemtype": "property",

62794

"name": "events",

62795

"type": "{EventTarget}",

62796

"class": "Subscriber",

62797

"module": "event-custom"

62798

},

62799

{

62800

"file": "event-custom/js/subscriber.js",

62801

"line": 48,

62802

"description": "This listener only reacts to the event once",

62803

"itemtype": "property",

62804

"name": "once",

62805

"class": "Subscriber",

62806

"module": "event-custom"

62807

},

62808

{

62809

"file": "event-custom/js/subscriber.js",

62810

"line": 94,

62811

"description": "Executes the subscriber.",

62812

"itemtype": "method",

62813

"name": "notify",

62814

"params": [

62815

{

62816

"name": "args",

62817

"description": "Arguments array for the subscriber.",

62818

"type": "Array"

62819

},

62820

{

62821

"name": "ce",

62822

"description": "The custom event that sent the notification.",

62823

"type": "CustomEvent"

62824

}

62825

],

62826

"class": "Subscriber",

62827

"module": "event-custom"

62828

},

62829

{

62830

"file": "event-custom/js/subscriber.js",

62831

"line": 122,

62832

"description": "Returns true if the fn and obj match this objects properties.\nUsed by the unsubscribe method to match the right subscriber.",

62833

"itemtype": "method",

62834

"name": "contains",

62835

"params": [

62836

{

62837

"name": "fn",

62838

"description": "the function to execute.",

62839

"type": "Function"

62840

},

62841

{

62842

"name": "context",

62843

"description": "optional 'this' keyword for the listener.",

62844

"type": "Object"

62845

}

62846

],

62847

"return": {

62848

"description": "true if the supplied arguments match this\n subscriber's signature.",

62849

"type": "Boolean"

62850

},

62851

"class": "Subscriber",

62852

"module": "event-custom"

62853

},

62854

{

62855

"file": "event-gestures/js/Flick.js",

62856

"line": 46,

62857

"description": "Sets up a \"flick\" event, that is fired whenever the user initiates a flick gesture on the node\nwhere the listener is attached. The subscriber can specify a minimum distance or velocity for\nwhich the event is to be fired. The subscriber can also specify if there is a particular axis which\nthey are interested in - \"x\" or \"y\". If no axis is specified, the axis along which there was most distance\ncovered is used.\n\nIt is recommended that you use Y.bind to set up context and additional arguments for your event handler,\nhowever if you want to pass the context and arguments as additional signature arguments to \"on\", \nyou need to provide a null value for the configuration object, e.g: <code>node.on(\"flick\", fn, null, context, arg1, arg2, arg3)</code>",

62858

"itemtype": "event",

62859

"name": "flick",

62860

"params": [

62861

{

62862

"name": "type",

62863

"description": "\"flick\"",

62864

"type": "String"

62865

},

62866

{

62867

"name": "fn",

62868

"description": "The method the event invokes. It receives an event facade with an e.flick object containing the flick related properties: e.flick.time, e.flick.distance, e.flick.velocity and e.flick.axis, e.flick.start.",

62869

"type": "Function"

62870

},

62871

{

62872

"name": "cfg",

62873

"description": "Optional. An object which specifies any of the following:\n<dl>\n<dt>minDistance (in pixels, defaults to 10)</dt>\n<dd>The minimum distance between start and end points, which would qualify the gesture as a flick.</dd>\n<dt>minVelocity (in pixels/ms, defaults to 0)</dt>\n<dd>The minimum velocity which would qualify the gesture as a flick.</dd>\n<dt>preventDefault (defaults to false)</dt>\n<dd>Can be set to true/false to prevent default behavior as soon as the touchstart/touchend or mousedown/mouseup is received so that things like scrolling or text selection can be \nprevented. This property can also be set to a function, which returns true or false, based on the event facade passed to it.</dd>\n<dt>axis (no default)</dt>\n<dd>Can be set to \"x\" or \"y\" if you want to constrain the flick velocity and distance to a single axis. If not\ndefined, the axis along which the maximum distance was covered is used.</dd>\n</dl>",

62874

"type": "Object"

62875

}

62876

],

62877

"return": {

62878

"description": "the detach handle",

62879

"type": "EventHandle"

62880

},

62881

"class": "YUI",

62882

"module": "event-gestures",

62883

"submodule": "event-flick"

62884

},

62885

{

62886

"file": "event-gestures/js/Move.js",

62887

"line": 89,

62888

"description": "Sets up a \"gesturemovestart\" event, that is fired on touch devices in response to a single finger \"touchstart\",\nand on mouse based devices in response to a \"mousedown\". The subscriber can specify the minimum time\nand distance thresholds which should be crossed before the \"gesturemovestart\" is fired and for the mouse,\nwhich button should initiate a \"gesturemovestart\". This event can also be listened for using node.delegate().\n\nIt is recommended that you use Y.bind to set up context and additional arguments for your event handler,\nhowever if you want to pass the context and arguments as additional signature arguments to on/delegate, \nyou need to provide a null value for the configuration object, e.g: <code>node.on(\"gesturemovestart\", fn, null, context, arg1, arg2, arg3)</code>",

62889

"itemtype": "event",

62890

"name": "gesturemovestart",

62891

"params": [

62892

{

62893

"name": "type",

62894

"description": "\"gesturemovestart\"",

62895

"type": "String"

62896

},

62897

{

62898

"name": "fn",

62899

"description": "The method the event invokes. It receives the event facade of the underlying DOM event (mousedown or touchstart.touches[0]) which contains position co-ordinates.",

62900

"type": "Function"

62901

},

62902

{

62903

"name": "cfg",

62904

"description": "Optional. An object which specifies:\n\n<dl>\n<dt>minDistance (defaults to 0)</dt>\n<dd>The minimum distance threshold which should be crossed before the gesturemovestart is fired</dd>\n<dt>minTime (defaults to 0)</dt>\n<dd>The minimum time threshold for which the finger/mouse should be help down before the gesturemovestart is fired</dd>\n<dt>button (no default)</dt>\n<dd>In the case of a mouse input device, if the event should only be fired for a specific mouse button.</dd>\n<dt>preventDefault (defaults to false)</dt>\n<dd>Can be set to true/false to prevent default behavior as soon as the touchstart or mousedown is received (that is before minTime or minDistance thresholds are crossed, and so before the gesturemovestart listener is notified) so that things like text selection and context popups (on touch devices) can be \nprevented. This property can also be set to a function, which returns true or false, based on the event facade passed to it (for example, DragDrop can determine if the target is a valid handle or not before preventing default).</dd>\n</dl>",

62905

"type": "Object"

62906

}

62907

],

62908

"return": {

62909

"description": "the detach handle",

62910

"type": "EventHandle"

62911

},

62912

"class": "YUI",

62913

"module": "event-gestures",

62914

"submodule": "event-move"

62915

},

62916

{

62917

"file": "event-gestures/js/Move.js",

62918

"line": 276,

62919

"description": "Sets up a \"gesturemove\" event, that is fired on touch devices in response to a single finger \"touchmove\",\nand on mouse based devices in response to a \"mousemove\".\n\nBy default this event is only fired when the same node\nhas received a \"gesturemovestart\" event. The subscriber can set standAlone to true, in the configuration properties,\nif they want to listen for this event without an initial \"gesturemovestart\".\n\nBy default this event sets up it's internal \"touchmove\" and \"mousemove\" DOM listeners on the document element. The subscriber\ncan set the root configuration property, to specify which node to attach DOM listeners to, if different from the document. \n\nThis event can also be listened for using node.delegate().\n\nIt is recommended that you use Y.bind to set up context and additional arguments for your event handler,\nhowever if you want to pass the context and arguments as additional signature arguments to on/delegate, \nyou need to provide a null value for the configuration object, e.g: <code>node.on(\"gesturemove\", fn, null, context, arg1, arg2, arg3)</code>",

62920

"itemtype": "event",

62921

"name": "gesturemove",

62922

"params": [

62923

{

62924

"name": "type",

62925

"description": "\"gesturemove\"",

62926

"type": "String"

62927

},

62928

{

62929

"name": "fn",

62930

"description": "The method the event invokes. It receives the event facade of the underlying DOM event (mousemove or touchmove.touches[0]) which contains position co-ordinates.",

62931

"type": "Function"

62932

},

62933

{

62934

"name": "cfg",

62935

"description": "Optional. An object which specifies:\n<dl>\n<dt>standAlone (defaults to false)</dt>\n<dd>true, if the subscriber should be notified even if a \"gesturemovestart\" has not occured on the same node.</dd>\n<dt>root (defaults to document)</dt>\n<dd>The node to which the internal DOM listeners should be attached.</dd>\n<dt>preventDefault (defaults to false)</dt>\n<dd>Can be set to true/false to prevent default behavior as soon as the touchmove or mousemove is received. As with gesturemovestart, can also be set to function which returns true/false based on the event facade passed to it.</dd>\n</dl>",

62936

"type": "Object"

62937

}

62938

],

62939

"return": {

62940

"description": "the detach handle",

62941

"type": "EventHandle"

62942

},

62943

"class": "YUI",

62944

"module": "event-gestures",

62945

"submodule": "event-move"

62946

},

62947

{

62948

"file": "event-gestures/js/Move.js",

62949

"line": 395,

62950

"description": "Sets up a \"gesturemoveend\" event, that is fired on touch devices in response to a single finger \"touchend\",\nand on mouse based devices in response to a \"mouseup\".\n\nBy default this event is only fired when the same node\nhas received a \"gesturemove\" or \"gesturemovestart\" event. The subscriber can set standAlone to true, in the configuration properties,\nif they want to listen for this event without a preceding \"gesturemovestart\" or \"gesturemove\".\n\nBy default this event sets up it's internal \"touchend\" and \"mouseup\" DOM listeners on the document element. The subscriber\ncan set the root configuration property, to specify which node to attach DOM listeners to, if different from the document. \n\nThis event can also be listened for using node.delegate().\n\nIt is recommended that you use Y.bind to set up context and additional arguments for your event handler,\nhowever if you want to pass the context and arguments as additional signature arguments to on/delegate, \nyou need to provide a null value for the configuration object, e.g: <code>node.on(\"gesturemoveend\", fn, null, context, arg1, arg2, arg3)</code>",

62951

"itemtype": "event",

62952

"name": "gesturemoveend",

62953

"params": [

62954

{

62955

"name": "type",

62956

"description": "\"gesturemoveend\"",

62957

"type": "String"

62958

},

62959

{

62960

"name": "fn",

62961

"description": "The method the event invokes. It receives the event facade of the underlying DOM event (mouseup or touchend.changedTouches[0]).",

62962

"type": "Function"

62963

},

62964

{

62965

"name": "cfg",

62966

"description": "Optional. An object which specifies:\n<dl>\n<dt>standAlone (defaults to false)</dt>\n<dd>true, if the subscriber should be notified even if a \"gesturemovestart\" or \"gesturemove\" has not occured on the same node.</dd>\n<dt>root (defaults to document)</dt>\n<dd>The node to which the internal DOM listeners should be attached.</dd>\n<dt>preventDefault (defaults to false)</dt>\n<dd>Can be set to true/false to prevent default behavior as soon as the touchend or mouseup is received. As with gesturemovestart, can also be set to function which returns true/false based on the event facade passed to it.</dd>\n</dl>",

62967

"type": "Object"

62968

}

62969

],

62970

"return": {

62971

"description": "the detach handle",

62972

"type": "EventHandle"

62973

},

62974

"class": "YUI",

62975

"module": "event-gestures",

62976

"submodule": "event-move"

62977

},

62978

{

62979

"file": "event-simulate/js/event-simulate.js",

62980

"line": 569,

62981

"description": "Simulates the event with the given name on a target.",

62982

"params": [

62983

{

62984

"name": "target",

62985

"description": "The DOM element that's the target of the event.",

62986

"type": "HTMLElement"

62987

},

62988

{

62989

"name": "type",

62990

"description": "The type of event to simulate (i.e., \"click\").",

62991

"type": "String"

62992

},

62993

{

62994

"name": "options",

62995

"description": "(Optional) Extra options to copy onto the event object.",

62996

"type": "Object"

62997

}

62998

],

62999

"return": {

63000

"description": "",

63001

"type": "Void"

63002

},

63003

"itemtype": "method",

63004

"name": "simulate",

63005

"static": 1,

63006

"class": "Event",

63007

"module": "event-simulate"

63008

},

63009

{

63010

"file": "event-valuechange/js/event-valuechange.js",

63011

"line": 44,

63012

"description": "Interval (in milliseconds) at which to poll for changes to the value of an\nelement with one or more `valueChange` subscribers when the user is likely\nto be interacting with it.",

63013

"itemtype": "property",

63014

"name": "POLL_INTERVAL",

63015

"type": "Number",

63016

"default": "50",

63017

"static": 1,

63018

"class": "ValueChange",

63019

"module": "event-valuechange"

63020

},

63021

{

63022

"file": "event-valuechange/js/event-valuechange.js",

63023

"line": 56,

63024

"description": "Timeout (in milliseconds) after which to stop polling when there hasn't been\nany new activity (keypresses, mouse clicks, etc.) on an element.",

63025

"itemtype": "property",

63026

"name": "TIMEOUT",

63027

"type": "Number",

63028

"default": "10000",

63029

"static": 1,

63030

"class": "ValueChange",

63031

"module": "event-valuechange"

63032

},

63033

{

63034

"file": "event-valuechange/js/event-valuechange.js",

63035

"line": 69,

63036

"description": "Called at an interval to poll for changes to the value of the specified\nnode.",

63037

"itemtype": "method",

63038

"name": "_poll",

63039

"params": [

63040

{

63041

"name": "node",

63042

"description": "Node to poll.",

63043

"type": "Node"

63044

},

63045

{

63046

"name": "options",

63047

"description": "Options object.",

63048

"type": "Object",

63049

"props": [

63050

{

63051

"name": "e",

63052

"description": "Event facade of the event that\n initiated the polling.",

63053

"type": "EventFacade",

63054

"optional": true

63055

}

63056

]

63057

}

63058

],

63059

"access": "protected",

63060

"tagname": "",

63061

"static": 1,

63062

"class": "ValueChange",

63063

"module": "event-valuechange"

63064

},

63065

{

63066

"file": "event-valuechange/js/event-valuechange.js",

63067

"line": 117,

63068

"description": "Restarts the inactivity timeout for the specified node.",

63069

"itemtype": "method",

63070

"name": "_refreshTimeout",

63071

"params": [

63072

{

63073

"name": "node",

63074

"description": "Node to refresh.",

63075

"type": "Node"

63076

},

63077

{

63078

"name": "notifier",

63079

"description": "",

63080

"type": "SyntheticEvent.Notifier"

63081

}

63082

],

63083

"access": "protected",

63084

"tagname": "",

63085

"static": 1,

63086

"class": "ValueChange",

63087

"module": "event-valuechange"

63088

},

63089

{

63090

"file": "event-valuechange/js/event-valuechange.js",

63091

"line": 148,

63092

"description": "Begins polling for changes to the `value` property of the specified node. If\npolling is already underway for the specified node, it will not be restarted\nunless the `force` option is `true`",

63093

"itemtype": "method",

63094

"name": "_startPolling",

63095

"params": [

63096

{

63097

"name": "node",

63098

"description": "Node to watch.",

63099

"type": "Node"

63100

},

63101

{

63102

"name": "notifier",

63103

"description": "",

63104

"type": "SyntheticEvent.Notifier"

63105

},

63106

{

63107

"name": "options",

63108

"description": "Options object.",

63109

"type": "Object",

63110

"props": [

63111

{

63112

"name": "e",

63113

"description": "Event facade of the event that\n initiated the polling.",

63114

"type": "EventFacade",

63115

"optional": true

63116

},

63117

{

63118

"name": "force",

63119

"description": "If `true`, polling will be\n restarted even if we're already polling this node.",

63120

"type": "Boolean",

63121

"optional": true,

63122

"optdefault": "false"

63123

}

63124

]

63125

}

63126

],

63127

"access": "protected",

63128

"tagname": "",

63129

"static": 1,

63130

"class": "ValueChange",

63131

"module": "event-valuechange"

63132

},

63133

{

63134

"file": "event-valuechange/js/event-valuechange.js",

63135

"line": 207,

63136

"description": "Stops polling for changes to the specified node's `value` attribute.",

63137

"itemtype": "method",

63138

"name": "_stopPolling",

63139

"params": [

63140

{

63141

"name": "node",

63142

"description": "Node to stop polling on.",

63143

"type": "Node"

63144

},

63145

{

63146

"name": "notifier",

63147

"description": "Notifier to remove from the\n node. If not specified, all notifiers will be removed.",

63148

"type": "SyntheticEvent.Notifier",

63149

"optional": true

63150

}

63151

],

63152

"access": "protected",

63153

"tagname": "",

63154

"static": 1,

63155

"class": "ValueChange",

63156

"module": "event-valuechange"

63157

},

63158

{

63159

"file": "event-valuechange/js/event-valuechange.js",

63160

"line": 241,

63161

"description": "Clears the inactivity timeout for the specified node, if any.",

63162

"itemtype": "method",

63163

"name": "_stopTimeout",

63164

"params": [

63165

{

63166

"name": "node",

63167

"description": "",

63168

"type": "Node"

63169

}

63170

],

63171

"access": "protected",

63172

"tagname": "",

63173

"static": 1,

63174

"class": "ValueChange",

63175

"module": "event-valuechange"

63176

},

63177

{

63178

"file": "event-valuechange/js/event-valuechange.js",

63179

"line": 258,

63180

"description": "Stops polling when a node's blur event fires.",

63181

"itemtype": "method",

63182

"name": "_onBlur",

63183

"params": [

63184

{

63185

"name": "e",

63186

"description": "",

63187

"type": "EventFacade"

63188

},

63189

{

63190

"name": "notifier",

63191

"description": "",

63192

"type": "SyntheticEvent.Notifier"

63193

}

63194

],

63195

"access": "protected",

63196

"tagname": "",

63197

"static": 1,

63198

"class": "ValueChange",

63199

"module": "event-valuechange"

63200

},

63201

{

63202

"file": "event-valuechange/js/event-valuechange.js",

63203

"line": 271,

63204

"description": "Resets a node's history and starts polling when a focus event occurs.",

63205

"itemtype": "method",

63206

"name": "_onFocus",

63207

"params": [

63208

{

63209

"name": "e",

63210

"description": "",

63211

"type": "EventFacade"

63212

},

63213

{

63214

"name": "notifier",

63215

"description": "",

63216

"type": "SyntheticEvent.Notifier"

63217

}

63218

],

63219

"access": "protected",

63220

"tagname": "",

63221

"static": 1,

63222

"class": "ValueChange",

63223

"module": "event-valuechange"

63224

},

63225

{

63226

"file": "event-valuechange/js/event-valuechange.js",

63227

"line": 294,

63228

"description": "Starts polling when a node receives a keyDown event.",

63229

"itemtype": "method",

63230

"name": "_onKeyDown",

63231

"params": [

63232

{

63233

"name": "e",

63234

"description": "",

63235

"type": "EventFacade"

63236

},

63237

{

63238

"name": "notifier",

63239

"description": "",

63240

"type": "SyntheticEvent.Notifier"

63241

}

63242

],

63243

"access": "protected",

63244

"tagname": "",

63245

"static": 1,

63246

"class": "ValueChange",

63247

"module": "event-valuechange"

63248

},

63249

{

63250

"file": "event-valuechange/js/event-valuechange.js",

63251

"line": 307,

63252

"description": "Starts polling when an IME-related keyUp event occurs on a node.",

63253

"itemtype": "method",

63254

"name": "_onKeyUp",

63255

"params": [

63256

{

63257

"name": "e",

63258

"description": "",

63259

"type": "EventFacade"

63260

},

63261

{

63262

"name": "notifier",

63263

"description": "",

63264

"type": "SyntheticEvent.Notifier"

63265

}

63266

],

63267

"access": "protected",

63268

"tagname": "",

63269

"static": 1,

63270

"class": "ValueChange",

63271

"module": "event-valuechange"

63272

},

63273

{

63274

"file": "event-valuechange/js/event-valuechange.js",

63275

"line": 327,

63276

"description": "Starts polling when a node receives a mouseDown event.",

63277

"itemtype": "method",

63278

"name": "_onMouseDown",

63279

"params": [

63280

{

63281

"name": "e",

63282

"description": "",

63283

"type": "EventFacade"

63284

},

63285

{

63286

"name": "notifier",

63287

"description": "",

63288

"type": "SyntheticEvent.Notifier"

63289

}

63290

],

63291

"access": "protected",

63292

"tagname": "",

63293

"static": 1,

63294

"class": "ValueChange",

63295

"module": "event-valuechange"

63296

},

63297

{

63298

"file": "event-valuechange/js/event-valuechange.js",

63299

"line": 340,

63300

"description": "Called when the `valuechange` event receives a new subscriber.",

63301

"itemtype": "method",

63302

"name": "_onSubscribe",

63303

"params": [

63304

{

63305

"name": "node",

63306

"description": "",

63307

"type": "Node"

63308

},

63309

{

63310

"name": "sub",

63311

"description": "",

63312

"type": "Subscription"

63313

},

63314

{

63315

"name": "notifier",

63316

"description": "",

63317

"type": "SyntheticEvent.Notifier"

63318

},

63319

{

63320

"name": "filter",

63321

"description": "Filter function or selector string. Only\n provided for delegate subscriptions.",

63322

"type": "Function|String",

63323

"optional": true

63324

}

63325

],

63326

"access": "protected",

63327

"tagname": "",

63328

"static": 1,

63329

"class": "ValueChange",

63330

"module": "event-valuechange"

63331

},

63332

{

63333

"file": "event-valuechange/js/event-valuechange.js",

63334

"line": 402,

63335

"description": "Called when the `valuechange` event loses a subscriber.",

63336

"itemtype": "method",

63337

"name": "_onUnsubscribe",

63338

"params": [

63339

{

63340

"name": "node",

63341

"description": "",

63342

"type": "Node"

63343

},

63344

{

63345

"name": "subscription",

63346

"description": "",

63347

"type": "Subscription"

63348

},

63349

{

63350

"name": "notifier",

63351

"description": "",

63352

"type": "SyntheticEvent.Notifier"

63353

}

63354

],

63355

"access": "protected",

63356

"tagname": "",

63357

"static": 1,

63358

"class": "ValueChange",

63359

"module": "event-valuechange"

63360

},

63361

{

63362

"file": "event-valuechange/js/event-valuechange.js",

63363

"line": 427,

63364

"description": "Synthetic event that fires when the `value` property of an `<input>` or\n`<textarea>` node changes as a result of a user-initiated keystroke, mouse\noperation, or input method editor (IME) input event.\n\nUnlike the `onchange` event, this event fires when the value actually changes\nand not when the element loses focus. This event also reports IME and\nmulti-stroke input more reliably than `oninput` or the various key events across\nbrowsers.\n\nFor performance reasons, only focused nodes are monitored for changes, so\nprogrammatic value changes on nodes that don't have focus won't be detected.",

63365

"example": [

63366

"\n\n YUI().use('event-valuechange', function (Y) {\n Y.one('#my-input').on('valueChange', function (e) {\n Y.log('previous value: ' + e.prevVal);\n Y.log('new value: ' + e.newVal);\n });\n });"

63367

],

63368

"itemtype": "event",

63369

"name": "valuechange",

63370

"params": [

63371

{

63372

"name": "prevVal",

63373

"description": "Previous value prior to the latest change.",

63374

"type": "String"

63375

},

63376

{

63377

"name": "newVal",

63378

"description": "New value after the latest change.",

63379

"type": "String"

63380

}

63381

],

63382

"class": "YUI",

63383

"module": "event-valuechange"

63384

},

63385

{

63386

"file": "event/js/available.js",

63387

"line": 8,

63388

"description": "Executes the callback as soon as the specified element\nis detected in the DOM. This function expects a selector\nstring for the element(s) to detect. If you already have\nan element reference, you don't need this event.",

63389

"itemtype": "event",

63390

"name": "available",

63391

"params": [

63392

{

63393

"name": "type",

63394

"description": "'available'",

63395

"type": "String"

63396

},

63397

{

63398

"name": "fn",

63399

"description": "the callback function to execute.",

63400

"type": "Function"

63401

},

63402

{

63403

"name": "el",

63404

"description": "an selector for the element(s) to attach",

63405

"type": "String"

63406

},

63407

{

63408

"name": "context",

63409

"description": "optional argument that specifies what 'this' refers to."

63410

},

63411

{

63412

"name": "args",

63413

"description": "0..n additional arguments to pass on to the callback function.\nThese arguments will be added after the event object.",

63414

"multiple": true

63415

}

63416

],

63417

"return": {

63418

"description": "the detach handle",

63419

"type": "EventHandle"

63420

},

63421

"class": "YUI",

63422

"module": "event",

63423

"submodule": "event-base"

63424

},

63425

{

63426

"file": "event/js/available.js",

63427

"line": 30,

63428

"description": "Executes the callback as soon as the specified element\nis detected in the DOM with a nextSibling property\n(indicating that the element's children are available).\nThis function expects a selector\nstring for the element(s) to detect. If you already have\nan element reference, you don't need this event.",

63429

"itemtype": "event",

63430

"name": "contentready",

63431

"params": [

63432

{

63433

"name": "type",

63434

"description": "'contentready'",

63435

"type": "String"

63436

},

63437

{

63438

"name": "fn",

63439

"description": "the callback function to execute.",

63440

"type": "Function"

63441

},

63442

{

63443

"name": "el",

63444

"description": "an selector for the element(s) to attach.",

63445

"type": "String"

63446

},

63447

{

63448

"name": "context",

63449

"description": "optional argument that specifies what 'this' refers to."

63450

},

63451

{

63452

"name": "args",

63453

"description": "0..n additional arguments to pass on to the callback function.\nThese arguments will be added after the event object.",

63454

"multiple": true

63455

}

63456

],

63457

"return": {

63458

"description": "the detach handle",

63459

"type": "EventHandle"

63460

},

63461

"class": "YUI",

63462

"module": "event",

63463

"submodule": "event-base"

63464

},

63465

{

63466

"file": "event/js/delegate.js",

63467

"line": 16,

63468

"description": "Sets up event delegation on a container element. The delegated event\nwill use a supplied selector or filtering function to test if the event\nreferences at least one node that should trigger the subscription\ncallback.\n\nSelector string filters will trigger the callback if the event originated\nfrom a node that matches it or is contained in a node that matches it.\nFunction filters are called for each Node up the parent axis to the\nsubscribing container node, and receive at each level the Node and the event\nobject. The function should return true (or a truthy value) if that Node\nshould trigger the subscription callback. Note, it is possible for filters\nto match multiple Nodes for a single event. In this case, the delegate\ncallback will be executed for each matching Node.\n\nFor each matching Node, the callback will be executed with its 'this'\nobject set to the Node matched by the filter (unless a specific context was\nprovided during subscription), and the provided event's\n<code>currentTarget</code> will also be set to the matching Node. The\ncontaining Node from which the subscription was originally made can be\nreferenced as <code>e.container</code>.",

63469

"itemtype": "method",

63470

"name": "delegate",

63471

"params": [

63472

{

63473

"name": "type",

63474

"description": "the event type to delegate",

63475

"type": "String"

63476

},

63477

{

63478

"name": "fn",

63479

"description": "the callback function to execute. This function\n will be provided the event object for the delegated event.",

63480

"type": "Function"

63481

},

63482

{

63483

"name": "el",

63484

"description": "the element that is the delegation container",

63485

"type": "String|node"

63486

},

63487

{

63488

"name": "filter",

63489

"description": "a selector that must match the target of the\n event or a function to test target and its parents for a match",

63490

"type": "String|Function"

63491

},

63492

{

63493

"name": "context",

63494

"description": "optional argument that specifies what 'this' refers to."

63495

},

63496

{

63497

"name": "args",

63498

"description": "0..n additional arguments to pass on to the callback function.\n These arguments will be added after the event object.",

63499

"multiple": true

63500

}

63501

],

63502

"return": {

63503

"description": "the detach handle",

63504

"type": "EventHandle"

63505

},

63506

"static": 1,

63507

"class": "Event",

63508

"module": "event",

63509

"submodule": "event-delegate"

63510

},

63511

{

63512

"file": "event/js/delegate.js",

63513

"line": 129,

63514

"description": "Overrides the <code>_notify</code> method on the normal DOM subscription to\ninject the filtering logic and only proceed in the case of a match.\n\nThis method is hosted as a private property of the `delegate` method\n(e.g. `Y.delegate.notifySub`)",

63515

"itemtype": "method",

63516

"name": "notifySub",

63517

"params": [

63518

{

63519

"name": "thisObj",

63520

"description": "default 'this' object for the callback",

63521

"type": "Object"

63522

},

63523

{

63524

"name": "args",

63525

"description": "arguments passed to the event's <code>fire()</code>",

63526

"type": "Array"

63527

},

63528

{

63529

"name": "ce",

63530

"description": "the custom event managing the DOM subscriptions for\n the subscribed event on the subscribing node.",

63531

"type": "CustomEvent"

63532

}

63533

],

63534

"return": {

63535

"description": "false if the event was stopped",

63536

"type": "Boolean"

63537

},

63538

"access": "private",

63539

"tagname": "",

63540

"static": 1,

63541

"since": "3.2.0",

63542

"class": "Event",

63543

"module": "event",

63544

"submodule": "event-delegate"

63545

},

63546

{

63547

"file": "event/js/delegate.js",

63548

"line": 183,

63549

"description": "Compiles a selector string into a filter function to identify whether\nNodes along the parent axis of an event's target should trigger event\nnotification.\n\nThis function is memoized, so previously compiled filter functions are\nreturned if the same selector string is provided.\n\nThis function may be useful when defining synthetic events for delegate\nhandling.\n\nHosted as a property of the `delegate` method (e.g. `Y.delegate.compileFilter`).",

63550

"itemtype": "method",

63551

"name": "compileFilter",

63552

"params": [

63553

{

63554

"name": "selector",

63555

"description": "the selector string to base the filtration on",

63556

"type": "String"

63557

}

63558

],

63559

"return": {

63560

"description": "",

63561

"type": "Function"

63562

},

63563

"since": "3.2.0",

63564

"static": 1,

63565

"class": "Event",

63566

"module": "event",

63567

"submodule": "event-delegate"

63568

},

63569

{

63570

"file": "event/js/delegate.js",

63571

"line": 209,

63572

"description": "Walks up the parent axis of an event's target, and tests each element\nagainst a supplied filter function. If any Nodes, including the container,\nsatisfy the filter, the delegated callback will be triggered for each.\n\nHosted as a protected property of the `delegate` method (e.g.\n`Y.delegate._applyFilter`).",

63573

"itemtype": "method",

63574

"name": "_applyFilter",

63575

"params": [

63576

{

63577

"name": "filter",

63578

"description": "boolean function to test for inclusion in event\n notification",

63579

"type": "Function"

63580

},

63581

{

63582

"name": "args",

63583

"description": "the arguments that would be passed to subscribers",

63584

"type": "Array"

63585

},

63586

{

63587

"name": "ce",

63588

"description": "the DOM event wrapper",

63589

"type": "CustomEvent"

63590

}

63591

],

63592

"return": {

63593

"description": "The Node or Nodes that satisfy the filter",

63594

"type": "Node|Node[]|undefined"

63595

},

63596

"access": "protected",

63597

"tagname": "",

63598

"class": "Event",

63599

"module": "event",

63600

"submodule": "event-delegate"

63601

},

63602

{

63603

"file": "event/js/delegate.js",

63604

"line": 286,

63605

"description": "Sets up event delegation on a container element. The delegated event\nwill use a supplied filter to test if the callback should be executed.\nThis filter can be either a selector string or a function that returns\na Node to use as the currentTarget for the event.\n\nThe event object for the delegated event is supplied to the callback\nfunction. It is modified slightly in order to support all properties\nthat may be needed for event delegation. 'currentTarget' is set to\nthe element that matched the selector string filter or the Node returned\nfrom the filter function. 'container' is set to the element that the\nlistener is delegated from (this normally would be the 'currentTarget').\n\nFilter functions will be called with the arguments that would be passed to\nthe callback function, including the event object as the first parameter.\nThe function should return false (or a falsey value) if the success criteria\naren't met, and the Node to use as the event's currentTarget and 'this'\nobject if they are.",

63606

"itemtype": "method",

63607

"name": "delegate",

63608

"params": [

63609

{

63610

"name": "type",

63611

"description": "the event type to delegate",

63612

"type": "String"

63613

},

63614

{

63615

"name": "fn",

63616

"description": "the callback function to execute. This function\nwill be provided the event object for the delegated event.",

63617

"type": "Function"

63618

},

63619

{

63620

"name": "el",

63621

"description": "the element that is the delegation container",

63622

"type": "String|node"

63623

},

63624

{

63625

"name": "filter",

63626

"description": "a selector that must match the target of the\nevent or a function that returns a Node or false.",

63627

"type": "String|function"

63628

},

63629

{

63630

"name": "context",

63631

"description": "optional argument that specifies what 'this' refers to."

63632

},

63633

{

63634

"name": "args",

63635

"description": "0..n additional arguments to pass on to the callback function.\nThese arguments will be added after the event object.",

63636

"multiple": true

63637

}

63638

],

63639

"return": {

63640

"description": "the detach handle",

63641

"type": "EventHandle"

63642

},

63643

"class": "YUI",

63644

"module": "event",

63645

"submodule": "event-delegate"

63646

},

63647

{

63648

"file": "event/js/event-dom.js",

63649

"line": 70,

63650

"description": "True after the onload event has fired",

63651

"itemtype": "property",

63652

"name": "_loadComplete",

63653

"type": "boolean",

63654

"static": 1,

63655

"access": "private",

63656

"tagname": "",

63657

"class": "Event",

63658

"module": "event",

63659

"submodule": "event-base"

63660

},

63661

{

63662

"file": "event/js/event-dom.js",

63663

"line": 79,

63664

"description": "The number of times to poll after window.onload. This number is\nincreased if additional late-bound handlers are requested after\nthe page load.",

63665

"itemtype": "property",

63666

"name": "_retryCount",

63667

"static": 1,

63668

"access": "private",

63669

"tagname": "",

63670

"class": "Event",

63671

"module": "event",

63672

"submodule": "event-base"

63673

},

63674

{

63675

"file": "event/js/event-dom.js",

63676

"line": 89,

63677

"description": "onAvailable listeners",

63678

"itemtype": "property",

63679

"name": "_avail",

63680

"static": 1,

63681

"access": "private",

63682

"tagname": "",

63683

"class": "Event",

63684

"module": "event",

63685

"submodule": "event-base"

63686

},

63687

{

63688

"file": "event/js/event-dom.js",

63689

"line": 97,

63690

"description": "Custom event wrappers for DOM events. Key is\n'event:' + Element uid stamp + event type",

63691

"itemtype": "property",

63692

"name": "_wrappers",

63693

"type": "Y.Event.Custom",

63694

"static": 1,

63695

"access": "private",

63696

"tagname": "",

63697

"class": "Event",

63698

"module": "event",

63699

"submodule": "event-base"

63700

},

63701

{

63702

"file": "event/js/event-dom.js",

63703

"line": 109,

63704

"description": "Custom event wrapper map DOM events. Key is\nElement uid stamp. Each item is a hash of custom event\nwrappers as provided in the _wrappers collection. This\nprovides the infrastructure for getListeners.",

63705

"itemtype": "property",

63706

"name": "_el_events",

63707

"static": 1,

63708

"access": "private",

63709

"tagname": "",

63710

"class": "Event",

63711

"module": "event",

63712

"submodule": "event-base"

63713

},

63714

{

63715

"file": "event/js/event-dom.js",

63716

"line": 122,

63717

"description": "The number of times we should look for elements that are not\nin the DOM at the time the event is requested after the document\nhas been loaded. The default is 1000@amp;40 ms, so it will poll\nfor 40 seconds or until all outstanding handlers are bound\n(whichever comes first).",

63718

"itemtype": "property",

63719

"name": "POLL_RETRYS",

63720

"type": "int",

63721

"static": 1,

63722

"final": 1,

63723

"class": "Event",

63724

"module": "event",

63725

"submodule": "event-base"

63726

},

63727

{

63728

"file": "event/js/event-dom.js",

63729

"line": 135,

63730

"description": "The poll interval in milliseconds",

63731

"itemtype": "property",

63732

"name": "POLL_INTERVAL",

63733

"type": "int",

63734

"static": 1,

63735

"final": 1,

63736

"class": "Event",

63737

"module": "event",

63738

"submodule": "event-base"

63739

},

63740

{

63741

"file": "event/js/event-dom.js",

63742

"line": 144,

63743

"description": "addListener/removeListener can throw errors in unexpected scenarios.\nThese errors are suppressed, the method returns false, and this property\nis set",

63744

"itemtype": "property",

63745

"name": "lastError",

63746

"static": 1,

63747

"type": "Error",

63748

"class": "Event",

63749

"module": "event",

63750

"submodule": "event-base"

63751

},

63752

{

63753

"file": "event/js/event-dom.js",

63754

"line": 155,

63755

"description": "poll handle",

63756

"itemtype": "property",

63757

"name": "_interval",

63758

"static": 1,

63759

"access": "private",

63760

"tagname": "",

63761

"class": "Event",

63762

"module": "event",

63763

"submodule": "event-base"

63764

},

63765

{

63766

"file": "event/js/event-dom.js",

63767

"line": 163,

63768

"description": "document readystate poll handle",

63769

"itemtype": "property",

63770

"name": "_dri",

63771

"static": 1,

63772

"access": "private",

63773

"tagname": "",

63774

"class": "Event",

63775

"module": "event",

63776

"submodule": "event-base"

63777

},

63778

{

63779

"file": "event/js/event-dom.js",

63780

"line": 171,

63781

"description": "True when the document is initially usable",

63782

"itemtype": "property",

63783

"name": "DOMReady",

63784

"type": "boolean",

63785

"static": 1,

63786

"class": "Event",

63787

"module": "event",

63788

"submodule": "event-base"

63789

},

63790

{

63791

"file": "event/js/event-dom.js",

63792

"line": 179,

63793

"itemtype": "method",

63794

"name": "startInterval",

63795

"static": 1,

63796

"access": "private",

63797

"tagname": "",

63798

"class": "Event",

63799

"module": "event",

63800

"submodule": "event-base"

63801

},

63802

{

63803

"file": "event/js/event-dom.js",

63804

"line": 190,

63805

"description": "Executes the supplied callback when the item with the supplied\nid is found. This is meant to be used to execute behavior as\nsoon as possible as the page loads. If you use this after the\ninitial page load it will poll for a fixed time for the element.\nThe number of times it will poll and the frequency are\nconfigurable. By default it will poll for 10 seconds.\n\nThe callback is executed with a single parameter:\nthe custom object parameter, if provided.",

63806

"itemtype": "method",

63807

"name": "onAvailable",

63808

"params": [

63809

{

63810

"name": "id",

63811

"description": "the id of the element, or an array\nof ids to look for.",

63812

"type": "String||string[]"

63813

},

63814

{

63815

"name": "fn",

63816

"description": "what to execute when the element is found.",

63817

"type": "Function"

63818

},

63819

{

63820

"name": "p_obj",

63821

"description": "an optional object to be passed back as\n a parameter to fn.",

63822

"type": "Object"

63823

},

63824

{

63825

"name": "p_override",

63826

"description": "If set to true, fn will execute\n in the context of p_obj, if set to an object it\n will execute in the context of that object",

63827

"type": "Boolean|object"

63828

},

63829

{

63830

"name": "checkContent",

63831

"description": "check child node readiness (onContentReady)",

63832

"type": "Boolean"

63833

}

63834

],

63835

"static": 1,

63836

"deprecated": true,

63837

"deprecationMessage": "Use Y.on(\"available\")",

63838

"class": "Event",

63839

"module": "event",

63840

"submodule": "event-base"

63841

},

63842

{

63843

"file": "event/js/event-dom.js",

63844

"line": 263,

63845

"description": "Works the same way as onAvailable, but additionally checks the\nstate of sibling elements to determine if the content of the\navailable element is safe to modify.\n\nThe callback is executed with a single parameter:\nthe custom object parameter, if provided.",

63846

"itemtype": "method",

63847

"name": "onContentReady",

63848

"params": [

63849

{

63850

"name": "id",

63851

"description": "the id of the element to look for.",

63852

"type": "String"

63853

},

63854

{

63855

"name": "fn",

63856

"description": "what to execute when the element is ready.",

63857

"type": "Function"

63858

},

63859

{

63860

"name": "obj",

63861

"description": "an optional object to be passed back as\n a parameter to fn.",

63862

"type": "Object"

63863

},

63864

{

63865

"name": "override",

63866

"description": "If set to true, fn will execute\n in the context of p_obj. If an object, fn will\n exectute in the context of that object",

63867

"type": "Boolean|object"

63868

}

63869

],

63870

"static": 1,

63871

"deprecated": true,

63872

"deprecationMessage": "Use Y.on(\"contentready\")",

63873

"class": "Event",

63874

"module": "event",

63875

"submodule": "event-base"

63876

},

63877

{

63878

"file": "event/js/event-dom.js",

63879

"line": 289,

63880

"description": "Adds an event listener",

63881

"itemtype": "method",

63882

"name": "attach",

63883

"params": [

63884

{

63885

"name": "type",

63886

"description": "The type of event to append",

63887

"type": "String"

63888

},

63889

{

63890

"name": "fn",

63891

"description": "The method the event invokes",

63892

"type": "Function"

63893

},

63894

{

63895

"name": "el",

63896

"description": "An id, an element\n reference, or a collection of ids and/or elements to assign the\n listener to.",

63897

"type": "String|HTMLElement|Array|NodeList"

63898

},

63899

{

63900

"name": "context",

63901

"description": "optional context object",

63902

"type": "Object"

63903

},

63904

{

63905

"name": "args",

63906

"description": "0..n arguments to pass to the callback",

63907

"type": "Boolean|object"

63908

}

63909

],

63910

"return": {

63911

"description": "an object to that can be used to detach the listener",

63912

"type": "EventHandle"

63913

},

63914

"static": 1,

63915

"class": "Event",

63916

"module": "event",

63917

"submodule": "event-base"

63918

},

63919

{

63920

"file": "event/js/event-dom.js",

63921

"line": 498,

63922

"description": "Removes an event listener. Supports the signature the event was bound\nwith, but the preferred way to remove listeners is using the handle\nthat is returned when using Y.on",

63923

"itemtype": "method",

63924

"name": "detach",

63925

"params": [

63926

{

63927

"name": "type",

63928

"description": "the type of event to remove.",

63929

"type": "String"

63930

},

63931

{

63932

"name": "fn",

63933

"description": "the method the event invokes. If fn is\nundefined, then all event handlers for the type of event are\nremoved.",

63934

"type": "Function"

63935

},

63936

{

63937

"name": "el",

63938

"description": "An\nevent handle, an id, an element reference, or a collection\nof ids and/or elements to remove the listener from.",

63939

"type": "String|HTMLElement|Array|NodeList|EventHandle"

63940

}

63941

],

63942

"return": {

63943

"description": "true if the unbind was successful, false otherwise.",

63944

"type": "Boolean"

63945

},

63946

"static": 1,

63947

"class": "Event",

63948

"module": "event",

63949

"submodule": "event-base"

63950

},

63951

{

63952

"file": "event/js/event-dom.js",

63953

"line": 580,

63954

"description": "Finds the event in the window object, the caller's arguments, or\nin the arguments of another method in the callstack. This is\nexecuted automatically for events registered through the event\nmanager, so the implementer should not normally need to execute\nthis function at all.",

63955

"itemtype": "method",

63956

"name": "getEvent",

63957

"params": [

63958

{

63959

"name": "e",

63960

"description": "the event parameter from the handler",

63961

"type": "Event"

63962

},

63963

{

63964

"name": "el",

63965

"description": "the element the listener was attached to",

63966

"type": "HTMLElement"

63967

}

63968

],

63969

"return": {

63970

"description": "the event",

63971

"type": "Event"

63972

},

63973

"static": 1,

63974

"class": "Event",

63975

"module": "event",

63976

"submodule": "event-base"

63977

},

63978

{

63979

"file": "event/js/event-dom.js",

63980

"line": 599,

63981

"description": "Generates an unique ID for the element if it does not already\nhave one.",

63982

"itemtype": "method",

63983

"name": "generateId",

63984

"params": [

63985

{

63986

"name": "el",

63987

"description": "the element to create the id for"

63988

}

63989

],

63990

"return": {

63991

"description": "the resulting id of the element",

63992

"type": "String"

63993

},

63994

"static": 1,

63995

"class": "Event",

63996

"module": "event",

63997

"submodule": "event-base"

63998

},

63999

{

64000

"file": "event/js/event-dom.js",

64001

"line": 611,

64002

"description": "We want to be able to use getElementsByTagName as a collection\nto attach a group of events to. Unfortunately, different\nbrowsers return different types of collections. This function\ntests to determine if the object is array-like. It will also\nfail if the object is an array, but is empty.",

64003

"itemtype": "method",

64004

"name": "_isValidCollection",

64005

"params": [

64006

{

64007

"name": "o",

64008

"description": "the object to test"

64009

}

64010

],

64011

"return": {

64012

"description": "true if the object is array-like and populated",

64013

"type": "Boolean"

64014

},

64015

"deprecated": true,

64016

"deprecationMessage": "was not meant to be used directly",

64017

"static": 1,

64018

"access": "private",

64019

"tagname": "",

64020

"class": "Event",

64021

"module": "event",

64022

"submodule": "event-base"

64023

},

64024

{

64025

"file": "event/js/event-dom.js",

64026

"line": 626,

64027

"description": "hook up any deferred listeners",

64028

"itemtype": "method",

64029

"name": "_load",

64030

"static": 1,

64031

"access": "private",

64032

"tagname": "",

64033

"class": "Event",

64034

"module": "event",

64035

"submodule": "event-base"

64036

},

64037

{

64038

"file": "event/js/event-dom.js",

64039

"line": 651,

64040

"description": "Polling function that runs before the onload event fires,\nattempting to attach to DOM Nodes as soon as they are\navailable",

64041

"itemtype": "method",

64042

"name": "_poll",

64043

"static": 1,

64044

"access": "private",

64045

"tagname": "",

64046

"class": "Event",

64047

"module": "event",

64048

"submodule": "event-base"

64049

},

64050

{

64051

"file": "event/js/event-dom.js",

64052

"line": 768,

64053

"description": "Removes all listeners attached to the given element via addListener.\nOptionally, the node's children can also be purged.\nOptionally, you can specify a specific type of event to remove.",

64054

"itemtype": "method",

64055

"name": "purgeElement",

64056

"params": [

64057

{

64058

"name": "el",

64059

"description": "the element to purge",

64060

"type": "HTMLElement"

64061

},

64062

{

64063

"name": "recurse",

64064

"description": "recursively purge this element's children\nas well. Use with caution.",

64065

"type": "Boolean"

64066

},

64067

{

64068

"name": "type",

64069

"description": "optional type of listener to purge. If\nleft out, all listeners will be removed",

64070

"type": "String"

64071

}

64072

],

64073

"static": 1,

64074

"class": "Event",

64075

"module": "event",

64076

"submodule": "event-base"

64077

},

64078

{

64079

"file": "event/js/event-dom.js",

64080

"line": 806,

64081

"description": "Removes all object references and the DOM proxy subscription for\na given event for a DOM node.",

64082

"itemtype": "method",

64083

"name": "_clean",

64084

"params": [

64085

{

64086

"name": "wrapper",

64087

"description": "Custom event proxy for the DOM\n subscription",

64088

"type": "CustomEvent"

64089

}

64090

],

64091

"access": "private",

64092

"tagname": "",

64093

"static": 1,

64094

"since": "3.4.0",

64095

"class": "Event",

64096

"module": "event",

64097

"submodule": "event-base"

64098

},

64099

{

64100

"file": "event/js/event-dom.js",

64101

"line": 832,

64102

"description": "Returns all listeners attached to the given element via addListener.\nOptionally, you can specify a specific type of event to return.",

64103

"itemtype": "method",

64104

"name": "getListeners",

64105

"params": [

64106

{

64107

"name": "el",

64108

"description": "the element or element id to inspect",

64109

"type": "HTMLElement|string"

64110

},

64111

{

64112

"name": "type",

64113

"description": "optional type of listener to return. If\nleft out, all listeners will be returned",

64114

"type": "String"

64115

}

64116

],

64117

"return": {

64118

"description": "the custom event wrapper for the DOM event(s)",

64119

"type": "CustomEvent"

64120

},

64121

"static": 1,

64122

"class": "Event",

64123

"module": "event",

64124

"submodule": "event-base"

64125

},

64126

{

64127

"file": "event/js/event-dom.js",

64128

"line": 876,

64129

"description": "Removes all listeners registered by pe.event. Called\nautomatically during the unload event.",

64130

"itemtype": "method",

64131

"name": "_unload",

64132

"static": 1,

64133

"access": "private",

64134

"tagname": "",

64135

"class": "Event",

64136

"module": "event",

64137

"submodule": "event-base"

64138

},

64139

{

64140

"file": "event/js/event-dom.js",

64141

"line": 893,

64142

"description": "Adds a DOM event directly without the caching, cleanup, context adj, etc",

64143

"itemtype": "method",

64144

"name": "nativeAdd",

64145

"params": [

64146

{

64147

"name": "el",

64148

"description": "the element to bind the handler to",

64149

"type": "HTMLElement"

64150

},

64151

{

64152

"name": "type",

64153

"description": "the type of event handler",

64154

"type": "String"

64155

},

64156

{

64157

"name": "fn",

64158

"description": "the callback to invoke",

64159

"type": "Function"

64160

},

64161

{

64162

"name": "capture",

64163

"description": "capture or bubble phase",

64164

"type": "Boolen"

64165

}

64166

],

64167

"static": 1,

64168

"access": "private",

64169

"tagname": "",

64170

"class": "Event",

64171

"module": "event",

64172

"submodule": "event-base"

64173

},

64174

{

64175

"file": "event/js/event-dom.js",

64176

"line": 906,

64177

"description": "Basic remove listener",

64178

"itemtype": "method",

64179

"name": "nativeRemove",

64180

"params": [

64181

{

64182

"name": "el",

64183

"description": "the element to bind the handler to",

64184

"type": "HTMLElement"

64185

},

64186

{

64187

"name": "type",

64188

"description": "the type of event handler",

64189

"type": "String"

64190

},

64191

{

64192

"name": "fn",

64193

"description": "the callback to invoke",

64194

"type": "Function"

64195

},

64196

{

64197

"name": "capture",

64198

"description": "capture or bubble phase",

64199

"type": "Boolen"

64200

}

64201

],

64202

"static": 1,

64203

"access": "private",

64204

"tagname": "",

64205

"class": "Event",

64206

"module": "event",

64207

"submodule": "event-base"

64208

},

64209

{

64210

"file": "event/js/event-facade-dom-ie.js",

64211

"line": 209,

64212

"description": "Wrapper function for Object.defineProperty that creates a property whose\nvalue will be calulated only when asked for. After calculating the value,\nthe getter wll be removed, so it will behave as a normal property beyond that\npoint. A setter is also assigned so assigning to the property will clear\nthe getter, so foo.prop = 'a'; foo.prop; won't trigger the getter,\noverwriting value 'a'.\n\nUsed only by the DOMEventFacades used by IE8 when the YUI configuration\n<code>lazyEventFacade</code> is set to true.",

64213

"itemtype": "method",

64214

"name": "_define",

64215

"params": [

64216

{

64217

"name": "o",

64218

"description": "A DOM object to add the property to",

64219

"type": "DOMObject"

64220

},

64221

{

64222

"name": "prop",

64223

"description": "The name of the new property",

64224

"type": "String"

64225

},

64226

{

64227

"name": "valueFn",

64228

"description": "The function that will return the initial, default\n value for the property.",

64229

"type": "Function"

64230

}

64231

],

64232

"static": 1,

64233

"access": "private",

64234

"tagname": "",

64235

"class": "DOMEventFacade",

64236

"module": "event"

64237

},

64238

{

64239

"file": "event/js/event-facade-dom-touch.js",

64240

"line": 11,

64241

"description": "Adds touch event facade normalization properties to the DOM event facade",

64242

"itemtype": "method",

64243

"name": "_touch",

64244

"access": "private",

64245

"tagname": "",

64246

"params": [

64247

{

64248

"name": "ev",

64249

"description": "the DOM event",

64250

"type": "Event"

64251

},

64252

{

64253

"name": "currentTarget",

64254

"description": "the element the listener was attached to",

64255

"type": "HTMLElement"

64256

},

64257

{

64258

"name": "wrapper",

64259

"description": "the custom event wrapper for this DOM event",

64260

"type": "Event.Custom"

64261

}

64262

],

64263

"class": "DOMEventFacade",

64264

"module": "event-touch"

64265

},

64266

{

64267

"file": "event/js/event-facade-dom-touch.js",

64268

"line": 30,

64269

"description": "Array of individual touch events for touch points that are still in\ncontact with the touch surface.",

64270

"itemtype": "property",

64271

"name": "touches",

64272

"type": "{DOMEventFacade[]}",

64273

"class": "DOMEventFacade",

64274

"module": "event-touch"

64275

},

64276

{

64277

"file": "event/js/event-facade-dom-touch.js",

64278

"line": 49,

64279

"description": "Array of individual touch events still in contact with the touch\nsurface and whose `touchstart` event occurred inside the same taregt\nelement as the current target element.",

64280

"itemtype": "property",

64281

"name": "targetTouches",

64282

"type": "{DOMEventFacade[]}",

64283

"class": "DOMEventFacade",

64284

"module": "event-touch"

64285

},

64286

{

64287

"file": "event/js/event-facade-dom-touch.js",

64288

"line": 72,

64289

"description": "An array of event-specific touch events.\n\nFor `touchstart`, the touch points that became active with the current\nevent.\n\nFor `touchmove`, the touch points that have changed since the last\nevent.\n\nFor `touchend`, the touch points that have been removed from the touch\nsurface.",

64290

"itemtype": "property",

64291

"name": "changedTouches",

64292

"type": "{DOMEventFacade[]}",

64293

"class": "DOMEventFacade",

64294

"module": "event-touch"

64295

},

64296

{

64297

"file": "event/js/event-facade-dom.js",

64298

"line": 21,

64299

"description": "webkit key remapping required for Safari < 3.1",

64300

"itemtype": "property",

64301

"name": "webkitKeymap",

64302

"access": "private",

64303

"tagname": "",

64304

"class": "DOMEventFacade",

64305

"module": "event",

64306

"submodule": "event-base"

64307

},

64308

{

64309

"file": "event/js/event-facade-dom.js",

64310

"line": 40,

64311

"description": "Returns a wrapped node. Intended to be used on event targets,\nso it will return the node's parent if the target is a text\nnode.\n\nIf accessing a property of the node throws an error, this is\nprobably the anonymous div wrapper Gecko adds inside text\nnodes. This likely will only occur when attempting to access\nthe relatedTarget. In this case, we now return null because\nthe anonymous div is completely useless and we do not know\nwhat the related target was because we can't even get to\nthe element's parent node.",

64312

"itemtype": "method",

64313

"name": "resolve",

64314

"access": "private",

64315

"tagname": "",

64316

"class": "DOMEventFacade",

64317

"module": "event",

64318

"submodule": "event-base"

64319

},

64320

{

64321

"file": "event/js/event-facade-dom.js",

64322

"line": 182,

64323

"description": "The native event",

64324

"itemtype": "property",

64325

"name": "_event",

64326

"type": "{Native DOM Event}",

64327

"access": "private",

64328

"tagname": "",

64329

"class": "DOMEventFacade",

64330

"module": "event",

64331

"submodule": "event-base"

64332

},

64333

{

64334

"file": "event/js/event-facade-dom.js",

64335

"line": 189,

64336

"description": "The name of the event (e.g. \"click\")",

64337

"itemtype": "property",

64338

"name": "type",

64339

"type": "{String}",

64340

"class": "DOMEventFacade",

64341

"module": "event",

64342

"submodule": "event-base"

64343

},

64344

{

64345

"file": "event/js/event-facade-dom.js",

64346

"line": 196,

64347

"description": "`true` if the \"alt\" or \"option\" key is pressed.",

64348

"itemtype": "property",

64349

"name": "altKey",

64350

"type": "{Boolean}",

64351

"class": "DOMEventFacade",

64352

"module": "event",

64353

"submodule": "event-base"

64354

},

64355

{

64356

"file": "event/js/event-facade-dom.js",

64357

"line": 203,

64358

"description": "`true` if the shift key is pressed.",

64359

"itemtype": "property",

64360

"name": "shiftKey",

64361

"type": "{Boolean}",

64362

"class": "DOMEventFacade",

64363

"module": "event",

64364

"submodule": "event-base"

64365

},

64366

{

64367

"file": "event/js/event-facade-dom.js",

64368

"line": 210,

64369

"description": "`true` if the \"Windows\" key on a Windows keyboard, \"command\" key on an\nApple keyboard, or \"meta\" key on other keyboards is pressed.",

64370

"itemtype": "property",

64371

"name": "metaKey",

64372

"type": "{Boolean}",

64373

"class": "DOMEventFacade",

64374

"module": "event",

64375

"submodule": "event-base"

64376

},

64377

{

64378

"file": "event/js/event-facade-dom.js",

64379

"line": 218,

64380

"description": "`true` if the \"Ctrl\" or \"control\" key is pressed.",

64381

"itemtype": "property",

64382

"name": "ctrlKey",

64383

"type": "{Boolean}",

64384

"class": "DOMEventFacade",

64385

"module": "event",

64386

"submodule": "event-base"

64387

},

64388

{

64389

"file": "event/js/event-facade-dom.js",

64390

"line": 225,

64391

"description": "The X location of the event on the page (including scroll)",

64392

"itemtype": "property",

64393

"name": "pageX",

64394

"type": "{Number}",

64395

"class": "DOMEventFacade",

64396

"module": "event",

64397

"submodule": "event-base"

64398

},

64399

{

64400

"file": "event/js/event-facade-dom.js",

64401

"line": 231,

64402

"description": "The Y location of the event on the page (including scroll)",

64403

"itemtype": "property",

64404

"name": "pageY",

64405

"type": "{Number}",

64406

"class": "DOMEventFacade",

64407

"module": "event",

64408

"submodule": "event-base"

64409

},

64410

{

64411

"file": "event/js/event-facade-dom.js",

64412

"line": 237,

64413

"description": "The X location of the event in the viewport",

64414

"itemtype": "property",

64415

"name": "clientX",

64416

"type": "{Number}",

64417

"class": "DOMEventFacade",

64418

"module": "event",

64419

"submodule": "event-base"

64420

},

64421

{

64422

"file": "event/js/event-facade-dom.js",

64423

"line": 243,

64424

"description": "The Y location of the event in the viewport",

64425

"itemtype": "property",

64426

"name": "clientY",

64427

"type": "{Number}",

64428

"class": "DOMEventFacade",

64429

"module": "event",

64430

"submodule": "event-base"

64431

},

64432

{

64433

"file": "event/js/event-facade-dom.js",

64434

"line": 249,

64435

"description": "The keyCode for key events. Uses charCode if keyCode is not available",

64436

"itemtype": "property",

64437

"name": "keyCode",

64438

"type": "{Number}",

64439

"class": "DOMEventFacade",

64440

"module": "event",

64441

"submodule": "event-base"

64442

},

64443

{

64444

"file": "event/js/event-facade-dom.js",

64445

"line": 255,

64446

"description": "The charCode for key events. Same as keyCode",

64447

"itemtype": "property",

64448

"name": "charCode",

64449

"type": "{Number}",

64450

"class": "DOMEventFacade",

64451

"module": "event",

64452

"submodule": "event-base"

64453

},

64454

{

64455

"file": "event/js/event-facade-dom.js",

64456

"line": 261,

64457

"description": "The button that was pushed. 1 for left click, 2 for middle click, 3 for\nright click. This is only reliably populated on `mouseup` events.",

64458

"itemtype": "property",

64459

"name": "button",

64460

"type": "{Number}",

64461

"class": "DOMEventFacade",

64462

"module": "event",

64463

"submodule": "event-base"

64464

},

64465

{

64466

"file": "event/js/event-facade-dom.js",

64467

"line": 268,

64468

"description": "The button that was pushed. Same as button.",

64469

"itemtype": "property",

64470

"name": "which",

64471

"type": "{Number}",

64472

"class": "DOMEventFacade",

64473

"module": "event",

64474

"submodule": "event-base"

64475

},

64476

{

64477

"file": "event/js/event-facade-dom.js",

64478

"line": 274,

64479

"description": "Node reference for the targeted element",

64480

"itemtype": "property",

64481

"name": "target",

64482

"type": "{Node}",

64483

"class": "DOMEventFacade",

64484

"module": "event",

64485

"submodule": "event-base"

64486

},

64487

{

64488

"file": "event/js/event-facade-dom.js",

64489

"line": 280,

64490

"description": "Node reference for the element that the listener was attached to.",

64491

"itemtype": "property",

64492

"name": "currentTarget",

64493

"type": "{Node}",

64494

"class": "DOMEventFacade",

64495

"module": "event",

64496

"submodule": "event-base"

64497

},

64498

{

64499

"file": "event/js/event-facade-dom.js",

64500

"line": 286,

64501

"description": "Node reference to the relatedTarget",

64502

"itemtype": "property",

64503

"name": "relatedTarget",

64504

"type": "{Node}",

64505

"class": "DOMEventFacade",

64506

"module": "event",

64507

"submodule": "event-base"

64508

},

64509

{

64510

"file": "event/js/event-facade-dom.js",

64511

"line": 292,

64512

"description": "Number representing the direction and velocity of the movement of the mousewheel.\nNegative is down, the higher the number, the faster. Applies to the mousewheel event.",

64513

"itemtype": "property",

64514

"name": "wheelDelta",

64515

"type": "{Number}",

64516

"class": "DOMEventFacade",

64517

"module": "event",

64518

"submodule": "event-base"

64519

},

64520

{

64521

"file": "event/js/event-facade-dom.js",

64522

"line": 299,

64523

"description": "Stops the propagation to the next bubble target",

64524

"itemtype": "method",

64525

"name": "stopPropagation",

64526

"class": "DOMEventFacade",

64527

"module": "event",

64528

"submodule": "event-base"

64529

},

64530

{

64531

"file": "event/js/event-facade-dom.js",

64532

"line": 304,

64533

"description": "Stops the propagation to the next bubble target and\nprevents any additional listeners from being exectued\non the current target.",

64534

"itemtype": "method",

64535

"name": "stopImmediatePropagation",

64536

"class": "DOMEventFacade",

64537

"module": "event",

64538

"submodule": "event-base"

64539

},

64540

{

64541

"file": "event/js/event-facade-dom.js",

64542

"line": 311,

64543

"description": "Prevents the event's default behavior",

64544

"itemtype": "method",

64545

"name": "preventDefault",

64546

"params": [

64547

{

64548

"name": "returnValue",

64549

"description": "sets the returnValue of the event to this value\n(rather than the default false value). This can be used to add a customized\nconfirmation query to the beforeunload event).",

64550

"type": "String"

64551

}

64552

],

64553

"class": "DOMEventFacade",

64554

"module": "event",

64555

"submodule": "event-base"

64556

},

64557

{

64558

"file": "event/js/event-facade-dom.js",

64559

"line": 319,

64560

"description": "Stops the event propagation and prevents the default\nevent behavior.",

64561

"itemtype": "method",

64562

"name": "halt",

64563

"params": [

64564

{

64565

"name": "immediate",

64566

"description": "if true additional listeners\non the current target will not be executed",

64567

"type": "Boolean"

64568

}

64569

],

64570

"class": "DOMEventFacade",

64571

"module": "event",

64572

"submodule": "event-base"

64573

},

64574

{

64575

"file": "event/js/event-ready.js",

64576

"line": 7,

64577

"description": "The domready event fires at the moment the browser's DOM is\nusable. In most cases, this is before images are fully\ndownloaded, allowing you to provide a more responsive user\ninterface.\n\nIn YUI 3, domready subscribers will be notified immediately if\nthat moment has already passed when the subscription is created.\n\nOne exception is if the yui.js file is dynamically injected into\nthe page. If this is done, you must tell the YUI instance that\nyou did this in order for DOMReady (and window load events) to\nfire normally. That configuration option is 'injected' -- set\nit to true if the yui.js script is not included inline.\n\nThis method is part of the 'event-ready' module, which is a\nsubmodule of 'event'.",

64578

"itemtype": "event",

64579

"name": "domready",

64580

"class": "YUI",

64581

"module": "event"

64582

},

64583

{

64584

"file": "event/js/key.js",

64585

"line": 131,

64586

"description": "Add a key listener. The listener will only be notified if the\nkeystroke detected meets the supplied specification. The\nspecification is a string that is defined as:\n\n<dl>\n <dt>spec</dt>\n <dd><code>[{type}:]{code}[,{code}]*</code></dd>\n <dt>type</dt>\n <dd><code>\"down\", \"up\", or \"press\"</code></dd>\n <dt>code</dt>\n <dd><code>{keyCode|character|keyName}[+{modifier}]*</code></dd>\n <dt>modifier</dt>\n <dd><code>\"shift\", \"ctrl\", \"alt\", or \"meta\"</code></dd>\n <dt>keyName</dt>\n <dd><code>\"enter\", \"backspace\", \"esc\", \"tab\", \"pageup\", or \"pagedown\"</code></dd>\n</dl>\n\nExamples:\n<ul>\n <li><code>Y.on(\"key\", callback, \"press:12,65+shift+ctrl\", \"#my-input\");</code></li>\n <li><code>Y.delegate(\"key\", preventSubmit, \"enter\", \"#forms\", \"input[type=text]\");</code></li>\n <li><code>Y.one(\"doc\").on(\"key\", viNav, \"j,k,l,;\");</code></li>\n</ul>",

64587

"itemtype": "event",

64588

"name": "key",

64589

"params": [

64590

{

64591

"name": "type",

64592

"description": "'key'",

64593

"type": "String"

64594

},

64595

{

64596

"name": "fn",

64597

"description": "the function to execute",

64598

"type": "Function"

64599

},

64600

{

64601

"name": "id",

64602

"description": "the element(s) to bind",

64603

"type": "String|HTMLElement|collection"

64604

},

64605

{

64606

"name": "spec",

64607

"description": "the keyCode and modifier specification",

64608

"type": "String"

64609

},

64610

{

64611

"name": "o",

64612

"description": "optional context object"

64613

},

64614

{

64615

"name": "args",

64616

"description": "0..n additional arguments to provide to the listener."

64617

}

64618

],

64619

"return": {

64620

"description": "the detach handle",

64621

"type": "Event.Handle"

64622

},

64623

"class": "YUI",

64624

"module": "event",

64625

"submodule": "event-key"

64626

},

64627

{

64628

"file": "event/js/mousewheel.js",

64629

"line": 25,

64630

"description": "Mousewheel event. This listener is automatically attached to the\ncorrect target, so one should not be supplied. Mouse wheel \ndirection and velocity is stored in the 'wheelDelta' field.",

64631

"itemtype": "event",

64632

"name": "mousewheel",

64633

"params": [

64634

{

64635

"name": "type",

64636

"description": "'mousewheel'",

64637

"type": "String"

64638

},

64639

{

64640

"name": "fn",

64641

"description": "the callback to execute",

64642

"type": "Function"

64643

},

64644

{

64645

"name": "context",

64646

"description": "optional context object"

64647

},

64648

{

64649

"name": "args",

64650

"description": "0..n additional arguments to provide to the listener."

64651

}

64652

],

64653

"return": {

64654

"description": "the detach handle",

64655

"type": "EventHandle"

64656

},

64657

"class": "YUI",

64658

"module": "event",

64659

"submodule": "event-mousewheel"

64660

},

64661

{

64662

"file": "event/js/outside.js",

64663

"line": 48,

64664

"description": "Defines a new outside event to correspond with the given DOM event.\n\nBy default, the created synthetic event name will be the name of the event\nwith \"outside\" appended (e.g. \"click\" becomes \"clickoutside\"). If you want\na different name for the created Event, pass it as a second argument like so:\n<code>Y.Event.defineOutside(eventType, \"yonderclick\")</code>.",

64665

"itemtype": "method",

64666

"name": "defineOutside",

64667

"params": [

64668

{

64669

"name": "event",

64670

"description": "DOM event",

64671

"type": "String"

64672

},

64673

{

64674

"name": "name",

64675

"description": "(optional) custom outside event name",

64676

"type": "String"

64677

}

64678

],

64679

"static": 1,

64680

"class": "Event",

64681

"module": "event",

64682

"submodule": "event-outside"

64683

},

64684

{

64685

"file": "event/js/resize-window.js",

64686

"line": 9,

64687

"description": "Old firefox fires the window resize event once when the resize action\nfinishes, other browsers fire the event periodically during the\nresize. This code uses timeout logic to simulate the Firefox \nbehavior in other browsers.",

64688

"itemtype": "event",

64689

"name": "windowresize",

64690

"class": "YUI",

64691

"module": "event",

64692

"submodule": "event-resize"

64693

},

64694

{

64695

"file": "event/js/synthetic.js",

64696

"line": 38,

64697

"description": "Executes the subscription callback, passing the firing arguments as the\nfirst parameters to that callback. For events that are configured with\nemitFacade=true, it is common practice to pass the triggering DOMEventFacade\nas the first parameter. Barring a proper DOMEventFacade or EventFacade\n(from a CustomEvent), a new EventFacade will be generated. In that case, if\nfire() is called with a simple object, it will be mixed into the facade.\nOtherwise, the facade will be prepended to the callback parameters.\n\nFor notifiers provided to delegate logic, the first argument should be an\nobject with a "currentTarget" property to identify what object to\ndefault as 'this' in the callback. Typically this is gleaned from the\nDOMEventFacade or EventFacade, but if configured with emitFacade=false, an\nobject must be provided. In that case, the object will be removed from the\ncallback parameters.\n\nAdditional arguments passed during event subscription will be\nautomatically added after those passed to fire().",

64698

"itemtype": "method",

64699

"name": "fire",

64700

"params": [

64701

{

64702

"name": "e",

64703

"description": "(see description)",

64704

"type": "EventFacade|DOMEventFacade|Object|any"

64705

},

64706

{

64707

"name": "arg",

64708

"description": "additional arguments received by all subscriptions",

64709

"type": "Any",

64710

"multiple": true

64711

}

64712

],

64713

"access": "private",

64714

"tagname": "",

64715

"class": "SyntheticEvent.Notifier",

64716

"module": "event",

64717

"submodule": "event-synthetic"

64718

},

64719

{

64720

"file": "event/js/synthetic.js",

64721

"line": 131,

64722

"description": "Adds a subscription from the Notifier registry.",

64723

"itemtype": "method",

64724

"name": "register",

64725

"params": [

64726

{

64727

"name": "handle",

64728

"description": "the subscription",

64729

"type": "EventHandle"

64730

}

64731

],

64732

"since": "3.4.0",

64733

"class": "SynthRegistry",

64734

"module": "event",

64735

"submodule": "event-synthetic"

64736

},

64737

{

64738

"file": "event/js/synthetic.js",

64739

"line": 143,

64740

"description": "Removes the subscription from the Notifier registry.",

64741

"itemtype": "method",

64742

"name": "_unregisterSub",

64743

"params": [

64744

{

64745

"name": "sub",

64746

"description": "the subscription",

64747

"type": "Subscription"

64748

}

64749

],

64750

"since": "3.4.0",

64751

"class": "SynthRegistry",

64752

"module": "event",

64753

"submodule": "event-synthetic"

64754

},

64755

{

64756

"file": "event/js/synthetic.js",

64757

"line": 171,

64758

"description": "Used by the event system's unload cleanup process. When navigating\naway from the page, the event system iterates the global map of element\nsubscriptions and detaches everything using detachAll(). Normally,\nthe map is populated with custom events, so this object needs to\nat least support the detachAll method to duck type its way to\ncleanliness.",

64759

"itemtype": "method",

64760

"name": "detachAll",

64761

"access": "private",

64762

"tagname": "",

64763

"since": "3.4.0",

64764

"class": "SynthRegistry",

64765

"module": "event",

64766

"submodule": "event-synthetic"

64767

},

64768

{

64769

"file": "event/js/synthetic.js",

64770

"line": 215,

64771

"description": "Returns the array of subscription handles for a node for the given event\ntype. Passing true as the third argument will create a registry entry\nin the event system's DOM map to host the array if one doesn't yet exist.",

64772

"itemtype": "method",

64773

"name": "getRegistry",

64774

"params": [

64775

{

64776

"name": "node",

64777

"description": "the node",

64778

"type": "Node"

64779

},

64780

{

64781

"name": "type",

64782

"description": "the event",

64783

"type": "String"

64784

},

64785

{

64786

"name": "create",

64787

"description": "create a registration entry to host a new array\n if one doesn't exist.",

64788

"type": "Boolean"

64789

}

64790

],

64791

"return": {

64792

"description": "",

64793

"type": "Array"

64794

},

64795

"static": 1,

64796

"access": "protected",

64797

"tagname": "",

64798

"since": "3.2.0",

64799

"class": "SyntheticEvent",

64800

"module": "event",

64801

"submodule": "event-synthetic"

64802

},

64803

{

64804

"file": "event/js/synthetic.js",

64805

"line": 248,

64806

"description": "Alternate <code>_delete()</code> method for the CustomEvent object\ncreated to manage SyntheticEvent subscriptions.",

64807

"itemtype": "method",

64808

"name": "_deleteSub",

64809

"params": [

64810

{

64811

"name": "sub",

64812

"description": "the subscription to clean up",

64813

"type": "Subscription"

64814

}

64815

],

64816

"access": "private",

64817

"tagname": "",

64818

"since": "3.2.0",

64819

"class": "SyntheticEvent",

64820

"module": "event",

64821

"submodule": "event-synthetic"

64822

},

64823

{

64824

"file": "event/js/synthetic.js",

64825

"line": 277,

64826

"description": "Construction logic for the event.",

64827

"itemtype": "method",

64828

"name": "_init",

64829

"access": "protected",

64830

"tagname": "",

64831

"class": "SyntheticEvent",

64832

"module": "event",

64833

"submodule": "event-synthetic"

64834

},

64835

{

64836

"file": "event/js/synthetic.js",

64837

"line": 293,

64838

"description": "Implementers MAY provide this method definition.\n\nImplement this function if the event supports a different\nsubscription signature. This function is used by both\n<code>on()</code> and <code>delegate()</code>. The second parameter\nindicates that the event is being subscribed via\n<code>delegate()</code>.\n\nImplementations must remove extra arguments from the args list\nbefore returning. The required args for <code>on()</code>\nsubscriptions are\n<pre><code>[type, callback, target, context, argN...]</code></pre>\n\nThe required args for <code>delegate()</code>\nsubscriptions are\n\n<pre><code>[type, callback, target, filter, context, argN...]</code></pre>\n\nThe return value from this function will be stored on the\nsubscription in the '_extra' property for reference elsewhere.",

64839

"itemtype": "method",

64840

"name": "processArgs",

64841

"params": [

64842

{

64843

"name": "args",

64844

"description": "parmeters passed to Y.on(..) or Y.delegate(..)",

64845

"type": "Array"

64846

},

64847

{

64848

"name": "delegate",

64849

"description": "true if the subscription is from Y.delegate",

64850

"type": "Boolean"

64851

}

64852

],

64853

"return": {

64854

"description": "",

64855

"type": "Any"

64856

},

64857

"class": "SyntheticEvent",

64858

"module": "event",

64859

"submodule": "event-synthetic"

64860

},

64861

{

64862

"file": "event/js/synthetic.js",

64863

"line": 322,

64864

"description": "Implementers MAY override this property.\n\nWhether to prevent multiple subscriptions to this event that are\nclassified as being the same. By default, this means the subscribed\ncallback is the same function. See the <code>subMatch</code>\nmethod. Setting this to true will impact performance for high volume\nevents.",

64865

"itemtype": "property",

64866

"name": "preventDups",

64867

"type": "{Boolean}",

64868

"default": "false",

64869

"class": "SyntheticEvent",

64870

"module": "event",

64871

"submodule": "event-synthetic"

64872

},

64873

{

64874

"file": "event/js/synthetic.js",

64875

"line": 337,

64876

"description": "Implementers SHOULD provide this method definition.\n\nImplementation logic for subscriptions done via <code>node.on(type,\nfn)</code> or <code>Y.on(type, fn, target)</code>. This\nfunction should set up the monitor(s) that will eventually fire the\nevent. Typically this involves subscribing to at least one DOM\nevent. It is recommended to store detach handles from any DOM\nsubscriptions to make for easy cleanup in the <code>detach</code>\nmethod. Typically these handles are added to the <code>sub</code>\nobject. Also for SyntheticEvents that leverage a single DOM\nsubscription under the hood, it is recommended to pass the DOM event\nobject to <code>notifier.fire(e)</code>. (The event name on the\nobject will be updated).",

64877

"itemtype": "method",

64878

"name": "on",

64879

"params": [

64880

{

64881

"name": "node",

64882

"description": "the node the subscription is being applied to",

64883

"type": "Node"

64884

},

64885

{

64886

"name": "sub",

64887

"description": "the object to track this subscription",

64888

"type": "Subscription"

64889

},

64890

{

64891

"name": "notifier",

64892

"description": "call notifier.fire(..) to\n trigger the execution of the subscribers",

64893

"type": "SyntheticEvent.Notifier"

64894

}

64895

],

64896

"class": "SyntheticEvent",

64897

"module": "event",

64898

"submodule": "event-synthetic"

64899

},

64900

{

64901

"file": "event/js/synthetic.js",

64902

"line": 360,

64903

"description": "Implementers SHOULD provide this method definition.\n\nImplementation logic for detaching subscriptions done via\n<code>node.on(type, fn)</code>. This function should clean up any\nsubscriptions made in the <code>on()</code> phase.",

64904

"itemtype": "method",

64905

"name": "detach",

64906

"params": [

64907

{

64908

"name": "node",

64909

"description": "the node the subscription was applied to",

64910

"type": "Node"

64911

},

64912

{

64913

"name": "sub",

64914

"description": "the object tracking this subscription",

64915

"type": "Subscription"

64916

},

64917

{

64918

"name": "notifier",

64919

"description": "the Notifier used to\n trigger the execution of the subscribers",

64920

"type": "SyntheticEvent.Notifier"

64921

}

64922

],

64923

"class": "SyntheticEvent",

64924

"module": "event",

64925

"submodule": "event-synthetic"

64926

},

64927

{

64928

"file": "event/js/synthetic.js",

64929

"line": 375,

64930

"description": "Implementers SHOULD provide this method definition.\n\nImplementation logic for subscriptions done via\n<code>node.delegate(type, fn, filter)</code> or\n<code>Y.delegate(type, fn, container, filter)</code>. Like with\n<code>on()</code> above, this function should monitor the environment\nfor the event being fired, and trigger subscription execution by\ncalling <code>notifier.fire(e)</code>.\n\nThis function receives a fourth argument, which is the filter\nused to identify which Node's are of interest to the subscription.\nThe filter will be either a boolean function that accepts a target\nNode for each hierarchy level as the event bubbles, or a selector\nstring. To translate selector strings into filter functions, use\n<code>Y.delegate.compileFilter(filter)</code>.",

64931

"itemtype": "method",

64932

"name": "delegate",

64933

"params": [

64934

{

64935

"name": "node",

64936

"description": "the node the subscription is being applied to",

64937

"type": "Node"

64938

},

64939

{

64940

"name": "sub",

64941

"description": "the object to track this subscription",

64942

"type": "Subscription"

64943

},

64944

{

64945

"name": "notifier",

64946

"description": "call notifier.fire(..) to\n trigger the execution of the subscribers",

64947

"type": "SyntheticEvent.Notifier"

64948

},

64949

{

64950

"name": "filter",

64951

"description": "Selector string or function that\n accepts an event object and returns null, a Node, or an\n array of Nodes matching the criteria for processing.",

64952

"type": "String|Function"

64953

}

64954

],

64955

"since": "3.2.0",

64956

"class": "SyntheticEvent",

64957

"module": "event",

64958

"submodule": "event-synthetic"

64959

},

64960

{

64961

"file": "event/js/synthetic.js",

64962

"line": 404,

64963

"description": "Implementers SHOULD provide this method definition.\n\nImplementation logic for detaching subscriptions done via\n<code>node.delegate(type, fn, filter)</code> or\n<code>Y.delegate(type, fn, container, filter)</code>. This function\nshould clean up any subscriptions made in the\n<code>delegate()</code> phase.",

64964

"itemtype": "method",

64965

"name": "detachDelegate",

64966

"params": [

64967

{

64968

"name": "node",

64969

"description": "the node the subscription was applied to",

64970

"type": "Node"

64971

},

64972

{

64973

"name": "sub",

64974

"description": "the object tracking this subscription",

64975

"type": "Subscription"

64976

},

64977

{

64978

"name": "notifier",

64979

"description": "the Notifier used to\n trigger the execution of the subscribers",

64980

"type": "SyntheticEvent.Notifier"

64981

},

64982

{

64983

"name": "filter",

64984

"description": "Selector string or function that\n accepts an event object and returns null, a Node, or an\n array of Nodes matching the criteria for processing.",

64985

"type": "String|Function"

64986

}

64987

],

64988

"since": "3.2.0",

64989

"class": "SyntheticEvent",

64990

"module": "event",

64991

"submodule": "event-synthetic"

64992

},

64993

{

64994

"file": "event/js/synthetic.js",

64995

"line": 425,

64996

"description": "Sets up the boilerplate for detaching the event and facilitating the\nexecution of subscriber callbacks.",

64997

"itemtype": "method",

64998

"name": "_on",

64999

"params": [

65000

{

65001

"name": "args",

65002

"description": "array of arguments passed to\n <code>Y.on(...)</code> or <code>Y.delegate(...)</code>",

65003

"type": "Array"

65004

},

65005

{

65006

"name": "delegate",

65007

"description": "true if called from\n<code>Y.delegate(...)</code>",

65008

"type": "Boolean"

65009

}

65010

],

65011

"return": {

65012

"description": "the detach handle for this subscription",

65013

"type": "EventHandle"

65014

},

65015

"access": "private",

65016

"tagname": "since 3.2.0",

65017

"class": "SyntheticEvent",

65018

"module": "event",

65019

"submodule": "event-synthetic"

65020

},

65021

{

65022

"file": "event/js/synthetic.js",

65023

"line": 486,

65024

"description": "Creates a new Notifier object for use by this event's\n<code>on(...)</code> or <code>delegate(...)</code> implementation\nand register the custom event proxy in the DOM system for cleanup.",

65025

"itemtype": "method",

65026

"name": "_subscribe",

65027

"params": [

65028

{

65029

"name": "node",

65030

"description": "the Node hosting the event",

65031

"type": "Node"

65032

},

65033

{

65034

"name": "method",

65035

"description": "\"on\" or \"delegate\"",

65036

"type": "String"

65037

},

65038

{

65039

"name": "args",

65040

"description": "the subscription arguments passed to either\n <code>Y.on(...)</code> or <code>Y.delegate(...)</code>\n after running through <code>processArgs(args)</code> to\n normalize the argument signature",

65041

"type": "Array"

65042

},

65043

{

65044

"name": "extra",

65045

"description": "Extra data parsed from\n <code>processArgs(args)</code>",

65046

"type": "Any"

65047

},

65048

{

65049

"name": "filter",

65050

"description": "the selector string or function\n filter passed to <code>Y.delegate(...)</code> (not\n present when called from <code>Y.on(...)</code>)",

65051

"type": "String|Function"

65052

}

65053

],

65054

"return": {

65055

"description": "",

65056

"type": "EventHandle"

65057

},

65058

"access": "private",

65059

"tagname": "",

65060

"since": "3.2.0",

65061

"class": "SyntheticEvent",

65062

"module": "event",

65063

"submodule": "event-synthetic"

65064

},

65065

{

65066

"file": "event/js/synthetic.js",

65067

"line": 541,

65068

"description": "Implementers MAY provide this method definition.\n\nImplement this function if you want extra data extracted during\nprocessArgs to be propagated to subscriptions on a per-node basis.\nThat is to say, if you call <code>Y.on('xyz', fn, xtra, 'div')</code>\nthe data returned from processArgs will be shared\nacross the subscription objects for all the divs. If you want each\nsubscription to receive unique information, do that processing\nhere.\n\nThe default implementation adds the data extracted by processArgs\nto the subscription object as <code>sub._extra</code>.",

65069

"itemtype": "method",

65070

"name": "applyArgExtras",

65071

"params": [

65072

{

65073

"name": "extra",

65074

"description": "Any extra data extracted from processArgs",

65075

"type": "Any"

65076

},

65077

{

65078

"name": "sub",

65079

"description": "the individual subscription",

65080

"type": "Subscription"

65081

}

65082

],

65083

"class": "SyntheticEvent",

65084

"module": "event",

65085

"submodule": "event-synthetic"

65086

},

65087

{

65088

"file": "event/js/synthetic.js",

65089

"line": 563,

65090

"description": "Removes the subscription(s) from the internal subscription dispatch\nmechanism. See <code>SyntheticEvent._deleteSub</code>.",

65091

"itemtype": "method",

65092

"name": "_detach",

65093

"params": [

65094

{

65095

"name": "args",

65096

"description": "The arguments passed to\n <code>node.detach(...)</code>",

65097

"type": "Array"

65098

}

65099

],

65100

"access": "private",

65101

"tagname": "",

65102

"since": "3.2.0",

65103

"class": "SyntheticEvent",

65104

"module": "event",

65105

"submodule": "event-synthetic"

65106

},

65107

{

65108

"file": "event/js/synthetic.js",

65109

"line": 599,

65110

"description": "Returns the detach handles of subscriptions on a node that satisfy a\nsearch/filter function. By default, the filter used is the\n<code>subMatch</code> method.",

65111

"itemtype": "method",

65112

"name": "getSubs",

65113

"params": [

65114

{

65115

"name": "node",

65116

"description": "the node hosting the event",

65117

"type": "Node"

65118

},

65119

{

65120

"name": "args",

65121

"description": "the array of original subscription args passed\n to <code>Y.on(...)</code> (before\n <code>processArgs</code>",

65122

"type": "Array"

65123

},

65124

{

65125

"name": "filter",

65126

"description": "function used to identify a subscription\n for inclusion in the returned array",

65127

"type": "Function"

65128

},

65129

{

65130

"name": "first",

65131

"description": "stop after the first match (used to check for\n duplicate subscriptions)",

65132

"type": "Boolean"

65133

}

65134

],

65135

"return": {

65136

"description": "detach handles for the matching subscriptions",

65137

"type": "EventHandle[]"

65138

},

65139

"class": "SyntheticEvent",

65140

"module": "event",

65141

"submodule": "event-synthetic"

65142

},

65143

{

65144

"file": "event/js/synthetic.js",

65145

"line": 642,

65146

"description": "Implementers MAY override this to define what constitutes a\n"same" subscription. Override implementations should\nconsider the lack of a comparator as a match, so calling\n<code>getSubs()</code> with no arguments will return all subs.\n\nCompares a set of subscription arguments against a Subscription\nobject to determine if they match. The default implementation\ncompares the callback function against the second argument passed to\n<code>Y.on(...)</code> or <code>node.detach(...)</code> etc.",

65147

"itemtype": "method",

65148

"name": "subMatch",

65149

"params": [

65150

{

65151

"name": "sub",

65152

"description": "the existing subscription",

65153

"type": "Subscription"

65154

},

65155

{

65156

"name": "args",

65157

"description": "the calling arguments passed to\n <code>Y.on(...)</code> etc.",

65158

"type": "Array"

65159

}

65160

],

65161

"return": {

65162

"description": "true if the sub can be described by the args\n present",

65163

"type": "Boolean"

65164

},

65165

"since": "3.2.0",

65166

"class": "SyntheticEvent",

65167

"module": "event",

65168

"submodule": "event-synthetic"

65169

},

65170

{

65171

"file": "event/js/synthetic.js",

65172

"line": 670,

65173

"description": "Defines a new event in the DOM event system. Implementers are\nresponsible for monitoring for a scenario whereby the event is fired. A\nnotifier object is provided to the functions identified below. When the\ncriteria defining the event are met, call notifier.fire( [args] ); to\nexecute event subscribers.\n\nThe first parameter is the name of the event. The second parameter is a\nconfiguration object which define the behavior of the event system when the\nnew event is subscribed to or detached from. The methods that should be\ndefined in this configuration object are <code>on</code>,\n<code>detach</code>, <code>delegate</code>, and <code>detachDelegate</code>.\nYou are free to define any other methods or properties needed to define your\nevent. Be aware, however, that since the object is used to subclass\nSyntheticEvent, you should avoid method names used by SyntheticEvent unless\nyour intention is to override the default behavior.\n\nThis is a list of properties and methods that you can or should specify\nin the configuration object:\n\n<dl>\n <dt><code>on</code></dt>\n <dd><code>function (node, subscription, notifier)</code> The\n implementation logic for subscription. Any special setup you need to\n do to create the environment for the event being fired--E.g. native\n DOM event subscriptions. Store subscription related objects and\n state on the <code>subscription</code> object. When the\n criteria have been met to fire the synthetic event, call\n <code>notifier.fire(e)</code>. See Notifier's <code>fire()</code>\n method for details about what to pass as parameters.</dd>\n\n <dt><code>detach</code></dt>\n <dd><code>function (node, subscription, notifier)</code> The\n implementation logic for cleaning up a detached subscription. E.g.\n detach any DOM subscriptions added in <code>on</code>.</dd>\n\n <dt><code>delegate</code></dt>\n <dd><code>function (node, subscription, notifier, filter)</code> The\n implementation logic for subscription via <code>Y.delegate</code> or\n <code>node.delegate</code>. The filter is typically either a selector\n string or a function. You can use\n <code>Y.delegate.compileFilter(selectorString)</code> to create a\n filter function from a selector string if needed. The filter function\n expects an event object as input and should output either null, a\n matching Node, or an array of matching Nodes. Otherwise, this acts\n like <code>on</code> DOM event subscriptions. Store subscription\n related objects and information on the <code>subscription</code>\n object. When the criteria have been met to fire the synthetic event,\n call <code>notifier.fire(e)</code> as noted above.</dd>\n\n <dt><code>detachDelegate</code></dt>\n <dd><code>function (node, subscription, notifier)</code> The\n implementation logic for cleaning up a detached delegate subscription.\n E.g. detach any DOM delegate subscriptions added in\n <code>delegate</code>.</dd>\n\n <dt><code>publishConfig</code></dt>\n <dd>(Object) The configuration object that will be used to instantiate\n the underlying CustomEvent. See Notifier's <code>fire</code> method\n for details.</dd>\n\n <dt><code>processArgs</code></dt\n <dd>\n <code>function (argArray, fromDelegate)</code> Optional method\n to extract any additional arguments from the subscription\n signature. Using this allows <code>on</code> or\n <code>delegate</code> signatures like\n <code>node.on("hover", overCallback,\n outCallback)</code>.\n When processing an atypical argument signature, make sure the\n args array is returned to the normal signature before returning\n from the function. For example, in the "hover" example\n above, the <code>outCallback</code> needs to be <code>splice</code>d\n out of the array. The expected signature of the args array for\n <code>on()</code> subscriptions is:\n <pre>\n <code>[type, callback, target, contextOverride, argN...]</code>\n </pre>\n And for <code>delegate()</code>:\n <pre>\n <code>[type, callback, target, filter, contextOverride, argN...]</code>\n </pre>\n where <code>target</code> is the node the event is being\n subscribed for. You can see these signatures documented for\n <code>Y.on()</code> and <code>Y.delegate()</code> respectively.\n Whatever gets returned from the function will be stored on the\n <code>subscription</code> object under\n <code>subscription._extra</code>.</dd>\n <dt><code>subMatch</code></dt>\n <dd>\n <code>function (sub, args)</code> Compares a set of\n subscription arguments against a Subscription object to determine\n if they match. The default implementation compares the callback\n function against the second argument passed to\n <code>Y.on(...)</code> or <code>node.detach(...)</code> etc.\n </dd>\n</dl>",

65174

"itemtype": "method",

65175

"name": "define",

65176

"params": [

65177

{

65178

"name": "type",

65179

"description": "the name of the event",

65180

"type": "String"

65181

},

65182

{

65183

"name": "config",

65184

"description": "the prototype definition for the new event (see above)",

65185

"type": "Object"

65186

},

65187

{

65188

"name": "force",

65189

"description": "override an existing event (use with caution)",

65190

"type": "Boolean"

65191

}

65192

],

65193

"return": {

65194

"description": "the subclass implementation instance created to\n handle event subscriptions of this type",

65195

"type": "SyntheticEvent"

65196

},

65197

"static": 1,

65198

"since": "3.1.0",

65199

"in": "event-synthetic",

65200

"class": "Event",

65201

"module": "event",

65202

"submodule": "event-synthetic"

65203

},

65204

{

65205

"file": "file/js/file-flash.js",

65206

"line": 20,

65207

"description": "Construction logic executed during FileFlash instantiation.",

65208

"itemtype": "method",

65209

"name": "initializer",

65210

"access": "protected",

65211

"tagname": "",

65212

"class": "FileFlash",

65213

"module": "file-flash"

65214

},

65215

{

65216

"file": "file/js/file-flash.js",

65217

"line": 32,

65218

"description": "Handler of events dispatched by the Flash player.",

65219

"itemtype": "method",

65220

"name": "_swfEventHandler",

65221

"params": [

65222

{

65223

"name": "event",

65224

"description": "The event object received from the Flash player.",

65225

"type": "Event"

65226

}

65227

],

65228

"access": "protected",

65229

"tagname": "",

65230

"class": "FileFlash",

65231

"module": "file-flash"

65232

},

65233

{

65234

"file": "file/js/file-flash.js",

65235

"line": 42,

65236

"description": "Signals that this file's upload has started.",

65237

"itemtype": "event",

65238

"name": "uploadstart",

65239

"params": [

65240

{

65241

"name": "event",

65242

"description": "The event object for the `uploadstart` with the\n following payload:\n <dl>\n <dt>uploader</dt>\n <dd>The Y.SWF instance of Flash uploader that's handling the upload.</dd>\n </dl>",

65243

"type": "Event"

65244

}

65245

],

65246

"class": "FileFlash",

65247

"module": "file-flash"

65248

},

65249

{

65250

"file": "file/js/file-flash.js",

65251

"line": 58,

65252

"description": "Signals that progress has been made on the upload of this file.",

65253

"itemtype": "event",

65254

"name": "uploadprogress",

65255

"params": [

65256

{

65257

"name": "event",

65258

"description": "The event object for the `uploadprogress` with the\n following payload:\n <dl>\n <dt>originEvent</dt>\n <dd>The original event fired by the Flash uploader instance.</dd>\n <dt>bytesLoaded</dt>\n <dd>The number of bytes of the file that has been uploaded.</dd>\n <dt>bytesTotal</dt>\n <dd>The total number of bytes in the file (the file size)</dd>\n <dt>percentLoaded</dt>\n <dd>The fraction of the file that has been uploaded, out of 100.</dd>\n </dl>",

65259

"type": "Event"

65260

}

65261

],

65262

"class": "FileFlash",

65263

"module": "file-flash"

65264

},

65265

{

65266

"file": "file/js/file-flash.js",

65267

"line": 84,

65268

"description": "Signals that this file's upload has completed, but data has not yet been received from the server.",

65269

"itemtype": "event",

65270

"name": "uploadfinished",

65271

"params": [

65272

{

65273

"name": "event",

65274

"description": "The event object for the `uploadfinished` with the\n following payload:\n <dl>\n <dt>originEvent</dt>\n <dd>The original event fired by the Flash player instance.</dd>\n </dl>",

65275

"type": "Event"

65276

}

65277

],

65278

"class": "FileFlash",

65279

"module": "file-flash"

65280

},

65281

{

65282

"file": "file/js/file-flash.js",

65283

"line": 98,

65284

"description": "Signals that this file's upload has completed and data has been received from the server.",

65285

"itemtype": "event",

65286

"name": "uploadcomplete",

65287

"params": [

65288

{

65289

"name": "event",

65290

"description": "The event object for the `uploadcomplete` with the\n following payload:\n <dl>\n <dt>originEvent</dt>\n <dd>The original event fired by the Flash player instance.</dd>\n <dt>data</dt>\n <dd>The data returned by the server.</dd>\n </dl>",

65291

"type": "Event"

65292

}

65293

],

65294

"class": "FileFlash",

65295

"module": "file-flash"

65296

},

65297

{

65298

"file": "file/js/file-flash.js",

65299

"line": 116,

65300

"description": "Signals that this file's upload has been cancelled.",

65301

"itemtype": "event",

65302

"name": "uploadcancel",

65303

"params": [

65304

{

65305

"name": "event",

65306

"description": "The event object for the `uploadcancel` with the\n following payload:\n <dl>\n <dt>originEvent</dt>\n <dd>The original event fired by the Flash player instance.</dd>\n </dl>",

65307

"type": "Event"

65308

}

65309

],

65310

"class": "FileFlash",

65311

"module": "file-flash"

65312

},

65313

{

65314

"file": "file/js/file-flash.js",

65315

"line": 131,

65316

"description": "Signals that this file's upload has encountered an error.",

65317

"itemtype": "event",

65318

"name": "uploaderror",

65319

"params": [

65320

{

65321

"name": "event",

65322

"description": "The event object for the `uploaderror` with the\n following payload:\n <dl>\n <dt>originEvent</dt>\n <dd>The original event fired by the Flash player instance.</dd>\n <dt>status</dt>\n <dd>The status code reported by the Flash player instance.</dd>\n <dt>statusText</dt>\n <dd>The text of the error event reported by the Flash player instance</dd>\n </dl>",

65323

"type": "Event"

65324

}

65325

],

65326

"class": "FileFlash",

65327

"module": "file-flash"

65328

},

65329

{

65330

"file": "file/js/file-flash.js",

65331

"line": 152,

65332

"description": "Starts the upload of a specific file.",

65333

"itemtype": "method",

65334

"name": "startUpload",

65335

"params": [

65336

{

65337

"name": "url",

65338

"description": "The URL to upload the file to.",

65339

"type": "String"

65340

},

65341

{

65342

"name": "parameters",

65343

"description": "(optional) A set of key-value pairs to send as variables along with the file upload HTTP request.",

65344

"type": "Object"

65345

},

65346

{

65347

"name": "fileFieldName",

65348

"description": "(optional) The name of the POST variable that should contain the uploaded file ('Filedata' by default)",

65349

"type": "String"

65350

}

65351

],

65352

"class": "FileFlash",

65353

"module": "file-flash"

65354

},

65355

{

65356

"file": "file/js/file-flash.js",

65357

"line": 182,

65358

"description": "Cancels the upload of a specific file, if currently in progress.",

65359

"itemtype": "method",

65360

"name": "cancelUpload",

65361

"class": "FileFlash",

65362

"module": "file-flash"

65363

},

65364

{

65365

"file": "file/js/file-flash.js",

65366

"line": 195,

65367

"description": "The identity of the class.",

65368

"itemtype": "property",

65369

"name": "NAME",

65370

"type": "String",

65371

"default": "'file'",

65372

"readonly": "",

65373

"access": "protected",

65374

"tagname": "",

65375

"static": 1,

65376

"class": "FileFlash",

65377

"module": "file-flash"

65378

},

65379

{

65380

"file": "file/js/file-flash.js",

65381

"line": 207,

65382

"description": "The type of transport.",

65383

"itemtype": "property",

65384

"name": "TYPE",

65385

"type": "String",

65386

"default": "'flash'",

65387

"readonly": "",

65388

"access": "protected",

65389

"tagname": "",

65390

"static": 1,

65391

"class": "FileFlash",

65392

"module": "file-flash"

65393

},

65394

{

65395

"file": "file/js/file-flash.js",

65396

"line": 219,

65397

"description": "Static property used to define the default attribute configuration of\nthe File.",

65398

"itemtype": "property",

65399

"name": "ATTRS",

65400

"type": "{Object}",

65401

"access": "protected",

65402

"tagname": "",

65403

"static": 1,

65404

"class": "FileFlash",

65405

"module": "file-flash"

65406

},

65407

{

65408

"file": "file/js/file-flash.js",

65409

"line": 230,

65410

"description": "A String containing the unique id of the file wrapped by the FileFlash instance.\nThe id is supplied by the Flash player uploader.",

65411

"itemtype": "attribute",

65412

"name": "id",

65413

"type": "{String}",

65414

"initonly": "",

65415

"class": "FileFlash",

65416

"module": "file-flash"

65417

},

65418

{

65419

"file": "file/js/file-flash.js",

65420

"line": 243,

65421

"description": "The size of the file wrapped by FileFlash. This value is supplied by the Flash player uploader.",

65422

"itemtype": "attribute",

65423

"name": "size",

65424

"type": "{Number}",

65425

"initonly": "",

65426

"class": "FileFlash",

65427

"module": "file-flash"

65428

},

65429

{

65430

"file": "file/js/file-flash.js",

65431

"line": 255,

65432

"description": "The name of the file wrapped by FileFlash. This value is supplied by the Flash player uploader.",

65433

"itemtype": "attribute",

65434

"name": "name",

65435

"type": "{String}",

65436

"initonly": "",

65437

"class": "FileFlash",

65438

"module": "file-flash"

65439

},

65440

{

65441

"file": "file/js/file-flash.js",

65442

"line": 267,

65443

"description": "The date that the file wrapped by FileFlash was created on. This value is supplied by the Flash player uploader.",

65444

"itemtype": "attribute",

65445

"name": "dateCreated",

65446

"type": "{Date}",

65447

"initonly": "",

65448

"class": "FileFlash",

65449

"module": "file-flash"

65450

},

65451

{

65452

"file": "file/js/file-flash.js",

65453

"line": 279,

65454

"description": "The date that the file wrapped by FileFlash was last modified on. This value is supplied by the Flash player uploader.",

65455

"itemtype": "attribute",

65456

"name": "dateModified",

65457

"type": "{Date}",

65458

"initonly": "",

65459

"class": "FileFlash",

65460

"module": "file-flash"

65461

},

65462

{

65463

"file": "file/js/file-flash.js",

65464

"line": 291,

65465

"description": "The number of bytes of the file that has been uploaded to the server. This value is\nnon-zero only while a file is being uploaded.",

65466

"itemtype": "attribute",

65467

"name": "bytesUploaded",

65468

"type": "{Date}",

65469

"readonly": "",

65470

"class": "FileFlash",

65471

"module": "file-flash"

65472

},

65473

{

65474

"file": "file/js/file-flash.js",

65475

"line": 304,

65476

"description": "The type of the file wrapped by FileFlash. This value is provided by the Flash player\nuploader.",

65477

"itemtype": "attribute",

65478

"name": "type",

65479

"type": "{String}",

65480

"initonly": "",

65481

"class": "FileFlash",

65482

"module": "file-flash"

65483

},

65484

{

65485

"file": "file/js/file-flash.js",

65486

"line": 317,

65487

"description": "The instance of Y.SWF wrapping the Flash player uploader associated with this file.",

65488

"itemtype": "attribute",

65489

"name": "uploder",

65490

"type": "{SWF}",

65491

"initonly": "",

65492

"class": "FileFlash",

65493

"module": "file-flash"

65494

},

65495

{

65496

"file": "file/js/file-html5.js",

65497

"line": 60,

65498

"description": "Construction logic executed during FileHTML5 instantiation.",

65499

"itemtype": "method",

65500

"name": "initializer",

65501

"access": "protected",

65502

"tagname": "",

65503

"class": "FileHTML5",

65504

"module": "file-html5"

65505

},

65506

{

65507

"file": "file/js/file-html5.js",

65508

"line": 72,

65509

"description": "Handler of events dispatched by the XMLHTTPRequest.",

65510

"itemtype": "method",

65511

"name": "_uplodEventHandler",

65512

"params": [

65513

{

65514

"name": "event",

65515

"description": "The event object received from the XMLHTTPRequest.",

65516

"type": "Event"

65517

}

65518

],

65519

"access": "protected",

65520

"tagname": "",

65521

"class": "FileHTML5",

65522

"module": "file-html5"

65523

},

65524

{

65525

"file": "file/js/file-html5.js",

65526

"line": 82,

65527

"description": "Signals that progress has been made on the upload of this file.",

65528

"itemtype": "event",

65529

"name": "uploadprogress",

65530

"params": [

65531

{

65532

"name": "event",

65533

"description": "The event object for the `uploadprogress` with the\n following payload:\n <dl>\n <dt>originEvent</dt>\n <dd>The original event fired by the XMLHttpRequest instance.</dd>\n <dt>bytesLoaded</dt>\n <dd>The number of bytes of the file that has been uploaded.</dd>\n <dt>bytesTotal</dt>\n <dd>The total number of bytes in the file (the file size)</dd>\n <dt>percentLoaded</dt>\n <dd>The fraction of the file that has been uploaded, out of 100.</dd>\n </dl>",

65534

"type": "Event"

65535

}

65536

],

65537

"class": "FileHTML5",

65538

"module": "file-html5"

65539

},

65540

{

65541

"file": "file/js/file-html5.js",

65542

"line": 108,

65543

"description": "Signals that this file's upload has completed and data has been received from the server.",

65544

"itemtype": "event",

65545

"name": "uploadcomplete",

65546

"params": [

65547

{

65548

"name": "event",

65549

"description": "The event object for the `uploadcomplete` with the\n following payload:\n <dl>\n <dt>originEvent</dt>\n <dd>The original event fired by the XMLHttpRequest instance.</dd>\n <dt>data</dt>\n <dd>The data returned by the server.</dd>\n </dl>",

65550

"type": "Event"

65551

}

65552

],

65553

"class": "FileHTML5",

65554

"module": "file-html5"

65555

},

65556

{

65557

"file": "file/js/file-html5.js",

65558

"line": 138,

65559

"description": "Signals that this file's upload has encountered an error.",

65560

"itemtype": "event",

65561

"name": "uploaderror",

65562

"params": [

65563

{

65564

"name": "event",

65565

"description": "The event object for the `uploaderror` with the\n following payload:\n <dl>\n <dt>originEvent</dt>\n <dd>The original event fired by the XMLHttpRequest instance.</dd>\n <dt>status</dt>\n <dd>The status code reported by the XMLHttpRequest</dd>\n <dt>statusText</dt>\n <dd>The text of the error event reported by the XMLHttpRequest instance</dd>\n </dl>",

65566

"type": "Event"

65567

}

65568

],

65569

"class": "FileHTML5",

65570

"module": "file-html5"

65571

},

65572

{

65573

"file": "file/js/file-html5.js",

65574

"line": 160,

65575

"description": "Signals that this file's upload has been cancelled.",

65576

"itemtype": "event",

65577

"name": "uploadcancel",

65578

"params": [

65579

{

65580

"name": "event",

65581

"description": "The event object for the `uploadcancel` with the\n following payload:\n <dl>\n <dt>originEvent</dt>\n <dd>The original event fired by the XMLHttpRequest instance.</dd>\n </dl>",

65582

"type": "Event"

65583

}

65584

],

65585

"class": "FileHTML5",

65586

"module": "file-html5"

65587

},

65588

{

65589

"file": "file/js/file-html5.js",

65590

"line": 176,

65591

"description": "Signals that XMLHttpRequest has fired a readystatechange event.",

65592

"itemtype": "event",

65593

"name": "readystatechange",

65594

"params": [

65595

{

65596

"name": "event",

65597

"description": "The event object for the `readystatechange` with the\n following payload:\n <dl>\n <dt>readyState</dt>\n <dd>The readyState code reported by the XMLHttpRequest instance.</dd>\n <dt>originEvent</dt>\n <dd>The original event fired by the XMLHttpRequest instance.</dd>\n </dl>",

65598

"type": "Event"

65599

}

65600

],

65601

"class": "FileHTML5",

65602

"module": "file-html5"

65603

},

65604

{

65605

"file": "file/js/file-html5.js",

65606

"line": 195,

65607

"description": "Starts the upload of a specific file.",

65608

"itemtype": "method",

65609

"name": "startUpload",

65610

"params": [

65611

{

65612

"name": "url",

65613

"description": "The URL to upload the file to.",

65614

"type": "String"

65615

},

65616

{

65617

"name": "parameters",

65618

"description": "(optional) A set of key-value pairs to send as variables along with the file upload HTTP request.",

65619

"type": "Object"

65620

},

65621

{

65622

"name": "fileFieldName",

65623

"description": "(optional) The name of the POST variable that should contain the uploaded file ('Filedata' by default)",

65624

"type": "String"

65625

}

65626

],

65627

"class": "FileHTML5",

65628

"module": "file-html5"

65629

},

65630

{

65631

"file": "file/js/file-html5.js",

65632

"line": 230,

65633

"description": "Signals that this file's upload has started.",

65634

"itemtype": "event",

65635

"name": "uploadstart",

65636

"params": [

65637

{

65638

"name": "event",

65639

"description": "The event object for the `uploadstart` with the\n following payload:\n <dl>\n <dt>xhr</dt>\n <dd>The XMLHttpRequest instance handling the file upload.</dd>\n </dl>",

65640

"type": "Event"

65641

}

65642

],

65643

"class": "FileHTML5",

65644

"module": "file-html5"

65645

},

65646

{

65647

"file": "file/js/file-html5.js",

65648

"line": 245,

65649

"description": "Cancels the upload of a specific file, if currently in progress.",

65650

"itemtype": "method",

65651

"name": "cancelUpload",

65652

"class": "FileHTML5",

65653

"module": "file-html5"

65654

},

65655

{

65656

"file": "file/js/file-html5.js",

65657

"line": 257,

65658

"description": "The identity of the class.",

65659

"itemtype": "property",

65660

"name": "NAME",

65661

"type": "String",

65662

"default": "'file'",

65663

"readonly": "",

65664

"access": "protected",

65665

"tagname": "",

65666

"static": 1,

65667

"class": "FileHTML5",

65668

"module": "file-html5"

65669

},

65670

{

65671

"file": "file/js/file-html5.js",

65672

"line": 269,

65673

"description": "The type of transport.",

65674

"itemtype": "property",

65675

"name": "TYPE",

65676

"type": "String",

65677

"default": "'html5'",

65678

"readonly": "",

65679

"access": "protected",

65680

"tagname": "",

65681

"static": 1,

65682

"class": "FileHTML5",

65683

"module": "file-html5"

65684

},

65685

{

65686

"file": "file/js/file-html5.js",

65687

"line": 281,

65688

"description": "Static property used to define the default attribute configuration of\nthe File.",

65689

"itemtype": "property",

65690

"name": "ATTRS",

65691

"type": "{Object}",

65692

"access": "protected",

65693

"tagname": "",

65694

"static": 1,

65695

"class": "FileHTML5",

65696

"module": "file-html5"

65697

},

65698

{

65699

"file": "file/js/file-html5.js",

65700

"line": 292,

65701

"description": "A String containing the unique id of the file wrapped by the FileFlash instance.\nThe id is supplied by the Flash player uploader.",

65702

"itemtype": "attribute",

65703

"name": "id",

65704

"type": "{String}",

65705

"initonly": "",

65706

"class": "FileHTML5",

65707

"module": "file-html5"

65708

},

65709

{

65710

"file": "file/js/file-html5.js",

65711

"line": 305,

65712

"description": "The size of the file wrapped by FileHTML5. This value is supplied by the instance of File().",

65713

"itemtype": "attribute",

65714

"name": "size",

65715

"type": "{Number}",

65716

"initonly": "",

65717

"class": "FileHTML5",

65718

"module": "file-html5"

65719

},

65720

{

65721

"file": "file/js/file-html5.js",

65722

"line": 317,

65723

"description": "The name of the file wrapped by FileHTML5. This value is supplied by the instance of File().",

65724

"itemtype": "attribute",

65725

"name": "name",

65726

"type": "{String}",

65727

"initonly": "",

65728

"class": "FileHTML5",

65729

"module": "file-html5"

65730

},

65731

{

65732

"file": "file/js/file-html5.js",

65733

"line": 329,

65734

"description": "The date that the file wrapped by FileHTML5 was created on. This value is supplied by the instance of File().",

65735

"itemtype": "attribute",

65736

"name": "dateCreated",

65737

"type": "{Date}",

65738

"initonly": "",

65739

"default": "null",

65740

"class": "FileHTML5",

65741

"module": "file-html5"

65742

},

65743

{

65744

"file": "file/js/file-html5.js",

65745

"line": 342,

65746

"description": "The date that the file wrapped by FileHTML5 was last modified on. This value is supplied by the instance of File().",

65747

"itemtype": "attribute",

65748

"name": "dateModified",

65749

"type": "{Date}",

65750

"initonly": "",

65751

"class": "FileHTML5",

65752

"module": "file-html5"

65753

},

65754

{

65755

"file": "file/js/file-html5.js",

65756

"line": 354,

65757

"description": "The number of bytes of the file that has been uploaded to the server. This value is\nnon-zero only while a file is being uploaded.",

65758

"itemtype": "attribute",

65759

"name": "bytesUploaded",

65760

"type": "{Date}",

65761

"readonly": "",

65762

"class": "FileHTML5",

65763

"module": "file-html5"

65764

},

65765

{

65766

"file": "file/js/file-html5.js",

65767

"line": 367,

65768

"description": "The type of the file wrapped by FileHTML. This value is provided by the instance of File()",

65769

"itemtype": "attribute",

65770

"name": "type",

65771

"type": "{String}",

65772

"initonly": "",

65773

"class": "FileHTML5",

65774

"module": "file-html5"

65775

},

65776

{

65777

"file": "file/js/file-html5.js",

65778

"line": 379,

65779

"description": "The pointer to the instance of File() wrapped by FileHTML5.",

65780

"itemtype": "attribute",

65781

"name": "file",

65782

"type": "{File}",

65783

"initonly": "",

65784

"class": "FileHTML5",

65785

"module": "file-html5"

65786

},

65787

{

65788

"file": "file/js/file-html5.js",

65789

"line": 391,

65790

"description": "The pointer to the instance of XMLHttpRequest used by FileHTML5 to upload the file.",

65791

"itemtype": "attribute",

65792

"name": "xhr",

65793

"type": "{XMLHttpRequest}",

65794

"initonly": "",

65795

"class": "FileHTML5",

65796

"module": "file-html5"

65797

},

65798

{

65799

"file": "file/js/file-html5.js",

65800

"line": 403,

65801

"description": "The bound event handler used to handle events from XMLHttpRequest.",

65802

"itemtype": "attribute",

65803

"name": "boundEventHandler",

65804

"type": "{Function}",

65805

"initonly": "",

65806

"class": "FileHTML5",

65807

"module": "file-html5"

65808

},

65809

{

65810

"file": "file/js/file-html5.js",

65811

"line": 416,

65812

"description": "Checks whether a specific native file instance is valid",

65813

"itemtype": "method",

65814

"name": "isValidFile",

65815

"params": [

65816

{

65817

"name": "file",

65818

"description": "A native File() instance.",

65819

"type": "File"

65820

}

65821

],

65822

"static": 1,

65823

"class": "FileHTML5",

65824

"module": "file-html5"

65825

},

65826

{

65827

"file": "file/js/file-html5.js",

65828

"line": 427,

65829

"description": "Checks whether the browser has a native upload capability\nvia XMLHttpRequest Level 2.",

65830

"itemtype": "method",

65831

"name": "canUpload",

65832

"static": 1,

65833

"class": "FileHTML5",

65834

"module": "file-html5"

65835

},

65836

{

65837

"file": "get/js/get-nodejs.js",

65838

"line": 22,

65839

"description": "Escape the path for Windows, they need to be double encoded when used as `__dirname` or `__filename`",

65840

"itemtype": "method",

65841

"name": "escapeWinPath",

65842

"access": "protected",

65843

"tagname": "",

65844

"params": [

65845

{

65846

"name": "p",

65847

"description": "The path to modify",

65848

"type": "String"

65849

}

65850

],

65851

"return": {

65852

"description": "The encoded path",

65853

"type": "String"

65854

},

65855

"class": "GetNodeJS",

65856

"module": "get-nodejs"

65857

},

65858

{

65859

"file": "get/js/get-nodejs.js",

65860

"line": 33,

65861

"description": "Takes the raw JS files and wraps them to be executed in the YUI context so they can be loaded\ninto the YUI object",

65862

"itemtype": "method",

65863

"name": "_exec",

65864

"access": "private",

65865

"tagname": "",

65866

"params": [

65867

{

65868

"name": "data",

65869

"description": "The JS to execute",

65870

"type": "String"

65871

},

65872

{

65873

"name": "url",

65874

"description": "The path to the file that was parsed",

65875

"type": "String"

65876

},

65877

{

65878

"name": "cb",

65879

"description": "The callback to execute when this is completed",

65880

"type": "Callback",

65881

"props": [

65882

{

65883

"name": "err=null",

65884

"description": "Error object",

65885

"type": "Error"

65886

},

65887

{

65888

"name": "url",

65889

"description": "The URL that was just parsed",

65890

"type": "String"

65891

}

65892

]

65893

}

65894

],

65895

"class": "GetNodeJS",

65896

"module": "get-nodejs"

65897

},

65898

{

65899

"file": "get/js/get-nodejs.js",

65900

"line": 70,

65901

"description": "Fetches the content from a remote URL or a file from disc and passes the content\noff to `_exec` for parsing",

65902

"itemtype": "method",

65903

"name": "_include",

65904

"access": "private",

65905

"tagname": "",

65906

"params": [

65907

{

65908

"name": "url",

65909

"description": "The URL/File path to fetch the content from",

65910

"type": "String"

65911

},

65912

{

65913

"name": "cb",

65914

"description": "The callback to fire once the content has been executed via `_exec`",

65915

"type": "Callback"

65916

}

65917

],

65918

"class": "GetNodeJS",

65919

"module": "get-nodejs"

65920

},

65921

{

65922

"file": "get/js/get-nodejs.js",

65923

"line": 137,

65924

"description": "Override for Get.script for loading local or remote YUI modules.",

65925

"itemtype": "method",

65926

"name": "js",

65927

"params": [

65928

{

65929

"name": "s",

65930

"description": "The URL's to load into this context",

65931

"type": "Array|String"

65932

},

65933

{

65934

"name": "options",

65935

"description": "Transaction options",

65936

"type": "Object"

65937

}

65938

],

65939

"class": "GetNodeJS",

65940

"module": "get-nodejs"

65941

},

65942

{

65943

"file": "get/js/get-nodejs.js",

65944

"line": 186,

65945

"description": "Alias for `Y.Get.js`",

65946

"itemtype": "method",

65947

"name": "script",

65948

"class": "GetNodeJS",

65949

"module": "get-nodejs"

65950

},

65951

{

65952

"file": "get/js/get.js",

65953

"line": 20,

65954

"description": "Default options for CSS requests. Options specified here will override\nglobal defaults for CSS requests.\n\nSee the `options` property for all available options.",

65955

"itemtype": "property",

65956

"name": "cssOptions",

65957

"type": "Object",

65958

"static": 1,

65959

"since": "3.5.0",

65960

"class": "Get",

65961

"module": "get"

65962

},

65963

{

65964

"file": "get/js/get.js",

65965

"line": 40,

65966

"description": "Default options for JS requests. Options specified here will override global\ndefaults for JS requests.\n\nSee the `options` property for all available options.",

65967

"itemtype": "property",

65968

"name": "jsOptions",

65969

"type": "Object",

65970

"static": 1,

65971

"since": "3.5.0",

65972

"class": "Get",

65973

"module": "get"

65974

},

65975

{

65976

"file": "get/js/get.js",

65977

"line": 56,

65978

"description": "Default options to use for all requests.\n\nNote that while all available options are documented here for ease of\ndiscovery, some options (like callback functions) only make sense at the\ntransaction level.\n\nCallback functions specified via the options object or the `options`\nparameter of the `css()`, `js()`, or `load()` methods will receive the\ntransaction object as a parameter. See `Y.Get.Transaction` for details on\nthe properties and methods available on transactions.",

65979

"static": 1,

65980

"since": "3.5.0",

65981

"itemtype": "property",

65982

"name": "options",

65983

"type": "Object",

65984

"class": "Get",

65985

"module": "get",

65986

"subprops": [

65987

{

65988

"name": "async",

65989

"description": "Whether or not to load scripts\n asynchronously, meaning they're requested in parallel and execution\n order is not guaranteed. Has no effect on CSS, since CSS is always\n loaded asynchronously.",

65990

"type": "Boolean",

65991

"optional": true,

65992

"optdefault": "false"

65993

},

65994

{

65995

"name": "attributes",

65996

"description": "HTML attribute name/value pairs that\n should be added to inserted nodes. By default, the `charset` attribute\n will be set to \"utf-8\" and nodes will be given an auto-generated `id`\n attribute, but you can override these with your own values if desired.",

65997

"type": "Object",

65998

"optional": true

65999

},

66000

{

66001

"name": "autopurge",

66002

"description": "Whether or not to automatically\n purge inserted nodes after the purge threshold is reached. This is\n `true` by default for JavaScript, but `false` for CSS since purging a\n CSS node will also remove any styling applied by the referenced file.",

66003

"type": "Boolean",

66004

"optional": true

66005

},

66006

{

66007

"name": "context",

66008

"description": "`this` object to use when calling\n callback functions. Defaults to the transaction object.",

66009

"type": "Object",

66010

"optional": true

66011

},

66012

{

66013

"name": "data",

66014

"description": "Arbitrary data object to pass to \"on*\"\n callbacks.",

66015

"type": "Mixed",

66016

"optional": true

66017

},

66018

{

66019

"name": "doc",

66020

"description": "Document into which nodes should be\n inserted. By default, the current document is used.",

66021

"type": "Document",

66022

"optional": true

66023

},

66024

{

66025

"name": "insertBefore",

66026

"description": "HTML element or id\n string of an element before which all generated nodes should be\n inserted. If not specified, Get will automatically determine the best\n place to insert nodes for maximum compatibility.",

66027

"type": "HTMLElement|String",

66028

"optional": true

66029

},

66030

{

66031

"name": "onEnd",

66032

"description": "Callback to execute after a transaction\n is complete, regardless of whether it succeeded or failed.",

66033

"type": "Function",

66034

"optional": true

66035

},

66036

{

66037

"name": "onFailure",

66038

"description": "Callback to execute after a\n transaction fails, times out, or is aborted.",

66039

"type": "Function",

66040

"optional": true

66041

},

66042

{

66043

"name": "onProgress",

66044

"description": "Callback to execute after each\n individual request in a transaction either succeeds or fails.",

66045

"type": "Function",

66046

"optional": true

66047

},

66048

{

66049

"name": "onSuccess",

66050

"description": "Callback to execute after a\n transaction completes successfully with no errors. Note that in browsers\n that don't support the `error` event on CSS `<link>` nodes, a failed CSS\n request may still be reported as a success because in these browsers\n it can be difficult or impossible to distinguish between success and\n failure for CSS resources.",

66051

"type": "Function",

66052

"optional": true

66053

},

66054

{

66055

"name": "onTimeout",

66056

"description": "Callback to execute after a\n transaction times out.",

66057

"type": "Function",

66058

"optional": true

66059

},

66060

{

66061

"name": "pollInterval",

66062

"description": "Polling interval (in\n milliseconds) for detecting CSS load completion in browsers that don't\n support the `load` event on `<link>` nodes. This isn't used for\n JavaScript.",

66063

"type": "Number",

66064

"optional": true,

66065

"optdefault": "50"

66066

},

66067

{

66068

"name": "purgethreshold",

66069

"description": "Number of nodes to insert\n before triggering an automatic purge when `autopurge` is `true`.",

66070

"type": "Number",

66071

"optional": true,

66072

"optdefault": "20"

66073

},

66074

{

66075

"name": "timeout",

66076

"description": "Number of milliseconds to wait before\n aborting a transaction. When a timeout occurs, the `onTimeout` callback\n is called, followed by `onFailure` and finally `onEnd`. By default,\n there is no timeout.",

66077

"type": "Number",

66078

"optional": true

66079

},

66080

{

66081

"name": "type",

66082

"description": "Resource type (\"css\" or \"js\"). This option\n is set automatically by the `css()` and `js()` functions and will be\n ignored there, but may be useful when using the `load()` function. If\n not specified, the type will be inferred from the URL, defaulting to\n \"js\" if the URL doesn't contain a recognizable file extension.",

66083

"type": "String",

66084

"optional": true

66085

}

66086

]

66087

},

66088

{

66089

"file": "get/js/get.js",

66090

"line": 149,

66091

"description": "Regex that matches a CSS URL. Used to guess the file type when it's not\nspecified.",

66092

"itemtype": "property",

66093

"name": "REGEX_CSS",

66094

"type": "RegExp",

66095

"final": 1,

66096

"access": "protected",

66097

"tagname": "",

66098

"static": 1,

66099

"since": "3.5.0",

66100

"class": "Get",

66101

"module": "get"

66102

},

66103

{

66104

"file": "get/js/get.js",

66105

"line": 162,

66106

"description": "Regex that matches a JS URL. Used to guess the file type when it's not\nspecified.",

66107

"itemtype": "property",

66108

"name": "REGEX_JS",

66109

"type": "RegExp",

66110

"final": 1,

66111

"access": "protected",

66112

"tagname": "",

66113

"static": 1,

66114

"since": "3.5.0",

66115

"class": "Get",

66116

"module": "get"

66117

},

66118

{

66119

"file": "get/js/get.js",

66120

"line": 175,

66121

"description": "Contains information about the current environment, such as what script and\nlink injection features it supports.\n\nThis object is created and populated the first time the `_getEnv()` method\nis called.",

66122

"itemtype": "property",

66123

"name": "_env",

66124

"type": "Object",

66125

"access": "protected",

66126

"tagname": "",

66127

"static": 1,

66128

"since": "3.5.0",

66129

"class": "Get",

66130

"module": "get"

66131

},

66132

{

66133

"file": "get/js/get.js",

66134

"line": 189,

66135

"description": "Mapping of document _yuid strings to <head> or <base> node references so we\ndon't have to look the node up each time we want to insert a request node.",

66136

"itemtype": "property",

66137

"name": "_insertCache",

66138

"type": "Object",

66139

"access": "protected",

66140

"tagname": "",

66141

"static": 1,

66142

"since": "3.5.0",

66143

"class": "Get",

66144

"module": "get"

66145

},

66146

{

66147

"file": "get/js/get.js",

66148

"line": 201,

66149

"description": "Information about the currently pending transaction, if any.\n\nThis is actually an object with two properties: `callback`, containing the\noptional callback passed to `css()`, `load()`, or `js()`; and `transaction`,\ncontaining the actual transaction instance.",

66150

"itemtype": "property",

66151

"name": "_pending",

66152

"type": "Object",

66153

"access": "protected",

66154

"tagname": "",

66155

"static": 1,

66156

"since": "3.5.0",

66157

"class": "Get",

66158

"module": "get"

66159

},

66160

{

66161

"file": "get/js/get.js",

66162

"line": 216,

66163

"description": "HTML nodes eligible to be purged next time autopurge is triggered.",

66164

"itemtype": "property",

66165

"name": "_purgeNodes",

66166

"type": "HTMLElement[]",

66167

"access": "protected",

66168

"tagname": "",

66169

"static": 1,

66170

"since": "3.5.0",

66171

"class": "Get",

66172

"module": "get"

66173

},

66174

{

66175

"file": "get/js/get.js",

66176

"line": 227,

66177

"description": "Queued transactions and associated callbacks.",

66178

"itemtype": "property",

66179

"name": "_queue",

66180

"type": "Object[]",

66181

"access": "protected",

66182

"tagname": "",

66183

"static": 1,

66184

"since": "3.5.0",

66185

"class": "Get",

66186

"module": "get"

66187

},

66188

{

66189

"file": "get/js/get.js",

66190

"line": 240,

66191

"description": "Aborts the specified transaction.\n\nThis will cause the transaction's `onFailure` callback to be called and\nwill prevent any new script and link nodes from being added to the document,\nbut any resources that have already been requested will continue loading\n(there's no safe way to prevent this, unfortunately).\n\n*Note:* This method is deprecated as of 3.5.0, and will be removed in a\nfuture version of YUI. Use the transaction-level `abort()` method instead.",

66192

"itemtype": "method",

66193

"name": "abort",

66194

"params": [

66195

{

66196

"name": "transaction",

66197

"description": "Transaction to abort.",

66198

"type": "Get.Transaction"

66199

}

66200

],

66201

"deprecated": true,

66202

"deprecationMessage": "Use the `abort()` method on the transaction instead.",

66203

"static": 1,

66204

"class": "Get",

66205

"module": "get"

66206

},

66207

{

66208

"file": "get/js/get.js",

66209

"line": 285,

66210

"description": "Loads one or more CSS files.\n\nThe _urls_ parameter may be provided as a URL string, a request object,\nor an array of URL strings and/or request objects.\n\nA request object is just an object that contains a `url` property and zero\nor more options that should apply specifically to that request.\nRequest-specific options take priority over transaction-level options and\ndefault options.\n\nURLs may be relative or absolute, and do not have to have the same origin\nas the current page.\n\nThe `options` parameter may be omitted completely and a callback passed in\nits place, if desired.",

66211

"example": [

66212

"\n\n // Load a single CSS file and log a message on completion.\n Y.Get.css('foo.css', function (err) {\n if (err) {\n Y.log('foo.css failed to load!');\n } else {\n Y.log('foo.css was loaded successfully');\n }\n });\n\n // Load multiple CSS files and log a message when all have finished\n // loading.\n var urls = ['foo.css', 'http://example.com/bar.css', 'baz/quux.css'];\n\n Y.Get.css(urls, function (err) {\n if (err) {\n Y.log('one or more files failed to load!');\n } else {\n Y.log('all files loaded successfully');\n }\n });\n\n // Specify transaction-level options, which will apply to all requests\n // within the transaction.\n Y.Get.css(urls, {\n attributes: {'class': 'my-css'},\n timeout : 5000\n });\n\n // Specify per-request options, which override transaction-level and\n // default options.\n Y.Get.css([\n {url: 'foo.css', attributes: {id: 'foo'}},\n {url: 'bar.css', attributes: {id: 'bar', charset: 'iso-8859-1'}}\n ]);"

66213

],

66214

"itemtype": "method",

66215

"name": "css",

66216

"params": [

66217

{

66218

"name": "urls",

66219

"description": "URL string, request object, or array\n of URLs and/or request objects to load.",

66220

"type": "String|Object|Array"

66221

},

66222

{

66223

"name": "options",

66224

"description": "Options for this transaction. See the\n `Y.Get.options` property for a complete list of available options.",

66225

"type": "Object",

66226

"optional": true

66227

},

66228

{

66229

"name": "callback",

66230

"description": "Callback function to be called on completion.\n This is a general callback and will be called before any more granular\n callbacks (`onSuccess`, `onFailure`, etc.) specified in the `options`\n object.",

66231

"type": "Function",

66232

"optional": true,

66233

"props": [

66234

{

66235

"name": "err",

66236

"description": "Array of errors that occurred during\n the transaction, or `null` on success.",

66237

"type": "Array|null"

66238

},

66239

{

66240

"name": "transaction",

66241

"description": "Transaction object.",

66242

"type": "Get.Transaction"

66243

}

66244

]

66245

}

66246

],

66247

"return": {

66248

"description": "Transaction object.",

66249

"type": "Get.Transaction"

66250

},

66251

"static": 1,

66252

"class": "Get",

66253

"module": "get"

66254

},

66255

{

66256

"file": "get/js/get.js",

66257

"line": 360,

66258

"description": "Loads one or more JavaScript resources.\n\nThe _urls_ parameter may be provided as a URL string, a request object,\nor an array of URL strings and/or request objects.\n\nA request object is just an object that contains a `url` property and zero\nor more options that should apply specifically to that request.\nRequest-specific options take priority over transaction-level options and\ndefault options.\n\nURLs may be relative or absolute, and do not have to have the same origin\nas the current page.\n\nThe `options` parameter may be omitted completely and a callback passed in\nits place, if desired.\n\nScripts will be executed in the order they're specified unless the `async`\noption is `true`, in which case they'll be loaded in parallel and executed\nin whatever order they finish loading.",

66259

"example": [

66260

"\n\n // Load a single JS file and log a message on completion.\n Y.Get.js('foo.js', function (err) {\n if (err) {\n Y.log('foo.js failed to load!');\n } else {\n Y.log('foo.js was loaded successfully');\n }\n });\n\n // Load multiple JS files, execute them in order, and log a message when\n // all have finished loading.\n var urls = ['foo.js', 'http://example.com/bar.js', 'baz/quux.js'];\n\n Y.Get.js(urls, function (err) {\n if (err) {\n Y.log('one or more files failed to load!');\n } else {\n Y.log('all files loaded successfully');\n }\n });\n\n // Specify transaction-level options, which will apply to all requests\n // within the transaction.\n Y.Get.js(urls, {\n attributes: {'class': 'my-js'},\n timeout : 5000\n });\n\n // Specify per-request options, which override transaction-level and\n // default options.\n Y.Get.js([\n {url: 'foo.js', attributes: {id: 'foo'}},\n {url: 'bar.js', attributes: {id: 'bar', charset: 'iso-8859-1'}}\n ]);"

66261

],

66262

"itemtype": "method",

66263

"name": "js",

66264

"params": [

66265

{

66266

"name": "urls",

66267

"description": "URL string, request object, or array\n of URLs and/or request objects to load.",

66268

"type": "String|Object|Array"

66269

},

66270

{

66271

"name": "options",

66272

"description": "Options for this transaction. See the\n `Y.Get.options` property for a complete list of available options.",

66273

"type": "Object",

66274

"optional": true

66275

},

66276

{

66277

"name": "callback",

66278

"description": "Callback function to be called on completion.\n This is a general callback and will be called before any more granular\n callbacks (`onSuccess`, `onFailure`, etc.) specified in the `options`\n object.",

66279

"type": "Function",

66280

"optional": true,

66281

"props": [

66282

{

66283

"name": "err",

66284

"description": "Array of errors that occurred during\n the transaction, or `null` on success.",

66285

"type": "Array|null"

66286

},

66287

{

66288

"name": "transaction",

66289

"description": "Transaction object.",

66290

"type": "Get.Transaction"

66291

}

66292

]

66293

}

66294

],

66295

"return": {

66296

"description": "Transaction object.",

66297

"type": "Get.Transaction"

66298

},

66299

"since": "3.5.0",

66300

"static": 1,

66301

"class": "Get",

66302

"module": "get"

66303

},

66304

{

66305

"file": "get/js/get.js",

66306

"line": 440,

66307

"description": "Loads one or more CSS and/or JavaScript resources in the same transaction.\n\nUse this method when you want to load both CSS and JavaScript in a single\ntransaction and be notified when all requested URLs have finished loading,\nregardless of type.\n\nBehavior and options are the same as for the `css()` and `js()` methods. If\na resource type isn't specified in per-request options or transaction-level\noptions, Get will guess the file type based on the URL's extension (`.css`\nor `.js`, with or without a following query string). If the file type can't\nbe guessed from the URL, a warning will be logged and Get will assume the\nURL is a JavaScript resource.",

66308

"example": [

66309

"\n\n // Load both CSS and JS files in a single transaction, and log a message\n // when all files have finished loading.\n Y.Get.load(['foo.css', 'bar.js', 'baz.css'], function (err) {\n if (err) {\n Y.log('one or more files failed to load!');\n } else {\n Y.log('all files loaded successfully');\n }\n });"

66310

],

66311

"itemtype": "method",

66312

"name": "load",

66313

"params": [

66314

{

66315

"name": "urls",

66316

"description": "URL string, request object, or array\n of URLs and/or request objects to load.",

66317

"type": "String|Object|Array"

66318

},

66319

{

66320

"name": "options",

66321

"description": "Options for this transaction. See the\n `Y.Get.options` property for a complete list of available options.",

66322

"type": "Object",

66323

"optional": true

66324

},

66325

{

66326

"name": "callback",

66327

"description": "Callback function to be called on completion.\n This is a general callback and will be called before any more granular\n callbacks (`onSuccess`, `onFailure`, etc.) specified in the `options`\n object.",

66328

"type": "Function",

66329

"optional": true

66330

},

66331

{

66332

"name": "err",

66333

"description": "Array of errors that occurred during the\n transaction, or `null` on success.",

66334

"type": "Array|null"

66335

},

66336

{

66337

"name": "Transaction",

66338

"description": "object.",

66339

"type": "Get.Transaction"

66340

}

66341

],

66342

"return": {

66343

"description": "Transaction object.",

66344

"type": "Get.Transaction"

66345

},

66346

"since": "3.5.0",

66347

"static": 1,

66348

"class": "Get",

66349

"module": "get"

66350

},

66351

{

66352

"file": "get/js/get.js",

66353

"line": 490,

66354

"description": "Triggers an automatic purge if the purge threshold has been reached.",

66355

"itemtype": "method",

66356

"name": "_autoPurge",

66357

"params": [

66358

{

66359

"name": "threshold",

66360

"description": "Purge threshold to use, in milliseconds.",

66361

"type": "Number"

66362

}

66363

],

66364

"access": "protected",

66365

"tagname": "",

66366

"since": "3.5.0",

66367

"static": 1,

66368

"class": "Get",

66369

"module": "get"

66370

},

66371

{

66372

"file": "get/js/get.js",

66373

"line": 506,

66374

"description": "Populates the `_env` property with information about the current\nenvironment.",

66375

"itemtype": "method",

66376

"name": "_getEnv",

66377

"return": {

66378

"description": "Environment information.",

66379

"type": "Object"

66380

},

66381

"access": "protected",

66382

"tagname": "",

66383

"since": "3.5.0",

66384

"static": 1,

66385

"class": "Get",

66386

"module": "get"

66387

},

66388

{

66389

"file": "get/js/get.js",

66390

"line": 710,

66391

"description": "Alias for `js()`.",

66392

"itemtype": "method",

66393

"name": "script",

66394

"static": 1,

66395

"class": "Get",

66396

"module": "get"

66397

},

66398

{

66399

"file": "get/js/get.js",

66400

"line": 748,

66401

"description": "Arbitrary data object associated with this transaction.\n\nThis object comes from the options passed to `Get.css()`, `Get.js()`, or\n`Get.load()`, and will be `undefined` if no data object was specified.",

66402

"itemtype": "property",

66403

"name": "data",

66404

"type": "Object",

66405

"class": "Get.Transaction",

66406

"module": "get"

66407

},

66408

{

66409

"file": "get/js/get.js",

66410

"line": 757,

66411

"description": "Array of errors that have occurred during this transaction, if any.",

66412

"since": "3.5.0",

66413

"itemtype": "property",

66414

"name": "{Object} errors.request Request object related to the error.",

66415

"type": "Object[]",

66416

"class": "Get.Transaction",

66417

"module": "get"

66418

},

66419

{

66420

"file": "get/js/get.js",

66421

"line": 766,

66422

"description": "Numeric id for this transaction, unique among all transactions within the same\nYUI sandbox in the current pageview.",

66423

"itemtype": "property",

66424

"name": "id",

66425

"type": "Number",

66426

"since": "3.5.0",

66427

"class": "Get.Transaction",

66428

"module": "get"

66429

},

66430

{

66431

"file": "get/js/get.js",

66432

"line": 774,

66433

"description": "HTMLElement nodes (native ones, not YUI Node instances) that have been inserted\nduring the current transaction.",

66434

"itemtype": "property",

66435

"name": "nodes",

66436

"type": "HTMLElement[]",

66437

"class": "Get.Transaction",

66438

"module": "get"

66439

},

66440

{

66441

"file": "get/js/get.js",

66442

"line": 781,

66443

"description": "Options associated with this transaction.\n\nSee `Get.options` for the full list of available options.",

66444

"itemtype": "property",

66445

"name": "options",

66446

"type": "Object",

66447

"since": "3.5.0",

66448

"class": "Get.Transaction",

66449

"module": "get"

66450

},

66451

{

66452

"file": "get/js/get.js",

66453

"line": 790,

66454

"description": "Request objects contained in this transaction. Each request object represents\none CSS or JS URL that will be (or has been) requested and loaded into the page.",

66455

"itemtype": "property",

66456

"name": "requests",

66457

"type": "Object",

66458

"since": "3.5.0",

66459

"class": "Get.Transaction",

66460

"module": "get"

66461

},

66462

{

66463

"file": "get/js/get.js",

66464

"line": 798,

66465

"description": "Id of the most recent transaction.",

66466

"itemtype": "property",

66467

"name": "_lastId",

66468

"type": "Number",

66469

"access": "protected",

66470

"tagname": "",

66471

"static": 1,

66472

"class": "Get.Transaction",

66473

"module": "get"

66474

},

66475

{

66476

"file": "get/js/get.js",

66477

"line": 811,

66478

"description": "Current state of this transaction. One of \"new\", \"executing\", or \"done\".",

66479

"itemtype": "property",

66480

"name": "_state",

66481

"type": "String",

66482

"access": "protected",

66483

"tagname": "",

66484

"class": "Get.Transaction",

66485

"module": "get"

66486

},

66487

{

66488

"file": "get/js/get.js",

66489

"line": 822,

66490

"description": "Aborts this transaction.\n\nThis will cause the transaction's `onFailure` callback to be called and\nwill prevent any new script and link nodes from being added to the document,\nbut any resources that have already been requested will continue loading\n(there's no safe way to prevent this, unfortunately).",

66491

"itemtype": "method",

66492

"name": "abort",

66493

"params": [

66494

{

66495

"name": "msg",

66496

"description": "Optional message to use in the `errors`\n array describing why the transaction was aborted.",

66497

"type": "String",

66498

"optional": true,

66499

"optdefault": "\"Aborted.\""

66500

}

66501

],

66502

"class": "Get.Transaction",

66503

"module": "get"

66504

},

66505

{

66506

"file": "get/js/get.js",

66507

"line": 845,

66508

"description": "Begins execting the transaction.\n\nThere's usually no reason to call this manually, since Get will call it\nautomatically when other pending transactions have finished. If you really\nwant to execute your transaction before Get does, you can, but be aware that\nthis transaction's scripts may end up executing before the scripts in other\npending transactions.\n\nIf the transaction is already executing, the specified callback (if any)\nwill be queued and called after execution finishes. If the transaction has\nalready finished, the callback will be called immediately (the transaction\nwill not be executed again).",

66509

"itemtype": "method",

66510

"name": "execute",

66511

"params": [

66512

{

66513

"name": "callback",

66514

"description": "Callback function to execute after all requests\n in the transaction are complete, or after the transaction is aborted.",

66515

"type": "Function"

66516

}

66517

],

66518

"class": "Get.Transaction",

66519

"module": "get"

66520

},

66521

{

66522

"file": "get/js/get.js",

66523

"line": 903,

66524

"description": "Manually purges any `<script>` or `<link>` nodes this transaction has\ncreated.\n\nBe careful when purging a transaction that contains CSS requests, since\nremoving `<link>` nodes will also remove any styles they applied.",

66525

"itemtype": "method",

66526

"name": "purge",

66527

"class": "Get.Transaction",

66528

"module": "get"

66529

},

66530

{

66531

"file": "graphics/js/CanvasCircle.js",

66532

"line": 20,

66533

"description": "Indicates the type of shape",

66534

"itemtype": "property",

66535

"name": "_type",

66536

"type": "String",

66537

"access": "private",

66538

"tagname": "",

66539

"class": "CanvasCircle",

66540

"module": "graphics"

66541

},

66542

{

66543

"file": "graphics/js/CanvasCircle.js",

66544

"line": 29,

66545

"description": "Draws the shape.",

66546

"itemtype": "method",

66547

"name": "_draw",

66548

"access": "private",

66549

"tagname": "",

66550

"class": "CanvasCircle",

66551

"module": "graphics"

66552

},

66553

{

66554

"file": "graphics/js/CanvasCircle.js",

66555

"line": 48,

66556

"description": "Indicates the width of the shape",

66557

"itemtype": "config",

66558

"name": "width",

66559

"type": "Number",

66560

"class": "CanvasCircle",

66561

"module": "graphics"

66562

},

66563

{

66564

"file": "graphics/js/CanvasCircle.js",

66565

"line": 67,

66566

"description": "Indicates the height of the shape",

66567

"itemtype": "config",

66568

"name": "height",

66569

"type": "Number",

66570

"class": "CanvasCircle",

66571

"module": "graphics"

66572

},

66573

{

66574

"file": "graphics/js/CanvasCircle.js",

66575

"line": 86,

66576

"description": "Radius of the circle",

66577

"itemtype": "config",

66578

"name": "radius",

66579

"type": "Number",

66580

"class": "CanvasCircle",

66581

"module": "graphics"

66582

},

66583

{

66584

"file": "graphics/js/CanvasDrawing.js",

66585

"line": 35,

66586

"description": "Parses hex color string and alpha value to rgba",

66587

"itemtype": "method",

66588

"name": "_toRGBA",

66589

"params": [

66590

{

66591

"name": "val",

66592

"description": "Color value to parse. Can be hex string, rgb or name.",

66593

"type": "Object"

66594

},

66595

{

66596

"name": "alpha",

66597

"description": "Numeric value between 0 and 1 representing the alpha level.",

66598

"type": "Number"

66599

}

66600

],

66601

"access": "private",

66602

"tagname": "",

66603

"class": "CanvasDrawing",

66604

"module": "graphics"

66605

},

66606

{

66607

"file": "graphics/js/CanvasDrawing.js",

66608

"line": 59,

66609

"description": "Converts color to rgb format",

66610

"itemtype": "method",

66611

"name": "_toRGB",

66612

"params": [

66613

{

66614

"name": "val",

66615

"description": "Color value to convert."

66616

}

66617

],

66618

"access": "private",

66619

"tagname": "",

66620

"class": "CanvasDrawing",

66621

"module": "graphics"

66622

},

66623

{

66624

"file": "graphics/js/CanvasDrawing.js",

66625

"line": 70,

66626

"description": "Sets the size of the graphics object.",

66627

"itemtype": "method",

66628

"name": "setSize",

66629

"params": [

66630

{

66631

"name": "w",

66632

"description": "width to set for the instance.",

66633

"type": "Number"

66634

},

66635

{

66636

"name": "h",

66637

"description": "height to set for the instance.",

66638

"type": "Number"

66639

}

66640

],

66641

"access": "private",

66642

"tagname": "",

66643

"class": "CanvasDrawing",

66644

"module": "graphics"

66645

},

66646

{

66647

"file": "graphics/js/CanvasDrawing.js",

66648

"line": 94,

66649

"description": "Tracks coordinates. Used to calculate the start point of dashed lines.",

66650

"itemtype": "method",

66651

"name": "_updateCoords",

66652

"params": [

66653

{

66654

"name": "x",

66655

"description": "x-coordinate",

66656

"type": "Number"

66657

},

66658

{

66659

"name": "y",

66660

"description": "y-coordinate",

66661

"type": "Number"

66662

}

66663

],

66664

"access": "private",

66665

"tagname": "",

66666

"class": "CanvasDrawing",

66667

"module": "graphics"

66668

},

66669

{

66670

"file": "graphics/js/CanvasDrawing.js",

66671

"line": 108,

66672

"description": "Clears the coordinate arrays. Called at the end of a drawing operation.",

66673

"itemtype": "method",

66674

"name": "_clearAndUpdateCoords",

66675

"access": "private",

66676

"tagname": "",

66677

"class": "CanvasDrawing",

66678

"module": "graphics"

66679

},

66680

{

66681

"file": "graphics/js/CanvasDrawing.js",

66682

"line": 121,

66683

"description": "Moves the shape's dom node.",

66684

"itemtype": "method",

66685

"name": "_updateNodePosition",

66686

"access": "private",

66687

"tagname": "",

66688

"class": "CanvasDrawing",

66689

"module": "graphics"

66690

},

66691

{

66692

"file": "graphics/js/CanvasDrawing.js",

66693

"line": 137,

66694

"description": "Queues up a method to be executed when a shape redraws.",

66695

"itemtype": "method",

66696

"name": "_updateDrawingQueue",

66697

"params": [

66698

{

66699

"name": "val",

66700

"description": "An array containing data that can be parsed into a method and arguments. The value at zero-index of the array is a string reference of\nthe drawing method that will be called. All subsequent indices are argument for that method. For example, `lineTo(10, 100)` would be structured as:\n`[\"lineTo\", 10, 100]`.",

66701

"type": "Array"

66702

}

66703

],

66704

"access": "private",

66705

"tagname": "",

66706

"class": "CanvasDrawing",

66707

"module": "graphics"

66708

},

66709

{

66710

"file": "graphics/js/CanvasDrawing.js",

66711

"line": 151,

66712

"description": "Draws a line segment using the current line style from the current drawing position to the specified x and y coordinates.",

66713

"itemtype": "method",

66714

"name": "lineTo",

66715

"params": [

66716

{

66717

"name": "point1",

66718

"description": "x-coordinate for the end point.",

66719

"type": "Number"

66720

},

66721

{

66722

"name": "point2",

66723

"description": "y-coordinate for the end point.",

66724

"type": "Number"

66725

}

66726

],

66727

"class": "CanvasDrawing",

66728

"module": "graphics"

66729

},

66730

{

66731

"file": "graphics/js/CanvasDrawing.js",

66732

"line": 192,

66733

"description": "Moves the current drawing position to specified x and y coordinates.",

66734

"itemtype": "method",

66735

"name": "moveTo",

66736

"params": [

66737

{

66738

"name": "x",

66739

"description": "x-coordinate for the end point.",

66740

"type": "Number"

66741

},

66742

{

66743

"name": "y",

66744

"description": "y-coordinate for the end point.",

66745

"type": "Number"

66746

}

66747

],

66748

"class": "CanvasDrawing",

66749

"module": "graphics"

66750

},

66751

{

66752

"file": "graphics/js/CanvasDrawing.js",

66753

"line": 209,

66754

"description": "Draws a bezier curve.",

66755

"itemtype": "method",

66756

"name": "curveTo",

66757

"params": [

66758

{

66759

"name": "cp1x",

66760

"description": "x-coordinate for the first control point.",

66761

"type": "Number"

66762

},

66763

{

66764

"name": "cp1y",

66765

"description": "y-coordinate for the first control point.",

66766

"type": "Number"

66767

},

66768

{

66769

"name": "cp2x",

66770

"description": "x-coordinate for the second control point.",

66771

"type": "Number"

66772

},

66773

{

66774

"name": "cp2y",

66775

"description": "y-coordinate for the second control point.",

66776

"type": "Number"

66777

},

66778

{

66779

"name": "x",

66780

"description": "x-coordinate for the end point.",

66781

"type": "Number"

66782

},

66783

{

66784

"name": "y",

66785

"description": "y-coordinate for the end point.",

66786

"type": "Number"

66787

}

66788

],

66789

"class": "CanvasDrawing",

66790

"module": "graphics"

66791

},

66792

{

66793

"file": "graphics/js/CanvasDrawing.js",

66794

"line": 237,

66795

"description": "Draws a quadratic bezier curve.",

66796

"itemtype": "method",

66797

"name": "quadraticCurveTo",

66798

"params": [

66799

{

66800

"name": "cpx",

66801

"description": "x-coordinate for the control point.",

66802

"type": "Number"

66803

},

66804

{

66805

"name": "cpy",

66806

"description": "y-coordinate for the control point.",

66807

"type": "Number"

66808

},

66809

{

66810

"name": "x",

66811

"description": "x-coordinate for the end point.",

66812

"type": "Number"

66813

},

66814

{

66815

"name": "y",

66816

"description": "y-coordinate for the end point.",

66817

"type": "Number"

66818

}

66819

],

66820

"class": "CanvasDrawing",

66821

"module": "graphics"

66822

},

66823

{

66824

"file": "graphics/js/CanvasDrawing.js",

66825

"line": 264,

66826

"description": "Draws a circle. Used internally by `CanvasCircle` class.",

66827

"itemtype": "method",

66828

"name": "drawCircle",

66829

"params": [

66830

{

66831

"name": "x",

66832

"description": "y-coordinate",

66833

"type": "Number"

66834

},

66835

{

66836

"name": "y",

66837

"description": "x-coordinate",

66838

"type": "Number"

66839

},

66840

{

66841

"name": "r",

66842

"description": "radius",

66843

"type": "Number"

66844

}

66845

],

66846

"access": "protected",

66847

"tagname": "",

66848

"class": "CanvasDrawing",

66849

"module": "graphics"

66850

},

66851

{

66852

"file": "graphics/js/CanvasDrawing.js",

66853

"line": 287,

66854

"description": "Draws a diamond.",

66855

"itemtype": "method",

66856

"name": "drawDiamond",

66857

"params": [

66858

{

66859

"name": "x",

66860

"description": "y-coordinate",

66861

"type": "Number"

66862

},

66863

{

66864

"name": "y",

66865

"description": "x-coordinate",

66866

"type": "Number"

66867

},

66868

{

66869

"name": "width",

66870

"description": "width",

66871

"type": "Number"

66872

},

66873

{

66874

"name": "height",

66875

"description": "height",

66876

"type": "Number"

66877

}

66878

],

66879

"access": "protected",

66880

"tagname": "",

66881

"class": "CanvasDrawing",

66882

"module": "graphics"

66883

},

66884

{

66885

"file": "graphics/js/CanvasDrawing.js",

66886

"line": 309,

66887

"description": "Draws an ellipse. Used internally by `CanvasEllipse` class.",

66888

"itemtype": "method",

66889

"name": "drawEllipse",

66890

"params": [

66891

{

66892

"name": "x",

66893

"description": "x-coordinate",

66894

"type": "Number"

66895

},

66896

{

66897

"name": "y",

66898

"description": "y-coordinate",

66899

"type": "Number"

66900

},

66901

{

66902

"name": "w",

66903

"description": "width",

66904

"type": "Number"

66905

},

66906

{

66907

"name": "h",

66908

"description": "height",

66909

"type": "Number"

66910

}

66911

],

66912

"access": "protected",

66913

"tagname": "",

66914

"class": "CanvasDrawing",

66915

"module": "graphics"

66916

},

66917

{

66918

"file": "graphics/js/CanvasDrawing.js",

66919

"line": 351,

66920

"description": "Draws a rectangle.",

66921

"itemtype": "method",

66922

"name": "drawRect",

66923

"params": [

66924

{

66925

"name": "x",

66926

"description": "x-coordinate",

66927

"type": "Number"

66928

},

66929

{

66930

"name": "y",

66931

"description": "y-coordinate",

66932

"type": "Number"

66933

},

66934

{

66935

"name": "w",

66936

"description": "width",

66937

"type": "Number"

66938

},

66939

{

66940

"name": "h",

66941

"description": "height",

66942

"type": "Number"

66943

}

66944

],

66945

"class": "CanvasDrawing",

66946

"module": "graphics"

66947

},

66948

{

66949

"file": "graphics/js/CanvasDrawing.js",

66950

"line": 373,

66951

"description": "Draws a rectangle with rounded corners.",

66952

"itemtype": "method",

66953

"name": "drawRect",

66954

"params": [

66955

{

66956

"name": "x",

66957

"description": "x-coordinate",

66958

"type": "Number"

66959

},

66960

{

66961

"name": "y",

66962

"description": "y-coordinate",

66963

"type": "Number"

66964

},

66965

{

66966

"name": "w",

66967

"description": "width",

66968

"type": "Number"

66969

},

66970

{

66971

"name": "h",

66972

"description": "height",

66973

"type": "Number"

66974

},

66975

{

66976

"name": "ew",

66977

"description": "width of the ellipse used to draw the rounded corners",

66978

"type": "Number"

66979

},

66980

{

66981

"name": "eh",

66982

"description": "height of the ellipse used to draw the rounded corners",

66983

"type": "Number"

66984

}

66985

],

66986

"class": "CanvasDrawing",

66987

"module": "graphics"

66988

},

66989

{

66990

"file": "graphics/js/CanvasDrawing.js",

66991

"line": 402,

66992

"description": "Draws a wedge.",

66993

"itemtype": "method",

66994

"name": "drawWedge",

66995

"params": [

66996

{

66997

"name": "x",

66998

"description": "x-coordinate of the wedge's center point",

66999

"type": "Number"

67000

},

67001

{

67002

"name": "y",

67003

"description": "y-coordinate of the wedge's center point",

67004

"type": "Number"

67005

},

67006

{

67007

"name": "startAngle",

67008

"description": "starting angle in degrees",

67009

"type": "Number"

67010

},

67011

{

67012

"name": "arc",

67013

"description": "sweep of the wedge. Negative values draw clockwise.",

67014

"type": "Number"

67015

},

67016

{

67017

"name": "radius",

67018

"description": "radius of wedge. If [optional] yRadius is defined, then radius is the x radius.",

67019

"type": "Number"

67020

},

67021

{

67022

"name": "yRadius",

67023

"description": "[optional] y radius for wedge.",

67024

"type": "Number"

67025

}

67026

],

67027

"access": "private",

67028

"tagname": "",

67029

"class": "CanvasDrawing",

67030

"module": "graphics"

67031

},

67032

{

67033

"file": "graphics/js/CanvasDrawing.js",

67034

"line": 482,

67035

"description": "Completes a drawing operation.",

67036

"itemtype": "method",

67037

"name": "end",

67038

"class": "CanvasDrawing",

67039

"module": "graphics"

67040

},

67041

{

67042

"file": "graphics/js/CanvasDrawing.js",

67043

"line": 492,

67044

"description": "Ends a fill and stroke",

67045

"itemtype": "method",

67046

"name": "closePath",

67047

"class": "CanvasDrawing",

67048

"module": "graphics"

67049

},

67050

{

67051

"file": "graphics/js/CanvasDrawing.js",

67052

"line": 503,

67053

"description": "Clears the graphics object.",

67054

"itemtype": "method",

67055

"name": "clear",

67056

"class": "CanvasDrawing",

67057

"module": "graphics"

67058

},

67059

{

67060

"file": "graphics/js/CanvasDrawing.js",

67061

"line": 509,

67062

"description": "Returns a linear gradient fill",

67063

"itemtype": "method",

67064

"name": "_getLinearGradient",

67065

"return": {

67066

"description": "CanvasGradient"

67067

},

67068

"access": "private",

67069

"tagname": "",

67070

"class": "CanvasDrawing",

67071

"module": "graphics"

67072

},

67073

{

67074

"file": "graphics/js/CanvasDrawing.js",

67075

"line": 589,

67076

"description": "Returns a radial gradient fill",

67077

"itemtype": "method",

67078

"name": "_getRadialGradient",

67079

"return": {

67080

"description": "CanvasGradient"

67081

},

67082

"access": "private",

67083

"tagname": "",

67084

"class": "CanvasDrawing",

67085

"module": "graphics"

67086

},

67087

{

67088

"file": "graphics/js/CanvasDrawing.js",

67089

"line": 681,

67090

"description": "Clears all values",

67091

"itemtype": "method",

67092

"name": "_initProps",

67093

"access": "private",

67094

"tagname": "",

67095

"class": "CanvasDrawing",

67096

"module": "graphics"

67097

},

67098

{

67099

"file": "graphics/js/CanvasDrawing.js",

67100

"line": 700,

67101

"description": "Indicates a drawing has completed.",

67102

"itemtype": "property",

67103

"name": "_drawingComplete",

67104

"type": "Boolean",

67105

"access": "private",

67106

"tagname": "",

67107

"class": "CanvasDrawing",

67108

"module": "graphics"

67109

},

67110

{

67111

"file": "graphics/js/CanvasDrawing.js",

67112

"line": 709,

67113

"description": "Creates canvas element",

67114

"itemtype": "method",

67115

"name": "_createGraphic",

67116

"return": {

67117

"description": "HTMLCanvasElement"

67118

},

67119

"access": "private",

67120

"tagname": "",

67121

"class": "CanvasDrawing",

67122

"module": "graphics"

67123

},

67124

{

67125

"file": "graphics/js/CanvasDrawing.js",

67126

"line": 721,

67127

"description": "Updates the size of the graphics object",

67128

"itemtype": "method",

67129

"name": "_trackSize",

67130

"params": [

67131

{

67132

"name": "w",

67133

"description": "width",

67134

"type": "Number"

67135

},

67136

{

67137

"name": "h",

67138

"description": "height",

67139

"type": "Number"

67140

}

67141

],

67142

"access": "private",

67143

"tagname": "",

67144

"class": "CanvasDrawing",

67145

"module": "graphics"

67146

},

67147

{

67148

"file": "graphics/js/CanvasEllipse.js",

67149

"line": 20,

67150

"description": "Indicates the type of shape",

67151

"itemtype": "property",

67152

"name": "_type",

67153

"type": "String",

67154

"access": "private",

67155

"tagname": "",

67156

"class": "CanvasEllipse",

67157

"module": "graphics"

67158

},

67159

{

67160

"file": "graphics/js/CanvasEllipse.js",

67161

"line": 29,

67162

"description": "Draws the shape.",

67163

"itemtype": "method",

67164

"name": "_draw",

67165

"access": "private",

67166

"tagname": "",

67167

"class": "CanvasEllipse",

67168

"module": "graphics"

67169

},

67170

{

67171

"file": "graphics/js/CanvasGraphic.js",

67172

"line": 20,

67173

"description": "Whether or not to render the `Graphic` automatically after to a specified parent node after init. This can be a Node instance or a CSS selector string.",

67174

"itemtype": "config",

67175

"name": "render",

67176

"type": "Node | String",

67177

"class": "CanvasGraphic",

67178

"module": "graphics"

67179

},

67180

{

67181

"file": "graphics/js/CanvasGraphic.js",

67182

"line": 28,

67183

"description": "Unique id for class instance.",

67184

"itemtype": "config",

67185

"name": "id",

67186

"type": "String",

67187

"class": "CanvasGraphic",

67188

"module": "graphics"

67189

},

67190

{

67191

"file": "graphics/js/CanvasGraphic.js",

67192

"line": 51,

67193

"description": "Key value pairs in which a shape instance is associated with its id.",

67194

"itemtype": "config",

67195

"name": "shapes",

67196

"type": "Object",

67197

"readonly": "",

67198

"class": "CanvasGraphic",

67199

"module": "graphics"

67200

},

67201

{

67202

"file": "graphics/js/CanvasGraphic.js",

67203

"line": 67,

67204

"description": "Object containing size and coordinate data for the content of a Graphic in relation to the graphic instance's position.",

67205

"itemtype": "config",

67206

"name": "contentBounds",

67207

"type": "Object",

67208

"readonly": "",

67209

"class": "CanvasGraphic",

67210

"module": "graphics"

67211

},

67212

{

67213

"file": "graphics/js/CanvasGraphic.js",

67214

"line": 83,

67215

"description": "The outermost html element of the Graphic instance.",

67216

"itemtype": "config",

67217

"name": "node",

67218

"type": "HTMLElement",

67219

"readonly": "",

67220

"class": "CanvasGraphic",

67221

"module": "graphics"

67222

},

67223

{

67224

"file": "graphics/js/CanvasGraphic.js",

67225

"line": 99,

67226

"description": "Indicates the width of the `Graphic`.",

67227

"itemtype": "config",

67228

"name": "width",

67229

"type": "Number",

67230

"class": "CanvasGraphic",

67231

"module": "graphics"

67232

},

67233

{

67234

"file": "graphics/js/CanvasGraphic.js",

67235

"line": 116,

67236

"description": "Indicates the height of the `Graphic`.",

67237

"itemtype": "config",

67238

"name": "height",

67239

"type": "Number",

67240

"class": "CanvasGraphic",

67241

"module": "graphics"

67242

},

67243

{

67244

"file": "graphics/js/CanvasGraphic.js",

67245

"line": 133,

67246

"description": "Determines how the size of instance is calculated. If true, the width and height are determined by the size of the contents.\nIf false, the width and height values are either explicitly set or determined by the size of the parent node's dimensions.",

67247

"itemtype": "config",

67248

"name": "autoSize",

67249

"type": "Boolean",

67250

"default": "false",

67251

"class": "CanvasGraphic",

67252

"module": "graphics"

67253

},

67254

{

67255

"file": "graphics/js/CanvasGraphic.js",

67256

"line": 145,

67257

"description": "The contentBounds will resize to greater values but not smaller values. (for performance)\nWhen resizing the contentBounds down is desirable, set the resizeDown value to true.",

67258

"itemtype": "config",

67259

"name": "resizeDown",

67260

"type": "Boolean",

67261

"class": "CanvasGraphic",

67262

"module": "graphics"

67263

},

67264

{

67265

"file": "graphics/js/CanvasGraphic.js",

67266

"line": 169,

67267

"description": "Indicates the x-coordinate for the instance.",

67268

"itemtype": "config",

67269

"name": "x",

67270

"type": "Number",

67271

"class": "CanvasGraphic",

67272

"module": "graphics"

67273

},

67274

{

67275

"file": "graphics/js/CanvasGraphic.js",

67276

"line": 192,

67277

"description": "Indicates the y-coordinate for the instance.",

67278

"itemtype": "config",

67279

"name": "y",

67280

"type": "Number",

67281

"class": "CanvasGraphic",

67282

"module": "graphics"

67283

},

67284

{

67285

"file": "graphics/js/CanvasGraphic.js",

67286

"line": 215,

67287

"description": "Indicates whether or not the instance will automatically redraw after a change is made to a shape.\nThis property will get set to false when batching operations.",

67288

"itemtype": "config",

67289

"name": "autoDraw",

67290

"type": "Boolean",

67291

"default": "true",

67292

"access": "private",

67293

"tagname": "",

67294

"class": "CanvasGraphic",

67295

"module": "graphics"

67296

},

67297

{

67298

"file": "graphics/js/CanvasGraphic.js",

67299

"line": 228,

67300

"description": "Indicates whether the `Graphic` and its children are visible.",

67301

"itemtype": "config",

67302

"name": "visible",

67303

"type": "Boolean",

67304

"class": "CanvasGraphic",

67305

"module": "graphics"

67306

},

67307

{

67308

"file": "graphics/js/CanvasGraphic.js",

67309

"line": 246,

67310

"description": "Storage for `x` attribute.",

67311

"itemtype": "property",

67312

"name": "_x",

67313

"type": "Number",

67314

"access": "private",

67315

"tagname": "",

67316

"class": "CanvasGraphic",

67317

"module": "graphics"

67318

},

67319

{

67320

"file": "graphics/js/CanvasGraphic.js",

67321

"line": 255,

67322

"description": "Storage for `y` attribute.",

67323

"itemtype": "property",

67324

"name": "_y",

67325

"type": "Number",

67326

"access": "private",

67327

"tagname": "",

67328

"class": "CanvasGraphic",

67329

"module": "graphics"

67330

},

67331

{

67332

"file": "graphics/js/CanvasGraphic.js",

67333

"line": 264,

67334

"description": "Gets the current position of the graphic instance in page coordinates.",

67335

"itemtype": "method",

67336

"name": "getXY",

67337

"return": {

67338

"description": "Array The XY position of the shape."

67339

},

67340

"class": "CanvasGraphic",

67341

"module": "graphics"

67342

},

67343

{

67344

"file": "graphics/js/CanvasGraphic.js",

67345

"line": 281,

67346

"description": "Storage for `resizeDown` attribute.",

67347

"itemtype": "property",

67348

"name": "_resizeDown",

67349

"type": "Boolean",

67350

"access": "private",

67351

"tagname": "",

67352

"class": "CanvasGraphic",

67353

"module": "graphics"

67354

},

67355

{

67356

"file": "graphics/js/CanvasGraphic.js",

67357

"line": 290,

67358

"description": "Initializes the class.",

67359

"itemtype": "method",

67360

"name": "initializer",

67361

"params": [

67362

{

67363

"name": "config",

67364

"description": "Optional attributes",

67365

"type": "Object"

67366

}

67367

],

67368

"access": "private",

67369

"tagname": "",

67370

"class": "CanvasGraphic",

67371

"module": "graphics"

67372

},

67373

{

67374

"file": "graphics/js/CanvasGraphic.js",

67375

"line": 319,

67376

"description": "Adds the graphics node to the dom.",

67377

"itemtype": "method",

67378

"name": "render",

67379

"params": [

67380

{

67381

"name": "parentNode",

67382

"description": "node in which to render the graphics node into.",

67383

"type": "HTMLElement"

67384

}

67385

],

67386

"class": "CanvasGraphic",

67387

"module": "graphics"

67388

},

67389

{

67390

"file": "graphics/js/CanvasGraphic.js",

67391

"line": 342,

67392

"description": "Removes all nodes.",

67393

"itemtype": "method",

67394

"name": "destroy",

67395

"class": "CanvasGraphic",

67396

"module": "graphics"

67397

},

67398

{

67399

"file": "graphics/js/CanvasGraphic.js",

67400

"line": 357,

67401

"description": "Generates a shape instance by type.",

67402

"itemtype": "method",

67403

"name": "addShape",

67404

"params": [

67405

{

67406

"name": "cfg",

67407

"description": "attributes for the shape",

67408

"type": "Object"

67409

}

67410

],

67411

"return": {

67412

"description": "Shape"

67413

},

67414

"class": "CanvasGraphic",

67415

"module": "graphics"

67416

},

67417

{

67418

"file": "graphics/js/CanvasGraphic.js",

67419

"line": 373,

67420

"description": "Adds a shape instance to the graphic instance.",

67421

"itemtype": "method",

67422

"name": "_appendShape",

67423

"params": [

67424

{

67425

"name": "shape",

67426

"description": "The shape instance to be added to the graphic.",

67427

"type": "Shape"

67428

}

67429

],

67430

"access": "private",

67431

"tagname": "",

67432

"class": "CanvasGraphic",

67433

"module": "graphics"

67434

},

67435

{

67436

"file": "graphics/js/CanvasGraphic.js",

67437

"line": 394,

67438

"description": "Removes a shape instance from from the graphic instance.",

67439

"itemtype": "method",

67440

"name": "removeShape",

67441

"params": [

67442

{

67443

"name": "shape",

67444

"description": "The instance or id of the shape to be removed.",

67445

"type": "Shape|String"

67446

}

67447

],

67448

"class": "CanvasGraphic",

67449

"module": "graphics"

67450

},

67451

{

67452

"file": "graphics/js/CanvasGraphic.js",

67453

"line": 421,

67454

"description": "Removes all shape instances from the dom.",

67455

"itemtype": "method",

67456

"name": "removeAllShapes",

67457

"class": "CanvasGraphic",

67458

"module": "graphics"

67459

},

67460

{

67461

"file": "graphics/js/CanvasGraphic.js",

67462

"line": 440,

67463

"description": "Removes all child nodes.",

67464

"itemtype": "method",

67465

"name": "_removeChildren",

67466

"params": [

67467

{

67468

"name": "node",

67469

"description": "",

67470

"type": "HTMLElement"

67471

}

67472

],

67473

"access": "private",

67474

"tagname": "",

67475

"class": "CanvasGraphic",

67476

"module": "graphics"

67477

},

67478

{

67479

"file": "graphics/js/CanvasGraphic.js",

67480

"line": 461,

67481

"description": "Toggles visibility",

67482

"itemtype": "method",

67483

"name": "_toggleVisible",

67484

"params": [

67485

{

67486

"name": "val",

67487

"description": "indicates visibilitye",

67488

"type": "Boolean"

67489

}

67490

],

67491

"access": "private",

67492

"tagname": "",

67493

"class": "CanvasGraphic",

67494

"module": "graphics"

67495

},

67496

{

67497

"file": "graphics/js/CanvasGraphic.js",

67498

"line": 486,

67499

"description": "Returns a shape class. Used by `addShape`.",

67500

"itemtype": "method",

67501

"name": "_getShapeClass",

67502

"params": [

67503

{

67504

"name": "val",

67505

"description": "Indicates which shape class.",

67506

"type": "Shape | String"

67507

}

67508

],

67509

"return": {

67510

"description": "Function"

67511

},

67512

"access": "private",

67513

"tagname": "",

67514

"class": "CanvasGraphic",

67515

"module": "graphics"

67516

},

67517

{

67518

"file": "graphics/js/CanvasGraphic.js",

67519

"line": 504,

67520

"description": "Look up for shape classes. Used by `addShape` to retrieve a class for instantiation.",

67521

"itemtype": "property",

67522

"name": "_shapeClass",

67523

"type": "Object",

67524

"access": "private",

67525

"tagname": "",

67526

"class": "CanvasGraphic",

67527

"module": "graphics"

67528

},

67529

{

67530

"file": "graphics/js/CanvasGraphic.js",

67531

"line": 519,

67532

"description": "Returns a shape based on the id of its dom node.",

67533

"itemtype": "method",

67534

"name": "getShapeById",

67535

"params": [

67536

{

67537

"name": "id",

67538

"description": "Dom id of the shape's node attribute.",

67539

"type": "String"

67540

}

67541

],

67542

"return": {

67543

"description": "Shape"

67544

},

67545

"class": "CanvasGraphic",

67546

"module": "graphics"

67547

},

67548

{

67549

"file": "graphics/js/CanvasGraphic.js",

67550

"line": 532,

67551

"description": "Allows for creating multiple shapes in order to batch appending and redraw operations.",

67552

"itemtype": "method",

67553

"name": "batch",

67554

"params": [

67555

{

67556

"name": "method",

67557

"description": "Method to execute.",

67558

"type": "Function"

67559

}

67560

],

67561

"class": "CanvasGraphic",

67562

"module": "graphics"

67563

},

67564

{

67565

"file": "graphics/js/CanvasGraphic.js",

67566

"line": 547,

67567

"description": "Returns a document fragment to for attaching shapes.",

67568

"itemtype": "method",

67569

"name": "_getDocFrag",

67570

"return": {

67571

"description": "DocumentFragment"

67572

},

67573

"access": "private",

67574

"tagname": "",

67575

"class": "CanvasGraphic",

67576

"module": "graphics"

67577

},

67578

{

67579

"file": "graphics/js/CanvasGraphic.js",

67580

"line": 563,

67581

"description": "Redraws all shapes.",

67582

"itemtype": "method",

67583

"name": "_redraw",

67584

"access": "private",

67585

"tagname": "",

67586

"class": "CanvasGraphic",

67587

"module": "graphics"

67588

},

67589

{

67590

"file": "graphics/js/CanvasGraphic.js",

67591

"line": 584,

67592

"description": "Adds a shape to the redraw queue and calculates the contentBounds. Used internally \nby `Shape` instances.",

67593

"itemtype": "method",

67594

"name": "addToRedrawQueue",

67595

"params": [

67596

{

67597

"name": "Shape",

67598

"description": "shape The shape instance to add to the queue"

67599

}

67600

],

67601

"access": "protected",

67602

"tagname": "",

67603

"class": "CanvasGraphic",

67604

"module": "graphics"

67605

},

67606

{

67607

"file": "graphics/js/CanvasGraphic.js",

67608

"line": 615,

67609

"description": "Recalculates and returns the `contentBounds` for the `Graphic` instance.",

67610

"itemtype": "method",

67611

"name": "_getUpdatedContentBounds",

67612

"return": {

67613

"description": "",

67614

"type": "Object"

67615

},

67616

"access": "private",

67617

"tagname": "",

67618

"class": "CanvasGraphic",

67619

"module": "graphics"

67620

},

67621

{

67622

"file": "graphics/js/CanvasPath.js",

67623

"line": 18,

67624

"description": "Indicates the type of shape",

67625

"itemtype": "property",

67626

"name": "_type",

67627

"type": "String",

67628

"access": "private",

67629

"tagname": "",

67630

"class": "CanvasPath",

67631

"module": "graphics"

67632

},

67633

{

67634

"file": "graphics/js/CanvasPath.js",

67635

"line": 27,

67636

"description": "Draws the shape.",

67637

"itemtype": "method",

67638

"name": "_draw",

67639

"access": "private",

67640

"tagname": "",

67641

"class": "CanvasPath",

67642

"module": "graphics"

67643

},

67644

{

67645

"file": "graphics/js/CanvasPath.js",

67646

"line": 38,

67647

"description": "Creates the dom node for the shape.",

67648

"itemtype": "method",

67649

"name": "createNode",

67650

"return": {

67651

"description": "HTMLElement"

67652

},

67653

"access": "private",

67654

"tagname": "",

67655

"class": "CanvasPath",

67656

"module": "graphics"

67657

},

67658

{

67659

"file": "graphics/js/CanvasPath.js",

67660

"line": 60,

67661

"description": "Completes a drawing operation.",

67662

"itemtype": "method",

67663

"name": "end",

67664

"class": "CanvasPath",

67665

"module": "graphics"

67666

},

67667

{

67668

"file": "graphics/js/CanvasPath.js",

67669

"line": 72,

67670

"description": "Indicates the width of the shape",

67671

"itemtype": "config",

67672

"name": "width",

67673

"type": "Number",

67674

"class": "CanvasPath",

67675

"module": "graphics"

67676

},

67677

{

67678

"file": "graphics/js/CanvasPath.js",

67679

"line": 92,

67680

"description": "Indicates the height of the shape",

67681

"itemtype": "config",

67682

"name": "height",

67683

"type": "Number",

67684

"class": "CanvasPath",

67685

"module": "graphics"

67686

},

67687

{

67688

"file": "graphics/js/CanvasPath.js",

67689

"line": 112,

67690

"description": "Indicates the path used for the node.",

67691

"itemtype": "config",

67692

"name": "path",

67693

"type": "String",

67694

"readonly": "",

67695

"class": "CanvasPath",

67696

"module": "graphics"

67697

},

67698

{

67699

"file": "graphics/js/CanvasPieSlice.js",

67700

"line": 14,

67701

"description": "Indicates the type of shape",

67702

"itemtype": "property",

67703

"name": "_type",

67704

"type": "String",

67705

"access": "private",

67706

"tagname": "",

67707

"class": "CanvasPieSlice",

67708

"module": "graphics"

67709

},

67710

{

67711

"file": "graphics/js/CanvasPieSlice.js",

67712

"line": 23,

67713

"description": "Change event listener",

67714

"access": "private",

67715

"tagname": "",

67716

"itemtype": "method",

67717

"name": "_updateHandler",

67718

"class": "CanvasPieSlice",

67719

"module": "graphics"

67720

},

67721

{

67722

"file": "graphics/js/CanvasPieSlice.js",

67723

"line": 53,

67724

"description": "Starting angle in relation to a circle in which to begin the pie slice drawing.",

67725

"itemtype": "config",

67726

"name": "startAngle",

67727

"type": "Number",

67728

"class": "CanvasPieSlice",

67729

"module": "graphics"

67730

},

67731

{

67732

"file": "graphics/js/CanvasPieSlice.js",

67733

"line": 63,

67734

"description": "Arc of the slice.",

67735

"itemtype": "config",

67736

"name": "arc",

67737

"type": "Number",

67738

"class": "CanvasPieSlice",

67739

"module": "graphics"

67740

},

67741

{

67742

"file": "graphics/js/CanvasPieSlice.js",

67743

"line": 73,

67744

"description": "Radius of the circle in which the pie slice is drawn",

67745

"itemtype": "config",

67746

"name": "radius",

67747

"type": "Number",

67748

"class": "CanvasPieSlice",

67749

"module": "graphics"

67750

},

67751

{

67752

"file": "graphics/js/CanvasRect.js",

67753

"line": 18,

67754

"description": "Indicates the type of shape",

67755

"itemtype": "property",

67756

"name": "_type",

67757

"type": "String",

67758

"access": "private",

67759

"tagname": "",

67760

"class": "CanvasRect",

67761

"module": "graphics"

67762

},

67763

{

67764

"file": "graphics/js/CanvasRect.js",

67765

"line": 27,

67766

"description": "Draws the shape.",

67767

"itemtype": "method",

67768

"name": "_draw",

67769

"access": "private",

67770

"tagname": "",

67771

"class": "CanvasRect",

67772

"module": "graphics"

67773

},

67774

{

67775

"file": "graphics/js/CanvasShape.js",

67776

"line": 22,

67777

"description": "Init method, invoked during construction.\nCalls `initializer` method.",

67778

"itemtype": "method",

67779

"name": "init",

67780

"access": "protected",

67781

"tagname": "",

67782

"class": "CanvasShape",

67783

"module": "graphics"

67784

},

67785

{

67786

"file": "graphics/js/CanvasShape.js",

67787

"line": 34,

67788

"description": "Initializes the shape",

67789

"access": "private",

67790

"tagname": "",

67791

"itemtype": "method",

67792

"name": "_initialize",

67793

"class": "CanvasShape",

67794

"module": "graphics"

67795

},

67796

{

67797

"file": "graphics/js/CanvasShape.js",

67798

"line": 55,

67799

"description": "Set the Graphic instance for the shape.",

67800

"itemtype": "method",

67801

"name": "_setGraphic",

67802

"params": [

67803

{

67804

"name": "render",

67805

"description": "This param is used to determine the graphic instance. If it is a `Graphic` instance, it will be assigned\nto the `graphic` attribute. Otherwise, a new Graphic instance will be created and rendered into the dom element that the render represents.",

67806

"type": "Graphic | Node | HTMLElement | String"

67807

}

67808

],

67809

"access": "private",

67810

"tagname": "",

67811

"class": "CanvasShape",

67812

"module": "graphics"

67813

},

67814

{

67815

"file": "graphics/js/CanvasShape.js",

67816

"line": 81,

67817

"description": "Add a class name to each node.",

67818

"itemtype": "method",

67819

"name": "addClass",

67820

"params": [

67821

{

67822

"name": "className",

67823

"description": "the class name to add to the node's class attribute",

67824

"type": "String"

67825

}

67826

],

67827

"class": "CanvasShape",

67828

"module": "graphics"

67829

},

67830

{

67831

"file": "graphics/js/CanvasShape.js",

67832

"line": 93,

67833

"description": "Removes a class name from each node.",

67834

"itemtype": "method",

67835

"name": "removeClass",

67836

"params": [

67837

{

67838

"name": "className",

67839

"description": "the class name to remove from the node's class attribute",

67840

"type": "String"

67841

}

67842

],

67843

"class": "CanvasShape",

67844

"module": "graphics"

67845

},

67846

{

67847

"file": "graphics/js/CanvasShape.js",

67848

"line": 105,

67849

"description": "Gets the current position of the node in page coordinates.",

67850

"itemtype": "method",

67851

"name": "getXY",

67852

"return": {

67853

"description": "Array The XY position of the shape."

67854

},

67855

"class": "CanvasShape",

67856

"module": "graphics"

67857

},

67858

{

67859

"file": "graphics/js/CanvasShape.js",

67860

"line": 120,

67861

"description": "Set the position of the shape in page coordinates, regardless of how the node is positioned.",

67862

"itemtype": "method",

67863

"name": "setXY",

67864

"params": [

67865

{

67866

"name": "Contains",

67867

"description": "X & Y values for new position (coordinates are page-based)",

67868

"type": "Array"

67869

}

67870

],

67871

"class": "CanvasShape",

67872

"module": "graphics"

67873

},

67874

{

67875

"file": "graphics/js/CanvasShape.js",

67876

"line": 137,

67877

"description": "Determines whether the node is an ancestor of another HTML element in the DOM hierarchy.",

67878

"itemtype": "method",

67879

"name": "contains",

67880

"params": [

67881

{

67882

"name": "needle",

67883

"description": "The possible node or descendent",

67884

"type": "CanvasShape | HTMLElement"

67885

}

67886

],

67887

"return": {

67888

"description": "Boolean Whether or not this shape is the needle or its ancestor."

67889

},

67890

"class": "CanvasShape",

67891

"module": "graphics"

67892

},

67893

{

67894

"file": "graphics/js/CanvasShape.js",

67895

"line": 149,

67896

"description": "Test if the supplied node matches the supplied selector.",

67897

"itemtype": "method",

67898

"name": "test",

67899

"params": [

67900

{

67901

"name": "selector",

67902

"description": "The CSS selector to test against.",

67903

"type": "String"

67904

}

67905

],

67906

"return": {

67907

"description": "Boolean Wheter or not the shape matches the selector."

67908

},

67909

"class": "CanvasShape",

67910

"module": "graphics"

67911

},

67912

{

67913

"file": "graphics/js/CanvasShape.js",

67914

"line": 162,

67915

"description": "Compares nodes to determine if they match.\nNode instances can be compared to each other and/or HTMLElements.",

67916

"itemtype": "method",

67917

"name": "compareTo",

67918

"params": [

67919

{

67920

"name": "refNode",

67921

"description": "The reference node to compare to the node.",

67922

"type": "HTMLElement | Node"

67923

}

67924

],

67925

"return": {

67926

"description": "True if the nodes match, false if they do not.",

67927

"type": "Boolean"

67928

},

67929

"class": "CanvasShape",

67930

"module": "graphics"

67931

},

67932

{

67933

"file": "graphics/js/CanvasShape.js",

67934

"line": 174,

67935

"description": "Value function for fill attribute",

67936

"itemtype": "method",

67937

"name": "_getDefaultFill",

67938

"return": {

67939

"description": "Object"

67940

},

67941

"access": "private",

67942

"tagname": "",

67943

"class": "CanvasShape",

67944

"module": "graphics"

67945

},

67946

{

67947

"file": "graphics/js/CanvasShape.js",

67948

"line": 192,

67949

"description": "Value function for stroke attribute",

67950

"itemtype": "method",

67951

"name": "_getDefaultStroke",

67952

"return": {

67953

"description": "Object"

67954

},

67955

"access": "private",

67956

"tagname": "",

67957

"class": "CanvasShape",

67958

"module": "graphics"

67959

},

67960

{

67961

"file": "graphics/js/CanvasShape.js",

67962

"line": 209,

67963

"description": "Left edge of the path",

67964

"itemtype": "property",

67965

"name": "_left",

67966

"type": "Number",

67967

"access": "private",

67968

"tagname": "",

67969

"class": "CanvasShape",

67970

"module": "graphics"

67971

},

67972

{

67973

"file": "graphics/js/CanvasShape.js",

67974

"line": 218,

67975

"description": "Right edge of the path",

67976

"itemtype": "property",

67977

"name": "_right",

67978

"type": "Number",

67979

"access": "private",

67980

"tagname": "",

67981

"class": "CanvasShape",

67982

"module": "graphics"

67983

},

67984

{

67985

"file": "graphics/js/CanvasShape.js",

67986

"line": 227,

67987

"description": "Top edge of the path",

67988

"itemtype": "property",

67989

"name": "_top",

67990

"type": "Number",

67991

"access": "private",

67992

"tagname": "",

67993

"class": "CanvasShape",

67994

"module": "graphics"

67995

},

67996

{

67997

"file": "graphics/js/CanvasShape.js",

67998

"line": 236,

67999

"description": "Bottom edge of the path",

68000

"itemtype": "property",

68001

"name": "_bottom",

68002

"type": "Number",

68003

"access": "private",

68004

"tagname": "",

68005

"class": "CanvasShape",

68006

"module": "graphics"

68007

},

68008

{

68009

"file": "graphics/js/CanvasShape.js",

68010

"line": 245,

68011

"description": "Creates the dom node for the shape.",

68012

"itemtype": "method",

68013

"name": "createNode",

68014

"return": {

68015

"description": "HTMLElement"

68016

},

68017

"access": "private",

68018

"tagname": "",

68019

"class": "CanvasShape",

68020

"module": "graphics"

68021

},

68022

{

68023

"file": "graphics/js/CanvasShape.js",

68024

"line": 269,

68025

"description": "Overrides default `on` method. Checks to see if its a dom interaction event. If so, \nreturn an event attached to the `node` element. If not, return the normal functionality.",

68026

"itemtype": "method",

68027

"name": "on",

68028

"params": [

68029

{

68030

"name": "type",

68031

"description": "event type",

68032

"type": "String"

68033

},

68034

{

68035

"name": "callback",

68036

"description": "function",

68037

"type": "Object"

68038

}

68039

],

68040

"access": "private",

68041

"tagname": "",

68042

"class": "CanvasShape",

68043

"module": "graphics"

68044

},

68045

{

68046

"file": "graphics/js/CanvasShape.js",

68047

"line": 287,

68048

"description": "Adds a stroke to the shape node.",

68049

"itemtype": "method",

68050

"name": "_strokeChangeHandler",

68051

"params": [

68052

{

68053

"name": "stroke",

68054

"description": "Properties of the `stroke` attribute.",

68055

"type": "Object"

68056

}

68057

],

68058

"access": "private",

68059

"tagname": "",

68060

"class": "CanvasShape",

68061

"module": "graphics"

68062

},

68063

{

68064

"file": "graphics/js/CanvasShape.js",

68065

"line": 337,

68066

"description": "Sets the value of an attribute.",

68067

"itemtype": "method",

68068

"name": "set",

68069

"params": [

68070

{

68071

"name": "name",

68072

"description": "The name of the attribute. Alternatively, an object of key value pairs can \nbe passed in to set multiple attributes at once.",

68073

"type": "String|Object"

68074

},

68075

{

68076

"name": "value",

68077

"description": "The value to set the attribute to. This value is ignored if an object is received as \nthe name param.",

68078

"type": "Any"

68079

}

68080

],

68081

"class": "CanvasShape",

68082

"module": "graphics"

68083

},

68084

{

68085

"file": "graphics/js/CanvasShape.js",

68086

"line": 357,

68087

"description": "Adds a fill to the shape node.",

68088

"itemtype": "method",

68089

"name": "_setFillProps",

68090

"params": [

68091

{

68092

"name": "fill",

68093

"description": "Properties of the `fill` attribute.",

68094

"type": "Object"

68095

}

68096

],

68097

"access": "private",

68098

"tagname": "",

68099

"class": "CanvasShape",

68100

"module": "graphics"

68101

},

68102

{

68103

"file": "graphics/js/CanvasShape.js",

68104

"line": 396,

68105

"description": "Specifies a 2d translation.",

68106

"itemtype": "method",

68107

"name": "translate",

68108

"params": [

68109

{

68110

"name": "x",

68111

"description": "The value to transate on the x-axis.",

68112

"type": "Number"

68113

},

68114

{

68115

"name": "y",

68116

"description": "The value to translate on the y-axis.",

68117

"type": "Number"

68118

}

68119

],

68120

"class": "CanvasShape",

68121

"module": "graphics"

68122

},

68123

{

68124

"file": "graphics/js/CanvasShape.js",

68125

"line": 410,

68126

"description": "Translates the shape along the x-axis. When translating x and y coordinates,\nuse the `translate` method.",

68127

"itemtype": "method",

68128

"name": "translateX",

68129

"params": [

68130

{

68131

"name": "x",

68132

"description": "The value to translate.",

68133

"type": "Number"

68134

}

68135

],

68136

"class": "CanvasShape",

68137

"module": "graphics"

68138

},

68139

{

68140

"file": "graphics/js/CanvasShape.js",

68141

"line": 423,

68142

"description": "Performs a translate on the y-coordinate. When translating x and y coordinates,\nuse the `translate` method.",

68143

"itemtype": "method",

68144

"name": "translateY",

68145

"params": [

68146

{

68147

"name": "y",

68148

"description": "The value to translate.",

68149

"type": "Number"

68150

}

68151

],

68152

"class": "CanvasShape",

68153

"module": "graphics"

68154

},

68155

{

68156

"file": "graphics/js/CanvasShape.js",

68157

"line": 436,

68158

"description": "Skews the shape around the x-axis and y-axis.",

68159

"itemtype": "method",

68160

"name": "skew",

68161

"params": [

68162

{

68163

"name": "x",

68164

"description": "The value to skew on the x-axis.",

68165

"type": "Number"

68166

},

68167

{

68168

"name": "y",

68169

"description": "The value to skew on the y-axis.",

68170

"type": "Number"

68171

}

68172

],

68173

"class": "CanvasShape",

68174

"module": "graphics"

68175

},

68176

{

68177

"file": "graphics/js/CanvasShape.js",

68178

"line": 448,

68179

"description": "Skews the shape around the x-axis.",

68180

"itemtype": "method",

68181

"name": "skewX",

68182

"params": [

68183

{

68184

"name": "x",

68185

"description": "x-coordinate",

68186

"type": "Number"

68187

}

68188

],

68189

"class": "CanvasShape",

68190

"module": "graphics"

68191

},

68192

{

68193

"file": "graphics/js/CanvasShape.js",

68194

"line": 459,

68195

"description": "Skews the shape around the y-axis.",

68196

"itemtype": "method",

68197

"name": "skewY",

68198

"params": [

68199

{

68200

"name": "y",

68201

"description": "y-coordinate",

68202

"type": "Number"

68203

}

68204

],

68205

"class": "CanvasShape",

68206

"module": "graphics"

68207

},

68208

{

68209

"file": "graphics/js/CanvasShape.js",

68210

"line": 470,

68211

"description": "Rotates the shape clockwise around it transformOrigin.",

68212

"itemtype": "method",

68213

"name": "rotate",

68214

"params": [

68215

{

68216

"name": "deg",

68217

"description": "The degree of the rotation.",

68218

"type": "Number"

68219

}

68220

],

68221

"class": "CanvasShape",

68222

"module": "graphics"

68223

},

68224

{

68225

"file": "graphics/js/CanvasShape.js",

68226

"line": 482,

68227

"description": "Specifies a 2d scaling operation.",

68228

"itemtype": "method",

68229

"name": "scale",

68230

"params": [

68231

{

68232

"name": "val",

68233

"description": "",

68234

"type": "Number"

68235

}

68236

],

68237

"class": "CanvasShape",

68238

"module": "graphics"

68239

},

68240

{

68241

"file": "graphics/js/CanvasShape.js",

68242

"line": 493,

68243

"description": "Storage for `rotation` atribute.",

68244

"itemtype": "property",

68245

"name": "_rotation",

68246

"type": "Number",

68247

"access": "private",

68248

"tagname": "",

68249

"class": "CanvasShape",

68250

"module": "graphics"

68251

},

68252

{

68253

"file": "graphics/js/CanvasShape.js",

68254

"line": 502,

68255

"description": "Storage for the transform attribute.",

68256

"itemtype": "property",

68257

"name": "_transform",

68258

"type": "String",

68259

"access": "private",

68260

"tagname": "",

68261

"class": "CanvasShape",

68262

"module": "graphics"

68263

},

68264

{

68265

"file": "graphics/js/CanvasShape.js",

68266

"line": 511,

68267

"description": "Adds a transform to the shape.",

68268

"itemtype": "method",

68269

"name": "_addTransform",

68270

"params": [

68271

{

68272

"name": "type",

68273

"description": "The transform being applied.",

68274

"type": "String"

68275

},

68276

{

68277

"name": "args",

68278

"description": "The arguments for the transform.",

68279

"type": "Array"

68280

}

68281

],

68282

"access": "private",

68283

"tagname": "",

68284

"class": "CanvasShape",

68285

"module": "graphics"

68286

},

68287

{

68288

"file": "graphics/js/CanvasShape.js",

68289

"line": 531,

68290

"description": "Applies all transforms.",

68291

"itemtype": "method",

68292

"name": "_updateTransform",

68293

"access": "private",

68294

"tagname": "",

68295

"class": "CanvasShape",

68296

"module": "graphics"

68297

},

68298

{

68299

"file": "graphics/js/CanvasShape.js",

68300

"line": 576,

68301

"description": "Updates `Shape` based on attribute changes.",

68302

"itemtype": "method",

68303

"name": "_updateHandler",

68304

"access": "private",

68305

"tagname": "",

68306

"class": "CanvasShape",

68307

"module": "graphics"

68308

},

68309

{

68310

"file": "graphics/js/CanvasShape.js",

68311

"line": 588,

68312

"description": "Updates the shape.",

68313

"itemtype": "method",

68314

"name": "_draw",

68315

"access": "private",

68316

"tagname": "",

68317

"class": "CanvasShape",

68318

"module": "graphics"

68319

},

68320

{

68321

"file": "graphics/js/CanvasShape.js",

68322

"line": 603,

68323

"description": "Completes a shape or drawing",

68324

"itemtype": "method",

68325

"name": "_closePath",

68326

"access": "private",

68327

"tagname": "",

68328

"class": "CanvasShape",

68329

"module": "graphics"

68330

},

68331

{

68332

"file": "graphics/js/CanvasShape.js",

68333

"line": 688,

68334

"description": "Completes a stroke and/or fill operation on the context.",

68335

"itemtype": "method",

68336

"name": "_strokeAndFill",

68337

"params": [

68338

{

68339

"name": "Reference",

68340

"description": "to the context element of the canvas instance.",

68341

"type": "Context"

68342

}

68343

],

68344

"access": "private",

68345

"tagname": "",

68346

"class": "CanvasShape",

68347

"module": "graphics"

68348

},

68349

{

68350

"file": "graphics/js/CanvasShape.js",

68351

"line": 731,

68352

"description": "Draws a dashed line between two points.",

68353

"itemtype": "method",

68354

"name": "_drawDashedLine",

68355

"params": [

68356

{

68357

"name": "xStart",

68358

"description": "The x position of the start of the line",

68359

"type": "Number"

68360

},

68361

{

68362

"name": "yStart",

68363

"description": "The y position of the start of the line",

68364

"type": "Number"

68365

},

68366

{

68367

"name": "xEnd",

68368

"description": "The x position of the end of the line",

68369

"type": "Number"

68370

},

68371

{

68372

"name": "yEnd",

68373

"description": "The y position of the end of the line",

68374

"type": "Number"

68375

}

68376

],

68377

"access": "private",

68378

"tagname": "",

68379

"class": "CanvasShape",

68380

"module": "graphics"

68381

},

68382

{

68383

"file": "graphics/js/CanvasShape.js",

68384

"line": 792,

68385

"description": "Returns the bounds for a shape.\n\nCalculates the a new bounding box from the original corner coordinates (base on size and position) and the transform matrix.\nThe calculated bounding box is used by the graphic instance to calculate its viewBox.",

68386

"itemtype": "method",

68387

"name": "getBounds",

68388

"return": {

68389

"description": "Object"

68390

},

68391

"class": "CanvasShape",

68392

"module": "graphics"

68393

},

68394

{

68395

"file": "graphics/js/CanvasShape.js",

68396

"line": 820,

68397

"description": "Destroys the shape instance.",

68398

"itemtype": "method",

68399

"name": "destroy",

68400

"class": "CanvasShape",

68401

"module": "graphics"

68402

},

68403

{

68404

"file": "graphics/js/CanvasShape.js",

68405

"line": 838,

68406

"description": "Implementation for shape destruction",

68407

"itemtype": "method",

68408

"name": "destroy",

68409

"access": "protected",

68410

"tagname": "",

68411

"class": "CanvasShape",

68412

"module": "graphics"

68413

},

68414

{

68415

"file": "graphics/js/CanvasShape.js",

68416

"line": 856,

68417

"description": "An array of x, y values which indicates the transformOrigin in which to rotate the shape. Valid values range between 0 and 1 representing a \nfraction of the shape's corresponding bounding box dimension. The default value is [0.5, 0.5].",

68418

"itemtype": "config",

68419

"name": "transformOrigin",

68420

"type": "Array",

68421

"class": "CanvasShape",

68422

"module": "graphics"

68423

},

68424

{

68425

"file": "graphics/js/CanvasShape.js",

68426

"line": 870,

68427

"description": "A string containing, in order, transform operations applied to the shape instance. The `transform` string can contain the following values:\n \n <dl>\n <dt>rotate</dt><dd>Rotates the shape clockwise around it transformOrigin.</dd>\n <dt>translate</dt><dd>Specifies a 2d translation.</dd>\n <dt>skew</dt><dd>Skews the shape around the x-axis and y-axis.</dd>\n <dt>scale</dt><dd>Specifies a 2d scaling operation.</dd>\n <dt>translateX</dt><dd>Translates the shape along the x-axis.</dd>\n <dt>translateY</dt><dd>Translates the shape along the y-axis.</dd>\n <dt>skewX</dt><dd>Skews the shape around the x-axis.</dd>\n <dt>skewY</dt><dd>Skews the shape around the y-axis.</dd>\n <dt>matrix</dt><dd>Specifies a 2D transformation matrix comprised of the specified six values.</dd> \n </dl>\n\nApplying transforms through the transform attribute will reset the transform matrix and apply a new transform. The shape class also contains corresponding methods for each transform\nthat will apply the transform to the current matrix. The below code illustrates how you might use the `transform` attribute to instantiate a recangle with a rotation of 45 degrees.\n var myRect = new Y.Rect({\n type:\"rect\",\n width: 50,\n height: 40,\n transform: \"rotate(45)\"\n };\nThe code below would apply `translate` and `rotate` to an existing shape.\n \n myRect.set(\"transform\", \"translate(40, 50) rotate(45)\");",

68428

"itemtype": "config",

68429

"name": "transform",

68430

"type": "String",

68431

"class": "CanvasShape",

68432

"module": "graphics"

68433

},

68434

{

68435

"file": "graphics/js/CanvasShape.js",

68436

"line": 914,

68437

"description": "Dom node for the shape",

68438

"itemtype": "config",

68439

"name": "node",

68440

"type": "HTMLElement",

68441

"readonly": "",

68442

"class": "CanvasShape",

68443

"module": "graphics"

68444

},

68445

{

68446

"file": "graphics/js/CanvasShape.js",

68447

"line": 930,

68448

"description": "Unique id for class instance.",

68449

"itemtype": "config",

68450

"name": "id",

68451

"type": "String",

68452

"class": "CanvasShape",

68453

"module": "graphics"

68454

},

68455

{

68456

"file": "graphics/js/CanvasShape.js",

68457

"line": 953,

68458

"description": "Indicates the width of the shape",

68459

"itemtype": "config",

68460

"name": "width",

68461

"type": "Number",

68462

"class": "CanvasShape",

68463

"module": "graphics"

68464

},

68465

{

68466

"file": "graphics/js/CanvasShape.js",

68467

"line": 963,

68468

"description": "Indicates the height of the shape",

68469

"itemtype": "config",

68470

"name": "height",

68471

"type": "Number",

68472

"class": "CanvasShape",

68473

"module": "graphics"

68474

},

68475

{

68476

"file": "graphics/js/CanvasShape.js",

68477

"line": 973,

68478

"description": "Indicates the x position of shape.",

68479

"itemtype": "config",

68480

"name": "x",

68481

"type": "Number",

68482

"class": "CanvasShape",

68483

"module": "graphics"

68484

},

68485

{

68486

"file": "graphics/js/CanvasShape.js",

68487

"line": 983,

68488

"description": "Indicates the y position of shape.",

68489

"itemtype": "config",

68490

"name": "y",

68491

"type": "Number",

68492

"class": "CanvasShape",

68493

"module": "graphics"

68494

},

68495

{

68496

"file": "graphics/js/CanvasShape.js",

68497

"line": 993,

68498

"description": "Indicates whether the shape is visible.",

68499

"itemtype": "config",

68500

"name": "visible",

68501

"type": "Boolean",

68502

"class": "CanvasShape",

68503

"module": "graphics"

68504

},

68505

{

68506

"file": "graphics/js/CanvasShape.js",

68507

"line": 1013,

68508

"description": "Contains information about the fill of the shape. \n <dl>\n <dt>color</dt><dd>The color of the fill.</dd>\n <dt>opacity</dt><dd>Number between 0 and 1 that indicates the opacity of the fill. The default value is 1.</dd>\n <dt>type</dt><dd>Type of fill.\n <dl>\n <dt>solid</dt><dd>Solid single color fill. (default)</dd>\n <dt>linear</dt><dd>Linear gradient fill.</dd>\n <dt>radial</dt><dd>Radial gradient fill.</dd>\n </dl>\n </dd>\n </dl>\n If a `linear` or `radial` is specified as the fill type. The following additional property is used:\n <dl>\n <dt>stops</dt><dd>An array of objects containing the following properties:\n <dl>\n <dt>color</dt><dd>The color of the stop.</dd>\n <dt>opacity</dt><dd>Number between 0 and 1 that indicates the opacity of the stop. The default value is 1. Note: No effect for IE 6 - 8</dd>\n <dt>offset</dt><dd>Number between 0 and 1 indicating where the color stop is positioned.</dd> \n </dl>\n </dd>\n Linear gradients also have the following property:\n <dt>rotation</dt><dd>Linear gradients flow left to right by default. The rotation property allows you to change the flow by rotation. (e.g. A rotation of 180 would make the gradient pain from right to left.)</dd>\n Radial gradients have the following additional properties:\n <dt>r</dt><dd>Radius of the gradient circle.</dd>\n <dt>fx</dt><dd>Focal point x-coordinate of the gradient.</dd>\n <dt>fy</dt><dd>Focal point y-coordinate of the gradient.</dd>\n </dl>\n The corresponding `SVGShape` class implements the following additional properties.\n <dl>\n <dt>cx</dt><dd>\n The x-coordinate of the center of the gradient circle. Determines where the color stop begins. The default value 0.5.\n </dd>\n <dt>cy</dt><dd>\n The y-coordinate of the center of the gradient circle. Determines where the color stop begins. The default value 0.5.\n </dd>\n </dl>\n These properties are not currently implemented in `CanvasShape` or `VMLShape`.",

68509

"itemtype": "config",

68510

"name": "fill",

68511

"type": "Object",

68512

"class": "CanvasShape",

68513

"module": "graphics"

68514

},

68515

{

68516

"file": "graphics/js/CanvasShape.js",

68517

"line": 1076,

68518

"description": "Contains information about the stroke of the shape.\n <dl>\n <dt>color</dt><dd>The color of the stroke.</dd>\n <dt>weight</dt><dd>Number that indicates the width of the stroke.</dd>\n <dt>opacity</dt><dd>Number between 0 and 1 that indicates the opacity of the stroke. The default value is 1.</dd>\n <dt>dashstyle</dt>Indicates whether to draw a dashed stroke. When set to \"none\", a solid stroke is drawn. When set to an array, the first index indicates the\n length of the dash. The second index indicates the length of gap.\n <dt>linecap</dt><dd>Specifies the linecap for the stroke. The following values can be specified:\n <dl>\n <dt>butt (default)</dt><dd>Specifies a butt linecap.</dd>\n <dt>square</dt><dd>Specifies a sqare linecap.</dd>\n <dt>round</dt><dd>Specifies a round linecap.</dd>\n </dl>\n </dd>\n <dt>linejoin</dt><dd>Specifies a linejoin for the stroke. The following values can be specified:\n <dl>\n <dt>round (default)</dt><dd>Specifies that the linejoin will be round.</dd>\n <dt>bevel</dt><dd>Specifies a bevel for the linejoin.</dd>\n <dt>miter limit</dt><dd>An integer specifying the miter limit of a miter linejoin. If you want to specify a linejoin of miter, you simply specify the limit as opposed to having\n separate miter and miter limit values.</dd>\n </dl>\n </dd>\n </dl>",

68519

"itemtype": "config",

68520

"name": "stroke",

68521

"type": "Object",

68522

"class": "CanvasShape",

68523

"module": "graphics"

68524

},

68525

{

68526

"file": "graphics/js/CanvasShape.js",

68527

"line": 1140,

68528

"description": "Reference to the container Graphic.",

68529

"itemtype": "config",

68530

"name": "graphic",

68531

"type": "Graphic",

68532

"class": "CanvasShape",

68533

"module": "graphics"

68534

},

68535

{

68536

"file": "graphics/js/GraphicBase.js",

68537

"line": 61,

68538

"description": "Initializes the attributes for a shape. If an attribute config is passed into the constructor of the host, \nthe initial values will be overwritten.",

68539

"itemtype": "method",

68540

"name": "addAttrs",

68541

"params": [

68542

{

68543

"name": "cfg",

68544

"description": "Optional object containing attributes key value pairs to be set.",

68545

"type": "Object"

68546

}

68547

],

68548

"class": "AttributeLite",

68549

"module": "graphics"

68550

},

68551

{

68552

"file": "graphics/js/GraphicBase.js",

68553

"line": 130,

68554

"description": "For a given item, returns the value of the property requested, or undefined if not found.",

68555

"itemtype": "method",

68556

"name": "get",

68557

"params": [

68558

{

68559

"name": "name",

68560

"description": "The name of the item",

68561

"type": "String"

68562

}

68563

],

68564

"return": {

68565

"description": "The value of the supplied property.",

68566

"type": "Any"

68567

},

68568

"class": "AttributeLite",

68569

"module": "graphics"

68570

},

68571

{

68572

"file": "graphics/js/GraphicBase.js",

68573

"line": 159,

68574

"description": "Sets the value of an attribute.",

68575

"itemtype": "method",

68576

"name": "set",

68577

"params": [

68578

{

68579

"name": "name",

68580

"description": "The name of the attribute. Alternatively, an object of key value pairs can \nbe passed in to set multiple attributes at once.",

68581

"type": "String|Object"

68582

},

68583

{

68584

"name": "value",

68585

"description": "The value to set the attribute to. This value is ignored if an object is received as \nthe name param.",

68586

"type": "Any"

68587

}

68588

],

68589

"class": "AttributeLite",

68590

"module": "graphics"

68591

},

68592

{

68593

"file": "graphics/js/GraphicBase.js",

68594

"line": 187,

68595

"description": "Provides setter logic. Used by `set`.",

68596

"itemtype": "method",

68597

"name": "_set",

68598

"params": [

68599

{

68600

"name": "name",

68601

"description": "The name of the attribute. Alternatively, an object of key value pairs can \nbe passed in to set multiple attributes at once.",

68602

"type": "String|Object"

68603

},

68604

{

68605

"name": "value",

68606

"description": "The value to set the attribute to. This value is ignored if an object is received as \nthe name param.",

68607

"type": "Any"

68608

}

68609

],

68610

"access": "protected",

68611

"tagname": "",

68612

"class": "AttributeLite",

68613

"module": "graphics"

68614

},

68615

{

68616

"file": "graphics/js/GraphicBase.js",

68617

"line": 257,

68618

"description": "Init method, invoked during construction.\nFires an init event after calling `initializer` on implementers.",

68619

"itemtype": "method",

68620

"name": "init",

68621

"access": "protected",

68622

"tagname": "",

68623

"class": "GraphicBase",

68624

"module": "graphics"

68625

},

68626

{

68627

"file": "graphics/js/GraphicBase.js",

68628

"line": 294,

68629

"description": "Draws a line segment using the current line style from the current drawing position to the specified x and y coordinates.",

68630

"itemtype": "method",

68631

"name": "lineTo",

68632

"params": [

68633

{

68634

"name": "point1",

68635

"description": "x-coordinate for the end point.",

68636

"type": "Number"

68637

},

68638

{

68639

"name": "point2",

68640

"description": "y-coordinate for the end point.",

68641

"type": "Number"

68642

}

68643

],

68644

"class": "Drawing",

68645

"module": "graphics"

68646

},

68647

{

68648

"file": "graphics/js/GraphicBase.js",

68649

"line": 301,

68650

"description": "Moves the current drawing position to specified x and y coordinates.",

68651

"itemtype": "method",

68652

"name": "moveTo",

68653

"params": [

68654

{

68655

"name": "x",

68656

"description": "x-coordinate for the end point.",

68657

"type": "Number"

68658

},

68659

{

68660

"name": "y",

68661

"description": "y-coordinate for the end point.",

68662

"type": "Number"

68663

}

68664

],

68665

"class": "Drawing",

68666

"module": "graphics"

68667

},

68668

{

68669

"file": "graphics/js/GraphicBase.js",

68670

"line": 308,

68671

"description": "Draws a bezier curve.",

68672

"itemtype": "method",

68673

"name": "curveTo",

68674

"params": [

68675

{

68676

"name": "cp1x",

68677

"description": "x-coordinate for the first control point.",

68678

"type": "Number"

68679

},

68680

{

68681

"name": "cp1y",

68682

"description": "y-coordinate for the first control point.",

68683

"type": "Number"

68684

},

68685

{

68686

"name": "cp2x",

68687

"description": "x-coordinate for the second control point.",

68688

"type": "Number"

68689

},

68690

{

68691

"name": "cp2y",

68692

"description": "y-coordinate for the second control point.",

68693

"type": "Number"

68694

},

68695

{

68696

"name": "x",

68697

"description": "x-coordinate for the end point.",

68698

"type": "Number"

68699

},

68700

{

68701

"name": "y",

68702

"description": "y-coordinate for the end point.",

68703

"type": "Number"

68704

}

68705

],

68706

"class": "Drawing",

68707

"module": "graphics"

68708

},

68709

{

68710

"file": "graphics/js/GraphicBase.js",

68711

"line": 319,

68712

"description": "Draws a quadratic bezier curve.",

68713

"itemtype": "method",

68714

"name": "quadraticCurveTo",

68715

"params": [

68716

{

68717

"name": "cpx",

68718

"description": "x-coordinate for the control point.",

68719

"type": "Number"

68720

},

68721

{

68722

"name": "cpy",

68723

"description": "y-coordinate for the control point.",

68724

"type": "Number"

68725

},

68726

{

68727

"name": "x",

68728

"description": "x-coordinate for the end point.",

68729

"type": "Number"

68730

},

68731

{

68732

"name": "y",

68733

"description": "y-coordinate for the end point.",

68734

"type": "Number"

68735

}

68736

],

68737

"class": "Drawing",

68738

"module": "graphics"

68739

},

68740

{

68741

"file": "graphics/js/GraphicBase.js",

68742

"line": 328,

68743

"description": "Draws a rectangle.",

68744

"itemtype": "method",

68745

"name": "drawRect",

68746

"params": [

68747

{

68748

"name": "x",

68749

"description": "x-coordinate",

68750

"type": "Number"

68751

},

68752

{

68753

"name": "y",

68754

"description": "y-coordinate",

68755

"type": "Number"

68756

},

68757

{

68758

"name": "w",

68759

"description": "width",

68760

"type": "Number"

68761

},

68762

{

68763

"name": "h",

68764

"description": "height",

68765

"type": "Number"

68766

}

68767

],

68768

"class": "Drawing",

68769

"module": "graphics"

68770

},

68771

{

68772

"file": "graphics/js/GraphicBase.js",

68773

"line": 337,

68774

"description": "Draws a rectangle with rounded corners.",

68775

"itemtype": "method",

68776

"name": "drawRoundRect",

68777

"params": [

68778

{

68779

"name": "x",

68780

"description": "x-coordinate",

68781

"type": "Number"

68782

},

68783

{

68784

"name": "y",

68785

"description": "y-coordinate",

68786

"type": "Number"

68787

},

68788

{

68789

"name": "w",

68790

"description": "width",

68791

"type": "Number"

68792

},

68793

{

68794

"name": "h",

68795

"description": "height",

68796

"type": "Number"

68797

},

68798

{

68799

"name": "ew",

68800

"description": "width of the ellipse used to draw the rounded corners",

68801

"type": "Number"

68802

},

68803

{

68804

"name": "eh",

68805

"description": "height of the ellipse used to draw the rounded corners",

68806

"type": "Number"

68807

}

68808

],

68809

"class": "Drawing",

68810

"module": "graphics"

68811

},

68812

{

68813

"file": "graphics/js/GraphicBase.js",

68814

"line": 348,

68815

"description": "Completes a drawing operation.",

68816

"itemtype": "method",

68817

"name": "end",

68818

"class": "Drawing",

68819

"module": "graphics"

68820

},

68821

{

68822

"file": "graphics/js/GraphicBase.js",

68823

"line": 353,

68824

"description": "Clears the path.",

68825

"itemtype": "method",

68826

"name": "clear",

68827

"class": "Drawing",

68828

"module": "graphics"

68829

},

68830

{

68831

"file": "graphics/js/GraphicBase.js",

68832

"line": 385,

68833

"description": "Init method, invoked during construction.\nCalls `initializer` method.",

68834

"itemtype": "method",

68835

"name": "init",

68836

"access": "protected",

68837

"tagname": "",

68838

"class": "Shape",

68839

"module": "graphics"

68840

},

68841

{

68842

"file": "graphics/js/GraphicBase.js",

68843

"line": 392,

68844

"description": "Initializes the shape",

68845

"access": "private",

68846

"tagname": "",

68847

"itemtype": "method",

68848

"name": "initializer",

68849

"class": "Shape",

68850

"module": "graphics"

68851

},

68852

{

68853

"file": "graphics/js/GraphicBase.js",

68854

"line": 398,

68855

"description": "Add a class name to each node.",

68856

"itemtype": "method",

68857

"name": "addClass",

68858

"params": [

68859

{

68860

"name": "className",

68861

"description": "the class name to add to the node's class attribute",

68862

"type": "String"

68863

}

68864

],

68865

"class": "Shape",

68866

"module": "graphics"

68867

},

68868

{

68869

"file": "graphics/js/GraphicBase.js",

68870

"line": 404,

68871

"description": "Removes a class name from each node.",

68872

"itemtype": "method",

68873

"name": "removeClass",

68874

"params": [

68875

{

68876

"name": "className",

68877

"description": "the class name to remove from the node's class attribute",

68878

"type": "String"

68879

}

68880

],

68881

"class": "Shape",

68882

"module": "graphics"

68883

},

68884

{

68885

"file": "graphics/js/GraphicBase.js",

68886

"line": 410,

68887

"description": "Gets the current position of the node in page coordinates.",

68888

"itemtype": "method",

68889

"name": "getXY",

68890

"return": {

68891

"description": "Array The XY position of the shape."

68892

},

68893

"class": "Shape",

68894

"module": "graphics"

68895

},

68896

{

68897

"file": "graphics/js/GraphicBase.js",

68898

"line": 416,

68899

"description": "Set the position of the shape in page coordinates, regardless of how the node is positioned.",

68900

"itemtype": "method",

68901

"name": "setXY",

68902

"params": [

68903

{

68904

"name": "Contains",

68905

"description": "x & y values for new position (coordinates are page-based)",

68906

"type": "Array"

68907

}

68908

],

68909

"class": "Shape",

68910

"module": "graphics"

68911

},

68912

{

68913

"file": "graphics/js/GraphicBase.js",

68914

"line": 422,

68915

"description": "Determines whether the node is an ancestor of another HTML element in the DOM hierarchy.",

68916

"itemtype": "method",

68917

"name": "contains",

68918

"params": [

68919

{

68920

"name": "needle",

68921

"description": "The possible node or descendent",

68922

"type": "Shape | HTMLElement"

68923

}

68924

],

68925

"return": {

68926

"description": "Boolean Whether or not this shape is the needle or its ancestor."

68927

},

68928

"class": "Shape",

68929

"module": "graphics"

68930

},

68931

{

68932

"file": "graphics/js/GraphicBase.js",

68933

"line": 429,

68934

"description": "Compares nodes to determine if they match.\nNode instances can be compared to each other and/or HTMLElements.",

68935

"itemtype": "method",

68936

"name": "compareTo",

68937

"params": [

68938

{

68939

"name": "refNode",

68940

"description": "The reference node to compare to the node.",

68941

"type": "HTMLElement | Node"

68942

}

68943

],

68944

"return": {

68945

"description": "True if the nodes match, false if they do not.",

68946

"type": "Boolean"

68947

},

68948

"class": "Shape",

68949

"module": "graphics"

68950

},

68951

{

68952

"file": "graphics/js/GraphicBase.js",

68953

"line": 436,

68954

"description": "Test if the supplied node matches the supplied selector.",

68955

"itemtype": "method",

68956

"name": "test",

68957

"params": [

68958

{

68959

"name": "selector",

68960

"description": "The CSS selector to test against.",

68961

"type": "String"

68962

}

68963

],

68964

"return": {

68965

"description": "Boolean Wheter or not the shape matches the selector."

68966

},

68967

"class": "Shape",

68968

"module": "graphics"

68969

},

68970

{

68971

"file": "graphics/js/GraphicBase.js",

68972

"line": 443,

68973

"description": "Sets the value of an attribute.",

68974

"itemtype": "method",

68975

"name": "set",

68976

"params": [

68977

{

68978

"name": "name",

68979

"description": "The name of the attribute. Alternatively, an object of key value pairs can \nbe passed in to set multiple attributes at once.",

68980

"type": "String|Object"

68981

},

68982

{

68983

"name": "value",

68984

"description": "The value to set the attribute to. This value is ignored if an object is received as \nthe name param.",

68985

"type": "Any"

68986

}

68987

],

68988

"class": "Shape",

68989

"module": "graphics"

68990

},

68991

{

68992

"file": "graphics/js/GraphicBase.js",

68993

"line": 452,

68994

"description": "Specifies a 2d translation.",

68995

"itemtype": "method",

68996

"name": "translate",

68997

"params": [

68998

{

68999

"name": "x",

69000

"description": "The value to transate on the x-axis.",

69001

"type": "Number"

69002

},

69003

{

69004

"name": "y",

69005

"description": "The value to translate on the y-axis.",

69006

"type": "Number"

69007

}

69008

],

69009

"class": "Shape",

69010

"module": "graphics"

69011

},

69012

{

69013

"file": "graphics/js/GraphicBase.js",

69014

"line": 459,

69015

"description": "Translates the shape along the x-axis. When translating x and y coordinates,\nuse the `translate` method.",

69016

"itemtype": "method",

69017

"name": "translateX",

69018

"params": [

69019

{

69020

"name": "x",

69021

"description": "The value to translate.",

69022

"type": "Number"

69023

}

69024

],

69025

"class": "Shape",

69026

"module": "graphics"

69027

},

69028

{

69029

"file": "graphics/js/GraphicBase.js",

69030

"line": 466,

69031

"description": "Translates the shape along the y-axis. When translating x and y coordinates,\nuse the `translate` method.",

69032

"itemtype": "method",

69033

"name": "translateY",

69034

"params": [

69035

{

69036

"name": "y",

69037

"description": "The value to translate.",

69038

"type": "Number"

69039

}

69040

],

69041

"class": "Shape",

69042

"module": "graphics"

69043

},

69044

{

69045

"file": "graphics/js/GraphicBase.js",

69046

"line": 473,

69047

"description": "Skews the shape around the x-axis and y-axis.",

69048

"itemtype": "method",

69049

"name": "skew",

69050

"params": [

69051

{

69052

"name": "x",

69053

"description": "The value to skew on the x-axis.",

69054

"type": "Number"

69055

},

69056

{

69057

"name": "y",

69058

"description": "The value to skew on the y-axis.",

69059

"type": "Number"

69060

}

69061

],

69062

"class": "Shape",

69063

"module": "graphics"

69064

},

69065

{

69066

"file": "graphics/js/GraphicBase.js",

69067

"line": 480,

69068

"description": "Skews the shape around the x-axis.",

69069

"itemtype": "method",

69070

"name": "skewX",

69071

"params": [

69072

{

69073

"name": "x",

69074

"description": "x-coordinate",

69075

"type": "Number"

69076

}

69077

],

69078

"class": "Shape",

69079

"module": "graphics"

69080

},

69081

{

69082

"file": "graphics/js/GraphicBase.js",

69083

"line": 486,

69084

"description": "Skews the shape around the y-axis.",

69085

"itemtype": "method",

69086

"name": "skewY",

69087

"params": [

69088

{

69089

"name": "y",

69090

"description": "y-coordinate",

69091

"type": "Number"

69092

}

69093

],

69094

"class": "Shape",

69095

"module": "graphics"

69096

},

69097

{

69098

"file": "graphics/js/GraphicBase.js",

69099

"line": 492,

69100

"description": "Rotates the shape clockwise around it transformOrigin.",

69101

"itemtype": "method",

69102

"name": "rotate",

69103

"params": [

69104

{

69105

"name": "deg",

69106

"description": "The degree of the rotation.",

69107

"type": "Number"

69108

}

69109

],

69110

"class": "Shape",

69111

"module": "graphics"

69112

},

69113

{

69114

"file": "graphics/js/GraphicBase.js",

69115

"line": 498,

69116

"description": "Specifies a 2d scaling operation.",

69117

"itemtype": "method",

69118

"name": "scale",

69119

"params": [

69120

{

69121

"name": "val",

69122

"description": "",

69123

"type": "Number"

69124

}

69125

],

69126

"class": "Shape",

69127

"module": "graphics"

69128

},

69129

{

69130

"file": "graphics/js/GraphicBase.js",

69131

"line": 504,

69132

"description": "Returns the bounds for a shape.\n\nCalculates the a new bounding box from the original corner coordinates (base on size and position) and the transform matrix.\nThe calculated bounding box is used by the graphic instance to calculate its viewBox.",

69133

"itemtype": "method",

69134

"name": "getBounds",

69135

"return": {

69136

"description": "Object"

69137

},

69138

"class": "Shape",

69139

"module": "graphics"

69140

},

69141

{

69142

"file": "graphics/js/GraphicBase.js",

69143

"line": 513,

69144

"description": "Destroys the instance.",

69145

"itemtype": "method",

69146

"name": "destroy",

69147

"class": "Shape",

69148

"module": "graphics"

69149

},

69150

{

69151

"file": "graphics/js/GraphicBase.js",

69152

"line": 518,

69153

"description": "An array of x, y values which indicates the transformOrigin in which to rotate the shape. Valid values range between 0 and 1 representing a \nfraction of the shape's corresponding bounding box dimension. The default value is [0.5, 0.5].",

69154

"itemtype": "config",

69155

"name": "transformOrigin",

69156

"type": "Array",

69157

"class": "Shape",

69158

"module": "graphics"

69159

},

69160

{

69161

"file": "graphics/js/GraphicBase.js",

69162

"line": 525,

69163

"description": "A string containing, in order, transform operations applied to the shape instance. The `transform` string can contain the following values:\n \n <dl>\n <dt>rotate</dt><dd>Rotates the shape clockwise around it transformOrigin.</dd>\n <dt>translate</dt><dd>Specifies a 2d translation.</dd>\n <dt>skew</dt><dd>Skews the shape around the x-axis and y-axis.</dd>\n <dt>scale</dt><dd>Specifies a 2d scaling operation.</dd>\n <dt>translateX</dt><dd>Translates the shape along the x-axis.</dd>\n <dt>translateY</dt><dd>Translates the shape along the y-axis.</dd>\n <dt>skewX</dt><dd>Skews the shape around the x-axis.</dd>\n <dt>skewY</dt><dd>Skews the shape around the y-axis.</dd>\n </dl>\n\nApplying transforms through the transform attribute will reset the transform matrix and apply a new transform. The shape class also contains corresponding methods for each transform\nthat will apply the transform to the current matrix. The below code illustrates how you might use the `transform` attribute to instantiate a recangle with a rotation of 45 degrees.\n var myRect = new Y.Rect({\n type:\"rect\",\n width: 50,\n height: 40,\n transform: \"rotate(45)\"\n };\nThe code below would apply `translate` and `rotate` to an existing shape.\n \n myRect.set(\"transform\", \"translate(40, 50) rotate(45)\");",

69164

"itemtype": "config",

69165

"name": "transform",

69166

"type": "String",

69167

"class": "Shape",

69168

"module": "graphics"

69169

},

69170

{

69171

"file": "graphics/js/GraphicBase.js",

69172

"line": 553,

69173

"description": "Unique id for class instance.",

69174

"itemtype": "config",

69175

"name": "id",

69176

"type": "String",

69177

"class": "Shape",

69178

"module": "graphics"

69179

},

69180

{

69181

"file": "graphics/js/GraphicBase.js",

69182

"line": 559,

69183

"description": "Indicates the x position of shape.",

69184

"itemtype": "config",

69185

"name": "x",

69186

"type": "Number",

69187

"class": "Shape",

69188

"module": "graphics"

69189

},

69190

{

69191

"file": "graphics/js/GraphicBase.js",

69192

"line": 565,

69193

"description": "Indicates the y position of shape.",

69194

"itemtype": "config",

69195

"name": "y",

69196

"type": "Number",

69197

"class": "Shape",

69198

"module": "graphics"

69199

},

69200

{

69201

"file": "graphics/js/GraphicBase.js",

69202

"line": 571,

69203

"description": "Indicates the width of the shape",

69204

"itemtype": "config",

69205

"name": "width",

69206

"type": "Number",

69207

"class": "Shape",

69208

"module": "graphics"

69209

},

69210

{

69211

"file": "graphics/js/GraphicBase.js",

69212

"line": 577,

69213

"description": "Indicates the height of the shape",

69214

"itemtype": "config",

69215

"name": "height",

69216

"type": "Number",

69217

"class": "Shape",

69218

"module": "graphics"

69219

},

69220

{

69221

"file": "graphics/js/GraphicBase.js",

69222

"line": 583,

69223

"description": "Indicates whether the shape is visible.",

69224

"itemtype": "config",

69225

"name": "visible",

69226

"type": "Boolean",

69227

"class": "Shape",

69228

"module": "graphics"

69229

},

69230

{

69231

"file": "graphics/js/GraphicBase.js",

69232

"line": 589,

69233

"description": "Contains information about the fill of the shape. \n <dl>\n <dt>color</dt><dd>The color of the fill.</dd>\n <dt>opacity</dt><dd>Number between 0 and 1 that indicates the opacity of the fill. The default value is 1.</dd>\n <dt>type</dt><dd>Type of fill.\n <dl>\n <dt>solid</dt><dd>Solid single color fill. (default)</dd>\n <dt>linear</dt><dd>Linear gradient fill.</dd>\n <dt>radial</dt><dd>Radial gradient fill.</dd>\n </dl>\n </dd>\n </dl>\n If a `linear` or `radial` is specified as the fill type. The following additional property is used:\n <dl>\n <dt>stops</dt><dd>An array of objects containing the following properties:\n <dl>\n <dt>color</dt><dd>The color of the stop.</dd>\n <dt>opacity</dt><dd>Number between 0 and 1 that indicates the opacity of the stop. The default value is 1. Note: No effect for IE 6 - 8</dd>\n <dt>offset</dt><dd>Number between 0 and 1 indicating where the color stop is positioned.</dd> \n </dl>\n </dd>\n Linear gradients also have the following property:\n <dt>rotation</dt><dd>Linear gradients flow left to right by default. The rotation property allows you to change the flow by rotation. (e.g. A rotation of 180 would make the gradient pain from right to left.)</dd>\n Radial gradients have the following additional properties:\n <dt>r</dt><dd>Radius of the gradient circle.</dd>\n <dt>fx</dt><dd>Focal point x-coordinate of the gradient.</dd>\n <dt>fy</dt><dd>Focal point y-coordinate of the gradient.</dd>\n <dt>cx</dt><dd>\n The x-coordinate of the center of the gradient circle. Determines where the color stop begins. The default value 0.5.\n Note: Currently, this property is not implemented for corresponding `CanvasShape` and `VMLShape` classes which are used on Android or IE 6 - 8.\n </dd>\n <dt>cy</dt><dd>\n The y-coordinate of the center of the gradient circle. Determines where the color stop begins. The default value 0.5.\n Note: Currently, this property is not implemented for corresponding `CanvasShape` and `VMLShape` classes which are used on Android or IE 6 - 8.\n </dd>\n </dl>",

69234

"itemtype": "config",

69235

"name": "fill",

69236

"type": "Object",

69237

"class": "Shape",

69238

"module": "graphics"

69239

},

69240

{

69241

"file": "graphics/js/GraphicBase.js",

69242

"line": 630,

69243

"description": "Contains information about the stroke of the shape.\n <dl>\n <dt>color</dt><dd>The color of the stroke.</dd>\n <dt>weight</dt><dd>Number that indicates the width of the stroke.</dd>\n <dt>opacity</dt><dd>Number between 0 and 1 that indicates the opacity of the stroke. The default value is 1.</dd>\n <dt>dashstyle</dt>Indicates whether to draw a dashed stroke. When set to \"none\", a solid stroke is drawn. When set to an array, the first index indicates the\n length of the dash. The second index indicates the length of gap.\n <dt>linecap</dt><dd>Specifies the linecap for the stroke. The following values can be specified:\n <dl>\n <dt>butt (default)</dt><dd>Specifies a butt linecap.</dd>\n <dt>square</dt><dd>Specifies a sqare linecap.</dd>\n <dt>round</dt><dd>Specifies a round linecap.</dd>\n </dl>\n </dd>\n <dt>linejoin</dt><dd>Specifies a linejoin for the stroke. The following values can be specified:\n <dl>\n <dt>round (default)</dt><dd>Specifies that the linejoin will be round.</dd>\n <dt>bevel</dt><dd>Specifies a bevel for the linejoin.</dd>\n <dt>miter limit</dt><dd>An integer specifying the miter limit of a miter linejoin. If you want to specify a linejoin of miter, you simply specify the limit as opposed to having\n separate miter and miter limit values.</dd>\n </dl>\n </dd>\n </dl>",

69244

"itemtype": "config",

69245

"name": "stroke",

69246

"type": "Object",

69247

"class": "Shape",

69248

"module": "graphics"

69249

},

69250

{

69251

"file": "graphics/js/GraphicBase.js",

69252

"line": 658,

69253

"description": "Dom node for the shape.",

69254

"itemtype": "config",

69255

"name": "node",

69256

"type": "HTMLElement",

69257

"readonly": "",

69258

"class": "Shape",

69259

"module": "graphics"

69260

},

69261

{

69262

"file": "graphics/js/GraphicBase.js",

69263

"line": 665,

69264

"description": "Reference to the parent graphic instance",

69265

"itemtype": "config",

69266

"name": "graphic",

69267

"type": "Graphic",

69268

"readonly": "",

69269

"class": "Shape",

69270

"module": "graphics"

69271

},

69272

{

69273

"file": "graphics/js/GraphicBase.js",

69274

"line": 730,

69275

"description": "Radius of the circle",

69276

"itemtype": "config",

69277

"name": "radius",

69278

"type": "Number",

69279

"class": "Circle",

69280

"module": "graphics"

69281

},

69282

{

69283

"file": "graphics/js/GraphicBase.js",

69284

"line": 918,

69285

"description": "Indicates the path used for the node.",

69286

"itemtype": "config",

69287

"name": "path",

69288

"type": "String",

69289

"readonly": "",

69290

"class": "Path",

69291

"module": "graphics"

69292

},

69293

{

69294

"file": "graphics/js/GraphicBase.js",

69295

"line": 947,

69296

"description": "Whether or not to render the `Graphic` automatically after to a specified parent node after init. This can be a Node instance or a CSS selector string.",

69297

"itemtype": "config",

69298

"name": "render",

69299

"type": "Node | String",

69300

"class": "Graphic",

69301

"module": "graphics"

69302

},

69303

{

69304

"file": "graphics/js/GraphicBase.js",

69305

"line": 953,

69306

"description": "Unique id for class instance.",

69307

"itemtype": "config",

69308

"name": "id",

69309

"type": "String",

69310

"class": "Graphic",

69311

"module": "graphics"

69312

},

69313

{

69314

"file": "graphics/js/GraphicBase.js",

69315

"line": 959,

69316

"description": "Key value pairs in which a shape instance is associated with its id.",

69317

"itemtype": "config",

69318

"name": "shapes",

69319

"type": "Object",

69320

"readonly": "",

69321

"class": "Graphic",

69322

"module": "graphics"

69323

},

69324

{

69325

"file": "graphics/js/GraphicBase.js",

69326

"line": 966,

69327

"description": "Object containing size and coordinate data for the content of a Graphic in relation to the coordSpace node.",

69328

"itemtype": "config",

69329

"name": "contentBounds",

69330

"type": "Object",

69331

"readonly": "",

69332

"class": "Graphic",

69333

"module": "graphics"

69334

},

69335

{

69336

"file": "graphics/js/GraphicBase.js",

69337

"line": 973,

69338

"description": "The html element that represents to coordinate system of the Graphic instance.",

69339

"itemtype": "config",

69340

"name": "node",

69341

"type": "HTMLElement",

69342

"readonly": "",

69343

"class": "Graphic",

69344

"module": "graphics"

69345

},

69346

{

69347

"file": "graphics/js/GraphicBase.js",

69348

"line": 980,

69349

"description": "Indicates the width of the `Graphic`.",

69350

"itemtype": "config",

69351

"name": "width",

69352

"type": "Number",

69353

"class": "Graphic",

69354

"module": "graphics"

69355

},

69356

{

69357

"file": "graphics/js/GraphicBase.js",

69358

"line": 986,

69359

"description": "Indicates the height of the `Graphic`.",

69360

"itemtype": "config",

69361

"name": "height",

69362

"type": "Number",

69363

"class": "Graphic",

69364

"module": "graphics"

69365

},

69366

{

69367

"file": "graphics/js/GraphicBase.js",

69368

"line": 992,

69369

"description": "Determines how the size of instance is calculated. If true, the width and height are determined by the size of the contents.\nIf false, the width and height values are either explicitly set or determined by the size of the parent node's dimensions.",

69370

"itemtype": "config",

69371

"name": "autoSize",

69372

"type": "Boolean",

69373

"default": "false",

69374

"class": "Graphic",

69375

"module": "graphics"

69376

},

69377

{

69378

"file": "graphics/js/GraphicBase.js",

69379

"line": 1000,

69380

"description": "The contentBounds will resize to greater values but not to smaller values. (for performance)\nWhen resizing the contentBounds down is desirable, set the resizeDown value to true.",

69381

"itemtype": "config",

69382

"name": "resizeDown",

69383

"type": "Boolean",

69384

"class": "Graphic",

69385

"module": "graphics"

69386

},

69387

{

69388

"file": "graphics/js/GraphicBase.js",

69389

"line": 1007,

69390

"description": "Indicates the x-coordinate for the instance.",

69391

"itemtype": "config",

69392

"name": "x",

69393

"type": "Number",

69394

"class": "Graphic",

69395

"module": "graphics"

69396

},

69397

{

69398

"file": "graphics/js/GraphicBase.js",

69399

"line": 1013,

69400

"description": "Indicates the y-coordinate for the instance.",

69401

"itemtype": "config",

69402

"name": "y",

69403

"type": "Number",

69404

"class": "Graphic",

69405

"module": "graphics"

69406

},

69407

{

69408

"file": "graphics/js/GraphicBase.js",

69409

"line": 1019,

69410

"description": "Indicates whether or not the instance will automatically redraw after a change is made to a shape.\nThis property will get set to false when batching operations.",

69411

"itemtype": "config",

69412

"name": "autoDraw",

69413

"type": "Boolean",

69414

"default": "true",

69415

"access": "private",

69416

"tagname": "",

69417

"class": "Graphic",

69418

"module": "graphics"

69419

},

69420

{

69421

"file": "graphics/js/GraphicBase.js",

69422

"line": 1028,

69423

"description": "Indicates whether the `Graphic` and its children are visible.",

69424

"itemtype": "config",

69425

"name": "visible",

69426

"type": "Boolean",

69427

"class": "Graphic",

69428

"module": "graphics"

69429

},

69430

{

69431

"file": "graphics/js/GraphicBase.js",

69432

"line": 1034,

69433

"description": "Gets the current position of the graphic instance in page coordinates.",

69434

"itemtype": "method",

69435

"name": "getXY",

69436

"return": {

69437

"description": "Array The XY position of the shape."

69438

},

69439

"class": "Graphic",

69440

"module": "graphics"

69441

},

69442

{

69443

"file": "graphics/js/GraphicBase.js",

69444

"line": 1040,

69445

"description": "Adds the graphics node to the dom.",

69446

"itemtype": "method",

69447

"name": "render",

69448

"params": [

69449

{

69450

"name": "parentNode",

69451

"description": "node in which to render the graphics node into.",

69452

"type": "Node|String"

69453

}

69454

],

69455

"class": "Graphic",

69456

"module": "graphics"

69457

},

69458

{

69459

"file": "graphics/js/GraphicBase.js",

69460

"line": 1046,

69461

"description": "Removes all nodes.",

69462

"itemtype": "method",

69463

"name": "destroy",

69464

"class": "Graphic",

69465

"module": "graphics"

69466

},

69467

{

69468

"file": "graphics/js/GraphicBase.js",

69469

"line": 1051,

69470

"description": "Generates a shape instance by type. The method accepts an object that contain's the shape's\ntype and attributes to be customized. For example, the code below would create a rectangle:\n\n var myRect = myGraphic.addShape({\n type: \"rect\",\n width: 40,\n height: 30,\n fill: {\n color: \"#9aa\"\n },\n stroke: {\n weight: 1,\n color: \"#000\"\n }\n });\n\nThe `Graphics` module includes a few basic shapes. More information on their creation \ncan be found in each shape's documentation:\n\n <ul>\n <li><a href=\"Circle.html\">`Circle`</a></li>\n <li><a href=\"Ellipse.html\">`Ellipse`</a></li>\n <li><a href=\"Rect.html\">`Rect`</a></li>\n <li><a href=\"Path.html\">`Path`</a></li>\n </ul>\n\n The `Graphics` module also allows for the creation of custom shapes. If a custom shape\n has been created, it can be instantiated with the `addShape` method as well. The attributes,\n required and optional, would need to be defined in the custom shape.\n\n var myCustomShape = myGraphic.addShape({\n type: Y.MyCustomShape,\n width: 50,\n height: 50,\n fill: {\n color: \"#9aa\"\n },\n stroke: {\n weight: 1,\n color: \"#000\"\n }\n });",

69471

"itemtype": "method",

69472

"name": "addShape",

69473

"params": [

69474

{

69475

"name": "cfg",

69476

"description": "Object containing the shape's type and attributes.",

69477

"type": "Object"

69478

}

69479

],

69480

"return": {

69481

"description": "Shape"

69482

},

69483

"class": "Graphic",

69484

"module": "graphics"

69485

},

69486

{

69487

"file": "graphics/js/GraphicBase.js",

69488

"line": 1099,

69489

"description": "Removes a shape instance from from the graphic instance.",

69490

"itemtype": "method",

69491

"name": "removeShape",

69492

"params": [

69493

{

69494

"name": "shape",

69495

"description": "The instance or id of the shape to be removed.",

69496

"type": "Shape|String"

69497

}

69498

],

69499

"class": "Graphic",

69500

"module": "graphics"

69501

},

69502

{

69503

"file": "graphics/js/GraphicBase.js",

69504

"line": 1105,

69505

"description": "Removes all shape instances from the dom.",

69506

"itemtype": "method",

69507

"name": "removeAllShapes",

69508

"class": "Graphic",

69509

"module": "graphics"

69510

},

69511

{

69512

"file": "graphics/js/GraphicBase.js",

69513

"line": 1110,

69514

"description": "Returns a shape based on the id of its dom node.",

69515

"itemtype": "method",

69516

"name": "getShapeById",

69517

"params": [

69518

{

69519

"name": "id",

69520

"description": "Dom id of the shape's node attribute.",

69521

"type": "String"

69522

}

69523

],

69524

"return": {

69525

"description": "Shape"

69526

},

69527

"class": "Graphic",

69528

"module": "graphics"

69529

},

69530

{

69531

"file": "graphics/js/GraphicBase.js",

69532

"line": 1117,

69533

"description": "Allows for creating multiple shapes in order to batch appending and redraw operations.",

69534

"itemtype": "method",

69535

"name": "batch",

69536

"params": [

69537

{

69538

"name": "method",

69539

"description": "Method to execute.",

69540

"type": "Function"

69541

}

69542

],

69543

"class": "Graphic",

69544

"module": "graphics"

69545

},

69546

{

69547

"file": "graphics/js/SVGCircle.js",

69548

"line": 20,

69549

"description": "Indicates the type of shape",

69550

"itemtype": "property",

69551

"name": "_type",

69552

"type": "String",

69553

"access": "private",

69554

"tagname": "",

69555

"class": "SVGCircle",

69556

"module": "graphics"

69557

},

69558

{

69559

"file": "graphics/js/SVGCircle.js",

69560

"line": 29,

69561

"description": "Updates the shape.",

69562

"itemtype": "method",

69563

"name": "_draw",

69564

"access": "private",

69565

"tagname": "",

69566

"class": "SVGCircle",

69567

"module": "graphics"

69568

},

69569

{

69570

"file": "graphics/js/SVGCircle.js",

69571

"line": 53,

69572

"description": "Indicates the width of the shape",

69573

"itemtype": "config",

69574

"name": "width",

69575

"type": "Number",

69576

"class": "SVGCircle",

69577

"module": "graphics"

69578

},

69579

{

69580

"file": "graphics/js/SVGCircle.js",

69581

"line": 72,

69582

"description": "Indicates the height of the shape",

69583

"itemtype": "config",

69584

"name": "height",

69585

"type": "Number",

69586

"class": "SVGCircle",

69587

"module": "graphics"

69588

},

69589

{

69590

"file": "graphics/js/SVGCircle.js",

69591

"line": 91,

69592

"description": "Radius of the circle",

69593

"itemtype": "config",

69594

"name": "radius",

69595

"type": "Number",

69596

"class": "SVGCircle",

69597

"module": "graphics"

69598

},

69599

{

69600

"file": "graphics/js/SVGDrawing.js",

69601

"line": 26,

69602

"description": "Indicates the type of shape",

69603

"access": "private",

69604

"tagname": "",

69605

"itemtype": "property",

69606

"name": "_type",

69607

"readonly": "",

69608

"type": "String",

69609

"class": "SVGDrawing",

69610

"module": "graphics"

69611

},

69612

{

69613

"file": "graphics/js/SVGDrawing.js",

69614

"line": 36,

69615

"description": "Draws a bezier curve.",

69616

"itemtype": "method",

69617

"name": "curveTo",

69618

"params": [

69619

{

69620

"name": "cp1x",

69621

"description": "x-coordinate for the first control point.",

69622

"type": "Number"

69623

},

69624

{

69625

"name": "cp1y",

69626

"description": "y-coordinate for the first control point.",

69627

"type": "Number"

69628

},

69629

{

69630

"name": "cp2x",

69631

"description": "x-coordinate for the second control point.",

69632

"type": "Number"

69633

},

69634

{

69635

"name": "cp2y",

69636

"description": "y-coordinate for the second control point.",

69637

"type": "Number"

69638

},

69639

{

69640

"name": "x",

69641

"description": "x-coordinate for the end point.",

69642

"type": "Number"

69643

},

69644

{

69645

"name": "y",

69646

"description": "y-coordinate for the end point.",

69647

"type": "Number"

69648

}

69649

],

69650

"class": "SVGDrawing",

69651

"module": "graphics"

69652

},

69653

{

69654

"file": "graphics/js/SVGDrawing.js",

69655

"line": 79,

69656

"description": "Draws a quadratic bezier curve.",

69657

"itemtype": "method",

69658

"name": "quadraticCurveTo",

69659

"params": [

69660

{

69661

"name": "cpx",

69662

"description": "x-coordinate for the control point.",

69663

"type": "Number"

69664

},

69665

{

69666

"name": "cpy",

69667

"description": "y-coordinate for the control point.",

69668

"type": "Number"

69669

},

69670

{

69671

"name": "x",

69672

"description": "x-coordinate for the end point.",

69673

"type": "Number"

69674

},

69675

{

69676

"name": "y",

69677

"description": "y-coordinate for the end point.",

69678

"type": "Number"

69679

}

69680

],

69681

"class": "SVGDrawing",

69682

"module": "graphics"

69683

},

69684

{

69685

"file": "graphics/js/SVGDrawing.js",

69686

"line": 120,

69687

"description": "Draws a rectangle.",

69688

"itemtype": "method",

69689

"name": "drawRect",

69690

"params": [

69691

{

69692

"name": "x",

69693

"description": "x-coordinate",

69694

"type": "Number"

69695

},

69696

{

69697

"name": "y",

69698

"description": "y-coordinate",

69699

"type": "Number"

69700

},

69701

{

69702

"name": "w",

69703

"description": "width",

69704

"type": "Number"

69705

},

69706

{

69707

"name": "h",

69708

"description": "height",

69709

"type": "Number"

69710

}

69711

],

69712

"class": "SVGDrawing",

69713

"module": "graphics"

69714

},

69715

{

69716

"file": "graphics/js/SVGDrawing.js",

69717

"line": 137,

69718

"description": "Draws a rectangle with rounded corners.",

69719

"itemtype": "method",

69720

"name": "drawRect",

69721

"params": [

69722

{

69723

"name": "x",

69724

"description": "x-coordinate",

69725

"type": "Number"

69726

},

69727

{

69728

"name": "y",

69729

"description": "y-coordinate",

69730

"type": "Number"

69731

},

69732

{

69733

"name": "w",

69734

"description": "width",

69735

"type": "Number"

69736

},

69737

{

69738

"name": "h",

69739

"description": "height",

69740

"type": "Number"

69741

},

69742

{

69743

"name": "ew",

69744

"description": "width of the ellipse used to draw the rounded corners",

69745

"type": "Number"

69746

},

69747

{

69748

"name": "eh",

69749

"description": "height of the ellipse used to draw the rounded corners",

69750

"type": "Number"

69751

}

69752

],

69753

"class": "SVGDrawing",

69754

"module": "graphics"

69755

},

69756

{

69757

"file": "graphics/js/SVGDrawing.js",

69758

"line": 160,

69759

"description": "Draws a circle.",

69760

"itemtype": "method",

69761

"name": "drawCircle",

69762

"params": [

69763

{

69764

"name": "x",

69765

"description": "y-coordinate",

69766

"type": "Number"

69767

},

69768

{

69769

"name": "y",

69770

"description": "x-coordinate",

69771

"type": "Number"

69772

},

69773

{

69774

"name": "r",

69775

"description": "radius",

69776

"type": "Number"

69777

}

69778

],

69779

"access": "protected",

69780

"tagname": "",

69781

"class": "SVGDrawing",

69782

"module": "graphics"

69783

},

69784

{

69785

"file": "graphics/js/SVGDrawing.js",

69786

"line": 181,

69787

"description": "Draws an ellipse.",

69788

"itemtype": "method",

69789

"name": "drawEllipse",

69790

"params": [

69791

{

69792

"name": "x",

69793

"description": "x-coordinate",

69794

"type": "Number"

69795

},

69796

{

69797

"name": "y",

69798

"description": "y-coordinate",

69799

"type": "Number"

69800

},

69801

{

69802

"name": "w",

69803

"description": "width",

69804

"type": "Number"

69805

},

69806

{

69807

"name": "h",

69808

"description": "height",

69809

"type": "Number"

69810

}

69811

],

69812

"access": "protected",

69813

"tagname": "",

69814

"class": "SVGDrawing",

69815

"module": "graphics"

69816

},

69817

{

69818

"file": "graphics/js/SVGDrawing.js",

69819

"line": 204,

69820

"description": "Draws a diamond.",

69821

"itemtype": "method",

69822

"name": "drawDiamond",

69823

"params": [

69824

{

69825

"name": "x",

69826

"description": "y-coordinate",

69827

"type": "Number"

69828

},

69829

{

69830

"name": "y",

69831

"description": "x-coordinate",

69832

"type": "Number"

69833

},

69834

{

69835

"name": "width",

69836

"description": "width",

69837

"type": "Number"

69838

},

69839

{

69840

"name": "height",

69841

"description": "height",

69842

"type": "Number"

69843

}

69844

],

69845

"access": "protected",

69846

"tagname": "",

69847

"class": "SVGDrawing",

69848

"module": "graphics"

69849

},

69850

{

69851

"file": "graphics/js/SVGDrawing.js",

69852

"line": 226,

69853

"description": "Draws a wedge.",

69854

"itemtype": "method",

69855

"name": "drawWedge",

69856

"params": [

69857

{

69858

"name": "x",

69859

"description": "x-coordinate of the wedge's center point",

69860

"type": "Number"

69861

},

69862

{

69863

"name": "y",

69864

"description": "y-coordinate of the wedge's center point",

69865

"type": "Number"

69866

},

69867

{

69868

"name": "startAngle",

69869

"description": "starting angle in degrees",

69870

"type": "Number"

69871

},

69872

{

69873

"name": "arc",

69874

"description": "sweep of the wedge. Negative values draw clockwise.",

69875

"type": "Number"

69876

},

69877

{

69878

"name": "radius",

69879

"description": "radius of wedge. If [optional] yRadius is defined, then radius is the x radius.",

69880

"type": "Number"

69881

},

69882

{

69883

"name": "yRadius",

69884

"description": "[optional] y radius for wedge.",

69885

"type": "Number"

69886

}

69887

],

69888

"access": "private",

69889

"tagname": "",

69890

"class": "SVGDrawing",

69891

"module": "graphics"

69892

},

69893

{

69894

"file": "graphics/js/SVGDrawing.js",

69895

"line": 320,

69896

"description": "Draws a line segment using the current line style from the current drawing position to the specified x and y coordinates.",

69897

"itemtype": "method",

69898

"name": "lineTo",

69899

"params": [

69900

{

69901

"name": "point1",

69902

"description": "x-coordinate for the end point.",

69903

"type": "Number"

69904

},

69905

{

69906

"name": "point2",

69907

"description": "y-coordinate for the end point.",

69908

"type": "Number"

69909

}

69910

],

69911

"class": "SVGDrawing",

69912

"module": "graphics"

69913

},

69914

{

69915

"file": "graphics/js/SVGDrawing.js",

69916

"line": 368,

69917

"description": "Moves the current drawing position to specified x and y coordinates.",

69918

"itemtype": "method",

69919

"name": "moveTo",

69920

"params": [

69921

{

69922

"name": "x",

69923

"description": "x-coordinate for the end point.",

69924

"type": "Number"

69925

},

69926

{

69927

"name": "y",

69928

"description": "y-coordinate for the end point.",

69929

"type": "Number"

69930

}

69931

],

69932

"class": "SVGDrawing",

69933

"module": "graphics"

69934

},

69935

{

69936

"file": "graphics/js/SVGDrawing.js",

69937

"line": 387,

69938

"description": "Completes a drawing operation.",

69939

"itemtype": "method",

69940

"name": "end",

69941

"class": "SVGDrawing",

69942

"module": "graphics"

69943

},

69944

{

69945

"file": "graphics/js/SVGDrawing.js",

69946

"line": 398,

69947

"description": "Clears the path.",

69948

"itemtype": "method",

69949

"name": "clear",

69950

"class": "SVGDrawing",

69951

"module": "graphics"

69952

},

69953

{

69954

"file": "graphics/js/SVGDrawing.js",

69955

"line": 415,

69956

"description": "Draws the path.",

69957

"itemtype": "method",

69958

"name": "_closePath",

69959

"access": "private",

69960

"tagname": "",

69961

"class": "SVGDrawing",

69962

"module": "graphics"

69963

},

69964

{

69965

"file": "graphics/js/SVGDrawing.js",

69966

"line": 500,

69967

"description": "Ends a fill and stroke",

69968

"itemtype": "method",

69969

"name": "closePath",

69970

"class": "SVGDrawing",

69971

"module": "graphics"

69972

},

69973

{

69974

"file": "graphics/js/SVGDrawing.js",

69975

"line": 510,

69976

"description": "Updates the size of the graphics object",

69977

"itemtype": "method",

69978

"name": "_trackSize",

69979

"params": [

69980

{

69981

"name": "w",

69982

"description": "width",

69983

"type": "Number"

69984

},

69985

{

69986

"name": "h",

69987

"description": "height",

69988

"type": "Number"

69989

}

69990

],

69991

"access": "private",

69992

"tagname": "",

69993

"class": "SVGDrawing",

69994

"module": "graphics"

69995

},

69996

{

69997

"file": "graphics/js/SVGEllipse.js",

69998

"line": 19,

69999

"description": "Indicates the type of shape",

70000

"itemtype": "property",

70001

"name": "_type",

70002

"type": "String",

70003

"access": "private",

70004

"tagname": "",

70005

"class": "SVGEllipse",

70006

"module": "graphics"

70007

},

70008

{

70009

"file": "graphics/js/SVGEllipse.js",

70010

"line": 28,

70011

"description": "Updates the shape.",

70012

"itemtype": "method",

70013

"name": "_draw",

70014

"access": "private",

70015

"tagname": "",

70016

"class": "SVGEllipse",

70017

"module": "graphics"

70018

},

70019

{

70020

"file": "graphics/js/SVGGraphic.js",

70021

"line": 18,

70022

"description": "Whether or not to render the `Graphic` automatically after to a specified parent node after init. This can be a Node instance or a CSS selector string.",

70023

"itemtype": "config",

70024

"name": "render",

70025

"type": "Node | String",

70026

"class": "SVGGraphic",

70027

"module": "graphics"

70028

},

70029

{

70030

"file": "graphics/js/SVGGraphic.js",

70031

"line": 26,

70032

"description": "Unique id for class instance.",

70033

"itemtype": "config",

70034

"name": "id",

70035

"type": "String",

70036

"class": "SVGGraphic",

70037

"module": "graphics"

70038

},

70039

{

70040

"file": "graphics/js/SVGGraphic.js",

70041

"line": 49,

70042

"description": "Key value pairs in which a shape instance is associated with its id.",

70043

"itemtype": "config",

70044

"name": "shapes",

70045

"type": "Object",

70046

"readonly": "",

70047

"class": "SVGGraphic",

70048

"module": "graphics"

70049

},

70050

{

70051

"file": "graphics/js/SVGGraphic.js",

70052

"line": 65,

70053

"description": "Object containing size and coordinate data for the content of a Graphic in relation to the coordSpace node.",

70054

"itemtype": "config",

70055

"name": "contentBounds",

70056

"type": "Object",

70057

"readonly": "",

70058

"class": "SVGGraphic",

70059

"module": "graphics"

70060

},

70061

{

70062

"file": "graphics/js/SVGGraphic.js",

70063

"line": 81,

70064

"description": "The html element that represents to coordinate system of the Graphic instance.",

70065

"itemtype": "config",

70066

"name": "node",

70067

"type": "HTMLElement",

70068

"readonly": "",

70069

"class": "SVGGraphic",

70070

"module": "graphics"

70071

},

70072

{

70073

"file": "graphics/js/SVGGraphic.js",

70074

"line": 97,

70075

"description": "Indicates the width of the `Graphic`.",

70076

"itemtype": "config",

70077

"name": "width",

70078

"type": "Number",

70079

"class": "SVGGraphic",

70080

"module": "graphics"

70081

},

70082

{

70083

"file": "graphics/js/SVGGraphic.js",

70084

"line": 114,

70085

"description": "Indicates the height of the `Graphic`.",

70086

"itemtype": "config",

70087

"name": "height",

70088

"type": "Number",

70089

"class": "SVGGraphic",

70090

"module": "graphics"

70091

},

70092

{

70093

"file": "graphics/js/SVGGraphic.js",

70094

"line": 131,

70095

"description": "Determines how the size of instance is calculated. If true, the width and height are determined by the size of the contents.\nIf false, the width and height values are either explicitly set or determined by the size of the parent node's dimensions.",

70096

"itemtype": "config",

70097

"name": "autoSize",

70098

"type": "Boolean",

70099

"default": "false",

70100

"class": "SVGGraphic",

70101

"module": "graphics"

70102

},

70103

{

70104

"file": "graphics/js/SVGGraphic.js",

70105

"line": 143,

70106

"description": "The contentBounds will resize to greater values but not to smaller values. (for performance)\nWhen resizing the contentBounds down is desirable, set the resizeDown value to true.",

70107

"itemtype": "config",

70108

"name": "resizeDown",

70109

"type": "Boolean",

70110

"class": "SVGGraphic",

70111

"module": "graphics"

70112

},

70113

{

70114

"file": "graphics/js/SVGGraphic.js",

70115

"line": 167,

70116

"description": "Indicates the x-coordinate for the instance.",

70117

"itemtype": "config",

70118

"name": "x",

70119

"type": "Number",

70120

"class": "SVGGraphic",

70121

"module": "graphics"

70122

},

70123

{

70124

"file": "graphics/js/SVGGraphic.js",

70125

"line": 190,

70126

"description": "Indicates the y-coordinate for the instance.",

70127

"itemtype": "config",

70128

"name": "y",

70129

"type": "Number",

70130

"class": "SVGGraphic",

70131

"module": "graphics"

70132

},

70133

{

70134

"file": "graphics/js/SVGGraphic.js",

70135

"line": 213,

70136

"description": "Indicates whether or not the instance will automatically redraw after a change is made to a shape.\nThis property will get set to false when batching operations.",

70137

"itemtype": "config",

70138

"name": "autoDraw",

70139

"type": "Boolean",

70140

"default": "true",

70141

"access": "private",

70142

"tagname": "",

70143

"class": "SVGGraphic",

70144

"module": "graphics"

70145

},

70146

{

70147

"file": "graphics/js/SVGGraphic.js",

70148

"line": 248,

70149

"description": "Storage for `x` attribute.",

70150

"itemtype": "property",

70151

"name": "_x",

70152

"type": "Number",

70153

"access": "private",

70154

"tagname": "",

70155

"class": "SVGGraphic",

70156

"module": "graphics"

70157

},

70158

{

70159

"file": "graphics/js/SVGGraphic.js",

70160

"line": 257,

70161

"description": "Storage for `y` attribute.",

70162

"itemtype": "property",

70163

"name": "_y",

70164

"type": "Number",

70165

"access": "private",

70166

"tagname": "",

70167

"class": "SVGGraphic",

70168

"module": "graphics"

70169

},

70170

{

70171

"file": "graphics/js/SVGGraphic.js",

70172

"line": 266,

70173

"description": "Gets the current position of the graphic instance in page coordinates.",

70174

"itemtype": "method",

70175

"name": "getXY",

70176

"return": {

70177

"description": "Array The XY position of the shape."

70178

},

70179

"class": "SVGGraphic",

70180

"module": "graphics"

70181

},

70182

{

70183

"file": "graphics/js/SVGGraphic.js",

70184

"line": 283,

70185

"access": "private",

70186

"tagname": "",

70187

"itemtype": "property",

70188

"name": "_resizeDown",

70189

"type": "Boolean",

70190

"class": "SVGGraphic",

70191

"module": "graphics"

70192

},

70193

{

70194

"file": "graphics/js/SVGGraphic.js",

70195

"line": 290,

70196

"description": "Initializes the class.",

70197

"itemtype": "method",

70198

"name": "initializer",

70199

"access": "private",

70200

"tagname": "",

70201

"class": "SVGGraphic",

70202

"module": "graphics"

70203

},

70204

{

70205

"file": "graphics/js/SVGGraphic.js",

70206

"line": 319,

70207

"description": "Adds the graphics node to the dom.",

70208

"itemtype": "method",

70209

"name": "render",

70210

"params": [

70211

{

70212

"name": "parentNode",

70213

"description": "node in which to render the graphics node into.",

70214

"type": "HTMLElement"

70215

}

70216

],

70217

"class": "SVGGraphic",

70218

"module": "graphics"

70219

},

70220

{

70221

"file": "graphics/js/SVGGraphic.js",

70222

"line": 337,

70223

"description": "Removes all nodes.",

70224

"itemtype": "method",

70225

"name": "destroy",

70226

"class": "SVGGraphic",

70227

"module": "graphics"

70228

},

70229

{

70230

"file": "graphics/js/SVGGraphic.js",

70231

"line": 362,

70232

"description": "Generates a shape instance by type.",

70233

"itemtype": "method",

70234

"name": "addShape",

70235

"params": [

70236

{

70237

"name": "cfg",

70238

"description": "attributes for the shape",

70239

"type": "Object"

70240

}

70241

],

70242

"return": {

70243

"description": "Shape"

70244

},

70245

"class": "SVGGraphic",

70246

"module": "graphics"

70247

},

70248

{

70249

"file": "graphics/js/SVGGraphic.js",

70250

"line": 378,

70251

"description": "Adds a shape instance to the graphic instance.",

70252

"itemtype": "method",

70253

"name": "_appendShape",

70254

"params": [

70255

{

70256

"name": "shape",

70257

"description": "The shape instance to be added to the graphic.",

70258

"type": "Shape"

70259

}

70260

],

70261

"access": "private",

70262

"tagname": "",

70263

"class": "SVGGraphic",

70264

"module": "graphics"

70265

},

70266

{

70267

"file": "graphics/js/SVGGraphic.js",

70268

"line": 399,

70269

"description": "Removes a shape instance from from the graphic instance.",

70270

"itemtype": "method",

70271

"name": "removeShape",

70272

"params": [

70273

{

70274

"name": "shape",

70275

"description": "The instance or id of the shape to be removed.",

70276

"type": "Shape|String"

70277

}

70278

],

70279

"class": "SVGGraphic",

70280

"module": "graphics"

70281

},

70282

{

70283

"file": "graphics/js/SVGGraphic.js",

70284

"line": 426,

70285

"description": "Removes all shape instances from the dom.",

70286

"itemtype": "method",

70287

"name": "removeAllShapes",

70288

"class": "SVGGraphic",

70289

"module": "graphics"

70290

},

70291

{

70292

"file": "graphics/js/SVGGraphic.js",

70293

"line": 445,

70294

"description": "Removes all child nodes.",

70295

"itemtype": "method",

70296

"name": "_removeChildren",

70297

"params": [

70298

{

70299

"name": "node",

70300

"description": "",

70301

"type": "HTMLElement"

70302

}

70303

],

70304

"access": "private",

70305

"tagname": "",

70306

"class": "SVGGraphic",

70307

"module": "graphics"

70308

},

70309

{

70310

"file": "graphics/js/SVGGraphic.js",

70311

"line": 466,

70312

"description": "Clears the graphics object.",

70313

"itemtype": "method",

70314

"name": "clear",

70315

"class": "SVGGraphic",

70316

"module": "graphics"

70317

},

70318

{

70319

"file": "graphics/js/SVGGraphic.js",

70320

"line": 475,

70321

"description": "Toggles visibility",

70322

"itemtype": "method",

70323

"name": "_toggleVisible",

70324

"params": [

70325

{

70326

"name": "val",

70327

"description": "indicates visibilitye",

70328

"type": "Boolean"

70329

}

70330

],

70331

"access": "private",

70332

"tagname": "",

70333

"class": "SVGGraphic",

70334

"module": "graphics"

70335

},

70336

{

70337

"file": "graphics/js/SVGGraphic.js",

70338

"line": 501,

70339

"description": "Returns a shape class. Used by `addShape`.",

70340

"itemtype": "method",

70341

"name": "_getShapeClass",

70342

"params": [

70343

{

70344

"name": "val",

70345

"description": "Indicates which shape class.",

70346

"type": "Shape | String"

70347

}

70348

],

70349

"return": {

70350

"description": "Function"

70351

},

70352

"access": "private",

70353

"tagname": "",

70354

"class": "SVGGraphic",

70355

"module": "graphics"

70356

},

70357

{

70358

"file": "graphics/js/SVGGraphic.js",

70359

"line": 519,

70360

"description": "Look up for shape classes. Used by `addShape` to retrieve a class for instantiation.",

70361

"itemtype": "property",

70362

"name": "_shapeClass",

70363

"type": "Object",

70364

"access": "private",

70365

"tagname": "",

70366

"class": "SVGGraphic",

70367

"module": "graphics"

70368

},

70369

{

70370

"file": "graphics/js/SVGGraphic.js",

70371

"line": 534,

70372

"description": "Returns a shape based on the id of its dom node.",

70373

"itemtype": "method",

70374

"name": "getShapeById",

70375

"params": [

70376

{

70377

"name": "id",

70378

"description": "Dom id of the shape's node attribute.",

70379

"type": "String"

70380

}

70381

],

70382

"return": {

70383

"description": "Shape"

70384

},

70385

"class": "SVGGraphic",

70386

"module": "graphics"

70387

},

70388

{

70389

"file": "graphics/js/SVGGraphic.js",

70390

"line": 547,

70391

"description": "Allows for creating multiple shapes in order to batch appending and redraw operations.",

70392

"itemtype": "method",

70393

"name": "batch",

70394

"params": [

70395

{

70396

"name": "method",

70397

"description": "Method to execute.",

70398

"type": "Function"

70399

}

70400

],

70401

"class": "SVGGraphic",

70402

"module": "graphics"

70403

},

70404

{

70405

"file": "graphics/js/SVGGraphic.js",

70406

"line": 562,

70407

"description": "Returns a document fragment to for attaching shapes.",

70408

"itemtype": "method",

70409

"name": "_getDocFrag",

70410

"return": {

70411

"description": "DocumentFragment"

70412

},

70413

"access": "private",

70414

"tagname": "",

70415

"class": "SVGGraphic",

70416

"module": "graphics"

70417

},

70418

{

70419

"file": "graphics/js/SVGGraphic.js",

70420

"line": 578,

70421

"description": "Redraws all shapes.",

70422

"itemtype": "method",

70423

"name": "_redraw",

70424

"access": "private",

70425

"tagname": "",

70426

"class": "SVGGraphic",

70427

"module": "graphics"

70428

},

70429

{

70430

"file": "graphics/js/SVGGraphic.js",

70431

"line": 612,

70432

"description": "Adds a shape to the redraw queue and calculates the contentBounds. Used internally \nby `Shape` instances.",

70433

"itemtype": "method",

70434

"name": "addToRedrawQueue",

70435

"params": [

70436

{

70437

"name": "shape",

70438

"description": "",

70439

"type": "SVGShape"

70440

}

70441

],

70442

"access": "protected",

70443

"tagname": "",

70444

"class": "SVGGraphic",

70445

"module": "graphics"

70446

},

70447

{

70448

"file": "graphics/js/SVGGraphic.js",

70449

"line": 643,

70450

"description": "Recalculates and returns the `contentBounds` for the `Graphic` instance.",

70451

"itemtype": "method",

70452

"name": "_getUpdatedContentBounds",

70453

"return": {

70454

"description": "",

70455

"type": "Object"

70456

},

70457

"access": "private",

70458

"tagname": "",

70459

"class": "SVGGraphic",

70460

"module": "graphics"

70461

},

70462

{

70463

"file": "graphics/js/SVGGraphic.js",

70464

"line": 680,

70465

"description": "Creates a contentNode element",

70466

"itemtype": "method",

70467

"name": "_createGraphics",

70468

"access": "private",

70469

"tagname": "",

70470

"class": "SVGGraphic",

70471

"module": "graphics"

70472

},

70473

{

70474

"file": "graphics/js/SVGGraphic.js",

70475

"line": 698,

70476

"description": "Creates a graphic node",

70477

"itemtype": "method",

70478

"name": "_createGraphicNode",

70479

"params": [

70480

{

70481

"name": "type",

70482

"description": "node type to create",

70483

"type": "String"

70484

},

70485

{

70486

"name": "pe",

70487

"description": "specified pointer-events value",

70488

"type": "String"

70489

}

70490

],

70491

"return": {

70492

"description": "HTMLElement"

70493

},

70494

"access": "private",

70495

"tagname": "",

70496

"class": "SVGGraphic",

70497

"module": "graphics"

70498

},

70499

{

70500

"file": "graphics/js/SVGGraphic.js",

70501

"line": 718,

70502

"description": "Returns a reference to a gradient definition based on an id and type.",

70503

"itemtype": "method",

70504

"name": "getGradientNode",

70505

"params": [

70506

{

70507

"name": "key",

70508

"description": "id that references the gradient definition",

70509

"type": "String"

70510

},

70511

{

70512

"name": "type",

70513

"description": "description of the gradient type",

70514

"type": "String"

70515

}

70516

],

70517

"return": {

70518

"description": "HTMLElement"

70519

},

70520

"access": "protected",

70521

"tagname": "",

70522

"class": "SVGGraphic",

70523

"module": "graphics"

70524

},

70525

{

70526

"file": "graphics/js/SVGPath.js",

70527

"line": 18,

70528

"description": "Left edge of the path",

70529

"itemtype": "property",

70530

"name": "_left",

70531

"type": "Number",

70532

"access": "private",

70533

"tagname": "",

70534

"class": "SVGPath",

70535

"module": "graphics"

70536

},

70537

{

70538

"file": "graphics/js/SVGPath.js",

70539

"line": 27,

70540

"description": "Right edge of the path",

70541

"itemtype": "property",

70542

"name": "_right",

70543

"type": "Number",

70544

"access": "private",

70545

"tagname": "",

70546

"class": "SVGPath",

70547

"module": "graphics"

70548

},

70549

{

70550

"file": "graphics/js/SVGPath.js",

70551

"line": 36,

70552

"description": "Top edge of the path",

70553

"itemtype": "property",

70554

"name": "_top",

70555

"type": "Number",

70556

"access": "private",

70557

"tagname": "",

70558

"class": "SVGPath",

70559

"module": "graphics"

70560

},

70561

{

70562

"file": "graphics/js/SVGPath.js",

70563

"line": 45,

70564

"description": "Bottom edge of the path",

70565

"itemtype": "property",

70566

"name": "_bottom",

70567

"type": "Number",

70568

"access": "private",

70569

"tagname": "",

70570

"class": "SVGPath",

70571

"module": "graphics"

70572

},

70573

{

70574

"file": "graphics/js/SVGPath.js",

70575

"line": 54,

70576

"description": "Indicates the type of shape",

70577

"itemtype": "property",

70578

"name": "_type",

70579

"readonly": "",

70580

"type": "String",

70581

"access": "private",

70582

"tagname": "",

70583

"class": "SVGPath",

70584

"module": "graphics"

70585

},

70586

{

70587

"file": "graphics/js/SVGPath.js",

70588

"line": 64,

70589

"description": "Storage for path",

70590

"itemtype": "property",

70591

"name": "_path",

70592

"type": "String",

70593

"access": "private",

70594

"tagname": "",

70595

"class": "SVGPath",

70596

"module": "graphics"

70597

},

70598

{

70599

"file": "graphics/js/SVGPath.js",

70600

"line": 75,

70601

"description": "Indicates the path used for the node.",

70602

"itemtype": "config",

70603

"name": "path",

70604

"type": "String",

70605

"readonly": "",

70606

"class": "SVGPath",

70607

"module": "graphics"

70608

},

70609

{

70610

"file": "graphics/js/SVGPath.js",

70611

"line": 91,

70612

"description": "Indicates the width of the shape",

70613

"itemtype": "config",

70614

"name": "width",

70615

"type": "Number",

70616

"class": "SVGPath",

70617

"module": "graphics"

70618

},

70619

{

70620

"file": "graphics/js/SVGPath.js",

70621

"line": 105,

70622

"description": "Indicates the height of the shape",

70623

"itemtype": "config",

70624

"name": "height",

70625

"type": "Number",

70626

"class": "SVGPath",

70627

"module": "graphics"

70628

},

70629

{

70630

"file": "graphics/js/SVGPieSlice.js",

70631

"line": 14,

70632

"description": "Indicates the type of shape",

70633

"itemtype": "property",

70634

"name": "_type",

70635

"type": "String",

70636

"access": "private",

70637

"tagname": "",

70638

"class": "SVGPieSlice",

70639

"module": "graphics"

70640

},

70641

{

70642

"file": "graphics/js/SVGPieSlice.js",

70643

"line": 23,

70644

"description": "Change event listener",

70645

"access": "private",

70646

"tagname": "",

70647

"itemtype": "method",

70648

"name": "_updateHandler",

70649

"class": "SVGPieSlice",

70650

"module": "graphics"

70651

},

70652

{

70653

"file": "graphics/js/SVGPieSlice.js",

70654

"line": 49,

70655

"description": "Starting angle in relation to a circle in which to begin the pie slice drawing.",

70656

"itemtype": "config",

70657

"name": "startAngle",

70658

"type": "Number",

70659

"class": "SVGPieSlice",

70660

"module": "graphics"

70661

},

70662

{

70663

"file": "graphics/js/SVGPieSlice.js",

70664

"line": 59,

70665

"description": "Arc of the slice.",

70666

"itemtype": "config",

70667

"name": "arc",

70668

"type": "Number",

70669

"class": "SVGPieSlice",

70670

"module": "graphics"

70671

},

70672

{

70673

"file": "graphics/js/SVGPieSlice.js",

70674

"line": 69,

70675

"description": "Radius of the circle in which the pie slice is drawn",

70676

"itemtype": "config",

70677

"name": "radius",

70678

"type": "Number",

70679

"class": "SVGPieSlice",

70680

"module": "graphics"

70681

},

70682

{

70683

"file": "graphics/js/SVGRect.js",

70684

"line": 17,

70685

"description": "Indicates the type of shape",

70686

"itemtype": "property",

70687

"name": "_type",

70688

"type": "String",

70689

"access": "private",

70690

"tagname": "",

70691

"class": "SVGRect",

70692

"module": "graphics"

70693

},

70694

{

70695

"file": "graphics/js/SVGShape.js",

70696

"line": 23,

70697

"description": "Init method, invoked during construction.\nCalls `initializer` method.",

70698

"itemtype": "method",

70699

"name": "init",

70700

"access": "protected",

70701

"tagname": "",

70702

"class": "SVGShape",

70703

"module": "graphics"

70704

},

70705

{

70706

"file": "graphics/js/SVGShape.js",

70707

"line": 35,

70708

"description": "Initializes the shape",

70709

"access": "private",

70710

"tagname": "",

70711

"itemtype": "method",

70712

"name": "initializer",

70713

"class": "SVGShape",

70714

"module": "graphics"

70715

},

70716

{

70717

"file": "graphics/js/SVGShape.js",

70718

"line": 53,

70719

"description": "Set the Graphic instance for the shape.",

70720

"itemtype": "method",

70721

"name": "_setGraphic",

70722

"params": [

70723

{

70724

"name": "render",

70725

"description": "This param is used to determine the graphic instance. If it is a `Graphic` instance, it will be assigned\nto the `graphic` attribute. Otherwise, a new Graphic instance will be created and rendered into the dom element that the render represents.",

70726

"type": "Graphic | Node | HTMLElement | String"

70727

}

70728

],

70729

"access": "private",

70730

"tagname": "",

70731

"class": "SVGShape",

70732

"module": "graphics"

70733

},

70734

{

70735

"file": "graphics/js/SVGShape.js",

70736

"line": 79,

70737

"description": "Add a class name to each node.",

70738

"itemtype": "method",

70739

"name": "addClass",

70740

"params": [

70741

{

70742

"name": "className",

70743

"description": "the class name to add to the node's class attribute",

70744

"type": "String"

70745

}

70746

],

70747

"class": "SVGShape",

70748

"module": "graphics"

70749

},

70750

{

70751

"file": "graphics/js/SVGShape.js",

70752

"line": 91,

70753

"description": "Removes a class name from each node.",

70754

"itemtype": "method",

70755

"name": "removeClass",

70756

"params": [

70757

{

70758

"name": "className",

70759

"description": "the class name to remove from the node's class attribute",

70760

"type": "String"

70761

}

70762

],

70763

"class": "SVGShape",

70764

"module": "graphics"

70765

},

70766

{

70767

"file": "graphics/js/SVGShape.js",

70768

"line": 105,

70769

"description": "Gets the current position of the node in page coordinates.",

70770

"itemtype": "method",

70771

"name": "getXY",

70772

"return": {

70773

"description": "Array The XY position of the shape."

70774

},

70775

"class": "SVGShape",

70776

"module": "graphics"

70777

},

70778

{

70779

"file": "graphics/js/SVGShape.js",

70780

"line": 120,

70781

"description": "Set the position of the shape in page coordinates, regardless of how the node is positioned.",

70782

"itemtype": "method",

70783

"name": "setXY",

70784

"params": [

70785

{

70786

"name": "Contains",

70787

"description": "x & y values for new position (coordinates are page-based)",

70788

"type": "Array"

70789

}

70790

],

70791

"class": "SVGShape",

70792

"module": "graphics"

70793

},

70794

{

70795

"file": "graphics/js/SVGShape.js",

70796

"line": 134,

70797

"description": "Determines whether the node is an ancestor of another HTML element in the DOM hierarchy.",

70798

"itemtype": "method",

70799

"name": "contains",

70800

"params": [

70801

{

70802

"name": "needle",

70803

"description": "The possible node or descendent",

70804

"type": "SVGShape | HTMLElement"

70805

}

70806

],

70807

"return": {

70808

"description": "Boolean Whether or not this shape is the needle or its ancestor."

70809

},

70810

"class": "SVGShape",

70811

"module": "graphics"

70812

},

70813

{

70814

"file": "graphics/js/SVGShape.js",

70815

"line": 146,

70816

"description": "Compares nodes to determine if they match.\nNode instances can be compared to each other and/or HTMLElements.",

70817

"itemtype": "method",

70818

"name": "compareTo",

70819

"params": [

70820

{

70821

"name": "refNode",

70822

"description": "The reference node to compare to the node.",

70823

"type": "HTMLElement | Node"

70824

}

70825

],

70826

"return": {

70827

"description": "True if the nodes match, false if they do not.",

70828

"type": "Boolean"

70829

},

70830

"class": "SVGShape",

70831

"module": "graphics"

70832

},

70833

{

70834

"file": "graphics/js/SVGShape.js",

70835

"line": 159,

70836

"description": "Test if the supplied node matches the supplied selector.",

70837

"itemtype": "method",

70838

"name": "test",

70839

"params": [

70840

{

70841

"name": "selector",

70842

"description": "The CSS selector to test against.",

70843

"type": "String"

70844

}

70845

],

70846

"return": {

70847

"description": "Boolean Wheter or not the shape matches the selector."

70848

},

70849

"class": "SVGShape",

70850

"module": "graphics"

70851

},

70852

{

70853

"file": "graphics/js/SVGShape.js",

70854

"line": 171,

70855

"description": "Value function for fill attribute",

70856

"access": "private",

70857

"tagname": "",

70858

"itemtype": "method",

70859

"name": "_getDefaultFill",

70860

"return": {

70861

"description": "Object"

70862

},

70863

"class": "SVGShape",

70864

"module": "graphics"

70865

},

70866

{

70867

"file": "graphics/js/SVGShape.js",

70868

"line": 190,

70869

"description": "Value function for stroke attribute",

70870

"access": "private",

70871

"tagname": "",

70872

"itemtype": "method",

70873

"name": "_getDefaultStroke",

70874

"return": {

70875

"description": "Object"

70876

},

70877

"class": "SVGShape",

70878

"module": "graphics"

70879

},

70880

{

70881

"file": "graphics/js/SVGShape.js",

70882

"line": 207,

70883

"description": "Creates the dom node for the shape.",

70884

"itemtype": "method",

70885

"name": "createNode",

70886

"return": {

70887

"description": "HTMLElement"

70888

},

70889

"access": "private",

70890

"tagname": "",

70891

"class": "SVGShape",

70892

"module": "graphics"

70893

},

70894

{

70895

"file": "graphics/js/SVGShape.js",

70896

"line": 236,

70897

"description": "Overrides default `on` method. Checks to see if its a dom interaction event. If so, \nreturn an event attached to the `node` element. If not, return the normal functionality.",

70898

"itemtype": "method",

70899

"name": "on",

70900

"params": [

70901

{

70902

"name": "type",

70903

"description": "event type",

70904

"type": "String"

70905

},

70906

{

70907

"name": "callback",

70908

"description": "function",

70909

"type": "Object"

70910

}

70911

],

70912

"access": "private",

70913

"tagname": "",

70914

"class": "SVGShape",

70915

"module": "graphics"

70916

},

70917

{

70918

"file": "graphics/js/SVGShape.js",

70919

"line": 254,

70920

"description": "Adds a stroke to the shape node.",

70921

"itemtype": "method",

70922

"name": "_strokeChangeHandler",

70923

"access": "private",

70924

"tagname": "",

70925

"class": "SVGShape",

70926

"module": "graphics"

70927

},

70928

{

70929

"file": "graphics/js/SVGShape.js",

70930

"line": 303,

70931

"description": "Adds a fill to the shape node.",

70932

"itemtype": "method",

70933

"name": "_fillChangeHandler",

70934

"access": "private",

70935

"tagname": "",

70936

"class": "SVGShape",

70937

"module": "graphics"

70938

},

70939

{

70940

"file": "graphics/js/SVGShape.js",

70941

"line": 341,

70942

"description": "Creates a gradient fill",

70943

"itemtype": "method",

70944

"name": "_setGradientFill",

70945

"params": [

70946

{

70947

"name": "type",

70948

"description": "gradient type",

70949

"type": "String"

70950

}

70951

],

70952

"access": "private",

70953

"tagname": "",

70954

"class": "SVGShape",

70955

"module": "graphics"

70956

},

70957

{

70958

"file": "graphics/js/SVGShape.js",

70959

"line": 469,

70960

"description": "Sets the value of an attribute.",

70961

"itemtype": "method",

70962

"name": "set",

70963

"params": [

70964

{

70965

"name": "name",

70966

"description": "The name of the attribute. Alternatively, an object of key value pairs can \nbe passed in to set multiple attributes at once.",

70967

"type": "String|Object"

70968

},

70969

{

70970

"name": "value",

70971

"description": "The value to set the attribute to. This value is ignored if an object is received as \nthe name param.",

70972

"type": "Any"

70973

}

70974

],

70975

"class": "SVGShape",

70976

"module": "graphics"

70977

},

70978

{

70979

"file": "graphics/js/SVGShape.js",

70980

"line": 488,

70981

"description": "Specifies a 2d translation.",

70982

"itemtype": "method",

70983

"name": "translate",

70984

"params": [

70985

{

70986

"name": "x",

70987

"description": "The value to transate on the x-axis.",

70988

"type": "Number"

70989

},

70990

{

70991

"name": "y",

70992

"description": "The value to translate on the y-axis.",

70993

"type": "Number"

70994

}

70995

],

70996

"class": "SVGShape",

70997

"module": "graphics"

70998

},

70999

{

71000

"file": "graphics/js/SVGShape.js",

71001

"line": 500,

71002

"description": "Translates the shape along the x-axis. When translating x and y coordinates,\nuse the `translate` method.",

71003

"itemtype": "method",

71004

"name": "translateX",

71005

"params": [

71006

{

71007

"name": "x",

71008

"description": "The value to translate.",

71009

"type": "Number"

71010

}

71011

],

71012

"class": "SVGShape",

71013

"module": "graphics"

71014

},

71015

{

71016

"file": "graphics/js/SVGShape.js",

71017

"line": 512,

71018

"description": "Translates the shape along the y-axis. When translating x and y coordinates,\nuse the `translate` method.",

71019

"itemtype": "method",

71020

"name": "translateY",

71021

"params": [

71022

{

71023

"name": "y",

71024

"description": "The value to translate.",

71025

"type": "Number"

71026

}

71027

],

71028

"class": "SVGShape",

71029

"module": "graphics"

71030

},

71031

{

71032

"file": "graphics/js/SVGShape.js",

71033

"line": 524,

71034

"description": "Skews the shape around the x-axis and y-axis.",

71035

"itemtype": "method",

71036

"name": "skew",

71037

"params": [

71038

{

71039

"name": "x",

71040

"description": "The value to skew on the x-axis.",

71041

"type": "Number"

71042

},

71043

{

71044

"name": "y",

71045

"description": "The value to skew on the y-axis.",

71046

"type": "Number"

71047

}

71048

],

71049

"class": "SVGShape",

71050

"module": "graphics"

71051

},

71052

{

71053

"file": "graphics/js/SVGShape.js",

71054

"line": 536,

71055

"description": "Skews the shape around the x-axis.",

71056

"itemtype": "method",

71057

"name": "skewX",

71058

"params": [

71059

{

71060

"name": "x",

71061

"description": "x-coordinate",

71062

"type": "Number"

71063

}

71064

],

71065

"class": "SVGShape",

71066

"module": "graphics"

71067

},

71068

{

71069

"file": "graphics/js/SVGShape.js",

71070

"line": 547,

71071

"description": "Skews the shape around the y-axis.",

71072

"itemtype": "method",

71073

"name": "skewY",

71074

"params": [

71075

{

71076

"name": "y",

71077

"description": "y-coordinate",

71078

"type": "Number"

71079

}

71080

],

71081

"class": "SVGShape",

71082

"module": "graphics"

71083

},

71084

{

71085

"file": "graphics/js/SVGShape.js",

71086

"line": 558,

71087

"description": "Rotates the shape clockwise around it transformOrigin.",

71088

"itemtype": "method",

71089

"name": "rotate",

71090

"params": [

71091

{

71092

"name": "deg",

71093

"description": "The degree of the rotation.",

71094

"type": "Number"

71095

}

71096

],

71097

"class": "SVGShape",

71098

"module": "graphics"

71099

},

71100

{

71101

"file": "graphics/js/SVGShape.js",

71102

"line": 569,

71103

"description": "Specifies a 2d scaling operation.",

71104

"itemtype": "method",

71105

"name": "scale",

71106

"params": [

71107

{

71108

"name": "val",

71109

"description": "",

71110

"type": "Number"

71111

}

71112

],

71113

"class": "SVGShape",

71114

"module": "graphics"

71115

},

71116

{

71117

"file": "graphics/js/SVGShape.js",

71118

"line": 580,

71119

"description": "Adds a transform to the shape.",

71120

"itemtype": "method",

71121

"name": "_addTransform",

71122

"params": [

71123

{

71124

"name": "type",

71125

"description": "The transform being applied.",

71126

"type": "String"

71127

},

71128

{

71129

"name": "args",

71130

"description": "The arguments for the transform.",

71131

"type": "Array"

71132

}

71133

],

71134

"access": "private",

71135

"tagname": "",

71136

"class": "SVGShape",

71137

"module": "graphics"

71138

},

71139

{

71140

"file": "graphics/js/SVGShape.js",

71141

"line": 600,

71142

"description": "Applies all transforms.",

71143

"itemtype": "method",

71144

"name": "_updateTransform",

71145

"access": "private",

71146

"tagname": "",

71147

"class": "SVGShape",

71148

"module": "graphics"

71149

},

71150

{

71151

"file": "graphics/js/SVGShape.js",

71152

"line": 673,

71153

"description": "Draws the shape.",

71154

"itemtype": "method",

71155

"name": "_draw",

71156

"access": "private",

71157

"tagname": "",

71158

"class": "SVGShape",

71159

"module": "graphics"

71160

},

71161

{

71162

"file": "graphics/js/SVGShape.js",

71163

"line": 693,

71164

"description": "Updates `Shape` based on attribute changes.",

71165

"itemtype": "method",

71166

"name": "_updateHandler",

71167

"access": "private",

71168

"tagname": "",

71169

"class": "SVGShape",

71170

"module": "graphics"

71171

},

71172

{

71173

"file": "graphics/js/SVGShape.js",

71174

"line": 704,

71175

"description": "Storage for the transform attribute.",

71176

"itemtype": "property",

71177

"name": "_transform",

71178

"type": "String",

71179

"access": "private",

71180

"tagname": "",

71181

"class": "SVGShape",

71182

"module": "graphics"

71183

},

71184

{

71185

"file": "graphics/js/SVGShape.js",

71186

"line": 713,

71187

"description": "Returns the bounds for a shape.\n\nCalculates the a new bounding box from the original corner coordinates (base on size and position) and the transform matrix.\nThe calculated bounding box is used by the graphic instance to calculate its viewBox.",

71188

"itemtype": "method",

71189

"name": "getBounds",

71190

"return": {

71191

"description": "Object"

71192

},

71193

"class": "SVGShape",

71194

"module": "graphics"

71195

},

71196

{

71197

"file": "graphics/js/SVGShape.js",

71198

"line": 742,

71199

"description": "Destroys the shape instance.",

71200

"itemtype": "method",

71201

"name": "destroy",

71202

"class": "SVGShape",

71203

"module": "graphics"

71204

},

71205

{

71206

"file": "graphics/js/SVGShape.js",

71207

"line": 760,

71208

"description": "Implementation for shape destruction",

71209

"itemtype": "method",

71210

"name": "destroy",

71211

"access": "protected",

71212

"tagname": "",

71213

"class": "SVGShape",

71214

"module": "graphics"

71215

},

71216

{

71217

"file": "graphics/js/SVGShape.js",

71218

"line": 781,

71219

"description": "An array of x, y values which indicates the transformOrigin in which to rotate the shape. Valid values range between 0 and 1 representing a \nfraction of the shape's corresponding bounding box dimension. The default value is [0.5, 0.5].",

71220

"itemtype": "config",

71221

"name": "transformOrigin",

71222

"type": "Array",

71223

"class": "SVGShape",

71224

"module": "graphics"

71225

},

71226

{

71227

"file": "graphics/js/SVGShape.js",

71228

"line": 795,

71229

"description": "A string containing, in order, transform operations applied to the shape instance. The `transform` string can contain the following values:\n \n <dl>\n <dt>rotate</dt><dd>Rotates the shape clockwise around it transformOrigin.</dd>\n <dt>translate</dt><dd>Specifies a 2d translation.</dd>\n <dt>skew</dt><dd>Skews the shape around the x-axis and y-axis.</dd>\n <dt>scale</dt><dd>Specifies a 2d scaling operation.</dd>\n <dt>translateX</dt><dd>Translates the shape along the x-axis.</dd>\n <dt>translateY</dt><dd>Translates the shape along the y-axis.</dd>\n <dt>skewX</dt><dd>Skews the shape around the x-axis.</dd>\n <dt>skewY</dt><dd>Skews the shape around the y-axis.</dd>\n <dt>matrix</dt><dd>Specifies a 2D transformation matrix comprised of the specified six values.</dd> \n </dl>\n\nApplying transforms through the transform attribute will reset the transform matrix and apply a new transform. The shape class also contains corresponding methods for each transform\nthat will apply the transform to the current matrix. The below code illustrates how you might use the `transform` attribute to instantiate a recangle with a rotation of 45 degrees.\n var myRect = new Y.Rect({\n type:\"rect\",\n width: 50,\n height: 40,\n transform: \"rotate(45)\"\n };\nThe code below would apply `translate` and `rotate` to an existing shape.\n \n myRect.set(\"transform\", \"translate(40, 50) rotate(45)\");",

71230

"itemtype": "config",

71231

"name": "transform",

71232

"type": "String",

71233

"class": "SVGShape",

71234

"module": "graphics"

71235

},

71236

{

71237

"file": "graphics/js/SVGShape.js",

71238

"line": 840,

71239

"description": "Unique id for class instance.",

71240

"itemtype": "config",

71241

"name": "id",

71242

"type": "String",

71243

"class": "SVGShape",

71244

"module": "graphics"

71245

},

71246

{

71247

"file": "graphics/js/SVGShape.js",

71248

"line": 863,

71249

"description": "Indicates the x position of shape.",

71250

"itemtype": "config",

71251

"name": "x",

71252

"type": "Number",

71253

"class": "SVGShape",

71254

"module": "graphics"

71255

},

71256

{

71257

"file": "graphics/js/SVGShape.js",

71258

"line": 873,

71259

"description": "Indicates the y position of shape.",

71260

"itemtype": "config",

71261

"name": "y",

71262

"type": "Number",

71263

"class": "SVGShape",

71264

"module": "graphics"

71265

},

71266

{

71267

"file": "graphics/js/SVGShape.js",

71268

"line": 883,

71269

"description": "Indicates the width of the shape",

71270

"itemtype": "config",

71271

"name": "width",

71272

"type": "Number",

71273

"class": "SVGShape",

71274

"module": "graphics"

71275

},

71276

{

71277

"file": "graphics/js/SVGShape.js",

71278

"line": 893,

71279

"description": "Indicates the height of the shape",

71280

"itemtype": "config",

71281

"name": "height",

71282

"type": "Number",

71283

"class": "SVGShape",

71284

"module": "graphics"

71285

},

71286

{

71287

"file": "graphics/js/SVGShape.js",

71288

"line": 903,

71289

"description": "Indicates whether the shape is visible.",

71290

"itemtype": "config",

71291

"name": "visible",

71292

"type": "Boolean",

71293

"class": "SVGShape",

71294

"module": "graphics"

71295

},

71296

{

71297

"file": "graphics/js/SVGShape.js",

71298

"line": 922,

71299

"description": "Contains information about the fill of the shape. \n <dl>\n <dt>color</dt><dd>The color of the fill.</dd>\n <dt>opacity</dt><dd>Number between 0 and 1 that indicates the opacity of the fill. The default value is 1.</dd>\n <dt>type</dt><dd>Type of fill.\n <dl>\n <dt>solid</dt><dd>Solid single color fill. (default)</dd>\n <dt>linear</dt><dd>Linear gradient fill.</dd>\n <dt>radial</dt><dd>Radial gradient fill.</dd>\n </dl>\n </dd>\n </dl>\n If a `linear` or `radial` is specified as the fill type. The following additional property is used:\n <dl>\n <dt>stops</dt><dd>An array of objects containing the following properties:\n <dl>\n <dt>color</dt><dd>The color of the stop.</dd>\n <dt>opacity</dt><dd>Number between 0 and 1 that indicates the opacity of the stop. The default value is 1. Note: No effect for IE 6 - 8</dd>\n <dt>offset</dt><dd>Number between 0 and 1 indicating where the color stop is positioned.</dd> \n </dl>\n </dd>\n Linear gradients also have the following property:\n <dt>rotation</dt><dd>Linear gradients flow left to right by default. The rotation property allows you to change the flow by rotation. (e.g. A rotation of 180 would make the gradient pain from right to left.)</dd>\n Radial gradients have the following additional properties:\n <dt>r</dt><dd>Radius of the gradient circle.</dd>\n <dt>fx</dt><dd>Focal point x-coordinate of the gradient.</dd>\n <dt>fy</dt><dd>Focal point y-coordinate of the gradient.</dd>\n <dt>cx</dt><dd>\n The x-coordinate of the center of the gradient circle. Determines where the color stop begins. The default value 0.5.\n Note: Currently, this property is not implemented for corresponding `CanvasShape` and `VMLShape` classes which are used on Android or IE 6 - 8.\n </dd>\n <dt>cy</dt><dd>\n The y-coordinate of the center of the gradient circle. Determines where the color stop begins. The default value 0.5.\n Note: Currently, this property is not implemented for corresponding `CanvasShape` and `VMLShape` classes which are used on Android or IE 6 - 8.\n </dd>\n </dl>",

71300

"itemtype": "config",

71301

"name": "fill",

71302

"type": "Object",

71303

"class": "SVGShape",

71304

"module": "graphics"

71305

},

71306

{

71307

"file": "graphics/js/SVGShape.js",

71308

"line": 982,

71309

"description": "Contains information about the stroke of the shape.\n <dl>\n <dt>color</dt><dd>The color of the stroke.</dd>\n <dt>weight</dt><dd>Number that indicates the width of the stroke.</dd>\n <dt>opacity</dt><dd>Number between 0 and 1 that indicates the opacity of the stroke. The default value is 1.</dd>\n <dt>dashstyle</dt>Indicates whether to draw a dashed stroke. When set to \"none\", a solid stroke is drawn. When set to an array, the first index indicates the\n length of the dash. The second index indicates the length of gap.\n <dt>linecap</dt><dd>Specifies the linecap for the stroke. The following values can be specified:\n <dl>\n <dt>butt (default)</dt><dd>Specifies a butt linecap.</dd>\n <dt>square</dt><dd>Specifies a sqare linecap.</dd>\n <dt>round</dt><dd>Specifies a round linecap.</dd>\n </dl>\n </dd>\n <dt>linejoin</dt><dd>Specifies a linejoin for the stroke. The following values can be specified:\n <dl>\n <dt>round (default)</dt><dd>Specifies that the linejoin will be round.</dd>\n <dt>bevel</dt><dd>Specifies a bevel for the linejoin.</dd>\n <dt>miter limit</dt><dd>An integer specifying the miter limit of a miter linejoin. If you want to specify a linejoin of miter, you simply specify the limit as opposed to having\n separate miter and miter limit values.</dd>\n </dl>\n </dd>\n </dl>",

71310

"itemtype": "config",

71311

"name": "stroke",

71312

"type": "Object",

71313

"class": "SVGShape",

71314

"module": "graphics"

71315

},

71316

{

71317

"file": "graphics/js/SVGShape.js",

71318

"line": 1063,

71319

"description": "The node used for gradient fills.",

71320

"itemtype": "config",

71321

"name": "gradientNode",

71322

"type": "HTMLElement",

71323

"access": "private",

71324

"tagname": "",

71325

"class": "SVGShape",

71326

"module": "graphics"

71327

},

71328

{

71329

"file": "graphics/js/SVGShape.js",

71330

"line": 1089,

71331

"description": "Dom node for the shape.",

71332

"itemtype": "config",

71333

"name": "node",

71334

"type": "HTMLElement",

71335

"readonly": "",

71336

"class": "SVGShape",

71337

"module": "graphics"

71338

},

71339

{

71340

"file": "graphics/js/SVGShape.js",

71341

"line": 1105,

71342

"description": "Reference to the parent graphic instance",

71343

"itemtype": "config",

71344

"name": "graphic",

71345

"type": "SVGGraphic",

71346

"readonly": "",

71347

"class": "SVGShape",

71348

"module": "graphics"

71349

},

71350

{

71351

"file": "graphics/js/VMLCircle.js",

71352

"line": 19,

71353

"description": "Indicates the type of shape",

71354

"itemtype": "property",

71355

"name": "_type",

71356

"type": "String",

71357

"access": "private",

71358

"tagname": "",

71359

"class": "VMLCircle",

71360

"module": "graphics"

71361

},

71362

{

71363

"file": "graphics/js/VMLCircle.js",

71364

"line": 30,

71365

"description": "Radius for the circle.",

71366

"itemtype": "config",

71367

"name": "radius",

71368

"type": "Number",

71369

"class": "VMLCircle",

71370

"module": "graphics"

71371

},

71372

{

71373

"file": "graphics/js/VMLCircle.js",

71374

"line": 42,

71375

"description": "Indicates the width of the shape",

71376

"itemtype": "config",

71377

"name": "width",

71378

"type": "Number",

71379

"class": "VMLCircle",

71380

"module": "graphics"

71381

},

71382

{

71383

"file": "graphics/js/VMLCircle.js",

71384

"line": 63,

71385

"description": "Indicates the height of the shape",

71386

"itemtype": "config",

71387

"name": "height",

71388

"type": "Number",

71389

"class": "VMLCircle",

71390

"module": "graphics"

71391

},

71392

{

71393

"file": "graphics/js/VMLDrawing.js",

71394

"line": 30,

71395

"description": "Current x position of the drqwing.",

71396

"itemtype": "property",

71397

"name": "_currentX",

71398

"type": "Number",

71399

"access": "private",

71400

"tagname": "",

71401

"class": "VMLDrawing",

71402

"module": "graphics"

71403

},

71404

{

71405

"file": "graphics/js/VMLDrawing.js",

71406

"line": 39,

71407

"description": "Current y position of the drqwing.",

71408

"itemtype": "property",

71409

"name": "_currentY",

71410

"type": "Number",

71411

"access": "private",

71412

"tagname": "",

71413

"class": "VMLDrawing",

71414

"module": "graphics"

71415

},

71416

{

71417

"file": "graphics/js/VMLDrawing.js",

71418

"line": 48,

71419

"description": "Draws a bezier curve.",

71420

"itemtype": "method",

71421

"name": "curveTo",

71422

"params": [

71423

{

71424

"name": "cp1x",

71425

"description": "x-coordinate for the first control point.",

71426

"type": "Number"

71427

},

71428

{

71429

"name": "cp1y",

71430

"description": "y-coordinate for the first control point.",

71431

"type": "Number"

71432

},

71433

{

71434

"name": "cp2x",

71435

"description": "x-coordinate for the second control point.",

71436

"type": "Number"

71437

},

71438

{

71439

"name": "cp2y",

71440

"description": "y-coordinate for the second control point.",

71441

"type": "Number"

71442

},

71443

{

71444

"name": "x",

71445

"description": "x-coordinate for the end point.",

71446

"type": "Number"

71447

},

71448

{

71449

"name": "y",

71450

"description": "y-coordinate for the end point.",

71451

"type": "Number"

71452

}

71453

],

71454

"class": "VMLDrawing",

71455

"module": "graphics"

71456

},

71457

{

71458

"file": "graphics/js/VMLDrawing.js",

71459

"line": 77,

71460

"description": "Draws a quadratic bezier curve.",

71461

"itemtype": "method",

71462

"name": "quadraticCurveTo",

71463

"params": [

71464

{

71465

"name": "cpx",

71466

"description": "x-coordinate for the control point.",

71467

"type": "Number"

71468

},

71469

{

71470

"name": "cpy",

71471

"description": "y-coordinate for the control point.",

71472

"type": "Number"

71473

},

71474

{

71475

"name": "x",

71476

"description": "x-coordinate for the end point.",

71477

"type": "Number"

71478

},

71479

{

71480

"name": "y",

71481

"description": "y-coordinate for the end point.",

71482

"type": "Number"

71483

}

71484

],

71485

"class": "VMLDrawing",

71486

"module": "graphics"

71487

},

71488

{

71489

"file": "graphics/js/VMLDrawing.js",

71490

"line": 96,

71491

"description": "Draws a rectangle.",

71492

"itemtype": "method",

71493

"name": "drawRect",

71494

"params": [

71495

{

71496

"name": "x",

71497

"description": "x-coordinate",

71498

"type": "Number"

71499

},

71500

{

71501

"name": "y",

71502

"description": "y-coordinate",

71503

"type": "Number"

71504

},

71505

{

71506

"name": "w",

71507

"description": "width",

71508

"type": "Number"

71509

},

71510

{

71511

"name": "h",

71512

"description": "height",

71513

"type": "Number"

71514

}

71515

],

71516

"class": "VMLDrawing",

71517

"module": "graphics"

71518

},

71519

{

71520

"file": "graphics/js/VMLDrawing.js",

71521

"line": 116,

71522

"description": "Draws a rectangle with rounded corners.",

71523

"itemtype": "method",

71524

"name": "drawRect",

71525

"params": [

71526

{

71527

"name": "x",

71528

"description": "x-coordinate",

71529

"type": "Number"

71530

},

71531

{

71532

"name": "y",

71533

"description": "y-coordinate",

71534

"type": "Number"

71535

},

71536

{

71537

"name": "w",

71538

"description": "width",

71539

"type": "Number"

71540

},

71541

{

71542

"name": "h",

71543

"description": "height",

71544

"type": "Number"

71545

},

71546

{

71547

"name": "ew",

71548

"description": "width of the ellipse used to draw the rounded corners",

71549

"type": "Number"

71550

},

71551

{

71552

"name": "eh",

71553

"description": "height of the ellipse used to draw the rounded corners",

71554

"type": "Number"

71555

}

71556

],

71557

"class": "VMLDrawing",

71558

"module": "graphics"

71559

},

71560

{

71561

"file": "graphics/js/VMLDrawing.js",

71562

"line": 140,

71563

"description": "Draws a circle. Used internally by `CanvasCircle` class.",

71564

"itemtype": "method",

71565

"name": "drawCircle",

71566

"params": [

71567

{

71568

"name": "x",

71569

"description": "y-coordinate",

71570

"type": "Number"

71571

},

71572

{

71573

"name": "y",

71574

"description": "x-coordinate",

71575

"type": "Number"

71576

},

71577

{

71578

"name": "r",

71579

"description": "radius",

71580

"type": "Number"

71581

}

71582

],

71583

"access": "protected",

71584

"tagname": "",

71585

"class": "VMLDrawing",

71586

"module": "graphics"

71587

},

71588

{

71589

"file": "graphics/js/VMLDrawing.js",

71590

"line": 160,

71591

"description": "Draws an ellipse.",

71592

"itemtype": "method",

71593

"name": "drawEllipse",

71594

"params": [

71595

{

71596

"name": "x",

71597

"description": "x-coordinate",

71598

"type": "Number"

71599

},

71600

{

71601

"name": "y",

71602

"description": "y-coordinate",

71603

"type": "Number"

71604

},

71605

{

71606

"name": "w",

71607

"description": "width",

71608

"type": "Number"

71609

},

71610

{

71611

"name": "h",

71612

"description": "height",

71613

"type": "Number"

71614

}

71615

],

71616

"access": "protected",

71617

"tagname": "",

71618

"class": "VMLDrawing",

71619

"module": "graphics"

71620

},

71621

{

71622

"file": "graphics/js/VMLDrawing.js",

71623

"line": 182,

71624

"description": "Draws a diamond.",

71625

"itemtype": "method",

71626

"name": "drawDiamond",

71627

"params": [

71628

{

71629

"name": "x",

71630

"description": "y-coordinate",

71631

"type": "Number"

71632

},

71633

{

71634

"name": "y",

71635

"description": "x-coordinate",

71636

"type": "Number"

71637

},

71638

{

71639

"name": "width",

71640

"description": "width",

71641

"type": "Number"

71642

},

71643

{

71644

"name": "height",

71645

"description": "height",

71646

"type": "Number"

71647

}

71648

],

71649

"access": "protected",

71650

"tagname": "",

71651

"class": "VMLDrawing",

71652

"module": "graphics"

71653

},

71654

{

71655

"file": "graphics/js/VMLDrawing.js",

71656

"line": 204,

71657

"description": "Draws a wedge.",

71658

"itemtype": "method",

71659

"name": "drawWedge",

71660

"params": [

71661

{

71662

"name": "x",

71663

"description": "x-coordinate of the wedge's center point",

71664

"type": "Number"

71665

},

71666

{

71667

"name": "y",

71668

"description": "y-coordinate of the wedge's center point",

71669

"type": "Number"

71670

},

71671

{

71672

"name": "startAngle",

71673

"description": "starting angle in degrees",

71674

"type": "Number"

71675

},

71676

{

71677

"name": "arc",

71678

"description": "sweep of the wedge. Negative values draw clockwise.",

71679

"type": "Number"

71680

},

71681

{

71682

"name": "radius",

71683

"description": "radius of wedge. If [optional] yRadius is defined, then radius is the x radius.",

71684

"type": "Number"

71685

},

71686

{

71687

"name": "yRadius",

71688

"description": "[optional] y radius for wedge.",

71689

"type": "Number"

71690

}

71691

],

71692

"access": "private",

71693

"tagname": "",

71694

"class": "VMLDrawing",

71695

"module": "graphics"

71696

},

71697

{

71698

"file": "graphics/js/VMLDrawing.js",

71699

"line": 237,

71700

"description": "Draws a line segment using the current line style from the current drawing position to the specified x and y coordinates.",

71701

"itemtype": "method",

71702

"name": "lineTo",

71703

"params": [

71704

{

71705

"name": "point1",

71706

"description": "x-coordinate for the end point.",

71707

"type": "Number"

71708

},

71709

{

71710

"name": "point2",

71711

"description": "y-coordinate for the end point.",

71712

"type": "Number"

71713

}

71714

],

71715

"class": "VMLDrawing",

71716

"module": "graphics"

71717

},

71718

{

71719

"file": "graphics/js/VMLDrawing.js",

71720

"line": 266,

71721

"description": "Moves the current drawing position to specified x and y coordinates.",

71722

"itemtype": "method",

71723

"name": "moveTo",

71724

"params": [

71725

{

71726

"name": "x",

71727

"description": "x-coordinate for the end point.",

71728

"type": "Number"

71729

},

71730

{

71731

"name": "y",

71732

"description": "y-coordinate for the end point.",

71733

"type": "Number"

71734

}

71735

],

71736

"class": "VMLDrawing",

71737

"module": "graphics"

71738

},

71739

{

71740

"file": "graphics/js/VMLDrawing.js",

71741

"line": 284,

71742

"description": "Draws the graphic.",

71743

"itemtype": "method",

71744

"name": "_draw",

71745

"access": "private",

71746

"tagname": "",

71747

"class": "VMLDrawing",

71748

"module": "graphics"

71749

},

71750

{

71751

"file": "graphics/js/VMLDrawing.js",

71752

"line": 327,

71753

"description": "Completes a drawing operation.",

71754

"itemtype": "method",

71755

"name": "end",

71756

"class": "VMLDrawing",

71757

"module": "graphics"

71758

},

71759

{

71760

"file": "graphics/js/VMLDrawing.js",

71761

"line": 337,

71762

"description": "Ends a fill and stroke",

71763

"itemtype": "method",

71764

"name": "closePath",

71765

"class": "VMLDrawing",

71766

"module": "graphics"

71767

},

71768

{

71769

"file": "graphics/js/VMLDrawing.js",

71770

"line": 347,

71771

"description": "Clears the path.",

71772

"itemtype": "method",

71773

"name": "clear",

71774

"class": "VMLDrawing",

71775

"module": "graphics"

71776

},

71777

{

71778

"file": "graphics/js/VMLDrawing.js",

71779

"line": 363,

71780

"description": "Updates the size of the graphics object",

71781

"itemtype": "method",

71782

"name": "_trackSize",

71783

"params": [

71784

{

71785

"name": "w",

71786

"description": "width",

71787

"type": "Number"

71788

},

71789

{

71790

"name": "h",

71791

"description": "height",

71792

"type": "Number"

71793

}

71794

],

71795

"access": "private",

71796

"tagname": "",

71797

"class": "VMLDrawing",

71798

"module": "graphics"

71799

},

71800

{

71801

"file": "graphics/js/VMLEllipse.js",

71802

"line": 19,

71803

"description": "Indicates the type of shape",

71804

"itemtype": "property",

71805

"name": "_type",

71806

"type": "String",

71807

"access": "private",

71808

"tagname": "",

71809

"class": "VMLEllipse",

71810

"module": "graphics"

71811

},

71812

{

71813

"file": "graphics/js/VMLGraphic.js",

71814

"line": 18,

71815

"description": "Whether or not to render the `Graphic` automatically after to a specified parent node after init. This can be a Node instance or a CSS selector string.",

71816

"itemtype": "config",

71817

"name": "render",

71818

"type": "Node | String",

71819

"class": "VMLGraphic",

71820

"module": "graphics"

71821

},

71822

{

71823

"file": "graphics/js/VMLGraphic.js",

71824

"line": 26,

71825

"description": "Unique id for class instance.",

71826

"itemtype": "config",

71827

"name": "id",

71828

"type": "String",

71829

"class": "VMLGraphic",

71830

"module": "graphics"

71831

},

71832

{

71833

"file": "graphics/js/VMLGraphic.js",

71834

"line": 49,

71835

"description": "Key value pairs in which a shape instance is associated with its id.",

71836

"itemtype": "config",

71837

"name": "shapes",

71838

"type": "Object",

71839

"readonly": "",

71840

"class": "VMLGraphic",

71841

"module": "graphics"

71842

},

71843

{

71844

"file": "graphics/js/VMLGraphic.js",

71845

"line": 65,

71846

"description": "Object containing size and coordinate data for the content of a Graphic in relation to the coordSpace node.",

71847

"itemtype": "config",

71848

"name": "contentBounds",

71849

"type": "Object",

71850

"class": "VMLGraphic",

71851

"module": "graphics"

71852

},

71853

{

71854

"file": "graphics/js/VMLGraphic.js",

71855

"line": 80,

71856

"description": "The html element that represents to coordinate system of the Graphic instance.",

71857

"itemtype": "config",

71858

"name": "node",

71859

"type": "HTMLElement",

71860

"class": "VMLGraphic",

71861

"module": "graphics"

71862

},

71863

{

71864

"file": "graphics/js/VMLGraphic.js",

71865

"line": 95,

71866

"description": "Indicates the width of the `Graphic`.",

71867

"itemtype": "config",

71868

"name": "width",

71869

"type": "Number",

71870

"class": "VMLGraphic",

71871

"module": "graphics"

71872

},

71873

{

71874

"file": "graphics/js/VMLGraphic.js",

71875

"line": 112,

71876

"description": "Indicates the height of the `Graphic`.",

71877

"itemtype": "config",

71878

"name": "height",

71879

"type": "Number",

71880

"class": "VMLGraphic",

71881

"module": "graphics"

71882

},

71883

{

71884

"file": "graphics/js/VMLGraphic.js",

71885

"line": 129,

71886

"description": "Determines how the size of instance is calculated. If true, the width and height are determined by the size of the contents.\nIf false, the width and height values are either explicitly set or determined by the size of the parent node's dimensions.",

71887

"itemtype": "config",

71888

"name": "autoSize",

71889

"type": "Boolean",

71890

"default": "false",

71891

"class": "VMLGraphic",

71892

"module": "graphics"

71893

},

71894

{

71895

"file": "graphics/js/VMLGraphic.js",

71896

"line": 141,

71897

"description": "The contentBounds will resize to greater values but not values. (for performance)\nWhen resizing the contentBounds down is desirable, set the resizeDown value to true.",

71898

"itemtype": "config",

71899

"name": "resizeDown",

71900

"type": "Boolean",

71901

"class": "VMLGraphic",

71902

"module": "graphics"

71903

},

71904

{

71905

"file": "graphics/js/VMLGraphic.js",

71906

"line": 165,

71907

"description": "Indicates the x-coordinate for the instance.",

71908

"itemtype": "config",

71909

"name": "x",

71910

"type": "Number",

71911

"class": "VMLGraphic",

71912

"module": "graphics"

71913

},

71914

{

71915

"file": "graphics/js/VMLGraphic.js",

71916

"line": 188,

71917

"description": "Indicates the y-coordinate for the instance.",

71918

"itemtype": "config",

71919

"name": "y",

71920

"type": "Number",

71921

"class": "VMLGraphic",

71922

"module": "graphics"

71923

},

71924

{

71925

"file": "graphics/js/VMLGraphic.js",

71926

"line": 211,

71927

"description": "Indicates whether or not the instance will automatically redraw after a change is made to a shape.\nThis property will get set to false when batching operations.",

71928

"itemtype": "config",

71929

"name": "autoDraw",

71930

"type": "Boolean",

71931

"default": "true",

71932

"access": "private",

71933

"tagname": "",

71934

"class": "VMLGraphic",

71935

"module": "graphics"

71936

},

71937

{

71938

"file": "graphics/js/VMLGraphic.js",

71939

"line": 236,

71940

"description": "Storage for `x` attribute.",

71941

"itemtype": "property",

71942

"name": "_x",

71943

"type": "Number",

71944

"access": "private",

71945

"tagname": "",

71946

"class": "VMLGraphic",

71947

"module": "graphics"

71948

},

71949

{

71950

"file": "graphics/js/VMLGraphic.js",

71951

"line": 245,

71952

"description": "Storage for `y` attribute.",

71953

"itemtype": "property",

71954

"name": "_y",

71955

"type": "Number",

71956

"access": "private",

71957

"tagname": "",

71958

"class": "VMLGraphic",

71959

"module": "graphics"

71960

},

71961

{

71962

"file": "graphics/js/VMLGraphic.js",

71963

"line": 254,

71964

"description": "Gets the current position of the graphic instance in page coordinates.",

71965

"itemtype": "method",

71966

"name": "getXY",

71967

"return": {

71968

"description": "Array The XY position of the shape."

71969

},

71970

"class": "VMLGraphic",

71971

"module": "graphics"

71972

},

71973

{

71974

"file": "graphics/js/VMLGraphic.js",

71975

"line": 271,

71976

"access": "private",

71977

"tagname": "",

71978

"itemtype": "property",

71979

"name": "_resizeDown",

71980

"type": "Boolean",

71981

"class": "VMLGraphic",

71982

"module": "graphics"

71983

},

71984

{

71985

"file": "graphics/js/VMLGraphic.js",

71986

"line": 278,

71987

"description": "Initializes the class.",

71988

"itemtype": "method",

71989

"name": "initializer",

71990

"access": "private",

71991

"tagname": "",

71992

"class": "VMLGraphic",

71993

"module": "graphics"

71994

},

71995

{

71996

"file": "graphics/js/VMLGraphic.js",

71997

"line": 301,

71998

"description": "Adds the graphics node to the dom.",

71999

"itemtype": "method",

72000

"name": "render",

72001

"params": [

72002

{

72003

"name": "parentNode",

72004

"description": "node in which to render the graphics node into.",

72005

"type": "HTMLElement"

72006

}

72007

],

72008

"class": "VMLGraphic",

72009

"module": "graphics"

72010

},

72011

{

72012

"file": "graphics/js/VMLGraphic.js",

72013

"line": 320,

72014

"description": "Removes all nodes.",

72015

"itemtype": "method",

72016

"name": "destroy",

72017

"class": "VMLGraphic",

72018

"module": "graphics"

72019

},

72020

{

72021

"file": "graphics/js/VMLGraphic.js",

72022

"line": 331,

72023

"description": "Generates a shape instance by type.",

72024

"itemtype": "method",

72025

"name": "addShape",

72026

"params": [

72027

{

72028

"name": "cfg",

72029

"description": "attributes for the shape",

72030

"type": "Object"

72031

}

72032

],

72033

"return": {

72034

"description": "Shape"

72035

},

72036

"class": "VMLGraphic",

72037

"module": "graphics"

72038

},

72039

{

72040

"file": "graphics/js/VMLGraphic.js",

72041

"line": 347,

72042

"description": "Adds a shape instance to the graphic instance.",

72043

"itemtype": "method",

72044

"name": "_appendShape",

72045

"params": [

72046

{

72047

"name": "shape",

72048

"description": "The shape instance to be added to the graphic.",

72049

"type": "Shape"

72050

}

72051

],

72052

"access": "private",

72053

"tagname": "",

72054

"class": "VMLGraphic",

72055

"module": "graphics"

72056

},

72057

{

72058

"file": "graphics/js/VMLGraphic.js",

72059

"line": 368,

72060

"description": "Removes a shape instance from from the graphic instance.",

72061

"itemtype": "method",

72062

"name": "removeShape",

72063

"params": [

72064

{

72065

"name": "shape",

72066

"description": "The instance or id of the shape to be removed.",

72067

"type": "Shape|String"

72068

}

72069

],

72070

"class": "VMLGraphic",

72071

"module": "graphics"

72072

},

72073

{

72074

"file": "graphics/js/VMLGraphic.js",

72075

"line": 395,

72076

"description": "Removes all shape instances from the dom.",

72077

"itemtype": "method",

72078

"name": "removeAllShapes",

72079

"class": "VMLGraphic",

72080

"module": "graphics"

72081

},

72082

{

72083

"file": "graphics/js/VMLGraphic.js",

72084

"line": 414,

72085

"description": "Removes all child nodes.",

72086

"itemtype": "method",

72087

"name": "_removeChildren",

72088

"params": [

72089

{

72090

"name": "node",

72091

"description": ""

72092

}

72093

],

72094

"access": "private",

72095

"tagname": "",

72096

"class": "VMLGraphic",

72097

"module": "graphics"

72098

},

72099

{

72100

"file": "graphics/js/VMLGraphic.js",

72101

"line": 435,

72102

"description": "Clears the graphics object.",

72103

"itemtype": "method",

72104

"name": "clear",

72105

"class": "VMLGraphic",

72106

"module": "graphics"

72107

},

72108

{

72109

"file": "graphics/js/VMLGraphic.js",

72110

"line": 445,

72111

"description": "Toggles visibility",

72112

"itemtype": "method",

72113

"name": "_toggleVisible",

72114

"params": [

72115

{

72116

"name": "val",

72117

"description": "indicates visibilitye",

72118

"type": "Boolean"

72119

}

72120

],

72121

"access": "private",

72122

"tagname": "",

72123

"class": "VMLGraphic",

72124

"module": "graphics"

72125

},

72126

{

72127

"file": "graphics/js/VMLGraphic.js",

72128

"line": 470,

72129

"description": "Sets the size of the graphics object.",

72130

"itemtype": "method",

72131

"name": "setSize",

72132

"params": [

72133

{

72134

"name": "w",

72135

"description": "width to set for the instance.",

72136

"type": "Number"

72137

},

72138

{

72139

"name": "h",

72140

"description": "height to set for the instance.",

72141

"type": "Number"

72142

}

72143

],

72144

"class": "VMLGraphic",

72145

"module": "graphics"

72146

},

72147

{

72148

"file": "graphics/js/VMLGraphic.js",

72149

"line": 485,

72150

"description": "Sets the positon of the graphics object.",

72151

"itemtype": "method",

72152

"name": "setPosition",

72153

"params": [

72154

{

72155

"name": "x",

72156

"description": "x-coordinate for the object.",

72157

"type": "Number"

72158

},

72159

{

72160

"name": "y",

72161

"description": "y-coordinate for the object.",

72162

"type": "Number"

72163

}

72164

],

72165

"class": "VMLGraphic",

72166

"module": "graphics"

72167

},

72168

{

72169

"file": "graphics/js/VMLGraphic.js",

72170

"line": 500,

72171

"description": "Creates a group element",

72172

"itemtype": "method",

72173

"name": "_createGraphic",

72174

"access": "private",

72175

"tagname": "",

72176

"class": "VMLGraphic",

72177

"module": "graphics"

72178

},

72179

{

72180

"file": "graphics/js/VMLGraphic.js",

72181

"line": 513,

72182

"description": "Creates a graphic node",

72183

"itemtype": "method",

72184

"name": "_createGraphicNode",

72185

"params": [

72186

{

72187

"name": "type",

72188

"description": "node type to create",

72189

"type": "String"

72190

},

72191

{

72192

"name": "pe",

72193

"description": "specified pointer-events value",

72194

"type": "String"

72195

}

72196

],

72197

"return": {

72198

"description": "HTMLElement"

72199

},

72200

"access": "private",

72201

"tagname": "",

72202

"class": "VMLGraphic",

72203

"module": "graphics"

72204

},

72205

{

72206

"file": "graphics/js/VMLGraphic.js",

72207

"line": 528,

72208

"description": "Returns a shape based on the id of its dom node.",

72209

"itemtype": "method",

72210

"name": "getShapeById",

72211

"params": [

72212

{

72213

"name": "id",

72214

"description": "Dom id of the shape's node attribute.",

72215

"type": "String"

72216

}

72217

],

72218

"return": {

72219

"description": "Shape"

72220

},

72221

"class": "VMLGraphic",

72222

"module": "graphics"

72223

},

72224

{

72225

"file": "graphics/js/VMLGraphic.js",

72226

"line": 540,

72227

"description": "Returns a shape class. Used by `addShape`.",

72228

"itemtype": "method",

72229

"name": "_getShapeClass",

72230

"params": [

72231

{

72232

"name": "val",

72233

"description": "Indicates which shape class.",

72234

"type": "Shape | String"

72235

}

72236

],

72237

"return": {

72238

"description": "Function"

72239

},

72240

"access": "private",

72241

"tagname": "",

72242

"class": "VMLGraphic",

72243

"module": "graphics"

72244

},

72245

{

72246

"file": "graphics/js/VMLGraphic.js",

72247

"line": 558,

72248

"description": "Look up for shape classes. Used by `addShape` to retrieve a class for instantiation.",

72249

"itemtype": "property",

72250

"name": "_shapeClass",

72251

"type": "Object",

72252

"access": "private",

72253

"tagname": "",

72254

"class": "VMLGraphic",

72255

"module": "graphics"

72256

},

72257

{

72258

"file": "graphics/js/VMLGraphic.js",

72259

"line": 573,

72260

"description": "Allows for creating multiple shapes in order to batch appending and redraw operations.",

72261

"itemtype": "method",

72262

"name": "batch",

72263

"params": [

72264

{

72265

"name": "method",

72266

"description": "Method to execute.",

72267

"type": "Function"

72268

}

72269

],

72270

"class": "VMLGraphic",

72271

"module": "graphics"

72272

},

72273

{

72274

"file": "graphics/js/VMLGraphic.js",

72275

"line": 588,

72276

"description": "Returns a document fragment to for attaching shapes.",

72277

"itemtype": "method",

72278

"name": "_getDocFrag",

72279

"return": {

72280

"description": "DocumentFragment"

72281

},

72282

"access": "private",

72283

"tagname": "",

72284

"class": "VMLGraphic",

72285

"module": "graphics"

72286

},

72287

{

72288

"file": "graphics/js/VMLGraphic.js",

72289

"line": 604,

72290

"description": "Adds a shape to the redraw queue and calculates the contentBounds.",

72291

"itemtype": "method",

72292

"name": "addToRedrawQueue",

72293

"params": [

72294

{

72295

"name": "shape",

72296

"description": "",

72297

"type": "VMLShape"

72298

}

72299

],

72300

"access": "protected",

72301

"tagname": "",

72302

"class": "VMLGraphic",

72303

"module": "graphics"

72304

},

72305

{

72306

"file": "graphics/js/VMLGraphic.js",

72307

"line": 634,

72308

"description": "Redraws all shapes.",

72309

"itemtype": "method",

72310

"name": "_redraw",

72311

"access": "private",

72312

"tagname": "",

72313

"class": "VMLGraphic",

72314

"module": "graphics"

72315

},

72316

{

72317

"file": "graphics/js/VMLGraphic.js",

72318

"line": 654,

72319

"description": "Recalculates and returns the `contentBounds` for the `Graphic` instance.",

72320

"itemtype": "method",

72321

"name": "_getUpdatedContentBounds",

72322

"return": {

72323

"description": "",

72324

"type": "Object"

72325

},

72326

"access": "private",

72327

"tagname": "",

72328

"class": "VMLGraphic",

72329

"module": "graphics"

72330

},

72331

{

72332

"file": "graphics/js/VMLPath.js",

72333

"line": 19,

72334

"description": "Indicates the width of the shape",

72335

"itemtype": "config",

72336

"name": "width",

72337

"type": "Number",

72338

"class": "VMLPath",

72339

"module": "graphics"

72340

},

72341

{

72342

"file": "graphics/js/VMLPath.js",

72343

"line": 33,

72344

"description": "Indicates the height of the shape",

72345

"itemtype": "config",

72346

"name": "height",

72347

"type": "Number",

72348

"class": "VMLPath",

72349

"module": "graphics"

72350

},

72351

{

72352

"file": "graphics/js/VMLPath.js",

72353

"line": 46,

72354

"description": "Indicates the path used for the node.",

72355

"itemtype": "config",

72356

"name": "path",

72357

"type": "String",

72358

"readonly": "",

72359

"class": "VMLPath",

72360

"module": "graphics"

72361

},

72362

{

72363

"file": "graphics/js/VMLPieSlice.js",

72364

"line": 14,

72365

"description": "Indicates the type of shape",

72366

"itemtype": "property",

72367

"name": "_type",

72368

"type": "String",

72369

"access": "private",

72370

"tagname": "",

72371

"class": "VMLPieSlice",

72372

"module": "graphics"

72373

},

72374

{

72375

"file": "graphics/js/VMLPieSlice.js",

72376

"line": 23,

72377

"description": "Change event listener",

72378

"access": "private",

72379

"tagname": "",

72380

"itemtype": "method",

72381

"name": "_updateHandler",

72382

"class": "VMLPieSlice",

72383

"module": "graphics"

72384

},

72385

{

72386

"file": "graphics/js/VMLPieSlice.js",

72387

"line": 49,

72388

"description": "Starting angle in relation to a circle in which to begin the pie slice drawing.",

72389

"itemtype": "config",

72390

"name": "startAngle",

72391

"type": "Number",

72392

"class": "VMLPieSlice",

72393

"module": "graphics"

72394

},

72395

{

72396

"file": "graphics/js/VMLPieSlice.js",

72397

"line": 59,

72398

"description": "Arc of the slice.",

72399

"itemtype": "config",

72400

"name": "arc",

72401

"type": "Number",

72402

"class": "VMLPieSlice",

72403

"module": "graphics"

72404

},

72405

{

72406

"file": "graphics/js/VMLPieSlice.js",

72407

"line": 69,

72408

"description": "Radius of the circle in which the pie slice is drawn",

72409

"itemtype": "config",

72410

"name": "radius",

72411

"type": "Number",

72412

"class": "VMLPieSlice",

72413

"module": "graphics"

72414

},

72415

{

72416

"file": "graphics/js/VMLRect.js",

72417

"line": 17,

72418

"description": "Indicates the type of shape",

72419

"itemtype": "property",

72420

"name": "_type",

72421

"type": "String",

72422

"access": "private",

72423

"tagname": "",

72424

"class": "VMLRect",

72425

"module": "graphics"

72426

},

72427

{

72428

"file": "graphics/js/VMLShape.js",

72429

"line": 23,

72430

"description": "Indicates the type of shape",

72431

"itemtype": "property",

72432

"name": "_type",

72433

"type": "String",

72434

"access": "private",

72435

"tagname": "",

72436

"class": "VMLShape",

72437

"module": "graphics"

72438

},

72439

{

72440

"file": "graphics/js/VMLShape.js",

72441

"line": 32,

72442

"description": "Init method, invoked during construction.\nCalls `initializer` method.",

72443

"itemtype": "method",

72444

"name": "init",

72445

"access": "protected",

72446

"tagname": "",

72447

"class": "VMLShape",

72448

"module": "graphics"

72449

},

72450

{

72451

"file": "graphics/js/VMLShape.js",

72452

"line": 44,

72453

"description": "Initializes the shape",

72454

"access": "private",

72455

"tagname": "",

72456

"itemtype": "method",

72457

"name": "_initialize",

72458

"class": "VMLShape",

72459

"module": "graphics"

72460

},

72461

{

72462

"file": "graphics/js/VMLShape.js",

72463

"line": 62,

72464

"description": "Set the Graphic instance for the shape.",

72465

"itemtype": "method",

72466

"name": "_setGraphic",

72467

"params": [

72468

{

72469

"name": "render",

72470

"description": "This param is used to determine the graphic instance. If it is a `Graphic` instance, it will be assigned\nto the `graphic` attribute. Otherwise, a new Graphic instance will be created and rendered into the dom element that the render represents.",

72471

"type": "Graphic | Node | HTMLElement | String"

72472

}

72473

],

72474

"access": "private",

72475

"tagname": "",

72476

"class": "VMLShape",

72477

"module": "graphics"

72478

},

72479

{

72480

"file": "graphics/js/VMLShape.js",

72481

"line": 88,

72482

"description": "Creates the dom node for the shape.",

72483

"itemtype": "method",

72484

"name": "createNode",

72485

"return": {

72486

"description": "HTMLElement"

72487

},

72488

"access": "private",

72489

"tagname": "",

72490

"class": "VMLShape",

72491

"module": "graphics"

72492

},

72493

{

72494

"file": "graphics/js/VMLShape.js",

72495

"line": 192,

72496

"description": "Add a class name to each node.",

72497

"itemtype": "method",

72498

"name": "addClass",

72499

"params": [

72500

{

72501

"name": "className",

72502

"description": "the class name to add to the node's class attribute",

72503

"type": "String"

72504

}

72505

],

72506

"class": "VMLShape",

72507

"module": "graphics"

72508

},

72509

{

72510

"file": "graphics/js/VMLShape.js",

72511

"line": 204,

72512

"description": "Removes a class name from each node.",

72513

"itemtype": "method",

72514

"name": "removeClass",

72515

"params": [

72516

{

72517

"name": "className",

72518

"description": "the class name to remove from the node's class attribute",

72519

"type": "String"

72520

}

72521

],

72522

"class": "VMLShape",

72523

"module": "graphics"

72524

},

72525

{

72526

"file": "graphics/js/VMLShape.js",

72527

"line": 216,

72528

"description": "Gets the current position of the node in page coordinates.",

72529

"itemtype": "method",

72530

"name": "getXY",

72531

"return": {

72532

"description": "Array The XY position of the shape."

72533

},

72534

"class": "VMLShape",

72535

"module": "graphics"

72536

},

72537

{

72538

"file": "graphics/js/VMLShape.js",

72539

"line": 231,

72540

"description": "Set the position of the shape in page coordinates, regardless of how the node is positioned.",

72541

"itemtype": "method",

72542

"name": "setXY",

72543

"params": [

72544

{

72545

"name": "Contains",

72546

"description": "x & y values for new position (coordinates are page-based)",

72547

"type": "Array"

72548

}

72549

],

72550

"class": "VMLShape",

72551

"module": "graphics"

72552

},

72553

{

72554

"file": "graphics/js/VMLShape.js",

72555

"line": 246,

72556

"description": "Determines whether the node is an ancestor of another HTML element in the DOM hierarchy.",

72557

"itemtype": "method",

72558

"name": "contains",

72559

"params": [

72560

{

72561

"name": "needle",

72562

"description": "The possible node or descendent",

72563

"type": "VMLShape | HTMLElement"

72564

}

72565

],

72566

"return": {

72567

"description": "Boolean Whether or not this shape is the needle or its ancestor."

72568

},

72569

"class": "VMLShape",

72570

"module": "graphics"

72571

},

72572

{

72573

"file": "graphics/js/VMLShape.js",

72574

"line": 258,

72575

"description": "Compares nodes to determine if they match.\nNode instances can be compared to each other and/or HTMLElements.",

72576

"itemtype": "method",

72577

"name": "compareTo",

72578

"params": [

72579

{

72580

"name": "refNode",

72581

"description": "The reference node to compare to the node.",

72582

"type": "HTMLElement | Node"

72583

}

72584

],

72585

"return": {

72586

"description": "True if the nodes match, false if they do not.",

72587

"type": "Boolean"

72588

},

72589

"class": "VMLShape",

72590

"module": "graphics"

72591

},

72592

{

72593

"file": "graphics/js/VMLShape.js",

72594

"line": 271,

72595

"description": "Test if the supplied node matches the supplied selector.",

72596

"itemtype": "method",

72597

"name": "test",

72598

"params": [

72599

{

72600

"name": "selector",

72601

"description": "The CSS selector to test against.",

72602

"type": "String"

72603

}

72604

],

72605

"return": {

72606

"description": "Boolean Wheter or not the shape matches the selector."

72607

},

72608

"class": "VMLShape",

72609

"module": "graphics"

72610

},

72611

{

72612

"file": "graphics/js/VMLShape.js",

72613

"line": 283,

72614

"description": "Calculates and returns properties for setting an initial stroke.",

72615

"itemtype": "method",

72616

"name": "_getStrokeProps",

72617

"return": {

72618

"description": "Object"

72619

},

72620

"access": "private",

72621

"tagname": "",

72622

"class": "VMLShape",

72623

"module": "graphics"

72624

},

72625

{

72626

"file": "graphics/js/VMLShape.js",

72627

"line": 350,

72628

"description": "Adds a stroke to the shape node.",

72629

"itemtype": "method",

72630

"name": "_strokeChangeHandler",

72631

"access": "private",

72632

"tagname": "",

72633

"class": "VMLShape",

72634

"module": "graphics"

72635

},

72636

{

72637

"file": "graphics/js/VMLShape.js",

72638

"line": 432,

72639

"description": "Calculates and returns properties for setting an initial fill.",

72640

"itemtype": "method",

72641

"name": "_getFillProps",

72642

"return": {

72643

"description": "Object"

72644

},

72645

"access": "private",

72646

"tagname": "",

72647

"class": "VMLShape",

72648

"module": "graphics"

72649

},

72650

{

72651

"file": "graphics/js/VMLShape.js",

72652

"line": 490,

72653

"description": "Adds a fill to the shape node.",

72654

"itemtype": "method",

72655

"name": "_fillChangeHandler",

72656

"access": "private",

72657

"tagname": "",

72658

"class": "VMLShape",

72659

"module": "graphics"

72660

},

72661

{

72662

"file": "graphics/js/VMLShape.js",

72663

"line": 591,

72664

"description": "Calculates and returns an object containing gradient properties for a fill node.",

72665

"itemtype": "method",

72666

"name": "_getGradientFill",

72667

"params": [

72668

{

72669

"name": "fill",

72670

"description": "Object containing fill properties.",

72671

"type": "Object"

72672

}

72673

],

72674

"return": {

72675

"description": "Object"

72676

},

72677

"access": "private",

72678

"tagname": "",

72679

"class": "VMLShape",

72680

"module": "graphics"

72681

},

72682

{

72683

"file": "graphics/js/VMLShape.js",

72684

"line": 675,

72685

"description": "Adds a transform to the shape.",

72686

"itemtype": "method",

72687

"name": "_addTransform",

72688

"params": [

72689

{

72690

"name": "type",

72691

"description": "The transform being applied.",

72692

"type": "String"

72693

},

72694

{

72695

"name": "args",

72696

"description": "The arguments for the transform.",

72697

"type": "Array"

72698

}

72699

],

72700

"access": "private",

72701

"tagname": "",

72702

"class": "VMLShape",

72703

"module": "graphics"

72704

},

72705

{

72706

"file": "graphics/js/VMLShape.js",

72707

"line": 695,

72708

"description": "Applies all transforms.",

72709

"itemtype": "method",

72710

"name": "_updateTransform",

72711

"access": "private",

72712

"tagname": "",

72713

"class": "VMLShape",

72714

"module": "graphics"

72715

},

72716

{

72717

"file": "graphics/js/VMLShape.js",

72718

"line": 774,

72719

"description": "Normalizes the skew offset values between -32767 and 32767.",

72720

"itemtype": "method",

72721

"name": "_getSkewOffsetValue",

72722

"params": [

72723

{

72724

"name": "val",

72725

"description": "The value to normalize",

72726

"type": "Number"

72727

}

72728

],

72729

"return": {

72730

"description": "Number"

72731

},

72732

"access": "private",

72733

"tagname": "",

72734

"class": "VMLShape",

72735

"module": "graphics"

72736

},

72737

{

72738

"file": "graphics/js/VMLShape.js",

72739

"line": 790,

72740

"description": "Storage for translateX",

72741

"itemtype": "property",

72742

"name": "_translateX",

72743

"type": "Number",

72744

"access": "private",

72745

"tagname": "",

72746

"class": "VMLShape",

72747

"module": "graphics"

72748

},

72749

{

72750

"file": "graphics/js/VMLShape.js",

72751

"line": 799,

72752

"description": "Storage for translateY",

72753

"itemtype": "property",

72754

"name": "_translateY",

72755

"type": "Number",

72756

"access": "private",

72757

"tagname": "",

72758

"class": "VMLShape",

72759

"module": "graphics"

72760

},

72761

{

72762

"file": "graphics/js/VMLShape.js",

72763

"line": 808,

72764

"description": "Storage for the transform attribute.",

72765

"itemtype": "property",

72766

"name": "_transform",

72767

"type": "String",

72768

"access": "private",

72769

"tagname": "",

72770

"class": "VMLShape",

72771

"module": "graphics"

72772

},

72773

{

72774

"file": "graphics/js/VMLShape.js",

72775

"line": 817,

72776

"description": "Specifies a 2d translation.",

72777

"itemtype": "method",

72778

"name": "translate",

72779

"params": [

72780

{

72781

"name": "x",

72782

"description": "The value to transate on the x-axis.",

72783

"type": "Number"

72784

},

72785

{

72786

"name": "y",

72787

"description": "The value to translate on the y-axis.",

72788

"type": "Number"

72789

}

72790

],

72791

"class": "VMLShape",

72792

"module": "graphics"

72793

},

72794

{

72795

"file": "graphics/js/VMLShape.js",

72796

"line": 831,

72797

"description": "Translates the shape along the x-axis. When translating x and y coordinates,\nuse the `translate` method.",

72798

"itemtype": "method",

72799

"name": "translateX",

72800

"params": [

72801

{

72802

"name": "x",

72803

"description": "The value to translate.",

72804

"type": "Number"

72805

}

72806

],

72807

"class": "VMLShape",

72808

"module": "graphics"

72809

},

72810

{

72811

"file": "graphics/js/VMLShape.js",

72812

"line": 844,

72813

"description": "Performs a translate on the y-coordinate. When translating x and y coordinates,\nuse the `translate` method.",

72814

"itemtype": "method",

72815

"name": "translateY",

72816

"params": [

72817

{

72818

"name": "y",

72819

"description": "The value to translate.",

72820

"type": "Number"

72821

}

72822

],

72823

"class": "VMLShape",

72824

"module": "graphics"

72825

},

72826

{

72827

"file": "graphics/js/VMLShape.js",

72828

"line": 857,

72829

"description": "Skews the shape around the x-axis and y-axis.",

72830

"itemtype": "method",

72831

"name": "skew",

72832

"params": [

72833

{

72834

"name": "x",

72835

"description": "The value to skew on the x-axis.",

72836

"type": "Number"

72837

},

72838

{

72839

"name": "y",

72840

"description": "The value to skew on the y-axis.",

72841

"type": "Number"

72842

}

72843

],

72844

"class": "VMLShape",

72845

"module": "graphics"

72846

},

72847

{

72848

"file": "graphics/js/VMLShape.js",

72849

"line": 869,

72850

"description": "Skews the shape around the x-axis.",

72851

"itemtype": "method",

72852

"name": "skewX",

72853

"params": [

72854

{

72855

"name": "x",

72856

"description": "x-coordinate",

72857

"type": "Number"

72858

}

72859

],

72860

"class": "VMLShape",

72861

"module": "graphics"

72862

},

72863

{

72864

"file": "graphics/js/VMLShape.js",

72865

"line": 880,

72866

"description": "Skews the shape around the y-axis.",

72867

"itemtype": "method",

72868

"name": "skewY",

72869

"params": [

72870

{

72871

"name": "y",

72872

"description": "y-coordinate",

72873

"type": "Number"

72874

}

72875

],

72876

"class": "VMLShape",

72877

"module": "graphics"

72878

},

72879

{

72880

"file": "graphics/js/VMLShape.js",

72881

"line": 891,

72882

"description": "Rotates the shape clockwise around it transformOrigin.",

72883

"itemtype": "method",

72884

"name": "rotate",

72885

"params": [

72886

{

72887

"name": "deg",

72888

"description": "The degree of the rotation.",

72889

"type": "Number"

72890

}

72891

],

72892

"class": "VMLShape",

72893

"module": "graphics"

72894

},

72895

{

72896

"file": "graphics/js/VMLShape.js",

72897

"line": 902,

72898

"description": "Specifies a 2d scaling operation.",

72899

"itemtype": "method",

72900

"name": "scale",

72901

"params": [

72902

{

72903

"name": "val",

72904

"description": "",

72905

"type": "Number"

72906

}

72907

],

72908

"class": "VMLShape",

72909

"module": "graphics"

72910

},

72911

{

72912

"file": "graphics/js/VMLShape.js",

72913

"line": 913,

72914

"description": "Overrides default `on` method. Checks to see if its a dom interaction event. If so, \nreturn an event attached to the `node` element. If not, return the normal functionality.",

72915

"itemtype": "method",

72916

"name": "on",

72917

"params": [

72918

{

72919

"name": "type",

72920

"description": "event type",

72921

"type": "String"

72922

},

72923

{

72924

"name": "callback",

72925

"description": "function",

72926

"type": "Object"

72927

}

72928

],

72929

"access": "private",

72930

"tagname": "",

72931

"class": "VMLShape",

72932

"module": "graphics"

72933

},

72934

{

72935

"file": "graphics/js/VMLShape.js",

72936

"line": 931,

72937

"description": "Draws the shape.",

72938

"itemtype": "method",

72939

"name": "_draw",

72940

"access": "private",

72941

"tagname": "",

72942

"class": "VMLShape",

72943

"module": "graphics"

72944

},

72945

{

72946

"file": "graphics/js/VMLShape.js",

72947

"line": 941,

72948

"description": "Updates `Shape` based on attribute changes.",

72949

"itemtype": "method",

72950

"name": "_updateHandler",

72951

"access": "private",

72952

"tagname": "",

72953

"class": "VMLShape",

72954

"module": "graphics"

72955

},

72956

{

72957

"file": "graphics/js/VMLShape.js",

72958

"line": 959,

72959

"description": "Creates a graphic node",

72960

"itemtype": "method",

72961

"name": "_createGraphicNode",

72962

"params": [

72963

{

72964

"name": "type",

72965

"description": "node type to create",

72966

"type": "String"

72967

}

72968

],

72969

"return": {

72970

"description": "HTMLElement"

72971

},

72972

"access": "private",

72973

"tagname": "",

72974

"class": "VMLShape",

72975

"module": "graphics"

72976

},

72977

{

72978

"file": "graphics/js/VMLShape.js",

72979

"line": 973,

72980

"description": "Value function for fill attribute",

72981

"access": "private",

72982

"tagname": "",

72983

"itemtype": "method",

72984

"name": "_getDefaultFill",

72985

"return": {

72986

"description": "Object"

72987

},

72988

"class": "VMLShape",

72989

"module": "graphics"

72990

},

72991

{

72992

"file": "graphics/js/VMLShape.js",

72993

"line": 991,

72994

"description": "Value function for stroke attribute",

72995

"access": "private",

72996

"tagname": "",

72997

"itemtype": "method",

72998

"name": "_getDefaultStroke",

72999

"return": {

73000

"description": "Object"

73001

},

73002

"class": "VMLShape",

73003

"module": "graphics"

73004

},

73005

{

73006

"file": "graphics/js/VMLShape.js",

73007

"line": 1008,

73008

"description": "Sets the value of an attribute.",

73009

"itemtype": "method",

73010

"name": "set",

73011

"params": [

73012

{

73013

"name": "name",

73014

"description": "The name of the attribute. Alternatively, an object of key value pairs can \nbe passed in to set multiple attributes at once.",

73015

"type": "String|Object"

73016

},

73017

{

73018

"name": "value",

73019

"description": "The value to set the attribute to. This value is ignored if an object is received as \nthe name param.",

73020

"type": "Any"

73021

}

73022

],

73023

"class": "VMLShape",

73024

"module": "graphics"

73025

},

73026

{

73027

"file": "graphics/js/VMLShape.js",

73028

"line": 1027,

73029

"description": "Returns the bounds for a shape.\n\nCalculates the a new bounding box from the original corner coordinates (base on size and position) and the transform matrix.\nThe calculated bounding box is used by the graphic instance to calculate its viewBox.",

73030

"itemtype": "method",

73031

"name": "getBounds",

73032

"params": [

73033

{

73034

"name": "optional",

73035

"description": "cfg Reference to matrix instance",

73036

"type": "Matrix",

73037

"optional": true

73038

}

73039

],

73040

"return": {

73041

"description": "Object"

73042

},

73043

"class": "VMLShape",

73044

"module": "graphics"

73045

},

73046

{

73047

"file": "graphics/js/VMLShape.js",

73048

"line": 1056,

73049

"description": "Destroys shape",

73050

"itemtype": "method",

73051

"name": "destroy",

73052

"class": "VMLShape",

73053

"module": "graphics"

73054

},

73055

{

73056

"file": "graphics/js/VMLShape.js",

73057

"line": 1074,

73058

"description": "Implementation for shape destruction",

73059

"itemtype": "method",

73060

"name": "destroy",

73061

"access": "protected",

73062

"tagname": "",

73063

"class": "VMLShape",

73064

"module": "graphics"

73065

},

73066

{

73067

"file": "graphics/js/VMLShape.js",

73068

"line": 1100,

73069

"description": "An array of x, y values which indicates the transformOrigin in which to rotate the shape. Valid values range between 0 and 1 representing a \nfraction of the shape's corresponding bounding box dimension. The default value is [0.5, 0.5].",

73070

"itemtype": "config",

73071

"name": "transformOrigin",

73072

"type": "Array",

73073

"class": "VMLShape",

73074

"module": "graphics"

73075

},

73076

{

73077

"file": "graphics/js/VMLShape.js",

73078

"line": 1114,

73079

"description": "A string containing, in order, transform operations applied to the shape instance. The `transform` string can contain the following values:\n \n <dl>\n <dt>rotate</dt><dd>Rotates the shape clockwise around it transformOrigin.</dd>\n <dt>translate</dt><dd>Specifies a 2d translation.</dd>\n <dt>skew</dt><dd>Skews the shape around the x-axis and y-axis.</dd>\n <dt>scale</dt><dd>Specifies a 2d scaling operation.</dd>\n <dt>translateX</dt><dd>Translates the shape along the x-axis.</dd>\n <dt>translateY</dt><dd>Translates the shape along the y-axis.</dd>\n <dt>skewX</dt><dd>Skews the shape around the x-axis.</dd>\n <dt>skewY</dt><dd>Skews the shape around the y-axis.</dd>\n <dt>matrix</dt><dd>Specifies a 2D transformation matrix comprised of the specified six values.</dd> \n </dl>\n\nApplying transforms through the transform attribute will reset the transform matrix and apply a new transform. The shape class also contains corresponding methods for each transform\nthat will apply the transform to the current matrix. The below code illustrates how you might use the `transform` attribute to instantiate a recangle with a rotation of 45 degrees.\n var myRect = new Y.Rect({\n type:\"rect\",\n width: 50,\n height: 40,\n transform: \"rotate(45)\"\n };\nThe code below would apply `translate` and `rotate` to an existing shape.\n \n myRect.set(\"transform\", \"translate(40, 50) rotate(45)\");",

73080

"itemtype": "config",

73081

"name": "transform",

73082

"type": "String",

73083

"class": "VMLShape",

73084

"module": "graphics"

73085

},

73086

{

73087

"file": "graphics/js/VMLShape.js",

73088

"line": 1167,

73089

"description": "Indicates the x position of shape.",

73090

"itemtype": "config",

73091

"name": "x",

73092

"type": "Number",

73093

"class": "VMLShape",

73094

"module": "graphics"

73095

},

73096

{

73097

"file": "graphics/js/VMLShape.js",

73098

"line": 1177,

73099

"description": "Indicates the y position of shape.",

73100

"itemtype": "config",

73101

"name": "y",

73102

"type": "Number",

73103

"class": "VMLShape",

73104

"module": "graphics"

73105

},

73106

{

73107

"file": "graphics/js/VMLShape.js",

73108

"line": 1187,

73109

"description": "Unique id for class instance.",

73110

"itemtype": "config",

73111

"name": "id",

73112

"type": "String",

73113

"class": "VMLShape",

73114

"module": "graphics"

73115

},

73116

{

73117

"file": "graphics/js/VMLShape.js",

73118

"line": 1210,

73119

"itemtype": "config",

73120

"name": "width",

73121

"class": "VMLShape",

73122

"module": "graphics"

73123

},

73124

{

73125

"file": "graphics/js/VMLShape.js",

73126

"line": 1218,

73127

"itemtype": "config",

73128

"name": "height",

73129

"class": "VMLShape",

73130

"module": "graphics"

73131

},

73132

{

73133

"file": "graphics/js/VMLShape.js",

73134

"line": 1226,

73135

"description": "Indicates whether the shape is visible.",

73136

"itemtype": "config",

73137

"name": "visible",

73138

"type": "Boolean",

73139

"class": "VMLShape",

73140

"module": "graphics"

73141

},

73142

{

73143

"file": "graphics/js/VMLShape.js",

73144

"line": 1246,

73145

"description": "Contains information about the fill of the shape. \n <dl>\n <dt>color</dt><dd>The color of the fill.</dd>\n <dt>opacity</dt><dd>Number between 0 and 1 that indicates the opacity of the fill. The default value is 1.</dd>\n <dt>type</dt><dd>Type of fill.\n <dl>\n <dt>solid</dt><dd>Solid single color fill. (default)</dd>\n <dt>linear</dt><dd>Linear gradient fill.</dd>\n <dt>radial</dt><dd>Radial gradient fill.</dd>\n </dl>\n </dd>\n </dl>\n If a `linear` or `radial` is specified as the fill type. The following additional property is used:\n <dl>\n <dt>stops</dt><dd>An array of objects containing the following properties:\n <dl>\n <dt>color</dt><dd>The color of the stop.</dd>\n <dt>opacity</dt><dd>Number between 0 and 1 that indicates the opacity of the stop. The default value is 1. Note: No effect for IE 6 - 8</dd>\n <dt>offset</dt><dd>Number between 0 and 1 indicating where the color stop is positioned.</dd> \n </dl>\n </dd>\n Linear gradients also have the following property:\n <dt>rotation</dt><dd>Linear gradients flow left to right by default. The rotation property allows you to change the flow by rotation. (e.g. A rotation of 180 would make the gradient pain from right to left.)</dd>\n Radial gradients have the following additional properties:\n <dt>r</dt><dd>Radius of the gradient circle.</dd>\n <dt>fx</dt><dd>Focal point x-coordinate of the gradient.</dd>\n <dt>fy</dt><dd>Focal point y-coordinate of the gradient.</dd>\n </dl>\n The corresponding `SVGShape` class implements the following additional properties.\n <dl>\n <dt>cx</dt><dd>\n The x-coordinate of the center of the gradient circle. Determines where the color stop begins. The default value 0.5.\n </dd>\n <dt>cy</dt><dd>\n The y-coordinate of the center of the gradient circle. Determines where the color stop begins. The default value 0.5.\n </dd>\n </dl>\n These properties are not currently implemented in `CanvasShape` or `VMLShape`.",

73146

"itemtype": "config",

73147

"name": "fill",

73148

"type": "Object",

73149

"class": "VMLShape",

73150

"module": "graphics"

73151

},

73152

{

73153

"file": "graphics/js/VMLShape.js",

73154

"line": 1326,

73155

"description": "Contains information about the stroke of the shape.\n <dl>\n <dt>color</dt><dd>The color of the stroke.</dd>\n <dt>weight</dt><dd>Number that indicates the width of the stroke.</dd>\n <dt>opacity</dt><dd>Number between 0 and 1 that indicates the opacity of the stroke. The default value is 1.</dd>\n <dt>dashstyle</dt>Indicates whether to draw a dashed stroke. When set to \"none\", a solid stroke is drawn. When set to an array, the first index indicates the\n length of the dash. The second index indicates the length of gap.\n <dt>linecap</dt><dd>Specifies the linecap for the stroke. The following values can be specified:\n <dl>\n <dt>butt (default)</dt><dd>Specifies a butt linecap.</dd>\n <dt>square</dt><dd>Specifies a sqare linecap.</dd>\n <dt>round</dt><dd>Specifies a round linecap.</dd>\n </dl>\n </dd>\n <dt>linejoin</dt><dd>Specifies a linejoin for the stroke. The following values can be specified:\n <dl>\n <dt>round (default)</dt><dd>Specifies that the linejoin will be round.</dd>\n <dt>bevel</dt><dd>Specifies a bevel for the linejoin.</dd>\n <dt>miter limit</dt><dd>An integer specifying the miter limit of a miter linejoin. If you want to specify a linejoin of miter, you simply specify the limit as opposed to having\n separate miter and miter limit values.</dd>\n </dl>\n </dd>\n </dl>",

73156

"itemtype": "config",

73157

"name": "stroke",

73158

"type": "Object",

73159

"class": "VMLShape",

73160

"module": "graphics"

73161

},

73162

{

73163

"file": "graphics/js/VMLShape.js",

73164

"line": 1402,

73165

"description": "Dom node for the shape.",

73166

"itemtype": "config",

73167

"name": "node",

73168

"type": "HTMLElement",

73169

"readonly": "",

73170

"class": "VMLShape",

73171

"module": "graphics"

73172

},

73173

{

73174

"file": "graphics/js/VMLShape.js",

73175

"line": 1418,

73176

"description": "Reference to the container Graphic.",

73177

"itemtype": "config",

73178

"name": "graphic",

73179

"type": "Graphic",

73180

"class": "VMLShape",

73181

"module": "graphics"

73182

},

73183

{

73184

"file": "handlebars/js/yui-handlebars-base-after.js",

73185

"line": 39,

73186

"description": "Registers a helper function that will be made available to all templates.\n\nHelper functions receive the current template context as the `this` object, and\ncan also receive arguments passed by the template.",

73187

"example": [

73188

"\n\n Y.Handlebars.registerHelper('linkify', function () {\n return '<a href=\"' + Y.Escape.html(this.url) + '\">' +\n Y.Escape.html(this.text) + '</a>';\n });\n\n var source = '<ul>{{#links}}<li>{{{linkify}}}</li>{{/links}}</ul>';\n\n Y.Handlebars.render(source, {\n links: [\n {url: '/foo', text: 'Foo'},\n {url: '/bar', text: 'Bar'},\n {url: '/baz', text: 'Baz'}\n ]\n });"

73189

],

73190

"itemtype": "method",

73191

"name": "registerHelper",

73192

"params": [

73193

{

73194

"name": "name",

73195

"description": "Name of this helper.",

73196

"type": "String"

73197

},

73198

{

73199

"name": "fn",

73200

"description": "Helper function.",

73201

"type": "Function"

73202

},

73203

{

73204

"name": "inverse",

73205

"description": "If `true`, this helper will be considered an\n \"inverse\" helper, like \"unless\". This means it will only be called if the\n expression given in the template evaluates to a false or empty value.",

73206

"type": "Boolean",

73207

"optional": true,

73208

"optdefault": "false"

73209

}

73210

],

73211

"class": "Handlebars",

73212

"module": "handlebars",

73213

"submodule": "handlebars-base"

73214

},

73215

{

73216

"file": "handlebars/js/yui-handlebars-base-after.js",

73217

"line": 70,

73218

"description": "Registers a partial that will be made available to all templates.\n\nA partial is another template that can be used to render part of a larger\ntemplate. For example, a website with a common header and footer across all its\npages might use a template for each page, which would call shared partials to\nrender the headers and footers.\n\nPartials may be specified as uncompiled template strings or as compiled template\nfunctions.",

73219

"example": [

73220

"\n\n Y.Handlebars.registerPartial('header', '<h1>{{title}}</h1>');\n Y.Handlebars.registerPartial('footer', 'Copyright (c) 2011 by Me.');\n\n var source = '{{> header}} Mustaches are awesome! {{> footer}}';\n\n Y.Handlebars.render(source, {title: 'My Page About Mustaches'});"

73221

],

73222

"itemtype": "method",

73223

"name": "registerPartial",

73224

"params": [

73225

{

73226

"name": "name",

73227

"description": "Name of this partial.",

73228

"type": "String"

73229

},

73230

{

73231

"name": "partial",

73232

"description": "Template string or compiled template function.",

73233

"type": "Function|String"

73234

}

73235

],

73236

"class": "Handlebars",

73237

"module": "handlebars",

73238

"submodule": "handlebars-base"

73239

},

73240

{

73241

"file": "handlebars/js/yui-handlebars-base-after.js",

73242

"line": 95,

73243

"description": "Converts a precompiled template into a renderable template function.",

73244

"example": [

73245

"\n\n <script src=\"precompiled-template.js\"></script>\n <script>\n YUI().use('handlebars-base', function (Y) {\n // Convert the precompiled template function into a renderable template\n // function.\n var template = Y.Handlebars.template(precompiledTemplate);\n\n // Render it.\n template({pie: 'Pumpkin'});\n });\n </script>"

73246

],

73247

"itemtype": "method",

73248

"name": "template",

73249

"params": [

73250

{

73251

"name": "template",

73252

"description": "Precompiled Handlebars template function.",

73253

"type": "Function"

73254

}

73255

],

73256

"return": {

73257

"description": "Compiled template function.",

73258

"type": "Function"

73259

},

73260

"class": "Handlebars",

73261

"module": "handlebars",

73262

"submodule": "handlebars-base"

73263

},

73264

{

73265

"file": "handlebars/js/yui-handlebars-compiler-after.js",

73266

"line": 14,

73267

"description": "Logs a debugging message. Note that messages will only be logged when the\nhandlebars module is loaded in \"debug\" mode.",

73268

"itemtype": "method",

73269

"name": "log",

73270

"params": [

73271

{

73272

"name": "level",

73273

"description": "Log level for this message. Supported levels are \"debug\",\n \"info\", \"warn\", and \"error\".",

73274

"type": "String"

73275

},

73276

{

73277

"name": "message",

73278

"description": "Message to log.",

73279

"type": "String"

73280

}

73281

],

73282

"class": "Handlebars",

73283

"module": "handlebars",

73284

"submodule": "handlebars-compiler"

73285

},

73286

{

73287

"file": "handlebars/js/yui-handlebars-compiler-after.js",

73288

"line": 28,

73289

"description": "Compiles and renders a Handlebars template string in a single step.\n\nIf you'll be using a template more than once, it's more efficient to compile it\ninto a function once using `compile()`, and then render it whenever you need to\nby simply executing the compiled function. However, if you only need to compile\nand render a template once, `render()` is a handy shortcut for doing both in a\nsingle step.",

73290

"example": [

73291

"\n\n Y.Handlebars.render('The pie of the day is {{pie}}!', {\n pie: 'Maple Custard'\n });\n // => \"The pie of the day is Maple Custard!\""

73292

],

73293

"itemtype": "method",

73294

"name": "render",

73295

"params": [

73296

{

73297

"name": "string",

73298

"description": "Handlebars template string to render.",

73299

"type": "String"

73300

},

73301

{

73302

"name": "context",

73303

"description": "Context object to pass to the template.",

73304

"type": "Object"

73305

},

73306

{

73307

"name": "options",

73308

"description": "Compile/render options.",

73309

"type": "Object",

73310

"optional": true,

73311

"props": [

73312

{

73313

"name": "helpers",

73314

"description": "Helper functions.",

73315

"type": "Object",

73316

"optional": true

73317

},

73318

{

73319

"name": "partials",

73320

"description": "Partials.",

73321

"type": "Object",

73322

"optional": true

73323

},

73324

{

73325

"name": "data",

73326

"description": "Data.",

73327

"type": "Object",

73328

"optional": true

73329

}

73330

]

73331

}

73332

],

73333

"return": {

73334

"description": "Rendered template string.",

73335

"type": "String"

73336

},

73337

"class": "Handlebars",

73338

"module": "handlebars",

73339

"submodule": "handlebars-compiler"

73340

},

73341

{

73342

"file": "handlebars/js/yui-handlebars-compiler-after.js",

73343

"line": 60,

73344

"description": "Compiles a Handlebars template string into a function. To render the template,\ncall the function and pass in a context object.",

73345

"example": [

73346

"\n\n var template = Y.Handlebars.compile('The pie of the day is {{pie}}!.');\n template({pie: 'Pecan'});\n // => \"The pie of the day is Pecan!\""

73347

],

73348

"itemtype": "method",

73349

"name": "compile",

73350

"params": [

73351

{

73352

"name": "string",

73353

"description": "Handlebars template string to compile.",

73354

"type": "String"

73355

},

73356

{

73357

"name": "options",

73358

"description": "Compiler options.",

73359

"type": "Object",

73360

"optional": true

73361

}

73362

],

73363

"return": {

73364

"description": "Compiled template function.",

73365

"type": "Function"

73366

},

73367

"class": "Handlebars",

73368

"module": "handlebars",

73369

"submodule": "handlebars-compiler"

73370

},

73371

{

73372

"file": "handlebars/js/yui-handlebars-compiler-after.js",

73373

"line": 76,

73374

"description": "Precompiles a Handlebars template string into a string of JavaScript code. This\ncan be used to precompile a template at build time or on the server, and the\nresulting template can then be rendered at runtime or on the client without\nneeding to go through a compile step.\n\nTo render a precompiled template, evaluate the code and then pass the resulting\nfunction to `Y.Handlebars.template()` to get back an executable template\nfunction.",

73375

"itemtype": "method",

73376

"name": "precompile",

73377

"params": [

73378

{

73379

"name": "string",

73380

"description": "Handlebars template string to compile.",

73381

"type": "String"

73382

},

73383

{

73384

"name": "options",

73385

"description": "Compiler options.",

73386

"type": "Object",

73387

"optional": true

73388

}

73389

],

73390

"return": {

73391

"description": "Precompiled template code.",

73392

"type": "String"

73393

},

73394

"class": "Handlebars",

73395

"module": "handlebars",

73396

"submodule": "handlebars-compiler"

73397

},

73398

{

73399

"file": "highlight/js/highlight-accentfold.js",

73400

"line": 21,

73401

"description": "Accent-folding version of `all()`.",

73402

"itemtype": "method",

73403

"name": "allFold",

73404

"params": [

73405

{

73406

"name": "haystack",

73407

"description": "String to apply highlighting to.",

73408

"type": "String"

73409

},

73410

{

73411

"name": "needles",

73412

"description": "String or array of strings that should be\n highlighted.",

73413

"type": "String|String[]"

73414

},

73415

{

73416

"name": "options",

73417

"description": "Options object.",

73418

"type": "Object",

73419

"optional": true,

73420

"props": [

73421

{

73422

"name": "startsWith",

73423

"description": "If `true`, matches must be\n anchored to the beginning of the string.",

73424

"type": "Boolean",

73425

"optional": true,

73426

"optdefault": "false"

73427

}

73428

]

73429

}

73430

],

73431

"return": {

73432

"description": "Escaped and highlighted copy of _haystack_.",

73433

"type": "String"

73434

},

73435

"static": 1,

73436

"class": "Highlight",

73437

"module": "highlight",

73438

"submodule": "highlight-accentfold"

73439

},

73440

{

73441

"file": "highlight/js/highlight-accentfold.js",

73442

"line": 100,

73443

"description": "Accent-folding version of `start()`.",

73444

"itemtype": "method",

73445

"name": "startFold",

73446

"params": [

73447

{

73448

"name": "haystack",

73449

"description": "String to apply highlighting to.",

73450

"type": "String"

73451

},

73452

{

73453

"name": "needles",

73454

"description": "String or array of strings that should be\n highlighted.",

73455

"type": "String|String[]"

73456

}

73457

],

73458

"return": {

73459

"description": "Escaped and highlighted copy of _haystack_.",

73460

"type": "String"

73461

},

73462

"static": 1,

73463

"class": "Highlight",

73464

"module": "highlight",

73465

"submodule": "highlight-accentfold"

73466

},

73467

{

73468

"file": "highlight/js/highlight-accentfold.js",

73469

"line": 114,

73470

"description": "Accent-folding version of `words()`.",

73471

"itemtype": "method",

73472

"name": "wordsFold",

73473

"params": [

73474

{

73475

"name": "haystack",

73476

"description": "String to apply highlighting to.",

73477

"type": "String"

73478

},

73479

{

73480

"name": "needles",

73481

"description": "String or array of strings containing words\n that should be highlighted. If a string is passed, it will be split\n into words; if an array is passed, it is assumed to have already been\n split.",

73482

"type": "String|String[]"

73483

}

73484

],

73485

"return": {

73486

"description": "Escaped and highlighted copy of _haystack_.",

73487

"type": "String"

73488

},

73489

"static": 1,

73490

"class": "Highlight",

73491

"module": "highlight",

73492

"submodule": "highlight-accentfold"

73493

},

73494

{

73495

"file": "highlight/js/highlight-base.js",

73496

"line": 42,

73497

"description": "Regular expression template for highlighting a match that occurs anywhere\nin a string. The placeholder `%needles` will be replaced with a list of\nneedles to match, joined by `|` characters.\n\nThis regex should have two capturing subpatterns:\n\n 1. Zero or one unclosed HTML entity (e.g. \"&amp\" without a \";\" at the\n end).\n 2. The `%needles` placeholder.\n\nThe first subpattern match is used to emulate a negative lookbehind\nassertion in order to prevent highlighting inside HTML entities.",

73498

"itemtype": "property",

73499

"name": "_REGEX",

73500

"type": "String",

73501

"access": "protected",

73502

"tagname": "",

73503

"static": 1,

73504

"final": 1,

73505

"class": "Highlight",

73506

"module": "highlight",

73507

"submodule": "highlight-base"

73508

},

73509

{

73510

"file": "highlight/js/highlight-base.js",

73511

"line": 64,

73512

"description": "Regex replacer function or string for normal matches.",

73513

"itemtype": "property",

73514

"name": "_REPLACER",

73515

"type": "Function|String",

73516

"access": "protected",

73517

"tagname": "",

73518

"static": 1,

73519

"final": 1,

73520

"class": "Highlight",

73521

"module": "highlight",

73522

"submodule": "highlight-base"

73523

},

73524

{

73525

"file": "highlight/js/highlight-base.js",

73526

"line": 81,

73527

"description": "Regular expression template for highlighting start-of-string matches\n(i.e., only matches that occur at the beginning of a string). The\nplaceholder `%needles` will be replaced with a list of needles to match,\njoined by `|` characters.\n\nSee `_REGEX` for a description of the capturing subpatterns this regex\nstring should contain.",

73528

"itemtype": "property",

73529

"name": "_START_REGEX",

73530

"type": "String",

73531

"access": "protected",

73532

"tagname": "",

73533

"static": 1,

73534

"final": 1,

73535

"class": "Highlight",

73536

"module": "highlight",

73537

"submodule": "highlight-base"

73538

},

73539

{

73540

"file": "highlight/js/highlight-base.js",

73541

"line": 98,

73542

"description": "Highlight template which will be used as a replacement for matched\nsubstrings. The placeholder `{s}` will be replaced with the matched\nsubstring.",

73543

"itemtype": "property",

73544

"name": "_TEMPLATE",

73545

"type": "String",

73546

"default": "'{s}'",

73547

"access": "protected",

73548

"tagname": "",

73549

"static": 1,

73550

"final": 1,

73551

"class": "Highlight",

73552

"module": "highlight",

73553

"submodule": "highlight-base"

73554

},

73555

{

73556

"file": "highlight/js/highlight-base.js",

73557

"line": 114,

73558

"description": "Highlights all occurrences in the _haystack_ string of the items in the\n_needles_ array, regardless of where they occur. The returned string will\nhave all HTML characters escaped except for the highlighting markup.",

73559

"itemtype": "method",

73560

"name": "all",

73561

"params": [

73562

{

73563

"name": "haystack",

73564

"description": "String to apply highlighting to.",

73565

"type": "String"

73566

},

73567

{

73568

"name": "needles",

73569

"description": "String or array of strings that should be\n highlighted.",

73570

"type": "String|String[]"

73571

},

73572

{

73573

"name": "options",

73574

"description": "Options object.",

73575

"type": "Object",

73576

"optional": true,

73577

"props": [

73578

{

73579

"name": "caseSensitive",

73580

"description": "If `true`, matching will\n be case-sensitive.",

73581

"type": "Boolean",

73582

"optional": true,

73583

"optdefault": "false"

73584

},

73585

{

73586

"name": "startsWith",

73587

"description": "If `true`, matches must be\n anchored to the beginning of the string.",

73588

"type": "Boolean",

73589

"optional": true,

73590

"optdefault": "false"

73591

}

73592

]

73593

}

73594

],

73595

"return": {

73596

"description": "Escaped and highlighted copy of _haystack_.",

73597

"type": "String"

73598

},

73599

"static": 1,

73600

"class": "Highlight",

73601

"module": "highlight",

73602

"submodule": "highlight-base"

73603

},

73604

{

73605

"file": "highlight/js/highlight-base.js",

73606

"line": 175,

73607

"description": "Same as `all()`, but case-sensitive by default.",

73608

"itemtype": "method",

73609

"name": "allCase",

73610

"params": [

73611

{

73612

"name": "haystack",

73613

"description": "String to apply highlighting to.",

73614

"type": "String"

73615

},

73616

{

73617

"name": "needles",

73618

"description": "String or array of strings that should be\n highlighted.",

73619

"type": "String|String[]"

73620

},

73621

{

73622

"name": "options",

73623

"description": "Options object. See `all()` for details.",

73624

"type": "Object",

73625

"optional": true

73626

}

73627

],

73628

"return": {

73629

"description": "Escaped and highlighted copy of _haystack_.",

73630

"type": "String"

73631

},

73632

"static": 1,

73633

"class": "Highlight",

73634

"module": "highlight",

73635

"submodule": "highlight-base"

73636

},

73637

{

73638

"file": "highlight/js/highlight-base.js",

73639

"line": 191,

73640

"description": "Highlights _needles_ that occur at the start of _haystack_. The returned\nstring will have all HTML characters escaped except for the highlighting\nmarkup.",

73641

"itemtype": "method",

73642

"name": "start",

73643

"params": [

73644

{

73645

"name": "haystack",

73646

"description": "String to apply highlighting to.",

73647

"type": "String"

73648

},

73649

{

73650

"name": "needles",

73651

"description": "String or array of strings that should be\n highlighted.",

73652

"type": "String|String[]"

73653

},

73654

{

73655

"name": "options",

73656

"description": "Options object.",

73657

"type": "Object",

73658

"optional": true,

73659

"props": [

73660

{

73661

"name": "caseSensitive",

73662

"description": "If `true`, matching will\n be case-sensitive.",

73663

"type": "Boolean",

73664

"optional": true,

73665

"optdefault": "false"

73666

}

73667

]

73668

}

73669

],

73670

"return": {

73671

"description": "Escaped and highlighted copy of _haystack_.",

73672

"type": "String"

73673

},

73674

"static": 1,

73675

"class": "Highlight",

73676

"module": "highlight",

73677

"submodule": "highlight-base"

73678

},

73679

{

73680

"file": "highlight/js/highlight-base.js",

73681

"line": 211,

73682

"description": "Same as `start()`, but case-sensitive by default.",

73683

"itemtype": "method",

73684

"name": "startCase",

73685

"params": [

73686

{

73687

"name": "haystack",

73688

"description": "String to apply highlighting to.",

73689

"type": "String"

73690

},

73691

{

73692

"name": "needles",

73693

"description": "String or array of strings that should be\n highlighted.",

73694

"type": "String|String[]"

73695

}

73696

],

73697

"return": {

73698

"description": "Escaped and highlighted copy of _haystack_.",

73699

"type": "String"

73700

},

73701

"static": 1,

73702

"class": "Highlight",

73703

"module": "highlight",

73704

"submodule": "highlight-base"

73705

},

73706

{

73707

"file": "highlight/js/highlight-base.js",

73708

"line": 228,

73709

"description": "Highlights complete words in the _haystack_ string that are also in the\n_needles_ array. The returned string will have all HTML characters escaped\nexcept for the highlighting markup.",

73710

"itemtype": "method",

73711

"name": "words",

73712

"params": [

73713

{

73714

"name": "haystack",

73715

"description": "String to apply highlighting to.",

73716

"type": "String"

73717

},

73718

{

73719

"name": "needles",

73720

"description": "String or array of strings containing words\n that should be highlighted. If a string is passed, it will be split\n into words; if an array is passed, it is assumed to have already been\n split.",

73721

"type": "String|String[]"

73722

},

73723

{

73724

"name": "options",

73725

"description": "Options object.",

73726

"type": "Object",

73727

"optional": true,

73728

"props": [

73729

{

73730

"name": "caseSensitive",

73731

"description": "If `true`, matching will\n be case-sensitive.",

73732

"type": "Boolean",

73733

"optional": true,

73734

"optdefault": "false"

73735

}

73736

]

73737

}

73738

],

73739

"return": {

73740

"description": "Escaped and highlighted copy of _haystack_.",

73741

"type": "String"

73742

},

73743

"static": 1,

73744

"class": "Highlight",

73745

"module": "highlight",

73746

"submodule": "highlight-base"

73747

},

73748

{

73749

"file": "highlight/js/highlight-base.js",

73750

"line": 287,

73751

"description": "Same as `words()`, but case-sensitive by default.",

73752

"itemtype": "method",

73753

"name": "wordsCase",

73754

"params": [

73755

{

73756

"name": "haystack",

73757

"description": "String to apply highlighting to.",

73758

"type": "String"

73759

},

73760

{

73761

"name": "needles",

73762

"description": "String or array of strings containing words\n that should be highlighted. If a string is passed, it will be split\n into words; if an array is passed, it is assumed to have already been\n split.",

73763

"type": "String|String[]"

73764

}

73765

],

73766

"return": {

73767

"description": "Escaped and highlighted copy of _haystack_.",

73768

"type": "String"

73769

},

73770

"static": 1,

73771

"class": "Highlight",

73772

"module": "highlight",

73773

"submodule": "highlight-base"

73774

},

73775

{

73776

"file": "history/js/history-base.js",

73777

"line": 72,

73778

"description": "Returns <code>true</code> if value is a simple object and not a\nfunction or an array.",

73779

"itemtype": "method",

73780

"name": "_isSimpleObject",

73781

"params": [

73782

{

73783

"name": "value",

73784

"description": "",

73785

"type": "Mixed"

73786

}

73787

],

73788

"return": {

73789

"description": "",

73790

"type": "Boolean"

73791

},

73792

"access": "private",

73793

"tagname": "",

73794

"class": "HistoryBase",

73795

"module": "history",

73796

"submodule": "history-base"

73797

},

73798

{

73799

"file": "history/js/history-base.js",

73800

"line": 87,

73801

"description": "Name of this component.",

73802

"itemtype": "property",

73803

"name": "NAME",

73804

"type": "String",

73805

"static": 1,

73806

"class": "HistoryBase",

73807

"module": "history",

73808

"submodule": "history-base"

73809

},

73810

{

73811

"file": "history/js/history-base.js",

73812

"line": 96,

73813

"description": "Constant used to identify state changes originating from the\n<code>add()</code> method.",

73814

"itemtype": "property",

73815

"name": "SRC_ADD",

73816

"type": "String",

73817

"static": 1,

73818

"final": 1,

73819

"class": "HistoryBase",

73820

"module": "history",

73821

"submodule": "history-base"

73822

},

73823

{

73824

"file": "history/js/history-base.js",

73825

"line": 107,

73826

"description": "Constant used to identify state changes originating from the\n<code>replace()</code> method.",

73827

"itemtype": "property",

73828

"name": "SRC_REPLACE",

73829

"type": "String",

73830

"static": 1,

73831

"final": 1,

73832

"class": "HistoryBase",

73833

"module": "history",

73834

"submodule": "history-base"

73835

},

73836

{

73837

"file": "history/js/history-base.js",

73838

"line": 118,

73839

"description": "Whether or not this browser supports the HTML5 History API.",

73840

"itemtype": "property",

73841

"name": "html5",

73842

"type": "Boolean",

73843

"static": 1,

73844

"class": "HistoryBase",

73845

"module": "history",

73846

"submodule": "history-base"

73847

},

73848

{

73849

"file": "history/js/history-base.js",

73850

"line": 133,

73851

"description": "Whether or not this browser supports the <code>window.onhashchange</code>\nevent natively. Note that even if this is <code>true</code>, you may\nstill want to use HistoryHash's synthetic <code>hashchange</code> event\nsince it normalizes implementation differences and fixes spec violations\nacross various browsers.",

73852

"itemtype": "property",

73853

"name": "nativeHashChange",

73854

"type": "Boolean",

73855

"static": 1,

73856

"class": "HistoryBase",

73857

"module": "history",

73858

"submodule": "history-base"

73859

},

73860

{

73861

"file": "history/js/history-base.js",

73862

"line": 158,

73863

"description": "Initializes this HistoryBase instance. This method is called by the\nconstructor.",

73864

"itemtype": "method",

73865

"name": "_init",

73866

"params": [

73867

{

73868

"name": "config",

73869

"description": "configuration object",

73870

"type": "Object"

73871

}

73872

],

73873

"access": "protected",

73874

"tagname": "",

73875

"class": "HistoryBase",

73876

"module": "history",

73877

"submodule": "history-base"

73878

},

73879

{

73880

"file": "history/js/history-base.js",

73881

"line": 169,

73882

"description": "Configuration object provided by the user on instantiation, or an\nempty object if one wasn't provided.",

73883

"itemtype": "property",

73884

"name": "_config",

73885

"type": "Object",

73886

"default": "{}",

73887

"access": "protected",

73888

"tagname": "",

73889

"class": "HistoryBase",

73890

"module": "history",

73891

"submodule": "history-base"

73892

},

73893

{

73894

"file": "history/js/history-base.js",

73895

"line": 180,

73896

"description": "If `true`, a `history:change` event will be fired whenever the URL\nchanges, even if there is no associated state change.",

73897

"itemtype": "property",

73898

"name": "force",

73899

"type": "Boolean",

73900

"default": "false",

73901

"class": "HistoryBase",

73902

"module": "history",

73903

"submodule": "history-base"

73904

},

73905

{

73906

"file": "history/js/history-base.js",

73907

"line": 190,

73908

"description": "Resolved initial state: a merge of the user-supplied initial state\n(if any) and any initial state provided by a subclass. This may\ndiffer from <code>_config.initialState</code>. If neither the config\nnor a subclass supplies an initial state, this property will be\n<code>null</code>.",

73909

"itemtype": "property",

73910

"name": "_initialState",

73911

"type": "Object|null",

73912

"default": "{}",

73913

"access": "protected",

73914

"tagname": "",

73915

"class": "HistoryBase",

73916

"module": "history",

73917

"submodule": "history-base"

73918

},

73919

{

73920

"file": "history/js/history-base.js",

73921

"line": 205,

73922

"description": "Fired when the state changes. To be notified of all state changes\nregardless of the History or YUI instance that generated them,\nsubscribe to this event on <code>Y.Global</code>. If you would rather\nbe notified only about changes generated by this specific History\ninstance, subscribe to this event on the instance.",

73923

"itemtype": "event",

73924

"name": "history:change",

73925

"params": [

73926

{

73927

"name": "e",

73928

"description": "Event facade with the following additional\n properties:\n\n<dl>\n <dt>changed (Object)</dt>\n <dd>\n Object hash of state items that have been added or changed. The\n key is the item key, and the value is an object containing\n <code>newVal</code> and <code>prevVal</code> properties\n representing the values of the item both before and after the\n change. If the item was newly added, <code>prevVal</code> will be\n <code>undefined</code>.\n </dd>\n\n <dt>newVal (Object)</dt>\n <dd>\n Object hash of key/value pairs of all state items after the\n change.\n </dd>\n\n <dt>prevVal (Object)</dt>\n <dd>\n Object hash of key/value pairs of all state items before the\n change.\n </dd>\n\n <dt>removed (Object)</dt>\n <dd>\n Object hash of key/value pairs of state items that have been\n removed. Values are the old values prior to removal.\n </dd>\n\n <dt>src (String)</dt>\n <dd>\n The source of the event. This can be used to selectively ignore\n events generated by certain sources.\n </dd>\n</dl>",

73929

"type": "EventFacade"

73930

}

73931

],

73932

"class": "HistoryBase",

73933

"module": "history",

73934

"submodule": "history-base"

73935

},

73936

{

73937

"file": "history/js/history-base.js",

73938

"line": 265,

73939

"description": "Adds a state entry with new values for the specified keys. By default,\nthe new state will be merged into the existing state, and new values will\noverride existing values. Specifying a <code>null</code> or\n<code>undefined</code> value will cause that key to be removed from the\nnew state entry.",

73940

"itemtype": "method",

73941

"name": "add",

73942

"params": [

73943

{

73944

"name": "state",

73945

"description": "Object hash of key/value pairs.",

73946

"type": "Object"

73947

},

73948

{

73949

"name": "options",

73950

"description": "(optional) Zero or more of the following options:\n <dl>\n <dt>merge (Boolean)</dt>\n <dd>\n \n If <code>true</code> (the default), the new state will be merged\n into the existing state. New values will override existing values,\n and <code>null</code> or <code>undefined</code> values will be\n removed from the state.\n \n\n \n If <code>false</code>, the existing state will be discarded as a\n whole and the new state will take its place.\n \n </dd>\n </dl>",

73951

"type": "Object"

73952

}

73953

],

73954

"chainable": 1,

73955

"class": "HistoryBase",

73956

"module": "history",

73957

"submodule": "history-base"

73958

},

73959

{

73960

"file": "history/js/history-base.js",

73961

"line": 299,

73962

"description": "Adds a state entry with a new value for a single key. By default, the new\nvalue will be merged into the existing state values, and will override an\nexisting value with the same key if there is one. Specifying a\n<code>null</code> or <code>undefined</code> value will cause the key to\nbe removed from the new state entry.",

73963

"itemtype": "method",

73964

"name": "addValue",

73965

"params": [

73966

{

73967

"name": "key",

73968

"description": "State parameter key.",

73969

"type": "String"

73970

},

73971

{

73972

"name": "value",

73973

"description": "New value.",

73974

"type": "String"

73975

},

73976

{

73977

"name": "options",

73978

"description": "(optional) Zero or more options. See\n <code>add()</code> for a list of supported options.",

73979

"type": "Object"

73980

}

73981

],

73982

"chainable": 1,

73983

"class": "HistoryBase",

73984

"module": "history",

73985

"submodule": "history-base"

73986

},

73987

{

73988

"file": "history/js/history-base.js",

73989

"line": 319,

73990

"description": "Returns the current value of the state parameter specified by key,\nor an object hash of key/value pairs for all current state parameters if\nno key is specified.",

73991

"itemtype": "method",

73992

"name": "get",

73993

"params": [

73994

{

73995

"name": "key",

73996

"description": "(optional) State parameter key.",

73997

"type": "String"

73998

}

73999

],

74000

"return": {

74001

"description": "Value of the specified state parameter, or an\n object hash of key/value pairs for all current state parameters.",

74002

"type": "Object|String"

74003

},

74004

"class": "HistoryBase",

74005

"module": "history",

74006

"submodule": "history-base"

74007

},

74008

{

74009

"file": "history/js/history-base.js",

74010

"line": 340,

74011

"description": "Same as <code>add()</code> except that a new browser history entry will\nnot be created. Instead, the current history entry will be replaced with\nthe new state.",

74012

"itemtype": "method",

74013

"name": "replace",

74014

"params": [

74015

{

74016

"name": "state",

74017

"description": "Object hash of key/value pairs.",

74018

"type": "Object"

74019

},

74020

{

74021

"name": "options",

74022

"description": "(optional) Zero or more options. See\n <code>add()</code> for a list of supported options.",

74023

"type": "Object"

74024

}

74025

],

74026

"chainable": 1,

74027

"class": "HistoryBase",

74028

"module": "history",

74029

"submodule": "history-base"

74030

},

74031

{

74032

"file": "history/js/history-base.js",

74033

"line": 357,

74034

"description": "Same as <code>addValue()</code> except that a new browser history entry\nwill not be created. Instead, the current history entry will be replaced\nwith the new state.",

74035

"itemtype": "method",

74036

"name": "replaceValue",

74037

"params": [

74038

{

74039

"name": "key",

74040

"description": "State parameter key.",

74041

"type": "String"

74042

},

74043

{

74044

"name": "value",

74045

"description": "New value.",

74046

"type": "String"

74047

},

74048

{

74049

"name": "options",

74050

"description": "(optional) Zero or more options. See\n <code>add()</code> for a list of supported options.",

74051

"type": "Object"

74052

}

74053

],

74054

"chainable": 1,

74055

"class": "HistoryBase",

74056

"module": "history",

74057

"submodule": "history-base"

74058

},

74059

{

74060

"file": "history/js/history-base.js",

74061

"line": 377,

74062

"description": "Changes the state. This method provides a common implementation shared by\nthe public methods for changing state.",

74063

"itemtype": "method",

74064

"name": "_change",

74065

"params": [

74066

{

74067

"name": "src",

74068

"description": "Source of the change, for inclusion in event facades\n to facilitate filtering.",

74069

"type": "String"

74070

},

74071

{

74072

"name": "state",

74073

"description": "Object hash of key/value pairs.",

74074

"type": "Object"

74075

},

74076

{

74077

"name": "options",

74078

"description": "(optional) Zero or more options. See\n <code>add()</code> for a list of supported options.",

74079

"type": "Object"

74080

}

74081

],

74082

"access": "protected",

74083

"tagname": "",

74084

"chainable": 1,

74085

"class": "HistoryBase",

74086

"module": "history",

74087

"submodule": "history-base"

74088

},

74089

{

74090

"file": "history/js/history-base.js",

74091

"line": 402,

74092

"description": "Called by _resolveChanges() when the state has changed. This method takes\ncare of actually firing the necessary events.",

74093

"itemtype": "method",

74094

"name": "_fireEvents",

74095

"params": [

74096

{

74097

"name": "src",

74098

"description": "Source of the changes, for inclusion in event facades\n to facilitate filtering.",

74099

"type": "String"

74100

},

74101

{

74102

"name": "changes",

74103

"description": "Resolved changes.",

74104

"type": "Object"

74105

},

74106

{

74107

"name": "options",

74108

"description": "Zero or more options. See <code>add()</code> for\n a list of supported options.",

74109

"type": "Object"

74110

}

74111

],

74112

"access": "protected",

74113

"tagname": "",

74114

"class": "HistoryBase",

74115

"module": "history",

74116

"submodule": "history-base"

74117

},

74118

{

74119

"file": "history/js/history-base.js",

74120

"line": 435,

74121

"description": "Fires a dynamic \"[key]Change\" event.",

74122

"itemtype": "method",

74123

"name": "_fireChangeEvent",

74124

"params": [

74125

{

74126

"name": "src",

74127

"description": "source of the change, for inclusion in event facades\n to facilitate filtering",

74128

"type": "String"

74129

},

74130

{

74131

"name": "key",

74132

"description": "key of the item that was changed",

74133

"type": "String"

74134

},

74135

{

74136

"name": "value",

74137

"description": "object hash containing newVal and\n prevVal properties for the changed item",

74138

"type": "Object"

74139

}

74140

],

74141

"access": "protected",

74142

"tagname": "",

74143

"class": "HistoryBase",

74144

"module": "history",

74145

"submodule": "history-base"

74146

},

74147

{

74148

"file": "history/js/history-base.js",

74149

"line": 447,

74150

"description": "\nDynamic event fired when an individual history item is added or\nchanged. The name of this event depends on the name of the key that\nchanged. To listen to change events for a key named \"foo\", subscribe\nto the <code>fooChange</code> event; for a key named \"bar\", subscribe\nto <code>barChange</code>, etc.\n\n\n\nKey-specific events are only fired for instance-level changes; that\nis, changes that were made via the same History instance on which the\nevent is subscribed. To be notified of changes made by other History\ninstances, subscribe to the global <code>history:change</code> event.\n",

74151

"itemtype": "event",

74152

"name": "[key]Change",

74153

"params": [

74154

{

74155

"name": "e",

74156

"description": "Event facade with the following additional\n properties:\n\n<dl>\n <dt>newVal (mixed)</dt>\n <dd>\n The new value of the item after the change.\n </dd>\n\n <dt>prevVal (mixed)</dt>\n <dd>\n The previous value of the item before the change, or\n <code>undefined</code> if the item was just added and has no\n previous value.\n </dd>\n\n <dt>src (String)</dt>\n <dd>\n The source of the event. This can be used to selectively ignore\n events generated by certain sources.\n </dd>\n</dl>",

74157

"type": "EventFacade"

74158

}

74159

],

74160

"class": "HistoryBase",

74161

"module": "history",

74162

"submodule": "history-base"

74163

},

74164

{

74165

"file": "history/js/history-base.js",

74166

"line": 494,

74167

"description": "Fires a dynamic \"[key]Remove\" event.",

74168

"itemtype": "method",

74169

"name": "_fireRemoveEvent",

74170

"params": [

74171

{

74172

"name": "src",

74173

"description": "source of the change, for inclusion in event facades\n to facilitate filtering",

74174

"type": "String"

74175

},

74176

{

74177

"name": "key",

74178

"description": "key of the item that was removed",

74179

"type": "String"

74180

},

74181

{

74182

"name": "value",

74183

"description": "value of the item prior to its removal",

74184

"type": "Mixed"

74185

}

74186

],

74187

"access": "protected",

74188

"tagname": "",

74189

"class": "HistoryBase",

74190

"module": "history",

74191

"submodule": "history-base"

74192

},

74193

{

74194

"file": "history/js/history-base.js",

74195

"line": 505,

74196

"description": "\nDynamic event fired when an individual history item is removed. The\nname of this event depends on the name of the key that was removed.\nTo listen to remove events for a key named \"foo\", subscribe to the\n<code>fooRemove</code> event; for a key named \"bar\", subscribe to\n<code>barRemove</code>, etc.\n\n\n\nKey-specific events are only fired for instance-level changes; that\nis, changes that were made via the same History instance on which the\nevent is subscribed. To be notified of changes made by other History\ninstances, subscribe to the global <code>history:change</code> event.\n",

74197

"itemtype": "event",

74198

"name": "[key]Remove",

74199

"params": [

74200

{

74201

"name": "e",

74202

"description": "Event facade with the following additional\n properties:\n\n<dl>\n <dt>prevVal (mixed)</dt>\n <dd>\n The value of the item before it was removed.\n </dd>\n\n <dt>src (String)</dt>\n <dd>\n The source of the event. This can be used to selectively ignore\n events generated by certain sources.\n </dd>\n</dl>",

74203

"type": "EventFacade"

74204

}

74205

],

74206

"class": "HistoryBase",

74207

"module": "history",

74208

"submodule": "history-base"

74209

},

74210

{

74211

"file": "history/js/history-base.js",

74212

"line": 544,

74213

"description": "Resolves the changes (if any) between newState and the current\nstate and fires appropriate events if things have changed.",

74214

"itemtype": "method",

74215

"name": "_resolveChanges",

74216

"params": [

74217

{

74218

"name": "src",

74219

"description": "source of the changes, for inclusion in event facades\n to facilitate filtering",

74220

"type": "String"

74221

},

74222

{

74223

"name": "newState",

74224

"description": "object hash of key/value pairs representing the\n new state",

74225

"type": "Object"

74226

},

74227

{

74228

"name": "options",

74229

"description": "Zero or more options. See <code>add()</code> for\n a list of supported options.",

74230

"type": "Object"

74231

}

74232

],

74233

"access": "protected",

74234

"tagname": "",

74235

"class": "HistoryBase",

74236

"module": "history",

74237

"submodule": "history-base"

74238

},

74239

{

74240

"file": "history/js/history-base.js",

74241

"line": 603,

74242

"description": "Stores the specified state. Don't call this method directly; go through\n_resolveChanges() to ensure that changes are resolved and all events are\nfired properly.",

74243

"itemtype": "method",

74244

"name": "_storeState",

74245

"params": [

74246

{

74247

"name": "src",

74248

"description": "source of the changes",

74249

"type": "String"

74250

},

74251

{

74252

"name": "newState",

74253

"description": "new state to store",

74254

"type": "Object"

74255

},

74256

{

74257

"name": "options",

74258

"description": "Zero or more options. See <code>add()</code> for\n a list of supported options.",

74259

"type": "Object"

74260

}

74261

],

74262

"access": "protected",

74263

"tagname": "",

74264

"class": "HistoryBase",

74265

"module": "history",

74266

"submodule": "history-base"

74267

},

74268

{

74269

"file": "history/js/history-base.js",

74270

"line": 623,

74271

"description": "Default <code>history:change</code> event handler.",

74272

"itemtype": "method",

74273

"name": "_defChangeFn",

74274

"params": [

74275

{

74276

"name": "e",

74277

"description": "state change event facade",

74278

"type": "EventFacade"

74279

}

74280

],

74281

"access": "protected",

74282

"tagname": "",

74283

"class": "HistoryBase",

74284

"module": "history",

74285

"submodule": "history-base"

74286

},

74287

{

74288

"file": "history/js/history-hash-ie.js",

74289

"line": 22,

74290

"description": "Gets the raw (not decoded) current location hash from the IE iframe,\nminus the preceding '#' character and the hashPrefix (if one is set).",

74291

"itemtype": "method",

74292

"name": "getIframeHash",

74293

"return": {

74294

"description": "current iframe hash",

74295

"type": "String"

74296

},

74297

"static": 1,

74298

"class": "HistoryHash",

74299

"module": "history",

74300

"submodule": "history-hash-ie"

74301

},

74302

{

74303

"file": "history/js/history-hash-ie.js",

74304

"line": 42,

74305

"description": "Updates the history iframe with the specified hash.",

74306

"itemtype": "method",

74307

"name": "_updateIframe",

74308

"params": [

74309

{

74310

"name": "hash",

74311

"description": "location hash",

74312

"type": "String"

74313

},

74314

{

74315

"name": "replace",

74316

"description": "(optional) if <code>true</code>, the current\n history state will be replaced without adding a new history entry",

74317

"type": "Boolean"

74318

}

74319

],

74320

"access": "protected",

74321

"tagname": "",

74322

"static": 1,

74323

"class": "HistoryHash",

74324

"module": "history",

74325

"submodule": "history-hash-ie"

74326

},

74327

{

74328

"file": "history/js/history-hash.js",

74329

"line": 87,

74330

"description": "Handler for hashchange events.",

74331

"itemtype": "method",

74332

"name": "_afterHashChange",

74333

"params": [

74334

{

74335

"name": "e",

74336

"description": "",

74337

"type": "Event"

74338

}

74339

],

74340

"access": "protected",

74341

"tagname": "",

74342

"class": "HistoryHash",

74343

"module": "history",

74344

"submodule": "history-hash"

74345

},

74346

{

74347

"file": "history/js/history-hash.js",

74348

"line": 101,

74349

"description": "Constant used to identify state changes originating from\n<code>hashchange</code> events.",

74350

"itemtype": "property",

74351

"name": "SRC_HASH",

74352

"type": "String",

74353

"static": 1,

74354

"final": 1,

74355

"class": "HistoryHash",

74356

"module": "history",

74357

"submodule": "history-hash"

74358

},

74359

{

74360

"file": "history/js/history-hash.js",

74361

"line": 112,

74362

"description": "\nPrefix to prepend when setting the hash fragment. For example, if the\nprefix is <code>!</code> and the hash fragment is set to\n<code>#foo=bar&baz=quux</code>, the final hash fragment in the URL will\nbecome <code>#!foo=bar&baz=quux</code>. This can be used to help make an\nAjax application crawlable in accordance with Google's guidelines at\n<a href=\"http://code.google.com/web/ajaxcrawling/\">http://code.google.com/web/ajaxcrawling/</a>.\n\n\n\nNote that this prefix applies to all HistoryHash instances. It's not\npossible for individual instances to use their own prefixes since they\nall operate on the same URL.\n",

74363

"itemtype": "property",

74364

"name": "hashPrefix",

74365

"type": "String",

74366

"default": "''",

74367

"static": 1,

74368

"class": "HistoryHash",

74369

"module": "history",

74370

"submodule": "history-hash"

74371

},

74372

{

74373

"file": "history/js/history-hash.js",

74374

"line": 137,

74375

"description": "Regular expression used to parse location hash/query strings.",

74376

"itemtype": "property",

74377

"name": "_REGEX_HASH",

74378

"type": "RegExp",

74379

"access": "protected",

74380

"tagname": "",

74381

"static": 1,

74382

"final": 1,

74383

"class": "HistoryHash",

74384

"module": "history",

74385

"submodule": "history-hash"

74386

},

74387

{

74388

"file": "history/js/history-hash.js",

74389

"line": 150,

74390

"description": "Creates a location hash string from the specified object of key/value\npairs.",

74391

"itemtype": "method",

74392

"name": "createHash",

74393

"params": [

74394

{

74395

"name": "params",

74396

"description": "object of key/value parameter pairs",

74397

"type": "Object"

74398

}

74399

],

74400

"return": {

74401

"description": "location hash string",

74402

"type": "String"

74403

},

74404

"static": 1,

74405

"class": "HistoryHash",

74406

"module": "history",

74407

"submodule": "history-hash"

74408

},

74409

{

74410

"file": "history/js/history-hash.js",

74411

"line": 172,

74412

"description": "Wrapper around <code>decodeURIComponent()</code> that also converts +\nchars into spaces.",

74413

"itemtype": "method",

74414

"name": "decode",

74415

"params": [

74416

{

74417

"name": "string",

74418

"description": "string to decode",

74419

"type": "String"

74420

}

74421

],

74422

"return": {

74423

"description": "decoded string",

74424

"type": "String"

74425

},

74426

"static": 1,

74427

"class": "HistoryHash",

74428

"module": "history",

74429

"submodule": "history-hash"

74430

},

74431

{

74432

"file": "history/js/history-hash.js",

74433

"line": 185,

74434

"description": "Wrapper around <code>encodeURIComponent()</code> that converts spaces to\n+ chars.",

74435

"itemtype": "method",

74436

"name": "encode",

74437

"params": [

74438

{

74439

"name": "string",

74440

"description": "string to encode",

74441

"type": "String"

74442

}

74443

],

74444

"return": {

74445

"description": "encoded string",

74446

"type": "String"

74447

},

74448

"static": 1,

74449

"class": "HistoryHash",

74450

"module": "history",

74451

"submodule": "history-hash"

74452

},

74453

{

74454

"file": "history/js/history-hash.js",

74455

"line": 198,

74456

"description": "Gets the raw (not decoded) current location hash, minus the preceding '#'\ncharacter and the hashPrefix (if one is set).",

74457

"itemtype": "method",

74458

"name": "getHash",

74459

"return": {

74460

"description": "current location hash",

74461

"type": "String"

74462

},

74463

"static": 1,

74464

"class": "HistoryHash",

74465

"module": "history",

74466

"submodule": "history-hash"

74467

},

74468

{

74469

"file": "history/js/history-hash.js",

74470

"line": 232,

74471

"description": "Gets the current bookmarkable URL.",

74472

"itemtype": "method",

74473

"name": "getUrl",

74474

"return": {

74475

"description": "current bookmarkable URL",

74476

"type": "String"

74477

},

74478

"static": 1,

74479

"class": "HistoryHash",

74480

"module": "history",

74481

"submodule": "history-hash"

74482

},

74483

{

74484

"file": "history/js/history-hash.js",

74485

"line": 243,

74486

"description": "Parses a location hash string into an object of key/value parameter\npairs. If hash is not specified, the current location hash will\nbe used.",

74487

"itemtype": "method",

74488

"name": "parseHash",

74489

"params": [

74490

{

74491

"name": "hash",

74492

"description": "(optional) location hash string",

74493

"type": "String"

74494

}

74495

],

74496

"return": {

74497

"description": "object of parsed key/value parameter pairs",

74498

"type": "Object"

74499

},

74500

"static": 1,

74501

"class": "HistoryHash",

74502

"module": "history",

74503

"submodule": "history-hash"

74504

},

74505

{

74506

"file": "history/js/history-hash.js",

74507

"line": 283,

74508

"description": "Replaces the browser's current location hash with the specified hash\nand removes all forward navigation states, without creating a new browser\nhistory entry. Automatically prepends the <code>hashPrefix</code> if one\nis set.",

74509

"itemtype": "method",

74510

"name": "replaceHash",

74511

"params": [

74512

{

74513

"name": "hash",

74514

"description": "new location hash",

74515

"type": "String"

74516

}

74517

],

74518

"static": 1,

74519

"class": "HistoryHash",

74520

"module": "history",

74521

"submodule": "history-hash"

74522

},

74523

{

74524

"file": "history/js/history-hash.js",

74525

"line": 304,

74526

"description": "Sets the browser's location hash to the specified string. Automatically\nprepends the <code>hashPrefix</code> if one is set.",

74527

"itemtype": "method",

74528

"name": "setHash",

74529

"params": [

74530

{

74531

"name": "hash",

74532

"description": "new location hash",

74533

"type": "String"

74534

}

74535

],

74536

"static": 1,

74537

"class": "HistoryHash",

74538

"module": "history",

74539

"submodule": "history-hash"

74540

},

74541

{

74542

"file": "history/js/history-hash.js",

74543

"line": 330,

74544

"description": "Synthetic <code>window.onhashchange</code> event that normalizes differences\nacross browsers and provides support for browsers that don't natively support\n<code>onhashchange</code>.\n\nThis event is provided by the <code>history-hash</code> module.",

74545

"example": [

74546

"\n\n YUI().use('history-hash', function (Y) {\n Y.on('hashchange', function (e) {\n // Handle hashchange events on the current window.\n }, Y.config.win);\n });"

74547

],

74548

"itemtype": "event",

74549

"name": "hashchange",

74550

"params": [

74551

{

74552

"name": "e",

74553

"description": "Event facade with the following additional\n properties:\n\n<dl>\n <dt>oldHash</dt>\n <dd>\n Previous hash fragment value before the change.\n </dd>\n\n <dt>oldUrl</dt>\n <dd>\n Previous URL (including the hash fragment) before the change.\n </dd>\n\n <dt>newHash</dt>\n <dd>\n New hash fragment value after the change.\n </dd>\n\n <dt>newUrl</dt>\n <dd>\n New URL (including the hash fragment) after the change.\n </dd>\n</dl>",

74554

"type": "EventFacade"

74555

}

74556

],

74557

"since": "3.2.0",

74558

"class": "YUI",

74559

"module": "history",

74560

"submodule": "history-hash"

74561

},

74562

{

74563

"file": "history/js/history-html5.js",

74564

"line": 87,

74565

"description": "Overrides HistoryBase's <code>_storeState()</code> and pushes or replaces\na history entry using the HTML5 history API when necessary.",

74566

"itemtype": "method",

74567

"name": "_storeState",

74568

"params": [

74569

{

74570

"name": "src",

74571

"description": "Source of the changes.",

74572

"type": "String"

74573

},

74574

{

74575

"name": "newState",

74576

"description": "New state to store.",

74577

"type": "Object"

74578

},

74579

{

74580

"name": "options",

74581

"description": "Zero or more options.",

74582

"type": "Object"

74583

}

74584

],

74585

"access": "protected",

74586

"tagname": "",

74587

"class": "HistoryHTML5",

74588

"module": "history",

74589

"submodule": "history-html5"

74590

},

74591

{

74592

"file": "history/js/history-html5.js",

74593

"line": 111,

74594

"description": "Handler for popstate events.",

74595

"itemtype": "method",

74596

"name": "_onPopState",

74597

"params": [

74598

{

74599

"name": "e",

74600

"description": "",

74601

"type": "Event"

74602

}

74603

],

74604

"access": "protected",

74605

"tagname": "",

74606

"class": "HistoryHTML5",

74607

"module": "history",

74608

"submodule": "history-html5"

74609

},

74610

{

74611

"file": "history/js/history-html5.js",

74612

"line": 125,

74613

"description": "Constant used to identify state changes originating from\n<code>popstate</code> events.",

74614

"itemtype": "property",

74615

"name": "SRC_POPSTATE",

74616

"type": "String",

74617

"static": 1,

74618

"final": 1,

74619

"class": "HistoryHTML5",

74620

"module": "history",

74621

"submodule": "history-html5"

74622

},

74623

{

74624

"file": "history/js/history-html5.js",

74625

"line": 143,

74626

"description": "\nIf <code>true</code>, the <code>Y.History</code> alias will always point to\n<code>Y.HistoryHTML5</code> when the history-html5 module is loaded, even if\nthe current browser doesn't support HTML5 history.\n\n\n\nIf <code>false</code>, the <code>Y.History</code> alias will always point to\n<code>Y.HistoryHash</code> when the history-hash module is loaded, even if\nthe current browser supports HTML5 history.\n\n\n\nIf neither <code>true</code> nor <code>false</code>, the\n<code>Y.History</code> alias will point to the best available history adapter\nthat the browser supports. This is the default behavior.\n",

74627

"itemtype": "property",

74628

"name": "useHistoryHTML5",

74629

"type": "boolean",

74630

"since": "3.2.0",

74631

"class": "config",

74632

"module": "history",

74633

"submodule": "history-html5"

74634

},

74635

{

74636

"file": "imageloader/js/imageloader.js",

74637

"line": 25,

74638

"description": "Name for the group. Only used to identify the group in logging statements.",

74639

"itemtype": "attribute",

74640

"name": "name",

74641

"type": "String",

74642

"class": "ImgLoadGroup",

74643

"module": "imageloader"

74644

},

74645

{

74646

"file": "imageloader/js/imageloader.js",

74647

"line": 34,

74648

"description": "Time limit, in seconds, after which images are fetched regardless of trigger events.",

74649

"itemtype": "attribute",

74650

"name": "timeLimit",

74651

"type": "Number",

74652

"class": "ImgLoadGroup",

74653

"module": "imageloader"

74654

},

74655

{

74656

"file": "imageloader/js/imageloader.js",

74657

"line": 43,

74658

"description": "Distance below the fold for which images are loaded. Images are not loaded until they are at most this distance away from (or above) the fold.\nThis check is performed at page load (domready) and after any window scroll or window resize event (until all images are loaded).",

74659

"itemtype": "attribute",

74660

"name": "foldDistance",

74661

"type": "Number",

74662

"class": "ImgLoadGroup",

74663

"module": "imageloader"

74664

},

74665

{

74666

"file": "imageloader/js/imageloader.js",

74667

"line": 55,

74668

"description": "Class name that will identify images belonging to the group. This class name will be removed from each element in order to fetch images.\nThis class should have, in its CSS style definition, \"<code>background:none !important;</code>\".",

74669

"itemtype": "attribute",

74670

"name": "className",

74671

"type": "String",

74672

"class": "ImgLoadGroup",

74673

"module": "imageloader"

74674

},

74675

{

74676

"file": "imageloader/js/imageloader.js",

74677

"line": 67,

74678

"description": "Determines how to act when className is used as the way to delay load images. The \"default\" action is to just\nremove the class name. The \"enhanced\" action is to remove the class name and also set the src attribute if\nthe element is an img.",

74679

"itemtype": "attribute",

74680

"name": "classNameAction",

74681

"type": "String",

74682

"class": "ImgLoadGroup",

74683

"module": "imageloader"

74684

},

74685

{

74686

"file": "imageloader/js/imageloader.js",

74687

"line": 82,

74688

"description": "Initialize all private members needed for the group.",

74689

"itemtype": "method",

74690

"name": "_init",

74691

"access": "private",

74692

"tagname": "",

74693

"class": "ImgLoadGroup",

74694

"module": "imageloader"

74695

},

74696

{

74697

"file": "imageloader/js/imageloader.js",

74698

"line": 89,

74699

"description": "Collection of triggers for this group.\nKeeps track of each trigger's event handle, as returned from <code>Y.on</code>.",

74700

"itemtype": "property",

74701

"name": "_triggers",

74702

"access": "private",

74703

"tagname": "",

74704

"type": "Array",

74705

"class": "ImgLoadGroup",

74706

"module": "imageloader"

74707

},

74708

{

74709

"file": "imageloader/js/imageloader.js",

74710

"line": 98,

74711

"description": "Collection of images (<code>Y.ImgLoadImgObj</code> objects) registered with this group, keyed by DOM id.",

74712

"itemtype": "property",

74713

"name": "_imgObjs",

74714

"access": "private",

74715

"tagname": "",

74716

"type": "Object",

74717

"class": "ImgLoadGroup",

74718

"module": "imageloader"

74719

},

74720

{

74721

"file": "imageloader/js/imageloader.js",

74722

"line": 106,

74723

"description": "Timeout object to keep a handle on the time limit.",

74724

"itemtype": "property",

74725

"name": "_timeout",

74726

"access": "private",

74727

"tagname": "",

74728

"type": "Object",

74729

"class": "ImgLoadGroup",

74730

"module": "imageloader"

74731

},

74732

{

74733

"file": "imageloader/js/imageloader.js",

74734

"line": 114,

74735

"description": "DOM elements having the class name that is associated with this group.\nElements are stored during the <code>_foldCheck</code> function and reused later during any subsequent <code>_foldCheck</code> calls - gives a slight performance improvement when the page fold is repeatedly checked.",

74736

"itemtype": "property",

74737

"name": "_classImageEls",

74738

"access": "private",

74739

"tagname": "",

74740

"type": "Array",

74741

"class": "ImgLoadGroup",

74742

"module": "imageloader"

74743

},

74744

{

74745

"file": "imageloader/js/imageloader.js",

74746

"line": 123,

74747

"description": "Keep the CSS class name in a member variable for ease and speed.",

74748

"itemtype": "property",

74749

"name": "_className",

74750

"access": "private",

74751

"tagname": "",

74752

"type": "String",

74753

"class": "ImgLoadGroup",

74754

"module": "imageloader"

74755

},

74756

{

74757

"file": "imageloader/js/imageloader.js",

74758

"line": 131,

74759

"description": "Boolean tracking whether the window scroll and window resize triggers have been set if this is a fold group.",

74760

"itemtype": "property",

74761

"name": "_areFoldTriggersSet",

74762

"access": "private",

74763

"tagname": "",

74764

"type": "Boolean",

74765

"class": "ImgLoadGroup",

74766

"module": "imageloader"

74767

},

74768

{

74769

"file": "imageloader/js/imageloader.js",

74770

"line": 139,

74771

"description": "The maximum pixel height of the document that has been made visible.\nDuring fold checks, if the user scrolls up then there's no need to check for newly exposed images.",

74772

"itemtype": "property",

74773

"name": "_maxKnownHLimit",

74774

"access": "private",

74775

"tagname": "",

74776

"type": "Int",

74777

"class": "ImgLoadGroup",

74778

"module": "imageloader"

74779

},

74780

{

74781

"file": "imageloader/js/imageloader.js",

74782

"line": 152,

74783

"description": "Adds a trigger to the group. Arguments are passed to <code>Y.on</code>.",

74784

"itemtype": "method",

74785

"name": "addTrigger",

74786

"chainable": 1,

74787

"params": [

74788

{

74789

"name": "obj",

74790

"description": "The DOM object to attach the trigger event to",

74791

"type": "Object"

74792

},

74793

{

74794

"name": "type",

74795

"description": "The event type",

74796

"type": "String"

74797

}

74798

],

74799

"class": "ImgLoadGroup",

74800

"module": "imageloader"

74801

},

74802

{

74803

"file": "imageloader/js/imageloader.js",

74804

"line": 179,

74805

"description": "Adds a custom event trigger to the group.",

74806

"itemtype": "method",

74807

"name": "addCustomTrigger",

74808

"chainable": 1,

74809

"params": [

74810

{

74811

"name": "name",

74812

"description": "The name of the event",

74813

"type": "String"

74814

},

74815

{

74816

"name": "obj",

74817

"description": "The object on which to attach the event. <code>obj</code> is optional - by default the event is attached to the <code>Y</code> instance",

74818

"type": "Object"

74819

}

74820

],

74821

"class": "ImgLoadGroup",

74822

"module": "imageloader"

74823

},

74824

{

74825

"file": "imageloader/js/imageloader.js",

74826

"line": 207,

74827

"description": "Sets the window scroll and window resize triggers for any group that is fold-conditional (i.e., has a fold distance set).",

74828

"itemtype": "method",

74829

"name": "_setFoldTriggers",

74830

"access": "private",

74831

"tagname": "",

74832

"class": "ImgLoadGroup",

74833

"module": "imageloader"

74834

},

74835

{

74836

"file": "imageloader/js/imageloader.js",

74837

"line": 227,

74838

"description": "Performs necessary setup at domready time.\nInitiates time limit for group; executes the fold check for the images.",

74839

"itemtype": "method",

74840

"name": "_onloadTasks",

74841

"access": "private",

74842

"tagname": "",

74843

"class": "ImgLoadGroup",

74844

"module": "imageloader"

74845

},

74846

{

74847

"file": "imageloader/js/imageloader.js",

74848

"line": 245,

74849

"description": "Returns the group's <code>fetch</code> method, with the proper closure, for use with <code>setTimeout</code>.",

74850

"itemtype": "method",

74851

"name": "_getFetchTimeout",

74852

"return": {

74853

"description": "group's <code>fetch</code> method",

74854

"type": "Function"

74855

},

74856

"access": "private",

74857

"tagname": "",

74858

"class": "ImgLoadGroup",

74859

"module": "imageloader"

74860

},

74861

{

74862

"file": "imageloader/js/imageloader.js",

74863

"line": 256,

74864

"description": "Registers an image with the group.\nArguments are passed through to a <code>Y.ImgLoadImgObj</code> constructor; see that class' attribute documentation for detailed information. \"<code>domId</code>\" is a required attribute.",

74865

"itemtype": "method",

74866

"name": "registerImage",

74867

"params": [

74868

{

74869

"name": "",

74870

"description": "A configuration object literal with attribute name/value pairs (passed through to a <code>Y.ImgLoadImgObj</code> constructor)",

74871

"type": "Object",

74872

"multiple": true

74873

}

74874

],

74875

"return": {

74876

"description": "<code>Y.ImgLoadImgObj</code> that was registered",

74877

"type": "Object"

74878

},

74879

"class": "ImgLoadGroup",

74880

"module": "imageloader"

74881

},

74882

{

74883

"file": "imageloader/js/imageloader.js",

74884

"line": 275,

74885

"description": "Displays the images in the group.\nThis method is called when a trigger fires or the time limit expires; it shouldn't be called externally, but is not private in the rare event that it needs to be called immediately.",

74886

"itemtype": "method",

74887

"name": "fetch",

74888

"class": "ImgLoadGroup",

74889

"module": "imageloader"

74890

},

74891

{

74892

"file": "imageloader/js/imageloader.js",

74893

"line": 297,

74894

"description": "Clears the timeout and all triggers associated with the group.",

74895

"itemtype": "method",

74896

"name": "_clearTriggers",

74897

"access": "private",

74898

"tagname": "",

74899

"class": "ImgLoadGroup",

74900

"module": "imageloader"

74901

},

74902

{

74903

"file": "imageloader/js/imageloader.js",

74904

"line": 310,

74905

"description": "Checks the position of each image in the group. If any part of the image is within the specified distance (<code>foldDistance</code>) of the client viewport, the image is fetched immediately.",

74906

"itemtype": "method",

74907

"name": "_foldCheck",

74908

"access": "private",

74909

"tagname": "",

74910

"class": "ImgLoadGroup",

74911

"module": "imageloader"

74912

},

74913

{

74914

"file": "imageloader/js/imageloader.js",

74915

"line": 368,

74916

"description": "Updates a given node, removing the ImageLoader class name. If the\nnode is an img and the classNameAction is \"enhanced\", then node\nclass name is removed and also the src attribute is set to the \nimage URL as well as clearing the style background image.",

74917

"itemtype": "method",

74918

"name": "_updateNodeClassName",

74919

"params": [

74920

{

74921

"name": "node",

74922

"description": "The node to act on.",

74923

"type": "Node"

74924

}

74925

],

74926

"access": "private",

74927

"tagname": "",

74928

"class": "ImgLoadGroup",

74929

"module": "imageloader"

74930

},

74931

{

74932

"file": "imageloader/js/imageloader.js",

74933

"line": 394,

74934

"description": "Finds all elements in the DOM with the class name specified in the group. Removes the class from the element in order to let the style definitions trigger the image fetching.",

74935

"itemtype": "method",

74936

"name": "_fetchByClass",

74937

"access": "private",

74938

"tagname": "",

74939

"class": "ImgLoadGroup",

74940

"module": "imageloader"

74941

},

74942

{

74943

"file": "imageloader/js/imageloader.js",

74944

"line": 432,

74945

"description": "HTML DOM id of the image element.",

74946

"itemtype": "attribute",

74947

"name": "domId",

74948

"type": "String",

74949

"class": "ImgLoadImgObj",

74950

"module": "imageloader"

74951

},

74952

{

74953

"file": "imageloader/js/imageloader.js",

74954

"line": 442,

74955

"description": "Background URL for the image.\nFor an image whose URL is specified by \"<code>background-image</code>\" in the element's style.",

74956

"itemtype": "attribute",

74957

"name": "bgUrl",

74958

"type": "String",

74959

"class": "ImgLoadImgObj",

74960

"module": "imageloader"

74961

},

74962

{

74963

"file": "imageloader/js/imageloader.js",

74964

"line": 452,

74965

"description": "Source URL for the image.\nFor an image whose URL is specified by a \"<code>src</code>\" attribute in the DOM element.",

74966

"itemtype": "attribute",

74967

"name": "srcUrl",

74968

"type": "String",

74969

"class": "ImgLoadImgObj",

74970

"module": "imageloader"

74971

},

74972

{

74973

"file": "imageloader/js/imageloader.js",

74974

"line": 462,

74975

"description": "Pixel width of the image. Will be set as a <code>width</code> attribute on the DOM element after the image is fetched.\nDefaults to the natural width of the image (no <code>width</code> attribute will be set).\nUsually only used with src images.",

74976

"itemtype": "attribute",

74977

"name": "width",

74978

"type": "Int",

74979

"class": "ImgLoadImgObj",

74980

"module": "imageloader"

74981

},

74982

{

74983

"file": "imageloader/js/imageloader.js",

74984

"line": 473,

74985

"description": "Pixel height of the image. Will be set as a <code>height</code> attribute on the DOM element after the image is fetched.\nDefaults to the natural height of the image (no <code>height</code> attribute will be set).\nUsually only used with src images.",

74986

"itemtype": "attribute",

74987

"name": "height",

74988

"type": "Int",

74989

"class": "ImgLoadImgObj",

74990

"module": "imageloader"

74991

},

74992

{

74993

"file": "imageloader/js/imageloader.js",

74994

"line": 484,

74995

"description": "Whether the image's <code>style.visibility</code> should be set to <code>visible</code> after the image is fetched.\nUsed when setting images as <code>visibility:hidden</code> prior to image fetching.",

74996

"itemtype": "attribute",

74997

"name": "setVisible",

74998

"type": "Boolean",

74999

"class": "ImgLoadImgObj",

75000

"module": "imageloader"

75001

},

75002

{

75003

"file": "imageloader/js/imageloader.js",

75004

"line": 494,

75005

"description": "Whether the image is a PNG.\nPNG images get special treatment in that the URL is specified through AlphaImageLoader for IE, versions 6 and earlier.\nOnly used with background images.",

75006

"itemtype": "attribute",

75007

"name": "isPng",

75008

"type": "Boolean",

75009

"class": "ImgLoadImgObj",

75010

"module": "imageloader"

75011

},

75012

{

75013

"file": "imageloader/js/imageloader.js",

75014

"line": 505,

75015

"description": "AlphaImageLoader <code>sizingMethod</code> property to be set for the image.\nOnly set if <code>isPng</code> value for this image is set to <code>true</code>.\nDefaults to <code>scale</code>.",

75016

"itemtype": "attribute",

75017

"name": "sizingMethod",

75018

"type": "String",

75019

"class": "ImgLoadImgObj",

75020

"module": "imageloader"

75021

},

75022

{

75023

"file": "imageloader/js/imageloader.js",

75024

"line": 516,

75025

"description": "AlphaImageLoader <code>enabled</code> property to be set for the image.\nOnly set if <code>isPng</code> value for this image is set to <code>true</code>.\nDefaults to <code>true</code>.",

75026

"itemtype": "attribute",

75027

"name": "enabled",

75028

"type": "String",

75029

"class": "ImgLoadImgObj",

75030

"module": "imageloader"

75031

},

75032

{

75033

"file": "imageloader/js/imageloader.js",

75034

"line": 531,

75035

"description": "Initialize all private members needed for the group.",

75036

"itemtype": "method",

75037

"name": "_init",

75038

"access": "private",

75039

"tagname": "",

75040

"class": "ImgLoadImgObj",

75041

"module": "imageloader"

75042

},

75043

{

75044

"file": "imageloader/js/imageloader.js",

75045

"line": 538,

75046

"description": "Whether this image has already been fetched.\nIn the case of fold-conditional groups, images won't be fetched twice.",

75047

"itemtype": "property",

75048

"name": "_fetched",

75049

"access": "private",

75050

"tagname": "",

75051

"type": "Boolean",

75052

"class": "ImgLoadImgObj",

75053

"module": "imageloader"

75054

},

75055

{

75056

"file": "imageloader/js/imageloader.js",

75057

"line": 547,

75058

"description": "The Node object returned from <code>Y.one</code>, to avoid repeat calls to access the DOM.",

75059

"itemtype": "property",

75060

"name": "_imgEl",

75061

"access": "private",

75062

"tagname": "",

75063

"type": "Object",

75064

"class": "ImgLoadImgObj",

75065

"module": "imageloader"

75066

},

75067

{

75068

"file": "imageloader/js/imageloader.js",

75069

"line": 555,

75070

"description": "The vertical position returned from <code>getY</code>, to avoid repeat calls to access the DOM.\nThe Y position is checked only for images registered with fold-conditional groups. The position is checked first at page load (domready)\n and this caching enhancement assumes that the image's vertical position won't change after that first check.",

75071

"itemtype": "property",

75072

"name": "_yPos",

75073

"access": "private",

75074

"tagname": "",

75075

"type": "Int",

75076

"class": "ImgLoadImgObj",

75077

"module": "imageloader"

75078

},

75079

{

75080

"file": "imageloader/js/imageloader.js",

75081

"line": 566,

75082

"description": "Displays the image; puts the URL into the DOM.\nThis method shouldn't be called externally, but is not private in the rare event that it needs to be called immediately.",

75083

"itemtype": "method",

75084

"name": "fetch",

75085

"params": [

75086

{

75087

"name": "withinY",

75088

"description": "The pixel distance from the top of the page, for which if the image lies within, it will be fetched. Undefined indicates that no check should be made, and the image should always be fetched",

75089

"type": "Int"

75090

}

75091

],

75092

"return": {

75093

"description": "Whether the image has been fetched (either during this execution or previously)",

75094

"type": "Boolean"

75095

},

75096

"class": "ImgLoadImgObj",

75097

"module": "imageloader"

75098

},

75099

{

75100

"file": "imageloader/js/imageloader.js",

75101

"line": 628,

75102

"description": "Gets the object (as a <code>Y.Node</code>) of the DOM element indicated by \"<code>domId</code>\".",

75103

"itemtype": "method",

75104

"name": "_getImgEl",

75105

"return": {

75106

"description": "DOM element of the image as a <code>Y.Node</code> object",

75107

"type": "Object"

75108

},

75109

"access": "private",

75110

"tagname": "",

75111

"class": "ImgLoadImgObj",

75112

"module": "imageloader"

75113

},

75114

{

75115

"file": "imageloader/js/imageloader.js",

75116

"line": 641,

75117

"description": "Gets the Y position of the node in page coordinates.\nExpects that the page-coordinate position of the image won't change.",

75118

"itemtype": "method",

75119

"name": "_getYPos",

75120

"return": {

75121

"description": "The Y position of the image",

75122

"type": "Object"

75123

},

75124

"access": "private",

75125

"tagname": "",

75126

"class": "ImgLoadImgObj",

75127

"module": "imageloader"

75128

},

75129

{

75130

"file": "intl/js/Intl.js",

75131

"line": 22,

75132

"description": "Private method to retrieve the language hash for a given module.",

75133

"itemtype": "method",

75134

"name": "_mod",

75135

"access": "private",

75136

"tagname": "",

75137

"params": [

75138

{

75139

"name": "module",

75140

"description": "The name of the module",

75141

"type": "String"

75142

}

75143

],

75144

"return": {

75145

"description": "The hash of localized resources for the module, keyed by BCP language tag",

75146

"type": "Object"

75147

},

75148

"class": "Intl",

75149

"module": "intl"

75150

},

75151

{

75152

"file": "intl/js/Intl.js",

75153

"line": 38,

75154

"description": "Sets the active language for the given module.\n\nReturns false on failure, which would happen if the language had not been registered through the <a href=\"#method_add\">add()</a> method.",

75155

"itemtype": "method",

75156

"name": "setLang",

75157

"params": [

75158

{

75159

"name": "module",

75160

"description": "The module name.",

75161

"type": "String"

75162

},

75163

{

75164

"name": "lang",

75165

"description": "The BCP 47 language tag.",

75166

"type": "String"

75167

}

75168

],

75169

"return": {

75170

"description": "boolean true if successful, false if not."

75171

},

75172

"class": "Intl",

75173

"module": "intl"

75174

},

75175

{

75176

"file": "intl/js/Intl.js",

75177

"line": 62,

75178

"description": "Get the currently active language for the given module.",

75179

"itemtype": "method",

75180

"name": "getLang",

75181

"params": [

75182

{

75183

"name": "module",

75184

"description": "The module name.",

75185

"type": "String"

75186

}

75187

],

75188

"return": {

75189

"description": "The BCP 47 language tag.",

75190

"type": "String"

75191

},

75192

"class": "Intl",

75193

"module": "intl"

75194

},

75195

{

75196

"file": "intl/js/Intl.js",

75197

"line": 75,

75198

"description": "Register a hash of localized resources for the given module and language",

75199

"itemtype": "method",

75200

"name": "add",

75201

"params": [

75202

{

75203

"name": "module",

75204

"description": "The module name.",

75205

"type": "String"

75206

},

75207

{

75208

"name": "lang",

75209

"description": "The BCP 47 language tag.",

75210

"type": "String"

75211

},

75212

{

75213

"name": "strings",

75214

"description": "The hash of localized values, keyed by the string name.",

75215

"type": "Object"

75216

}

75217

],

75218

"class": "Intl",

75219

"module": "intl"

75220

},

75221

{

75222

"file": "intl/js/Intl.js",

75223

"line": 90,

75224

"description": "Gets the module's localized resources for the currently active language (as provided by the <a href=\"#method_getLang\">getLang</a> method).\n\nOptionally, the localized resources for alternate languages which have been added to Intl (see the <a href=\"#method_add\">add</a> method) can\nbe retrieved by providing the BCP 47 language tag as the lang parameter.\n",

75225

"itemtype": "method",

75226

"name": "get",

75227

"params": [

75228

{

75229

"name": "module",

75230

"description": "The module name.",

75231

"type": "String"

75232

},

75233

{

75234

"name": "key",

75235

"description": "Optional. A single resource key. If not provided, returns a copy (shallow clone) of all resources.",

75236

"type": "String"

75237

},

75238

{

75239

"name": "lang",

75240

"description": "Optional. The BCP 47 language tag. If not provided, the module's currently active language is used.",

75241

"type": "String"

75242

}

75243

],

75244

"return": {

75245

"description": "String | Object A copy of the module's localized resources, or a single value if key is provided."

75246

},

75247

"class": "Intl",

75248

"module": "intl"

75249

},

75250

{

75251

"file": "intl/js/Intl.js",

75252

"line": 113,

75253

"description": "Gets the list of languages for which localized resources are available for a given module, based on the module\nmeta-data (part of loader). If loader is not on the page, returns an empty array.",

75254

"itemtype": "method",

75255

"name": "getAvailableLangs",

75256

"params": [

75257

{

75258

"name": "module",

75259

"description": "The name of the module",

75260

"type": "String"

75261

}

75262

],

75263

"return": {

75264

"description": "The array of languages available.",

75265

"type": "Array"

75266

},

75267

"class": "Intl",

75268

"module": "intl"

75269

},

75270

{

75271

"file": "intl/js/Intl.js",

75272

"line": 132,

75273

"description": "Notification event to indicate when the lang for a module has changed. There is no default behavior associated with this event,\nso the on and after moments are equivalent.",

75274

"itemtype": "event",

75275

"name": "intl:langChange",

75276

"params": [

75277

{

75278

"name": "e",

75279

"description": "The event facade\nThe event facade contains:\n<dl>\n <dt>module</dt><dd>The name of the module for which the language changed</dd>\n <dt>newVal</dt><dd>The new language tag</dd>\n <dt>prevVal</dt><dd>The current language tag</dd>\n</dl>",

75280

"type": "EventFacade"

75281

}

75282

],

75283

"class": "Intl",

75284

"module": "intl"

75285

},

75286

{

75287

"file": "io/js/io-base.js",

75288

"line": 42,

75289

"description": "A counter that increments for each transaction.",

75290

"itemtype": "property",

75291

"name": "_id",

75292

"access": "private",

75293

"tagname": "",

75294

"type": "{Number}",

75295

"class": "IO",

75296

"module": "io-base"

75297

},

75298

{

75299

"file": "io/js/io-base.js",

75300

"line": 51,

75301

"description": "Object of IO HTTP headers sent with each transaction.",

75302

"itemtype": "property",

75303

"name": "_headers",

75304

"access": "private",

75305

"tagname": "",

75306

"type": "{Object}",

75307

"class": "IO",

75308

"module": "io-base"

75309

},

75310

{

75311

"file": "io/js/io-base.js",

75312

"line": 62,

75313

"description": "Object that stores timeout values for any transaction with a defined\n\"timeout\" configuration property.",

75314

"itemtype": "property",

75315

"name": "_timeout",

75316

"access": "private",

75317

"tagname": "",

75318

"type": "{Object}",

75319

"class": "IO",

75320

"module": "io-base"

75321

},

75322

{

75323

"file": "io/js/io-base.js",

75324

"line": 93,

75325

"description": "Method that creates a unique transaction object for each request.",

75326

"itemtype": "method",

75327

"name": "_create",

75328

"access": "private",

75329

"tagname": "",

75330

"params": [

75331

{

75332

"name": "cfg",

75333

"description": "Configuration object subset to determine if\n the transaction is an XDR or file upload,\n requiring an alternate transport.",

75334

"type": "Object"

75335

},

75336

{

75337

"name": "id",

75338

"description": "Transaction id",

75339

"type": "Number"

75340

}

75341

],

75342

"return": {

75343

"description": "The transaction object",

75344

"type": "Object"

75345

},

75346

"class": "IO",

75347

"module": "io-base"

75348

},

75349

{

75350

"file": "io/js/io-base.js",

75351

"line": 164,

75352

"description": "Method for creating and firing events.",

75353

"itemtype": "method",

75354

"name": "_evt",

75355

"access": "private",

75356

"tagname": "",

75357

"params": [

75358

{

75359

"name": "eventName",

75360

"description": "Event to be published.",

75361

"type": "String"

75362

},

75363

{

75364

"name": "transaction",

75365

"description": "Transaction object.",

75366

"type": "Object"

75367

},

75368

{

75369

"name": "config",

75370

"description": "Configuration data subset for event subscription.",

75371

"type": "Object"

75372

}

75373

],

75374

"class": "IO",

75375

"module": "io-base"

75376

},

75377

{

75378

"file": "io/js/io-base.js",

75379

"line": 226,

75380

"description": "Fires event \"io:start\" and creates, fires a transaction-specific\nstart event, if `config.on.start` is defined.",

75381

"itemtype": "method",

75382

"name": "start",

75383

"params": [

75384

{

75385

"name": "transaction",

75386

"description": "Transaction object.",

75387

"type": "Object"

75388

},

75389

{

75390

"name": "config",

75391

"description": "Configuration object for the transaction.",

75392

"type": "Object"

75393

}

75394

],

75395

"class": "IO",

75396

"module": "io-base"

75397

},

75398

{

75399

"file": "io/js/io-base.js",

75400

"line": 235,

75401

"description": "Signals the start of an IO request.",

75402

"itemtype": "event",

75403

"name": "io:start",

75404

"class": "IO",

75405

"module": "io-base"

75406

},

75407

{

75408

"file": "io/js/io-base.js",

75409

"line": 242,

75410

"description": "Fires event \"io:complete\" and creates, fires a\ntransaction-specific \"complete\" event, if config.on.complete is\ndefined.",

75411

"itemtype": "method",

75412

"name": "complete",

75413

"params": [

75414

{

75415

"name": "transaction",

75416

"description": "Transaction object.",

75417

"type": "Object"

75418

},

75419

{

75420

"name": "config",

75421

"description": "Configuration object for the transaction.",

75422

"type": "Object"

75423

}

75424

],

75425

"class": "IO",

75426

"module": "io-base"

75427

},

75428

{

75429

"file": "io/js/io-base.js",

75430

"line": 252,

75431

"description": "Signals the completion of the request-response phase of a\ntransaction. Response status and data are accessible, if\navailable, in this event.",

75432

"itemtype": "event",

75433

"name": "io:complete",

75434

"class": "IO",

75435

"module": "io-base"

75436

},

75437

{

75438

"file": "io/js/io-base.js",

75439

"line": 261,

75440

"description": "Fires event \"io:end\" and creates, fires a transaction-specific \"end\"\nevent, if config.on.end is defined.",

75441

"itemtype": "method",

75442

"name": "end",

75443

"params": [

75444

{

75445

"name": "transaction",

75446

"description": "Transaction object.",

75447

"type": "Object"

75448

},

75449

{

75450

"name": "config",

75451

"description": "Configuration object for the transaction.",

75452

"type": "Object"

75453

}

75454

],

75455

"class": "IO",

75456

"module": "io-base"

75457

},

75458

{

75459

"file": "io/js/io-base.js",

75460

"line": 270,

75461

"description": "Signals the end of the transaction lifecycle.",

75462

"itemtype": "event",

75463

"name": "io:end",

75464

"class": "IO",

75465

"module": "io-base"

75466

},

75467

{

75468

"file": "io/js/io-base.js",

75469

"line": 278,

75470

"description": "Fires event \"io:success\" and creates, fires a transaction-specific\n\"success\" event, if config.on.success is defined.",

75471

"itemtype": "method",

75472

"name": "success",

75473

"params": [

75474

{

75475

"name": "transaction",

75476

"description": "Transaction object.",

75477

"type": "Object"

75478

},

75479

{

75480

"name": "config",

75481

"description": "Configuration object for the transaction.",

75482

"type": "Object"

75483

}

75484

],

75485

"class": "IO",

75486

"module": "io-base"

75487

},

75488

{

75489

"file": "io/js/io-base.js",

75490

"line": 287,

75491

"description": "Signals an HTTP response with status in the 2xx range.\nFires after io:complete.",

75492

"itemtype": "event",

75493

"name": "io:success",

75494

"class": "IO",

75495

"module": "io-base"

75496

},

75497

{

75498

"file": "io/js/io-base.js",

75499

"line": 296,

75500

"description": "Fires event \"io:failure\" and creates, fires a transaction-specific\n\"failure\" event, if config.on.failure is defined.",

75501

"itemtype": "method",

75502

"name": "failure",

75503

"params": [

75504

{

75505

"name": "transaction",

75506

"description": "Transaction object.",

75507

"type": "Object"

75508

},

75509

{

75510

"name": "config",

75511

"description": "Configuration object for the transaction.",

75512

"type": "Object"

75513

}

75514

],

75515

"class": "IO",

75516

"module": "io-base"

75517

},

75518

{

75519

"file": "io/js/io-base.js",

75520

"line": 305,

75521

"description": "Signals an HTTP response with status outside of the 2xx range.\nFires after io:complete.",

75522

"itemtype": "event",

75523

"name": "io:failure",

75524

"class": "IO",

75525

"module": "io-base"

75526

},

75527

{

75528

"file": "io/js/io-base.js",

75529

"line": 314,

75530

"description": "Fires event \"io:progress\" and creates, fires a transaction-specific\n\"progress\" event -- for XMLHttpRequest file upload -- if\nconfig.on.progress is defined.",

75531

"itemtype": "method",

75532

"name": "progress",

75533

"params": [

75534

{

75535

"name": "transaction",

75536

"description": "Transaction object.",

75537

"type": "Object"

75538

},

75539

{

75540

"name": "progress",

75541

"description": "event.",

75542

"type": "Object"

75543

},

75544

{

75545

"name": "config",

75546

"description": "Configuration object for the transaction.",

75547

"type": "Object"

75548

}

75549

],

75550

"class": "IO",

75551

"module": "io-base"

75552

},

75553

{

75554

"file": "io/js/io-base.js",

75555

"line": 325,

75556

"description": "Signals the interactive state during a file upload transaction.\nThis event fires after io:start and before io:complete.",

75557

"itemtype": "event",

75558

"name": "io:progress",

75559

"class": "IO",

75560

"module": "io-base"

75561

},

75562

{

75563

"file": "io/js/io-base.js",

75564

"line": 334,

75565

"description": "Fires event \"io:complete\" and creates, fires a transaction-specific\n\"complete\" event -- for XMLHttpRequest file upload -- if\nconfig.on.complete is defined.",

75566

"itemtype": "method",

75567

"name": "load",

75568

"params": [

75569

{

75570

"name": "transaction",

75571

"description": "Transaction object.",

75572

"type": "Object"

75573

},

75574

{

75575

"name": "load",

75576

"description": "event.",

75577

"type": "Object"

75578

},

75579

{

75580

"name": "config",

75581

"description": "Configuration object for the transaction.",

75582

"type": "Object"

75583

}

75584

],

75585

"class": "IO",

75586

"module": "io-base"

75587

},

75588

{

75589

"file": "io/js/io-base.js",

75590

"line": 349,

75591

"description": "Fires event \"io:failure\" and creates, fires a transaction-specific\n\"failure\" event -- for XMLHttpRequest file upload -- if\nconfig.on.failure is defined.",

75592

"itemtype": "method",

75593

"name": "error",

75594

"params": [

75595

{

75596

"name": "transaction",

75597

"description": "Transaction object.",

75598

"type": "Object"

75599

},

75600

{

75601

"name": "error",

75602

"description": "event.",

75603

"type": "Object"

75604

},

75605

{

75606

"name": "config",

75607

"description": "Configuration object for the transaction.",

75608

"type": "Object"

75609

}

75610

],

75611

"class": "IO",

75612

"module": "io-base"

75613

},

75614

{

75615

"file": "io/js/io-base.js",

75616

"line": 364,

75617

"description": "Retry an XDR transaction, using the Flash tranport, if the native\ntransport fails.",

75618

"itemtype": "method",

75619

"name": "_retry",

75620

"access": "private",

75621

"tagname": "",

75622

"params": [

75623

{

75624

"name": "transaction",

75625

"description": "Transaction object.",

75626

"type": "Object"

75627

},

75628

{

75629

"name": "uri",

75630

"description": "Qualified path to transaction resource.",

75631

"type": "String"

75632

},

75633

{

75634

"name": "config",

75635

"description": "Configuration object for the transaction.",

75636

"type": "Object"

75637

}

75638

],

75639

"class": "IO",

75640

"module": "io-base"

75641

},

75642

{

75643

"file": "io/js/io-base.js",

75644

"line": 380,

75645

"description": "Method that concatenates string data for HTTP GET transactions.",

75646

"itemtype": "method",

75647

"name": "_concat",

75648

"access": "private",

75649

"tagname": "",

75650

"params": [

75651

{

75652

"name": "uri",

75653

"description": "URI or root data.",

75654

"type": "String"

75655

},

75656

{

75657

"name": "data",

75658

"description": "Data to be concatenated onto URI.",

75659

"type": "String"

75660

}

75661

],

75662

"return": {

75663

"description": "",

75664

"type": "String"

75665

},

75666

"class": "IO",

75667

"module": "io-base"

75668

},

75669

{

75670

"file": "io/js/io-base.js",

75671

"line": 394,

75672

"description": "Stores default client headers for all transactions. If a label is\npassed with no value argument, the header will be deleted.",

75673

"itemtype": "method",

75674

"name": "setHeader",

75675

"params": [

75676

{

75677

"name": "name",

75678

"description": "HTTP header",

75679

"type": "String"

75680

},

75681

{

75682

"name": "value",

75683

"description": "HTTP header value",

75684

"type": "String"

75685

}

75686

],

75687

"class": "IO",

75688

"module": "io-base"

75689

},

75690

{

75691

"file": "io/js/io-base.js",

75692

"line": 410,

75693

"description": "Method that sets all HTTP headers to be sent in a transaction.",

75694

"itemtype": "method",

75695

"name": "_setHeaders",

75696

"access": "private",

75697

"tagname": "",

75698

"params": [

75699

{

75700

"name": "transaction",

75701

"description": "- XHR instance for the specific transaction.",

75702

"type": "Object"

75703

},

75704

{

75705

"name": "headers",

75706

"description": "- HTTP headers for the specific transaction, as\n defined in the configuration object passed to YUI.io().",

75707

"type": "Object"

75708

}

75709

],

75710

"class": "IO",

75711

"module": "io-base"

75712

},

75713

{

75714

"file": "io/js/io-base.js",

75715

"line": 428,

75716

"description": "Starts timeout count if the configuration object has a defined\ntimeout property.",

75717

"itemtype": "method",

75718

"name": "_startTimeout",

75719

"access": "private",

75720

"tagname": "",

75721

"params": [

75722

{

75723

"name": "transaction",

75724

"description": "Transaction object generated by _create().",

75725

"type": "Object"

75726

},

75727

{

75728

"name": "timeout",

75729

"description": "Timeout in milliseconds.",

75730

"type": "Object"

75731

}

75732

],

75733

"class": "IO",

75734

"module": "io-base"

75735

},

75736

{

75737

"file": "io/js/io-base.js",

75738

"line": 445,

75739

"description": "Clears the timeout interval started by _startTimeout().",

75740

"itemtype": "method",

75741

"name": "_clearTimeout",

75742

"access": "private",

75743

"tagname": "",

75744

"params": [

75745

{

75746

"name": "id",

75747

"description": "- Transaction id.",

75748

"type": "Number"

75749

}

75750

],

75751

"class": "IO",

75752

"module": "io-base"

75753

},

75754

{

75755

"file": "io/js/io-base.js",

75756

"line": 457,

75757

"description": "Method that determines if a transaction response qualifies as success\nor failure, based on the response HTTP status code, and fires the\nappropriate success or failure events.",

75758

"itemtype": "method",

75759

"name": "_result",

75760

"access": "private",

75761

"tagname": "",

75762

"static": 1,

75763

"params": [

75764

{

75765

"name": "transaction",

75766

"description": "Transaction object generated by _create().",

75767

"type": "Object"

75768

},

75769

{

75770

"name": "config",

75771

"description": "Configuration object passed to io().",

75772

"type": "Object"

75773

}

75774

],

75775

"class": "IO",

75776

"module": "io-base"

75777

},

75778

{

75779

"file": "io/js/io-base.js",

75780

"line": 486,

75781

"description": "Event handler bound to onreadystatechange.",

75782

"itemtype": "method",

75783

"name": "_rS",

75784

"access": "private",

75785

"tagname": "",

75786

"params": [

75787

{

75788

"name": "transaction",

75789

"description": "Transaction object generated by _create().",

75790

"type": "Object"

75791

},

75792

{

75793

"name": "config",

75794

"description": "Configuration object passed to YUI.io().",

75795

"type": "Object"

75796

}

75797

],

75798

"class": "IO",

75799

"module": "io-base"

75800

},

75801

{

75802

"file": "io/js/io-base.js",

75803

"line": 510,

75804

"description": "Terminates a transaction due to an explicit abort or timeout.",

75805

"itemtype": "method",

75806

"name": "_abort",

75807

"access": "private",

75808

"tagname": "",

75809

"params": [

75810

{

75811

"name": "transaction",

75812

"description": "Transaction object generated by _create().",

75813

"type": "Object"

75814

},

75815

{

75816

"name": "type",

75817

"description": "Identifies timed out or aborted transaction.",

75818

"type": "String"

75819

}

75820

],

75821

"class": "IO",

75822

"module": "io-base"

75823

},

75824

{

75825

"file": "io/js/io-base.js",

75826

"line": 525,

75827

"description": "Requests a transaction. `send()` is implemented as `Y.io()`. Each\ntransaction may include a configuration object. Its properties are:\n\n<dl>\n <dt>method</dt>\n <dd>HTTP method verb (e.g., GET or POST). If this property is not\n not defined, the default value will be GET.</dd>\n\n <dt>data</dt>\n <dd>This is the name-value string that will be sent as the\n transaction data. If the request is HTTP GET, the data become\n part of querystring. If HTTP POST, the data are sent in the\n message body.</dd>\n\n <dt>xdr</dt>\n <dd>Defines the transport to be used for cross-domain requests.\n By setting this property, the transaction will use the specified\n transport instead of XMLHttpRequest. The properties of the\n transport object are:\n <dl>\n <dt>use</dt>\n <dd>The transport to be used: 'flash' or 'native'</dd>\n <dt>dataType</dt>\n <dd>Set the value to 'XML' if that is the expected response\n content type.</dd>\n </dl></dd>\n\n <dt>form</dt>\n <dd>Form serialization configuration object. Its properties are:\n <dl>\n <dt>id</dt>\n <dd>Node object or id of HTML form</dd>\n <dt>useDisabled</dt>\n <dd>`true` to also serialize disabled form field values\n (defaults to `false`)</dd>\n </dl></dd>\n\n <dt>on</dt>\n <dd>Assigns transaction event subscriptions. Available events are:\n <dl>\n <dt>start</dt>\n <dd>Fires when a request is sent to a resource.</dd>\n <dt>complete</dt>\n <dd>Fires when the transaction is complete.</dd>\n <dt>success</dt>\n <dd>Fires when the HTTP response status is within the 2xx\n range.</dd>\n <dt>failure</dt>\n <dd>Fires when the HTTP response status is outside the 2xx\n range, if an exception occurs, if the transation is aborted,\n or if the transaction exceeds a configured `timeout`.</dd>\n <dt>end</dt>\n <dd>Fires at the conclusion of the transaction\n lifecycle, after `success` or `failure`.</dd>\n </dl>\n\n Callback functions for `start` and `end` receive the id of the\n transaction as a first argument. For `complete`, `success`, and\n `failure`, callbacks receive the id and the response object\n (usually the XMLHttpRequest instance). If the `arguments`\n property was included in the configuration object passed to\n `Y.io()`, the configured data will be passed to all callbacks as\n the last argument.\n </dd>\n\n <dt>sync</dt>\n <dd>Pass `true` to make a same-domain transaction synchronous.\n CAVEAT: This will negatively impact the user\n experience. Have a very good reason if you intend to use\n this.</dd>\n\n <dt>context</dt>\n <dd>The \"`this'\" object for all configured event handlers. If a\n specific context is needed for individual callbacks, bind the\n callback to a context using `Y.bind()`.</dd>\n\n <dt>headers</dt>\n <dd>Object map of transaction headers to send to the server. The\n object keys are the header names and the values are the header\n values.</dd>\n\n <dt>timeout</dt>\n <dd>Millisecond threshold for the transaction before being\n automatically aborted.</dd>\n\n <dt>arguments</dt>\n <dd>User-defined data passed to all registered event handlers.\n This value is available as the second argument in the \"start\" and\n \"end\" event handlers. It is the third argument in the \"complete\",\n \"success\", and \"failure\" event handlers. Be sure to quote\n this property name in the transaction configuration as\n \"arguments\" is a reserved word in JavaScript (e.g.\n `Y.io({ ..., \"arguments\": stuff })`).</dd>\n</dl>",

75828

"itemtype": "method",

75829

"name": "send",

75830

"access": "public",

75831

"tagname": "",

75832

"params": [

75833

{

75834

"name": "uri",

75835

"description": "Qualified path to transaction resource.",

75836

"type": "String"

75837

},

75838

{

75839

"name": "config",

75840

"description": "Configuration object for the transaction.",

75841

"type": "Object"

75842

},

75843

{

75844

"name": "id",

75845

"description": "Transaction id, if already set.",

75846

"type": "Number"

75847

}

75848

],

75849

"return": {

75850

"description": "",

75851

"type": "Object"

75852

},

75853

"class": "IO",

75854

"module": "io-base"

75855

},

75856

{

75857

"file": "io/js/io-base.js",

75858

"line": 768,

75859

"description": "Method for initiating an ajax call. The first argument is the url end\npoint for the call. The second argument is an object to configure the\ntransaction and attach event subscriptions. The configuration object\nsupports the following properties:\n\n<dl>\n <dt>method</dt>\n <dd>HTTP method verb (e.g., GET or POST). If this property is not\n not defined, the default value will be GET.</dd>\n\n <dt>data</dt>\n <dd>This is the name-value string that will be sent as the\n transaction data. If the request is HTTP GET, the data become\n part of querystring. If HTTP POST, the data are sent in the\n message body.</dd>\n\n <dt>xdr</dt>\n <dd>Defines the transport to be used for cross-domain requests.\n By setting this property, the transaction will use the specified\n transport instead of XMLHttpRequest. The properties of the\n transport object are:\n <dl>\n <dt>use</dt>\n <dd>The transport to be used: 'flash' or 'native'</dd>\n <dt>dataType</dt>\n <dd>Set the value to 'XML' if that is the expected response\n content type.</dd>\n </dl></dd>\n\n <dt>form</dt>\n <dd>Form serialization configuration object. Its properties are:\n <dl>\n <dt>id</dt>\n <dd>Node object or id of HTML form</dd>\n <dt>useDisabled</dt>\n <dd>`true` to also serialize disabled form field values\n (defaults to `false`)</dd>\n </dl></dd>\n\n <dt>on</dt>\n <dd>Assigns transaction event subscriptions. Available events are:\n <dl>\n <dt>start</dt>\n <dd>Fires when a request is sent to a resource.</dd>\n <dt>complete</dt>\n <dd>Fires when the transaction is complete.</dd>\n <dt>success</dt>\n <dd>Fires when the HTTP response status is within the 2xx\n range.</dd>\n <dt>failure</dt>\n <dd>Fires when the HTTP response status is outside the 2xx\n range, if an exception occurs, if the transation is aborted,\n or if the transaction exceeds a configured `timeout`.</dd>\n <dt>end</dt>\n <dd>Fires at the conclusion of the transaction\n lifecycle, after `success` or `failure`.</dd>\n </dl>\n\n Callback functions for `start` and `end` receive the id of the\n transaction as a first argument. For `complete`, `success`, and\n `failure`, callbacks receive the id and the response object\n (usually the XMLHttpRequest instance). If the `arguments`\n property was included in the configuration object passed to\n `Y.io()`, the configured data will be passed to all callbacks as\n the last argument.\n </dd>\n\n <dt>sync</dt>\n <dd>Pass `true` to make a same-domain transaction synchronous.\n CAVEAT: This will negatively impact the user\n experience. Have a very good reason if you intend to use\n this.</dd>\n\n <dt>context</dt>\n <dd>The \"`this'\" object for all configured event handlers. If a\n specific context is needed for individual callbacks, bind the\n callback to a context using `Y.bind()`.</dd>\n\n <dt>headers</dt>\n <dd>Object map of transaction headers to send to the server. The\n object keys are the header names and the values are the header\n values.</dd>\n\n <dt>timeout</dt>\n <dd>Millisecond threshold for the transaction before being\n automatically aborted.</dd>\n\n <dt>arguments</dt>\n <dd>User-defined data passed to all registered event handlers.\n This value is available as the second argument in the \"start\" and\n \"end\" event handlers. It is the third argument in the \"complete\",\n \"success\", and \"failure\" event handlers. Be sure to quote\n this property name in the transaction configuration as\n \"arguments\" is a reserved word in JavaScript (e.g.\n `Y.io({ ..., \"arguments\": stuff })`).</dd>\n</dl>",

75860

"itemtype": "method",

75861

"name": "io",

75862

"static": 1,

75863

"params": [

75864

{

75865

"name": "url",

75866

"description": "qualified path to transaction resource.",

75867

"type": "String"

75868

},

75869

{

75870

"name": "config",

75871

"description": "configuration object for the transaction.",

75872

"type": "Object"

75873

}

75874

],

75875

"return": {

75876

"description": "",

75877

"type": "Object"

75878

},

75879

"class": "YUI",

75880

"module": "io-base"

75881

},

75882

{

75883

"file": "io/js/io-base.js",

75884

"line": 880,

75885

"description": "Method for setting and deleting IO HTTP headers to be sent with every\nrequest.\n\nHosted as a property on the `io` function (e.g. `Y.io.header`).",

75886

"itemtype": "method",

75887

"name": "header",

75888

"params": [

75889

{

75890

"name": "name",

75891

"description": "HTTP header",

75892

"type": "String"

75893

},

75894

{

75895

"name": "value",

75896

"description": "HTTP header value",

75897

"type": "String"

75898

}

75899

],

75900

"static": 1,

75901

"class": "YUI",

75902

"module": "io-base"

75903

},

75904

{

75905

"file": "io/js/io-form.js",

75906

"line": 12,

75907

"description": "Method to enumerate through an HTML form's elements collection\nand return a string comprised of key-value pairs.",

75908

"itemtype": "method",

75909

"name": "_serialize",

75910

"access": "private",

75911

"tagname": "",

75912

"static": 1,

75913

"params": [

75914

{

75915

"name": "c",

75916

"description": "- YUI form node or HTML form id.",

75917

"type": "Object"

75918

},

75919

{

75920

"name": "s",

75921

"description": "- Key-value data defined in the configuration object.",

75922

"type": "String"

75923

}

75924

],

75925

"return": {

75926

"description": "",

75927

"type": "String"

75928

},

75929

"class": "IO",

75930

"module": "io",

75931

"submodule": "io-form"

75932

},

75933

{

75934

"file": "io/js/io-nodejs.js",

75935

"line": 3,

75936

"description": "Passthru to the NodeJS <a href=\"https://github.com/mikeal/request\">request</a> module.\nThis method is return of `require('request')` so you can use it inside NodeJS without\nthe IO abstraction.",

75937

"itemtype": "method",

75938

"name": "request",

75939

"static": 1,

75940

"class": "IO",

75941

"module": "io"

75942

},

75943

{

75944

"file": "io/js/io-nodejs.js",

75945

"line": 16,

75946

"description": "NodeJS IO transport, uses the NodeJS <a href=\"https://github.com/mikeal/request\">request</a>\nmodule under the hood to perform all network IO.",

75947

"itemtype": "method",

75948

"name": "transports.nodejs",

75949

"static": 1,

75950

"return": {

75951

"description": "This object contains only a `send` method that accepts a\n`transaction object`, `uri` and the `config object`.",

75952

"type": "Object"

75953

},

75954

"example": [

75955

"\n \n Y.io('https://somedomain.com/url', {\n method: 'PUT',\n data: '?foo=bar',\n //Extra request module config options.\n request: {\n maxRedirects: 100,\n strictSSL: true,\n multipart: [\n {\n 'content-type': 'application/json',\n body: JSON.stringify({\n foo: 'bar',\n _attachments: {\n 'message.txt': {\n follows: true,\n length: 18,\n 'content_type': 'text/plain'\n }\n }\n })\n },\n {\n body: 'I am an attachment'\n }\n ] \n },\n on: {\n success: function(id, e) {\n Y.log(e.responseText);\n }\n }\n });"

75956

],

75957

"class": "IO",

75958

"module": "io"

75959

},

75960

{

75961

"file": "io/js/io-queue.js",

75962

"line": 11,

75963

"description": "Array of transactions queued for processing",

75964

"itemtype": "property",

75965

"name": "_q",

75966

"access": "private",

75967

"tagname": "",

75968

"static": 1,

75969

"type": "{Object}",

75970

"class": "IO",

75971

"module": "io",

75972

"submodule": "io-queue"

75973

},

75974

{

75975

"file": "io/js/io-queue.js",

75976

"line": 22,

75977

"description": "Property to determine whether the queue is set to\n1 (active) or 0 (inactive). When inactive, transactions\nwill be stored in the queue until the queue is set to active.",

75978

"itemtype": "property",

75979

"name": "_qState",

75980

"access": "private",

75981

"tagname": "",

75982

"static": 1,

75983

"type": "{Number}",

75984

"class": "IO",

75985

"module": "io",

75986

"submodule": "io-queue"

75987

},

75988

{

75989

"file": "io/js/io-queue.js",

75990

"line": 34,

75991

"description": "Method Process the first transaction from the\nqueue in FIFO order.",

75992

"itemtype": "method",

75993

"name": "_qShift",

75994

"access": "private",

75995

"tagname": "",

75996

"static": 1,

75997

"class": "IO",

75998

"module": "io",

75999

"submodule": "io-queue"

76000

},

76001

{

76002

"file": "io/js/io-queue.js",

76003

"line": 51,

76004

"description": "Method for queueing a transaction before the request is sent to the\nresource, to ensure sequential processing.",

76005

"itemtype": "method",

76006

"name": "queue",

76007

"static": 1,

76008

"return": {

76009

"description": "",

76010

"type": "Object"

76011

},

76012

"class": "IO",

76013

"module": "io",

76014

"submodule": "io-queue"

76015

},

76016

{

76017

"file": "io/js/io-queue.js",

76018

"line": 85,

76019

"description": "Method for promoting a transaction to the top of the queue.",

76020

"itemtype": "method",

76021

"name": "promote",

76022

"static": 1,

76023

"class": "IO",

76024

"module": "io",

76025

"submodule": "io-queue"

76026

},

76027

{

76028

"file": "io/js/io-queue.js",

76029

"line": 95,

76030

"description": "Method for removing a specific, pending transaction from\nthe queue.",

76031

"itemtype": "method",

76032

"name": "remove",

76033

"access": "private",

76034

"tagname": "",

76035

"static": 1,

76036

"class": "IO",

76037

"module": "io",

76038

"submodule": "io-queue"

76039

},

76040

{

76041

"file": "io/js/io-queue.js",

76042

"line": 117,

76043

"description": "Method for setting queue processing to inactive.\nTransaction requests to YUI.io.queue() will be stored in the queue, but\nnot processed until the queue is reset to \"active\".",

76044

"itemtype": "method",

76045

"name": "_stop",

76046

"access": "private",

76047

"tagname": "",

76048

"static": 1,

76049

"class": "IO",

76050

"module": "io",

76051

"submodule": "io-queue"

76052

},

76053

{

76054

"file": "io/js/io-queue.js",

76055

"line": 131,

76056

"description": "Method to query the current size of the queue.",

76057

"itemtype": "method",

76058

"name": "_size",

76059

"access": "private",

76060

"tagname": "",

76061

"static": 1,

76062

"return": {

76063

"description": "",

76064

"type": "Number"

76065

},

76066

"class": "IO",

76067

"module": "io",

76068

"submodule": "io-queue"

76069

},

76070

{

76071

"file": "io/js/io-upload-iframe.js",

76072

"line": 14,

76073

"description": "Creates the iframe transported used in file upload\ntransactions, and binds the response event handler.",

76074

"itemtype": "method",

76075

"name": "_cFrame",

76076

"access": "private",

76077

"tagname": "",

76078

"params": [

76079

{

76080

"name": "o",

76081

"description": "Transaction object generated by _create().",

76082

"type": "Object"

76083

},

76084

{

76085

"name": "c",

76086

"description": "Configuration object passed to YUI.io().",

76087

"type": "Object"

76088

},

76089

{

76090

"name": "io",

76091

"description": "",

76092

"type": "Object"

76093

}

76094

],

76095

"class": "IO",

76096

"module": "io",

76097

"submodule": "io-upload-iframe"

76098

},

76099

{

76100

"file": "io/js/io-upload-iframe.js",

76101

"line": 34,

76102

"description": "Removes the iframe transport used in the file upload \ntransaction.",

76103

"itemtype": "method",

76104

"name": "_dFrame",

76105

"access": "private",

76106

"tagname": "",

76107

"params": [

76108

{

76109

"name": "id",

76110

"description": "The transaction ID used in the iframe's creation.",

76111

"type": "Number"

76112

}

76113

],

76114

"class": "IO",

76115

"module": "io",

76116

"submodule": "io-upload-iframe"

76117

},

76118

{

76119

"file": "io/js/io-upload-iframe.js",

76120

"line": 49,

76121

"description": "Parses the POST data object and creates hidden form elements\nfor each key-value, and appends them to the HTML form object.",

76122

"itemtype": "method",

76123

"name": "appendData",

76124

"access": "private",

76125

"tagname": "",

76126

"static": 1,

76127

"params": [

76128

{

76129

"name": "f",

76130

"description": "HTML form object.",

76131

"type": "Object"

76132

},

76133

{

76134

"name": "s",

76135

"description": "The key-value POST data.",

76136

"type": "String"

76137

}

76138

],

76139

"return": {

76140

"description": "o Array of created fields.",

76141

"type": "Array"

76142

},

76143

"class": "IO",

76144

"module": "io",

76145

"submodule": "io-upload-iframe"

76146

},

76147

{

76148

"file": "io/js/io-upload-iframe.js",

76149

"line": 82,

76150

"description": "Removes the custom fields created to pass additional POST\ndata, along with the HTML form fields.",

76151

"itemtype": "method",

76152

"name": "_removeData",

76153

"access": "private",

76154

"tagname": "",

76155

"static": 1,

76156

"params": [

76157

{

76158

"name": "f",

76159

"description": "HTML form object.",

76160

"type": "Object"

76161

},

76162

{

76163

"name": "o",

76164

"description": "HTML form fields created from configuration.data.",

76165

"type": "Object"

76166

}

76167

],

76168

"class": "IO",

76169

"module": "io",

76170

"submodule": "io-upload-iframe"

76171

},

76172

{

76173

"file": "io/js/io-upload-iframe.js",

76174

"line": 99,

76175

"description": "Sets the appropriate attributes and values to the HTML\nform, in preparation of a file upload transaction.",

76176

"itemtype": "method",

76177

"name": "_setAttrs",

76178

"access": "private",

76179

"tagname": "",

76180

"static": 1,

76181

"params": [

76182

{

76183

"name": "f",

76184

"description": "HTML form object.",

76185

"type": "Object"

76186

},

76187

{

76188

"name": "id",

76189

"description": "The Transaction ID.",

76190

"type": "Object"

76191

},

76192

{

76193

"name": "uri",

76194

"description": "Qualified path to transaction resource.",

76195

"type": "Object"

76196

}

76197

],

76198

"class": "IO",

76199

"module": "io",

76200

"submodule": "io-upload-iframe"

76201

},

76202

{

76203

"file": "io/js/io-upload-iframe.js",

76204

"line": 116,

76205

"description": "Reset the HTML form attributes to their original values.",

76206

"itemtype": "method",

76207

"name": "_resetAttrs",

76208

"access": "private",

76209

"tagname": "",

76210

"static": 1,

76211

"params": [

76212

{

76213

"name": "f",

76214

"description": "HTML form object.",

76215

"type": "Object"

76216

},

76217

{

76218

"name": "a",

76219

"description": "Object of original attributes.",

76220

"type": "Object"

76221

}

76222

],

76223

"class": "IO",

76224

"module": "io",

76225

"submodule": "io-upload-iframe"

76226

},

76227

{

76228

"file": "io/js/io-upload-iframe.js",

76229

"line": 135,

76230

"description": "Starts timeout count if the configuration object\nhas a defined timeout property.",

76231

"itemtype": "method",

76232

"name": "_startUploadTimeout",

76233

"access": "private",

76234

"tagname": "",

76235

"static": 1,

76236

"params": [

76237

{

76238

"name": "o",

76239

"description": "Transaction object generated by _create().",

76240

"type": "Object"

76241

},

76242

{

76243

"name": "c",

76244

"description": "Configuration object passed to YUI.io().",

76245

"type": "Object"

76246

}

76247

],

76248

"class": "IO",

76249

"module": "io",

76250

"submodule": "io-upload-iframe"

76251

},

76252

{

76253

"file": "io/js/io-upload-iframe.js",

76254

"line": 158,

76255

"description": "Clears the timeout interval started by _startUploadTimeout().",

76256

"itemtype": "method",

76257

"name": "_clearUploadTimeout",

76258

"access": "private",

76259

"tagname": "",

76260

"static": 1,

76261

"params": [

76262

{

76263

"name": "id",

76264

"description": "- Transaction ID.",

76265

"type": "Number"

76266

}

76267

],

76268

"class": "IO",

76269

"module": "io",

76270

"submodule": "io-upload-iframe"

76271

},

76272

{

76273

"file": "io/js/io-upload-iframe.js",

76274

"line": 172,

76275

"description": "Bound to the iframe's Load event and processes\nthe response data.",

76276

"itemtype": "method",

76277

"name": "_uploadComplete",

76278

"access": "private",

76279

"tagname": "",

76280

"static": 1,

76281

"params": [

76282

{

76283

"name": "o",

76284

"description": "The transaction object",

76285

"type": "Object"

76286

},

76287

{

76288

"name": "c",

76289

"description": "Configuration object for the transaction.",

76290

"type": "Object"

76291

}

76292

],

76293

"class": "IO",

76294

"module": "io",

76295

"submodule": "io-upload-iframe"

76296

},

76297

{

76298

"file": "io/js/io-upload-iframe.js",

76299

"line": 216,

76300

"description": "Uploads HTML form data, inclusive of files/attachments,\nusing the iframe created in _create to facilitate the transaction.",

76301

"itemtype": "method",

76302

"name": "_upload",

76303

"access": "private",

76304

"tagname": "",

76305

"static": 1,

76306

"params": [

76307

{

76308

"name": "o",

76309

"description": "The transaction object",

76310

"type": "Object"

76311

},

76312

{

76313

"name": "uri",

76314

"description": "Qualified path to transaction resource.",

76315

"type": "Object"

76316

},

76317

{

76318

"name": "c",

76319

"description": "Configuration object for the transaction.",

76320

"type": "Object"

76321

}

76322

],

76323

"class": "IO",

76324

"module": "io",

76325

"submodule": "io-upload-iframe"

76326

},

76327

{

76328

"file": "io/js/io-xdr.js",

76329

"line": 9,

76330

"description": "Fires when the XDR transport is ready for use.",

76331

"itemtype": "event",

76332

"name": "io:xdrReady",

76333

"class": "IO",

76334

"module": "io",

76335

"submodule": "io-xdr"

76336

},

76337

{

76338

"file": "io/js/io-xdr.js",

76339

"line": 15,

76340

"description": "Map of stored configuration objects when using\nFlash as the transport for cross-domain requests.",

76341

"itemtype": "property",

76342

"name": "_cB",

76343

"access": "private",

76344

"tagname": "",

76345

"type": "{Object}",

76346

"class": "IO",

76347

"module": "io",

76348

"submodule": "io-xdr"

76349

},

76350

{

76351

"file": "io/js/io-xdr.js",

76352

"line": 25,

76353

"description": "Map of transaction simulated readyState values\nwhen XDomainRequest is the transport.",

76354

"itemtype": "property",

76355

"name": "_rS",

76356

"access": "private",

76357

"tagname": "",

76358

"type": "{Object}",

76359

"class": "IO",

76360

"module": "io",

76361

"submodule": "io-xdr"

76362

},

76363

{

76364

"file": "io/js/io-xdr.js",

76365

"line": 42,

76366

"description": "Method that creates the Flash transport swf.",

76367

"itemtype": "method",

76368

"name": "_swf",

76369

"access": "private",

76370

"tagname": "",

76371

"params": [

76372

{

76373

"name": "uri",

76374

"description": "- location of io.swf.",

76375

"type": "String"

76376

},

76377

{

76378

"name": "yid",

76379

"description": "- YUI sandbox id.",

76380

"type": "String"

76381

},

76382

{

76383

"name": "yid",

76384

"description": "- IO instance id.",

76385

"type": "String"

76386

}

76387

],

76388

"class": "IO",

76389

"module": "io",

76390

"submodule": "io-xdr"

76391

},

76392

{

76393

"file": "io/js/io-xdr.js",

76394

"line": 64,

76395

"description": "Creates a response object for XDR transactions, for success\nand failure cases.",

76396

"itemtype": "method",

76397

"name": "_data",

76398

"access": "private",

76399

"tagname": "",

76400

"params": [

76401

{

76402

"name": "o",

76403

"description": "- Transaction object generated by _create() in io-base.",

76404

"type": "Object"

76405

},

76406

{

76407

"name": "u",

76408

"description": "- Configuration xdr.use.",

76409

"type": "Boolean"

76410

},

76411

{

76412

"name": "d",

76413

"description": "- Configuration xdr.dataType.",

76414

"type": "Boolean"

76415

}

76416

],

76417

"return": {

76418

"description": "",

76419

"type": "Object"

76420

},

76421

"class": "IO",

76422

"module": "io",

76423

"submodule": "io-xdr"

76424

},

76425

{

76426

"file": "io/js/io-xdr.js",

76427

"line": 87,

76428

"description": "Method for intiating an XDR transaction abort.",

76429

"itemtype": "method",

76430

"name": "_abort",

76431

"access": "private",

76432

"tagname": "",

76433

"params": [

76434

{

76435

"name": "o",

76436

"description": "- Transaction object generated by _create() in io-base.",

76437

"type": "Object"

76438

},

76439

{

76440

"name": "c",

76441

"description": "- configuration object for the transaction.",

76442

"type": "Object"

76443

}

76444

],

76445

"class": "IO",

76446

"module": "io",

76447

"submodule": "io-xdr"

76448

},

76449

{

76450

"file": "io/js/io-xdr.js",

76451

"line": 99,

76452

"description": "Method for determining if an XDR transaction has completed\nand all data are received.",

76453

"itemtype": "method",

76454

"name": "_isInProgress",

76455

"access": "private",

76456

"tagname": "",

76457

"params": [

76458

{

76459

"name": "o",

76460

"description": "- Transaction object generated by _create() in io-base.",

76461

"type": "Object"

76462

}

76463

],

76464

"class": "IO",

76465

"module": "io",

76466

"submodule": "io-xdr"

76467

},

76468

{

76469

"file": "io/js/io-xdr.js",

76470

"line": 113,

76471

"description": "Map of io transports.",

76472

"itemtype": "property",

76473

"name": "_transport",

76474

"access": "private",

76475

"tagname": "",

76476

"type": "{Object}",

76477

"class": "IO",

76478

"module": "io",

76479

"submodule": "io-xdr"

76480

},

76481

{

76482

"file": "io/js/io-xdr.js",

76483

"line": 122,

76484

"description": "Sets event handlers for XDomainRequest transactions.",

76485

"itemtype": "method",

76486

"name": "_ieEvt",

76487

"access": "private",

76488

"tagname": "",

76489

"static": 1,

76490

"params": [

76491

{

76492

"name": "o",

76493

"description": "- Transaction object generated by _create() in io-base.",

76494

"type": "Object"

76495

},

76496

{

76497

"name": "c",

76498

"description": "- configuration object for the transaction.",

76499

"type": "Object"

76500

}

76501

],

76502

"class": "IO",

76503

"module": "io",

76504

"submodule": "io-xdr"

76505

},

76506

{

76507

"file": "io/js/io-xdr.js",

76508

"line": 154,

76509

"description": "Method for accessing the transport's interface for making a\ncross-domain transaction.",

76510

"itemtype": "method",

76511

"name": "xdr",

76512

"params": [

76513

{

76514

"name": "uri",

76515

"description": "- qualified path to transaction resource.",

76516

"type": "String"

76517

},

76518

{

76519

"name": "o",

76520

"description": "- Transaction object generated by _create() in io-base.",

76521

"type": "Object"

76522

},

76523

{

76524

"name": "c",

76525

"description": "- configuration object for the transaction.",

76526

"type": "Object"

76527

}

76528

],

76529

"class": "IO",

76530

"module": "io",

76531

"submodule": "io-xdr"

76532

},

76533

{

76534

"file": "io/js/io-xdr.js",

76535

"line": 205,

76536

"description": "Response controller for cross-domain requests when using the\nFlash transport or IE8's XDomainRequest object.",

76537

"itemtype": "method",

76538

"name": "xdrResponse",

76539

"params": [

76540

{

76541

"name": "e",

76542

"description": "Event name",

76543

"type": "String"

76544

},

76545

{

76546

"name": "o",

76547

"description": "Transaction object generated by _create() in io-base.",

76548

"type": "Object"

76549

},

76550

{

76551

"name": "c",

76552

"description": "Configuration object for the transaction.",

76553

"type": "Object"

76554

}

76555

],

76556

"return": {

76557

"description": "",

76558

"type": "Object"

76559

},

76560

"class": "IO",

76561

"module": "io",

76562

"submodule": "io-xdr"

76563

},

76564

{

76565

"file": "io/js/io-xdr.js",

76566

"line": 245,

76567

"description": "Fires event \"io:xdrReady\"",

76568

"itemtype": "method",

76569

"name": "_xdrReady",

76570

"access": "private",

76571

"tagname": "",

76572

"params": [

76573

{

76574

"name": "yid",

76575

"description": "- YUI sandbox id.",

76576

"type": "Number"

76577

},

76578

{

76579

"name": "uid",

76580

"description": "- IO instance id.",

76581

"type": "Number"

76582

}

76583

],

76584

"class": "IO",

76585

"module": "io",

76586

"submodule": "io-xdr"

76587

},

76588

{

76589

"file": "io/js/io-xdr.js",

76590

"line": 257,

76591

"description": "Initializes the desired transport.",

76592

"itemtype": "method",

76593

"name": "transport",

76594

"params": [

76595

{

76596

"name": "o",

76597

"description": "- object of transport configurations.",

76598

"type": "Object"

76599

}

76600

],

76601

"class": "IO",

76602

"module": "io",

76603

"submodule": "io-xdr"

76604

},

76605

{

76606

"file": "io/js/io-xdr.js",

76607

"line": 271,

76608

"description": "Fires event \"io:xdrReady\"",

76609

"itemtype": "method",

76610

"name": "xdrReady",

76611

"access": "protected",

76612

"tagname": "",

76613

"static": 1,

76614

"params": [

76615

{

76616

"name": "yid",

76617

"description": "- YUI sandbox id.",

76618

"type": "Number"

76619

},

76620

{

76621

"name": "uid",

76622

"description": "- IO instance id.",

76623

"type": "Number"

76624

}

76625

],

76626

"class": "IO",

76627

"module": "io",

76628

"submodule": "io-xdr"

76629

},

76630

{

76631

"file": "io/js/io-xdr.js",

76632

"line": 297,

76633

"description": "Delay value to calling the Flash transport, in the\nevent io.swf has not finished loading. Once the E_XDR_READY\nevent is fired, this value will be set to 0.",

76634

"itemtype": "property",

76635

"name": "delay",

76636

"static": 1,

76637

"type": "{Number}",

76638

"class": "IO",

76639

"module": "io",

76640

"submodule": "io-xdr"

76641

},

76642

{

76643

"file": "io/js/transports.js",

76644

"line": 7,

76645

"description": "The ID of the default IO transport, defaults to `xhr`",

76646

"itemtype": "property",

76647

"name": "_default",

76648

"type": "{String}",

76649

"static": 1,

76650

"class": "JSON",

76651

"module": "io"

76652

},

76653

{

76654

"file": "io/js/transports.js",

76655

"line": 14,

76656

"itemtype": "method",

76657

"name": "defaultTransport",

76658

"static": 1,

76659

"params": [

76660

{

76661

"name": "id",

76662

"description": "The transport to set as the default, if empty a new transport is created.",

76663

"type": "String",

76664

"optional": true

76665

}

76666

],

76667

"return": {

76668

"description": "The transport object with a `send` method",

76669

"type": "Object"

76670

},

76671

"class": "JSON",

76672

"module": "io"

76673

},

76674

{

76675

"file": "io/js/transports.js",

76676

"line": 34,

76677

"description": "An object hash of custom transports available to IO",

76678

"itemtype": "property",

76679

"name": "transports",

76680

"type": "{Object}",

76681

"static": 1,

76682

"class": "JSON",

76683

"module": "io"

76684

},

76685

{

76686

"file": "io/js/transports.js",

76687

"line": 52,

76688

"description": "Create a custom transport of type and return it's object",

76689

"itemtype": "method",

76690

"name": "customTransport",

76691

"params": [

76692

{

76693

"name": "id",

76694

"description": "The id of the transport to create.",

76695

"type": "String"

76696

}

76697

],

76698

"static": 1,

76699

"class": "JSON",

76700

"module": "io"

76701

},

76702

{

76703

"file": "io/js/transports.js",

76704

"line": 67,

76705

"description": "Fired from the notify method of the transport which in turn fires\nthe event on the IO object.",

76706

"itemtype": "method",

76707

"name": "notify",

76708

"params": [

76709

{

76710

"name": "event",

76711

"description": "The name of the event",

76712

"type": "String"

76713

},

76714

{

76715

"name": "transaction",

76716

"description": "The transaction object",

76717

"type": "Object"

76718

},

76719

{

76720

"name": "config",

76721

"description": "The configuration object for this transaction",

76722

"type": "Object"

76723

}

76724

],

76725

"class": "JSON",

76726

"module": "io"

76727

},

76728

{

76729

"file": "json/js/parse.js",

76730

"line": 44,

76731

"description": "Alias to native browser implementation of the JSON object if available.",

76732

"itemtype": "property",

76733

"name": "Native",

76734

"type": "{Object}",

76735

"access": "private",

76736

"tagname": "",

76737

"class": "JSON",

76738

"module": "json",

76739

"submodule": "json-parse"

76740

},

76741

{

76742

"file": "json/js/parse.js",

76743

"line": 56,

76744

"description": "Replace certain Unicode characters that JavaScript may handle incorrectly\nduring eval--either by deleting them or treating them as line\nendings--with escape sequences.\nIMPORTANT NOTE: This regex will be used to modify the input if a match is\nfound.",

76745

"itemtype": "property",

76746

"name": "_UNICODE_EXCEPTIONS",

76747

"type": "{RegExp}",

76748

"access": "private",

76749

"tagname": "",

76750

"class": "JSON",

76751

"module": "json",

76752

"submodule": "json-parse"

76753

},

76754

{

76755

"file": "json/js/parse.js",

76756

"line": 70,

76757

"description": "First step in the safety evaluation. Regex used to replace all escape\nsequences (i.e. \"\\\\\", etc) with '@' characters (a non-JSON character).",

76758

"itemtype": "property",

76759

"name": "_ESCAPES",

76760

"type": "{RegExp}",

76761

"access": "private",

76762

"tagname": "",

76763

"class": "JSON",

76764

"module": "json",

76765

"submodule": "json-parse"

76766

},

76767

{

76768

"file": "json/js/parse.js",

76769

"line": 80,

76770

"description": "Second step in the safety evaluation. Regex used to replace all simple\nvalues with ']' characters.",

76771

"itemtype": "property",

76772

"name": "_VALUES",

76773

"type": "{RegExp}",

76774

"access": "private",

76775

"tagname": "",

76776

"class": "JSON",

76777

"module": "json",

76778

"submodule": "json-parse"

76779

},

76780

{

76781

"file": "json/js/parse.js",

76782

"line": 90,

76783

"description": "Third step in the safety evaluation. Regex used to remove all open\nsquare brackets following a colon, comma, or at the beginning of the\nstring.",

76784

"itemtype": "property",

76785

"name": "_BRACKETS",

76786

"type": "{RegExp}",

76787

"access": "private",

76788

"tagname": "",

76789

"class": "JSON",

76790

"module": "json",

76791

"submodule": "json-parse"

76792

},

76793

{

76794

"file": "json/js/parse.js",

76795

"line": 101,

76796

"description": "Final step in the safety evaluation. Regex used to test the string left\nafter all previous replacements for invalid characters.",

76797

"itemtype": "property",

76798

"name": "_UNSAFE",

76799

"type": "{RegExp}",

76800

"access": "private",

76801

"tagname": "",

76802

"class": "JSON",

76803

"module": "json",

76804

"submodule": "json-parse"

76805

},

76806

{

76807

"file": "json/js/parse.js",

76808

"line": 111,

76809

"description": "Replaces specific unicode characters with their appropriate \\unnnn\nformat. Some browsers ignore certain characters during eval.",

76810

"itemtype": "method",

76811

"name": "escapeException",

76812

"params": [

76813

{

76814

"name": "c",

76815

"description": "Unicode character",

76816

"type": "String"

76817

}

76818

],

76819

"return": {

76820

"description": "the \\unnnn escapement of the character",

76821

"type": "String"

76822

},

76823

"access": "private",

76824

"tagname": "",

76825

"class": "JSON",

76826

"module": "json",

76827

"submodule": "json-parse"

76828

},

76829

{

76830

"file": "json/js/parse.js",

76831

"line": 124,

76832

"description": "Traverses nested objects, applying a reviver function to each (key,value)\nfrom the scope if the key:value's containing object. The value returned\nfrom the function will replace the original value in the key:value pair.\nIf the value returned is undefined, the key will be omitted from the\nreturned object.",

76833

"itemtype": "method",

76834

"name": "_revive",

76835

"params": [

76836

{

76837

"name": "data",

76838

"description": "Any JavaScript data",

76839

"type": "MIXED"

76840

},

76841

{

76842

"name": "reviver",

76843

"description": "filter or mutation function",

76844

"type": "Function"

76845

}

76846

],

76847

"return": {

76848

"description": "The results of the filtered data",

76849

"type": "MIXED"

76850

},

76851

"access": "private",

76852

"tagname": "",

76853

"class": "JSON",

76854

"module": "json",

76855

"submodule": "json-parse"

76856

},

76857

{

76858

"file": "json/js/parse.js",

76859

"line": 158,

76860

"description": "Parse a JSON string, returning the native JavaScript representation.",

76861

"params": [

76862

{

76863

"name": "s",

76864

"description": "JSON string data",

76865

"type": "String"

76866

},

76867

{

76868

"name": "reviver",

76869

"description": "(optional) function(k,v) passed each key value\n pair of object literals, allowing pruning or altering values",

76870

"type": "Function"

76871

}

76872

],

76873

"return": {

76874

"description": "the native JavaScript representation of the JSON string",

76875

"type": "MIXED"

76876

},

76877

"throws": [

76878

"SyntaxError"

76879

],

76880

"itemtype": "method",

76881

"name": "parse",

76882

"static": 1,

76883

"class": "JSON",

76884

"module": "json",

76885

"submodule": "json-parse"

76886

},

76887

{

76888

"file": "json/js/parse.js",

76889

"line": 214,

76890

"description": "Leverage native JSON parse if the browser has a native implementation.\nIn general, this is a good idea. See the Known Issues section in the\nJSON user guide for caveats. The default value is true for browsers with\nnative JSON support.",

76891

"itemtype": "property",

76892

"name": "useNativeParse",

76893

"type": "Boolean",

76894

"default": "true",

76895

"static": 1,

76896

"class": "JSON",

76897

"module": "json",

76898

"submodule": "json-parse"

76899

},

76900

{

76901

"file": "json/js/stringify.js",

76902

"line": 248,

76903

"description": "Leverage native JSON stringify if the browser has a native\nimplementation. In general, this is a good idea. See the Known Issues\nsection in the JSON user guide for caveats. The default value is true\nfor browsers with native JSON support.",

76904

"itemtype": "property",

76905

"name": "useNativeStringify",

76906

"type": "Boolean",

76907

"default": "true",

76908

"static": 1,

76909

"class": "JSON",

76910

"module": "json",

76911

"submodule": "json-stringify"

76912

},

76913

{

76914

"file": "json/js/stringify.js",

76915

"line": 261,

76916

"description": "Serializes a Date instance as a UTC date string. Used internally by\nstringify. Override this method if you need Dates serialized in a\ndifferent format.",

76917

"itemtype": "method",

76918

"name": "dateToString",

76919

"params": [

76920

{

76921

"name": "d",

76922

"description": "The Date to serialize",

76923

"type": "Date"

76924

}

76925

],

76926

"return": {

76927

"description": "stringified Date in UTC format YYYY-MM-DDTHH:mm:SSZ",

76928

"type": "String"

76929

},

76930

"deprecated": true,

76931

"deprecationMessage": "Use a replacer function",

76932

"static": 1,

76933

"class": "JSON",

76934

"module": "json",

76935

"submodule": "json-stringify"

76936

},

76937

{

76938

"file": "json/js/stringify.js",

76939

"line": 285,

76940

"description": "Converts an arbitrary value to a JSON string representation.\n\nObjects with cyclical references will trigger an exception.\n\nIf a whitelist is provided, only matching object keys will be\nincluded. Alternately, a replacer function may be passed as the\nsecond parameter. This function is executed on every value in the\ninput, and its return value will be used in place of the original value.\nThis is useful to serialize specialized objects or class instances.\n\nIf a positive integer or non-empty string is passed as the third\nparameter, the output will be formatted with carriage returns and\nindentation for readability. If a String is passed (such as \"\\t\") it\nwill be used once for each indentation level. If a number is passed,\nthat number of spaces will be used.",

76941

"itemtype": "method",

76942

"name": "stringify",

76943

"params": [

76944

{

76945

"name": "o",

76946

"description": "any arbitrary value to convert to JSON string",

76947

"type": "MIXED"

76948

},

76949

{

76950

"name": "w",

76951

"description": "(optional) whitelist of acceptable object\n keys to include, or a replacer function to modify the\n raw value before serialization",

76952

"type": "Array|Function"

76953

},

76954

{

76955

"name": "ind",

76956

"description": "(optional) indentation character or depth of\n spaces to format the output.",

76957

"type": "Number|String"

76958

}

76959

],

76960

"return": {

76961

"description": "JSON string representation of the input",

76962

"type": "String"

76963

},

76964

"static": 1,

76965

"class": "JSON",

76966

"module": "json",

76967

"submodule": "json-stringify"

76968

},

76969

{

76970

"file": "json/js/stringify.js",

76971

"line": 317,

76972

"description": "Number of occurrences of a special character within a single call to\nstringify that should trigger promotion of that character to a dedicated\npreprocess step for future calls. This is only used in environments\nthat don't support native JSON, or when useNativeStringify is set to\nfalse.\n\nSo, if set to 50 and an object is passed to stringify that includes\nstrings containing the special character \\x07 more than 50 times,\nsubsequent calls to stringify will process object strings through a\nfaster serialization path for \\x07 before using the generic, slower,\nreplacement process for all special characters.\n\nTo prime the preprocessor cache, set this value to 1, then call\n<code>Y.JSON.stringify(\"(all special characters to\ncache)\");</code>, then return this setting to a more conservative\nvalue.\n\nSpecial characters \\ \" \\b \\t \\n \\f \\r are already cached.",

76973

"itemtype": "property",

76974

"name": "charCacheThreshold",

76975

"static": 1,

76976

"default": "100",

76977

"type": "{Number}",

76978

"class": "JSON",

76979

"module": "json",

76980

"submodule": "json-stringify"

76981

},

76982

{

76983

"file": "jsonp/js/jsonp-url.js",

76984

"line": 16,

76985

"description": "RegExp used by the default URL formatter to insert the generated callback\nname into the JSONP url. Looks for a query param callback=. If a value\nis assigned, it will be clobbered.",

76986

"itemtype": "property",

76987

"name": "_pattern",

76988

"type": "RegExp",

76989

"default": "/\\bcallback=.*?(?=&|$)/i",

76990

"access": "protected",

76991

"tagname": "",

76992

"class": "JSONPRequest",

76993

"module": "jsonp",

76994

"submodule": "jsonp-url"

76995

},

76996

{

76997

"file": "jsonp/js/jsonp-url.js",

76998

"line": 28,

76999

"description": "Template used by the default URL formatter to add the callback function\nname to the url.",

77000

"itemtype": "property",

77001

"name": "_template",

77002

"type": "String",

77003

"default": "\"callback={callback}\"",

77004

"access": "protected",

77005

"tagname": "",

77006

"class": "JSONPRequest",

77007

"module": "jsonp",

77008

"submodule": "jsonp-url"

77009

},

77010

{

77011

"file": "jsonp/js/jsonp-url.js",

77012

"line": 39,

77013

"description": "Parses the url for a callback named explicitly in the string.\nOverride this if the target JSONP service uses a different query\nparameter or url format.\n\nIf the callback is declared inline, the corresponding function will\nbe returned. Otherwise null.",

77014

"itemtype": "method",

77015

"name": "_defaultCallback",

77016

"params": [

77017

{

77018

"name": "url",

77019

"description": "the url to search in",

77020

"type": "String"

77021

}

77022

],

77023

"return": {

77024

"description": "the callback function if found, or null",

77025

"type": "Function"

77026

},

77027

"access": "protected",

77028

"tagname": "",

77029

"class": "JSONPRequest",

77030

"module": "jsonp",

77031

"submodule": "jsonp-url"

77032

},

77033

{

77034

"file": "jsonp/js/jsonp-url.js",

77035

"line": 93,

77036

"description": "URL formatter that looks for callback= in the url and appends it\nif not present. The supplied proxy name will be assigned to the query\nparam. Override this method by passing a function as the\n"format" property in the config object to the constructor.",

77037

"itemtype": "method",

77038

"name": "_format",

77039

"params": [

77040

{

77041

"name": "url",

77042

"description": "the original url",

77043

"type": "String"

77044

},

77045

{

77046

"name": "proxy",

77047

"description": "the function name that will be used as a proxy to\n the configured callback methods.",

77048

"type": "String"

77049

}

77050

],

77051

"return": {

77052

"description": "fully qualified JSONP url",

77053

"type": "String"

77054

},

77055

"access": "protected",

77056

"tagname": "",

77057

"class": "JSONPRequest",

77058

"module": "jsonp",

77059

"submodule": "jsonp-url"

77060

},

77061

{

77062

"file": "jsonp/js/jsonp.js",

77063

"line": 45,

77064

"description": "Set up the success and failure handlers and the regex pattern used\nto insert the temporary callback name in the url.",

77065

"itemtype": "method",

77066

"name": "_init",

77067

"params": [

77068

{

77069

"name": "url",

77070

"description": "the url of the JSONP service",

77071

"type": "String"

77072

},

77073

{

77074

"name": "callback",

77075

"description": "Optional success callback or config\n object containing success and failure functions and\n the url regex.",

77076

"type": "Object|Function"

77077

}

77078

],

77079

"access": "protected",

77080

"tagname": "",

77081

"class": "JSONPRequest",

77082

"module": "jsonp"

77083

},

77084

{

77085

"file": "jsonp/js/jsonp.js",

77086

"line": 59,

77087

"description": "Map of the number of requests currently pending responses per\ngenerated proxy. Used to ensure the proxy is not flushed if the\nrequest times out and there is a timeout handler and success\nhandler, and used by connections configured to allowCache to make\nsure the proxy isn't deleted until the last response has returned.",

77088

"itemtype": "property",

77089

"name": "_requests",

77090

"access": "private",

77091

"tagname": "",

77092

"type": "{Object}",

77093

"class": "JSONPRequest",

77094

"module": "jsonp"

77095

},

77096

{

77097

"file": "jsonp/js/jsonp.js",

77098

"line": 72,

77099

"description": "Map of the number of timeouts received from the destination url\nby generated proxy. Used to ensure the proxy is not flushed if the\nrequest times out and there is a timeout handler and success\nhandler, and used by connections configured to allowCache to make\nsure the proxy isn't deleted until the last response has returned.",

77100

"itemtype": "property",

77101

"name": "_timeouts",

77102

"access": "private",

77103

"tagname": "",

77104

"type": "{Object}",

77105

"class": "JSONPRequest",

77106

"module": "jsonp"

77107

},

77108

{

77109

"file": "jsonp/js/jsonp.js",

77110

"line": 105,

77111

"description": "Override this method to provide logic to default the success callback if\nit is not provided at construction. This is overridden by jsonp-url to\nparse the callback from the url string.",

77112

"itemtype": "method",

77113

"name": "_defaultCallback",

77114

"params": [

77115

{

77116

"name": "url",

77117

"description": "the url passed at construction",

77118

"type": "String"

77119

},

77120

{

77121

"name": "config",

77122

"description": "(optional) the config object passed at\n construction",

77123

"type": "Object"

77124

}

77125

],

77126

"return": {

77127

"description": "",

77128

"type": "Function"

77129

},

77130

"class": "JSONPRequest",

77131

"module": "jsonp"

77132

},

77133

{

77134

"file": "jsonp/js/jsonp.js",

77135

"line": 118,

77136

"description": "Issues the JSONP request.",

77137

"itemtype": "method",

77138

"name": "send",

77139

"params": [

77140

{

77141

"name": "args",

77142

"description": "any additional arguments to pass to the url formatter\n beyond the base url and the proxy function name",

77143

"type": "Any",

77144

"multiple": true

77145

}

77146

],

77147

"chainable": 1,

77148

"class": "JSONPRequest",

77149

"module": "jsonp"

77150

},

77151

{

77152

"file": "jsonp/js/jsonp.js",

77153

"line": 207,

77154

"description": "Default url formatter. Looks for callback= in the url and appends it\nif not present. The supplied proxy name will be assigned to the query\nparam. Override this method by passing a function as the\n"format" property in the config object to the constructor.",

77155

"itemtype": "method",

77156

"name": "_format",

77157

"params": [

77158

{

77159

"name": "url",

77160

"description": "the original url",

77161

"type": "String"

77162

},

77163

{

77164

"name": "proxy",

77165

"description": "the function name that will be used as a proxy to\n the configured callback methods.",

77166

"type": "String"

77167

},

77168

{

77169

"name": "args",

77170

"description": "additional args passed to send()",

77171

"type": "Any",

77172

"multiple": true

77173

}

77174

],

77175

"return": {

77176

"description": "fully qualified JSONP url",

77177

"type": "String"

77178

},

77179

"access": "protected",

77180

"tagname": "",

77181

"class": "JSONPRequest",

77182

"module": "jsonp"

77183

},

77184

{

77185

"file": "jsonp/js/jsonp.js",

77186

"line": 228,

77187

"itemtype": "method",

77188

"name": "jsonp",

77189

"params": [

77190

{

77191

"name": "url",

77192

"description": "the url of the JSONP service with the {callback}\n placeholder where the callback function name typically goes.",

77193

"type": "String"

77194

},

77195

{

77196

"name": "c",

77197

"description": "Callback function accepting the JSON payload\n as its argument, or a configuration object (see above).",

77198

"type": "Function|Object"

77199

},

77200

{

77201

"name": "args",

77202

"description": "additional arguments to pass to send()",

77203

"type": "Any",

77204

"multiple": true

77205

}

77206

],

77207

"return": {

77208

"description": "",

77209

"type": "JSONPRequest"

77210

},

77211

"static": 1,

77212

"class": "YUI",

77213

"module": "jsonp"

77214

},

77215

{

77216

"file": "loader/js/loader.js",

77217

"line": 44,

77218

"description": "The component metadata is stored in Y.Env.meta.\nPart of the loader module.",

77219

"itemtype": "property",

77220

"name": "meta",

77221

"class": "YUI",

77222

"module": "loader",

77223

"submodule": "loader-base"

77224

},

77225

{

77226

"file": "loader/js/loader.js",

77227

"line": 107,

77228

"description": "Internal callback to handle multiple internal insert() calls\nso that css is inserted prior to js",

77229

"itemtype": "property",

77230

"name": "_internalCallback",

77231

"access": "private",

77232

"tagname": "",

77233

"class": "Loader",

77234

"module": "loader",

77235

"submodule": "loader-base"

77236

},

77237

{

77238

"file": "loader/js/loader.js",

77239

"line": 115,

77240

"description": "Callback that will be executed when the loader is finished\nwith an insert",

77241

"itemtype": "method",

77242

"name": "onSuccess",

77243

"type": "function",

77244

"class": "Loader",

77245

"module": "loader",

77246

"submodule": "loader-base"

77247

},

77248

{

77249

"file": "loader/js/loader.js",

77250

"line": 123,

77251

"description": "Callback that will be executed if there is a failure",

77252

"itemtype": "method",

77253

"name": "onFailure",

77254

"type": "function",

77255

"class": "Loader",

77256

"module": "loader",

77257

"submodule": "loader-base"

77258

},

77259

{

77260

"file": "loader/js/loader.js",

77261

"line": 130,

77262

"description": "Callback for the 'CSSComplete' event. When loading YUI components\nwith CSS the CSS is loaded first, then the script. This provides\na moment you can tie into to improve the presentation of the page\nwhile the script is loading.",

77263

"itemtype": "method",

77264

"name": "onCSS",

77265

"type": "function",

77266

"class": "Loader",

77267

"module": "loader",

77268

"submodule": "loader-base"

77269

},

77270

{

77271

"file": "loader/js/loader.js",

77272

"line": 140,

77273

"description": "Callback executed each time a script or css file is loaded",

77274

"itemtype": "method",

77275

"name": "onProgress",

77276

"type": "function",

77277

"class": "Loader",

77278

"module": "loader",

77279

"submodule": "loader-base"

77280

},

77281

{

77282

"file": "loader/js/loader.js",

77283

"line": 147,

77284

"description": "Callback that will be executed if a timeout occurs",

77285

"itemtype": "method",

77286

"name": "onTimeout",

77287

"type": "function",

77288

"class": "Loader",

77289

"module": "loader",

77290

"submodule": "loader-base"

77291

},

77292

{

77293

"file": "loader/js/loader.js",

77294

"line": 154,

77295

"description": "The execution context for all callbacks",

77296

"itemtype": "property",

77297

"name": "context",

77298

"default": "{YUI} the YUI instance",

77299

"class": "Loader",

77300

"module": "loader",

77301

"submodule": "loader-base"

77302

},

77303

{

77304

"file": "loader/js/loader.js",

77305

"line": 161,

77306

"description": "Data that is passed to all callbacks",

77307

"itemtype": "property",

77308

"name": "data",

77309

"class": "Loader",

77310

"module": "loader",

77311

"submodule": "loader-base"

77312

},

77313

{

77314

"file": "loader/js/loader.js",

77315

"line": 167,

77316

"description": "Node reference or id where new nodes should be inserted before",

77317

"itemtype": "property",

77318

"name": "insertBefore",

77319

"type": "string|HTMLElement",

77320

"class": "Loader",

77321

"module": "loader",

77322

"submodule": "loader-base"

77323

},

77324

{

77325

"file": "loader/js/loader.js",

77326

"line": 174,

77327

"description": "The charset attribute for inserted nodes",

77328

"itemtype": "property",

77329

"name": "charset",

77330

"type": "string",

77331

"deprecated": true,

77332

"deprecationMessage": ", use cssAttributes or jsAttributes.",

77333

"class": "Loader",

77334

"module": "loader",

77335

"submodule": "loader-base"

77336

},

77337

{

77338

"file": "loader/js/loader.js",

77339

"line": 182,

77340

"description": "An object literal containing attributes to add to link nodes",

77341

"itemtype": "property",

77342

"name": "cssAttributes",

77343

"type": "object",

77344

"class": "Loader",

77345

"module": "loader",

77346

"submodule": "loader-base"

77347

},

77348

{

77349

"file": "loader/js/loader.js",

77350

"line": 189,

77351

"description": "An object literal containing attributes to add to script nodes",

77352

"itemtype": "property",

77353

"name": "jsAttributes",

77354

"type": "object",

77355

"class": "Loader",

77356

"module": "loader",

77357

"submodule": "loader-base"

77358

},

77359

{

77360

"file": "loader/js/loader.js",

77361

"line": 196,

77362

"description": "The base directory.",

77363

"itemtype": "property",

77364

"name": "base",

77365

"type": "string",

77366

"default": "http://yui.yahooapis.com/[YUI VERSION]/build/",

77367

"class": "Loader",

77368

"module": "loader",

77369

"submodule": "loader-base"

77370

},

77371

{

77372

"file": "loader/js/loader.js",

77373

"line": 204,

77374

"description": "Base path for the combo service",

77375

"itemtype": "property",

77376

"name": "comboBase",

77377

"type": "string",

77378

"default": "http://yui.yahooapis.com/combo?",

77379

"class": "Loader",

77380

"module": "loader",

77381

"submodule": "loader-base"

77382

},

77383

{

77384

"file": "loader/js/loader.js",

77385

"line": 218,

77386

"description": "If configured, the loader will attempt to use the combo\nservice for YUI resources and configured external resources.",

77387

"itemtype": "property",

77388

"name": "combine",

77389

"type": "boolean",

77390

"default": "true if a base dir isn't in the config",

77391

"class": "Loader",

77392

"module": "loader",

77393

"submodule": "loader-base"

77394

},

77395

{

77396

"file": "loader/js/loader.js",

77397

"line": 228,

77398

"description": "The default seperator to use between files in a combo URL",

77399

"itemtype": "property",

77400

"name": "comboSep",

77401

"type": "{String}",

77402

"default": "Ampersand",

77403

"class": "Loader",

77404

"module": "loader",

77405

"submodule": "loader-base"

77406

},

77407

{

77408

"file": "loader/js/loader.js",

77409

"line": 235,

77410

"description": "Max url length for combo urls. The default is 2048. This is the URL\nlimit for the Yahoo! hosted combo servers. If consuming\na different combo service that has a different URL limit\nit is possible to override this default by supplying\nthe maxURLLength config option. The config option will\nonly take effect if lower than the default.",

77411

"itemtype": "property",

77412

"name": "maxURLLength",

77413

"type": "int",

77414

"class": "Loader",

77415

"module": "loader",

77416

"submodule": "loader-base"

77417

},

77418

{

77419

"file": "loader/js/loader.js",

77420

"line": 248,

77421

"description": "Ignore modules registered on the YUI global",

77422

"itemtype": "property",

77423

"name": "ignoreRegistered",

77424

"default": "false",

77425

"class": "Loader",

77426

"module": "loader",

77427

"submodule": "loader-base"

77428

},

77429

{

77430

"file": "loader/js/loader.js",

77431

"line": 255,

77432

"description": "Root path to prepend to module path for the combo\nservice",

77433

"itemtype": "property",

77434

"name": "root",

77435

"type": "string",

77436

"default": "[YUI VERSION]/build/",

77437

"class": "Loader",

77438

"module": "loader",

77439

"submodule": "loader-base"

77440

},

77441

{

77442

"file": "loader/js/loader.js",

77443

"line": 264,

77444

"description": "Timeout value in milliseconds. If set, self value will be used by\nthe get utility. the timeout event will fire if\na timeout occurs.",

77445

"itemtype": "property",

77446

"name": "timeout",

77447

"type": "int",

77448

"class": "Loader",

77449

"module": "loader",

77450

"submodule": "loader-base"

77451

},

77452

{

77453

"file": "loader/js/loader.js",

77454

"line": 273,

77455

"description": "A list of modules that should not be loaded, even if\nthey turn up in the dependency tree",

77456

"itemtype": "property",

77457

"name": "ignore",

77458

"type": "string[]",

77459

"class": "Loader",

77460

"module": "loader",

77461

"submodule": "loader-base"

77462

},

77463

{

77464

"file": "loader/js/loader.js",

77465

"line": 281,

77466

"description": "A list of modules that should always be loaded, even\nif they have already been inserted into the page.",

77467

"itemtype": "property",

77468

"name": "force",

77469

"type": "string[]",

77470

"class": "Loader",

77471

"module": "loader",

77472

"submodule": "loader-base"

77473

},

77474

{

77475

"file": "loader/js/loader.js",

77476

"line": 291,

77477

"description": "Should we allow rollups",

77478

"itemtype": "property",

77479

"name": "allowRollup",

77480

"type": "boolean",

77481

"default": "false",

77482

"class": "Loader",

77483

"module": "loader",

77484

"submodule": "loader-base"

77485

},

77486

{

77487

"file": "loader/js/loader.js",

77488

"line": 299,

77489

"description": "A filter to apply to result urls. This filter will modify the default\npath for all modules. The default path for the YUI library is the\nminified version of the files (e.g., event-min.js). The filter property\ncan be a predefined filter or a custom filter. The valid predefined\nfilters are:\n<dl>\n <dt>DEBUG</dt>\n <dd>Selects the debug versions of the library (e.g., event-debug.js).\n This option will automatically include the Logger widget</dd>\n <dt>RAW</dt>\n <dd>Selects the non-minified version of the library (e.g., event.js).\n </dd>\n</dl>\nYou can also define a custom filter, which must be an object literal\ncontaining a search expression and a replace string:\n\n myFilter: {\n 'searchExp': \"-min\\\\.js\",\n 'replaceStr': \"-debug.js\"\n }",

77490

"itemtype": "property",

77491

"name": "filter",

77492

"type": "string| {searchExp: string, replaceStr: string}",

77493

"class": "Loader",

77494

"module": "loader",

77495

"submodule": "loader-base"

77496

},

77497

{

77498

"file": "loader/js/loader.js",

77499

"line": 326,

77500

"description": "per-component filter specification. If specified for a given\ncomponent, this overrides the filter config.",

77501

"itemtype": "property",

77502

"name": "filters",

77503

"type": "object",

77504

"class": "Loader",

77505

"module": "loader",

77506

"submodule": "loader-base"

77507

},

77508

{

77509

"file": "loader/js/loader.js",

77510

"line": 334,

77511

"description": "The list of requested modules",

77512

"itemtype": "property",

77513

"name": "required",

77514

"type": "{string: boolean}",

77515

"class": "Loader",

77516

"module": "loader",

77517

"submodule": "loader-base"

77518

},

77519

{

77520

"file": "loader/js/loader.js",

77521

"line": 341,

77522

"description": "If a module name is predefined when requested, it is checked againsts\nthe patterns provided in this property. If there is a match, the\nmodule is added with the default configuration.\n\nAt the moment only supporting module prefixes, but anticipate\nsupporting at least regular expressions.",

77523

"itemtype": "property",

77524

"name": "patterns",

77525

"type": "Object",

77526

"class": "Loader",

77527

"module": "loader",

77528

"submodule": "loader-base"

77529

},

77530

{

77531

"file": "loader/js/loader.js",

77532

"line": 354,

77533

"description": "The library metadata",

77534

"itemtype": "property",

77535

"name": "moduleInfo",

77536

"class": "Loader",

77537

"module": "loader",

77538

"submodule": "loader-base"

77539

},

77540

{

77541

"file": "loader/js/loader.js",

77542

"line": 363,

77543

"description": "Provides the information used to skin the skinnable components.\nThe following skin definition would result in 'skin1' and 'skin2'\nbeing loaded for calendar (if calendar was requested), and\n'sam' for all other skinnable components:\n\n skin: {\n // The default skin, which is automatically applied if not\n // overriden by a component-specific skin definition.\n // Change this in to apply a different skin globally\n defaultSkin: 'sam',\n\n // This is combined with the loader base property to get\n // the default root directory for a skin. ex:\n // http://yui.yahooapis.com/2.3.0/build/assets/skins/sam/\n base: 'assets/skins/',\n \n // Any component-specific overrides can be specified here,\n // making it possible to load different skins for different\n // components. It is possible to load more than one skin\n // for a given component as well.\n overrides: {\n calendar: ['skin1', 'skin2']\n }\n }",

77544

"itemtype": "property",

77545

"name": "skin",

77546

"type": "{Object}",

77547

"class": "Loader",

77548

"module": "loader",

77549

"submodule": "loader-base"

77550

},

77551

{

77552

"file": "loader/js/loader.js",

77553

"line": 424,

77554

"description": "Set when beginning to compute the dependency tree.\nComposed of what YUI reports to be loaded combined\nwith what has been loaded by any instance on the page\nwith the version number specified in the metadata.",

77555

"itemtype": "property",

77556

"name": "loaded",

77557

"type": "{string: boolean}",

77558

"class": "Loader",

77559

"module": "loader",

77560

"submodule": "loader-base"

77561

},

77562

{

77563

"file": "loader/js/loader.js",

77564

"line": 449,

77565

"description": "List of rollup files found in the library metadata",

77566

"itemtype": "property",

77567

"name": "rollups",

77568

"class": "Loader",

77569

"module": "loader",

77570

"submodule": "loader-base"

77571

},

77572

{

77573

"file": "loader/js/loader.js",

77574

"line": 455,

77575

"description": "Whether or not to load optional dependencies for\nthe requested modules",

77576

"itemtype": "property",

77577

"name": "loadOptional",

77578

"type": "boolean",

77579

"default": "false",

77580

"class": "Loader",

77581

"module": "loader",

77582

"submodule": "loader-base"

77583

},

77584

{

77585

"file": "loader/js/loader.js",

77586

"line": 464,

77587

"description": "All of the derived dependencies in sorted order, which\nwill be populated when either calculate() or insert()\nis called",

77588

"itemtype": "property",

77589

"name": "sorted",

77590

"type": "string[]",

77591

"class": "Loader",

77592

"module": "loader",

77593

"submodule": "loader-base"

77594

},

77595

{

77596

"file": "loader/js/loader.js",

77597

"line": 480,

77598

"description": "Flag to indicate the dependency tree needs to be recomputed\nif insert is called again.",

77599

"itemtype": "property",

77600

"name": "dirty",

77601

"type": "boolean",

77602

"default": "true",

77603

"class": "Loader",

77604

"module": "loader",

77605

"submodule": "loader-base"

77606

},

77607

{

77608

"file": "loader/js/loader.js",

77609

"line": 489,

77610

"description": "List of modules inserted by the utility",

77611

"itemtype": "property",

77612

"name": "inserted",

77613

"type": "{string: boolean}",

77614

"class": "Loader",

77615

"module": "loader",

77616

"submodule": "loader-base"

77617

},

77618

{

77619

"file": "loader/js/loader.js",

77620

"line": 496,

77621

"description": "List of skipped modules during insert() because the module\nwas not defined",

77622

"itemtype": "property",

77623

"name": "skipped",

77624

"class": "Loader",

77625

"module": "loader",

77626

"submodule": "loader-base"

77627

},

77628

{

77629

"file": "loader/js/loader.js",

77630

"line": 517,

77631

"description": "Regex that matches a CSS URL. Used to guess the file type when it's not\nspecified.",

77632

"itemtype": "property",

77633

"name": "REGEX_CSS",

77634

"type": "RegExp",

77635

"final": 1,

77636

"access": "protected",

77637

"tagname": "",

77638

"since": "3.5.0",

77639

"class": "Loader",

77640

"module": "loader",

77641

"submodule": "loader-base"

77642

},

77643

{

77644

"file": "loader/js/loader.js",

77645

"line": 529,

77646

"description": "Default filters for raw and debug",

77647

"itemtype": "property",

77648

"name": "FILTER_DEFS",

77649

"type": "Object",

77650

"final": 1,

77651

"access": "protected",

77652

"tagname": "",

77653

"class": "Loader",

77654

"module": "loader",

77655

"submodule": "loader-base"

77656

},

77657

{

77658

"file": "loader/js/loader.js",

77659

"line": 646,

77660

"description": "Apply a new config to the Loader instance",

77661

"itemtype": "method",

77662

"name": "_config",

77663

"access": "private",

77664

"tagname": "",

77665

"params": [

77666

{

77667

"name": "o",

77668

"description": "The new configuration",

77669

"type": "Object"

77670

}

77671

],

77672

"class": "Loader",

77673

"module": "loader",

77674

"submodule": "loader-base"

77675

},

77676

{

77677

"file": "loader/js/loader.js",

77678

"line": 721,

77679

"description": "Returns the skin module name for the specified skin name. If a\nmodule name is supplied, the returned skin module name is\nspecific to the module passed in.",

77680

"itemtype": "method",

77681

"name": "formatSkin",

77682

"params": [

77683

{

77684

"name": "skin",

77685

"description": "the name of the skin.",

77686

"type": "String"

77687

},

77688

{

77689

"name": "mod",

77690

"description": "optional: the name of a module to skin.",

77691

"type": "String"

77692

}

77693

],

77694

"return": {

77695

"description": "the full skin module name.",

77696

"type": "String"

77697

},

77698

"class": "Loader",

77699

"module": "loader",

77700

"submodule": "loader-base"

77701

},

77702

{

77703

"file": "loader/js/loader.js",

77704

"line": 739,

77705

"description": "Adds the skin def to the module info",

77706

"itemtype": "method",

77707

"name": "_addSkin",

77708

"params": [

77709

{

77710

"name": "skin",

77711

"description": "the name of the skin.",

77712

"type": "String"

77713

},

77714

{

77715

"name": "mod",

77716

"description": "the name of the module.",

77717

"type": "String"

77718

},

77719

{

77720

"name": "parent",

77721

"description": "parent module if this is a skin of a\nsubmodule or plugin.",

77722

"type": "String"

77723

}

77724

],

77725

"return": {

77726

"description": "the module name for the skin.",

77727

"type": "String"

77728

},

77729

"access": "private",

77730

"tagname": "",

77731

"class": "Loader",

77732

"module": "loader",

77733

"submodule": "loader-base"

77734

},

77735

{

77736

"file": "loader/js/loader.js",

77737

"line": 784,

77738

"description": "Adds an alias module to the system",

77739

"itemtype": "method",

77740

"name": "addAlias",

77741

"params": [

77742

{

77743

"name": "use",

77744

"description": "An array of modules that makes up this alias",

77745

"type": "Array"

77746

},

77747

{

77748

"name": "name",

77749

"description": "The name of the alias",

77750

"type": "String"

77751

}

77752

],

77753

"example": [

77754

"\n var loader = new Y.Loader({});\n loader.addAlias([ 'node', 'yql' ], 'davglass');\n loader.require(['davglass']);\n var out = loader.resolve(true);\n\n //out.js will contain Node and YQL modules"

77755

],

77756

"class": "Loader",

77757

"module": "loader",

77758

"submodule": "loader-base"

77759

},

77760

{

77761

"file": "loader/js/loader.js",

77762

"line": 804,

77763

"description": "Add a new module group",

77764

"itemtype": "method",

77765

"name": "addGroup",

77766

"params": [

77767

{

77768

"name": "config",

77769

"description": "An object containing the group configuration data",

77770

"type": "Object",

77771

"props": [

77772

{

77773

"name": "name",

77774

"description": "required, the group name",

77775

"type": "String"

77776

},

77777

{

77778

"name": "base",

77779

"description": "The base directory for this module group",

77780

"type": "String"

77781

},

77782

{

77783

"name": "root",

77784

"description": "The root path to add to each combo resource path",

77785

"type": "String"

77786

},

77787

{

77788

"name": "combine",

77789

"description": "Should the request be combined",

77790

"type": "Boolean"

77791

},

77792

{

77793

"name": "comboBase",

77794

"description": "Combo service base path",

77795

"type": "String"

77796

},

77797

{

77798

"name": "modules",

77799

"description": "The group of modules",

77800

"type": "Object"

77801

}

77802

]

77803

},

77804

{

77805

"name": "name",

77806

"description": "the group name.",

77807

"type": "String"

77808

}

77809

],

77810

"example": [

77811

"\n var loader = new Y.Loader({});\n loader.addGroup({\n name: 'davglass',\n combine: true,\n comboBase: '/combo?',\n root: '',\n modules: {\n //Module List here\n }\n }, 'davglass');"

77812

],

77813

"class": "Loader",

77814

"module": "loader",

77815

"submodule": "loader-base"

77816

},

77817

{

77818

"file": "loader/js/loader.js",

77819

"line": 852,

77820

"description": "Add a new module to the component metadata.",

77821

"itemtype": "method",

77822

"name": "addModule",

77823

"params": [

77824

{

77825

"name": "config",

77826

"description": "An object containing the module data.",

77827

"type": "Object",

77828

"props": [

77829

{

77830

"name": "name",

77831

"description": "Required, the component name",

77832

"type": "String"

77833

},

77834

{

77835

"name": "type",

77836

"description": "Required, the component type (js or css)",

77837

"type": "String"

77838

},

77839

{

77840

"name": "path",

77841

"description": "Required, the path to the script from `base`",

77842

"type": "String"

77843

},

77844

{

77845

"name": "requires",

77846

"description": "Array of modules required by this component",

77847

"type": "Array"

77848

},

77849

{

77850

"name": "optional",

77851

"description": "Array of optional modules for this component",

77852

"type": "Array",

77853

"optional": true

77854

},

77855

{

77856

"name": "supersedes",

77857

"description": "Array of the modules this component replaces",

77858

"type": "Array",

77859

"optional": true

77860

},

77861

{

77862

"name": "after",

77863

"description": "Array of modules the components which, if present, should be sorted above this one",

77864

"type": "Array",

77865

"optional": true

77866

},

77867

{

77868

"name": "after_map",

77869

"description": "Faster alternative to 'after' -- supply a hash instead of an array",

77870

"type": "Object",

77871

"optional": true

77872

},

77873

{

77874

"name": "rollup",

77875

"description": "The number of superseded modules required for automatic rollup",

77876

"type": "Number",

77877

"optional": true

77878

},

77879

{

77880

"name": "fullpath",

77881

"description": "If `fullpath` is specified, this is used instead of the configured `base + path`",

77882

"type": "String",

77883

"optional": true

77884

},

77885

{

77886

"name": "skinnable",

77887

"description": "Flag to determine if skin assets should automatically be pulled in",

77888

"type": "Boolean",

77889

"optional": true

77890

},

77891

{

77892

"name": "submodules",

77893

"description": "Hash of submodules",

77894

"type": "Object",

77895

"optional": true

77896

},

77897

{

77898

"name": "group",

77899

"description": "The group the module belongs to -- this is set automatically when it is added as part of a group configuration.",

77900

"type": "String",

77901

"optional": true

77902

},

77903

{

77904

"name": "lang",

77905

"description": "Array of BCP 47 language tags of languages for which this module has localized resource bundles, e.g., `[\"en-GB\", \"zh-Hans-CN\"]`",

77906

"type": "Array",

77907

"optional": true

77908

},

77909

{

77910

"name": "condition",

77911

"description": "Specifies that the module should be loaded automatically if a condition is met. This is an object with up to three fields:",

77912

"type": "Object",

77913

"optional": true,

77914

"props": [

77915

{

77916

"name": "trigger",

77917

"description": "The name of a module that can trigger the auto-load",

77918

"type": "String",

77919

"optional": true

77920

},

77921

{

77922

"name": "test",

77923

"description": "A function that returns true when the module is to be loaded.",

77924

"type": "Function",

77925

"optional": true

77926

},

77927

{

77928

"name": "when",

77929

"description": "Specifies the load order of the conditional module\n with regard to the position of the trigger module.\n This should be one of three values: `before`, `after`, or `instead`. The default is `after`.",

77930

"type": "String",

77931

"optional": true

77932

}

77933

]

77934

},

77935

{

77936

"name": "testresults",

77937

"description": "A hash of test results from `Y.Features.all()`",

77938

"type": "Object",

77939

"optional": true

77940

},

77941

{

77942

"name": "configFn",

77943

"description": "A function to exectute when configuring this module",

77944

"type": "Function",

77945

"optional": true,

77946

"props": [

77947

{

77948

"name": "mod",

77949

"description": "The module config, modifying this object will modify it's config. Returning false will delete the module's config.",

77950

"type": "Object"

77951

}

77952

]

77953

}

77954

]

77955

},

77956

{

77957

"name": "name",

77958

"description": "The module name, required if not in the module data.",

77959

"type": "String",

77960

"optional": true

77961

}

77962

],

77963

"return": {

77964

"description": "the module definition or null if the object passed in did not provide all required attributes.",

77965

"type": "Object"

77966

},

77967

"class": "Loader",

77968

"module": "loader",

77969

"submodule": "loader-base"

77970

},

77971

{

77972

"file": "loader/js/loader.js",

77973

"line": 1135,

77974

"description": "Add a requirement for one or more module",

77975

"itemtype": "method",

77976

"name": "require",

77977

"params": [

77978

{

77979

"name": "what",

77980

"description": "the modules to load.",

77981

"type": "String[] | string*"

77982

}

77983

],

77984

"class": "Loader",

77985

"module": "loader",

77986

"submodule": "loader-base"

77987

},

77988

{

77989

"file": "loader/js/loader.js",

77990

"line": 1147,

77991

"description": "Grab all the items that were asked for, check to see if the Loader\nmeta-data contains a \"use\" array. If it doesm remove the asked item and replace it with \nthe content of the \"use\".\nThis will make asking for: \"dd\"\nActually ask for: \"dd-ddm-base,dd-ddm,dd-ddm-drop,dd-drag,dd-proxy,dd-constrain,dd-drop,dd-scroll,dd-drop-plugin\"",

77992

"access": "private",

77993

"tagname": "",

77994

"itemtype": "method",

77995

"name": "_explodeRollups",

77996

"class": "Loader",

77997

"module": "loader",

77998

"submodule": "loader-base"

77999

},

78000

{

78001

"file": "loader/js/loader.js",

78002

"line": 1181,

78003

"description": "Explodes the required array to remove aliases and replace them with real modules",

78004

"itemtype": "method",

78005

"name": "filterRequires",

78006

"params": [

78007

{

78008

"name": "r",

78009

"description": "The original requires array",

78010

"type": "Array"

78011

}

78012

],

78013

"return": {

78014

"description": "The new array of exploded requirements",

78015

"type": "Array"

78016

},

78017

"class": "Loader",

78018

"module": "loader",

78019

"submodule": "loader-base"

78020

},

78021

{

78022

"file": "loader/js/loader.js",

78023

"line": 1215,

78024

"description": "Returns an object containing properties for all modules required\nin order to load the requested module",

78025

"itemtype": "method",

78026

"name": "getRequires",

78027

"params": [

78028

{

78029

"name": "mod",

78030

"description": "The module definition from moduleInfo.",

78031

"type": "Object"

78032

}

78033

],

78034

"return": {

78035

"description": "the expanded requirement list.",

78036

"type": "Array"

78037

},

78038

"class": "Loader",

78039

"module": "loader",

78040

"submodule": "loader-base"

78041

},

78042

{

78043

"file": "loader/js/loader.js",

78044

"line": 1436,

78045

"description": "Check to see if named css module is already loaded on the page",

78046

"itemtype": "method",

78047

"name": "isCSSLoaded",

78048

"params": [

78049

{

78050

"name": "name",

78051

"description": "The name of the css file",

78052

"type": "String"

78053

}

78054

],

78055

"return": {

78056

"description": "Boolean"

78057

},

78058

"class": "Loader",

78059

"module": "loader",

78060

"submodule": "loader-base"

78061

},

78062

{

78063

"file": "loader/js/loader.js",

78064

"line": 1470,

78065

"description": "Returns a hash of module names the supplied module satisfies.",

78066

"itemtype": "method",

78067

"name": "getProvides",

78068

"params": [

78069

{

78070

"name": "name",

78071

"description": "The name of the module.",

78072

"type": "String"

78073

}

78074

],

78075

"return": {

78076

"description": "what this module provides.",

78077

"type": "Object"

78078

},

78079

"class": "Loader",

78080

"module": "loader",

78081

"submodule": "loader-base"

78082

},

78083

{

78084

"file": "loader/js/loader.js",

78085

"line": 1502,

78086

"description": "Calculates the dependency tree, the result is stored in the sorted\nproperty.",

78087

"itemtype": "method",

78088

"name": "calculate",

78089

"params": [

78090

{

78091

"name": "o",

78092

"description": "optional options object.",

78093

"type": "Object"

78094

},

78095

{

78096

"name": "type",

78097

"description": "optional argument to prune modules.",

78098

"type": "String"

78099

}

78100

],

78101

"class": "Loader",

78102

"module": "loader",

78103

"submodule": "loader-base"

78104

},

78105

{

78106

"file": "loader/js/loader.js",

78107

"line": 1531,

78108

"description": "Creates a \"psuedo\" package for languages provided in the lang array",

78109

"itemtype": "method",

78110

"name": "_addLangPack",

78111

"access": "private",

78112

"tagname": "",

78113

"params": [

78114

{

78115

"name": "lang",

78116

"description": "The language to create",

78117

"type": "String"

78118

},

78119

{

78120

"name": "m",

78121

"description": "The module definition to create the language pack around",

78122

"type": "Object"

78123

},

78124

{

78125

"name": "packName",

78126

"description": "The name of the package (e.g: lang/datatype-date-en-US)",

78127

"type": "String"

78128

}

78129

],

78130

"return": {

78131

"description": "The module definition",

78132

"type": "Object"

78133

},

78134

"class": "Loader",

78135

"module": "loader",

78136

"submodule": "loader-base"

78137

},

78138

{

78139

"file": "loader/js/loader.js",

78140

"line": 1574,

78141

"description": "Investigates the current YUI configuration on the page. By default,\nmodules already detected will not be loaded again unless a force\noption is encountered. Called by calculate()",

78142

"itemtype": "method",

78143

"name": "_setup",

78144

"access": "private",

78145

"tagname": "",

78146

"class": "Loader",

78147

"module": "loader",

78148

"submodule": "loader-base"

78149

},

78150

{

78151

"file": "loader/js/loader.js",

78152

"line": 1641,

78153

"description": "Builds a module name for a language pack",

78154

"itemtype": "method",

78155

"name": "getLangPackName",

78156

"params": [

78157

{

78158

"name": "lang",

78159

"description": "the language code.",

78160

"type": "String"

78161

},

78162

{

78163

"name": "mname",

78164

"description": "the module to build it for.",

78165

"type": "String"

78166

}

78167

],

78168

"return": {

78169

"description": "the language pack module name.",

78170

"type": "String"

78171

},

78172

"class": "Loader",

78173

"module": "loader",

78174

"submodule": "loader-base"

78175

},

78176

{

78177

"file": "loader/js/loader.js",

78178

"line": 1651,

78179

"description": "Inspects the required modules list looking for additional\ndependencies. Expands the required list to include all\nrequired modules. Called by calculate()",

78180

"itemtype": "method",

78181

"name": "_explode",

78182

"access": "private",

78183

"tagname": "",

78184

"class": "Loader",

78185

"module": "loader",

78186

"submodule": "loader-base"

78187

},

78188

{

78189

"file": "loader/js/loader.js",

78190

"line": 1690,

78191

"description": "Get's the loader meta data for the requested module",

78192

"itemtype": "method",

78193

"name": "getModule",

78194

"params": [

78195

{

78196

"name": "mname",

78197

"description": "The module name to get",

78198

"type": "String"

78199

}

78200

],

78201

"return": {

78202

"description": "The module metadata",

78203

"type": "Object"

78204

},

78205

"class": "Loader",

78206

"module": "loader",

78207

"submodule": "loader-base"

78208

},

78209

{

78210

"file": "loader/js/loader.js",

78211

"line": 1752,

78212

"description": "Remove superceded modules and loaded modules. Called by\ncalculate() after we have the mega list of all dependencies",

78213

"itemtype": "method",

78214

"name": "_reduce",

78215

"return": {

78216

"description": "the reduced dependency hash.",

78217

"type": "Object"

78218

},

78219

"access": "private",

78220

"tagname": "",

78221

"class": "Loader",

78222

"module": "loader",

78223

"submodule": "loader-base"

78224

},

78225

{

78226

"file": "loader/js/loader.js",

78227

"line": 1792,

78228

"description": "Handles the queue when a module has been loaded for all cases",

78229

"itemtype": "method",

78230

"name": "_finish",

78231

"access": "private",

78232

"tagname": "",

78233

"params": [

78234

{

78235

"name": "msg",

78236

"description": "The message from Loader",

78237

"type": "String"

78238

},

78239

{

78240

"name": "success",

78241

"description": "A boolean denoting success or failure",

78242

"type": "Boolean"

78243

}

78244

],

78245

"class": "Loader",

78246

"module": "loader",

78247

"submodule": "loader-base"

78248

},

78249

{

78250

"file": "loader/js/loader.js",

78251

"line": 1815,

78252

"description": "The default Loader onSuccess handler, calls this.onSuccess with a payload",

78253

"itemtype": "method",

78254

"name": "_onSuccess",

78255

"access": "private",

78256

"tagname": "",

78257

"class": "Loader",

78258

"module": "loader",

78259

"submodule": "loader-base"

78260

},

78261

{

78262

"file": "loader/js/loader.js",

78263

"line": 1854,

78264

"description": "The default Loader onProgress handler, calls this.onProgress with a payload",

78265

"itemtype": "method",

78266

"name": "_onProgress",

78267

"access": "private",

78268

"tagname": "",

78269

"class": "Loader",

78270

"module": "loader",

78271

"submodule": "loader-base"

78272

},

78273

{

78274

"file": "loader/js/loader.js",

78275

"line": 1868,

78276

"description": "The default Loader onFailure handler, calls this.onFailure with a payload",

78277

"itemtype": "method",

78278

"name": "_onFailure",

78279

"access": "private",

78280

"tagname": "",

78281

"class": "Loader",

78282

"module": "loader",

78283

"submodule": "loader-base"

78284

},

78285

{

78286

"file": "loader/js/loader.js",

78287

"line": 1896,

78288

"description": "The default Loader onTimeout handler, calls this.onTimeout with a payload",

78289

"itemtype": "method",

78290

"name": "_onTimeout",

78291

"access": "private",

78292

"tagname": "",

78293

"class": "Loader",

78294

"module": "loader",

78295

"submodule": "loader-base"

78296

},

78297

{

78298

"file": "loader/js/loader.js",

78299

"line": 1913,

78300

"description": "Sorts the dependency tree. The last step of calculate()",

78301

"itemtype": "method",

78302

"name": "_sort",

78303

"access": "private",

78304

"tagname": "",

78305

"class": "Loader",

78306

"module": "loader",

78307

"submodule": "loader-base"

78308

},

78309

{

78310

"file": "loader/js/loader.js",

78311

"line": 1985,

78312

"description": "Handles the actual insertion of script/link tags",

78313

"itemtype": "method",

78314

"name": "_insert",

78315

"access": "private",

78316

"tagname": "",

78317

"params": [

78318

{

78319

"name": "source",

78320

"description": "The YUI instance the request came from",

78321

"type": "Object"

78322

},

78323

{

78324

"name": "o",

78325

"description": "The metadata to include",

78326

"type": "Object"

78327

},

78328

{

78329

"name": "type",

78330

"description": "JS or CSS",

78331

"type": "String"

78332

},

78333

{

78334

"name": "skipcalc",

78335

"description": "Do a Loader.calculate on the meta",

78336

"type": "Boolean",

78337

"optional": true,

78338

"optdefault": "false"

78339

}

78340

],

78341

"class": "Loader",

78342

"module": "loader",

78343

"submodule": "loader-base"

78344

},

78345

{

78346

"file": "loader/js/loader.js",

78347

"line": 2129,

78348

"description": "Once a loader operation is completely finished, process any additional queued items.",

78349

"itemtype": "method",

78350

"name": "_continue",

78351

"access": "private",

78352

"tagname": "",

78353

"class": "Loader",

78354

"module": "loader",

78355

"submodule": "loader-base"

78356

},

78357

{

78358

"file": "loader/js/loader.js",

78359

"line": 2141,

78360

"description": "inserts the requested modules and their dependencies.\n<code>type</code> can be \"js\" or \"css\". Both script and\ncss are inserted if type is not provided.",

78361

"itemtype": "method",

78362

"name": "insert",

78363

"params": [

78364

{

78365

"name": "o",

78366

"description": "optional options object.",

78367

"type": "Object"

78368

},

78369

{

78370

"name": "type",

78371

"description": "the type of dependency to insert.",

78372

"type": "String"

78373

}

78374

],

78375

"class": "Loader",

78376

"module": "loader",

78377

"submodule": "loader-base"

78378

},

78379

{

78380

"file": "loader/js/loader.js",

78381

"line": 2161,

78382

"description": "Executed every time a module is loaded, and if we are in a load\ncycle, we attempt to load the next script. Public so that it\nis possible to call this if using a method other than\nY.register to determine when scripts are fully loaded",

78383

"itemtype": "method",

78384

"name": "loadNext",

78385

"deprecated": true,

78386

"params": [

78387

{

78388

"name": "mname",

78389

"description": "optional the name of the module that has\nbeen loaded (which is usually why it is time to load the next\none).",

78390

"type": "String"

78391

}

78392

],

78393

"class": "Loader",

78394

"module": "loader",

78395

"submodule": "loader-base"

78396

},

78397

{

78398

"file": "loader/js/loader.js",

78399

"line": 2177,

78400

"description": "Apply filter defined for this instance to a url/path",

78401

"itemtype": "method",

78402

"name": "_filter",

78403

"params": [

78404

{

78405

"name": "u",

78406

"description": "the string to filter.",

78407

"type": "String"

78408

},

78409

{

78410

"name": "name",

78411

"description": "the name of the module, if we are processing\na single module as opposed to a combined url.",

78412

"type": "String"

78413

}

78414

],

78415

"return": {

78416

"description": "the filtered string.",

78417

"type": "String"

78418

},

78419

"access": "private",

78420

"tagname": "",

78421

"class": "Loader",

78422

"module": "loader",

78423

"submodule": "loader-base"

78424

},

78425

{

78426

"file": "loader/js/loader.js",

78427

"line": 2211,

78428

"description": "Generates the full url for a module",

78429

"itemtype": "method",

78430

"name": "_url",

78431

"params": [

78432

{

78433

"name": "path",

78434

"description": "the path fragment.",

78435

"type": "String"

78436

},

78437

{

78438

"name": "name",

78439

"description": "The name of the module",

78440

"type": "String"

78441

},

78442

{

78443

"name": "base",

78444

"description": "The base url to use",

78445

"type": "String",

78446

"optional": true,

78447

"optdefault": "self.base"

78448

}

78449

],

78450

"return": {

78451

"description": "the full url.",

78452

"type": "String"

78453

},

78454

"access": "private",

78455

"tagname": "",

78456

"class": "Loader",

78457

"module": "loader",

78458

"submodule": "loader-base"

78459

},

78460

{

78461

"file": "loader/js/loader.js",

78462

"line": 2223,

78463

"description": "Returns an Object hash of file arrays built from `loader.sorted` or from an arbitrary list of sorted modules.",

78464

"itemtype": "method",

78465

"name": "resolve",

78466

"params": [

78467

{

78468

"name": "calc",

78469

"description": "Perform a loader.calculate() before anything else",

78470

"type": "Boolean",

78471

"optional": true,

78472

"optdefault": "false"

78473

},

78474

{

78475

"name": "s",

78476

"description": "An override for the loader.sorted array",

78477

"type": "Array",

78478

"optional": true,

78479

"optdefault": "loader.sorted"

78480

}

78481

],

78482

"return": {

78483

"description": "Object hash (js and css) of two arrays of file lists",

78484

"type": "Object"

78485

},

78486

"example": [

78487

" This method can be used as an off-line dep calculator\n\n var Y = YUI();\n var loader = new Y.Loader({\n filter: 'debug',\n base: '../../',\n root: 'build/',\n combine: true,\n require: ['node', 'dd', 'console']\n });\n var out = loader.resolve(true);\n"

78488

],

78489

"class": "Loader",

78490

"module": "loader",

78491

"submodule": "loader-base"

78492

},

78493

{

78494

"file": "loader/js/loader.js",

78495

"line": 2421,

78496

"description": "Shortcut to calculate, resolve and load all modules.\n\n var loader = new Y.Loader({\n ignoreRegistered: true,\n modules: {\n mod: {\n path: 'mod.js'\n }\n },\n requires: [ 'mod' ]\n });\n loader.load(function() {\n console.log('All modules have loaded..');\n });",

78497

"itemtype": "method",

78498

"name": "load",

78499

"params": [

78500

{

78501

"name": "cb",

78502

"description": "Executed after all load operations are complete",

78503

"type": "Callback"

78504

}

78505

],

78506

"class": "Loader",

78507

"module": "loader",

78508

"submodule": "loader-base"

78509

},

78510

{

78511

"file": "loader/js/rollup.js",

78512

"line": 8,

78513

"description": "Look for rollup packages to determine if all of the modules a\nrollup supersedes are required. If so, include the rollup to\nhelp reduce the total number of connections required. Called\nby calculate(). This is an optional feature, and requires the\nappropriate submodule to function.",

78514

"itemtype": "method",

78515

"name": "_rollup",

78516

"access": "private",

78517

"tagname": "",

78518

"class": "Loader",

78519

"module": "loader",

78520

"submodule": "rollup"

78521

},

78522

{

78523

"file": "matrix/js/Matrix.js",

78524

"line": 14,

78525

"description": "Used as value for the _rounding method.",

78526

"itemtype": "property",

78527

"name": "_rounder",

78528

"access": "private",

78529

"tagname": "",

78530

"class": "Matrix",

78531

"module": "matrix"

78532

},

78533

{

78534

"file": "matrix/js/Matrix.js",

78535

"line": 22,

78536

"description": "Updates the matrix.",

78537

"itemtype": "method",

78538

"name": "multiple",

78539

"params": [

78540

{

78541

"name": "a",

78542

"description": "",

78543

"type": "Number"

78544

},

78545

{

78546

"name": "b",

78547

"description": "",

78548

"type": "Number"

78549

},

78550

{

78551

"name": "c",

78552

"description": "",

78553

"type": "Number"

78554

},

78555

{

78556

"name": "d",

78557

"description": "",

78558

"type": "Number"

78559

},

78560

{

78561

"name": "dx",

78562

"description": "",

78563

"type": "Number"

78564

},

78565

{

78566

"name": "dy",

78567

"description": "",

78568

"type": "Number"

78569

}

78570

],

78571

"class": "Matrix",

78572

"module": "matrix"

78573

},

78574

{

78575

"file": "matrix/js/Matrix.js",

78576

"line": 51,

78577

"description": "Parses a string and updates the matrix.",

78578

"itemtype": "method",

78579

"name": "applyCSSText",

78580

"params": [

78581

{

78582

"name": "val",

78583

"description": "A css transform string",

78584

"type": "String"

78585

}

78586

],

78587

"class": "Matrix",

78588

"module": "matrix"

78589

},

78590

{

78591

"file": "matrix/js/Matrix.js",

78592

"line": 71,

78593

"description": "Parses a string and returns an array of transform arrays.",

78594

"itemtype": "method",

78595

"name": "getTransformArray",

78596

"params": [

78597

{

78598

"name": "val",

78599

"description": "A css transform string",

78600

"type": "String"

78601

}

78602

],

78603

"return": {

78604

"description": "Array"

78605

},

78606

"class": "Matrix",

78607

"module": "matrix"

78608

},

78609

{

78610

"file": "matrix/js/Matrix.js",

78611

"line": 95,

78612

"description": "Default values for the matrix",

78613

"itemtype": "property",

78614

"name": "_defaults",

78615

"access": "private",

78616

"tagname": "",

78617

"class": "Matrix",

78618

"module": "matrix"

78619

},

78620

{

78621

"file": "matrix/js/Matrix.js",

78622

"line": 110,

78623

"description": "Rounds values",

78624

"itemtype": "method",

78625

"name": "_round",

78626

"access": "private",

78627

"tagname": "",

78628

"class": "Matrix",

78629

"module": "matrix"

78630

},

78631

{

78632

"file": "matrix/js/Matrix.js",

78633

"line": 121,

78634

"description": "Initializes a matrix.",

78635

"itemtype": "method",

78636

"name": "init",

78637

"params": [

78638

{

78639

"name": "config",

78640

"description": "Specified key value pairs for matrix properties. If a property is not explicitly defined in the config argument,\nthe default value will be used.",

78641

"type": "Object"

78642

}

78643

],

78644

"class": "Matrix",

78645

"module": "matrix"

78646

},

78647

{

78648

"file": "matrix/js/Matrix.js",

78649

"line": 144,

78650

"description": "Applies a scale transform",

78651

"itemtype": "method",

78652

"name": "scale",

78653

"params": [

78654

{

78655

"name": "val",

78656

"description": "",

78657

"type": "Number"

78658

}

78659

],

78660

"class": "Matrix",

78661

"module": "matrix"

78662

},

78663

{

78664

"file": "matrix/js/Matrix.js",

78665

"line": 155,

78666

"description": "Applies a skew transformation.",

78667

"itemtype": "method",

78668

"name": "skew",

78669

"params": [

78670

{

78671

"name": "x",

78672

"description": "The value to skew on the x-axis.",

78673

"type": "Number"

78674

},

78675

{

78676

"name": "y",

78677

"description": "The value to skew on the y-axis.",

78678

"type": "Number"

78679

}

78680

],

78681

"class": "Matrix",

78682

"module": "matrix"

78683

},

78684

{

78685

"file": "matrix/js/Matrix.js",

78686

"line": 179,

78687

"description": "Applies a skew to the x-coordinate",

78688

"itemtype": "method",

78689

"name": "skewX",

78690

"params": [

78691

{

78692

"name": "x",

78693

"description": "x-coordinate",

78694

"type": "Number"

78695

}

78696

],

78697

"class": "Matrix",

78698

"module": "matrix"

78699

},

78700

{

78701

"file": "matrix/js/Matrix.js",

78702

"line": 190,

78703

"description": "Applies a skew to the y-coordinate",

78704

"itemtype": "method",

78705

"name": "skewY",

78706

"params": [

78707

{

78708

"name": "y",

78709

"description": "y-coordinate",

78710

"type": "Number"

78711

}

78712

],

78713

"class": "Matrix",

78714

"module": "matrix"

78715

},

78716

{

78717

"file": "matrix/js/Matrix.js",

78718

"line": 201,

78719

"description": "Returns a string of text that can be used to populate a the css transform property of an element.",

78720

"itemtype": "method",

78721

"name": "toCSSText",

78722

"return": {

78723

"description": "String"

78724

},

78725

"class": "Matrix",

78726

"module": "matrix"

78727

},

78728

{

78729

"file": "matrix/js/Matrix.js",

78730

"line": 235,

78731

"description": "Returns a string that can be used to populate the css filter property of an element.",

78732

"itemtype": "method",

78733

"name": "toFilterText",

78734

"return": {

78735

"description": "String"

78736

},

78737

"class": "Matrix",

78738

"module": "matrix"

78739

},

78740

{

78741

"file": "matrix/js/Matrix.js",

78742

"line": 255,

78743

"description": "Converts a radian value to a degree.",

78744

"itemtype": "method",

78745

"name": "rad2deg",

78746

"params": [

78747

{

78748

"name": "rad",

78749

"description": "Radian value to be converted.",

78750

"type": "Number"

78751

}

78752

],

78753

"return": {

78754

"description": "Number"

78755

},

78756

"class": "Matrix",

78757

"module": "matrix"

78758

},

78759

{

78760

"file": "matrix/js/Matrix.js",

78761

"line": 267,

78762

"description": "Converts a degree value to a radian.",

78763

"itemtype": "method",

78764

"name": "deg2rad",

78765

"params": [

78766

{

78767

"name": "deg",

78768

"description": "Degree value to be converted to radian.",

78769

"type": "Number"

78770

}

78771

],

78772

"return": {

78773

"description": "Number"

78774

},

78775

"class": "Matrix",

78776

"module": "matrix"

78777

},

78778

{

78779

"file": "matrix/js/Matrix.js",

78780

"line": 289,

78781

"description": "Applies a rotate transform.",

78782

"itemtype": "method",

78783

"name": "rotate",

78784

"params": [

78785

{

78786

"name": "deg",

78787

"description": "The degree of the rotation.",

78788

"type": "Number"

78789

}

78790

],

78791

"class": "Matrix",

78792

"module": "matrix"

78793

},

78794

{

78795

"file": "matrix/js/Matrix.js",

78796

"line": 303,

78797

"description": "Applies translate transformation.",

78798

"itemtype": "method",

78799

"name": "translate",

78800

"params": [

78801

{

78802

"name": "x",

78803

"description": "The value to transate on the x-axis.",

78804

"type": "Number"

78805

},

78806

{

78807

"name": "y",

78808

"description": "The value to translate on the y-axis.",

78809

"type": "Number"

78810

}

78811

],

78812

"class": "Matrix",

78813

"module": "matrix"

78814

},

78815

{

78816

"file": "matrix/js/Matrix.js",

78817

"line": 317,

78818

"description": "Returns an identity matrix.",

78819

"itemtype": "method",

78820

"name": "identity",

78821

"return": {

78822

"description": "Object"

78823

},

78824

"class": "Matrix",

78825

"module": "matrix"

78826

},

78827

{

78828

"file": "matrix/js/Matrix.js",

78829

"line": 336,

78830

"description": "Returns a 3x3 Matrix array\n\n/ \\\n| matrix[0][0] matrix[1][0] matrix[2][0] |\n| matrix[0][1] matrix[1][1] matrix[2][1] |\n| matrix[0][2] matrix[1][2] matrix[2][2] |\n\\ /",

78831

"itemtype": "method",

78832

"name": "getMatrixArray",

78833

"return": {

78834

"description": "Array"

78835

},

78836

"class": "Matrix",

78837

"module": "matrix"

78838

},

78839

{

78840

"file": "matrix/js/Matrix.js",

78841

"line": 359,

78842

"description": "Returns the left, top, right and bottom coordinates for a transformed\nitem.",

78843

"itemtype": "method",

78844

"name": "getContentRect",

78845

"params": [

78846

{

78847

"name": "width",

78848

"description": "The width of the item.",

78849

"type": "Number"

78850

},

78851

{

78852

"name": "height",

78853

"description": "The height of the item.",

78854

"type": "Number"

78855

},

78856

{

78857

"name": "x",

78858

"description": "The x-coordinate of the item.",

78859

"type": "Number"

78860

},

78861

{

78862

"name": "y",

78863

"description": "The y-coordinate of the item.",

78864

"type": "Number"

78865

}

78866

],

78867

"return": {

78868

"description": "Object"

78869

},

78870

"class": "Matrix",

78871

"module": "matrix"

78872

},

78873

{

78874

"file": "matrix/js/Matrix.js",

78875

"line": 402,

78876

"description": "Returns the determinant of the matrix.",

78877

"itemtype": "method",

78878

"name": "getDeterminant",

78879

"return": {

78880

"description": "Number"

78881

},

78882

"class": "Matrix",

78883

"module": "matrix"

78884

},

78885

{

78886

"file": "matrix/js/Matrix.js",

78887

"line": 413,

78888

"description": "Returns the inverse (in array form) of the matrix.",

78889

"itemtype": "method",

78890

"name": "inverse",

78891

"return": {

78892

"description": "Array"

78893

},

78894

"class": "Matrix",

78895

"module": "matrix"

78896

},

78897

{

78898

"file": "matrix/js/Matrix.js",

78899

"line": 424,

78900

"description": "Returns the transpose of the matrix",

78901

"itemtype": "method",

78902

"name": "transpose",

78903

"return": {

78904

"description": "Array"

78905

},

78906

"class": "Matrix",

78907

"module": "matrix"

78908

},

78909

{

78910

"file": "matrix/js/Matrix.js",

78911

"line": 435,

78912

"description": "Returns an array of transform commands that represent the matrix.",

78913

"itemtype": "method",

78914

"name": "decompose",

78915

"return": {

78916

"description": "Array"

78917

},

78918

"class": "Matrix",

78919

"module": "matrix"

78920

},

78921

{

78922

"file": "matrix/js/MatrixUtil.js",

78923

"line": 2,

78924

"description": "Used as value for the _rounding method.",

78925

"itemtype": "property",

78926

"name": "_rounder",

78927

"access": "private",

78928

"tagname": "",

78929

"class": "Plugin.Flick",

78930

"module": "matrix"

78931

},

78932

{

78933

"file": "matrix/js/MatrixUtil.js",

78934

"line": 10,

78935

"description": "Rounds values",

78936

"itemtype": "method",

78937

"name": "_round",

78938

"access": "private",

78939

"tagname": "",

78940

"class": "Plugin.Flick",

78941

"module": "matrix"

78942

},

78943

{

78944

"file": "matrix/js/MatrixUtil.js",

78945

"line": 20,

78946

"description": "Converts a radian value to a degree.",

78947

"itemtype": "method",

78948

"name": "rad2deg",

78949

"params": [

78950

{

78951

"name": "rad",

78952

"description": "Radian value to be converted.",

78953

"type": "Number"

78954

}

78955

],

78956

"return": {

78957

"description": "Number"

78958

},

78959

"class": "Plugin.Flick",

78960

"module": "matrix"

78961

},

78962

{

78963

"file": "matrix/js/MatrixUtil.js",

78964

"line": 32,

78965

"description": "Converts a degree value to a radian.",

78966

"itemtype": "method",

78967

"name": "deg2rad",

78968

"params": [

78969

{

78970

"name": "deg",

78971

"description": "Degree value to be converted to radian.",

78972

"type": "Number"

78973

}

78974

],

78975

"return": {

78976

"description": "Number"

78977

},

78978

"class": "Plugin.Flick",

78979

"module": "matrix"

78980

},

78981

{

78982

"file": "matrix/js/MatrixUtil.js",

78983

"line": 44,

78984

"description": "Converts an angle to a radian",

78985

"itemtype": "method",

78986

"name": "angle2rad",

78987

"params": [

78988

{

78989

"name": "val",

78990

"description": "Value to be converted to radian.",

78991

"type": "Objecxt"

78992

}

78993

],

78994

"return": {

78995

"description": "Number"

78996

},

78997

"class": "Plugin.Flick",

78998

"module": "matrix"

78999

},

79000

{

79001

"file": "matrix/js/MatrixUtil.js",

79002

"line": 61,

79003

"description": "Converts a transform object to an array of column vectors. \n\n/ \\\n| matrix[0][0] matrix[1][0] matrix[2][0] |\n| matrix[0][1] matrix[1][1] matrix[2][1] |\n| matrix[0][2] matrix[1][2] matrix[2][2] |\n\\ /",

79004

"itemtype": "method",

79005

"name": "getnxn",

79006

"return": {

79007

"description": "Array"

79008

},

79009

"class": "Plugin.Flick",

79010

"module": "matrix"

79011

},

79012

{

79013

"file": "matrix/js/MatrixUtil.js",

79014

"line": 83,

79015

"description": "Returns the determinant of a given matrix. \n\n/ \\\n| matrix[0][0] matrix[1][0] matrix[2][0] |\n| matrix[0][1] matrix[1][1] matrix[2][1] |\n| matrix[0][2] matrix[1][2] matrix[2][2] |\n| matrix[0][3] matrix[1][3] matrix[2][3] |\n\\ /",

79016

"itemtype": "method",

79017

"name": "getDeterminant",

79018

"params": [

79019

{

79020

"name": "matrix",

79021

"description": "An nxn matrix represented an array of vector (column) arrays. Each vector array has index for each row.",

79022

"type": "Array"

79023

}

79024

],

79025

"return": {

79026

"description": "Number"

79027

},

79028

"class": "Plugin.Flick",

79029

"module": "matrix"

79030

},

79031

{

79032

"file": "matrix/js/MatrixUtil.js",

79033

"line": 123,

79034

"description": "Returns the inverse of a matrix",

79035

"itemtype": "method",

79036

"name": "inverse",

79037

"params": [

79038

{

79039

"name": "Array",

79040

"description": "matrix An array representing an nxn matrix"

79041

}

79042

],

79043

"return": {

79044

"description": "Array\n\n/ \\\n| matrix[0][0] matrix[1][0] matrix[2][0] |\n| matrix[0][1] matrix[1][1] matrix[2][1] |\n| matrix[0][2] matrix[1][2] matrix[2][2] |\n| matrix[0][3] matrix[1][3] matrix[2][3] |\n\\ /"

79045

},

79046

"class": "Plugin.Flick",

79047

"module": "matrix"

79048

},

79049

{

79050

"file": "matrix/js/MatrixUtil.js",

79051

"line": 176,

79052

"description": "Multiplies a matrix by a numeric value.",

79053

"itemtype": "method",

79054

"name": "scalarMultiply",

79055

"params": [

79056

{

79057

"name": "matrix",

79058

"description": "The matrix to be altered.",

79059

"type": "Array"

79060

},

79061

{

79062

"name": "multiplier",

79063

"description": "The number to multiply against the matrix.",

79064

"type": "Number"

79065

}

79066

],

79067

"return": {

79068

"description": "Array"

79069

},

79070

"class": "Plugin.Flick",

79071

"module": "matrix"

79072

},

79073

{

79074

"file": "matrix/js/MatrixUtil.js",

79075

"line": 199,

79076

"description": "Returns the transpose for an nxn matrix.",

79077

"itemtype": "method",

79078

"name": "transpose",

79079

"params": [

79080

{

79081

"name": "matrix",

79082

"description": "An nxn matrix represented by an array of vector arrays."

79083

}

79084

],

79085

"return": {

79086

"description": "Array"

79087

},

79088

"class": "Plugin.Flick",

79089

"module": "matrix"

79090

},

79091

{

79092

"file": "matrix/js/MatrixUtil.js",

79093

"line": 223,

79094

"description": "Returns a matrix of minors based on a matrix, column index and row index.",

79095

"itemtype": "method",

79096

"name": "getMinors",

79097

"params": [

79098

{

79099

"name": "matrix",

79100

"description": "The matrix from which to extract the matrix of minors.",

79101

"type": "Array"

79102

},

79103

{

79104

"name": "columnIndex",

79105

"description": "A zero-based index representing the specified column to exclude.",

79106

"type": "Number"

79107

},

79108

{

79109

"name": "rowIndex",

79110

"description": "A zero-based index represeenting the specified row to exclude.",

79111

"type": "Number"

79112

}

79113

],

79114

"return": {

79115

"description": "Array"

79116

},

79117

"class": "Plugin.Flick",

79118

"module": "matrix"

79119

},

79120

{

79121

"file": "matrix/js/MatrixUtil.js",

79122

"line": 257,

79123

"description": "Returns the sign of value",

79124

"itemtype": "method",

79125

"name": "sign",

79126

"params": [

79127

{

79128

"name": "val",

79129

"description": "value to be interpreted",

79130

"type": "Number"

79131

}

79132

],

79133

"return": {

79134

"description": "Number"

79135

},

79136

"class": "Plugin.Flick",

79137

"module": "matrix"

79138

},

79139

{

79140

"file": "matrix/js/MatrixUtil.js",

79141

"line": 269,

79142

"description": "Multiplies a vector and a matrix",

79143

"itemtype": "method",

79144

"name": "vectorMatrixProduct",

79145

"params": [

79146

{

79147

"name": "vector",

79148

"description": "Array representing a column vector",

79149

"type": "Array"

79150

},

79151

{

79152

"name": "matrix",

79153

"description": "Array representing an nxn matrix",

79154

"type": "Array"

79155

}

79156

],

79157

"return": {

79158

"description": "Array"

79159

},

79160

"class": "Plugin.Flick",

79161

"module": "matrix"

79162

},

79163

{

79164

"file": "matrix/js/MatrixUtil.js",

79165

"line": 296,

79166

"description": "Breaks up a 2d transform matrix into a series of transform operations.",

79167

"itemtype": "method",

79168

"name": "decompose",

79169

"params": [

79170

{

79171

"name": "3x3",

79172

"description": "matrix array",

79173

"type": "Array"

79174

}

79175

],

79176

"return": {

79177

"description": "Array"

79178

},

79179

"class": "Plugin.Flick",

79180

"module": "matrix"

79181

},

79182

{

79183

"file": "matrix/js/MatrixUtil.js",

79184

"line": 344,

79185

"description": "Parses a transform string and returns an array of transform arrays.",

79186

"itemtype": "method",

79187

"name": "getTransformArray",

79188

"params": [

79189

{

79190

"name": "val",

79191

"description": "A transform string",

79192

"type": "String"

79193

}

79194

],

79195

"return": {

79196

"description": "Array"

79197

},

79198

"class": "Plugin.Flick",

79199

"module": "matrix"

79200

},

79201

{

79202

"file": "matrix/js/MatrixUtil.js",

79203

"line": 383,

79204

"description": "Returns an array of transform arrays representing transform functions and arguments.",

79205

"itemtype": "method",

79206

"name": "getTransformFunctionArray",

79207

"return": {

79208

"description": "Array"

79209

},

79210

"class": "Plugin.Flick",

79211

"module": "matrix"

79212

},

79213

{

79214

"file": "matrix/js/MatrixUtil.js",

79215

"line": 415,

79216

"description": "Compares to arrays or transform functions to ensure both contain the same functions in the same \norder.",

79217

"itemtype": "method",

79218

"name": "compareTransformSequence",

79219

"params": [

79220

{

79221

"name": "list1",

79222

"description": "Array to compare",

79223

"type": "Array"

79224

},

79225

{

79226

"name": "list2",

79227

"description": "Array to compare",

79228

"type": "Array"

79229

}

79230

],

79231

"return": {

79232

"description": "Boolean"

79233

},

79234

"class": "Plugin.Flick",

79235

"module": "matrix"

79236

},

79237

{

79238

"file": "matrix/js/MatrixUtil.js",

79239

"line": 444,

79240

"description": "Mapping of possible transform method names.",

79241

"itemtype": "property",

79242

"name": "transformMethods",

79243

"type": "Object",

79244

"class": "Plugin.Flick",

79245

"module": "matrix"

79246

},

79247

{

79248

"file": "node-flick/js/NodeFlick.js",

79249

"line": 44,

79250

"description": "Drag coefficent for inertial scrolling. The closer to 1 this\nvalue is, the less friction during scrolling.",

79251

"itemtype": "attribute",

79252

"name": "deceleration",

79253

"default": "0.98",

79254

"class": "Plugin.Flick",

79255

"module": "node-flick",

79256

"namespace": "Plugin"

79257

},

79258

{

79259

"file": "node-flick/js/NodeFlick.js",

79260

"line": 55,

79261

"description": "Drag coefficient for intertial scrolling at the upper\nand lower boundaries of the scrollview. Set to 0 to \ndisable \"rubber-banding\".",

79262

"itemtype": "attribute",

79263

"name": "bounce",

79264

"type": "Number",

79265

"default": "0.7",

79266

"class": "Plugin.Flick",

79267

"module": "node-flick",

79268

"namespace": "Plugin"

79269

},

79270

{

79271

"file": "node-flick/js/NodeFlick.js",

79272

"line": 68,

79273

"description": "The bounce distance in pixels",

79274

"itemtype": "attribute",

79275

"name": "bounceDistance",

79276

"type": "Number",

79277

"default": "150",

79278

"class": "Plugin.Flick",

79279

"module": "node-flick",

79280

"namespace": "Plugin"

79281

},

79282

{

79283

"file": "node-flick/js/NodeFlick.js",

79284

"line": 79,

79285

"description": "The minimum flick gesture velocity (px/ms) at which to trigger the flick response",

79286

"itemtype": "attribute",

79287

"name": "minVelocity",

79288

"type": "Number",

79289

"default": "0",

79290

"class": "Plugin.Flick",

79291

"module": "node-flick",

79292

"namespace": "Plugin"

79293

},

79294

{

79295

"file": "node-flick/js/NodeFlick.js",

79296

"line": 90,

79297

"description": "The minimum flick gesture distance (px) for which to trigger the flick response",

79298

"itemtype": "attribute",

79299

"name": "minVelocity",

79300

"type": "Number",

79301

"default": "10",

79302

"class": "Plugin.Flick",

79303

"module": "node-flick",

79304

"namespace": "Plugin"

79305

},

79306

{

79307

"file": "node-flick/js/NodeFlick.js",

79308

"line": 101,

79309

"description": "The constraining box relative to which the flick animation and bounds should be calculated.",

79310

"itemtype": "attribute",

79311

"name": "boundingBox",

79312

"type": "Node",

79313

"default": "parentNode",

79314

"class": "Plugin.Flick",

79315

"module": "node-flick",

79316

"namespace": "Plugin"

79317

},

79318

{

79319

"file": "node-flick/js/NodeFlick.js",

79320

"line": 114,

79321

"description": "The constraining box relative to which the flick animation and bounds should be calculated.",

79322

"itemtype": "attribute",

79323

"name": "boundingBox",

79324

"type": "Node",

79325

"default": "parentNode",

79326

"class": "Plugin.Flick",

79327

"module": "node-flick",

79328

"namespace": "Plugin"

79329

},

79330

{

79331

"file": "node-flick/js/NodeFlick.js",

79332

"line": 125,

79333

"description": "The custom duration to apply to the flick animation. By default,\nthe animation duration is controlled by the deceleration factor.",

79334

"itemtype": "attribute",

79335

"name": "duration",

79336

"type": "Number",

79337

"default": "null",

79338

"class": "Plugin.Flick",

79339

"module": "node-flick",

79340

"namespace": "Plugin"

79341

},

79342

{

79343

"file": "node-flick/js/NodeFlick.js",

79344

"line": 137,

79345

"description": "The custom transition easing to use for the flick animation. If not\nprovided defaults to internally to Flick.EASING, or Flick.SNAP_EASING based\non whether or not we're animating the flick or bounce step.",

79346

"itemtype": "attribute",

79347

"name": "easing",

79348

"type": "String",

79349

"default": "null",

79350

"class": "Plugin.Flick",

79351

"module": "node-flick",

79352

"namespace": "Plugin"

79353

},

79354

{

79355

"file": "node-flick/js/NodeFlick.js",

79356

"line": 151,

79357

"description": "The NAME of the Flick class. Used to prefix events generated\nby the plugin.",

79358

"itemtype": "property",

79359

"name": "NAME",

79360

"static": 1,

79361

"type": "String",

79362

"default": "\"pluginFlick\"",

79363

"class": "Plugin.Flick",

79364

"module": "node-flick",

79365

"namespace": "Plugin"

79366

},

79367

{

79368

"file": "node-flick/js/NodeFlick.js",

79369

"line": 162,

79370

"description": "The namespace for the plugin. This will be the property on the node, which will \nreference the plugin instance, when it's plugged in.",

79371

"itemtype": "property",

79372

"name": "NS",

79373

"static": 1,

79374

"type": "String",

79375

"default": "\"flick\"",

79376

"class": "Plugin.Flick",

79377

"module": "node-flick",

79378

"namespace": "Plugin"

79379

},

79380

{

79381

"file": "node-flick/js/NodeFlick.js",

79382

"line": 175,

79383

"description": "The initializer lifecycle implementation.",

79384

"itemtype": "method",

79385

"name": "initializer",

79386

"params": [

79387

{

79388

"name": "config",

79389

"description": "The user configuration for the plugin",

79390

"type": "Object"

79391

}

79392

],

79393

"class": "Plugin.Flick",

79394

"module": "node-flick",

79395

"namespace": "Plugin"

79396

},

79397

{

79398

"file": "node-flick/js/NodeFlick.js",

79399

"line": 193,

79400

"description": "Sets the min/max boundaries for the flick animation,\nbased on the boundingBox dimensions.",

79401

"itemtype": "method",

79402

"name": "setBounds",

79403

"class": "Plugin.Flick",

79404

"module": "node-flick",

79405

"namespace": "Plugin"

79406

},

79407

{

79408

"file": "node-flick/js/NodeFlick.js",

79409

"line": 227,

79410

"description": "Adds the CSS classes, necessary to set up overflow/position properties on the\nnode and boundingBox.",

79411

"itemtype": "method",

79412

"name": "_renderClasses",

79413

"access": "protected",

79414

"tagname": "",

79415

"class": "Plugin.Flick",

79416

"module": "node-flick",

79417

"namespace": "Plugin"

79418

},

79419

{

79420

"file": "node-flick/js/NodeFlick.js",

79421

"line": 239,

79422

"description": "The flick event listener. Kicks off the flick animation.",

79423

"itemtype": "method",

79424

"name": "_onFlick",

79425

"params": [

79426

{

79427

"name": "e",

79428

"description": "The flick event facade, containing e.flick.distance, e.flick.velocity etc.",

79429

"type": "EventFacade"

79430

}

79431

],

79432

"access": "protected",

79433

"tagname": "",

79434

"class": "Plugin.Flick",

79435

"module": "node-flick",

79436

"namespace": "Plugin"

79437

},

79438

{

79439

"file": "node-flick/js/NodeFlick.js",

79440

"line": 252,

79441

"description": "Executes a single frame in the flick animation",

79442

"itemtype": "method",

79443

"name": "_flickFrame",

79444

"access": "protected",

79445

"tagname": "",

79446

"class": "Plugin.Flick",

79447

"module": "node-flick",

79448

"namespace": "Plugin"

79449

},

79450

{

79451

"file": "node-flick/js/NodeFlick.js",

79452

"line": 335,

79453

"description": "Internal utility method to set the X offset position",

79454

"itemtype": "method",

79455

"name": "_setX",

79456

"params": [

79457

{

79458

"name": "val",

79459

"description": "",

79460

"type": "Number"

79461

}

79462

],

79463

"access": "private",

79464

"tagname": "",

79465

"class": "Plugin.Flick",

79466

"module": "node-flick",

79467

"namespace": "Plugin"

79468

},

79469

{

79470

"file": "node-flick/js/NodeFlick.js",

79471

"line": 346,

79472

"description": "Internal utility method to set the Y offset position",

79473

"itemtype": "method",

79474

"name": "_setY",

79475

"params": [

79476

{

79477

"name": "val",

79478

"description": "",

79479

"type": "Number"

79480

}

79481

],

79482

"access": "private",

79483

"tagname": "",

79484

"class": "Plugin.Flick",

79485

"module": "node-flick",

79486

"namespace": "Plugin"

79487

},

79488

{

79489

"file": "node-flick/js/NodeFlick.js",

79490

"line": 357,

79491

"description": "Internal utility method to move the node to a given XY position,\nusing transitions, if specified.",

79492

"itemtype": "method",

79493

"name": "_move",

79494

"params": [

79495

{

79496

"name": "x",

79497

"description": "The X offset position",

79498

"type": "Number"

79499

},

79500

{

79501

"name": "y",

79502

"description": "The Y offset position",

79503

"type": "Number"

79504

},

79505

{

79506

"name": "duration",

79507

"description": "The duration to use for the transition animation",

79508

"type": "Number"

79509

},

79510

{

79511

"name": "easing",

79512

"description": "The easing to use for the transition animation.",

79513

"type": "String"

79514

}

79515

],

79516

"access": "private",

79517

"tagname": "",

79518

"class": "Plugin.Flick",

79519

"module": "node-flick",

79520

"namespace": "Plugin"

79521

},

79522

{

79523

"file": "node-flick/js/NodeFlick.js",

79524

"line": 392,

79525

"description": "Internal utility method to perform the transition step",

79526

"itemtype": "method",

79527

"name": "_anim",

79528

"params": [

79529

{

79530

"name": "x",

79531

"description": "The X offset position",

79532

"type": "Number"

79533

},

79534

{

79535

"name": "y",

79536

"description": "The Y offset position",

79537

"type": "Number"

79538

},

79539

{

79540

"name": "duration",

79541

"description": "The duration to use for the transition animation",

79542

"type": "Number"

79543

},

79544

{

79545

"name": "easing",

79546

"description": "The easing to use for the transition animation.",

79547

"type": "String"

79548

}

79549

],

79550

"access": "private",

79551

"tagname": "",

79552

"class": "Plugin.Flick",

79553

"module": "node-flick",

79554

"namespace": "Plugin"

79555

},

79556

{

79557

"file": "node-flick/js/NodeFlick.js",

79558

"line": 424,

79559

"description": "Internal utility method to constrain the offset value\nbased on the bounce criteria.",

79560

"itemtype": "method",

79561

"name": "_bounce",

79562

"params": [

79563

{

79564

"name": "x",

79565

"description": "The offset value to constrain.",

79566

"type": "Number"

79567

},

79568

{

79569

"name": "max",

79570

"description": "The max offset value.",

79571

"type": "Number"

79572

}

79573

],

79574

"access": "private",

79575

"tagname": "",

79576

"class": "Plugin.Flick",

79577

"module": "node-flick",

79578

"namespace": "Plugin"

79579

},

79580

{

79581

"file": "node-flick/js/NodeFlick.js",

79582

"line": 451,

79583

"description": "Stop the animation timer",

79584

"itemtype": "method",

79585

"name": "_killTimer",

79586

"access": "private",

79587

"tagname": "",

79588

"class": "Plugin.Flick",

79589

"module": "node-flick",

79590

"namespace": "Plugin"

79591

},

79592

{

79593

"file": "node-flick/js/NodeFlick.js",

79594

"line": 465,

79595

"description": "The threshold used to determine when the decelerated velocity of the node\nis practically 0.",

79596

"itemtype": "property",

79597

"name": "VELOCITY_THRESHOLD",

79598

"static": 1,

79599

"type": "Number",

79600

"default": "0.015",

79601

"class": "Plugin.Flick",

79602

"module": "node-flick",

79603

"namespace": "Plugin"

79604

},

79605

{

79606

"file": "node-flick/js/NodeFlick.js",

79607

"line": 476,

79608

"description": "The duration to use for the bounce snap-back transition",

79609

"itemtype": "property",

79610

"name": "SNAP_DURATION",

79611

"static": 1,

79612

"type": "Number",

79613

"default": "400",

79614

"class": "Plugin.Flick",

79615

"module": "node-flick",

79616

"namespace": "Plugin"

79617

},

79618

{

79619

"file": "node-flick/js/NodeFlick.js",

79620

"line": 486,

79621

"description": "The default easing to use for the main flick movement transition",

79622

"itemtype": "property",

79623

"name": "EASING",

79624

"static": 1,

79625

"type": "String",

79626

"default": "'cubic-bezier(0, 0.1, 0, 1.0)'",

79627

"class": "Plugin.Flick",

79628

"module": "node-flick",

79629

"namespace": "Plugin"

79630

},

79631

{

79632

"file": "node-flick/js/NodeFlick.js",

79633

"line": 496,

79634

"description": "The default easing to use for the bounce snap-back transition",

79635

"itemtype": "property",

79636

"name": "SNAP_EASING",

79637

"static": 1,

79638

"type": "String",

79639

"default": "'ease-out'",

79640

"class": "Plugin.Flick",

79641

"module": "node-flick",

79642

"namespace": "Plugin"

79643

},

79644

{

79645

"file": "node-flick/js/NodeFlick.js",

79646

"line": 506,

79647

"description": "The default CSS class names used by the plugin",

79648

"itemtype": "property",

79649

"name": "CLASS_NAMES",

79650

"static": 1,

79651

"type": "Object",

79652

"class": "Plugin.Flick",

79653

"module": "node-flick",

79654

"namespace": "Plugin"

79655

},

79656

{

79657

"file": "node-focusmanager/js/node-focusmanager.js",

79658

"line": 83,

79659

"description": "Boolean indicating that one of the descendants is focused.",

79660

"itemtype": "attribute",

79661

"name": "focused",

79662

"readonly": "",

79663

"default": "false",

79664

"type": "boolean",

79665

"class": "plugin.NodeFocusManager",

79666

"module": "node-focusmanager",

79667

"namespace": "plugin"

79668

},

79669

{

79670

"file": "node-focusmanager/js/node-focusmanager.js",

79671

"line": 99,

79672

"description": "String representing the CSS selector used to define the descendant Nodes\nwhose focus should be managed.",

79673

"itemtype": "attribute",

79674

"name": "descendants",

79675

"type": "Y.NodeList",

79676

"class": "plugin.NodeFocusManager",

79677

"module": "node-focusmanager",

79678

"namespace": "plugin"

79679

},

79680

{

79681

"file": "node-focusmanager/js/node-focusmanager.js",

79682

"line": 117,

79683

"description": "Node, or index of the Node, representing the descendant that is either\nfocused or is focusable (<code>tabIndex</code> attribute is set to 0).\nThe value cannot represent a disabled descendant Node. Use a value of -1\nto remove all descendant Nodes from the default tab flow.\nIf no value is specified, the active descendant will be inferred using\nthe following criteria:\n<ol>\n<li>Examining the <code>tabIndex</code> attribute of each descendant and\nusing the first descendant whose <code>tabIndex</code> attribute is set\nto 0</li>\n<li>If no default can be inferred then the value is set to either 0 or\nthe index of the first enabled descendant.</li>\n</ol>",

79684

"itemtype": "attribute",

79685

"name": "activeDescendant",

79686

"type": "Number",

79687

"class": "plugin.NodeFocusManager",

79688

"module": "node-focusmanager",

79689

"namespace": "plugin"

79690

},

79691

{

79692

"file": "node-focusmanager/js/node-focusmanager.js",

79693

"line": 194,

79694

"description": "Object literal representing the keys to be used to navigate between the\nnext/previous descendant. The format for the attribute's value is\n<code>{ next: \"down:40\", previous: \"down:38\" }</code>. The value for the\n\"next\" and \"previous\" properties are used to attach\n<a href=\"event/#keylistener\"><code>key</code></a> event listeners. See\nthe <a href=\"event/#keylistener\">Using the key Event</a> section of\nthe Event documentation for more information on \"key\" event listeners.",

79695

"itemtype": "attribute",

79696

"name": "keys",

79697

"type": "Object",

79698

"class": "plugin.NodeFocusManager",

79699

"module": "node-focusmanager",

79700

"namespace": "plugin"

79701

},

79702

{

79703

"file": "node-focusmanager/js/node-focusmanager.js",

79704

"line": 219,

79705

"description": "String representing the name of class applied to the focused active\ndescendant Node. Can also be an object literal used to define both the\nclass name, and the Node to which the class should be applied. If using\nan object literal, the format is:\n<code>{ className: \"focus\", fn: myFunction }</code>. The function\nreferenced by the <code>fn</code> property in the object literal will be\npassed a reference to the currently focused active descendant Node.",

79706

"itemtype": "attribute",

79707

"name": "focusClass",

79708

"type": "String|Object",

79709

"class": "plugin.NodeFocusManager",

79710

"module": "node-focusmanager",

79711

"namespace": "plugin"

79712

},

79713

{

79714

"file": "node-focusmanager/js/node-focusmanager.js",

79715

"line": 234,

79716

"description": "Boolean indicating if focus should be set to the first/last descendant\nwhen the end or beginning of the descendants has been reached.",

79717

"itemtype": "attribute",

79718

"name": "circular",

79719

"type": "Boolean",

79720

"default": "true",

79721

"class": "plugin.NodeFocusManager",

79722

"module": "node-focusmanager",

79723

"namespace": "plugin"

79724

},

79725

{

79726

"file": "node-focusmanager/js/node-focusmanager.js",

79727

"line": 277,

79728

"itemtype": "method",

79729

"name": "_initDescendants",

79730

"description": "Sets the <code>tabIndex</code> attribute of all of the\ndescendants to -1, except the active descendant, whose\n<code>tabIndex</code> attribute is set to 0.",

79731

"access": "protected",

79732

"tagname": "",

79733

"class": "plugin.NodeFocusManager",

79734

"module": "node-focusmanager",

79735

"namespace": "plugin"

79736

},

79737

{

79738

"file": "node-focusmanager/js/node-focusmanager.js",

79739

"line": 388,

79740

"itemtype": "method",

79741

"name": "_isDescendant",

79742

"description": "Determines if the specified Node instance is a descendant\nmanaged by the Focus Manager.",

79743

"params": [

79744

{

79745

"name": "node",

79746

"description": "Node instance to be checked.",

79747

"type": "Node"

79748

}

79749

],

79750

"return": {

79751

"description": "Boolean indicating if the specified Node instance is a\ndescendant managed by the Focus Manager.",

79752

"type": "Boolean"

79753

},

79754

"access": "protected",

79755

"tagname": "",

79756

"class": "plugin.NodeFocusManager",

79757

"module": "node-focusmanager",

79758

"namespace": "plugin"

79759

},

79760

{

79761

"file": "node-focusmanager/js/node-focusmanager.js",

79762

"line": 404,

79763

"itemtype": "method",

79764

"name": "_removeFocusClass",

79765

"description": "Removes the class name representing focus (as specified by\nthe \"focusClass\" attribute) from the Node instance to which it is\ncurrently applied.",

79766

"access": "protected",

79767

"tagname": "",

79768

"class": "plugin.NodeFocusManager",

79769

"module": "node-focusmanager",

79770

"namespace": "plugin"

79771

},

79772

{

79773

"file": "node-focusmanager/js/node-focusmanager.js",

79774

"line": 429,

79775

"itemtype": "method",

79776

"name": "_detachKeyHandler",

79777

"description": "Detaches the \"key\" event handlers used to support the \"keys\"\nattribute.",

79778

"access": "protected",

79779

"tagname": "",

79780

"class": "plugin.NodeFocusManager",

79781

"module": "node-focusmanager",

79782

"namespace": "plugin"

79783

},

79784

{

79785

"file": "node-focusmanager/js/node-focusmanager.js",

79786

"line": 451,

79787

"itemtype": "method",

79788

"name": "_preventScroll",

79789

"description": "Prevents the viewport from scolling when the user presses\nthe up, down, left, or right key.",

79790

"access": "protected",

79791

"tagname": "",

79792

"class": "plugin.NodeFocusManager",

79793

"module": "node-focusmanager",

79794

"namespace": "plugin"

79795

},

79796

{

79797

"file": "node-focusmanager/js/node-focusmanager.js",

79798

"line": 466,

79799

"itemtype": "method",

79800

"name": "_fireClick",

79801

"description": "Fires the click event if the enter key is pressed while\nfocused on an HTML element that is not natively clickable.",

79802

"access": "protected",

79803

"tagname": "",

79804

"class": "plugin.NodeFocusManager",

79805

"module": "node-focusmanager",

79806

"namespace": "plugin"

79807

},

79808

{

79809

"file": "node-focusmanager/js/node-focusmanager.js",

79810

"line": 489,

79811

"itemtype": "method",

79812

"name": "_attachKeyHandler",

79813

"description": "Attaches the \"key\" event handlers used to support the \"keys\"\nattribute.",

79814

"access": "protected",

79815

"tagname": "",

79816

"class": "plugin.NodeFocusManager",

79817

"module": "node-focusmanager",

79818

"namespace": "plugin"

79819

},

79820

{

79821

"file": "node-focusmanager/js/node-focusmanager.js",

79822

"line": 538,

79823

"itemtype": "method",

79824

"name": "_detachEventHandlers",

79825

"description": "Detaches all event handlers used by the Focus Manager.",

79826

"access": "protected",

79827

"tagname": "",

79828

"class": "plugin.NodeFocusManager",

79829

"module": "node-focusmanager",

79830

"namespace": "plugin"

79831

},

79832

{

79833

"file": "node-focusmanager/js/node-focusmanager.js",

79834

"line": 562,

79835

"itemtype": "method",

79836

"name": "_detachEventHandlers",

79837

"description": "Attaches all event handlers used by the Focus Manager.",

79838

"access": "protected",

79839

"tagname": "",

79840

"class": "plugin.NodeFocusManager",

79841

"module": "node-focusmanager",

79842

"namespace": "plugin"

79843

},

79844

{

79845

"file": "node-focusmanager/js/node-focusmanager.js",

79846

"line": 635,

79847

"itemtype": "method",

79848

"name": "_onDocMouseDown",

79849

"description": "\"mousedown\" event handler for the owner document of the\nFocus Manager's Node.",

79850

"access": "protected",

79851

"tagname": "",

79852

"params": [

79853

{

79854

"name": "event",

79855

"description": "Object representing the DOM event.",

79856

"type": "Object"

79857

}

79858

],

79859

"class": "plugin.NodeFocusManager",

79860

"module": "node-focusmanager",

79861

"namespace": "plugin"

79862

},

79863

{

79864

"file": "node-focusmanager/js/node-focusmanager.js",

79865

"line": 721,

79866

"itemtype": "method",

79867

"name": "_onDocFocus",

79868

"description": "\"focus\" event handler for the owner document of the\nFocus Manager's Node.",

79869

"access": "protected",

79870

"tagname": "",

79871

"params": [

79872

{

79873

"name": "event",

79874

"description": "Object representing the DOM event.",

79875

"type": "Object"

79876

}

79877

],

79878

"class": "plugin.NodeFocusManager",

79879

"module": "node-focusmanager",

79880

"namespace": "plugin"

79881

},

79882

{

79883

"file": "node-focusmanager/js/node-focusmanager.js",

79884

"line": 802,

79885

"itemtype": "method",

79886

"name": "_focusNext",

79887

"description": "Keydown event handler that moves focus to the next\nenabled descendant.",

79888

"access": "protected",

79889

"tagname": "",

79890

"params": [

79891

{

79892

"name": "event",

79893

"description": "Object representing the DOM event.",

79894

"type": "Object"

79895

},

79896

{

79897

"name": "activeDescendant",

79898

"description": "Number representing the index of the\nnext descendant to be focused",

79899

"type": "Number"

79900

}

79901

],

79902

"class": "plugin.NodeFocusManager",

79903

"module": "node-focusmanager",

79904

"namespace": "plugin"

79905

},

79906

{

79907

"file": "node-focusmanager/js/node-focusmanager.js",

79908

"line": 849,

79909

"itemtype": "method",

79910

"name": "_focusPrevious",

79911

"description": "Keydown event handler that moves focus to the previous\nenabled descendant.",

79912

"access": "protected",

79913

"tagname": "",

79914

"params": [

79915

{

79916

"name": "event",

79917

"description": "Object representing the DOM event.",

79918

"type": "Object"

79919

},

79920

{

79921

"name": "activeDescendant",

79922

"description": "Number representing the index of the\nnext descendant to be focused.",

79923

"type": "Number"

79924

}

79925

],

79926

"class": "plugin.NodeFocusManager",

79927

"module": "node-focusmanager",

79928

"namespace": "plugin"

79929

},

79930

{

79931

"file": "node-focusmanager/js/node-focusmanager.js",

79932

"line": 891,

79933

"itemtype": "method",

79934

"name": "_afterActiveDescendantChange",

79935

"description": "afterChange event handler for the\n\"activeDescendant\" attribute.",

79936

"access": "protected",

79937

"tagname": "",

79938

"params": [

79939

{

79940

"name": "event",

79941

"description": "Object representing the change event.",

79942

"type": "Object"

79943

}

79944

],

79945

"class": "plugin.NodeFocusManager",

79946

"module": "node-focusmanager",

79947

"namespace": "plugin"

79948

},

79949

{

79950

"file": "node-focusmanager/js/node-focusmanager.js",

79951

"line": 932,

79952

"itemtype": "method",

79953

"name": "focus",

79954

"description": "Focuses the active descendant and sets the\n<code>focused</code> attribute to true.",

79955

"params": [

79956

{

79957

"name": "index",

79958

"description": "Optional. Number representing the index of the\ndescendant to be set as the active descendant.",

79959

"type": "Number"

79960

},

79961

{

79962

"name": "index",

79963

"description": "Optional. Node instance representing the\ndescendant to be set as the active descendant.",

79964

"type": "Node"

79965

}

79966

],

79967

"class": "plugin.NodeFocusManager",

79968

"module": "node-focusmanager",

79969

"namespace": "plugin"

79970

},

79971

{

79972

"file": "node-focusmanager/js/node-focusmanager.js",

79973

"line": 971,

79974

"itemtype": "method",

79975

"name": "blur",

79976

"description": "Blurs the current active descendant and sets the\n<code>focused</code> attribute to false.",

79977

"class": "plugin.NodeFocusManager",

79978

"module": "node-focusmanager",

79979

"namespace": "plugin"

79980

},

79981

{

79982

"file": "node-focusmanager/js/node-focusmanager.js",

79983

"line": 1004,

79984

"itemtype": "method",

79985

"name": "start",

79986

"description": "Enables the Focus Manager.",

79987

"class": "plugin.NodeFocusManager",

79988

"module": "node-focusmanager",

79989

"namespace": "plugin"

79990

},

79991

{

79992

"file": "node-focusmanager/js/node-focusmanager.js",

79993

"line": 1022,

79994

"itemtype": "method",

79995

"name": "stop",

79996

"description": "Disables the Focus Manager by detaching all event handlers.",

79997

"class": "plugin.NodeFocusManager",

79998

"module": "node-focusmanager",

79999

"namespace": "plugin"

80000

},

80001

{

80002

"file": "node-focusmanager/js/node-focusmanager.js",

80003

"line": 1042,

80004

"itemtype": "method",

80005

"name": "refresh",

80006

"description": "Refreshes the Focus Manager's descendants by re-executing the\nCSS selector query specified by the <code>descendants</code> attribute.",

80007

"class": "plugin.NodeFocusManager",

80008

"module": "node-focusmanager",

80009

"namespace": "plugin"

80010

},

80011

{

80012

"file": "node-menunav/js/node-menunav.js",

80013

"line": 361,

80014

"itemtype": "property",

80015

"name": "SHIM_TEMPLATE_TITLE",

80016

"description": "String representing the value for the <code>title</code> \nattribute for the shim used to prevent <code><select></code> elements \nfrom poking through menus in IE 6.",

80017

"default": "\"Menu Stacking Shim\"",

80018

"type": "String",

80019

"class": "plugin.NodeMenuNav",

80020

"module": "node-menunav",

80021

"namespace": "plugin"

80022

},

80023

{

80024

"file": "node-menunav/js/node-menunav.js",

80025

"line": 372,

80026

"itemtype": "property",

80027

"name": "SHIM_TEMPLATE",

80028

"description": "String representing the HTML used to create the \n<code><iframe></code> shim used to prevent \n<code><select></code> elements from poking through menus in IE 6.",

80029

"default": ""<iframe frameborder="0" tabindex="-1" \nclass="yui-shim" title="Menu Stacking Shim" \nsrc="javascript:false;"></iframe>"",

80030

"type": "String",

80031

"class": "plugin.NodeMenuNav",

80032

"module": "node-menunav",

80033

"namespace": "plugin"

80034

},

80035

{

80036

"file": "node-menunav/js/node-menunav.js",

80037

"line": 406,

80038

"description": "Boolean indicating if use of the WAI-ARIA Roles and States should be \nenabled for the menu.",

80039

"itemtype": "attribute",

80040

"name": "useARIA",

80041

"readonly": "",

80042

"writeonce": "",

80043

"default": "true",

80044

"type": "boolean",

80045

"class": "plugin.NodeMenuNav",

80046

"module": "node-menunav",

80047

"namespace": "plugin"

80048

},

80049

{

80050

"file": "node-menunav/js/node-menunav.js",

80051

"line": 483,

80052

"description": "Boolean indicating if submenus are automatically made visible when the \nuser mouses over the menu's items.",

80053

"itemtype": "attribute",

80054

"name": "autoSubmenuDisplay",

80055

"readonly": "",

80056

"writeonce": "",

80057

"default": "true",

80058

"type": "boolean",

80059

"class": "plugin.NodeMenuNav",

80060

"module": "node-menunav",

80061

"namespace": "plugin"

80062

},

80063

{

80064

"file": "node-menunav/js/node-menunav.js",

80065

"line": 501,

80066

"description": "Number indicating the time (in milliseconds) that should expire before a \nsubmenu is made visible when the user mouses over the menu's label.",

80067

"itemtype": "attribute",

80068

"name": "submenuShowDelay",

80069

"readonly": "",

80070

"writeonce": "",

80071

"default": "250",

80072

"type": "Number",

80073

"class": "plugin.NodeMenuNav",

80074

"module": "node-menunav",

80075

"namespace": "plugin"

80076

},

80077

{

80078

"file": "node-menunav/js/node-menunav.js",

80079

"line": 519,

80080

"description": "Number indicating the time (in milliseconds) that should expire before a \nsubmenu is hidden when the user mouses out of a menu label heading in the \ndirection of a submenu.",

80081

"itemtype": "attribute",

80082

"name": "submenuHideDelay",

80083

"readonly": "",

80084

"writeonce": "",

80085

"default": "250",

80086

"type": "Number",

80087

"class": "plugin.NodeMenuNav",

80088

"module": "node-menunav",

80089

"namespace": "plugin"

80090

},

80091

{

80092

"file": "node-menunav/js/node-menunav.js",

80093

"line": 538,

80094

"description": "Number indicating the time (in milliseconds) that should expire before a \nsubmenu is hidden when the user mouses out of it.",

80095

"itemtype": "attribute",

80096

"name": "mouseOutHideDelay",

80097

"readonly": "",

80098

"writeonce": "",

80099

"default": "750",

80100

"type": "Number",

80101

"class": "plugin.NodeMenuNav",

80102

"module": "node-menunav",

80103

"namespace": "plugin"

80104

},

80105

{

80106

"file": "node-menunav/js/node-menunav.js",

80107

"line": 562,

80108

"itemtype": "property",

80109

"name": "_rootMenu",

80110

"description": "Node instance representing the root menu in the menu.",

80111

"default": "null",

80112

"access": "protected",

80113

"tagname": "",

80114

"type": "Node",

80115

"class": "plugin.NodeMenuNav",

80116

"module": "node-menunav",

80117

"namespace": "plugin"

80118

},

80119

{

80120

"file": "node-menunav/js/node-menunav.js",

80121

"line": 572,

80122

"itemtype": "property",

80123

"name": "_activeItem",

80124

"description": "Node instance representing the menu's active descendent: \nthe menuitem or menu label the user is currently interacting with.",

80125

"default": "null",

80126

"access": "protected",

80127

"tagname": "",

80128

"type": "Node",

80129

"class": "plugin.NodeMenuNav",

80130

"module": "node-menunav",

80131

"namespace": "plugin"

80132

},

80133

{

80134

"file": "node-menunav/js/node-menunav.js",

80135

"line": 583,

80136

"itemtype": "property",

80137

"name": "_activeMenu",

80138

"description": "Node instance representing the menu that is the parent of \nthe menu's active descendent.",

80139

"default": "null",

80140

"access": "protected",

80141

"tagname": "",

80142

"type": "Node",

80143

"class": "plugin.NodeMenuNav",

80144

"module": "node-menunav",

80145

"namespace": "plugin"

80146

},

80147

{

80148

"file": "node-menunav/js/node-menunav.js",

80149

"line": 594,

80150

"itemtype": "property",

80151

"name": "_hasFocus",

80152

"description": "Boolean indicating if the menu has focus.",

80153

"default": "false",

80154

"access": "protected",

80155

"tagname": "",

80156

"type": "Boolean",

80157

"class": "plugin.NodeMenuNav",

80158

"module": "node-menunav",

80159

"namespace": "plugin"

80160

},

80161

{

80162

"file": "node-menunav/js/node-menunav.js",

80163

"line": 612,

80164

"itemtype": "property",

80165

"name": "_blockMouseEvent",

80166

"description": "Boolean indicating whether or not to handle the \n\"mouseover\" event.",

80167

"default": "false",

80168

"access": "protected",

80169

"tagname": "",

80170

"type": "Boolean",

80171

"class": "plugin.NodeMenuNav",

80172

"module": "node-menunav",

80173

"namespace": "plugin"

80174

},

80175

{

80176

"file": "node-menunav/js/node-menunav.js",

80177

"line": 623,

80178

"itemtype": "property",

80179

"name": "_currentMouseX",

80180

"description": "Number representing the current x coordinate of the mouse \ninside the menu.",

80181

"default": "0",

80182

"access": "protected",

80183

"tagname": "",

80184

"type": "Number",

80185

"class": "plugin.NodeMenuNav",

80186

"module": "node-menunav",

80187

"namespace": "plugin"

80188

},

80189

{

80190

"file": "node-menunav/js/node-menunav.js",

80191

"line": 634,

80192

"itemtype": "property",

80193

"name": "_movingToSubmenu",

80194

"description": "Boolean indicating if the mouse is moving from a menu \nlabel to its corresponding submenu.",

80195

"default": "false",

80196

"access": "protected",

80197

"tagname": "",

80198

"type": "Boolean",

80199

"class": "plugin.NodeMenuNav",

80200

"module": "node-menunav",

80201

"namespace": "plugin"

80202

},

80203

{

80204

"file": "node-menunav/js/node-menunav.js",

80205

"line": 645,

80206

"itemtype": "property",

80207

"name": "_showSubmenuTimer",

80208

"description": "Timer used to show a submenu.",

80209

"default": "null",

80210

"access": "protected",

80211

"tagname": "",

80212

"type": "Object",

80213

"class": "plugin.NodeMenuNav",

80214

"module": "node-menunav",

80215

"namespace": "plugin"

80216

},

80217

{

80218

"file": "node-menunav/js/node-menunav.js",

80219

"line": 655,

80220

"itemtype": "property",

80221

"name": "_hideSubmenuTimer",

80222

"description": "Timer used to hide a submenu.",

80223

"default": "null",

80224

"access": "protected",

80225

"tagname": "",

80226

"type": "Object",

80227

"class": "plugin.NodeMenuNav",

80228

"module": "node-menunav",

80229

"namespace": "plugin"

80230

},

80231

{

80232

"file": "node-menunav/js/node-menunav.js",

80233

"line": 665,

80234

"itemtype": "property",

80235

"name": "_hideAllSubmenusTimer",

80236

"description": "Timer used to hide a all submenus.",

80237

"default": "null",

80238

"access": "protected",

80239

"tagname": "",

80240

"type": "Object",

80241

"class": "plugin.NodeMenuNav",

80242

"module": "node-menunav",

80243

"namespace": "plugin"

80244

},

80245

{

80246

"file": "node-menunav/js/node-menunav.js",

80247

"line": 675,

80248

"itemtype": "property",

80249

"name": "_firstItem",

80250

"description": "Node instance representing the first item (menuitem or menu \nlabel) in the root menu of a menu.",

80251

"default": "null",

80252

"access": "protected",

80253

"tagname": "",

80254

"type": "Node",

80255

"class": "plugin.NodeMenuNav",

80256

"module": "node-menunav",

80257

"namespace": "plugin"

80258

},

80259

{

80260

"file": "node-menunav/js/node-menunav.js",

80261

"line": 755,

80262

"itemtype": "method",

80263

"name": "_isRoot",

80264

"description": "Returns a boolean indicating if the specified menu is the \nroot menu in the menu.",

80265

"access": "protected",

80266

"tagname": "",

80267

"params": [

80268

{

80269

"name": "menu",

80270

"description": "Node instance representing a menu.",

80271

"type": "Node"

80272

}

80273

],

80274

"return": {

80275

"description": "Boolean indicating if the specified menu is the root \nmenu in the menu.",

80276

"type": "Boolean"

80277

},

80278

"class": "plugin.NodeMenuNav",

80279

"module": "node-menunav",

80280

"namespace": "plugin"

80281

},

80282

{

80283

"file": "node-menunav/js/node-menunav.js",

80284

"line": 771,

80285

"itemtype": "method",

80286

"name": "_getTopmostSubmenu",

80287

"description": "Returns the topmost submenu of a submenu hierarchy.",

80288

"access": "protected",

80289

"tagname": "",

80290

"params": [

80291

{

80292

"name": "menu",

80293

"description": "Node instance representing a menu.",

80294

"type": "Node"

80295

}

80296

],

80297

"return": {

80298

"description": "Node instance representing a menu.",

80299

"type": "Node"

80300

},

80301

"class": "plugin.NodeMenuNav",

80302

"module": "node-menunav",

80303

"namespace": "plugin"

80304

},

80305

{

80306

"file": "node-menunav/js/node-menunav.js",

80307

"line": 800,

80308

"itemtype": "method",

80309

"name": "_clearActiveItem",

80310

"description": "Clears the menu's active descendent.",

80311

"access": "protected",

80312

"tagname": "",

80313

"class": "plugin.NodeMenuNav",

80314

"module": "node-menunav",

80315

"namespace": "plugin"

80316

},

80317

{

80318

"file": "node-menunav/js/node-menunav.js",

80319

"line": 819,

80320

"itemtype": "method",

80321

"name": "_setActiveItem",

80322

"description": "Sets the specified menuitem or menu label as the menu's \nactive descendent.",

80323

"access": "protected",

80324

"tagname": "",

80325

"params": [

80326

{

80327

"name": "item",

80328

"description": "Node instance representing a menuitem or menu label.",

80329

"type": "Node"

80330

}

80331

],

80332

"class": "plugin.NodeMenuNav",

80333

"module": "node-menunav",

80334

"namespace": "plugin"

80335

},

80336

{

80337

"file": "node-menunav/js/node-menunav.js",

80338

"line": 843,

80339

"itemtype": "method",

80340

"name": "_focusItem",

80341

"description": "Focuses the specified menuitem or menu label.",

80342

"access": "protected",

80343

"tagname": "",

80344

"params": [

80345

{

80346

"name": "item",

80347

"description": "Node instance representing a menuitem or menu label.",

80348

"type": "Node"

80349

}

80350

],

80351

"class": "plugin.NodeMenuNav",

80352

"module": "node-menunav",

80353

"namespace": "plugin"

80354

},

80355

{

80356

"file": "node-menunav/js/node-menunav.js",

80357

"line": 872,

80358

"itemtype": "method",

80359

"name": "_showMenu",

80360

"description": "Shows the specified menu.",

80361

"access": "protected",

80362

"tagname": "",

80363

"params": [

80364

{

80365

"name": "menu",

80366

"description": "Node instance representing a menu.",

80367

"type": "Node"

80368

}

80369

],

80370

"class": "plugin.NodeMenuNav",

80371

"module": "node-menunav",

80372

"namespace": "plugin"

80373

},

80374

{

80375

"file": "node-menunav/js/node-menunav.js",

80376

"line": 932,

80377

"itemtype": "method",

80378

"name": "_hideMenu",

80379

"description": "Hides the specified menu.",

80380

"access": "protected",

80381

"tagname": "",

80382

"params": [

80383

{

80384

"name": "menu",

80385

"description": "Node instance representing a menu.",

80386

"type": "Node"

80387

},

80388

{

80389

"name": "activateAndFocusLabel",

80390

"description": "Boolean indicating if the label \nfor the specified \nmenu should be focused and set as active.",

80391

"type": "Boolean"

80392

}

80393

],

80394

"class": "plugin.NodeMenuNav",

80395

"module": "node-menunav",

80396

"namespace": "plugin"

80397

},

80398

{

80399

"file": "node-menunav/js/node-menunav.js",

80400

"line": 976,

80401

"itemtype": "method",

80402

"name": "_hideAllSubmenus",

80403

"description": "Hides all submenus of the specified menu.",

80404

"access": "protected",

80405

"tagname": "",

80406

"params": [

80407

{

80408

"name": "menu",

80409

"description": "Node instance representing a menu.",

80410

"type": "Node"

80411

}

80412

],

80413

"class": "plugin.NodeMenuNav",

80414

"module": "node-menunav",

80415

"namespace": "plugin"

80416

},

80417

{

80418

"file": "node-menunav/js/node-menunav.js",

80419

"line": 995,

80420

"itemtype": "method",

80421

"name": "_cancelShowSubmenuTimer",

80422

"description": "Cancels the timer used to show a submenu.",

80423

"access": "protected",

80424

"tagname": "",

80425

"class": "plugin.NodeMenuNav",

80426

"module": "node-menunav",

80427

"namespace": "plugin"

80428

},

80429

{

80430

"file": "node-menunav/js/node-menunav.js",

80431

"line": 1013,

80432

"itemtype": "method",

80433

"name": "_cancelHideSubmenuTimer",

80434

"description": "Cancels the timer used to hide a submenu.",

80435

"access": "protected",

80436

"tagname": "",

80437

"class": "plugin.NodeMenuNav",

80438

"module": "node-menunav",

80439

"namespace": "plugin"

80440

},

80441

{

80442

"file": "node-menunav/js/node-menunav.js",

80443

"line": 1032,

80444

"itemtype": "method",

80445

"name": "_initFocusManager",

80446

"description": "Initializes and updates the Focus Manager so that is is \nalways managing descendants of the active menu.",

80447

"access": "protected",

80448

"tagname": "",

80449

"class": "plugin.NodeMenuNav",

80450

"module": "node-menunav",

80451

"namespace": "plugin"

80452

},

80453

{

80454

"file": "node-menunav/js/node-menunav.js",

80455

"line": 1104,

80456

"itemtype": "method",

80457

"name": "_onActiveDescendantChange",

80458

"description": "\"activeDescendantChange\" event handler for menu's \nFocus Manager.",

80459

"access": "protected",

80460

"tagname": "",

80461

"params": [

80462

{

80463

"name": "event",

80464

"description": "Object representing the Attribute change event.",

80465

"type": "Object"

80466

},

80467

{

80468

"name": "menuNav",

80469

"description": "Object representing the NodeMenuNav instance.",

80470

"type": "NodeMenuNav"

80471

}

80472

],

80473

"class": "plugin.NodeMenuNav",

80474

"module": "node-menunav",

80475

"namespace": "plugin"

80476

},

80477

{

80478

"file": "node-menunav/js/node-menunav.js",

80479

"line": 1124,

80480

"itemtype": "method",

80481

"name": "_afterActiveDescendantChange",

80482

"description": "\"activeDescendantChange\" event handler for menu's \nFocus Manager.",

80483

"access": "protected",

80484

"tagname": "",

80485

"params": [

80486

{

80487

"name": "event",

80488

"description": "Object representing the Attribute change event.",

80489

"type": "Object"

80490

},

80491

{

80492

"name": "menuNav",

80493

"description": "Object representing the NodeMenuNav instance.",

80494

"type": "NodeMenuNav"

80495

}

80496

],

80497

"class": "plugin.NodeMenuNav",

80498

"module": "node-menunav",

80499

"namespace": "plugin"

80500

},

80501

{

80502

"file": "node-menunav/js/node-menunav.js",

80503

"line": 1144,

80504

"itemtype": "method",

80505

"name": "_onDocFocus",

80506

"description": "\"focus\" event handler for the owner document of the MenuNav.",

80507

"access": "protected",

80508

"tagname": "",

80509

"params": [

80510

{

80511

"name": "event",

80512

"description": "Object representing the DOM event.",

80513

"type": "Object"

80514

}

80515

],

80516

"class": "plugin.NodeMenuNav",

80517

"module": "node-menunav",

80518

"namespace": "plugin"

80519

},

80520

{

80521

"file": "node-menunav/js/node-menunav.js",

80522

"line": 1215,

80523

"itemtype": "method",

80524

"name": "_onMenuMouseOver",

80525

"description": "\"mouseover\" event handler for a menu.",

80526

"access": "protected",

80527

"tagname": "",

80528

"params": [

80529

{

80530

"name": "menu",

80531

"description": "Node instance representing a menu.",

80532

"type": "Node"

80533

},

80534

{

80535

"name": "event",

80536

"description": "Object representing the DOM event.",

80537

"type": "Object"

80538

}

80539

],

80540

"class": "plugin.NodeMenuNav",

80541

"module": "node-menunav",

80542

"namespace": "plugin"

80543

},

80544

{

80545

"file": "node-menunav/js/node-menunav.js",

80546

"line": 1254,

80547

"itemtype": "method",

80548

"name": "_hideAndFocusLabel",

80549

"description": "Hides all of the submenus of the root menu and focuses the \nlabel of the topmost submenu",

80550

"access": "protected",

80551

"tagname": "",

80552

"class": "plugin.NodeMenuNav",

80553

"module": "node-menunav",

80554

"namespace": "plugin"

80555

},

80556

{

80557

"file": "node-menunav/js/node-menunav.js",

80558

"line": 1279,

80559

"itemtype": "method",

80560

"name": "_onMenuMouseOut",

80561

"description": "\"mouseout\" event handler for a menu.",

80562

"access": "protected",

80563

"tagname": "",

80564

"params": [

80565

{

80566

"name": "menu",

80567

"description": "Node instance representing a menu.",

80568

"type": "Node"

80569

},

80570

{

80571

"name": "event",

80572

"description": "Object representing the DOM event.",

80573

"type": "Object"

80574

}

80575

],

80576

"class": "plugin.NodeMenuNav",

80577

"module": "node-menunav",

80578

"namespace": "plugin"

80579

},

80580

{

80581

"file": "node-menunav/js/node-menunav.js",

80582

"line": 1334,

80583

"itemtype": "method",

80584

"name": "_onMenuLabelMouseOver",

80585

"description": "\"mouseover\" event handler for a menu label.",

80586

"access": "protected",

80587

"tagname": "",

80588

"params": [

80589

{

80590

"name": "menuLabel",

80591

"description": "Node instance representing a menu label.",

80592

"type": "Node"

80593

},

80594

{

80595

"name": "event",

80596

"description": "Object representing the DOM event.",

80597

"type": "Object"

80598

}

80599

],

80600

"class": "plugin.NodeMenuNav",

80601

"module": "node-menunav",

80602

"namespace": "plugin"

80603

},

80604

{

80605

"file": "node-menunav/js/node-menunav.js",

80606

"line": 1402,

80607

"itemtype": "method",

80608

"name": "_onMenuLabelMouseOut",

80609

"description": "\"mouseout\" event handler for a menu label.",

80610

"access": "protected",

80611

"tagname": "",

80612

"params": [

80613

{

80614

"name": "menuLabel",

80615

"description": "Node instance representing a menu label.",

80616

"type": "Node"

80617

},

80618

{

80619

"name": "event",

80620

"description": "Object representing the DOM event.",

80621

"type": "Object"

80622

}

80623

],

80624

"class": "plugin.NodeMenuNav",

80625

"module": "node-menunav",

80626

"namespace": "plugin"

80627

},

80628

{

80629

"file": "node-menunav/js/node-menunav.js",

80630

"line": 1461,

80631

"itemtype": "method",

80632

"name": "_onMenuItemMouseOver",

80633

"description": "\"mouseover\" event handler for a menuitem.",

80634

"access": "protected",

80635

"tagname": "",

80636

"params": [

80637

{

80638

"name": "menuItem",

80639

"description": "Node instance representing a menuitem.",

80640

"type": "Node"

80641

},

80642

{

80643

"name": "event",

80644

"description": "Object representing the DOM event.",

80645

"type": "Object"

80646

}

80647

],

80648

"class": "plugin.NodeMenuNav",

80649

"module": "node-menunav",

80650

"namespace": "plugin"

80651

},

80652

{

80653

"file": "node-menunav/js/node-menunav.js",

80654

"line": 1490,

80655

"itemtype": "method",

80656

"name": "_onMenuItemMouseOut",

80657

"description": "\"mouseout\" event handler for a menuitem.",

80658

"access": "protected",

80659

"tagname": "",

80660

"params": [

80661

{

80662

"name": "menuItem",

80663

"description": "Node instance representing a menuitem.",

80664

"type": "Node"

80665

},

80666

{

80667

"name": "event",

80668

"description": "Object representing the DOM event.",

80669

"type": "Object"

80670

}

80671

],

80672

"class": "plugin.NodeMenuNav",

80673

"module": "node-menunav",

80674

"namespace": "plugin"

80675

},

80676

{

80677

"file": "node-menunav/js/node-menunav.js",

80678

"line": 1504,

80679

"itemtype": "method",

80680

"name": "_onVerticalMenuKeyDown",

80681

"description": "\"keydown\" event handler for vertical menus.",

80682

"access": "protected",

80683

"tagname": "",

80684

"params": [

80685

{

80686

"name": "event",

80687

"description": "Object representing the DOM event.",

80688

"type": "Object"

80689

}

80690

],

80691

"class": "plugin.NodeMenuNav",

80692

"module": "node-menunav",

80693

"namespace": "plugin"

80694

},

80695

{

80696

"file": "node-menunav/js/node-menunav.js",

80697

"line": 1650,

80698

"itemtype": "method",

80699

"name": "_onHorizontalMenuKeyDown",

80700

"description": "\"keydown\" event handler for horizontal menus.",

80701

"access": "protected",

80702

"tagname": "",

80703

"params": [

80704

{

80705

"name": "event",

80706

"description": "Object representing the DOM event.",

80707

"type": "Object"

80708

}

80709

],

80710

"class": "plugin.NodeMenuNav",

80711

"module": "node-menunav",

80712

"namespace": "plugin"

80713

},

80714

{

80715

"file": "node-menunav/js/node-menunav.js",

80716

"line": 1704,

80717

"itemtype": "method",

80718

"name": "_onMouseMove",

80719

"description": "\"mousemove\" event handler for the menu.",

80720

"access": "protected",

80721

"tagname": "",

80722

"params": [

80723

{

80724

"name": "event",

80725

"description": "Object representing the DOM event.",

80726

"type": "Object"

80727

}

80728

],

80729

"class": "plugin.NodeMenuNav",

80730

"module": "node-menunav",

80731

"namespace": "plugin"

80732

},

80733

{

80734

"file": "node-menunav/js/node-menunav.js",

80735

"line": 1727,

80736

"itemtype": "method",

80737

"name": "_onMouseOver",

80738

"description": "\"mouseover\" event handler for the menu.",

80739

"access": "protected",

80740

"tagname": "",

80741

"params": [

80742

{

80743

"name": "event",

80744

"description": "Object representing the DOM event.",

80745

"type": "Object"

80746

}

80747

],

80748

"class": "plugin.NodeMenuNav",

80749

"module": "node-menunav",

80750

"namespace": "plugin"

80751

},

80752

{

80753

"file": "node-menunav/js/node-menunav.js",

80754

"line": 1795,

80755

"itemtype": "method",

80756

"name": "_onMouseOut",

80757

"description": "\"mouseout\" event handler for the menu.",

80758

"access": "protected",

80759

"tagname": "",

80760

"params": [

80761

{

80762

"name": "event",

80763

"description": "Object representing the DOM event.",

80764

"type": "Object"

80765

}

80766

],

80767

"class": "plugin.NodeMenuNav",

80768

"module": "node-menunav",

80769

"namespace": "plugin"

80770

},

80771

{

80772

"file": "node-menunav/js/node-menunav.js",

80773

"line": 1871,

80774

"itemtype": "method",

80775

"name": "_toggleSubmenuDisplay",

80776

"description": "\"mousedown,\" \"keydown,\" and \"click\" event handler for the \nmenu used to toggle the display of a submenu.",

80777

"access": "protected",

80778

"tagname": "",

80779

"params": [

80780

{

80781

"name": "event",

80782

"description": "Object representing the DOM event.",

80783

"type": "Object"

80784

}

80785

],

80786

"class": "plugin.NodeMenuNav",

80787

"module": "node-menunav",

80788

"namespace": "plugin"

80789

},

80790

{

80791

"file": "node-menunav/js/node-menunav.js",

80792

"line": 2039,

80793

"itemtype": "method",

80794

"name": "_onKeyPress",

80795

"description": "\"keypress\" event handler for the menu.",

80796

"access": "protected",

80797

"tagname": "",

80798

"params": [

80799

{

80800

"name": "event",

80801

"description": "Object representing the DOM event.",

80802

"type": "Object"

80803

}

80804

],

80805

"class": "plugin.NodeMenuNav",

80806

"module": "node-menunav",

80807

"namespace": "plugin"

80808

},

80809

{

80810

"file": "node-menunav/js/node-menunav.js",

80811

"line": 2065,

80812

"itemtype": "method",

80813

"name": "_onKeyDown",

80814

"description": "\"keydown\" event handler for the menu.",

80815

"access": "protected",

80816

"tagname": "",

80817

"params": [

80818

{

80819

"name": "event",

80820

"description": "Object representing the DOM event.",

80821

"type": "Object"

80822

}

80823

],

80824

"class": "plugin.NodeMenuNav",

80825

"module": "node-menunav",

80826

"namespace": "plugin"

80827

},

80828

{

80829

"file": "node-menunav/js/node-menunav.js",

80830

"line": 2143,

80831

"itemtype": "method",

80832

"name": "_onDocMouseDown",

80833

"description": "\"mousedown\" event handler for the owner document of \nthe menu.",

80834

"access": "protected",

80835

"tagname": "",

80836

"params": [

80837

{

80838

"name": "event",

80839

"description": "Object representing the DOM event.",

80840

"type": "Object"

80841

}

80842

],

80843

"class": "plugin.NodeMenuNav",

80844

"module": "node-menunav",

80845

"namespace": "plugin"

80846

},

80847

{

80848

"file": "node/js/align-plugin.js",

80849

"line": 25,

80850

"description": "Aligns node with a point on another node or region.\nPossible alignment points are:\n<dl>\n <dt>tl</dt>\n <dd>top left</dd>\n <dt>tr</dt>\n <dd>top right</dd>\n <dt>bl</dt>\n <dd>bottom left</dd>\n <dt>br</dt>\n <dd>bottom right</dd>\n <dt>tc</dt>\n <dd>top center</dd>\n <dt>bc</dt>\n <dd>bottom center</dd>\n <dt>rc</dt>\n <dd>right center</dd>\n <dt>lc</dt>\n <dd>left center</dd>\n <dt>cc</dt>\n <dd>center center</dd>\n</dl>",

80851

"itemtype": "method",

80852

"name": "to",

80853

"params": [

80854

{

80855

"name": "region",

80856

"description": "The node or\nregion to align with. Defaults to the viewport region.",

80857

"type": "String || Node || HTMLElement || Object"

80858

},

80859

{

80860

"name": "regionPoint",

80861

"description": "The point of the region to align with.",

80862

"type": "String"

80863

},

80864

{

80865

"name": "point",

80866

"description": "The point of the node aligned to the region.",

80867

"type": "String"

80868

},

80869

{

80870

"name": "resize",

80871

"description": "Whether or not the node should re-align when\nthe window is resized. Defaults to false.",

80872

"type": "Boolean"

80873

}

80874

],

80875

"class": "Plugin.Align",

80876

"module": "align-plugin"

80877

},

80878

{

80879

"file": "node/js/align-plugin.js",

80880

"line": 123,

80881

"description": "Aligns the center of a node to the center of another node or region.",

80882

"itemtype": "method",

80883

"name": "center",

80884

"params": [

80885

{

80886

"name": "region",

80887

"description": "optional The node or\nregion to align with. Defaults to the viewport region.\nthe window is resized. If centering to viewport, this defaults\nto true, otherwise default is false.",

80888

"type": "Node || HTMLElement || Object"

80889

}

80890

],

80891

"class": "Plugin.Align",

80892

"module": "align-plugin"

80893

},

80894

{

80895

"file": "node/js/align-plugin.js",

80896

"line": 136,

80897

"description": "Removes the resize handler, if any. This is called automatically\nwhen unplugged from the host node.",

80898

"itemtype": "method",

80899

"name": "destroy",

80900

"class": "Plugin.Align",

80901

"module": "align-plugin"

80902

},

80903

{

80904

"file": "node/js/node-attrs.js",

80905

"line": 9,

80906

"description": "Static collection of configuration attributes for special handling",

80907

"itemtype": "property",

80908

"name": "ATTRS",

80909

"static": 1,

80910

"type": "object",

80911

"class": "Node",

80912

"module": "node",

80913

"submodule": "node-base"

80914

},

80915

{

80916

"file": "node/js/node-attrs.js",

80917

"line": 16,

80918

"description": "Allows for getting and setting the text of an element.\nFormatting is preserved and special characters are treated literally.",

80919

"itemtype": "config",

80920

"name": "text",

80921

"type": "String",

80922

"class": "Node",

80923

"module": "node",

80924

"submodule": "node-base"

80925

},

80926

{

80927

"file": "node/js/node-attrs.js",

80928

"line": 33,

80929

"description": "Allows for getting and setting the text of an element.\nFormatting is preserved and special characters are treated literally.",

80930

"itemtype": "config",

80931

"name": "for",

80932

"type": "String",

80933

"class": "Node",

80934

"module": "node",

80935

"submodule": "node-base"

80936

},

80937

{

80938

"file": "node/js/node-attrs.js",

80939

"line": 56,

80940

"description": "Returns a NodeList instance of all HTMLElement children.",

80941

"readonly": "",

80942

"itemtype": "config",

80943

"name": "children",

80944

"type": "NodeList",

80945

"class": "Node",

80946

"module": "node",

80947

"submodule": "node-base"

80948

},

80949

{

80950

"file": "node/js/node-attrs.js",

80951

"line": 95,

80952

"description": "Allows setting attributes on DOM nodes, normalizing in some cases.\nThis passes through to the DOM node, allowing for custom attributes.",

80953

"itemtype": "method",

80954

"name": "setAttribute",

80955

"chainable": 1,

80956

"params": [

80957

{

80958

"name": "name",

80959

"description": "The attribute name",

80960

"type": "String"

80961

},

80962

{

80963

"name": "value",

80964

"description": "The value to set",

80965

"type": "String"

80966

}

80967

],

80968

"class": "NodeList",

80969

"module": "node",

80970

"submodule": "node-base"

80971

},

80972

{

80973

"file": "node/js/node-attrs.js",

80974

"line": 106,

80975

"description": "Allows getting attributes on DOM nodes, normalizing in some cases.\nThis passes through to the DOM node, allowing for custom attributes.",

80976

"itemtype": "method",

80977

"name": "getAttribute",

80978

"params": [

80979

{

80980

"name": "name",

80981

"description": "The attribute name",

80982

"type": "String"

80983

}

80984

],

80985

"return": {

80986

"description": "The attribute value",

80987

"type": "String"

80988

},

80989

"class": "NodeList",

80990

"module": "node",

80991

"submodule": "node-base"

80992

},

80993

{

80994

"file": "node/js/node-class.js",

80995

"line": 7,

80996

"description": "Determines whether each node has the given className.",

80997

"itemtype": "method",

80998

"name": "hasClass",

80999

"params": [

81000

{

81001

"name": "className",

81002

"description": "the class name to search for",

81003

"type": "String"

81004

}

81005

],

81006

"return": {

81007

"description": "Whether or not the element has the specified class",

81008

"type": "Boolean"

81009

},

81010

"class": "Node",

81011

"module": "node",

81012

"submodule": "node-base"

81013

},

81014

{

81015

"file": "node/js/node-class.js",

81016

"line": 16,

81017

"description": "Adds a class name to each node.",

81018

"itemtype": "method",

81019

"name": "addClass",

81020

"params": [

81021

{

81022

"name": "className",

81023

"description": "the class name to add to the node's class attribute",

81024

"type": "String"

81025

}

81026

],

81027

"chainable": 1,

81028

"class": "Node",

81029

"module": "node",

81030

"submodule": "node-base"

81031

},

81032

{

81033

"file": "node/js/node-class.js",

81034

"line": 24,

81035

"description": "Removes a class name from each node.",

81036

"itemtype": "method",

81037

"name": "removeClass",

81038

"params": [

81039

{

81040

"name": "className",

81041

"description": "the class name to remove from the node's class attribute",

81042

"type": "String"

81043

}

81044

],

81045

"chainable": 1,

81046

"class": "Node",

81047

"module": "node",

81048

"submodule": "node-base"

81049

},

81050

{

81051

"file": "node/js/node-class.js",

81052

"line": 32,

81053

"description": "Replace a class with another class for each node.\nIf no oldClassName is present, the newClassName is simply added.",

81054

"itemtype": "method",

81055

"name": "replaceClass",

81056

"params": [

81057

{

81058

"name": "oldClassName",

81059

"description": "the class name to be replaced",

81060

"type": "String"

81061

},

81062

{

81063

"name": "newClassName",

81064

"description": "the class name that will be replacing the old class name",

81065

"type": "String"

81066

}

81067

],

81068

"chainable": 1,

81069

"class": "Node",

81070

"module": "node",

81071

"submodule": "node-base"

81072

},

81073

{

81074

"file": "node/js/node-class.js",

81075

"line": 42,

81076

"description": "If the className exists on the node it is removed, if it doesn't exist it is added.",

81077

"itemtype": "method",

81078

"name": "toggleClass",

81079

"params": [

81080

{

81081

"name": "className",

81082

"description": "the class name to be toggled",

81083

"type": "String"

81084

},

81085

{

81086

"name": "force",

81087

"description": "Option to force adding or removing the class.",

81088

"type": "Boolean"

81089

}

81090

],

81091

"chainable": 1,

81092

"class": "Node",

81093

"module": "node",

81094

"submodule": "node-base"

81095

},

81096

{

81097

"file": "node/js/node-class.js",

81098

"line": 53,

81099

"description": "Determines whether each node has the given className.",

81100

"itemtype": "method",

81101

"name": "hasClass",

81102

"see": [

81103

"Node.hasClass"

81104

],

81105

"params": [

81106

{

81107

"name": "className",

81108

"description": "the class name to search for",

81109

"type": "String"

81110

}

81111

],

81112

"return": {

81113

"description": "An array of booleans for each node bound to the NodeList.",

81114

"type": "Array"

81115

},

81116

"class": "NodeList",

81117

"module": "node",

81118

"submodule": "node-base"

81119

},

81120

{

81121

"file": "node/js/node-class.js",

81122

"line": 62,

81123

"description": "Adds a class name to each node.",

81124

"itemtype": "method",

81125

"name": "addClass",

81126

"see": [

81127

"Node.addClass"

81128

],

81129

"params": [

81130

{

81131

"name": "className",

81132

"description": "the class name to add to the node's class attribute",

81133

"type": "String"

81134

}

81135

],

81136

"chainable": 1,

81137

"class": "NodeList",

81138

"module": "node",

81139

"submodule": "node-base"

81140

},

81141

{

81142

"file": "node/js/node-class.js",

81143

"line": 70,

81144

"description": "Removes a class name from each node.",

81145

"itemtype": "method",

81146

"name": "removeClass",

81147

"see": [

81148

"Node.removeClass"

81149

],

81150

"params": [

81151

{

81152

"name": "className",

81153

"description": "the class name to remove from the node's class attribute",

81154

"type": "String"

81155

}

81156

],

81157

"chainable": 1,

81158

"class": "NodeList",

81159

"module": "node",

81160

"submodule": "node-base"

81161

},

81162

{

81163

"file": "node/js/node-class.js",

81164

"line": 78,

81165

"description": "Replace a class with another class for each node.\nIf no oldClassName is present, the newClassName is simply added.",

81166

"itemtype": "method",

81167

"name": "replaceClass",

81168

"see": [

81169

"Node.replaceClass"

81170

],

81171

"params": [

81172

{

81173

"name": "oldClassName",

81174

"description": "the class name to be replaced",

81175

"type": "String"

81176

},

81177

{

81178

"name": "newClassName",

81179

"description": "the class name that will be replacing the old class name",

81180

"type": "String"

81181

}

81182

],

81183

"chainable": 1,

81184

"class": "NodeList",

81185

"module": "node",

81186

"submodule": "node-base"

81187

},

81188

{

81189

"file": "node/js/node-class.js",

81190

"line": 88,

81191

"description": "If the className exists on the node it is removed, if it doesn't exist it is added.",

81192

"itemtype": "method",

81193

"name": "toggleClass",

81194

"see": [

81195

"Node.toggleClass"

81196

],

81197

"params": [

81198

{

81199

"name": "className",

81200

"description": "the class name to be toggled",

81201

"type": "String"

81202

}

81203

],

81204

"chainable": 1,

81205

"class": "NodeList",

81206

"module": "node",

81207

"submodule": "node-base"

81208

},

81209

{

81210

"file": "node/js/node-core.js",

81211

"line": 60,

81212

"description": "The underlying DOM node bound to the Y.Node instance",

81213

"itemtype": "property",

81214

"name": "_node",

81215

"access": "private",

81216

"tagname": "",

81217

"class": "Node",

81218

"module": "node",

81219

"submodule": "node-core"

81220

},

81221

{

81222

"file": "node/js/node-core.js",

81223

"line": 108,

81224

"description": "The name of the component",

81225

"static": 1,

81226

"itemtype": "property",

81227

"name": "NAME",

81228

"class": "Node",

81229

"module": "node",

81230

"submodule": "node-core"

81231

},

81232

{

81233

"file": "node/js/node-core.js",

81234

"line": 123,

81235

"description": "A list of Node instances that have been created",

81236

"access": "private",

81237

"tagname": "",

81238

"itemtype": "property",

81239

"name": "_instances",

81240

"static": 1,

81241

"class": "Node",

81242

"module": "node",

81243

"submodule": "node-core"

81244

},

81245

{

81246

"file": "node/js/node-core.js",

81247

"line": 132,

81248

"description": "Retrieves the DOM node bound to a Node instance",

81249

"itemtype": "method",

81250

"name": "getDOMNode",

81251

"static": 1,

81252

"params": [

81253

{

81254

"name": "node",

81255

"description": "The Node instance or an HTMLNode",

81256

"type": "Node | HTMLNode"

81257

}

81258

],

81259

"return": {

81260

"description": "The DOM node bound to the Node instance. If a DOM node is passed\nas the node argument, it is simply returned.",

81261

"type": "HTMLNode"

81262

},

81263

"class": "Node",

81264

"module": "node",

81265

"submodule": "node-core"

81266

},

81267

{

81268

"file": "node/js/node-core.js",

81269

"line": 148,

81270

"description": "Checks Node return values and wraps DOM Nodes as Y.Node instances\nand DOM Collections / Arrays as Y.NodeList instances.\nOther return values just pass thru. If undefined is returned (e.g. no return)\nthen the Node instance is returned for chainability.",

81271

"itemtype": "method",

81272

"name": "scrubVal",

81273

"static": 1,

81274

"params": [

81275

{

81276

"name": "node",

81277

"description": "The Node instance or an HTMLNode",

81278

"type": "Any"

81279

}

81280

],

81281

"return": {

81282

"description": "Depends on what is returned from the DOM node.",

81283

"type": "Node | NodeList | Any"

81284

},

81285

"class": "Node",

81286

"module": "node",

81287

"submodule": "node-core"

81288

},

81289

{

81290

"file": "node/js/node-core.js",

81291

"line": 178,

81292

"description": "Adds methods to the Y.Node prototype, routing through scrubVal.",

81293

"itemtype": "method",

81294

"name": "addMethod",

81295

"static": 1,

81296

"params": [

81297

{

81298

"name": "name",

81299

"description": "The name of the method to add",

81300

"type": "String"

81301

},

81302

{

81303

"name": "fn",

81304

"description": "The function that becomes the method",

81305

"type": "Function"

81306

},

81307

{

81308

"name": "context",

81309

"description": "An optional context to call the method with\n(defaults to the Node instance)",

81310

"type": "Object"

81311

}

81312

],

81313

"return": {

81314

"description": "Depends on what is returned from the DOM node.",

81315

"type": "Any"

81316

},

81317

"class": "Node",

81318

"module": "node",

81319

"submodule": "node-core"

81320

},

81321

{

81322

"file": "node/js/node-core.js",

81323

"line": 219,

81324

"description": "Imports utility methods to be added as Y.Node methods.",

81325

"itemtype": "method",

81326

"name": "importMethod",

81327

"static": 1,

81328

"params": [

81329

{

81330

"name": "host",

81331

"description": "The object that contains the method to import.",

81332

"type": "Object"

81333

},

81334

{

81335

"name": "name",

81336

"description": "The name of the method to import",

81337

"type": "String"

81338

},

81339

{

81340

"name": "altName",

81341

"description": "An optional name to use in place of the host name",

81342

"type": "String"

81343

},

81344

{

81345

"name": "context",

81346

"description": "An optional context to call the method with",

81347

"type": "Object"

81348

}

81349

],

81350

"class": "Node",

81351

"module": "node",

81352

"submodule": "node-core"

81353

},

81354

{

81355

"file": "node/js/node-core.js",

81356

"line": 240,

81357

"description": "Retrieves a NodeList based on the given CSS selector.",

81358

"itemtype": "method",

81359

"name": "all",

81360

"params": [

81361

{

81362

"name": "selector",

81363

"description": "The CSS selector to test against.",

81364

"type": "String"

81365

}

81366

],

81367

"return": {

81368

"description": "A NodeList instance for the matching HTMLCollection/Array.",

81369

"type": "NodeList"

81370

},

81371

"class": "YUI",

81372

"module": "node",

81373

"submodule": "node-core"

81374

},

81375

{

81376

"file": "node/js/node-core.js",

81377

"line": 249,

81378

"description": "Returns a single Node instance bound to the node or the\nfirst element matching the given selector. Returns null if no match found.\nNote: For chaining purposes you may want to\nuse <code>Y.all</code>, which returns a NodeList when no match is found.",

81379

"itemtype": "method",

81380

"name": "one",

81381

"params": [

81382

{

81383

"name": "node",

81384

"description": "a node or Selector",

81385

"type": "String | HTMLElement"

81386

}

81387

],

81388

"return": {

81389

"description": "a Node instance or null if no match found.",

81390

"type": "Node | null"

81391

},

81392

"class": "YUI",

81393

"module": "node",

81394

"submodule": "node-core"

81395

},

81396

{

81397

"file": "node/js/node-core.js",

81398

"line": 260,

81399

"description": "Returns a single Node instance bound to the node or the\nfirst element matching the given selector. Returns null if no match found.\nNote: For chaining purposes you may want to\nuse <code>Y.all</code>, which returns a NodeList when no match is found.",

81400

"itemtype": "method",

81401

"name": "one",

81402

"static": 1,

81403

"params": [

81404

{

81405

"name": "node",

81406

"description": "a node or Selector",

81407

"type": "String | HTMLElement"

81408

}

81409

],

81410

"return": {

81411

"description": "a Node instance or null if no match found.",

81412

"type": "Node | null"

81413

},

81414

"class": "Node",

81415

"module": "node",

81416

"submodule": "node-core"

81417

},

81418

{

81419

"file": "node/js/node-core.js",

81420

"line": 302,

81421

"description": "The default setter for DOM properties\nCalled with instance context (this === the Node instance)",

81422

"itemtype": "method",

81423

"name": "DEFAULT_SETTER",

81424

"static": 1,

81425

"params": [

81426

{

81427

"name": "name",

81428

"description": "The attribute/property being set",

81429

"type": "String"

81430

},

81431

{

81432

"name": "val",

81433

"description": "The value to be set",

81434

"type": "Any"

81435

}

81436

],

81437

"return": {

81438

"description": "The value",

81439

"type": "Any"

81440

},

81441

"class": "Node",

81442

"module": "node",

81443

"submodule": "node-core"

81444

},

81445

{

81446

"file": "node/js/node-core.js",

81447

"line": 327,

81448

"description": "The default getter for DOM properties\nCalled with instance context (this === the Node instance)",

81449

"itemtype": "method",

81450

"name": "DEFAULT_GETTER",

81451

"static": 1,

81452

"params": [

81453

{

81454

"name": "name",

81455

"description": "The attribute/property to look up",

81456

"type": "String"

81457

}

81458

],

81459

"return": {

81460

"description": "The current value",

81461

"type": "Any"

81462

},

81463

"class": "Node",

81464

"module": "node",

81465

"submodule": "node-core"

81466

},

81467

{

81468

"file": "node/js/node-core.js",

81469

"line": 351,

81470

"description": "The method called when outputting Node instances as strings",

81471

"itemtype": "method",

81472

"name": "toString",

81473

"return": {

81474

"description": "A string representation of the Node instance",

81475

"type": "String"

81476

},

81477

"class": "Node",

81478

"module": "node",

81479

"submodule": "node-core"

81480

},

81481

{

81482

"file": "node/js/node-core.js",

81483

"line": 381,

81484

"description": "Returns an attribute value on the Node instance.\nUnless pre-configured (via `Node.ATTRS`), get hands\noff to the underlying DOM node. Only valid\nattributes/properties for the node will be queried.",

81485

"itemtype": "method",

81486

"name": "get",

81487

"params": [

81488

{

81489

"name": "attr",

81490

"description": "The attribute",

81491

"type": "String"

81492

}

81493

],

81494

"return": {

81495

"description": "The current value of the attribute",

81496

"type": "Any"

81497

},

81498

"class": "Node",

81499

"module": "node",

81500

"submodule": "node-core"

81501

},

81502

{

81503

"file": "node/js/node-core.js",

81504

"line": 407,

81505

"description": "Helper method for get.",

81506

"itemtype": "method",

81507

"name": "_get",

81508

"access": "private",

81509

"tagname": "",

81510

"params": [

81511

{

81512

"name": "attr",

81513

"description": "The attribute",

81514

"type": "String"

81515

}

81516

],

81517

"return": {

81518

"description": "The current value of the attribute",

81519

"type": "Any"

81520

},

81521

"class": "Node",

81522

"module": "node",

81523

"submodule": "node-core"

81524

},

81525

{

81526

"file": "node/js/node-core.js",

81527

"line": 429,

81528

"description": "Sets an attribute on the Node instance.\nUnless pre-configured (via Node.ATTRS), set hands\noff to the underlying DOM node. Only valid\nattributes/properties for the node will be set.\nTo set custom attributes use setAttribute.",

81529

"itemtype": "method",

81530

"name": "set",

81531

"params": [

81532

{

81533

"name": "attr",

81534

"description": "The attribute to be set.",

81535

"type": "String"

81536

},

81537

{

81538

"name": "val",

81539

"description": "The value to set the attribute to.",

81540

"type": "Any"

81541

}

81542

],

81543

"chainable": 1,

81544

"class": "Node",

81545

"module": "node",

81546

"submodule": "node-core"

81547

},

81548

{

81549

"file": "node/js/node-core.js",

81550

"line": 458,

81551

"description": "Sets multiple attributes.",

81552

"itemtype": "method",

81553

"name": "setAttrs",

81554

"params": [

81555

{

81556

"name": "attrMap",

81557

"description": "an object of name/value pairs to set",

81558

"type": "Object"

81559

}

81560

],

81561

"chainable": 1,

81562

"class": "Node",

81563

"module": "node",

81564

"submodule": "node-core"

81565

},

81566

{

81567

"file": "node/js/node-core.js",

81568

"line": 476,

81569

"description": "Returns an object containing the values for the requested attributes.",

81570

"itemtype": "method",

81571

"name": "getAttrs",

81572

"params": [

81573

{

81574

"name": "attrs",

81575

"description": "an array of attributes to get values",

81576

"type": "Array"

81577

}

81578

],

81579

"return": {

81580

"description": "An object with attribute name/value pairs.",

81581

"type": "Object"

81582

},

81583

"class": "Node",

81584

"module": "node",

81585

"submodule": "node-core"

81586

},

81587

{

81588

"file": "node/js/node-core.js",

81589

"line": 495,

81590

"description": "Compares nodes to determine if they match.\nNode instances can be compared to each other and/or HTMLElements.",

81591

"itemtype": "method",

81592

"name": "compareTo",

81593

"params": [

81594

{

81595

"name": "refNode",

81596

"description": "The reference node to compare to the node.",

81597

"type": "HTMLElement | Node"

81598

}

81599

],

81600

"return": {

81601

"description": "True if the nodes match, false if they do not.",

81602

"type": "Boolean"

81603

},

81604

"class": "Node",

81605

"module": "node",

81606

"submodule": "node-core"

81607

},

81608

{

81609

"file": "node/js/node-core.js",

81610

"line": 511,

81611

"description": "Determines whether the node is appended to the document.",

81612

"itemtype": "method",

81613

"name": "inDoc",

81614

"params": [

81615

{

81616

"name": "doc",

81617

"description": "optional An optional document to check against.\nDefaults to current document.",

81618

"type": "Node|HTMLElement"

81619

}

81620

],

81621

"return": {

81622

"description": "Whether or not this node is appended to the document.",

81623

"type": "Boolean"

81624

},

81625

"class": "Node",

81626

"module": "node",

81627

"submodule": "node-core"

81628

},

81629

{

81630

"file": "node/js/node-core.js",

81631

"line": 537,

81632

"description": "Returns the nearest ancestor that passes the test applied by supplied boolean method.",

81633

"itemtype": "method",

81634

"name": "ancestor",

81635

"params": [

81636

{

81637

"name": "fn",

81638

"description": "A selector string or boolean method for testing elements.\nIf a function is used, it receives the current node being tested as the only argument.",

81639

"type": "String | Function"

81640

},

81641

{

81642

"name": "testSelf",

81643

"description": "optional Whether or not to include the element in the scan",

81644

"type": "Boolean"

81645

},

81646

{

81647

"name": "stopFn",

81648

"description": "optional A selector string or boolean\nmethod to indicate when the search should stop. The search bails when the function\nreturns true or the selector matches.\nIf a function is used, it receives the current node being tested as the only argument.",

81649

"type": "String | Function"

81650

}

81651

],

81652

"return": {

81653

"description": "The matching Node instance or null if not found",

81654

"type": "Node"

81655

},

81656

"class": "Node",

81657

"module": "node",

81658

"submodule": "node-core"

81659

},

81660

{

81661

"file": "node/js/node-core.js",

81662

"line": 559,

81663

"description": "Returns the ancestors that pass the test applied by supplied boolean method.",

81664

"itemtype": "method",

81665

"name": "ancestors",

81666

"params": [

81667

{

81668

"name": "fn",

81669

"description": "A selector string or boolean method for testing elements.",

81670

"type": "String | Function"

81671

},

81672

{

81673

"name": "testSelf",

81674

"description": "optional Whether or not to include the element in the scan\nIf a function is used, it receives the current node being tested as the only argument.",

81675

"type": "Boolean"

81676

}

81677

],

81678

"return": {

81679

"description": "A NodeList instance containing the matching elements",

81680

"type": "NodeList"

81681

},

81682

"class": "Node",

81683

"module": "node",

81684

"submodule": "node-core"

81685

},

81686

{

81687

"file": "node/js/node-core.js",

81688

"line": 575,

81689

"description": "Returns the previous matching sibling.\nReturns the nearest element node sibling if no method provided.",

81690

"itemtype": "method",

81691

"name": "previous",

81692

"params": [

81693

{

81694

"name": "fn",

81695

"description": "A selector or boolean method for testing elements.\nIf a function is used, it receives the current node being tested as the only argument.",

81696

"type": "String | Function"

81697

}

81698

],

81699

"return": {

81700

"description": "Node instance or null if not found",

81701

"type": "Node"

81702

},

81703

"class": "Node",

81704

"module": "node",

81705

"submodule": "node-core"

81706

},

81707

{

81708

"file": "node/js/node-core.js",

81709

"line": 587,

81710

"description": "Returns the next matching sibling.\nReturns the nearest element node sibling if no method provided.",

81711

"itemtype": "method",

81712

"name": "next",

81713

"params": [

81714

{

81715

"name": "fn",

81716

"description": "A selector or boolean method for testing elements.\nIf a function is used, it receives the current node being tested as the only argument.",

81717

"type": "String | Function"

81718

}

81719

],

81720

"return": {

81721

"description": "Node instance or null if not found",

81722

"type": "Node"

81723

},

81724

"class": "Node",

81725

"module": "node",

81726

"submodule": "node-core"

81727

},

81728

{

81729

"file": "node/js/node-core.js",

81730

"line": 599,

81731

"description": "Returns all matching siblings.\nReturns all siblings if no method provided.",

81732

"itemtype": "method",

81733

"name": "siblings",

81734

"params": [

81735

{

81736

"name": "fn",

81737

"description": "A selector or boolean method for testing elements.\nIf a function is used, it receives the current node being tested as the only argument.",

81738

"type": "String | Function"

81739

}

81740

],

81741

"return": {

81742

"description": "NodeList instance bound to found siblings",

81743

"type": "NodeList"

81744

},

81745

"class": "Node",

81746

"module": "node",

81747

"submodule": "node-core"

81748

},

81749

{

81750

"file": "node/js/node-core.js",

81751

"line": 611,

81752

"description": "Retrieves a Node instance of nodes based on the given CSS selector.",

81753

"itemtype": "method",

81754

"name": "one",

81755

"params": [

81756

{

81757

"name": "selector",

81758

"description": "The CSS selector to test against.",

81759

"type": "String"

81760

}

81761

],

81762

"return": {

81763

"description": "A Node instance for the matching HTMLElement.",

81764

"type": "Node"

81765

},

81766

"class": "Node",

81767

"module": "node",

81768

"submodule": "node-core"

81769

},

81770

{

81771

"file": "node/js/node-core.js",

81772

"line": 622,

81773

"description": "Retrieves a NodeList based on the given CSS selector.",

81774

"itemtype": "method",

81775

"name": "all",

81776

"params": [

81777

{

81778

"name": "selector",

81779

"description": "The CSS selector to test against.",

81780

"type": "String"

81781

}

81782

],

81783

"return": {

81784

"description": "A NodeList instance for the matching HTMLCollection/Array.",

81785

"type": "NodeList"

81786

},

81787

"class": "Node",

81788

"module": "node",

81789

"submodule": "node-core"

81790

},

81791

{

81792

"file": "node/js/node-core.js",

81793

"line": 637,

81794

"description": "Test if the supplied node matches the supplied selector.",

81795

"itemtype": "method",

81796

"name": "test",

81797

"params": [

81798

{

81799

"name": "selector",

81800

"description": "The CSS selector to test against.",

81801

"type": "String"

81802

}

81803

],

81804

"return": {

81805

"description": "Whether or not the node matches the selector.",

81806

"type": "Boolean"

81807

},

81808

"class": "Node",

81809

"module": "node",

81810

"submodule": "node-core"

81811

},

81812

{

81813

"file": "node/js/node-core.js",

81814

"line": 648,

81815

"description": "Removes the node from its parent.\nShortcut for myNode.get('parentNode').removeChild(myNode);",

81816

"itemtype": "method",

81817

"name": "remove",

81818

"params": [

81819

{

81820

"name": "destroy",

81821

"description": "whether or not to call destroy() on the node\nafter removal.",

81822

"type": "Boolean"

81823

}

81824

],

81825

"chainable": 1,

81826

"class": "Node",

81827

"module": "node",

81828

"submodule": "node-core"

81829

},

81830

{

81831

"file": "node/js/node-core.js",

81832

"line": 671,

81833

"description": "Replace the node with the other node. This is a DOM update only\nand does not change the node bound to the Node instance.\nShortcut for myNode.get('parentNode').replaceChild(newNode, myNode);",

81834

"itemtype": "method",

81835

"name": "replace",

81836

"params": [

81837

{

81838

"name": "newNode",

81839

"description": "Node to be inserted",

81840

"type": "Node | HTMLNode"

81841

}

81842

],

81843

"chainable": 1,

81844

"class": "Node",

81845

"module": "node",

81846

"submodule": "node-core"

81847

},

81848

{

81849

"file": "node/js/node-core.js",

81850

"line": 689,

81851

"itemtype": "method",

81852

"name": "replaceChild",

81853

"params": [

81854

{

81855

"name": "node",

81856

"description": "Node to be inserted",

81857

"type": "String | HTMLElement | Node"

81858

},

81859

{

81860

"name": "refNode",

81861

"description": "Node to be replaced",

81862

"type": "HTMLElement | Node"

81863

}

81864

],

81865

"return": {

81866

"description": "The replaced node",

81867

"type": "Node"

81868

},

81869

"class": "Node",

81870

"module": "node",

81871

"submodule": "node-core"

81872

},

81873

{

81874

"file": "node/js/node-core.js",

81875

"line": 704,

81876

"description": "Nulls internal node references, removes any plugins and event listeners",

81877

"itemtype": "method",

81878

"name": "destroy",

81879

"params": [

81880

{

81881

"name": "recursivePurge",

81882

"description": "(optional) Whether or not to remove listeners from the\nnode's subtree (default is false)",

81883

"type": "Boolean"

81884

}

81885

],

81886

"class": "Node",

81887

"module": "node",

81888

"submodule": "node-core"

81889

},

81890

{

81891

"file": "node/js/node-core.js",

81892

"line": 738,

81893

"description": "Invokes a method on the Node instance",

81894

"itemtype": "method",

81895

"name": "invoke",

81896

"params": [

81897

{

81898

"name": "method",

81899

"description": "The name of the method to invoke",

81900

"type": "String"

81901

},

81902

{

81903

"name": "a,",

81904

"description": "b, c, etc. Arguments to invoke the method with.",

81905

"type": "Any"

81906

}

81907

],

81908

"return": {

81909

"description": "Whatever the underly method returns.\nDOM Nodes and Collections return values\nare converted to Node/NodeList instances."

81910

},

81911

"class": "Node",

81912

"module": "node",

81913

"submodule": "node-core"

81914

},

81915

{

81916

"file": "node/js/node-core.js",

81917

"line": 764,

81918

"itemtype": "method",

81919

"name": "swap",

81920

"description": "Swap DOM locations with the given node.\nThis does not change which DOM node each Node instance refers to.",

81921

"params": [

81922

{

81923

"name": "otherNode",

81924

"description": "The node to swap with",

81925

"type": "Node"

81926

}

81927

],

81928

"chainable": 1,

81929

"class": "Node",

81930

"module": "node",

81931

"submodule": "node-core"

81932

},

81933

{

81934

"file": "node/js/node-core.js",

81935

"line": 805,

81936

"description": "Removes and destroys all of the nodes within the node.",

81937

"itemtype": "method",

81938

"name": "empty",

81939

"chainable": 1,

81940

"class": "Node",

81941

"module": "node",

81942

"submodule": "node-core"

81943

},

81944

{

81945

"file": "node/js/node-core.js",

81946

"line": 815,

81947

"description": "Returns the DOM node bound to the Node instance",

81948

"itemtype": "method",

81949

"name": "getDOMNode",

81950

"return": {

81951

"description": "",

81952

"type": "DOMNode"

81953

},

81954

"class": "Node",

81955

"module": "node",

81956

"submodule": "node-core"

81957

},

81958

{

81959

"file": "node/js/node-create.js",

81960

"line": 9,

81961

"description": "Returns a new dom node using the provided markup string.",

81962

"itemtype": "method",

81963

"name": "create",

81964

"static": 1,

81965

"params": [

81966

{

81967

"name": "html",

81968

"description": "The markup used to create the element",

81969

"type": "String"

81970

},

81971

{

81972

"name": "doc",

81973

"description": "An optional document context",

81974

"type": "HTMLDocument"

81975

}

81976

],

81977

"return": {

81978

"description": "A Node instance bound to a DOM node or fragment",

81979

"type": "Node"

81980

},

81981

"class": "Node",

81982

"module": "node",

81983

"submodule": "node-base"

81984

},

81985

{

81986

"file": "node/js/node-create.js",

81987

"line": 26,

81988

"description": "Creates a new Node using the provided markup string.",

81989

"itemtype": "method",

81990

"name": "create",

81991

"params": [

81992

{

81993

"name": "html",

81994

"description": "The markup used to create the element",

81995

"type": "String"

81996

},

81997

{

81998

"name": "doc",

81999

"description": "An optional document context",

82000

"type": "HTMLDocument"

82001

}

82002

],

82003

"return": {

82004

"description": "A Node instance bound to a DOM node or fragment",

82005

"type": "Node"

82006

},

82007

"class": "Node",

82008

"module": "node",

82009

"submodule": "node-base"

82010

},

82011

{

82012

"file": "node/js/node-create.js",

82013

"line": 35,

82014

"description": "Inserts the content before the reference node.",

82015

"itemtype": "method",

82016

"name": "insert",

82017

"params": [

82018

{

82019

"name": "content",

82020

"description": "The content to insert",

82021

"type": "String | Node | HTMLElement | NodeList | HTMLCollection"

82022

},

82023

{

82024

"name": "where",

82025

"description": "The position to insert at.\nPossible \"where\" arguments\n<dl>\n<dt>Y.Node</dt>\n<dd>The Node to insert before</dd>\n<dt>HTMLElement</dt>\n<dd>The element to insert before</dd>\n<dt>Int</dt>\n<dd>The index of the child element to insert before</dd>\n<dt>\"replace\"</dt>\n<dd>Replaces the existing HTML</dd>\n<dt>\"before\"</dt>\n<dd>Inserts before the existing HTML</dd>\n<dt>\"before\"</dt>\n<dd>Inserts content before the node</dd>\n<dt>\"after\"</dt>\n<dd>Inserts content after the node</dd>\n</dl>",

82026

"type": "Int | Node | HTMLElement | String"

82027

}

82028

],

82029

"chainable": 1,

82030

"class": "Node",

82031

"module": "node",

82032

"submodule": "node-base"

82033

},

82034

{

82035

"file": "node/js/node-create.js",

82036

"line": 82,

82037

"description": "Inserts the content as the firstChild of the node.",

82038

"itemtype": "method",

82039

"name": "prepend",

82040

"params": [

82041

{

82042

"name": "content",

82043

"description": "The content to insert",

82044

"type": "String | Node | HTMLElement"

82045

}

82046

],

82047

"chainable": 1,

82048

"class": "Node",

82049

"module": "node",

82050

"submodule": "node-base"

82051

},

82052

{

82053

"file": "node/js/node-create.js",

82054

"line": 92,

82055

"description": "Inserts the content as the lastChild of the node.",

82056

"itemtype": "method",

82057

"name": "append",

82058

"params": [

82059

{

82060

"name": "content",

82061

"description": "The content to insert",

82062

"type": "String | Node | HTMLElement"

82063

}

82064

],

82065

"chainable": 1,

82066

"class": "Node",

82067

"module": "node",

82068

"submodule": "node-base"

82069

},

82070

{

82071

"file": "node/js/node-create.js",

82072

"line": 102,

82073

"itemtype": "method",

82074

"name": "appendChild",

82075

"params": [

82076

{

82077

"name": "node",

82078

"description": "Node to be appended",

82079

"type": "String | HTMLElement | Node"

82080

}

82081

],

82082

"return": {

82083

"description": "The appended node",

82084

"type": "Node"

82085

},

82086

"class": "Node",

82087

"module": "node",

82088

"submodule": "node-base"

82089

},

82090

{

82091

"file": "node/js/node-create.js",

82092

"line": 111,

82093

"itemtype": "method",

82094

"name": "insertBefore",

82095

"params": [

82096

{

82097

"name": "newNode",

82098

"description": "Node to be appended",

82099

"type": "String | HTMLElement | Node"

82100

},

82101

{

82102

"name": "refNode",

82103

"description": "Node to be inserted before",

82104

"type": "HTMLElement | Node"

82105

}

82106

],

82107

"return": {

82108

"description": "The inserted node",

82109

"type": "Node"

82110

},

82111

"class": "Node",

82112

"module": "node",

82113

"submodule": "node-base"

82114

},

82115

{

82116

"file": "node/js/node-create.js",

82117

"line": 121,

82118

"description": "Appends the node to the given node.",

82119

"itemtype": "method",

82120

"name": "appendTo",

82121

"params": [

82122

{

82123

"name": "node",

82124

"description": "The node to append to",

82125

"type": "Node | HTMLElement"

82126

}

82127

],

82128

"chainable": 1,

82129

"class": "Node",

82130

"module": "node",

82131

"submodule": "node-base"

82132

},

82133

{

82134

"file": "node/js/node-create.js",

82135

"line": 132,

82136

"description": "Replaces the node's current content with the content.\nNote that this passes to innerHTML and is not escaped.\nUse `Y.Escape.html()` to escape HTML, or `set('text')` to add as text.",

82137

"itemtype": "method",

82138

"name": "setContent",

82139

"deprecated": true,

82140

"deprecationMessage": "Use setHTML",

82141

"params": [

82142

{

82143

"name": "content",

82144

"description": "The content to insert",

82145

"type": "String | Node | HTMLElement | NodeList | HTMLCollection"

82146

}

82147

],

82148

"chainable": 1,

82149

"class": "Node",

82150

"module": "node",

82151

"submodule": "node-base"

82152

},

82153

{

82154

"file": "node/js/node-create.js",

82155

"line": 146,

82156

"description": "Returns the node's current content (e.g. innerHTML)",

82157

"itemtype": "method",

82158

"name": "getContent",

82159

"deprecated": true,

82160

"deprecationMessage": "Use getHTML",

82161

"return": {

82162

"description": "The current content",

82163

"type": "String"

82164

},

82165

"class": "Node",

82166

"module": "node",

82167

"submodule": "node-base"

82168

},

82169

{

82170

"file": "node/js/node-create.js",

82171

"line": 157,

82172

"description": "Replaces the node's current html content with the content provided.\nNote that this passes to innerHTML and is not escaped.\nUse `Y.Escape.html()` to escape HTML, or `set('text')` to add as text.",

82173

"itemtype": "method",

82174

"name": "setHTML",

82175

"params": [

82176

{

82177

"name": "content",

82178

"description": "The content to insert",

82179

82180

}

82181

],

82182

"chainable": 1,

82183

"class": "Node",

82184

"module": "node",

82185

"submodule": "node-base"

82186

},

82187

{

82188

"file": "node/js/node-create.js",

82189

"line": 167,

82190

"description": "Returns the node's current html content (e.g. innerHTML)",

82191

"itemtype": "method",

82192

"name": "getHTML",

82193

"return": {

82194

"description": "The html content",

82195

"type": "String"

82196

},

82197

"class": "Node",

82198

"module": "node",

82199

"submodule": "node-base"

82200

},

82201

{

82202

"file": "node/js/node-create.js",

82203

"line": 175,

82204

"description": "Called on each Node instance",

82205

"itemtype": "method",

82206

"name": "append",

82207

"see": [

82208

"Node.append"

82209

],

82210

"class": "NodeList",

82211

"module": "node",

82212

"submodule": "node-base"

82213

},

82214

{

82215

"file": "node/js/node-create.js",

82216

"line": 183,

82217

"description": "Called on each Node instance",

82218

"itemtype": "method",

82219

"name": "insert",

82220

"see": [

82221

"Node.insert"

82222

],

82223

"class": "NodeList",

82224

"module": "node",

82225

"submodule": "node-base"

82226

},

82227

{

82228

"file": "node/js/node-create.js",

82229

"line": 191,

82230

"description": "Called on each Node instance",

82231

"itemtype": "method",

82232

"name": "appendChild",

82233

"see": [

82234

"Node.appendChild"

82235

],

82236

"class": "NodeList",

82237

"module": "node",

82238

"submodule": "node-base"

82239

},

82240

{

82241

"file": "node/js/node-create.js",

82242

"line": 199,

82243

"description": "Called on each Node instance",

82244

"itemtype": "method",

82245

"name": "insertBefore",

82246

"see": [

82247

"Node.insertBefore"

82248

],

82249

"class": "NodeList",

82250

"module": "node",

82251

"submodule": "node-base"

82252

},

82253

{

82254

"file": "node/js/node-create.js",

82255

"line": 207,

82256

"description": "Called on each Node instance",

82257

"itemtype": "method",

82258

"name": "prepend",

82259

"see": [

82260

"Node.prepend"

82261

],

82262

"class": "NodeList",

82263

"module": "node",

82264

"submodule": "node-base"

82265

},

82266

{

82267

"file": "node/js/node-create.js",

82268

"line": 215,

82269

"description": "Called on each Node instance\nNote that this passes to innerHTML and is not escaped.\nUse `Y.Escape.html()` to escape HTML, or `set('text')` to add as text.",

82270

"itemtype": "method",

82271

"name": "setContent",

82272

"deprecated": true,

82273

"deprecationMessage": "Use setHTML",

82274

"class": "NodeList",

82275

"module": "node",

82276

"submodule": "node-base"

82277

},

82278

{

82279

"file": "node/js/node-create.js",

82280

"line": 225,

82281

"description": "Called on each Node instance",

82282

"itemtype": "method",

82283

"name": "getContent",

82284

"deprecated": true,

82285

"deprecationMessage": "Use getHTML",

82286

"class": "NodeList",

82287

"module": "node",

82288

"submodule": "node-base"

82289

},

82290

{

82291

"file": "node/js/node-create.js",

82292

"line": 233,

82293

"description": "Called on each Node instance\nNote that this passes to innerHTML and is not escaped.\nUse `Y.Escape.html()` to escape HTML, or `set('text')` to add as text.",

82294

"itemtype": "method",

82295

"name": "setHTML",

82296

"see": [

82297

"Node.setHTML"

82298

],

82299

"class": "NodeList",

82300

"module": "node",

82301

"submodule": "node-base"

82302

},

82303

{

82304

"file": "node/js/node-create.js",

82305

"line": 243,

82306

"description": "Called on each Node instance",

82307

"itemtype": "method",

82308

"name": "getHTML",

82309

"see": [

82310

"Node.getHTML"

82311

],

82312

"class": "NodeList",

82313

"module": "node",

82314

"submodule": "node-base"

82315

},

82316

{

82317

"file": "node/js/node-data.js",

82318

"line": 16,

82319

"itemtype": "method",

82320

"name": "getData",

82321

"description": "Retrieves arbitrary data stored on a Node instance.\nIf no data is associated with the Node, it will attempt to retrieve\na value from the corresponding HTML data attribute. (e.g. node.getData('foo')\nwill check node.getAttribute('data-foo')).",

82322

"params": [

82323

{

82324

"name": "name",

82325

"description": "Optional name of the data field to retrieve.\nIf no name is given, all data is returned.",

82326

"type": "String"

82327

}

82328

],

82329

"return": {

82330

"description": "Whatever is stored at the given field,\nor an object hash of all fields.",

82331

"type": "Any | Object"

82332

},

82333

"class": "YUI",

82334

"module": "node",

82335

"submodule": "node-data"

82336

},

82337

{

82338

"file": "node/js/node-data.js",

82339

"line": 84,

82340

"itemtype": "method",

82341

"name": "setData",

82342

"description": "Stores arbitrary data on a Node instance.\nThis is not stored with the DOM node.",

82343

"params": [

82344

{

82345

"name": "name",

82346

"description": "The name of the field to set. If no name\nis given, name is treated as the data and overrides any existing data.",

82347

"type": "String"

82348

},

82349

{

82350

"name": "val",

82351

"description": "The value to be assigned to the field.",

82352

"type": "Any"

82353

}

82354

],

82355

"chainable": 1,

82356

"class": "YUI",

82357

"module": "node",

82358

"submodule": "node-data"

82359

},

82360

{

82361

"file": "node/js/node-data.js",

82362

"line": 104,

82363

"itemtype": "method",

82364

"name": "clearData",

82365

"description": "Clears internally stored data.",

82366

"params": [

82367

{

82368

"name": "name",

82369

"description": "The name of the field to clear. If no name\nis given, all data is cleared.",

82370

"type": "String"

82371

}

82372

],

82373

"chainable": 1,

82374

"class": "YUI",

82375

"module": "node",

82376

"submodule": "node-data"

82377

},

82378

{

82379

"file": "node/js/node-data.js",

82380

"line": 125,

82381

"itemtype": "method",

82382

"name": "getData",

82383

"description": "Retrieves arbitrary data stored on each Node instance\nbound to the NodeList.",

82384

"see": [

82385

"Node"

82386

],

82387

"params": [

82388

{

82389

"name": "name",

82390

"description": "Optional name of the data field to retrieve.\nIf no name is given, all data is returned.",

82391

"type": "String"

82392

}

82393

],

82394

"return": {

82395

"description": "An array containing all of the data for each Node instance. \nor an object hash of all fields.",

82396

"type": "Array"

82397

},

82398

"class": "YUI",

82399

"module": "node",

82400

"submodule": "node-data"

82401

},

82402

{

82403

"file": "node/js/node-data.js",

82404

"line": 140,

82405

"itemtype": "method",

82406

"name": "setData",

82407

"description": "Stores arbitrary data on each Node instance bound to the\n NodeList. This is not stored with the DOM node.",

82408

"params": [

82409

{

82410

"name": "name",

82411

"description": "The name of the field to set. If no name\nis given, name is treated as the data and overrides any existing data.",

82412

"type": "String"

82413

},

82414

{

82415

"name": "val",

82416

"description": "The value to be assigned to the field.",

82417

"type": "Any"

82418

}

82419

],

82420

"chainable": 1,

82421

"class": "YUI",

82422

"module": "node",

82423

"submodule": "node-data"

82424

},

82425

{

82426

"file": "node/js/node-data.js",

82427

"line": 154,

82428

"itemtype": "method",

82429

"name": "clearData",

82430

"description": "Clears data on all Node instances bound to the NodeList.",

82431

"params": [

82432

{

82433

"name": "name",

82434

"description": "The name of the field to clear. If no name\nis given, all data is cleared.",

82435

"type": "String"

82436

}

82437

],

82438

"chainable": 1,

82439

"class": "YUI",

82440

"module": "node",

82441

"submodule": "node-data"

82442

},

82443

{

82444

"file": "node/js/node-deprecated.js",

82445

"line": 27,

82446

"description": "Returns a single Node instance bound to the node or the\nfirst element matching the given selector.",

82447

"itemtype": "method",

82448

"name": "get",

82449

"deprecated": true,

82450

"deprecationMessage": "Use Y.one",

82451

"static": 1,

82452

"params": [

82453

{

82454

"name": "node",

82455

"description": "a node or Selector",

82456

"type": "String | HTMLElement"

82457

},

82458

{

82459

"name": "doc",

82460

"description": "an optional document to scan. Defaults to Y.config.doc.",

82461

"type": "Node | HTMLElement"

82462

}

82463

],

82464

"class": "YUI",

82465

"module": "node",

82466

"submodule": "node-deprecated"

82467

},

82468

{

82469

"file": "node/js/node-deprecated.js",

82470

"line": 38,

82471

"description": "Returns a single Node instance bound to the node or the\nfirst element matching the given selector.",

82472

"itemtype": "method",

82473

"name": "get",

82474

"deprecated": true,

82475

"deprecationMessage": "Use Y.one",

82476

"static": 1,

82477

"params": [

82478

{

82479

"name": "node",

82480

"description": "a node or Selector",

82481

"type": "String | HTMLElement"

82482

},

82483

{

82484

"name": "doc",

82485

"description": "an optional document to scan. Defaults to Y.config.doc.",

82486

"type": "Node | HTMLElement"

82487

}

82488

],

82489

"class": "Node",

82490

"module": "node",

82491

"submodule": "node-deprecated"

82492

},

82493

{

82494

"file": "node/js/node-deprecated.js",

82495

"line": 55,

82496

"description": "Retrieves a Node instance of nodes based on the given CSS selector.",

82497

"itemtype": "method",

82498

"name": "query",

82499

"deprecated": true,

82500

"deprecationMessage": "Use one()",

82501

"params": [

82502

{

82503

"name": "selector",

82504

"description": "The CSS selector to test against.",

82505

"type": "String"

82506

}

82507

],

82508

"return": {

82509

"description": "A Node instance for the matching HTMLElement.",

82510

"type": "Node"

82511

},

82512

"class": "Node",

82513

"module": "node",

82514

"submodule": "node-deprecated"

82515

},

82516

{

82517

"file": "node/js/node-deprecated.js",

82518

"line": 67,

82519

"description": "Retrieves a nodeList based on the given CSS selector.",

82520

"itemtype": "method",

82521

"name": "queryAll",

82522

"deprecated": true,

82523

"deprecationMessage": "Use all()",

82524

"params": [

82525

{

82526

"name": "selector",

82527

"description": "The CSS selector to test against.",

82528

"type": "String"

82529

}

82530

],

82531

"return": {

82532

"description": "A NodeList instance for the matching HTMLCollection/Array.",

82533

"type": "NodeList"

82534

},

82535

"class": "Node",

82536

"module": "node",

82537

"submodule": "node-deprecated"

82538

},

82539

{

82540

"file": "node/js/node-deprecated.js",

82541

"line": 79,

82542

"description": "Applies the given function to each Node in the NodeList.",

82543

"itemtype": "method",

82544

"name": "each",

82545

"deprecated": true,

82546

"deprecationMessage": "Use NodeList",

82547

"params": [

82548

{

82549

"name": "fn",

82550

"description": "The function to apply",

82551

"type": "Function"

82552

},

82553

{

82554

"name": "context",

82555

"description": "optional An optional context to apply the function with\nDefault context is the NodeList instance",

82556

"type": "Object"

82557

}

82558

],

82559

"chainable": 1,

82560

"class": "Node",

82561

"module": "node",

82562

"submodule": "node-deprecated"

82563

},

82564

{

82565

"file": "node/js/node-deprecated.js",

82566

"line": 94,

82567

"description": "Retrieves the Node instance at the given index.",

82568

"itemtype": "method",

82569

"name": "item",

82570

"deprecated": true,

82571

"deprecationMessage": "Use NodeList",

82572

"params": [

82573

{

82574

"name": "index",

82575

"description": "The index of the target Node.",

82576

"type": "Number"

82577

}

82578

],

82579

"return": {

82580

"description": "The Node instance at the given index.",

82581

"type": "Node"

82582

},

82583

"class": "Node",

82584

"module": "node",

82585

"submodule": "node-deprecated"

82586

},

82587

{

82588

"file": "node/js/node-deprecated.js",

82589

"line": 107,

82590

"description": "Returns the current number of items in the Node.",

82591

"itemtype": "method",

82592

"name": "size",

82593

"deprecated": true,

82594

"deprecationMessage": "Use NodeList",

82595

"return": {

82596

"description": "The number of items in the Node.",

82597

"type": "Int"

82598

},

82599

"class": "Node",

82600

"module": "node",

82601

"submodule": "node-deprecated"

82602

},

82603

{

82604

"file": "node/js/node-event-delegate.js",

82605

"line": 7,

82606

"description": "Sets up a delegation listener for an event occurring inside the Node.\nThe delegated event will be verified against a supplied selector or\nfiltering function to test if the event references at least one node that\nshould trigger the subscription callback.\n\nSelector string filters will trigger the callback if the event originated\nfrom a node that matches it or is contained in a node that matches it.\nFunction filters are called for each Node up the parent axis to the\nsubscribing container node, and receive at each level the Node and the event\nobject. The function should return true (or a truthy value) if that Node\nshould trigger the subscription callback. Note, it is possible for filters\nto match multiple Nodes for a single event. In this case, the delegate\ncallback will be executed for each matching Node.\n\nFor each matching Node, the callback will be executed with its 'this'\nobject set to the Node matched by the filter (unless a specific context was\nprovided during subscription), and the provided event's\n<code>currentTarget</code> will also be set to the matching Node. The\ncontaining Node from which the subscription was originally made can be\nreferenced as <code>e.container</code>.",

82607

"itemtype": "method",

82608

"name": "delegate",

82609

"params": [

82610

{

82611

"name": "type",

82612

"description": "the event type to delegate",

82613

"type": "String"

82614

},

82615

{

82616

"name": "fn",

82617

"description": "the callback function to execute. This function\n will be provided the event object for the delegated event.",

82618

"type": "Function"

82619

},

82620

{

82621

"name": "spec",

82622

"description": "a selector that must match the target of the\n event or a function to test target and its parents for a match",

82623

"type": "String|Function"

82624

},

82625

{

82626

"name": "context",

82627

"description": "optional argument that specifies what 'this' refers to.",

82628

"type": "Object"

82629

},

82630

{

82631

"name": "args",

82632

"description": "0..n additional arguments to pass on to the callback function.\n These arguments will be added after the event object.",

82633

"type": "Any",

82634

"multiple": true

82635

}

82636

],

82637

"return": {

82638

"description": "the detach handle",

82639

"type": "EventHandle"

82640

},

82641

"class": "Node",

82642

"module": "node",

82643

"submodule": "node-event-delegate"

82644

},

82645

{

82646

"file": "node/js/node-event-simulate.js",

82647

"line": 7,

82648

"description": "Simulates an event on the node.",

82649

"params": [

82650

{

82651

"name": "type",

82652

"description": "The type of event to simulate (i.e., \"click\").",

82653

"type": "String"

82654

},

82655

{

82656

"name": "options",

82657

"description": "(Optional) Extra options to copy onto the event object.",

82658

"type": "Object"

82659

}

82660

],

82661

"return": {

82662

"description": "",

82663

"type": "Void"

82664

},

82665

"itemtype": "method",

82666

"name": "simulate",

82667

"class": "Node",

82668

"module": "node",

82669

"submodule": "node-event-simulate"

82670

},

82671

{

82672

"file": "node/js/node-event.js",

82673

"line": 8,

82674

"description": "List of events that route to DOM events",

82675

"static": 1,

82676

"itemtype": "property",

82677

"name": "DOM_EVENTS",

82678

"class": "Node",

82679

"module": "node",

82680

"submodule": "node-base"

82681

},

82682

{

82683

"file": "node/js/node-event.js",

82684

"line": 69,

82685

"description": "Removes event listeners from the node and (optionally) its subtree",

82686

"itemtype": "method",

82687

"name": "purge",

82688

"params": [

82689

{

82690

"name": "recurse",

82691

"description": "(optional) Whether or not to remove listeners from the\nnode's subtree",

82692

"type": "Boolean"

82693

},

82694

{

82695

"name": "type",

82696

"description": "(optional) Only remove listeners of the specified type",

82697

"type": "String"

82698

}

82699

],

82700

"chainable": 1,

82701

"class": "Node",

82702

"module": "node",

82703

"submodule": "node-base"

82704

},

82705

{

82706

"file": "node/js/node-event.js",

82707

"line": 101,

82708

"description": "Subscribe a callback function for each `Node` in the collection to execute\nin response to a DOM event.\n\nNOTE: Generally, the `on()` method should be avoided on `NodeLists`, in\nfavor of using event delegation from a parent Node. See the Event user\nguide for details.\n\nMost DOM events are associated with a preventable default behavior, such as\nlink clicks navigating to a new page. Callbacks are passed a\n`DOMEventFacade` object as their first argument (usually called `e`) that\ncan be used to prevent this default behavior with `e.preventDefault()`. See\nthe `DOMEventFacade` API for all available properties and methods on the\nobject.\n\nBy default, the `this` object will be the `NodeList` that the subscription\ncame from, not the `Node` that received the event. Use\n`e.currentTarget` to refer to the `Node`.\n\nReturning `false` from a callback is supported as an alternative to calling\n`e.preventDefault(); e.stopPropagation();`. However, it is recommended to\nuse the event methods.",

82709

"example": [

82710

"\n\n Y.all(\".sku\").on(\"keydown\", function (e) {\n if (e.keyCode === 13) {\n e.preventDefault();\n\n // Use e.currentTarget to refer to the individual Node\n var item = Y.MyApp.searchInventory( e.currentTarget.get('value') );\n // etc ...\n }\n });"

82711

],

82712

"itemtype": "method",

82713

"name": "on",

82714

"params": [

82715

{

82716

"name": "type",

82717

"description": "The name of the event",

82718

"type": "String"

82719

},

82720

{

82721

"name": "fn",

82722

"description": "The callback to execute in response to the event",

82723

"type": "Function"

82724

},

82725

{

82726

"name": "context",

82727

"description": "Override `this` object in callback",

82728

"type": "Object",

82729

"optional": true

82730

},

82731

{

82732

"name": "arg*",

82733

"description": "0..n additional arguments to supply to the subscriber",

82734

"type": "Any",

82735

"optional": true

82736

}

82737

],

82738

"return": {

82739

"description": "A subscription handle capable of detaching that\n subscription",

82740

"type": "EventHandle"

82741

},

82742

"class": "NodeList",

82743

"module": "node",

82744

"submodule": "node-base"

82745

},

82746

{

82747

"file": "node/js/node-event.js",

82748

"line": 149,

82749

"description": "Applies an one-time event listener to each Node bound to the NodeList.",

82750

"itemtype": "method",

82751

"name": "once",

82752

"params": [

82753

{

82754

"name": "type",

82755

"description": "The event being listened for",

82756

"type": "String"

82757

},

82758

{

82759

"name": "fn",

82760

"description": "The handler to call when the event fires",

82761

"type": "Function"

82762

},

82763

{

82764

"name": "context",

82765

"description": "The context to call the handler with.\nDefault is the NodeList instance.",

82766

"type": "Object"

82767

}

82768

],

82769

"return": {

82770

"description": "A subscription handle capable of detaching that\n subscription",

82771

"type": "EventHandle"

82772

},

82773

"class": "NodeList",

82774

"module": "node",

82775

"submodule": "node-base"

82776

},

82777

{

82778

"file": "node/js/node-event.js",

82779

"line": 164,

82780

"description": "Applies an event listener to each Node bound to the NodeList.\nThe handler is called only after all on() handlers are called\nand the event is not prevented.",

82781

"itemtype": "method",

82782

"name": "after",

82783

"params": [

82784

{

82785

"name": "type",

82786

"description": "The event being listened for",

82787

"type": "String"

82788

},

82789

{

82790

"name": "fn",

82791

"description": "The handler to call when the event fires",

82792

"type": "Function"

82793

},

82794

{

82795

"name": "context",

82796

"description": "The context to call the handler with.\nDefault is the NodeList instance.",

82797

"type": "Object"

82798

}

82799

],

82800

"return": {

82801

"description": "A subscription handle capable of detaching that\n subscription",

82802

"type": "EventHandle"

82803

},

82804

"class": "NodeList",

82805

"module": "node",

82806

"submodule": "node-base"

82807

},

82808

{

82809

"file": "node/js/node-event.js",

82810

"line": 181,

82811

"description": "Applies an one-time event listener to each Node bound to the NodeList\nthat will be called only after all on() handlers are called and the\nevent is not prevented.",

82812

"itemtype": "method",

82813

"name": "onceAfter",

82814

"params": [

82815

{

82816

"name": "type",

82817

"description": "The event being listened for",

82818

"type": "String"

82819

},

82820

{

82821

"name": "fn",

82822

"description": "The handler to call when the event fires",

82823

"type": "Function"

82824

},

82825

{

82826

"name": "context",

82827

"description": "The context to call the handler with.\nDefault is the NodeList instance.",

82828

"type": "Object"

82829

}

82830

],

82831

"return": {

82832

"description": "A subscription handle capable of detaching that\n subscription",

82833

"type": "EventHandle"

82834

},

82835

"class": "NodeList",

82836

"module": "node",

82837

"submodule": "node-base"

82838

},

82839

{

82840

"file": "node/js/node-event.js",

82841

"line": 201,

82842

"description": "Called on each Node instance",

82843

"itemtype": "method",

82844

"name": "detach",

82845

"see": [

82846

"Node.detach"

82847

],

82848

"class": "NodeList",

82849

"module": "node",

82850

"submodule": "node-base"

82851

},

82852

{

82853

"file": "node/js/node-event.js",

82854

"line": 209,

82855

"itemtype": "method",

82856

"name": "detachAll",

82857

"see": [

82858

"Node.detachAll"

82859

],

82860

"class": "NodeList",

82861

"module": "node",

82862

"submodule": "node-base"

82863

},

82864

{

82865

"file": "node/js/node-event.js",

82866

"line": 217,

82867

"description": "Subscribe a callback function to execute in response to a DOM event or custom\nevent.\n\nMost DOM events are associated with a preventable default behavior such as\nlink clicks navigating to a new page. Callbacks are passed a `DOMEventFacade`\nobject as their first argument (usually called `e`) that can be used to\nprevent this default behavior with `e.preventDefault()`. See the\n`DOMEventFacade` API for all available properties and methods on the object.\n\nIf the event name passed as the first parameter is not a whitelisted DOM event,\nit will be treated as a custom event subscriptions, allowing\n`node.fire('customEventName')` later in the code. Refer to the Event user guide\nfor the full DOM event whitelist.\n\nBy default, the `this` object in the callback will refer to the subscribed\n`Node`.\n\nReturning `false` from a callback is supported as an alternative to calling\n`e.preventDefault(); e.stopPropagation();`. However, it is recommended to use\nthe event methods.",

82868

"example": [

82869

"\n\n Y.one(\"#my-form\").on(\"submit\", function (e) {\n e.preventDefault();\n\n // proceed with ajax form submission instead...\n });"

82870

],

82871

"itemtype": "method",

82872

"name": "on",

82873

"params": [

82874

{

82875

"name": "type",

82876

"description": "The name of the event",

82877

"type": "String"

82878

},

82879

{

82880

"name": "fn",

82881

"description": "The callback to execute in response to the event",

82882

"type": "Function"

82883

},

82884

{

82885

"name": "context",

82886

"description": "Override `this` object in callback",

82887

"type": "Object",

82888

"optional": true

82889

},

82890

{

82891

"name": "arg*",

82892

"description": "0..n additional arguments to supply to the subscriber",

82893

"type": "Any",

82894

"optional": true

82895

}

82896

],

82897

"return": {

82898

"description": "A subscription handle capable of detaching that\n subscription",

82899

"type": "EventHandle"

82900

},

82901

"class": "Node",

82902

"module": "node",

82903

"submodule": "node-base"

82904

},

82905

{

82906

"file": "node/js/node-imports.js",

82907

"line": 7,

82908

"description": "Passes through to DOM method.",

82909

"itemtype": "method",

82910

"name": "removeChild",

82911

"params": [

82912

{

82913

"name": "node",

82914

"description": "Node to be removed",

82915

"type": "HTMLElement | Node"

82916

}

82917

],

82918

"return": {

82919

"description": "The removed node",

82920

"type": "Node"

82921

},

82922

"class": "Node",

82923

"module": "node",

82924

"submodule": "node-core"

82925

},

82926

{

82927

"file": "node/js/node-imports.js",

82928

"line": 16,

82929

"description": "Passes through to DOM method.",

82930

"itemtype": "method",

82931

"name": "hasChildNodes",

82932

"return": {

82933

"description": "Whether or not the node has any childNodes",

82934

"type": "Boolean"

82935

},

82936

"class": "Node",

82937

"module": "node",

82938

"submodule": "node-core"

82939

},

82940

{

82941

"file": "node/js/node-imports.js",

82942

"line": 23,

82943

"description": "Passes through to DOM method.",

82944

"itemtype": "method",

82945

"name": "cloneNode",

82946

"params": [

82947

{

82948

"name": "deep",

82949

"description": "Whether or not to perform a deep clone, which includes\nsubtree and attributes",

82950

"type": "Boolean"

82951

}

82952

],

82953

"return": {

82954

"description": "The clone",

82955

"type": "Node"

82956

},

82957

"class": "Node",

82958

"module": "node",

82959

"submodule": "node-core"

82960

},

82961

{

82962

"file": "node/js/node-imports.js",

82963

"line": 32,

82964

"description": "Passes through to DOM method.",

82965

"itemtype": "method",

82966

"name": "hasAttribute",

82967

"params": [

82968

{

82969

"name": "attribute",

82970

"description": "The attribute to test for",

82971

"type": "String"

82972

}

82973

],

82974

"return": {

82975

"description": "Whether or not the attribute is present",

82976

"type": "Boolean"

82977

},

82978

"class": "Node",

82979

"module": "node",

82980

"submodule": "node-core"

82981

},

82982

{

82983

"file": "node/js/node-imports.js",

82984

"line": 40,

82985

"description": "Passes through to DOM method.",

82986

"itemtype": "method",

82987

"name": "scrollIntoView",

82988

"chainable": 1,

82989

"class": "Node",

82990

"module": "node",

82991

"submodule": "node-core"

82992

},

82993

{

82994

"file": "node/js/node-imports.js",

82995

"line": 47,

82996

"description": "Passes through to DOM method.",

82997

"itemtype": "method",

82998

"name": "getElementsByTagName",

82999

"params": [

83000

{

83001

"name": "tagName",

83002

"description": "The tagName to collect",

83003

"type": "String"

83004

}

83005

],

83006

"return": {

83007

"description": "A NodeList representing the HTMLCollection",

83008

"type": "NodeList"

83009

},

83010

"class": "Node",

83011

"module": "node",

83012

"submodule": "node-core"

83013

},

83014

{

83015

"file": "node/js/node-imports.js",

83016

"line": 55,

83017

"description": "Passes through to DOM method.",

83018

"itemtype": "method",

83019

"name": "focus",

83020

"chainable": 1,

83021

"class": "Node",

83022

"module": "node",

83023

"submodule": "node-core"

83024

},

83025

{

83026

"file": "node/js/node-imports.js",

83027

"line": 62,

83028

"description": "Passes through to DOM method.",

83029

"itemtype": "method",

83030

"name": "blur",

83031

"chainable": 1,

83032

"class": "Node",

83033

"module": "node",

83034

"submodule": "node-core"

83035

},

83036

{

83037

"file": "node/js/node-imports.js",

83038

"line": 69,

83039

"description": "Passes through to DOM method.\nOnly valid on FORM elements",

83040

"itemtype": "method",

83041

"name": "submit",

83042

"chainable": 1,

83043

"class": "Node",

83044

"module": "node",

83045

"submodule": "node-core"

83046

},

83047

{

83048

"file": "node/js/node-imports.js",

83049

"line": 77,

83050

"description": "Passes through to DOM method.\nOnly valid on FORM elements",

83051

"itemtype": "method",

83052

"name": "reset",

83053

"chainable": 1,

83054

"class": "Node",

83055

"module": "node",

83056

"submodule": "node-core"

83057

},

83058

{

83059

"file": "node/js/node-imports.js",

83060

"line": 85,

83061

"description": "Passes through to DOM method.",

83062

"itemtype": "method",

83063

"name": "select",

83064

"chainable": 1,

83065

"class": "Node",

83066

"module": "node",

83067

"submodule": "node-core"

83068

},

83069

{

83070

"file": "node/js/node-imports.js",

83071

"line": 92,

83072

"description": "Passes through to DOM method.\nOnly valid on TABLE elements",

83073

"itemtype": "method",

83074

"name": "createCaption",

83075

"chainable": 1,

83076

"class": "Node",

83077

"module": "node",

83078

"submodule": "node-core"

83079

},

83080

{

83081

"file": "node/js/node-imports.js",

83082

"line": 108,

83083

"description": "Passes through to DOM method.",

83084

"itemtype": "method",

83085

"name": "removeAttribute",

83086

"params": [

83087

{

83088

"name": "attribute",

83089

"description": "The attribute to be removed",

83090

"type": "String"

83091

}

83092

],

83093

"chainable": 1,

83094

"class": "Node",

83095

"module": "node",

83096

"submodule": "node-core"

83097

},

83098

{

83099

"file": "node/js/node-imports.js",

83100

"line": 125,

83101

"description": "Determines whether the node is an ancestor of another HTML element in the DOM hierarchy.",

83102

"itemtype": "method",

83103

"name": "contains",

83104

"params": [

83105

{

83106

"name": "needle",

83107

"description": "The possible node or descendent",

83108

"type": "Node | HTMLElement"

83109

}

83110

],

83111

"return": {

83112

"description": "Whether or not this node is the needle its ancestor",

83113

"type": "Boolean"

83114

},

83115

"class": "Node",

83116

"module": "node",

83117

"submodule": "node-core"

83118

},

83119

{

83120

"file": "node/js/node-imports.js",

83121

"line": 132,

83122

"description": "Allows setting attributes on DOM nodes, normalizing in some cases.\nThis passes through to the DOM node, allowing for custom attributes.",

83123

"itemtype": "method",

83124

"name": "setAttribute",

83125

"chainable": 1,

83126

"params": [

83127

{

83128

"name": "name",

83129

"description": "The attribute name",

83130

"type": "String"

83131

},

83132

{

83133

"name": "value",

83134

"description": "The value to set",

83135

"type": "String"

83136

}

83137

],

83138

"class": "Node",

83139

"module": "node",

83140

"submodule": "node-core"

83141

},

83142

{

83143

"file": "node/js/node-imports.js",

83144

"line": 142,

83145

"description": "Allows getting attributes on DOM nodes, normalizing in some cases.\nThis passes through to the DOM node, allowing for custom attributes.",

83146

"itemtype": "method",

83147

"name": "getAttribute",

83148

"params": [

83149

{

83150

"name": "name",

83151

"description": "The attribute name",

83152

"type": "String"

83153

}

83154

],

83155

"return": {

83156

"description": "The attribute value",

83157

"type": "String"

83158

},

83159

"class": "Node",

83160

"module": "node",

83161

"submodule": "node-core"

83162

},

83163

{

83164

"file": "node/js/node-imports.js",

83165

"line": 152,

83166

"description": "Wraps the given HTML around the node.",

83167

"itemtype": "method",

83168

"name": "wrap",

83169

"params": [

83170

{

83171

"name": "html",

83172

"description": "The markup to wrap around the node.",

83173

"type": "String"

83174

}

83175

],

83176

"chainable": 1,

83177

"class": "Node",

83178

"module": "node",

83179

"submodule": "node-core"

83180

},

83181

{

83182

"file": "node/js/node-imports.js",

83183

"line": 161,

83184

"description": "Removes the node's parent node.",

83185

"itemtype": "method",

83186

"name": "unwrap",

83187

"chainable": 1,

83188

"class": "Node",

83189

"module": "node",

83190

"submodule": "node-core"

83191

},

83192

{

83193

"file": "node/js/node-imports.js",

83194

"line": 168,

83195

"description": "Applies a unique ID to the node if none exists",

83196

"itemtype": "method",

83197

"name": "generateID",

83198

"return": {

83199

"description": "The existing or generated ID",

83200

"type": "String"

83201

},

83202

"class": "Node",

83203

"module": "node",

83204

"submodule": "node-core"

83205

},

83206

{

83207

"file": "node/js/node-imports.js",

83208

"line": 177,

83209

"description": "Allows getting attributes on DOM nodes, normalizing in some cases.\nThis passes through to the DOM node, allowing for custom attributes.",

83210

"itemtype": "method",

83211

"name": "getAttribute",

83212

"see": [

83213

"Node"

83214

],

83215

"params": [

83216

{

83217

"name": "name",

83218

"description": "The attribute name",

83219

"type": "String"

83220

}

83221

],

83222

"return": {

83223

"description": "The attribute value",

83224

"type": "String"

83225

},

83226

"class": "NodeList",

83227

"module": "node",

83228

"submodule": "node-core"

83229

},

83230

{

83231

"file": "node/js/node-imports.js",

83232

"line": 188,

83233

"description": "Allows setting attributes on DOM nodes, normalizing in some cases.\nThis passes through to the DOM node, allowing for custom attributes.",

83234

"itemtype": "method",

83235

"name": "setAttribute",

83236

"see": [

83237

"Node"

83238

],

83239

"chainable": 1,

83240

"params": [

83241

{

83242

"name": "name",

83243

"description": "The attribute name",

83244

"type": "String"

83245

},

83246

{

83247

"name": "value",

83248

"description": "The value to set",

83249

"type": "String"

83250

}

83251

],

83252

"class": "NodeList",

83253

"module": "node",

83254

"submodule": "node-core"

83255

},

83256

{

83257

"file": "node/js/node-imports.js",

83258

"line": 200,

83259

"description": "Allows for removing attributes on DOM nodes.\nThis passes through to the DOM node, allowing for custom attributes.",

83260

"itemtype": "method",

83261

"name": "removeAttribute",

83262

"see": [

83263

"Node"

83264

],

83265

"params": [

83266

{

83267

"name": "name",

83268

"description": "The attribute to remove",

83269

"type": "String"

83270

}

83271

],

83272

"class": "NodeList",

83273

"module": "node",

83274

"submodule": "node-core"

83275

},

83276

{

83277

"file": "node/js/node-imports.js",

83278

"line": 209,

83279

"description": "Removes the parent node from node in the list.",

83280

"itemtype": "method",

83281

"name": "unwrap",

83282

"chainable": 1,

83283

"class": "NodeList",

83284

"module": "node",

83285

"submodule": "node-core"

83286

},

83287

{

83288

"file": "node/js/node-imports.js",

83289

"line": 215,

83290

"description": "Wraps the given HTML around each node.",

83291

"itemtype": "method",

83292

"name": "wrap",

83293

"params": [

83294

{

83295

"name": "html",

83296

"description": "The markup to wrap around the node.",

83297

"type": "String"

83298

}

83299

],

83300

"chainable": 1,

83301

"class": "NodeList",

83302

"module": "node",

83303

"submodule": "node-core"

83304

},

83305

{

83306

"file": "node/js/node-imports.js",

83307

"line": 223,

83308

"description": "Applies a unique ID to each node if none exists",

83309

"itemtype": "method",

83310

"name": "generateID",

83311

"return": {

83312

"description": "The existing or generated ID",

83313

"type": "String"

83314

},

83315

"class": "NodeList",

83316

"module": "node",

83317

"submodule": "node-core"

83318

},

83319

{

83320

"file": "node/js/node-load.js",

83321

"line": 7,

83322

"description": "The default IO complete handler.",

83323

"itemtype": "method",

83324

"name": "_ioComplete",

83325

"access": "protected",

83326

"tagname": "",

83327

"params": [

83328

{

83329

"name": "code",

83330

"description": "The response code.",

83331

"type": "String"

83332

},

83333

{

83334

"name": "response",

83335

"description": "The response object.",

83336

"type": "Object"

83337

},

83338

{

83339

"name": "args",

83340

"description": "An array containing the callback and selector",

83341

"type": "Array"

83342

}

83343

],

83344

"class": "Node",

83345

"module": "node",

83346

"submodule": "node-load"

83347

},

83348

{

83349

"file": "node/js/node-load.js",

83350

"line": 36,

83351

"description": "Loads content from the given url and replaces the Node's\nexisting content with the remote content.",

83352

"itemtype": "method",

83353

"name": "load",

83354

"params": [

83355

{

83356

"name": "url",

83357

"description": "The URL to load via XMLHttpRequest.",

83358

"type": "String"

83359

},

83360

{

83361

"name": "selector",

83362

"description": "An optional selector representing a subset of an HTML document to load.",

83363

"type": "String"

83364

},

83365

{

83366

"name": "callback",

83367

"description": "An optional function to run after the content has been loaded.",

83368

"type": "Function"

83369

}

83370

],

83371

"chainable": 1,

83372

"class": "Node",

83373

"module": "node",

83374

"submodule": "node-load"

83375

},

83376

{

83377

"file": "node/js/node-pluginhost.js",

83378

"line": 6,

83379

"description": "Registers plugins to be instantiated at the class level (plugins\nwhich should be plugged into every instance of Node by default).",

83380

"itemtype": "method",

83381

"name": "plug",

83382

"static": 1,

83383

"params": [

83384

{

83385

"name": "plugin",

83386

"description": "Either the plugin class, an array of plugin classes or an array of objects (with fn and cfg properties defined)",

83387

"type": "Function | Array"

83388

},

83389

{

83390

"name": "config",

83391

"description": "(Optional) If plugin is the plugin class, the configuration for the plugin",

83392

"type": "Object"

83393

}

83394

],

83395

"class": "Node",

83396

"module": "node",

83397

"submodule": "node-pluginhost"

83398

},

83399

{

83400

"file": "node/js/node-pluginhost.js",

83401

"line": 23,

83402

"description": "Unregisters any class level plugins which have been registered by the Node",

83403

"itemtype": "method",

83404

"name": "unplug",

83405

"static": 1,

83406

"params": [

83407

{

83408

"name": "plugin",

83409

"description": "The plugin class, or an array of plugin classes",

83410

"type": "Function | Array"

83411

}

83412

],

83413

"class": "Node",

83414

"module": "node",

83415

"submodule": "node-pluginhost"

83416

},

83417

{

83418

"file": "node/js/node-region.js",

83419

"line": 6,

83420

"description": "Returns a region object for the node",

83421

"itemtype": "config",

83422

"name": "region",

83423

"type": "Node",

83424

"class": "Node",

83425

"module": "node",

83426

"submodule": "node-screen"

83427

},

83428

{

83429

"file": "node/js/node-region.js",

83430

"line": 31,

83431

"description": "Returns a region object for the node's viewport",

83432

"itemtype": "config",

83433

"name": "viewportRegion",

83434

"type": "Node",

83435

"class": "Node",

83436

"module": "node",

83437

"submodule": "node-screen"

83438

},

83439

{

83440

"file": "node/js/node-region.js",

83441

"line": 45,

83442

"description": "Compares the intersection of the node with another node or region",

83443

"itemtype": "method",

83444

"name": "intersect",

83445

"params": [

83446

{

83447

"name": "node2",

83448

"description": "The node or region to compare with.",

83449

"type": "Node|Object"

83450

},

83451

{

83452

"name": "altRegion",

83453

"description": "An alternate region to use (rather than this node's).",

83454

"type": "Object"

83455

}

83456

],

83457

"return": {

83458

"description": "An object representing the intersection of the regions.",

83459

"type": "Object"

83460

},

83461

"class": "Node",

83462

"module": "node",

83463

"submodule": "node-screen"

83464

},

83465

{

83466

"file": "node/js/node-region.js",

83467

"line": 61,

83468

"description": "Determines whether or not the node is within the giving region.",

83469

"itemtype": "method",

83470

"name": "inRegion",

83471

"params": [

83472

{

83473

"name": "node2",

83474

"description": "The node or region to compare with.",

83475

"type": "Node|Object"

83476

},

83477

{

83478

"name": "all",

83479

"description": "Whether or not all of the node must be in the region.",

83480

"type": "Boolean"

83481

},

83482

{

83483

"name": "altRegion",

83484

"description": "An alternate region to use (rather than this node's).",

83485

"type": "Object"

83486

}

83487

],

83488

"return": {

83489

"description": "An object representing the intersection of the regions.",

83490

"type": "Object"

83491

},

83492

"class": "Node",

83493

"module": "node",

83494

"submodule": "node-screen"

83495

},

83496

{

83497

"file": "node/js/node-screen.js",

83498

"line": 10,

83499

"description": "Returns the inner width of the viewport (exludes scrollbar).",

83500

"itemtype": "config",

83501

"name": "winWidth",

83502

"type": "{Int}",

83503

"class": "Node",

83504

"module": "node",

83505

"submodule": "node-screen"

83506

},

83507

{

83508

"file": "node/js/node-screen.js",

83509

"line": 18,

83510

"description": "Returns the inner height of the viewport (exludes scrollbar).",

83511

"itemtype": "config",

83512

"name": "winHeight",

83513

"type": "{Int}",

83514

"class": "Node",

83515

"module": "node",

83516

"submodule": "node-screen"

83517

},

83518

{

83519

"file": "node/js/node-screen.js",

83520

"line": 25,

83521

"description": "Document width",

83522

"itemtype": "config",

83523

"name": "winHeight",

83524

"type": "{Int}",

83525

"class": "Node",

83526

"module": "node",

83527

"submodule": "node-screen"

83528

},

83529

{

83530

"file": "node/js/node-screen.js",

83531

"line": 32,

83532

"description": "Document height",

83533

"itemtype": "config",

83534

"name": "docHeight",

83535

"type": "{Int}",

83536

"class": "Node",

83537

"module": "node",

83538

"submodule": "node-screen"

83539

},

83540

{

83541

"file": "node/js/node-screen.js",

83542

"line": 39,

83543

"description": "Pixel distance the page has been scrolled horizontally",

83544

"itemtype": "config",

83545

"name": "docScrollX",

83546

"type": "{Int}",

83547

"class": "Node",

83548

"module": "node",

83549

"submodule": "node-screen"

83550

},

83551

{

83552

"file": "node/js/node-screen.js",

83553

"line": 46,

83554

"description": "Pixel distance the page has been scrolled vertically",

83555

"itemtype": "config",

83556

"name": "docScrollY",

83557

"type": "{Int}",

83558

"class": "Node",

83559

"module": "node",

83560

"submodule": "node-screen"

83561

},

83562

{

83563

"file": "node/js/node-screen.js",

83564

"line": 106,

83565

"description": "Gets the current position of the node in page coordinates.",

83566

"itemtype": "method",

83567

"name": "getXY",

83568

"return": {

83569

"description": "The XY position of the node",

83570

"type": "Array"

83571

},

83572

"class": "Node",

83573

"module": "node",

83574

"submodule": "node-screen"

83575

},

83576

{

83577

"file": "node/js/node-screen.js",

83578

"line": 114,

83579

"description": "Set the position of the node in page coordinates, regardless of how the node is positioned.",

83580

"itemtype": "method",

83581

"name": "setXY",

83582

"params": [

83583

{

83584

"name": "xy",

83585

"description": "Contains X & Y values for new position (coordinates are page-based)",

83586

"type": "Array"

83587

}

83588

],

83589

"chainable": 1,

83590

"class": "Node",

83591

"module": "node",

83592

"submodule": "node-screen"

83593

},

83594

{

83595

"file": "node/js/node-screen.js",

83596

"line": 122,

83597

"description": "Gets the current position of the node in page coordinates.",

83598

"itemtype": "method",

83599

"name": "getX",

83600

"return": {

83601

"description": "The X position of the node",

83602

"type": "Int"

83603

},

83604

"class": "Node",

83605

"module": "node",

83606

"submodule": "node-screen"

83607

},

83608

{

83609

"file": "node/js/node-screen.js",

83610

"line": 129,

83611

"description": "Set the position of the node in page coordinates, regardless of how the node is positioned.",

83612

"itemtype": "method",

83613

"name": "setX",

83614

"params": [

83615

{

83616

"name": "x",

83617

"description": "X value for new position (coordinates are page-based)",

83618

"type": "Int"

83619

}

83620

],

83621

"chainable": 1,

83622

"class": "Node",

83623

"module": "node",

83624

"submodule": "node-screen"

83625

},

83626

{

83627

"file": "node/js/node-screen.js",

83628

"line": 137,

83629

"description": "Gets the current position of the node in page coordinates.",

83630

"itemtype": "method",

83631

"name": "getY",

83632

"return": {

83633

"description": "The Y position of the node",

83634

"type": "Int"

83635

},

83636

"class": "Node",

83637

"module": "node",

83638

"submodule": "node-screen"

83639

},

83640

{

83641

"file": "node/js/node-screen.js",

83642

"line": 144,

83643

"description": "Set the position of the node in page coordinates, regardless of how the node is positioned.",

83644

"itemtype": "method",

83645

"name": "setY",

83646

"params": [

83647

{

83648

"name": "y",

83649

"description": "Y value for new position (coordinates are page-based)",

83650

"type": "Int"

83651

}

83652

],

83653

"chainable": 1,

83654

"class": "Node",

83655

"module": "node",

83656

"submodule": "node-screen"

83657

},

83658

{

83659

"file": "node/js/node-screen.js",

83660

"line": 152,

83661

"description": "Swaps the XY position of this node with another node.",

83662

"itemtype": "method",

83663

"name": "swapXY",

83664

"params": [

83665

{

83666

"name": "otherNode",

83667

"description": "The node to swap with.",

83668

"type": "Node | HTMLElement"

83669

}

83670

],

83671

"chainable": 1,

83672

"class": "Node",

83673

"module": "node",

83674

"submodule": "node-screen"

83675

},

83676

{

83677

"file": "node/js/node-style.js",

83678

"line": 9,

83679

"description": "Sets a style property of the node.\nUse camelCase (e.g. 'backgroundColor') for multi-word properties.",

83680

"itemtype": "method",

83681

"name": "setStyle",

83682

"params": [

83683

{

83684

"name": "attr",

83685

"description": "The style attribute to set.",

83686

"type": "String"

83687

},

83688

{

83689

"name": "val",

83690

"description": "The value.",

83691

"type": "String|Number"

83692

}

83693

],

83694

"chainable": 1,

83695

"class": "Node",

83696

"module": "node",

83697

"submodule": "node-style"

83698

},

83699

{

83700

"file": "node/js/node-style.js",

83701

"line": 22,

83702

"description": "Sets multiple style properties on the node.\nUse camelCase (e.g. 'backgroundColor') for multi-word properties.",

83703

"itemtype": "method",

83704

"name": "setStyles",

83705

"params": [

83706

{

83707

"name": "hash",

83708

"description": "An object literal of property:value pairs.",

83709

"type": "Object"

83710

}

83711

],

83712

"chainable": 1,

83713

"class": "Node",

83714

"module": "node",

83715

"submodule": "node-style"

83716

},

83717

{

83718

"file": "node/js/node-style.js",

83719

"line": 34,

83720

"description": "Returns the style's current value.\nUse camelCase (e.g. 'backgroundColor') for multi-word properties.",

83721

"itemtype": "method",

83722

"name": "getStyle",

83723

"params": [

83724

{

83725

"name": "attr",

83726

"description": "The style attribute to retrieve.",

83727

"type": "String"

83728

}

83729

],

83730

"return": {

83731

"description": "The current value of the style property for the element.",

83732

"type": "String"

83733

},

83734

"class": "Node",

83735

"module": "node",

83736

"submodule": "node-style"

83737

},

83738

{

83739

"file": "node/js/node-style.js",

83740

"line": 47,

83741

"description": "Returns the computed value for the given style property.\nUse camelCase (e.g. 'backgroundColor') for multi-word properties.",

83742

"itemtype": "method",

83743

"name": "getComputedStyle",

83744

"params": [

83745

{

83746

"name": "attr",

83747

"description": "The style attribute to retrieve.",

83748

"type": "String"

83749

}

83750

],

83751

"return": {

83752

"description": "The computed value of the style property for the element.",

83753

"type": "String"

83754

},

83755

"class": "Node",

83756

"module": "node",

83757

"submodule": "node-style"

83758

},

83759

{

83760

"file": "node/js/node-style.js",

83761

"line": 59,

83762

"description": "Returns an array of values for each node.\nUse camelCase (e.g. 'backgroundColor') for multi-word properties.",

83763

"itemtype": "method",

83764

"name": "getStyle",

83765

"see": [

83766

"Node.getStyle"

83767

],

83768

"params": [

83769

{

83770

"name": "attr",

83771

"description": "The style attribute to retrieve.",

83772

"type": "String"

83773

}

83774

],

83775

"return": {

83776

"description": "The current values of the style property for the element.",

83777

"type": "Array"

83778

},

83779

"class": "NodeList",

83780

"module": "node",

83781

"submodule": "node-style"

83782

},

83783

{

83784

"file": "node/js/node-style.js",

83785

"line": 69,

83786

"description": "Returns an array of the computed value for each node.\nUse camelCase (e.g. 'backgroundColor') for multi-word properties.",

83787

"itemtype": "method",

83788

"name": "getComputedStyle",

83789

"see": [

83790

"Node.getComputedStyle"

83791

],

83792

"params": [

83793

{

83794

"name": "attr",

83795

"description": "The style attribute to retrieve.",

83796

"type": "String"

83797

}

83798

],

83799

"return": {

83800

"description": "The computed values for each node.",

83801

"type": "Array"

83802

},

83803

"class": "NodeList",

83804

"module": "node",

83805

"submodule": "node-style"

83806

},

83807

{

83808

"file": "node/js/node-style.js",

83809

"line": 78,

83810

"description": "Sets a style property on each node.\nUse camelCase (e.g. 'backgroundColor') for multi-word properties.",

83811

"itemtype": "method",

83812

"name": "setStyle",

83813

"see": [

83814

"Node.setStyle"

83815

],

83816

"params": [

83817

{

83818

"name": "attr",

83819

"description": "The style attribute to set.",

83820

"type": "String"

83821

},

83822

{

83823

"name": "val",

83824

"description": "The value.",

83825

"type": "String|Number"

83826

}

83827

],

83828

"chainable": 1,

83829

"class": "NodeList",

83830

"module": "node",

83831

"submodule": "node-style"

83832

},

83833

{

83834

"file": "node/js/node-style.js",

83835

"line": 88,

83836

"description": "Sets multiple style properties on each node.\nUse camelCase (e.g. 'backgroundColor') for multi-word properties.",

83837

"itemtype": "method",

83838

"name": "setStyles",

83839

"see": [

83840

"Node.setStyles"

83841

],

83842

"params": [

83843

{

83844

"name": "hash",

83845

"description": "An object literal of property:value pairs.",

83846

"type": "Object"

83847

}

83848

],

83849

"chainable": 1,

83850

"class": "NodeList",

83851

"module": "node",

83852

"submodule": "node-style"

83853

},

83854

{

83855

"file": "node/js/node-view.js",

83856

"line": 9,

83857

"description": "Makes the node visible.\nIf the \"transition\" module is loaded, show optionally\nanimates the showing of the node using either the default\ntransition effect ('fadeIn'), or the given named effect.",

83858

"itemtype": "method",

83859

"name": "show",

83860

"params": [

83861

{

83862

"name": "name",

83863

"description": "A named Transition effect to use as the show effect.",

83864

"type": "String"

83865

},

83866

{

83867

"name": "config",

83868

"description": "Options to use with the transition.",

83869

"type": "Object"

83870

},

83871

{

83872

"name": "callback",

83873

"description": "An optional function to run after the transition completes.",

83874

"type": "Function"

83875

}

83876

],

83877

"chainable": 1,

83878

"class": "Node",

83879

"module": "node",

83880

"submodule": "node-base"

83881

},

83882

{

83883

"file": "node/js/node-view.js",

83884

"line": 27,

83885

"description": "The implementation for showing nodes.\nDefault is to toggle the style.display property.",

83886

"itemtype": "method",

83887

"name": "_show",

83888

"access": "protected",

83889

"tagname": "",

83890

"chainable": 1,

83891

"class": "Node",

83892

"module": "node",

83893

"submodule": "node-base"

83894

},

83895

{

83896

"file": "node/js/node-view.js",

83897

"line": 43,

83898

"description": "Displays or hides the node.\nIf the \"transition\" module is loaded, toggleView optionally\nanimates the toggling of the node using either the default\ntransition effect ('fadeIn'), or the given named effect.",

83899

"itemtype": "method",

83900

"name": "toggleView",

83901

"params": [

83902

{

83903

"name": "on",

83904

"description": "An optional boolean value to force the node to be shown or hidden",

83905

"type": "Boolean",

83906

"optional": true

83907

},

83908

{

83909

"name": "callback",

83910

"description": "An optional function to run after the transition completes.",

83911

"type": "Function",

83912

"optional": true

83913

}

83914

],

83915

"chainable": 1,

83916

"class": "Node",

83917

"module": "node",

83918

"submodule": "node-base"

83919

},

83920

{

83921

"file": "node/js/node-view.js",

83922

"line": 80,

83923

"description": "Hides the node.\nIf the \"transition\" module is loaded, hide optionally\nanimates the hiding of the node using either the default\ntransition effect ('fadeOut'), or the given named effect.",

83924

"itemtype": "method",

83925

"name": "hide",

83926

"params": [

83927

{

83928

"name": "name",

83929

"description": "A named Transition effect to use as the show effect.",

83930

"type": "String"

83931

},

83932

{

83933

"name": "config",

83934

"description": "Options to use with the transition.",

83935

"type": "Object"

83936

},

83937

{

83938

"name": "callback",

83939

"description": "An optional function to run after the transition completes.",

83940

"type": "Function"

83941

}

83942

],

83943

"chainable": 1,

83944

"class": "Node",

83945

"module": "node",

83946

"submodule": "node-base"

83947

},

83948

{

83949

"file": "node/js/node-view.js",

83950

"line": 97,

83951

"description": "The implementation for hiding nodes.\nDefault is to toggle the style.display property.",

83952

"itemtype": "method",

83953

"name": "_hide",

83954

"access": "protected",

83955

"tagname": "",

83956

"chainable": 1,

83957

"class": "Node",

83958

"module": "node",

83959

"submodule": "node-base"

83960

},

83961

{

83962

"file": "node/js/node-view.js",

83963

"line": 110,

83964

"description": "Makes each node visible.\nIf the \"transition\" module is loaded, show optionally\nanimates the showing of the node using either the default\ntransition effect ('fadeIn'), or the given named effect.",

83965

"itemtype": "method",

83966

"name": "show",

83967

"params": [

83968

{

83969

"name": "name",

83970

"description": "A named Transition effect to use as the show effect.",

83971

"type": "String"

83972

},

83973

{

83974

"name": "config",

83975

"description": "Options to use with the transition.",

83976

"type": "Object"

83977

},

83978

{

83979

"name": "callback",

83980

"description": "An optional function to run after the transition completes.",

83981

"type": "Function"

83982

}

83983

],

83984

"chainable": 1,

83985

"class": "NodeList",

83986

"module": "node",

83987

"submodule": "node-base"

83988

},

83989

{

83990

"file": "node/js/node-view.js",

83991

"line": 124,

83992

"description": "Hides each node.\nIf the \"transition\" module is loaded, hide optionally\nanimates the hiding of the node using either the default\ntransition effect ('fadeOut'), or the given named effect.",

83993

"itemtype": "method",

83994

"name": "hide",

83995

"params": [

83996

{

83997

"name": "name",

83998

"description": "A named Transition effect to use as the show effect.",

83999

"type": "String"

84000

},

84001

{

84002

"name": "config",

84003

"description": "Options to use with the transition.",

84004

"type": "Object"

84005

},

84006

{

84007

"name": "callback",

84008

"description": "An optional function to run after the transition completes.",

84009

"type": "Function"

84010

}

84011

],

84012

"chainable": 1,

84013

"class": "NodeList",

84014

"module": "node",

84015

"submodule": "node-base"

84016

},

84017

{

84018

"file": "node/js/node-view.js",

84019

"line": 137,

84020

"description": "Displays or hides each node.\nIf the \"transition\" module is loaded, toggleView optionally\nanimates the toggling of the nodes using either the default\ntransition effect ('fadeIn'), or the given named effect.",

84021

"itemtype": "method",

84022

"name": "toggleView",

84023

"params": [

84024

{

84025

"name": "on",

84026

"description": "An optional boolean value to force the nodes to be shown or hidden",

84027

"type": "Boolean",

84028

"optional": true

84029

},

84030

{

84031

"name": "callback",

84032

"description": "An optional function to run after the transition completes.",

84033

"type": "Function",

84034

"optional": true

84035

}

84036

],

84037

"chainable": 1,

84038

"class": "NodeList",

84039

"module": "node",

84040

"submodule": "node-base"

84041

},

84042

{

84043

"file": "node/js/nodelist-array.js",

84044

"line": 9,

84045

"itemtype": "method",

84046

"name": "concat",

84047

"params": [

84048

{

84049

"name": "valueN",

84050

"description": "Arrays/NodeLists and/or values to\nconcatenate to the resulting NodeList",

84051

"type": "NodeList | Array"

84052

}

84053

],

84054

"return": {

84055

"description": "A new NodeList comprised of this NodeList joined with the input.",

84056

"type": "NodeList"

84057

},

84058

"class": "NodeList",

84059

"module": "node",

84060

"submodule": "node-core"

84061

},

84062

{

84063

"file": "node/js/nodelist-array.js",

84064

"line": 17,

84065

"itemtype": "method",

84066

"name": "pop",

84067

"return": {

84068

"description": "The last item in the NodeList.",

84069

"type": "Node"

84070

},

84071

"class": "NodeList",

84072

"module": "node",

84073

"submodule": "node-core"

84074

},

84075

{

84076

"file": "node/js/nodelist-array.js",

84077

"line": 23,

84078

"itemtype": "method",

84079

"name": "push",

84080

"params": [

84081

{

84082

"name": "nodes",

84083

"description": "One or more nodes to add to the end of the NodeList.",

84084

"type": "Node | DOMNode"

84085

}

84086

],

84087

"class": "NodeList",

84088

"module": "node",

84089

"submodule": "node-core"

84090

},

84091

{

84092

"file": "node/js/nodelist-array.js",

84093

"line": 29,

84094

"itemtype": "method",

84095

"name": "shift",

84096

"return": {

84097

"description": "The first item in the NodeList.",

84098

"type": "Node"

84099

},

84100

"class": "NodeList",

84101

"module": "node",

84102

"submodule": "node-core"

84103

},

84104

{

84105

"file": "node/js/nodelist-array.js",

84106

"line": 35,

84107

"itemtype": "method",

84108

"name": "slice",

84109

"params": [

84110

{

84111

"name": "begin",

84112

"description": "Zero-based index at which to begin extraction.\n As a negative index, start indicates an offset from the end of the sequence. slice(-2) extracts the second-to-last element and the last element in the sequence.",

84113

"type": "Number"

84114

},

84115

{

84116

"name": "end",

84117

"description": "Zero-based index at which to end extraction. slice extracts up to but not including end.\n slice(1,4) extracts the second element through the fourth element (elements indexed 1, 2, and 3).\n As a negative index, end indicates an offset from the end of the sequence. slice(2,-1) extracts the third element through the second-to-last element in the sequence.\n If end is omitted, slice extracts to the end of the sequence.",

84118

"type": "Number"

84119

}

84120

],

84121

"return": {

84122

"description": "A new NodeList comprised of this NodeList joined with the input.",

84123

"type": "NodeList"

84124

},

84125

"class": "NodeList",

84126

"module": "node",

84127

"submodule": "node-core"

84128

},

84129

{

84130

"file": "node/js/nodelist-array.js",

84131

"line": 47,

84132

"itemtype": "method",

84133

"name": "splice",

84134

"params": [

84135

{

84136

"name": "index",

84137

"description": "Index at which to start changing the array. If negative, will begin that many elements from the end.",

84138

"type": "Number"

84139

},

84140

{

84141

"name": "howMany",

84142

"description": "An integer indicating the number of old array elements to remove. If howMany is 0, no elements are removed. In this case, you should specify at least one new element. If no howMany parameter is specified (second syntax above, which is a SpiderMonkey extension), all elements after index are removed.\n{Node | DOMNode| element1, ..., elementN\n The elements to add to the array. If you don't specify any elements, splice simply removes elements from the array.",

84143

"type": "Number"

84144

}

84145

],

84146

"return": {

84147

"description": "The element(s) removed.",

84148

"type": "NodeList"

84149

},

84150

"class": "NodeList",

84151

"module": "node",

84152

"submodule": "node-core"

84153

},

84154

{

84155

"file": "node/js/nodelist-array.js",

84156

"line": 57,

84157

"itemtype": "method",

84158

"name": "unshift",

84159

"params": [

84160

{

84161

"name": "nodes",

84162

"description": "One or more nodes to add to the NodeList.",

84163

"type": "Node | DOMNode"

84164

}

84165

],

84166

"class": "NodeList",

84167

"module": "node",

84168

"submodule": "node-core"

84169

},

84170

{

84171

"file": "node/js/nodelist.js",

84172

"line": 39,

84173

"description": "The underlying array of DOM nodes bound to the Y.NodeList instance",

84174

"itemtype": "property",

84175

"name": "_nodes",

84176

"access": "private",

84177

"tagname": "",

84178

"class": "NodeList",

84179

"module": "node",

84180

"submodule": "node-core"

84181

},

84182

{

84183

"file": "node/js/nodelist.js",

84184

"line": 49,

84185

"description": "Retrieves the DOM nodes bound to a NodeList instance",

84186

"itemtype": "method",

84187

"name": "getDOMNodes",

84188

"static": 1,

84189

"params": [

84190

{

84191

"name": "nodelist",

84192

"description": "The NodeList instance",

84193

"type": "NodeList"

84194

}

84195

],

84196

"return": {

84197

"description": "The array of DOM nodes bound to the NodeList",

84198

"type": "Array"

84199

},

84200

"class": "NodeList",

84201

"module": "node",

84202

"submodule": "node-core"

84203

},

84204

{

84205

"file": "node/js/nodelist.js",

84206

"line": 137,

84207

"description": "Retrieves the Node instance at the given index.",

84208

"itemtype": "method",

84209

"name": "item",

84210

"params": [

84211

{

84212

"name": "index",

84213

"description": "The index of the target Node.",

84214

"type": "Number"

84215

}

84216

],

84217

"return": {

84218

"description": "The Node instance at the given index.",

84219

"type": "Node"

84220

},

84221

"class": "NodeList",

84222

"module": "node",

84223

"submodule": "node-core"

84224

},

84225

{

84226

"file": "node/js/nodelist.js",

84227

"line": 148,

84228

"description": "Applies the given function to each Node in the NodeList.",

84229

"itemtype": "method",

84230

"name": "each",

84231

"params": [

84232

{

84233

"name": "fn",

84234

"description": "The function to apply. It receives 3 arguments:\nthe current node instance, the node's index, and the NodeList instance",

84235

"type": "Function"

84236

},

84237

{

84238

"name": "context",

84239

"description": "optional An optional context to apply the function with\nDefault context is the current Node instance",

84240

"type": "Object"

84241

}

84242

],

84243

"chainable": 1,

84244

"class": "NodeList",

84245

"module": "node",

84246

"submodule": "node-core"

84247

},

84248

{

84249

"file": "node/js/nodelist.js",

84250

"line": 180,

84251

"description": "Executes the function once for each node until a true value is returned.",

84252

"itemtype": "method",

84253

"name": "some",

84254

"params": [

84255

{

84256

"name": "fn",

84257

"description": "The function to apply. It receives 3 arguments:\nthe current node instance, the node's index, and the NodeList instance",

84258

"type": "Function"

84259

},

84260

{

84261

"name": "context",

84262

"description": "optional An optional context to execute the function from.\nDefault context is the current Node instance",

84263

"type": "Object"

84264

}

84265

],

84266

"return": {

84267

"description": "Whether or not the function returned true for any node.",

84268

"type": "Boolean"

84269

},

84270

"class": "NodeList",

84271

"module": "node",

84272

"submodule": "node-core"

84273

},

84274

{

84275

"file": "node/js/nodelist.js",

84276

"line": 198,

84277

"description": "Creates a documenFragment from the nodes bound to the NodeList instance",

84278

"itemtype": "method",

84279

"name": "toFrag",

84280

"return": {

84281

"description": "a Node instance bound to the documentFragment",

84282

"type": "Node"

84283

},

84284

"class": "NodeList",

84285

"module": "node",

84286

"submodule": "node-core"

84287

},

84288

{

84289

"file": "node/js/nodelist.js",

84290

"line": 207,

84291

"description": "Returns the index of the node in the NodeList instance\nor -1 if the node isn't found.",

84292

"itemtype": "method",

84293

"name": "indexOf",

84294

"params": [

84295

{

84296

"name": "node",

84297

"description": "the node to search for",

84298

"type": "Node | DOMNode"

84299

}

84300

],

84301

"return": {

84302

"description": "the index of the node value or -1 if not found",

84303

"type": "Int"

84304

},

84305

"class": "NodeList",

84306

"module": "node",

84307

"submodule": "node-core"

84308

},

84309

{

84310

"file": "node/js/nodelist.js",

84311

"line": 218,

84312

"description": "Filters the NodeList instance down to only nodes matching the given selector.",

84313

"itemtype": "method",

84314

"name": "filter",

84315

"params": [

84316

{

84317

"name": "selector",

84318

"description": "The selector to filter against",

84319

"type": "String"

84320

}

84321

],

84322

"return": {

84323

"description": "NodeList containing the updated collection",

84324

"type": "NodeList"

84325

},

84326

"see": [

84327

"Selector"

84328

],

84329

"class": "NodeList",

84330

"module": "node",

84331

"submodule": "node-core"

84332

},

84333

{

84334

"file": "node/js/nodelist.js",

84335

"line": 230,

84336

"description": "Creates a new NodeList containing all nodes at every n indices, where\nremainder n % index equals r.\n(zero-based index).",

84337

"itemtype": "method",

84338

"name": "modulus",

84339

"params": [

84340

{

84341

"name": "n",

84342

"description": "The offset to use (return every nth node)",

84343

"type": "Int"

84344

},

84345

{

84346

"name": "r",

84347

"description": "An optional remainder to use with the modulus operation (defaults to zero)",

84348

"type": "Int"

84349

}

84350

],

84351

"return": {

84352

"description": "NodeList containing the updated collection",

84353

"type": "NodeList"

84354

},

84355

"class": "NodeList",

84356

"module": "node",

84357

"submodule": "node-core"

84358

},

84359

{

84360

"file": "node/js/nodelist.js",

84361

"line": 251,

84362

"description": "Creates a new NodeList containing all nodes at odd indices\n(zero-based index).",

84363

"itemtype": "method",

84364

"name": "odd",

84365

"return": {

84366

"description": "NodeList containing the updated collection",

84367

"type": "NodeList"

84368

},

84369

"class": "NodeList",

84370

"module": "node",

84371

"submodule": "node-core"

84372

},

84373

{

84374

"file": "node/js/nodelist.js",

84375

"line": 261,

84376

"description": "Creates a new NodeList containing all nodes at even indices\n(zero-based index), including zero.",

84377

"itemtype": "method",

84378

"name": "even",

84379

"return": {

84380

"description": "NodeList containing the updated collection",

84381

"type": "NodeList"

84382

},

84383

"class": "NodeList",

84384

"module": "node",

84385

"submodule": "node-core"

84386

},

84387

{

84388

"file": "node/js/nodelist.js",

84389

"line": 274,

84390

"description": "Reruns the initial query, when created using a selector query",

84391

"itemtype": "method",

84392

"name": "refresh",

84393

"chainable": 1,

84394

"class": "NodeList",

84395

"module": "node",

84396

"submodule": "node-core"

84397

},

84398

{

84399

"file": "node/js/nodelist.js",

84400

"line": 298,

84401

"description": "Returns the current number of items in the NodeList.",

84402

"itemtype": "method",

84403

"name": "size",

84404

"return": {

84405

"description": "The number of items in the NodeList.",

84406

"type": "Int"

84407

},

84408

"class": "NodeList",

84409

"module": "node",

84410

"submodule": "node-core"

84411

},

84412

{

84413

"file": "node/js/nodelist.js",

84414

"line": 307,

84415

"description": "Determines if the instance is bound to any nodes",

84416

"itemtype": "method",

84417

"name": "isEmpty",

84418

"return": {

84419

"description": "Whether or not the NodeList is bound to any nodes",

84420

"type": "Boolean"

84421

},

84422

"class": "NodeList",

84423

"module": "node",

84424

"submodule": "node-core"

84425

},

84426

{

84427

"file": "node/js/nodelist.js",

84428

"line": 340,

84429

"description": "Returns the DOM node bound to the Node instance",

84430

"itemtype": "method",

84431

"name": "getDOMNodes",

84432

"return": {

84433

"description": "",

84434

"type": "Array"

84435

},

84436

"class": "NodeList",

84437

"module": "node",

84438

"submodule": "node-core"

84439

},

84440

{

84441

"file": "node/js/nodelist.js",

84442

"line": 351,

84443

"description": "Called on each Node instance. Nulls internal node references, \nremoves any plugins and event listeners",

84444

"itemtype": "method",

84445

"name": "destroy",

84446

"params": [

84447

{

84448

"name": "recursivePurge",

84449

"description": "(optional) Whether or not to \nremove listeners from the node's subtree (default is false)",

84450

"type": "Boolean"

84451

}

84452

],

84453

"see": [

84454

"Node.destroy"

84455

],

84456

"class": "NodeList",

84457

"module": "node",

84458

"submodule": "node-core"

84459

},

84460

{

84461

"file": "node/js/nodelist.js",

84462

"line": 361,

84463

"description": "Called on each Node instance. Removes and destroys all of the nodes \nwithin the node",

84464

"itemtype": "method",

84465

"name": "empty",

84466

"chainable": 1,

84467

"see": [

84468

"Node.empty"

84469

],

84470

"class": "NodeList",

84471

"module": "node",

84472

"submodule": "node-core"

84473

},

84474

{

84475

"file": "node/js/nodelist.js",

84476

"line": 370,

84477

"description": "Called on each Node instance. Removes the node from its parent.\nShortcut for myNode.get('parentNode').removeChild(myNode);",

84478

"itemtype": "method",

84479

"name": "remove",

84480

"params": [

84481

{

84482

"name": "destroy",

84483

"description": "whether or not to call destroy() on the node\nafter removal.",

84484

"type": "Boolean"

84485

}

84486

],

84487

"chainable": 1,

84488

"see": [

84489

"Node.remove"

84490

],

84491

"class": "NodeList",

84492

"module": "node",

84493

"submodule": "node-core"

84494

},

84495

{

84496

"file": "node/js/nodelist.js",

84497

"line": 381,

84498

"description": "Called on each Node instance. Sets an attribute on the Node instance.\nUnless pre-configured (via Node.ATTRS), set hands\noff to the underlying DOM node. Only valid\nattributes/properties for the node will be set.\nTo set custom attributes use setAttribute.",

84499

"itemtype": "method",

84500

"name": "set",

84501

"params": [

84502

{

84503

"name": "attr",

84504

"description": "The attribute to be set.",

84505

"type": "String"

84506

},

84507

{

84508

"name": "val",

84509

"description": "The value to set the attribute to.",

84510

"type": "Any"

84511

}

84512

],

84513

"chainable": 1,

84514

"see": [

84515

"Node.set"

84516

],

84517

"class": "NodeList",

84518

"module": "node",

84519

"submodule": "node-core"

84520

},

84521

{

84522

"file": "node/js/nodelist.js",

84523

"line": 399,

84524

"itemtype": "method",

84525

"name": "get",

84526

"see": [

84527

"Node"

84528

],

84529

"class": "NodeList",

84530

"module": "node",

84531

"submodule": "node-core"

84532

},

84533

{

84534

"file": "node/js/shim-plugin.js",

84535

"line": 17,

84536

"description": "Default class used to mark the shim element",

84537

"itemtype": "property",

84538

"name": "CLASS_NAME",

84539

"type": "String",

84540

"static": 1,

84541

"default": "\"yui-node-shim\"",

84542

"class": "Plugin.Shim",

84543

"module": "shim-plugin"

84544

},

84545

{

84546

"file": "node/js/shim-plugin.js",

84547

"line": 28,

84548

"description": "Default markup template used to generate the shim element.",

84549

"itemtype": "property",

84550

"name": "TEMPLATE",

84551

"type": "String",

84552

"static": 1,

84553

"class": "Plugin.Shim",

84554

"module": "shim-plugin"

84555

},

84556

{

84557

"file": "node/js/shim-plugin.js",

84558

"line": 67,

84559

"description": "Updates the size of the shim to fill its container",

84560

"itemtype": "method",

84561

"name": "sync",

84562

"class": "Plugin.Shim",

84563

"module": "shim-plugin"

84564

},

84565

{

84566

"file": "node/js/shim-plugin.js",

84567

"line": 83,

84568

"description": "Removes the shim and destroys the plugin",

84569

"itemtype": "method",

84570

"name": "destroy",

84571

"class": "Plugin.Shim",

84572

"module": "shim-plugin"

84573

},

84574

{

84575

"file": "oop/js/oop.js",

84576

"line": 31,

84577

"description": "Augments the _receiver_ with prototype properties from the _supplier_. The\nreceiver may be a constructor function or an object. The supplier must be a\nconstructor function.\n\nIf the _receiver_ is an object, then the _supplier_ constructor will be called\nimmediately after _receiver_ is augmented, with _receiver_ as the `this` object.\n\nIf the _receiver_ is a constructor function, then all prototype methods of\n_supplier_ that are copied to _receiver_ will be sequestered, and the\n_supplier_ constructor will not be called immediately. The first time any\nsequestered method is called on the _receiver_'s prototype, all sequestered\nmethods will be immediately copied to the _receiver_'s prototype, the\n_supplier_'s constructor will be executed, and finally the newly unsequestered\nmethod that was called will be executed.\n\nThis sequestering logic sounds like a bunch of complicated voodoo, but it makes\nit cheap to perform frequent augmentation by ensuring that suppliers'\nconstructors are only called if a supplied method is actually used. If none of\nthe supplied methods is ever used, then there's no need to take the performance\nhit of calling the _supplier_'s constructor.",

84578

"itemtype": "method",

84579

"name": "augment",

84580

"params": [

84581

{

84582

"name": "receiver",

84583

"description": "Object or function to be augmented.",

84584

"type": "Function|Object"

84585

},

84586

{

84587

"name": "supplier",

84588

"description": "Function that supplies the prototype properties with\n which to augment the _receiver_.",

84589

"type": "Function"

84590

},

84591

{

84592

"name": "overwrite",

84593

"description": "If `true`, properties already on the receiver\n will be overwritten if found on the supplier's prototype.",

84594

"type": "Boolean",

84595

"optional": true,

84596

"optdefault": "false"

84597

},

84598

{

84599

"name": "whitelist",

84600

"description": "An array of property names. If specified,\n only the whitelisted prototype properties will be applied to the receiver, and\n all others will be ignored.",

84601

"type": "String[]",

84602

"optional": true

84603

},

84604

{

84605

"name": "args",

84606

"description": "Argument or array of arguments to pass to the\n supplier's constructor when initializing.",

84607

"type": "Array|any",

84608

"optional": true

84609

}

84610

],

84611

"return": {

84612

"description": "Augmented object.",

84613

"type": "Function"

84614

},

84615

"class": "YUI",

84616

"module": "oop"

84617

},

84618

{

84619

"file": "oop/js/oop.js",

84620

"line": 137,

84621

"description": "Copies object properties from the supplier to the receiver. If the target has\nthe property, and the property is an object, the target object will be\naugmented with the supplier's value.",

84622

"itemtype": "method",

84623

"name": "aggregate",

84624

"params": [

84625

{

84626

"name": "receiver",

84627

"description": "Object to receive the augmentation.",

84628

"type": "Object"

84629

},

84630

{

84631

"name": "supplier",

84632

"description": "Object that supplies the properties with which to\n augment the receiver.",

84633

"type": "Object"

84634

},

84635

{

84636

"name": "overwrite",

84637

"description": "If `true`, properties already on the receiver\n will be overwritten if found on the supplier.",

84638

"type": "Boolean",

84639

"optional": true,

84640

"optdefault": "false"

84641

},

84642

{

84643

"name": "whitelist",

84644

"description": "Whitelist. If supplied, only properties in this\n list will be applied to the receiver.",

84645

"type": "String[]",

84646

"optional": true

84647

}

84648

],

84649

"return": {

84650

"description": "Augmented object.",

84651

"type": "Object"

84652

},

84653

"class": "YUI",

84654

"module": "oop"

84655

},

84656

{

84657

"file": "oop/js/oop.js",

84658

"line": 156,

84659

"description": "Utility to set up the prototype, constructor and superclass properties to\nsupport an inheritance strategy that can chain constructors and methods.\nStatic members will not be inherited.",

84660

"itemtype": "method",

84661

"name": "extend",

84662

"params": [

84663

{

84664

"name": "r",

84665

"description": "the object to modify.",

84666

"type": "Function"

84667

},

84668

{

84669

"name": "s",

84670

"description": "the object to inherit.",

84671

"type": "Function"

84672

},

84673

{

84674

"name": "px",

84675

"description": "prototype properties to add/override.",

84676

"type": "Object"

84677

},

84678

{

84679

"name": "sx",

84680

"description": "static properties to add/override.",

84681

"type": "Object"

84682

}

84683

],

84684

"return": {

84685

"description": "the extended object.",

84686

"type": "Object"

84687

},

84688

"class": "YUI",

84689

"module": "oop"

84690

},

84691

{

84692

"file": "oop/js/oop.js",

84693

"line": 197,

84694

"description": "Executes the supplied function for each item in\na collection. Supports arrays, objects, and\nNodeLists",

84695

"itemtype": "method",

84696

"name": "each",

84697

"params": [

84698

{

84699

"name": "o",

84700

"description": "the object to iterate.",

84701

"type": "Object"

84702

},

84703

{

84704

"name": "f",

84705

"description": "the function to execute. This function\nreceives the value, key, and object as parameters.",

84706

"type": "Function"

84707

},

84708

{

84709

"name": "c",

84710

"description": "the execution context for the function.",

84711

"type": "Object"

84712

},

84713

{

84714

"name": "proto",

84715

"description": "if true, prototype properties are\niterated on objects.",

84716

"type": "Boolean"

84717

}

84718

],

84719

"return": {

84720

"description": "the YUI instance.",

84721

"type": "YUI"

84722

},

84723

"class": "YUI",

84724

"module": "oop"

84725

},

84726

{

84727

"file": "oop/js/oop.js",

84728

"line": 214,

84729

"description": "Executes the supplied function for each item in\na collection. The operation stops if the function\nreturns true. Supports arrays, objects, and\nNodeLists.",

84730

"itemtype": "method",

84731

"name": "some",

84732

"params": [

84733

{

84734

"name": "o",

84735

"description": "the object to iterate.",

84736

"type": "Object"

84737

},

84738

{

84739

"name": "f",

84740

"description": "the function to execute. This function\nreceives the value, key, and object as parameters.",

84741

"type": "Function"

84742

},

84743

{

84744

"name": "c",

84745

"description": "the execution context for the function.",

84746

"type": "Object"

84747

},

84748

{

84749

"name": "proto",

84750

"description": "if true, prototype properties are\niterated on objects.",

84751

"type": "Boolean"

84752

}

84753

],

84754

"return": {

84755

"description": "true if the function ever returns true,\nfalse otherwise.",

84756

"type": "Boolean"

84757

},

84758

"class": "YUI",

84759

"module": "oop"

84760

},

84761

{

84762

"file": "oop/js/oop.js",

84763

"line": 233,

84764

"description": "Deep object/array copy. Function clones are actually\nwrappers around the original function.\nArray-like objects are treated as arrays.\nPrimitives are returned untouched. Optionally, a\nfunction can be provided to handle other data types,\nfilter keys, validate values, etc.",

84765

"itemtype": "method",

84766

"name": "clone",

84767

"params": [

84768

{

84769

"name": "o",

84770

"description": "what to clone.",

84771

"type": "Object"

84772

},

84773

{

84774

"name": "safe",

84775

"description": "if true, objects will not have prototype\nitems from the source. If false, they will. In this case, the\noriginal is initially protected, but the clone is not completely\nimmune from changes to the source object prototype. Also, cloned\nprototype items that are deleted from the clone will result\nin the value of the source prototype being exposed. If operating\non a non-safe clone, items should be nulled out rather than deleted.",

84776

"type": "Boolean"

84777

},

84778

{

84779

"name": "f",

84780

"description": "optional function to apply to each item in a\ncollection; it will be executed prior to applying the value to\nthe new object. Return false to prevent the copy.",

84781

"type": "Function"

84782

},

84783

{

84784

"name": "c",

84785

"description": "optional execution context for f.",

84786

"type": "Object"

84787

},

84788

{

84789

"name": "owner",

84790

"description": "Owner object passed when clone is iterating\nan object. Used to set up context for cloned functions.",

84791

"type": "Object"

84792

},

84793

{

84794

"name": "cloned",

84795

"description": "hash of previously cloned objects to avoid\nmultiple clones.",

84796

"type": "Object"

84797

}

84798

],

84799

"return": {

84800

"description": "the cloned object.",

84801

"type": "Array|Object"

84802

},

84803

"class": "YUI",

84804

"module": "oop"

84805

},

84806

{

84807

"file": "oop/js/oop.js",

84808

"line": 338,

84809

"description": "Returns a function that will execute the supplied function in the\nsupplied object's context, optionally adding any additional\nsupplied parameters to the beginning of the arguments collection the\nsupplied to the function.",

84810

"itemtype": "method",

84811

"name": "bind",

84812

"params": [

84813

{

84814

"name": "f",

84815

"description": "the function to bind, or a function name\nto execute on the context object.",

84816

"type": "Function|String"

84817

},

84818

{

84819

"name": "c",

84820

"description": "the execution context.",

84821

"type": "Object"

84822

},

84823

{

84824

"name": "args",

84825

"description": "0..n arguments to include before the arguments the\nfunction is executed with.",

84826

"type": "Any",

84827

"multiple": true

84828

}

84829

],

84830

"return": {

84831

"description": "the wrapped function.",

84832

"type": "Function"

84833

},

84834

"class": "YUI",

84835

"module": "oop"

84836

},

84837

{

84838

"file": "oop/js/oop.js",

84839

"line": 363,

84840

"description": "Returns a function that will execute the supplied function in the\nsupplied object's context, optionally adding any additional\nsupplied parameters to the end of the arguments the function\nis executed with.",

84841

"itemtype": "method",

84842

"name": "rbind",

84843

"params": [

84844

{

84845

"name": "f",

84846

"description": "the function to bind, or a function name\nto execute on the context object.",

84847

"type": "Function|String"

84848

},

84849

{

84850

"name": "c",

84851

"description": "the execution context.",

84852

"type": "Object"

84853

},

84854

{

84855

"name": "args",

84856

"description": "0..n arguments to append to the end of\narguments collection supplied to the function.",

84857

"type": "Any",

84858

"multiple": true

84859

}

84860

],

84861

"return": {

84862

"description": "the wrapped function.",

84863

"type": "Function"

84864

},

84865

"class": "YUI",

84866

"module": "oop"

84867

},

84868

{

84869

"file": "panel/js/panel.js",

84870

"line": 49,

84871

"description": "Collection of predefined buttons mapped from name => config.\n\nPanel includes a \"close\" button which can be use by name. When the close\nbutton is in the header (which is the default), it will look like: [x].\n\nSee `addButton()` for a list of possible configuration values.",

84872

"example": [

84873

"\n // Panel with close button in header.\n var panel = new Y.Panel({\n buttons: ['close']\n });\n\n // Panel with close button in footer.\n var otherPanel = new Y.Panel({\n buttons: {\n footer: ['close']\n }\n });"

84874

],

84875

"itemtype": "property",

84876

"name": "BUTTONS",

84877

"type": "Object",

84878

"default": "{close: {}}",

84879

"since": "3.5.0",

84880

"class": "Panel",

84881

"module": "panel"

84882

},

84883

{

84884

"file": "parallel/js/parallel.js",

84885

"line": 43,

84886

"description": "An Array of results from all the callbacks in the stack",

84887

"itemtype": "property",

84888

"name": "results",

84889

"type": "Array",

84890

"class": "Parallel",

84891

"module": "parallel"

84892

},

84893

{

84894

"file": "parallel/js/parallel.js",

84895

"line": 50,

84896

"description": "The total items in the stack",

84897

"itemtype": "property",

84898

"name": "total",

84899

"type": "Number",

84900

"class": "Parallel",

84901

"module": "parallel"

84902

},

84903

{

84904

"file": "parallel/js/parallel.js",

84905

"line": 56,

84906

"description": "The number of stacked callbacks executed",

84907

"itemtype": "property",

84908

"name": "finished",

84909

"type": "Number",

84910

"class": "Parallel",

84911

"module": "parallel"

84912

},

84913

{

84914

"file": "parallel/js/parallel.js",

84915

"line": 62,

84916

"description": "Add a callback to the stack",

84917

"itemtype": "method",

84918

"name": "add",

84919

"params": [

84920

{

84921

"name": "fn",

84922

"description": "The function callback we are waiting for",

84923

"type": "Function"

84924

}

84925

],

84926

"class": "Parallel",

84927

"module": "parallel"

84928

},

84929

{

84930

"file": "parallel/js/parallel.js",

84931

"line": 76,

84932

"description": "Test to see if all registered items in the stack have completed, if so call the callback to `done`",

84933

"itemtype": "method",

84934

"name": "test",

84935

"class": "Parallel",

84936

"module": "parallel"

84937

},

84938

{

84939

"file": "parallel/js/parallel.js",

84940

"line": 86,

84941

"description": "The method to call when all the items in the stack are complete.",

84942

"itemtype": "method",

84943

"name": "done",

84944

"params": [

84945

{

84946

"name": "callback",

84947

"description": "The callback to execute on complete",

84948

"type": "Function",

84949

"props": [

84950

{

84951

"name": "results",

84952

"description": "The results of all the callbacks in the stack",

84953

"type": "Mixed"

84954

},

84955

{

84956

"name": "data",

84957

"description": "The data given to the `done` method",

84958

"type": "Mixed",

84959

"optional": true

84960

}

84961

]

84962

},

84963

{

84964

"name": "data",

84965

"description": "Mixed data to pass to the success callback",

84966

"type": "Mixed"

84967

}

84968

],

84969

"class": "Parallel",

84970

"module": "parallel"

84971

},

84972

{

84973

"file": "pjax/js/pjax-base.js",

84974

"line": 18,

84975

"description": "Fired when navigating to a URL via Pjax.\n\nWhen the `navigate()` method is called or a pjax link is clicked, this event\nwill be fired if the browser supports HTML5 history _and_ the router has a\nroute handler for the specified URL.\n\nThis is a useful event to listen to for adding a visual loading indicator\nwhile the route handlers are busy handling the URL change.",

84976

"itemtype": "event",

84977

"name": "navigate",

84978

"params": [

84979

{

84980

"name": "url",

84981

"description": "The URL that the router will dispatch to its route\n handlers in order to fulfill the enhanced navigation \"request\".",

84982

"type": "String"

84983

},

84984

{

84985

"name": "force",

84986

"description": "Whether the enhanced navigation should occur\n even in browsers without HTML5 history.",

84987

"type": "Boolean",

84988

"optional": true,

84989

"optdefault": "false"

84990

},

84991

{

84992

"name": "hash",

84993

"description": "The hash-fragment (including \"#\") of the `url`. This\n will be present when the `url` differs from the current URL only by its\n hash and `navigateOnHash` has ben set to `true`.",

84994

"type": "String",

84995

"optional": true

84996

},

84997

{

84998

"name": "originEvent",

84999

"description": "The event that caused the navigation. Usually\n this would be a click event from a \"pjax\" anchor element.",

85000

"type": "Event",

85001

"optional": true

85002

},

85003

{

85004

"name": "replace",

85005

"description": "Whether or not the current history entry will be\n replaced, or a new entry will be created. Will default to `true` if the\n specified `url` is the same as the current URL.",

85006

"type": "Boolean",

85007

"optional": true

85008

}

85009

],

85010

"since": "3.5.0",

85011

"class": "PjaxBase",

85012

"module": "pjax",

85013

"submodule": "pjax-base"

85014

},

85015

{

85016

"file": "pjax/js/pjax-base.js",

85017

"line": 71,

85018

"description": "Holds the delegated pjax-link click handler.",

85019

"itemtype": "property",

85020

"name": "_pjaxEvents",

85021

"type": "EventHandle",

85022

"access": "protected",

85023

"tagname": "",

85024

"since": "3.5.0",

85025

"class": "PjaxBase",

85026

"module": "pjax",

85027

"submodule": "pjax-base"

85028

},

85029

{

85030

"file": "pjax/js/pjax-base.js",

85031

"line": 80,

85032

"description": "Regex used to break up a URL string around the URL's path.\n\nSubpattern captures:\n\n 1. Origin, everything before the URL's path-part.\n 2. The URL's path-part.\n 3. Suffix, everything after the URL's path-part.",

85033

"itemtype": "property",

85034

"name": "_regexURL",

85035

"type": "RegExp",

85036

"access": "protected",

85037

"tagname": "",

85038

"since": "3.5.0",

85039

"class": "PjaxBase",

85040

"module": "pjax",

85041

"submodule": "pjax-base"

85042

},

85043

{

85044

"file": "pjax/js/pjax-base.js",

85045

"line": 114,

85046

"description": "Navigates to the specified URL if there is a route handler that matches. In\nbrowsers capable of using HTML5 history, the navigation will be enhanced by\nfiring the `navigate` event and having the router handle the \"request\".\nNon-HTML5 browsers will navigate to the new URL via manipulation of\n`window.location`.\n\nWhen there is a route handler for the specified URL and it is being\nnavigated to, this method will return `true`, otherwise it will return\n`false`.\n\n**Note:** The specified URL _must_ be of the same origin as the current URL,\notherwise an error will be logged and navigation will not occur. This is\nintended as both a security constraint and a purposely imposed limitation as\nit does not make sense to tell the router to navigate to a URL on a\ndifferent scheme, host, or port.",

85047

"itemtype": "method",

85048

"name": "navigate",

85049

"params": [

85050

{

85051

"name": "url",

85052

"description": "The URL to navigate to. This must be of the same origin\n as the current URL.",

85053

"type": "String"

85054

},

85055

{

85056

"name": "options",

85057

"description": "Additional options to configure the navigation.\n These are mixed into the `navigate` event facade.",

85058

"type": "Object",

85059

"optional": true,

85060

"props": [

85061

{

85062

"name": "replace",

85063

"description": "Whether or not the current history\n entry will be replaced, or a new entry will be created. Will default\n to `true` if the specified `url` is the same as the current URL.",

85064

"type": "Boolean",

85065

"optional": true

85066

},

85067

{

85068

"name": "force",

85069

"description": "Whether the enhanced navigation\n should occur even in browsers without HTML5 history.",

85070

"type": "Boolean",

85071

"optional": true,

85072

"optdefault": "false"

85073

}

85074

]

85075

}

85076

],

85077

"return": {

85078

"description": "`true` if the URL was navigated to, `false` otherwise.",

85079

"type": "Boolean"

85080

},

85081

"since": "3.5.0",

85082

"class": "PjaxBase",

85083

"module": "pjax",

85084

"submodule": "pjax-base"

85085

},

85086

{

85087

"file": "pjax/js/pjax-base.js",

85088

"line": 161,

85089

"description": "Returns the current path root after popping off the last path segment,\nmaking it useful for resolving other URL paths against.\n\nThe path root will always begin and end with a '/'.",

85090

"itemtype": "method",

85091

"name": "_getRoot",

85092

"return": {

85093

"description": "The URL's path root.",

85094

"type": "String"

85095

},

85096

"access": "protected",

85097

"tagname": "",

85098

"since": "3.5.0",

85099

"class": "PjaxBase",

85100

"module": "pjax",

85101

"submodule": "pjax-base"

85102

},

85103

{

85104

"file": "pjax/js/pjax-base.js",

85105

"line": 187,

85106

"description": "Underlying implementation for `navigate()`.",

85107

"itemtype": "method",

85108

"name": "_navigate",

85109

"params": [

85110

{

85111

"name": "url",

85112

"description": "The fully-resolved URL that the router should dispatch\n to its route handlers to fulfill the enhanced navigation \"request\", or use\n to update `window.location` in non-HTML5 history capable browsers.",

85113

"type": "String"

85114

},

85115

{

85116

"name": "options",

85117

"description": "Additional options to configure the navigation.\n These are mixed into the `navigate` event facade.",

85118

"type": "Object",

85119

"optional": true,

85120

"props": [

85121

{

85122

"name": "replace",

85123

"description": "Whether or not the current history\n entry will be replaced, or a new entry will be created. Will default\n to `true` if the specified `url` is the same as the current URL.",

85124

"type": "Boolean",

85125

"optional": true

85126

},

85127

{

85128

"name": "force",

85129

"description": "Whether the enhanced navigation\n should occur even in browsers without HTML5 history.",

85130

"type": "Boolean",

85131

"optional": true,

85132

"optdefault": "false"

85133

}

85134

]

85135

}

85136

],

85137

"return": {

85138

"description": "`true` if the URL was navigated to, `false` otherwise.",

85139

"type": "Boolean"

85140

},

85141

"access": "protected",

85142

"tagname": "",

85143

"since": "3.5.0",

85144

"class": "PjaxBase",

85145

"module": "pjax",

85146

"submodule": "pjax-base"

85147

},

85148

{

85149

"file": "pjax/js/pjax-base.js",

85150

"line": 254,

85151

"description": "Returns a normalized path, ridding it of any '..' segments and properly\nhandling leading and trailing slashes.",

85152

"itemtype": "method",

85153

"name": "_normalizePath",

85154

"params": [

85155

{

85156

"name": "path",

85157

"description": "URL path to normalize.",

85158

"type": "String"

85159

}

85160

],

85161

"return": {

85162

"description": "Normalized path.",

85163

"type": "String"

85164

},

85165

"access": "protected",

85166

"tagname": "",

85167

"since": "3.5.0",

85168

"class": "PjaxBase",

85169

"module": "pjax",

85170

"submodule": "pjax-base"

85171

},

85172

{

85173

"file": "pjax/js/pjax-base.js",

85174

"line": 296,

85175

"description": "Binds the delegation of link-click events that match the `linkSelector` to\nthe `_onLinkClick()` handler.\n\nBy default this method will only be called if the browser is capable of\nusing HTML5 history.",

85176

"itemtype": "method",

85177

"name": "_pjaxBindUI",

85178

"access": "protected",

85179

"tagname": "",

85180

"since": "3.5.0",

85181

"class": "PjaxBase",

85182

"module": "pjax",

85183

"submodule": "pjax-base"

85184

},

85185

{

85186

"file": "pjax/js/pjax-base.js",

85187

"line": 315,

85188

"description": "Returns the normalized result of resolving the `path` against the current\npath. Falsy values for `path` will return just the current path.",

85189

"itemtype": "method",

85190

"name": "_resolvePath",

85191

"params": [

85192

{

85193

"name": "path",

85194

"description": "URL path to resolve.",

85195

"type": "String"

85196

}

85197

],

85198

"return": {

85199

"description": "Resolved path.",

85200

"type": "String"

85201

},

85202

"access": "protected",

85203

"tagname": "",

85204

"since": "3.5.0",

85205

"class": "PjaxBase",

85206

"module": "pjax",

85207

"submodule": "pjax-base"

85208

},

85209

{

85210

"file": "pjax/js/pjax-base.js",

85211

"line": 339,

85212

"description": "Resolves the specified URL against the current URL.\n\nThis method resolves URLs like a browser does and will always return an\nabsolute URL. When the specified URL is already absolute, it is assumed to\nbe fully resolved and is simply returned as is. Scheme-relative URLs are\nprefixed with the current protocol. Relative URLs are giving the current\nURL's origin and are resolved and normalized against the current path root.",

85213

"itemtype": "method",

85214

"name": "_resolveURL",

85215

"params": [

85216

{

85217

"name": "url",

85218

"description": "URL to resolve.",

85219

"type": "String"

85220

}

85221

],

85222

"return": {

85223

"description": "Resolved URL.",

85224

"type": "String"

85225

},

85226

"access": "protected",

85227

"tagname": "",

85228

"since": "3.5.0",

85229

"class": "PjaxBase",

85230

"module": "pjax",

85231

"submodule": "pjax-base"

85232

},

85233

{

85234

"file": "pjax/js/pjax-base.js",

85235

"line": 392,

85236

"description": "Default handler for the `navigate` event.\n\nAdds a new history entry or replaces the current entry for the specified URL\nand will scroll the page to the top if configured to do so.",

85237

"itemtype": "method",

85238

"name": "_defNavigateFn",

85239

"params": [

85240

{

85241

"name": "e",

85242

"description": "",

85243

"type": "EventFacade"

85244

}

85245

],

85246

"access": "protected",

85247

"tagname": "",

85248

"since": "3.5.0",

85249

"class": "PjaxBase",

85250

"module": "pjax",

85251

"submodule": "pjax-base"

85252

},

85253

{

85254

"file": "pjax/js/pjax-base.js",

85255

"line": 417,

85256

"description": "Handler for delegated link-click events which match the `linkSelector`.\n\nThis will attempt to enhance the navigation to the link element's `href` by\npassing the URL to the `_navigate()` method. When the navigation is being\nenhanced, the default action is prevented.\n\nIf the user clicks a link with the middle/right mouse buttons, or is holding\ndown the Ctrl or Command keys, this method's behavior is not applied and\nallows the native behavior to occur. Similarly, if the router is not capable\nor handling the URL because no route-handlers match, the link click will\nbehave natively.",

85257

"itemtype": "method",

85258

"name": "_onLinkClick",

85259

"params": [

85260

{

85261

"name": "e",

85262

"description": "",

85263

"type": "EventFacade"

85264

}

85265

],

85266

"access": "protected",

85267

"tagname": "",

85268

"since": "3.5.0",

85269

"class": "PjaxBase",

85270

"module": "pjax",

85271

"submodule": "pjax-base"

85272

},

85273

{

85274

"file": "pjax/js/pjax-base.js",

85275

"line": 452,

85276

"description": "CSS selector string used to filter link click events so that only the links\nwhich match it will have the enhanced navigation behavior of Pjax applied.\n\nWhen a link is clicked and that link matches this selector, Pjax will\nattempt to dispatch to any route handlers matching the link's `href` URL. If\nHTML5 history is not supported or if no route handlers match, the link click\nwill be handled by the browser just like any old link.",

85277

"itemtype": "attribute",

85278

"name": "linkSelector",

85279

"type": "String|Function",

85280

"default": "\"a.pjax\"",

85281

"initonly": "",

85282

"since": "3.5.0",

85283

"class": "PjaxBase",

85284

"module": "pjax",

85285

"submodule": "pjax-base"

85286

},

85287

{

85288

"file": "pjax/js/pjax-base.js",

85289

"line": 472,

85290

"description": "Whether navigating to a hash-fragment identifier on the current page should\nbe enhanced and cause the `navigate` event to fire.\n\nBy default Pjax allows the browser to perform its default action when a user\nis navigating within a page by clicking in-page links\n(e.g. `<a href=\"#top\">Top of page</a>`) and does not attempt to interfere or\nenhance in-page navigation.",

85291

"itemtype": "attribute",

85292

"name": "navigateOnHash",

85293

"type": "Boolean",

85294

"default": "false",

85295

"since": "3.5.0",

85296

"class": "PjaxBase",

85297

"module": "pjax",

85298

"submodule": "pjax-base"

85299

},

85300

{

85301

"file": "pjax/js/pjax-base.js",

85302

"line": 490,

85303

"description": "Whether the page should be scrolled to the top after navigating to a URL.\n\nWhen the user clicks the browser's back button, the previous scroll position\nwill be maintained.",

85304

"itemtype": "attribute",

85305

"name": "scrollToTop",

85306

"type": "Boolean",

85307

"default": "true",

85308

"since": "3.5.0",

85309

"class": "PjaxBase",

85310

"module": "pjax",

85311

"submodule": "pjax-base"

85312

},

85313

{

85314

"file": "pjax/js/pjax.js",

85315

"line": 26,

85316

"description": "Fired when an error occurs while attempting to load a URL via Ajax.",

85317

"itemtype": "event",

85318

"name": "error",

85319

"params": [

85320

{

85321

"name": "content",

85322

"description": "Content extracted from the response, if any.",

85323

"type": "Object",

85324

"props": [

85325

{

85326

"name": "node",

85327

"description": "A `Y.Node` instance for a document fragment\n containing the extracted HTML content.",

85328

"type": "Node"

85329

},

85330

{

85331

"name": "title",

85332

"description": "The title of the HTML page, if any,\n extracted using the `titleSelector` attribute. If `titleSelector` is not\n set or if a title could not be found, this property will be `undefined`.",

85333

"type": "String",

85334

"optional": true

85335

}

85336

]

85337

},

85338

{

85339

"name": "responseText",

85340

"description": "Raw Ajax response text.",

85341

"type": "String"

85342

},

85343

{

85344

"name": "status",

85345

"description": "HTTP status code for the Ajax response.",

85346

"type": "Number"

85347

},

85348

{

85349

"name": "url",

85350

"description": "The absolute URL that failed to load.",

85351

"type": "String"

85352

}

85353

],

85354

"since": "3.5.0",

85355

"class": "Pjax",

85356

"module": "pjax"

85357

},

85358

{

85359

"file": "pjax/js/pjax.js",

85360

"line": 43,

85361

"description": "Fired when a URL is successfully loaded via Ajax.",

85362

"itemtype": "event",

85363

"name": "load",

85364

"params": [

85365

{

85366

"name": "content",

85367

"description": "Content extracted from the response, if any.",

85368

"type": "Object",

85369

"props": [

85370

{

85371

"name": "node",

85372

"description": "A `Y.Node` instance for a document fragment\n containing the extracted HTML content.",

85373

"type": "Node"

85374

},

85375

{

85376

"name": "title",

85377

"description": "The title of the HTML page, if any,\n extracted using the `titleSelector` attribute. If `titleSelector` is not\n set or if a title could not be found, this property will be `undefined`.",

85378

"type": "String",

85379

"optional": true

85380

}

85381

]

85382

},

85383

{

85384

"name": "responseText",

85385

"description": "Raw Ajax response text.",

85386

"type": "String"

85387

},

85388

{

85389

"name": "status",

85390

"description": "HTTP status code for the Ajax response.",

85391

"type": "Number"

85392

},

85393

{

85394

"name": "url",

85395

"description": "The absolute URL that was loaded.",

85396

"type": "String"

85397

}

85398

],

85399

"since": "3.5.0",

85400

"class": "Pjax",

85401

"module": "pjax"

85402

},

85403

{

85404

"file": "pjax/js/pjax.js",

85405

"line": 69,

85406

"description": "Extracts and returns the relevant HTML content from an Ajax response. The\ncontent is extracted using the `contentSelector` attribute as a CSS\nselector. If `contentSelector` is `null`, the entire response will be\nreturned.\n\nThe return value is an object containing two properties:\n\n - **node**: A `Y.Node` instance for a document fragment containing the\n extracted HTML content.\n\n - **title**: The title of the HTML page, if any, extracted using the\n `titleSelector` attribute (which defaults to looking for a `<title>`\n element). If `titleSelector` is not set or if a title could not be\n found, this property will be `undefined`.",

85407

"itemtype": "method",

85408

"name": "getContent",

85409

"params": [

85410

{

85411

"name": "responseText",

85412

"description": "Raw Ajax response text.",

85413

"type": "String"

85414

}

85415

],

85416

"return": {

85417

"description": "Content object with the properties described above.",

85418

"type": "Object"

85419

},

85420

"since": "3.5.0",

85421

"class": "Pjax",

85422

"module": "pjax"

85423

},

85424

{

85425

"file": "pjax/js/pjax.js",

85426

"line": 116,

85427

"description": "Default Pjax route handler. Makes an Ajax request for the requested URL.",

85428

"itemtype": "method",

85429

"name": "_defaultRoute",

85430

"params": [

85431

{

85432

"name": "req",

85433

"description": "Request object.",

85434

"type": "Object"

85435

}

85436

],

85437

"access": "protected",

85438

"tagname": "",

85439

"since": "3.5.0",

85440

"class": "Pjax",

85441

"module": "pjax"

85442

},

85443

{

85444

"file": "pjax/js/pjax.js",

85445

"line": 158,

85446

"description": "Default event handler for both the `error` and `load` events. Attempts to\ninsert the loaded content into the `container` node and update the page's\ntitle.",

85447

"itemtype": "method",

85448

"name": "_defCompleteFn",

85449

"params": [

85450

{

85451

"name": "e",

85452

"description": "",

85453

"type": "EventFacade"

85454

}

85455

],

85456

"access": "protected",

85457

"tagname": "",

85458

"since": "3.5.0",

85459

"class": "Pjax",

85460

"module": "pjax"

85461

},

85462

{

85463

"file": "pjax/js/pjax.js",

85464

"line": 181,

85465

"description": "Handles IO end events.",

85466

"itemtype": "method",

85467

"name": "_onPjaxIOEnd",

85468

"access": "protected",

85469

"tagname": "",

85470

"since": "3.5.0",

85471

"class": "Pjax",

85472

"module": "pjax"

85473

},

85474

{

85475

"file": "pjax/js/pjax.js",

85476

"line": 192,

85477

"description": "Handles IO failure events and fires our own `error` event.",

85478

"itemtype": "method",

85479

"name": "_onPjaxIOFailure",

85480

"access": "protected",

85481

"tagname": "",

85482

"since": "3.5.0",

85483

"class": "Pjax",

85484

"module": "pjax"

85485

},

85486

{

85487

"file": "pjax/js/pjax.js",

85488

"line": 210,

85489

"description": "Handles IO success events and fires our own 'load' event.",

85490

"itemtype": "method",

85491

"name": "_onPjaxIOSuccess",

85492

"access": "protected",

85493

"tagname": "",

85494

"since": "3.5.0",

85495

"class": "Pjax",

85496

"module": "pjax"

85497

},

85498

{

85499

"file": "pjax/js/pjax.js",

85500

"line": 229,

85501

"description": "If `true`, a \"pjax=1\" query parameter will be appended to all URLs\nrequested via Pjax.\n\nBrowsers ignore HTTP request headers when caching content, so if the\nsame URL is used to request a partial Pjax page and a full page, the\nbrowser will cache them under the same key and may later load the\ncached partial page when the user actually requests a full page (or vice\nversa).\n\nTo prevent this, we can add a bogus query parameter to the URL so that\nPjax URLs will always be cached separately from non-Pjax URLs.",

85502

"itemtype": "attribute",

85503

"name": "addPjaxParam",

85504

"type": "Boolean",

85505

"default": "true",

85506

"since": "3.5.0",

85507

"class": "Pjax",

85508

"module": "pjax"

85509

},

85510

{

85511

"file": "pjax/js/pjax.js",

85512

"line": 251,

85513

"description": "Node into which content should be inserted when a page is loaded via\nPjax. This node's existing contents will be removed to make way for the\nnew content.\n\nIf not set, loaded content will not be automatically inserted into the\npage.",

85514

"itemtype": "attribute",

85515

"name": "container",

85516

"type": "Node",

85517

"default": "null",

85518

"since": "3.5.0",

85519

"class": "Pjax",

85520

"module": "pjax"

85521

},

85522

{

85523

"file": "pjax/js/pjax.js",

85524

"line": 272,

85525

"description": "CSS selector used to extract a specific portion of the content of a page\nloaded via Pjax.\n\nFor example, if you wanted to load the page `example.html` but only use\nthe content within an element with the id \"pjax-content\", you'd set\n`contentSelector` to \"#pjax-content\".\n\nIf not set, the entire page will be used.",

85526

"itemtype": "attribute",

85527

"name": "contentSelector",

85528

"type": "String",

85529

"default": "null",

85530

"since": "3.5.0",

85531

"class": "Pjax",

85532

"module": "pjax"

85533

},

85534

{

85535

"file": "pjax/js/pjax.js",

85536

"line": 298,

85537

"description": "CSS selector used to extract a page title from the content of a page\nloaded via Pjax.\n\nBy default this is set to extract the title from the `<title>` element,\nbut you could customize it to extract the title from an `<h1>`, or from\nany other element, if that's more appropriate for the content you're\nloading.",

85538

"itemtype": "attribute",

85539

"name": "titleSelector",

85540

"type": "String",

85541

"default": "\"title\"",

85542

"since": "3.5.0",

85543

"class": "Pjax",

85544

"module": "pjax"

85545

},

85546

{

85547

"file": "pjax/js/pjax.js",

85548

"line": 316,

85549

"description": "Time in milliseconds after which an Ajax request should time out. When a\ntimeout occurs, the `error` event will be fired.",

85550

"itemtype": "attribute",

85551

"name": "timeout",

85552

"type": "Number",

85553

"default": "30000",

85554

"since": "3.5.0",

85555

"class": "Pjax",

85556

"module": "pjax"

85557

},

85558

{

85559

"file": "plugin/js/plugin.js",

85560

"line": 22,

85561

"description": "Object defining the set of attributes supported by the Plugin.Base class",

85562

"itemtype": "property",

85563

"name": "ATTRS",

85564

"type": "Object",

85565

"static": 1,

85566

"class": "Plugin.Base",

85567

"module": "plugin"

85568

},

85569

{

85570

"file": "plugin/js/plugin.js",

85571

"line": 31,

85572

"description": "The plugin's host object.",

85573

"itemtype": "attribute",

85574

"name": "host",

85575

"writeonce": "",

85576

"type": "Plugin.Host",

85577

"class": "Plugin.Base",

85578

"module": "plugin"

85579

},

85580

{

85581

"file": "plugin/js/plugin.js",

85582

"line": 43,

85583

"description": "The string identifying the Plugin.Base class. Plugins extending\nPlugin.Base should set their own NAME value.",

85584

"itemtype": "property",

85585

"name": "NAME",

85586

"type": "String",

85587

"static": 1,

85588

"class": "Plugin.Base",

85589

"module": "plugin"

85590

},

85591

{

85592

"file": "plugin/js/plugin.js",

85593

"line": 53,

85594

"description": "The name of the property the the plugin will be attached to\nwhen plugged into a Plugin Host. Plugins extending Plugin.Base,\nshould set their own NS value.",

85595

"itemtype": "property",

85596

"name": "NS",

85597

"type": "String",

85598

"static": 1,

85599

"class": "Plugin.Base",

85600

"module": "plugin"

85601

},

85602

{

85603

"file": "plugin/js/plugin.js",

85604

"line": 66,

85605

"description": "The list of event handles for event listeners or AOP injected methods\napplied by the plugin to the host object.",

85606

"itemtype": "property",

85607

"name": "_handles",

85608

"access": "private",

85609

"tagname": "",

85610

"type": "Array",

85611

"value": "null",

85612

"class": "Plugin.Base",

85613

"module": "plugin"

85614

},

85615

{

85616

"file": "plugin/js/plugin.js",

85617

"line": 77,

85618

"description": "Initializer lifecycle implementation.",

85619

"itemtype": "method",

85620

"name": "initializer",

85621

"params": [

85622

{

85623

"name": "config",

85624

"description": "Configuration object with property name/value pairs.",

85625

"type": "Object"

85626

}

85627

],

85628

"class": "Plugin.Base",

85629

"module": "plugin"

85630

},

85631

{

85632

"file": "plugin/js/plugin.js",

85633

"line": 89,

85634

"description": "Destructor lifecycle implementation.\n\nRemoves any event listeners or injected methods applied by the Plugin",

85635

"itemtype": "method",

85636

"name": "destructor",

85637

"class": "Plugin.Base",

85638

"module": "plugin"

85639

},

85640

{

85641

"file": "plugin/js/plugin.js",

85642

"line": 105,

85643

"description": "Listens for the \"on\" moment of events fired by the host, \nor injects code \"before\" a given method on the host.",

85644

"itemtype": "method",

85645

"name": "doBefore",

85646

"params": [

85647

{

85648

"name": "strMethod",

85649

"description": "The event to listen for, or method to inject logic before.",

85650

"type": "String"

85651

},

85652

{

85653

"name": "fn",

85654

"description": "The handler function. For events, the \"on\" moment listener. For methods, the function to execute before the given method is executed.",

85655

"type": "Function"

85656

},

85657

{

85658

"name": "context",

85659

"description": "An optional context to call the handler with. The default context is the plugin instance.",

85660

"type": "Object"

85661

}

85662

],

85663

"return": {

85664

"description": "handle The detach handle for the handler.",

85665

"type": "EventHandle"

85666

},

85667

"class": "Plugin.Base",

85668

"module": "plugin"

85669

},

85670

{

85671

"file": "plugin/js/plugin.js",

85672

"line": 128,

85673

"description": "Listens for the \"after\" moment of events fired by the host, \nor injects code \"after\" a given method on the host.",

85674

"itemtype": "method",

85675

"name": "doAfter",

85676

"params": [

85677

{

85678

"name": "strMethod",

85679

"description": "The event to listen for, or method to inject logic after.",

85680

"type": "String"

85681

},

85682

{

85683

"name": "fn",

85684

"description": "The handler function. For events, the \"after\" moment listener. For methods, the function to execute after the given method is executed.",

85685

"type": "Function"

85686

},

85687

{

85688

"name": "context",

85689

"description": "An optional context to call the handler with. The default context is the plugin instance.",

85690

"type": "Object"

85691

}

85692

],

85693

"return": {

85694

"description": "handle The detach handle for the listener.",

85695

"type": "EventHandle"

85696

},

85697

"class": "Plugin.Base",

85698

"module": "plugin"

85699

},

85700

{

85701

"file": "plugin/js/plugin.js",

85702

"line": 151,

85703

"description": "Listens for the \"on\" moment of events fired by the host object.\n\nListeners attached through this method will be detached when the plugin is unplugged.",

85704

"itemtype": "method",

85705

"name": "onHostEvent",

85706

"params": [

85707

{

85708

"name": "type",

85709

"description": "The event type.",

85710

"type": "String | Object"

85711

},

85712

{

85713

"name": "fn",

85714

"description": "The listener.",

85715

"type": "Function"

85716

},

85717

{

85718

"name": "context",

85719

"description": "The execution context. Defaults to the plugin instance.",

85720

"type": "Object"

85721

}

85722

],

85723

"return": {

85724

"description": "handle The detach handle for the listener.",

85725

"type": "EventHandle"

85726

},

85727

"class": "Plugin.Base",

85728

"module": "plugin"

85729

},

85730

{

85731

"file": "plugin/js/plugin.js",

85732

"line": 168,

85733

"description": "Listens for the \"after\" moment of events fired by the host object.\n\nListeners attached through this method will be detached when the plugin is unplugged.",

85734

"itemtype": "method",

85735

"name": "afterHostEvent",

85736

"params": [

85737

{

85738

"name": "type",

85739

"description": "The event type.",

85740

"type": "String | Object"

85741

},

85742

{

85743

"name": "fn",

85744

"description": "The listener.",

85745

"type": "Function"

85746

},

85747

{

85748

"name": "context",

85749

"description": "The execution context. Defaults to the plugin instance.",

85750

"type": "Object"

85751

}

85752

],

85753

"return": {

85754

"description": "handle The detach handle for the listener.",

85755

"type": "EventHandle"

85756

},

85757

"class": "Plugin.Base",

85758

"module": "plugin"

85759

},

85760

{

85761

"file": "plugin/js/plugin.js",

85762

"line": 185,

85763

"description": "Injects a function to be executed before a given method on host object.\n\nThe function will be detached when the plugin is unplugged.",

85764

"itemtype": "method",

85765

"name": "beforeHostMethod",

85766

"params": [

85767

{

85768

"name": "method",

85769

"description": "The name of the method to inject the function before.",

85770

"type": "String"

85771

},

85772

{

85773

"name": "fn",

85774

"description": "The function to inject.",

85775

"type": "Function"

85776

},

85777

{

85778

"name": "context",

85779

"description": "The execution context. Defaults to the plugin instance.",

85780

"type": "Object"

85781

}

85782

],

85783

"return": {

85784

"description": "handle The detach handle for the injected function.",

85785

"type": "EventHandle"

85786

},

85787

"class": "Plugin.Base",

85788

"module": "plugin"

85789

},

85790

{

85791

"file": "plugin/js/plugin.js",

85792

"line": 202,

85793

"description": "Injects a function to be executed after a given method on host object.\n\nThe function will be detached when the plugin is unplugged.",

85794

"itemtype": "method",

85795

"name": "afterHostMethod",

85796

"params": [

85797

{

85798

"name": "method",

85799

"description": "The name of the method to inject the function after.",

85800

"type": "String"

85801

},

85802

{

85803

"name": "fn",

85804

"description": "The function to inject.",

85805

"type": "Function"

85806

},

85807

{

85808

"name": "context",

85809

"description": "The execution context. Defaults to the plugin instance.",

85810

"type": "Object"

85811

}

85812

],

85813

"return": {

85814

"description": "handle The detach handle for the injected function.",

85815

"type": "EventHandle"

85816

},

85817

"class": "Plugin.Base",

85818

"module": "plugin"

85819

},

85820

{

85821

"file": "pluginhost/js/PluginHost.js",

85822

"line": 42,

85823

"description": "Adds a plugin to the host object. This will instantiate the \nplugin and attach it to the configured namespace on the host object.",

85824

"itemtype": "method",

85825

"name": "plug",

85826

"chainable": 1,

85827

"params": [

85828

{

85829

"name": "P",

85830

"description": "Accepts the plugin class, or an \nobject with a \"fn\" property specifying the plugin class and \na \"cfg\" property specifying the configuration for the Plugin.\n\nAdditionally an Array can also be passed in, with the above function or \nobject values, allowing the user to add multiple plugins in a single call.\n",

85831

"type": "Function | Object |Array"

85832

},

85833

{

85834

"name": "config",

85835

"description": "(Optional) If the first argument is the plugin class, the second argument\ncan be the configuration for the plugin."

85836

}

85837

],

85838

"return": {

85839

"description": "A reference to the host object",

85840

"type": "Base"

85841

},

85842

"class": "Plugin.Host",

85843

"module": "pluginhost-base"

85844

},

85845

{

85846

"file": "pluginhost/js/PluginHost.js",

85847

"line": 93,

85848

"description": "Removes a plugin from the host object. This will destroy the \nplugin instance and delete the namepsace from the host object.",

85849

"itemtype": "method",

85850

"name": "unplug",

85851

"params": [

85852

{

85853

"name": "plugin",

85854

"description": "The namespace of the plugin, or the plugin class with the static NS namespace property defined. If not provided,\nall registered plugins are unplugged.",

85855

"type": "String | Function"

85856

}

85857

],

85858

"return": {

85859

"description": "A reference to the host object",

85860

"type": "Base"

85861

},

85862

"chainable": 1,

85863

"class": "Plugin.Host",

85864

"module": "pluginhost-base"

85865

},

85866

{

85867

"file": "pluginhost/js/PluginHost.js",

85868

"line": 134,

85869

"description": "Determines if a plugin has plugged into this host.",

85870

"itemtype": "method",

85871

"name": "hasPlugin",

85872

"params": [

85873

{

85874

"name": "ns",

85875

"description": "The plugin's namespace",

85876

"type": "String"

85877

}

85878

],

85879

"return": {

85880

"description": "Returns a truthy value (the plugin instance) if present, or undefined if not.",

85881

"type": "Plugin"

85882

},

85883

"class": "Plugin.Host",

85884

"module": "pluginhost-base"

85885

},

85886

{

85887

"file": "pluginhost/js/PluginHost.js",

85888

"line": 145,

85889

"description": "Initializes static plugins registered on the host (using the\nBase.plug static method) and any plugins passed to the \ninstance through the \"plugins\" configuration property.",

85890

"itemtype": "method",

85891

"name": "_initPlugins",

85892

"params": [

85893

{

85894

"name": "config",

85895

"description": "The configuration object with property name/value pairs.",

85896

"type": "Config"

85897

}

85898

],

85899

"access": "private",

85900

"tagname": "",

85901

"class": "Plugin.Host",

85902

"module": "pluginhost-base"

85903

},

85904

{

85905

"file": "pluginhost/js/PluginHost.js",

85906

"line": 163,

85907

"description": "Unplugs and destroys all plugins on the host",

85908

"itemtype": "method",

85909

"name": "_destroyPlugins",

85910

"access": "private",

85911

"tagname": "",

85912

"class": "Plugin.Host",

85913

"module": "pluginhost-base"

85914

},

85915

{

85916

"file": "pluginhost/js/PluginHostConfig.js",

85917

"line": 9,

85918

"description": "A protected initialization method, used by the host class to initialize\nplugin configurations passed the constructor, through the config object.\n\nHost objects should invoke this method at the appropriate time in their\nconstruction lifecycle.",

85919

"itemtype": "method",

85920

"name": "_initConfigPlugins",

85921

"params": [

85922

{

85923

"name": "config",

85924

"description": "The configuration object passed to the constructor",

85925

"type": "Object"

85926

}

85927

],

85928

"access": "protected",

85929

"tagname": "",

85930

"class": "Plugin.Host",

85931

"module": "pluginhost-base",

85932

"submodule": "pluginhost-config"

85933

},

85934

{

85935

"file": "pluginhost/js/PluginHostConfig.js",

85936

"line": 60,

85937

"description": "Registers plugins to be instantiated at the class level (plugins \nwhich should be plugged into every instance of the class by default).",

85938

"itemtype": "method",

85939

"name": "plug",

85940

"static": 1,

85941

"params": [

85942

{

85943

"name": "hostClass",

85944

"description": "The host class on which to register the plugins",

85945

"type": "Function"

85946

},

85947

{

85948

"name": "plugin",

85949

"description": "Either the plugin class, an array of plugin classes or an array of objects (with fn and cfg properties defined)",

85950

"type": "Function | Array"

85951

},

85952

{

85953

"name": "config",

85954

"description": "(Optional) If plugin is the plugin class, the configuration for the plugin",

85955

"type": "Object"

85956

}

85957

],

85958

"class": "Plugin.Host",

85959

"module": "pluginhost-base",

85960

"submodule": "pluginhost-config"

85961

},

85962

{

85963

"file": "pluginhost/js/PluginHostConfig.js",

85964

"line": 94,

85965

"description": "Unregisters any class level plugins which have been registered by the host class, or any\nother class in the hierarchy.",

85966

"itemtype": "method",

85967

"name": "unplug",

85968

"static": 1,

85969

"params": [

85970

{

85971

"name": "hostClass",

85972

"description": "The host class from which to unregister the plugins",

85973

"type": "Function"

85974

},

85975

{

85976

"name": "plugin",

85977

"description": "The plugin class, or an array of plugin classes",

85978

"type": "Function | Array"

85979

}

85980

],

85981

"class": "Plugin.Host",

85982

"module": "pluginhost-base",

85983

"submodule": "pluginhost-config"

85984

},

85985

{

85986

"file": "profiler/js/Profiler.js",

85987

"line": 93,

85988

"description": "Removes all report data from the profiler.",

85989

"params": [

85990

{

85991

"name": "name",

85992

"description": "(Optional) The name of the report to clear. If\n omitted, then all report data is cleared.",

85993

"type": "String"

85994

}

85995

],

85996

"return": {

85997

"description": "",

85998

"type": "Void"

85999

},

86000

"itemtype": "method",

86001

"name": "clear",

86002

"static": 1,

86003

"class": "Profiler",

86004

"module": "profiler"

86005

},

86006

{

86007

"file": "profiler/js/Profiler.js",

86008

"line": 111,

86009

"description": "Returns the uninstrumented version of a function/object.",

86010

"params": [

86011

{

86012

"name": "name",

86013

"description": "The name of the function/object to retrieve.",

86014

"type": "String"

86015

}

86016

],

86017

"return": {

86018

"description": "The uninstrumented version of a function/object.",

86019

"type": "Function|Object"

86020

},

86021

"itemtype": "method",

86022

"name": "getOriginal",

86023

"static": 1,

86024

"class": "Profiler",

86025

"module": "profiler"

86026

},

86027

{

86028

"file": "profiler/js/Profiler.js",

86029

"line": 122,

86030

"description": "Instruments a method to have profiling calls.",

86031

"params": [

86032

{

86033

"name": "name",

86034

"description": "The name of the report for the function.",

86035

"type": "String"

86036

},

86037

{

86038

"name": "method",

86039

"description": "The function to instrument.",

86040

"type": "Function"

86041

}

86042

],

86043

"return": {

86044

"description": "An instrumented version of the function.",

86045

"type": "Function"

86046

},

86047

"itemtype": "method",

86048

"name": "instrument",

86049

"static": 1,

86050

"class": "Profiler",

86051

"module": "profiler"

86052

},

86053

{

86054

"file": "profiler/js/Profiler.js",

86055

"line": 167,

86056

"description": "Pauses profiling information for a given name.",

86057

"params": [

86058

{

86059

"name": "name",

86060

"description": "The name of the data point.",

86061

"type": "String"

86062

}

86063

],

86064

"return": {

86065

"description": "",

86066

"type": "Void"

86067

},

86068

"itemtype": "method",

86069

"name": "pause",

86070

"static": 1,

86071

"class": "Profiler",

86072

"module": "profiler"

86073

},

86074

{

86075

"file": "profiler/js/Profiler.js",

86076

"line": 186,

86077

"description": "Start profiling information for a given name. The name cannot be the name\nof a registered function or object. This is used to start timing for a\nparticular block of code rather than instrumenting the entire function.",

86078

"params": [

86079

{

86080

"name": "name",

86081

"description": "The name of the data point.",

86082

"type": "String"

86083

}

86084

],

86085

"return": {

86086

"description": "",

86087

"type": "Void"

86088

},

86089

"itemtype": "method",

86090

"name": "start",

86091

"static": 1,

86092

"class": "Profiler",

86093

"module": "profiler"

86094

},

86095

{

86096

"file": "profiler/js/Profiler.js",

86097

"line": 222,

86098

"description": "Stops profiling information for a given name.",

86099

"params": [

86100

{

86101

"name": "name",

86102

"description": "The name of the data point.",

86103

"type": "String"

86104

}

86105

],

86106

"return": {

86107

"description": "",

86108

"type": "Void"

86109

},

86110

"itemtype": "method",

86111

"name": "stop",

86112

"static": 1,

86113

"class": "Profiler",

86114

"module": "profiler"

86115

},

86116

{

86117

"file": "profiler/js/Profiler.js",

86118

"line": 251,

86119

"description": "Returns the average amount of time (in milliseconds) that the function\nwith the given name takes to execute.",

86120

"params": [

86121

{

86122

"name": "name",

86123

"description": "The name of the function whose data should be returned.\n If an object type method, it should be 'constructor.prototype.methodName';\n a normal object method would just be 'object.methodName'.",

86124

"type": "String"

86125

}

86126

],

86127

"return": {

86128

"description": "The average time it takes the function to execute.",

86129

"type": "Float"

86130

},

86131

"itemtype": "method",

86132

"name": "getAverage",

86133

"static": 1,

86134

"class": "Profiler",

86135

"module": "profiler"

86136

},

86137

{

86138

"file": "profiler/js/Profiler.js",

86139

"line": 265,

86140

"description": "Returns the number of times that the given function has been called.",

86141

"params": [

86142

{

86143

"name": "name",

86144

"description": "The name of the function whose data should be returned.",

86145

"type": "String"

86146

}

86147

],

86148

"return": {

86149

"description": "The number of times the function was called.",

86150

"type": "Int"

86151

},

86152

"itemtype": "method",

86153

"name": "getCallCount",

86154

"static": 1,

86155

"class": "Profiler",

86156

"module": "profiler"

86157

},

86158

{

86159

"file": "profiler/js/Profiler.js",

86160

"line": 276,

86161

"description": "Returns the maximum amount of time (in milliseconds) that the function\nwith the given name takes to execute.",

86162

"params": [

86163

{

86164

"name": "name",

86165

"description": "The name of the function whose data should be returned.\n If an object type method, it should be 'constructor.prototype.methodName';\n a normal object method would just be 'object.methodName'.",

86166

"type": "String"

86167

}

86168

],

86169

"return": {

86170

"description": "The maximum time it takes the function to execute.",

86171

"type": "Float"

86172

},

86173

"itemtype": "method",

86174

"name": "getMax",

86175

"static": 1,

86176

"class": "Profiler",

86177

"module": "profiler"

86178

},

86179

{

86180

"file": "profiler/js/Profiler.js",

86181

"line": 290,

86182

"description": "Returns the minimum amount of time (in milliseconds) that the function\nwith the given name takes to execute.",

86183

"params": [

86184

{

86185

"name": "name",

86186

"description": "The name of the function whose data should be returned.\n If an object type method, it should be 'constructor.prototype.methodName';\n a normal object method would just be 'object.methodName'.",

86187

"type": "String"

86188

}

86189

],

86190

"return": {

86191

"description": "The minimum time it takes the function to execute.",

86192

"type": "Float"

86193

},

86194

"itemtype": "method",

86195

"name": "getMin",

86196

"static": 1,

86197

"class": "Profiler",

86198

"module": "profiler"

86199

},

86200

{

86201

"file": "profiler/js/Profiler.js",

86202

"line": 304,

86203

"description": "Returns an object containing profiling data for a single function.\nThe object has an entry for min, max, avg, calls, and points).",

86204

"return": {

86205

"description": "An object containing profile data for a given function.",

86206

"type": "Object"

86207

},

86208

"itemtype": "method",

86209

"name": "getFunctionReport",

86210

"static": 1,

86211

"deprecated": true,

86212

"deprecationMessage": "Use getReport() instead.",

86213

"class": "Profiler",

86214

"module": "profiler"

86215

},

86216

{

86217

"file": "profiler/js/Profiler.js",

86218

"line": 316,

86219

"description": "Returns an object containing profiling data for a single function.\nThe object has an entry for min, max, avg, calls, and points).",

86220

"return": {

86221

"description": "An object containing profile data for a given function.",

86222

"type": "Object"

86223

},

86224

"itemtype": "method",

86225

"name": "getReport",

86226

"static": 1,

86227

"class": "Profiler",

86228

"module": "profiler"

86229

},

86230

{

86231

"file": "profiler/js/Profiler.js",

86232

"line": 327,

86233

"description": "Returns an object containing profiling data for all of the functions \nthat were profiled. The object has an entry for each function and \nreturns all information (min, max, average, calls, etc.) for each\nfunction.",

86234

"return": {

86235

"description": "An object containing all profile data.",

86236

"type": "Object"

86237

},

86238

"itemtype": "method",

86239

"name": "getFullReport",

86240

"static": 1,

86241

"class": "Profiler",

86242

"module": "profiler"

86243

},

86244

{

86245

"file": "profiler/js/Profiler.js",

86246

"line": 356,

86247

"description": "Sets up a constructor for profiling, including all properties and methods on the prototype.",

86248

"params": [

86249

{

86250

"name": "name",

86251

"description": "The fully-qualified name of the function including namespace information.",

86252

"type": "String"

86253

},

86254

{

86255

"name": "owner",

86256

"description": "(Optional) The object that owns the function (namespace or containing object).",

86257

"type": "Object"

86258

}

86259

],

86260

"return": {

86261

"description": "",

86262

"type": "Void"

86263

},

86264

"itemtype": "method",

86265

"name": "registerConstructor",

86266

"static": 1,

86267

"class": "Profiler",

86268

"module": "profiler"

86269

},

86270

{

86271

"file": "profiler/js/Profiler.js",

86272

"line": 368,

86273

"description": "Sets up a function for profiling. It essentially overwrites the function with one\nthat has instrumentation data. This method also creates an entry for the function\nin the profile report. The original function is stored on the container object.",

86274

"params": [

86275

{

86276

"name": "name",

86277

"description": "The full name of the function including namespacing. This\n is the name of the function that is stored in the report.",

86278

"type": "String"

86279

},

86280

{

86281

"name": "owner",

86282

"description": "(Optional) The object that owns the function. If the function\n isn't global then this argument is required. This could be the namespace that\n the function belongs to or the object on which it's\n a method.",

86283

"type": "Object"

86284

},

86285

{

86286

"name": "registerPrototype",

86287

"description": "(Optional) Indicates that the prototype should\n also be instrumented. Setting to true has the same effect as calling\n registerConstructor().",

86288

"type": "Boolean"

86289

}

86290

],

86291

"return": {

86292

"description": "",

86293

"type": "Void"

86294

},

86295

"itemtype": "method",

86296

"name": "registerFunction",

86297

"static": 1,

86298

"class": "Profiler",

86299

"module": "profiler"

86300

},

86301

{

86302

"file": "profiler/js/Profiler.js",

86303

"line": 426,

86304

"description": "Sets up an object for profiling. It takes the object and looks for functions.\nWhen a function is found, registerMethod() is called on it. If set to recrusive\nmode, it will also setup objects found inside of this object for profiling, \nusing the same methodology.",

86305

"params": [

86306

{

86307

"name": "name",

86308

"description": "The name of the object to profile (shows up in report).",

86309

"type": "String"

86310

},

86311

{

86312

"name": "owner",

86313

"description": "(Optional) The object represented by the name.",

86314

"type": "Object"

86315

},

86316

{

86317

"name": "recurse",

86318

"description": "(Optional) Determines if subobject methods are also profiled.",

86319

"type": "Boolean"

86320

}

86321

],

86322

"return": {

86323

"description": "",

86324

"type": "Void"

86325

},

86326

"itemtype": "method",

86327

"name": "registerObject",

86328

"static": 1,

86329

"class": "Profiler",

86330

"module": "profiler"

86331

},

86332

{

86333

"file": "profiler/js/Profiler.js",

86334

"line": 458,

86335

"description": "Removes a constructor function from profiling. Reverses the registerConstructor() method.",

86336

"params": [

86337

{

86338

"name": "name",

86339

"description": "The full name of the function including namespacing. This\n is the name of the function that is stored in the report.",

86340

"type": "String"

86341

}

86342

],

86343

"return": {

86344

"description": "",

86345

"type": "Void"

86346

},

86347

"itemtype": "method",

86348

"name": "unregisterFunction",

86349

"static": 1,

86350

"class": "Profiler",

86351

"module": "profiler"

86352

},

86353

{

86354

"file": "profiler/js/Profiler.js",

86355

"line": 474,

86356

"description": "Removes function from profiling. Reverses the registerFunction() method.",

86357

"params": [

86358

{

86359

"name": "name",

86360

"description": "The full name of the function including namespacing. This\n is the name of the function that is stored in the report.",

86361

"type": "String"

86362

}

86363

],

86364

"return": {

86365

"description": "",

86366

"type": "Void"

86367

},

86368

"itemtype": "method",

86369

"name": "unregisterFunction",

86370

"static": 1,

86371

"class": "Profiler",

86372

"module": "profiler"

86373

},

86374

{

86375

"file": "profiler/js/Profiler.js",

86376

"line": 510,

86377

"description": "Unregisters an object for profiling. It takes the object and looks for functions.\nWhen a function is found, unregisterMethod() is called on it. If set to recrusive\nmode, it will also unregister objects found inside of this object, \nusing the same methodology.",

86378

"params": [

86379

{

86380

"name": "name",

86381

"description": "The name of the object to unregister.",

86382

"type": "String"

86383

},

86384

{

86385

"name": "recurse",

86386

"description": "(Optional) Determines if subobject methods should also be\n unregistered.",

86387

"type": "Boolean"

86388

}

86389

],

86390

"return": {

86391

"description": "",

86392

"type": "Void"

86393

},

86394

"itemtype": "method",

86395

"name": "unregisterObject",

86396

"static": 1,

86397

"class": "Profiler",

86398

"module": "profiler"

86399

},

86400

{

86401

"file": "querystring/js/querystring-stringify.js",

86402

"line": 27,

86403

"description": "Converts an arbitrary value to a Query String representation.\n\nObjects with cyclical references will trigger an exception.",

86404

"itemtype": "method",

86405

"name": "stringify",

86406

"access": "public",

86407

"tagname": "",

86408

"params": [

86409

{

86410

"name": "obj",

86411

"description": "any arbitrary value to convert to query string",

86412

"type": "Variant"

86413

},

86414

{

86415

"name": "cfg",

86416

"description": "(optional) Configuration object. The three\nsupported configurations are:\n<ul><li>sep: When defined, the value will be used as the key-value\nseparator. The default value is \"&\".</li>\n<li>eq: When defined, the value will be used to join the key to\nthe value. The default value is \"=\".</li>\n<li>arrayKey: When set to true, the key of an array will have the\n'[]' notation appended to the key. The default value is false.\n</li></ul>",

86417

"type": "Object"

86418

},

86419

{

86420

"name": "name",

86421

"description": "(optional) Name of the current key, for handling children recursively.",

86422

"type": "String"

86423

}

86424

],

86425

"static": 1,

86426

"class": "QueryString",

86427

"module": "querystring",

86428

"submodule": "querystring-stringify"

86429

},

86430

{

86431

"file": "queue-promote/js/queue-promote.js",

86432

"line": 9,

86433

"description": "Returns the current index in the queue of the specified item",

86434

"itemtype": "method",

86435

"name": "indexOf",

86436

"params": [

86437

{

86438

"name": "needle",

86439

"description": "the item to search for",

86440

"type": "MIXED"

86441

}

86442

],

86443

"return": {

86444

"description": "the index of the item or -1 if not found",

86445

"type": "Number"

86446

},

86447

"class": "Queue",

86448

"module": "queue-promote"

86449

},

86450

{

86451

"file": "queue-promote/js/queue-promote.js",

86452

"line": 20,

86453

"description": "Moves the referenced item to the head of the queue",

86454

"itemtype": "method",

86455

"name": "promote",

86456

"params": [

86457

{

86458

"name": "item",

86459

"description": "an item in the queue",

86460

"type": "MIXED"

86461

}

86462

],

86463

"class": "Queue",

86464

"module": "queue-promote"

86465

},

86466

{

86467

"file": "queue-promote/js/queue-promote.js",

86468

"line": 34,

86469

"description": "Removes the referenced item from the queue",

86470

"itemtype": "method",

86471

"name": "remove",

86472

"params": [

86473

{

86474

"name": "item",

86475

"description": "an item in the queue",

86476

"type": "MIXED"

86477

}

86478

],

86479

"class": "Queue",

86480

"module": "queue-promote"

86481

},

86482

{

86483

"file": "recordset/js/record.js",

86484

"line": 17,

86485

"description": "Retrieve a particular (or all) values from the object",

86486

"params": [

86487

{

86488

"name": "field",

86489

"description": "(optional) The key to retrieve the value from. If not supplied, the entire object is returned.",

86490

"type": "String"

86491

}

86492

],

86493

"itemtype": "method",

86494

"name": "getValue",

86495

"access": "public",

86496

"tagname": "",

86497

"class": "Record",

86498

"module": "queue-promote"

86499

},

86500

{

86501

"file": "recordset/js/record.js",

86502

"line": 37,

86503

"description": "Unique ID of the record instance",

86504

"itemtype": "attribute",

86505

"name": "id",

86506

"type": "string",

86507

"class": "Record",

86508

"module": "queue-promote"

86509

},

86510

{

86511

"file": "recordset/js/record.js",

86512

"line": 46,

86513

"description": "The object stored within the record instance",

86514

"itemtype": "attribute",

86515

"name": "data",

86516

"type": "object",

86517

"class": "Record",

86518

"module": "queue-promote"

86519

},

86520

{

86521

"file": "recordset/js/recordset-base.js",

86522

"line": 29,

86523

"description": "Publish default functions for events. Create the initial hash table.",

86524

"itemtype": "method",

86525

"name": "initializer",

86526

"access": "protected",

86527

"tagname": "",

86528

"class": "Recordset",

86529

"module": "recordset",

86530

"submodule": "recordset-base"

86531

},

86532

{

86533

"file": "recordset/js/recordset-base.js",

86534

"line": 45,

86535

"description": "At least one record is being added. Additional properties of\nthe event are:\n<dl>\n <dt>added</dt>\n <dd>Array of new records to be added</dd>\n <dt>index</dt>\n <dd>The insertion index in the Recordset's internal\n array</dd>\n</dl>\n\nPreventing this event will cause the new records NOT to be\nadded to the Recordset's internal collection.",

86536

"itemtype": "event",

86537

"name": "add",

86538

"preventable": "_defAddFn",

86539

"class": "Recordset",

86540

"module": "recordset",

86541

"submodule": "recordset-base"

86542

},

86543

{

86544

"file": "recordset/js/recordset-base.js",

86545

"line": 64,

86546

"description": "At least one record is being removed. Additional properties of\nthe event are:\n<dl>\n <dt>removed</dt>\n <dd>Array of records to be removed</dd>\n <dt>range</dt>\n <dd>Number of records to be removed</dd>\n <dt>index</dt>\n <dd>The starting index in the Recordset's internal\n array from which to remove records</dd>\n</dl>\n\nPreventing this event will cause the records NOT to be\nremoved from the Recordset's internal collection.",

86547

"itemtype": "event",

86548

"name": "remove",

86549

"preventable": "_defRemoveFn",

86550

"class": "Recordset",

86551

"module": "recordset",

86552

"submodule": "recordset-base"

86553

},

86554

{

86555

"file": "recordset/js/recordset-base.js",

86556

"line": 85,

86557

"description": "The Recordset is being flushed of all records.",

86558

"itemtype": "event",

86559

"name": "empty",

86560

"preventable": "_defEmptyFn",

86561

"class": "Recordset",

86562

"module": "recordset",

86563

"submodule": "recordset-base"

86564

},

86565

{

86566

"file": "recordset/js/recordset-base.js",

86567

"line": 93,

86568

"description": "At least one record is being updated. Additional properties of\nthe event are:\n<dl>\n <dt>updated</dt>\n <dd>Array of records with updated values</dd>\n <dt>overwritten</dt>\n <dd>Array of current records that will be replaced</dd>\n <dt>index</dt>\n <dd>The starting index in the Recordset's internal\n array from which to update will apply</dd>\n</dl>\n\nPreventing this event will cause the records NOT to be\nupdated in the Recordset's internal collection.",

86569

"itemtype": "event",

86570

"name": "update",

86571

"preventable": "_defUpdateFn",

86572

"class": "Recordset",

86573

"module": "recordset",

86574

"submodule": "recordset-base"

86575

},

86576

{

86577

"file": "recordset/js/recordset-base.js",

86578

"line": 125,

86579

"description": "Returns the record with particular ID or index",

86580

"itemtype": "method",

86581

"name": "getRecord",

86582

"params": [

86583

{

86584

"name": "i",

86585

"description": "The ID of the record if a string, or the index if a number.",

86586

"type": "String, Number"

86587

}

86588

],

86589

"return": {

86590

"description": "A Y.Record instance",

86591

"type": "Record"

86592

},

86593

"class": "Recordset",

86594

"module": "recordset",

86595

"submodule": "recordset-base"

86596

},

86597

{

86598

"file": "recordset/js/recordset-base.js",

86599

"line": 144,

86600

"description": "Returns the record at a particular index",

86601

"itemtype": "method",

86602

"name": "getRecordByIndex",

86603

"params": [

86604

{

86605

"name": "i",

86606

"description": "Index at which the required record resides",

86607

"type": "Number"

86608

}

86609

],

86610

"return": {

86611

"description": "A Y.Record instance",

86612

"type": "Record"

86613

},

86614

"class": "Recordset",

86615

"module": "recordset",

86616

"submodule": "recordset-base"

86617

},

86618

{

86619

"file": "recordset/js/recordset-base.js",

86620

"line": 155,

86621

"description": "Returns a range of records beginning at particular index",

86622

"itemtype": "method",

86623

"name": "getRecordsByIndex",

86624

"params": [

86625

{

86626

"name": "index",

86627

"description": "Index at which the required record resides",

86628

"type": "Number"

86629

},

86630

{

86631

"name": "range",

86632

"description": "(Optional) Number of records to retrieve. The default is 1",

86633

"type": "Number"

86634

}

86635

],

86636

"return": {

86637

"description": "An array of Y.Record instances",

86638

"type": "Array"

86639

},

86640

"class": "Recordset",

86641

"module": "recordset",

86642

"submodule": "recordset-base"

86643

},

86644

{

86645

"file": "recordset/js/recordset-base.js",

86646

"line": 175,

86647

"description": "Returns the length of the recordset",

86648

"itemtype": "method",

86649

"name": "getLength",

86650

"return": {

86651

"description": "Number of records in the recordset",

86652

"type": "Number"

86653

},

86654

"class": "Recordset",

86655

"module": "recordset",

86656

"submodule": "recordset-base"

86657

},

86658

{

86659

"file": "recordset/js/recordset-base.js",

86660

"line": 185,

86661

"description": "Gets an array of values for a data _key_ in the set's records. If no _key_\nis supplied, the returned array will contain the full data object for each\nrecord.",

86662

"itemtype": "method",

86663

"name": "getValuesByKey",

86664

"params": [

86665

{

86666

"name": "key",

86667

"description": "Data property to get from all records",

86668

"type": "String",

86669

"optional": true

86670

}

86671

],

86672

"return": {

86673

"description": "An array of values for the given _key_ if supplied.\n Otherwise, an array of each record's data hash.",

86674

"type": "Array"

86675

},

86676

"class": "Recordset",

86677

"module": "recordset",

86678

"submodule": "recordset-base"

86679

},

86680

{

86681

"file": "recordset/js/recordset-base.js",

86682

"line": 206,

86683

"description": "Adds one or more Records to the RecordSet at the given index. If index is null, then adds the Records to the end of the RecordSet.",

86684

"itemtype": "method",

86685

"name": "add",

86686

"params": [

86687

{

86688

"name": "oData",

86689

"description": "A Y.Record instance, An object literal of data or an array of object literals",

86690

"type": "Record|Object|Array"

86691

},

86692

{

86693

"name": "index",

86694

"description": "[index] Index at which to add the record(s)",

86695

"type": "Number",

86696

"optional": true

86697

}

86698

],

86699

"return": {

86700

"description": "The updated recordset instance",

86701

"type": "Recordset"

86702

},

86703

"class": "Recordset",

86704

"module": "recordset",

86705

"submodule": "recordset-base"

86706

},

86707

{

86708

"file": "recordset/js/recordset-base.js",

86709

"line": 238,

86710

"description": "Removes one or more Records to the RecordSet at the given index. If index\nis null, then removes a single Record from the end of the RecordSet.",

86711

"itemtype": "method",

86712

"name": "remove",

86713

"params": [

86714

{

86715

"name": "index",

86716

"description": "Index at which to remove the record(s) from",

86717

"type": "Number",

86718

"optional": true

86719

},

86720

{

86721

"name": "range",

86722

"description": "Number of records to remove (including the one\n at the index)",

86723

"type": "Number",

86724

"optional": true

86725

}

86726

],

86727

"return": {

86728

"description": "The updated recordset instance",

86729

"type": "Recordset"

86730

},

86731

"class": "Recordset",

86732

"module": "recordset",

86733

"submodule": "recordset-base"

86734

},

86735

{

86736

"file": "recordset/js/recordset-base.js",

86737

"line": 266,

86738

"description": "Empties the recordset",

86739

"itemtype": "method",

86740

"name": "empty",

86741

"return": {

86742

"description": "The updated recordset instance",

86743

"type": "Recordset"

86744

},

86745

"class": "Recordset",

86746

"module": "recordset",

86747

"submodule": "recordset-base"

86748

},

86749

{

86750

"file": "recordset/js/recordset-base.js",

86751

"line": 277,

86752

"description": "Updates the recordset with the new records passed in. Overwrites existing\nrecords when updating the index with the new records.",

86753

"itemtype": "method",

86754

"name": "update",

86755

"params": [

86756

{

86757

"name": "data",

86758

"description": "A Y.Record instance, An object literal of\n data or an array of object literals",

86759

"type": "Record|Object|Array"

86760

},

86761

{

86762

"name": "index",

86763

"description": "The index to start updating from.",

86764

"type": "Number",

86765

"optional": true

86766

}

86767

],

86768

"return": {

86769

"description": "The updated recordset instance",

86770

"type": "Recordset"

86771

},

86772

"class": "Recordset",

86773

"module": "recordset",

86774

"submodule": "recordset-base"

86775

},

86776

{

86777

"file": "recordset/js/recordset-base.js",

86778

"line": 310,

86779

"description": "Default behavior for the \"add\" event. Adds Record instances starting from\nthe index specified in `e.index`.",

86780

"itemtype": "method",

86781

"name": "_defAddFn",

86782

"params": [

86783

{

86784

"name": "e",

86785

"description": "The add event",

86786

"type": "EventFacade"

86787

}

86788

],

86789

"access": "private",

86790

"tagname": "",

86791

"class": "Recordset",

86792

"module": "recordset",

86793

"submodule": "recordset-base"

86794

},

86795

{

86796

"file": "recordset/js/recordset-base.js",

86797

"line": 322,

86798

"description": "Default behavior for the \"remove\" event. Removes Records from the\ninternal array starting from `e.index`. By default, it will remove one\nRecord. But if `e.range` is set, it will remove that many Records.",

86799

"itemtype": "method",

86800

"name": "_defRemoveFn",

86801

"params": [

86802

{

86803

"name": "e",

86804

"description": "The remove event",

86805

"type": "EventFacade"

86806

}

86807

],

86808

"access": "private",

86809

"tagname": "",

86810

"class": "Recordset",

86811

"module": "recordset",

86812

"submodule": "recordset-base"

86813

},

86814

{

86815

"file": "recordset/js/recordset-base.js",

86816

"line": 335,

86817

"description": "Default behavior for the \"update\" event. Sets Record instances for each\nitem in `e.updated` at indexes starting from `e.index`.",

86818

"itemtype": "method",

86819

"name": "_defUpdateFn",

86820

"params": [

86821

{

86822

"name": "e",

86823

"description": "The update event",

86824

"type": "EventFacade"

86825

}

86826

],

86827

"access": "private",

86828

"tagname": "",

86829

"class": "Recordset",

86830

"module": "recordset",

86831

"submodule": "recordset-base"

86832

},

86833

{

86834

"file": "recordset/js/recordset-base.js",

86835

"line": 349,

86836

"description": "Default behavior for the \"empty\" event. Clears the internal array of\nRecords.",

86837

"itemtype": "method",

86838

"name": "_defEmptyFn",

86839

"params": [

86840

{

86841

"name": "e",

86842

"description": "The empty event",

86843

"type": "EventFacade"

86844

}

86845

],

86846

"access": "private",

86847

"tagname": "",

86848

"class": "Recordset",

86849

"module": "recordset",

86850

"submodule": "recordset-base"

86851

},

86852

{

86853

"file": "recordset/js/recordset-base.js",

86854

"line": 362,

86855

"description": "Updates the internal hash table.",

86856

"itemtype": "method",

86857

"name": "_defUpdateHash",

86858

"params": [

86859

{

86860

"name": "e",

86861

"description": "Event triggering the hash table update",

86862

"type": "EventFacade"

86863

}

86864

],

86865

"access": "private",

86866

"tagname": "",

86867

"class": "Recordset",

86868

"module": "recordset",

86869

"submodule": "recordset-base"

86870

},

86871

{

86872

"file": "recordset/js/recordset-base.js",

86873

"line": 386,

86874

"description": "Regenerates the hash table from the current internal array of Records.",

86875

"itemtype": "method",

86876

"name": "_hashRecordsChange",

86877

"params": [

86878

{

86879

"name": "hash",

86880

"description": "The hash map before replacement",

86881

"type": "Object"

86882

},

86883

{

86884

"name": "key",

86885

"description": "The key by which to add items to the hash",

86886

"type": "String"

86887

},

86888

{

86889

"name": "e",

86890

"description": "The event or object containing the items to be added.\n Items are expected to be stored in an array assigned to\n the `added` property.",

86891

"type": "Object"

86892

}

86893

],

86894

"return": {

86895

"description": "The updated hash map",

86896

"type": "Object"

86897

},

86898

"access": "private",

86899

"tagname": "",

86900

"class": "Recordset",

86901

"module": "recordset",

86902

"submodule": "recordset-base"

86903

},

86904

{

86905

"file": "recordset/js/recordset-base.js",

86906

"line": 402,

86907

"description": "Builds a hash table from the current internal array of Records.",

86908

"itemtype": "method",

86909

"name": "_buildHashTable",

86910

"params": [

86911

{

86912

"name": "key",

86913

"description": "The Record key to hash the items by",

86914

"type": "String"

86915

}

86916

],

86917

"return": {

86918

"description": "A new hash map of Records keyed by each Records' key",

86919

"type": "Object"

86920

},

86921

"access": "private",

86922

"tagname": "",

86923

"class": "Recordset",

86924

"module": "recordset",

86925

"submodule": "recordset-base"

86926

},

86927

{

86928

"file": "recordset/js/recordset-base.js",

86929

"line": 414,

86930

"description": "Adds items to the hash table. Items are the values, and the keys are the\nvalues of the item's attribute named in the `key` parameter.",

86931

"itemtype": "method",

86932

"name": "_hashAdd",

86933

"params": [

86934

{

86935

"name": "hash",

86936

"description": "The hash map before adding items",

86937

"type": "Object"

86938

},

86939

{

86940

"name": "key",

86941

"description": "The key by which to add the items to the hash",

86942

"type": "String"

86943

},

86944

{

86945

"name": "e",

86946

"description": "The event or object containing the items to be added.\n Items are expected to be stored in an array assigned to\n the `added` property.",

86947

"type": "Object"

86948

}

86949

],

86950

"return": {

86951

"description": "The updated hash map",

86952

"type": "Object"

86953

},

86954

"access": "private",

86955

"tagname": "",

86956

"class": "Recordset",

86957

"module": "recordset",

86958

"submodule": "recordset-base"

86959

},

86960

{

86961

"file": "recordset/js/recordset-base.js",

86962

"line": 438,

86963

"description": "Removes items from the hash table.",

86964

"itemtype": "method",

86965

"name": "_hashRemove",

86966

"params": [

86967

{

86968

"name": "hash",

86969

"description": "The hash map before removing items",

86970

"type": "Object"

86971

},

86972

{

86973

"name": "key",

86974

"description": "The key by which to remove the items from the hash",

86975

"type": "String"

86976

},

86977

{

86978

"name": "e",

86979

"description": "The event or object containing the items to be removed.\n Items are expected to be stored in an array assigned to\n the `removed` property.",

86980

"type": "Object"

86981

}

86982

],

86983

"return": {

86984

"description": "The updated hash map",

86985

"type": "Object"

86986

},

86987

"access": "private",

86988

"tagname": "",

86989

"class": "Recordset",

86990

"module": "recordset",

86991

"submodule": "recordset-base"

86992

},

86993

{

86994

"file": "recordset/js/recordset-base.js",

86995

"line": 458,

86996

"description": "Updates items in the hash table.",

86997

"itemtype": "method",

86998

"name": "_hashUpdate",

86999

"params": [

87000

{

87001

"name": "hash",

87002

"description": "The hash map before updating items",

87003

"type": "Object"

87004

},

87005

{

87006

"name": "key",

87007

"description": "The key by which to update the items to the hash",

87008

"type": "String"

87009

},

87010

{

87011

"name": "e",

87012

"description": "The event or object containing the items to be updated.\n Items are expected to be stored in an array assigned to\n the `updated` property. Optionally, items can be\n identified for being overwritten by including them in an\n array assigned to the `overwritten` property.",

87013

"type": "Object"

87014

}

87015

],

87016

"return": {

87017

"description": "The updated hash map",

87018

"type": "Object"

87019

},

87020

"access": "private",

87021

"tagname": "",

87022

"class": "Recordset",

87023

"module": "recordset",

87024

"submodule": "recordset-base"

87025

},

87026

{

87027

"file": "recordset/js/recordset-base.js",

87028

"line": 480,

87029

"description": "Clears the hash table.",

87030

"itemtype": "method",

87031

"name": "_hashEmpty",

87032

"params": [

87033

{

87034

"name": "hash",

87035

"description": "The hash map before adding items",

87036

"type": "Object"

87037

},

87038

{

87039

"name": "key",

87040

"description": "The key by which to remove the items from the hash",

87041

"type": "String"

87042

},

87043

{

87044

"name": "e",

87045

"description": "The event or object containing the items to be removed.\n Items are expected to be stored in an array assigned to\n the `removed` property.",

87046

"type": "Object"

87047

}

87048

],

87049

"return": {

87050

"description": "An empty hash",

87051

"type": "Object"

87052

},

87053

"access": "private",

87054

"tagname": "",

87055

"class": "Recordset",

87056

"module": "recordset",

87057

"submodule": "recordset-base"

87058

},

87059

{

87060

"file": "recordset/js/recordset-base.js",

87061

"line": 496,

87062

"description": "Sets up the hashtable with all the records currently in the recordset",

87063

"itemtype": "method",

87064

"name": "_initHashTable",

87065

"access": "private",

87066

"tagname": "",

87067

"class": "Recordset",

87068

"module": "recordset",

87069

"submodule": "recordset-base"

87070

},

87071

{

87072

"file": "recordset/js/recordset-base.js",

87073

"line": 506,

87074

"description": "Helper method - it takes an object bag and converts it to a Y.Record",

87075

"itemtype": "method",

87076

"name": "_changeToRecord",

87077

"params": [

87078

{

87079

"name": "obj",

87080

"description": "Any objet literal or Y.Record instance",

87081

"type": "Object|Record"

87082

}

87083

],

87084

"return": {

87085

"description": "A Record instance.",

87086

"type": "Record"

87087

},

87088

"access": "private",

87089

"tagname": "",

87090

"class": "Recordset",

87091

"module": "recordset",

87092

"submodule": "recordset-base"

87093

},

87094

{

87095

"file": "recordset/js/recordset-base.js",

87096

"line": 518,

87097

"description": "Ensures the value being set is an array of Record instances. If array items\nare raw object data, they are turned into Records.",

87098

"itemtype": "method",

87099

"name": "_setRecords",

87100

"params": [

87101

{

87102

"name": "items",

87103

"description": "The Records or data Objects to store as\n Records.",

87104

"type": "Record[]|Object[]"

87105

}

87106

],

87107

"return": {

87108

"description": "",

87109

"type": "Record[]"

87110

},

87111

"class": "Recordset",

87112

"module": "recordset",

87113

"submodule": "recordset-base"

87114

},

87115

{

87116

"file": "recordset/js/recordset-base.js",

87117

"line": 545,

87118

"description": "An array of Records that the Recordset is storing. Passing an array\nof raw record data is also accepted. The data for each item will be\nwrapped in a Record instance.",

87119

"itemtype": "attribute",

87120

"name": "records",

87121

"type": "{Record[]}",

87122

"class": "Recordset",

87123

"module": "recordset",

87124

"submodule": "recordset-base"

87125

},

87126

{

87127

"file": "recordset/js/recordset-base.js",

87128

"line": 563,

87129

"description": "A hash table where the ID of the record is the key, and the record\ninstance is the value.",

87130

"itemtype": "attribute",

87131

"name": "table",

87132

"type": "object",

87133

"class": "Recordset",

87134

"module": "recordset",

87135

"submodule": "recordset-base"

87136

},

87137

{

87138

"file": "recordset/js/recordset-base.js",

87139

"line": 574,

87140

"description": "The ID to use as the key in the hash table.",

87141

"itemtype": "attribute",

87142

"name": "key",

87143

"type": "string",

87144

"class": "Recordset",

87145

"module": "recordset",

87146

"submodule": "recordset-base"

87147

},

87148

{

87149

"file": "recordset/js/recordset-filter.js",

87150

"line": 36,

87151

"description": "Filter through the recordset with a custom filter function, or a key-value\npair.",

87152

"itemtype": "method",

87153

"name": "filter",

87154

"params": [

87155

{

87156

"name": "filter",

87157

"description": "A custom filter function or a string\n representing the key to filter by.",

87158

"type": "Function|String"

87159

},

87160

{

87161

"name": "value",

87162

"description": "If filtering by key (_filter_ is a string), further\n filter by a specific value.",

87163

"type": "Any",

87164

"optional": true

87165

}

87166

],

87167

"return": {

87168

"description": "A new filtered Recordset instance",

87169

"type": "Recordset"

87170

},

87171

"class": "RecordsetFilter",

87172

"module": "recordset",

87173

"submodule": "recordset-filter"

87174

},

87175

{

87176

"file": "recordset/js/recordset-filter.js",

87177

"line": 65,

87178

"description": "The inverse of filter. Executes the supplied function on each item. Returns\na new Recordset containing the items that the supplied function returned\n`false` for.",

87179

"itemtype": "method",

87180

"name": "reject",

87181

"params": [

87182

{

87183

"name": "filter",

87184

"description": "A boolean function, executed on each item.",

87185

"type": "Function"

87186

}

87187

],

87188

"return": {

87189

"description": "A new Recordset instance containing the items on which\n the supplied function returned false.",

87190

"type": "Recordset"

87191

},

87192

"class": "RecordsetFilter",

87193

"module": "recordset",

87194

"submodule": "recordset-filter"

87195

},

87196

{

87197

"file": "recordset/js/recordset-filter.js",

87198

"line": 81,

87199

"description": "Iterates over the Recordset, returning a new Recordset of all the elements\nthat match the supplied regular expression",

87200

"itemtype": "method",

87201

"name": "grep",

87202

"params": [

87203

{

87204

"name": "pattern",

87205

"description": "The regular expression to test against each record.",

87206

"type": "RegExp"

87207

}

87208

],

87209

"return": {

87210

"description": "A Recordset instance containing all the items in the\n collection that produce a match against the supplied regular\n expression. If no items match, an empty Recordset instance is returned.",

87211

"type": "Recordset"

87212

},

87213

"class": "RecordsetFilter",

87214

"module": "recordset",

87215

"submodule": "recordset-filter"

87216

},

87217

{

87218

"file": "recordset/js/recordset-indexer.js",

87219

"line": 21,

87220

"description": "Collection of all the hashTables created by the plugin. \nThe individual tables can be accessed by the key they are hashing against.",

87221

"itemtype": "attribute",

87222

"name": "hashTables",

87223

"access": "public",

87224

"tagname": "",

87225

"type": "object",

87226

"class": "RecordsetIndexer",

87227

"module": "recordset",

87228

"submodule": "recordset-indexer"

87229

},

87230

{

87231

"file": "recordset/js/recordset-indexer.js",

87232

"line": 62,

87233

"description": "Setup the hash table for a given key with all existing records in the recordset",

87234

"itemtype": "method",

87235

"name": "_setHashTable",

87236

"params": [

87237

{

87238

"name": "key",

87239

"description": "A key to hash by.",

87240

"type": "String"

87241

}

87242

],

87243

"return": {

87244

"description": "obj The created hash table",

87245

"type": "Object"

87246

},

87247

"access": "private",

87248

"tagname": "",

87249

"class": "RecordsetIndexer",

87250

"module": "recordset",

87251

"submodule": "recordset-indexer"

87252

},

87253

{

87254

"file": "recordset/js/recordset-indexer.js",

87255

"line": 86,

87256

"description": "Updates all hash tables when a record is added to the recordset",

87257

"itemtype": "method",

87258

"name": "_defAddHash",

87259

"access": "private",

87260

"tagname": "",

87261

"class": "RecordsetIndexer",

87262

"module": "recordset",

87263

"submodule": "recordset-indexer"

87264

},

87265

{

87266

"file": "recordset/js/recordset-indexer.js",

87267

"line": 111,

87268

"description": "Updates all hash tables when a record is removed from the recordset",

87269

"itemtype": "method",

87270

"name": "_defRemoveHash",

87271

"access": "private",

87272

"tagname": "",

87273

"class": "RecordsetIndexer",

87274

"module": "recordset",

87275

"submodule": "recordset-indexer"

87276

},

87277

{

87278

"file": "recordset/js/recordset-indexer.js",

87279

"line": 137,

87280

"description": "Updates all hash tables when the recordset is updated (a combination of add and remove)",

87281

"itemtype": "method",

87282

"name": "_defUpdateHash",

87283

"access": "private",

87284

"tagname": "",

87285

"class": "RecordsetIndexer",

87286

"module": "recordset",

87287

"submodule": "recordset-indexer"

87288

},

87289

{

87290

"file": "recordset/js/recordset-indexer.js",

87291

"line": 187,

87292

"description": "Creates a new hash table.",

87293

"itemtype": "method",

87294

"name": "createTable",

87295

"params": [

87296

{

87297

"name": "key",

87298

"description": "A key to hash by.",

87299

"type": "String"

87300

}

87301

],

87302

"return": {

87303

"description": "tbls[key] The created hash table",

87304

"type": "Object"

87305

},

87306

"access": "public",

87307

"tagname": "",

87308

"class": "RecordsetIndexer",

87309

"module": "recordset",

87310

"submodule": "recordset-indexer"

87311

},

87312

{

87313

"file": "recordset/js/recordset-indexer.js",

87314

"line": 204,

87315

"description": "Get a hash table that hashes records by a given key.",

87316

"itemtype": "method",

87317

"name": "getTable",

87318

"params": [

87319

{

87320

"name": "key",

87321

"description": "A key to hash by.",

87322

"type": "String"

87323

}

87324

],

87325

"return": {

87326

"description": "table The created hash table",

87327

"type": "Object"

87328

},

87329

"access": "public",

87330

"tagname": "",

87331

"class": "RecordsetIndexer",

87332

"module": "recordset",

87333

"submodule": "recordset-indexer"

87334

},

87335

{

87336

"file": "recordset/js/recordset-sort.js",

87337

"line": 26,

87338

"description": "The last properties used to sort. Consists of an object literal with the keys \"field\", \"desc\", and \"sorter\"",

87339

"itemtype": "attribute",

87340

"name": "lastSortProperties",

87341

"access": "public",

87342

"tagname": "",

87343

"type": "object",

87344

"class": "RecordsetSort",

87345

"module": "recordset",

87346

"submodule": "recordset-sort"

87347

},

87348

{

87349

"file": "recordset/js/recordset-sort.js",

87350

"line": 44,

87351

"description": "Default sort function to use if none is specified by the user.\nTakes two records, the key to sort by, and whether sorting direction is descending or not (boolean).\nIf two records have the same value for a given key, the ID is used as the tie-breaker.",

87352

"itemtype": "attribute",

87353

"name": "defaultSorter",

87354

"access": "public",

87355

"tagname": "",

87356

"type": "function",

87357

"class": "RecordsetSort",

87358

"module": "recordset",

87359

"submodule": "recordset-sort"

87360

},

87361

{

87362

"file": "recordset/js/recordset-sort.js",

87363

"line": 65,

87364

"description": "A boolean telling if the recordset is in a sorted state.",

87365

"itemtype": "attribute",

87366

"name": "defaultSorter",

87367

"access": "public",

87368

"tagname": "",

87369

"type": "function",

87370

"class": "RecordsetSort",

87371

"module": "recordset",

87372

"submodule": "recordset-sort"

87373

},

87374

{

87375

"file": "recordset/js/recordset-sort.js",

87376

"line": 80,

87377

"description": "Sets up the default function to use when the \"sort\" event is fired.",

87378

"itemtype": "method",

87379

"name": "initializer",

87380

"access": "protected",

87381

"tagname": "",

87382

"class": "RecordsetSort",

87383

"module": "recordset",

87384

"submodule": "recordset-sort"

87385

},

87386

{

87387

"file": "recordset/js/recordset-sort.js",

87388

"line": 119,

87389

"description": "Method that all sort calls go through. \nSets up the lastSortProperties object with the details of the sort, and passes in parameters \nto the \"defaultSorter\" or a custom specified sort function.",

87390

"itemtype": "method",

87391

"name": "_defSortFn",

87392

"access": "private",

87393

"tagname": "",

87394

"class": "RecordsetSort",

87395

"module": "recordset",

87396

"submodule": "recordset-sort"

87397

},

87398

{

87399

"file": "recordset/js/recordset-sort.js",

87400

"line": 136,

87401

"description": "Sorts the recordset.",

87402

"itemtype": "method",

87403

"name": "sort",

87404

"params": [

87405

{

87406

"name": "field",

87407

"description": "A key to sort by.",

87408

"type": "String"

87409

},

87410

{

87411

"name": "desc",

87412

"description": "True if you want sort order to be descending, false if you want sort order to be ascending",

87413

"type": "Boolean"

87414

}

87415

],

87416

"access": "public",

87417

"tagname": "",

87418

"class": "RecordsetSort",

87419

"module": "recordset",

87420

"submodule": "recordset-sort"

87421

},

87422

{

87423

"file": "recordset/js/recordset-sort.js",

87424

"line": 152,

87425

"description": "Resorts the recordset based on the last-used sort parameters (stored in 'lastSortProperties' ATTR)",

87426

"itemtype": "method",

87427

"name": "resort",

87428

"access": "public",

87429

"tagname": "",

87430

"class": "RecordsetSort",

87431

"module": "recordset",

87432

"submodule": "recordset-sort"

87433

},

87434

{

87435

"file": "recordset/js/recordset-sort.js",

87436

"line": 167,

87437

"description": "Reverses the recordset calling the standard array.reverse() method.",

87438

"itemtype": "method",

87439

"name": "reverse",

87440

"access": "public",

87441

"tagname": "",

87442

"class": "RecordsetSort",

87443

"module": "recordset",

87444

"submodule": "recordset-sort"

87445

},

87446

{

87447

"file": "recordset/js/recordset-sort.js",

87448

"line": 177,

87449

"description": "Sorts the recordset based on the last-used sort parameters, but flips the order. (ie: Descending becomes ascending, and vice versa).",

87450

"itemtype": "method",

87451

"name": "flip",

87452

"access": "public",

87453

"tagname": "",

87454

"class": "RecordsetSort",

87455

"module": "recordset",

87456

"submodule": "recordset-sort"

87457

},

87458

{

87459

"file": "resize/js/resize-base.js",

87460

"line": 168,

87461

"description": "Static property provides a string to identify the class.",

87462

"itemtype": "property",

87463

"name": "NAME",

87464

"type": "String",

87465

"static": 1,

87466

"class": "Resize",

87467

"module": "resize"

87468

},

87469

{

87470

"file": "resize/js/resize-base.js",

87471

"line": 177,

87472

"description": "Static property used to define the default attribute\nconfiguration for the Resize.",

87473

"itemtype": "property",

87474

"name": "ATTRS",

87475

"type": "Object",

87476

"static": 1,

87477

"class": "Resize",

87478

"module": "resize"

87479

},

87480

{

87481

"file": "resize/js/resize-base.js",

87482

"line": 186,

87483

"description": "Stores the active handle during the resize.",

87484

"itemtype": "attribute",

87485

"name": "activeHandle",

87486

"default": "null",

87487

"access": "private",

87488

"tagname": "",

87489

"type": "String",

87490

"class": "Resize",

87491

"module": "resize"

87492

},

87493

{

87494

"file": "resize/js/resize-base.js",

87495

"line": 201,

87496

"description": "Stores the active handle element during the resize.",

87497

"itemtype": "attribute",

87498

"name": "activeHandleNode",

87499

"default": "null",

87500

"access": "private",

87501

"tagname": "",

87502

"type": "Node",

87503

"class": "Resize",

87504

"module": "resize"

87505

},

87506

{

87507

"file": "resize/js/resize-base.js",

87508

"line": 214,

87509

"description": "False to ensure that the resize handles are always visible, true to\ndisplay them only when the user mouses over the resizable borders.",

87510

"itemtype": "attribute",

87511

"name": "autoHide",

87512

"default": "false",

87513

"type": "boolean",

87514

"class": "Resize",

87515

"module": "resize"

87516

},

87517

{

87518

"file": "resize/js/resize-base.js",

87519

"line": 227,

87520

"description": "The default minimum height of the element. Only used when\nResizeConstrained is not plugged.",

87521

"itemtype": "attribute",

87522

"name": "defMinHeight",

87523

"default": "15",

87524

"type": "Number",

87525

"class": "Resize",

87526

"module": "resize"

87527

},

87528

{

87529

"file": "resize/js/resize-base.js",

87530

"line": 240,

87531

"description": "The default minimum width of the element. Only used when\nResizeConstrained is not plugged.",

87532

"itemtype": "attribute",

87533

"name": "defMinWidth",

87534

"default": "15",

87535

"type": "Number",

87536

"class": "Resize",

87537

"module": "resize"

87538

},

87539

{

87540

"file": "resize/js/resize-base.js",

87541

"line": 253,

87542

"description": "The handles to use (any combination of): 't', 'b', 'r', 'l', 'bl',\n'br', 'tl', 'tr'. Can use a shortcut of All.",

87543

"itemtype": "attribute",

87544

"name": "handles",

87545

"default": "all",

87546

"type": "Array | String",

87547

"class": "Resize",

87548

"module": "resize"

87549

},

87550

{

87551

"file": "resize/js/resize-base.js",

87552

"line": 266,

87553

"description": "Node to wrap the resize handles.",

87554

"itemtype": "attribute",

87555

"name": "handlesWrapper",

87556

"type": "Node",

87557

"class": "Resize",

87558

"module": "resize"

87559

},

87560

{

87561

"file": "resize/js/resize-base.js",

87562

"line": 278,

87563

"description": "The selector or element to resize. Required.",

87564

"itemtype": "attribute",

87565

"name": "node",

87566

"type": "Node",

87567

"class": "Resize",

87568

"module": "resize"

87569

},

87570

{

87571

"file": "resize/js/resize-base.js",

87572

"line": 288,

87573

"description": "True when the element is being Resized.",

87574

"itemtype": "attribute",

87575

"name": "resizing",

87576

"default": "false",

87577

"type": "boolean",

87578

"class": "Resize",

87579

"module": "resize"

87580

},

87581

{

87582

"file": "resize/js/resize-base.js",

87583

"line": 300,

87584

"description": "True to wrap an element with a div if needed (required for textareas\nand images, defaults to false) in favor of the handles config option.\nThe wrapper element type (default div) could be over-riden passing the\n<code>wrapper</code> attribute.",

87585

"itemtype": "attribute",

87586

"name": "wrap",

87587

"default": "false",

87588

"type": "boolean",

87589

"class": "Resize",

87590

"module": "resize"

87591

},

87592

{

87593

"file": "resize/js/resize-base.js",

87594

"line": 316,

87595

"description": "Elements that requires a wrapper by default. Normally are elements\nwhich cannot have children elements.",

87596

"itemtype": "attribute",

87597

"name": "wrapTypes",

87598

87599

"readonly": "",

87600

"type": "Regex",

87601

"class": "Resize",

87602

"module": "resize"

87603

},

87604

{

87605

"file": "resize/js/resize-base.js",

87606

"line": 330,

87607

"description": "Element to wrap the <code>wrapTypes</code>. This element will house\nthe handles elements.",

87608

"itemtype": "attribute",

87609

"name": "wrapper",

87610

"default": "div",

87611

"type": "String | Node",

87612

"writeonce": "",

87613

"class": "Resize",

87614

"module": "resize"

87615

},

87616

{

87617

"file": "resize/js/resize-base.js",

87618

"line": 405,

87619

"description": "Array containing all possible resizable handles.",

87620

"itemtype": "property",

87621

"name": "ALL_HANDLES",

87622

"type": "{String}",

87623

"class": "Resize",

87624

"module": "resize"

87625

},

87626

{

87627

"file": "resize/js/resize-base.js",

87628

"line": 413,

87629

"description": "Regex which matches with the handles that could change the height of\nthe resizable element.",

87630

"itemtype": "property",

87631

"name": "REGEX_CHANGE_HEIGHT",

87632

"type": "{String}",

87633

"class": "Resize",

87634

"module": "resize"

87635

},

87636

{

87637

"file": "resize/js/resize-base.js",

87638

"line": 422,

87639

"description": "Regex which matches with the handles that could change the left of\nthe resizable element.",

87640

"itemtype": "property",

87641

"name": "REGEX_CHANGE_LEFT",

87642

"type": "{String}",

87643

"class": "Resize",

87644

"module": "resize"

87645

},

87646

{

87647

"file": "resize/js/resize-base.js",

87648

"line": 431,

87649

"description": "Regex which matches with the handles that could change the top of\nthe resizable element.",

87650

"itemtype": "property",

87651

"name": "REGEX_CHANGE_TOP",

87652

"type": "{String}",

87653

"class": "Resize",

87654

"module": "resize"

87655

},

87656

{

87657

"file": "resize/js/resize-base.js",

87658

"line": 440,

87659

"description": "Regex which matches with the handles that could change the width of\nthe resizable element.",

87660

"itemtype": "property",

87661

"name": "REGEX_CHANGE_WIDTH",

87662

"type": "{String}",

87663

"class": "Resize",

87664

"module": "resize"

87665

},

87666

{

87667

"file": "resize/js/resize-base.js",

87668

"line": 449,

87669

"description": "Template used to create the resize wrapper for the handles.",

87670

"itemtype": "property",

87671

"name": "HANDLES_WRAP_TEMPLATE",

87672

"type": "{String}",

87673

"class": "Resize",

87674

"module": "resize"

87675

},

87676

{

87677

"file": "resize/js/resize-base.js",

87678

"line": 457,

87679

"description": "Template used to create the resize wrapper node when needed.",

87680

"itemtype": "property",

87681

"name": "WRAP_TEMPLATE",

87682

"type": "{String}",

87683

"class": "Resize",

87684

"module": "resize"

87685

},

87686

{

87687

"file": "resize/js/resize-base.js",

87688

"line": 465,

87689

"description": "Template used to create each resize handle.",

87690

"itemtype": "property",

87691

"name": "HANDLE_TEMPLATE",

87692

"type": "{String}",

87693

"class": "Resize",

87694

"module": "resize"

87695

},

87696

{

87697

"file": "resize/js/resize-base.js",

87698

"line": 476,

87699

"description": "Each box has a content area and optional surrounding padding and\nborder areas. This property stores the sum of all horizontal\nsurrounding * information needed to adjust the node height.",

87700

"itemtype": "property",

87701

"name": "totalHSurrounding",

87702

"default": "0",

87703

"type": "number",

87704

"class": "Resize",

87705

"module": "resize"

87706

},

87707

{

87708

"file": "resize/js/resize-base.js",

87709

"line": 487,

87710

"description": "Each box has a content area and optional surrounding padding and\nborder areas. This property stores the sum of all vertical\nsurrounding * information needed to adjust the node height.",

87711

"itemtype": "property",

87712

"name": "totalVSurrounding",

87713

"default": "0",

87714

"type": "number",

87715

"class": "Resize",

87716

"module": "resize"

87717

},

87718

{

87719

"file": "resize/js/resize-base.js",

87720

"line": 498,

87721

"description": "Stores the <a href=\"Resize.html#attr_node\">node</a>\nsurrounding information retrieved from\n<a href=\"Resize.html#method__getBoxSurroundingInfo\">_getBoxSurroundingInfo</a>.",

87722

"itemtype": "property",

87723

"name": "nodeSurrounding",

87724

"type": "Object",

87725

"default": "null",

87726

"class": "Resize",

87727

"module": "resize"

87728

},

87729

{

87730

"file": "resize/js/resize-base.js",

87731

"line": 509,

87732

"description": "Stores the <a href=\"Resize.html#attr_wrapper\">wrapper</a>\nsurrounding information retrieved from\n<a href=\"Resize.html#method__getBoxSurroundingInfo\">_getBoxSurroundingInfo</a>.",

87733

"itemtype": "property",

87734

"name": "wrapperSurrounding",

87735

"type": "Object",

87736

"default": "null",

87737

"class": "Resize",

87738

"module": "resize"

87739

},

87740

{

87741

"file": "resize/js/resize-base.js",

87742

"line": 520,

87743

"description": "Whether the handle being dragged can change the height.",

87744

"itemtype": "property",

87745

"name": "changeHeightHandles",

87746

"default": "false",

87747

"type": "boolean",

87748

"class": "Resize",

87749

"module": "resize"

87750

},

87751

{

87752

"file": "resize/js/resize-base.js",

87753

"line": 529,

87754

"description": "Whether the handle being dragged can change the left.",

87755

"itemtype": "property",

87756

"name": "changeLeftHandles",

87757

"default": "false",

87758

"type": "boolean",

87759

"class": "Resize",

87760

"module": "resize"

87761

},

87762

{

87763

"file": "resize/js/resize-base.js",

87764

"line": 538,

87765

"description": "Whether the handle being dragged can change the top.",

87766

"itemtype": "property",

87767

"name": "changeTopHandles",

87768

"default": "false",

87769

"type": "boolean",

87770

"class": "Resize",

87771

"module": "resize"

87772

},

87773

{

87774

"file": "resize/js/resize-base.js",

87775

"line": 547,

87776

"description": "Whether the handle being dragged can change the width.",

87777

"itemtype": "property",

87778

"name": "changeWidthHandles",

87779

"default": "false",

87780

"type": "boolean",

87781

"class": "Resize",

87782

"module": "resize"

87783

},

87784

{

87785

"file": "resize/js/resize-base.js",

87786

"line": 556,

87787

"description": "Store DD.Delegate reference for the respective Resize instance.",

87788

"itemtype": "property",

87789

"name": "delegate",

87790

"default": "null",

87791

"type": "Object",

87792

"class": "Resize",

87793

"module": "resize"

87794

},

87795

{

87796

"file": "resize/js/resize-base.js",

87797

"line": 565,

87798

"description": "Stores the current values for the height, width, top and left. You are\nable to manipulate these values on resize in order to change the resize\nbehavior.",

87799

"itemtype": "property",

87800

"name": "info",

87801

"type": "Object",

87802

"access": "protected",

87803

"tagname": "",

87804

"class": "Resize",

87805

"module": "resize"

87806

},

87807

{

87808

"file": "resize/js/resize-base.js",

87809

"line": 576,

87810

"description": "Stores the last values for the height, width, top and left.",

87811

"itemtype": "property",

87812

"name": "lastInfo",

87813

"type": "Object",

87814

"access": "protected",

87815

"tagname": "",

87816

"class": "Resize",

87817

"module": "resize"

87818

},

87819

{

87820

"file": "resize/js/resize-base.js",

87821

"line": 585,

87822

"description": "Stores the original values for the height, width, top and left, stored\non resize start.",

87823

"itemtype": "property",

87824

"name": "originalInfo",

87825

"type": "Object",

87826

"access": "protected",

87827

"tagname": "",

87828

"class": "Resize",

87829

"module": "resize"

87830

},

87831

{

87832

"file": "resize/js/resize-base.js",

87833

"line": 595,

87834

"description": "Construction logic executed during Resize instantiation. Lifecycle.",

87835

"itemtype": "method",

87836

"name": "initializer",

87837

"access": "protected",

87838

"tagname": "",

87839

"class": "Resize",

87840

"module": "resize"

87841

},

87842

{

87843

"file": "resize/js/resize-base.js",

87844

"line": 605,

87845

"description": "Create the DOM structure for the Resize. Lifecycle.",

87846

"itemtype": "method",

87847

"name": "renderUI",

87848

"access": "protected",

87849

"tagname": "",

87850

"class": "Resize",

87851

"module": "resize"

87852

},

87853

{

87854

"file": "resize/js/resize-base.js",

87855

"line": 617,

87856

"description": "Bind the events on the Resize UI. Lifecycle.",

87857

"itemtype": "method",

87858

"name": "bindUI",

87859

"access": "protected",

87860

"tagname": "",

87861

"class": "Resize",

87862

"module": "resize"

87863

},

87864

{

87865

"file": "resize/js/resize-base.js",

87866

"line": 631,

87867

"description": "Sync the Resize UI.",

87868

"itemtype": "method",

87869

"name": "syncUI",

87870

"access": "protected",

87871

"tagname": "",

87872

"class": "Resize",

87873

"module": "resize"

87874

},

87875

{

87876

"file": "resize/js/resize-base.js",

87877

"line": 648,

87878

"description": "Descructor lifecycle implementation for the Resize class. Purges events attached\nto the node (and all child nodes) and removes the Resize handles.",

87879

"itemtype": "method",

87880

"name": "destructor",

87881

"access": "protected",

87882

"tagname": "",

87883

"class": "Resize",

87884

"module": "resize"

87885

},

87886

{

87887

"file": "resize/js/resize-base.js",

87888

"line": 687,

87889

"description": "Creates DOM (or manipulates DOM for progressive enhancement)\nThis method is invoked by initializer(). It's chained automatically for\nsubclasses if required.",

87890

"itemtype": "method",

87891

"name": "renderer",

87892

"access": "protected",

87893

"tagname": "",

87894

"class": "Resize",

87895

"module": "resize"

87896

},

87897

{

87898

"file": "resize/js/resize-base.js",

87899

"line": 701,

87900

"description": "Loop through each handle which is being used and executes a callback.\nExample:\n<pre><code>instance.eachHandle(\n function(handleName, index) { ... }\n );</code></pre>",

87901

"itemtype": "method",

87902

"name": "eachHandle",

87903

"params": [

87904

{

87905

"name": "fn",

87906

"description": "Callback function to be executed for each handle.",

87907

"type": "Function"

87908

}

87909

],

87910

"class": "Resize",

87911

"module": "resize"

87912

},

87913

{

87914

"file": "resize/js/resize-base.js",

87915

"line": 726,

87916

"description": "Bind the handles DragDrop events to the Resize instance.",

87917

"itemtype": "method",

87918

"name": "_bindDD",

87919

"access": "private",

87920

"tagname": "",

87921

"class": "Resize",

87922

"module": "resize"

87923

},

87924

{

87925

"file": "resize/js/resize-base.js",

87926

"line": 756,

87927

"description": "Bind the events related to the handles (_onHandleMouseEnter, _onHandleMouseLeave).",

87928

"itemtype": "method",

87929

"name": "_bindHandle",

87930

"access": "private",

87931

"tagname": "",

87932

"class": "Resize",

87933

"module": "resize"

87934

},

87935

{

87936

"file": "resize/js/resize-base.js",

87937

"line": 772,

87938

"description": "Create the custom events used on the Resize.",

87939

"itemtype": "method",

87940

"name": "_createEvents",

87941

"access": "private",

87942

"tagname": "",

87943

"class": "Resize",

87944

"module": "resize"

87945

},

87946

{

87947

"file": "resize/js/resize-base.js",

87948

"line": 791,

87949

"description": "Handles the resize start event. Fired when a handle starts to be\ndragged.",

87950

"itemtype": "event",

87951

"name": "resize:start",

87952

"preventable": "_defResizeStartFn",

87953

"params": [

87954

{

87955

"name": "event",

87956

"description": "The resize start event.",

87957

"type": "Event.Facade"

87958

}

87959

],

87960

"bubbles": "Resize",

87961

"type": "{Event.Custom}",

87962

"class": "Resize",

87963

"module": "resize"

87964

},

87965

{

87966

"file": "resize/js/resize-base.js",

87967

"line": 803,

87968

"description": "Handles the resize event. Fired on each pixel when the handle is\nbeing dragged.",

87969

"itemtype": "event",

87970

"name": "resize:resize",

87971

"preventable": "_defResizeFn",

87972

"params": [

87973

{

87974

"name": "event",

87975

"description": "The resize event.",

87976

"type": "Event.Facade"

87977

}

87978

],

87979

"bubbles": "Resize",

87980

"type": "{Event.Custom}",

87981

"class": "Resize",

87982

"module": "resize"

87983

},

87984

{

87985

"file": "resize/js/resize-base.js",

87986

"line": 815,

87987

"description": "Handles the resize align event.",

87988

"itemtype": "event",

87989

"name": "resize:align",

87990

"preventable": "_defResizeAlignFn",

87991

"params": [

87992

{

87993

"name": "event",

87994

"description": "The resize align event.",

87995

"type": "Event.Facade"

87996

}

87997

],

87998

"bubbles": "Resize",

87999

"type": "{Event.Custom}",

88000

"class": "Resize",

88001

"module": "resize"

88002

},

88003

{

88004

"file": "resize/js/resize-base.js",

88005

"line": 826,

88006

"description": "Handles the resize end event. Fired when a handle stop to be\ndragged.",

88007

"itemtype": "event",

88008

"name": "resize:end",

88009

"preventable": "_defResizeEndFn",

88010

"params": [

88011

{

88012

"name": "event",

88013

"description": "The resize end event.",

88014

"type": "Event.Facade"

88015

}

88016

],

88017

"bubbles": "Resize",

88018

"type": "{Event.Custom}",

88019

"class": "Resize",

88020

"module": "resize"

88021

},

88022

{

88023

"file": "resize/js/resize-base.js",

88024

"line": 838,

88025

"description": "Handles the resize mouseUp event. Fired when a mouseUp event happens on a\nhandle.",

88026

"itemtype": "event",

88027

"name": "resize:mouseUp",

88028

"preventable": "_defMouseUpFn",

88029

"params": [

88030

{

88031

"name": "event",

88032

"description": "The resize mouseUp event.",

88033

"type": "Event.Facade"

88034

}

88035

],

88036

"bubbles": "Resize",

88037

"type": "{Event.Custom}",

88038

"class": "Resize",

88039

"module": "resize"

88040

},

88041

{

88042

"file": "resize/js/resize-base.js",

88043

"line": 851,

88044

"description": "Responsible for loop each handle element and append to the wrapper.",

88045

"itemtype": "method",

88046

"name": "_renderHandles",

88047

"access": "protected",

88048

"tagname": "",

88049

"class": "Resize",

88050

"module": "resize"

88051

},

88052

{

88053

"file": "resize/js/resize-base.js",

88054

"line": 869,

88055

"description": "Creates the handle element based on the handle name and initialize the\nDragDrop on it.",

88056

"itemtype": "method",

88057

"name": "_buildHandle",

88058

"params": [

88059

{

88060

"name": "handle",

88061

"description": "Handle name ('t', 'tr', 'b', ...).",

88062

"type": "String"

88063

}

88064

],

88065

"access": "protected",

88066

"tagname": "",

88067

"class": "Resize",

88068

"module": "resize"

88069

},

88070

{

88071

"file": "resize/js/resize-base.js",

88072

"line": 887,

88073

"description": "Basic resize calculations.",

88074

"itemtype": "method",

88075

"name": "_calcResize",

88076

"access": "protected",

88077

"tagname": "",

88078

"class": "Resize",

88079

"module": "resize"

88080

},

88081

{

88082

"file": "resize/js/resize-base.js",

88083

"line": 910,

88084

"description": "Helper method to update the current size value on\n<a href=\"Resize.html#property_info\">info</a> to respect the\nmin/max values and fix the top/left calculations.",

88085

"itemtype": "method",

88086

"name": "_checkSize",

88087

"params": [

88088

{

88089

"name": "offset",

88090

"description": "'offsetHeight' or 'offsetWidth'",

88091

"type": "String"

88092

},

88093

{

88094

"name": "size",

88095

"description": "Size to restrict the offset",

88096

"type": "Number"

88097

}

88098

],

88099

"access": "protected",

88100

"tagname": "",

88101

"class": "Resize",

88102

"module": "resize"

88103

},

88104

{

88105

"file": "resize/js/resize-base.js",

88106

"line": 938,

88107

"description": "Copy relevant styles of the <a href=\"Resize.html#attr_node\">node</a>\nto the <a href=\"Resize.html#attr_wrapper\">wrapper</a>.",

88108

"itemtype": "method",

88109

"name": "_copyStyles",

88110

"params": [

88111

{

88112

"name": "node",

88113

"description": "Node from.",

88114

"type": "Node"

88115

},

88116

{

88117

"name": "wrapper",

88118

"description": "Node to.",

88119

"type": "Node"

88120

}

88121

],

88122

"access": "protected",

88123

"tagname": "",

88124

"class": "Resize",

88125

"module": "resize"

88126

},

88127

{

88128

"file": "resize/js/resize-base.js",

88129

"line": 993,

88130

"description": "Generates metadata to the <a href=\"Resize.html#property_info\">info</a>\nand <a href=\"Resize.html#property_originalInfo\">originalInfo</a>\n<pre><code>bottom, actXY, left, top, offsetHeight, offsetWidth, right</code></pre>",

88131

"itemtype": "method",

88132

"name": "_getInfo",

88133

"params": [

88134

{

88135

"name": "node",

88136

"description": "",

88137

"type": "Node"

88138

},

88139

{

88140

"name": "event",

88141

"description": "",

88142

"type": "EventFacade"

88143

}

88144

],

88145

"access": "private",

88146

"tagname": "",

88147

"class": "Resize",

88148

"module": "resize"

88149

},

88150

{

88151

"file": "resize/js/resize-base.js",

88152

"line": 1028,

88153

"description": "Each box has a content area and optional surrounding margin,\npadding and * border areas. This method get all this information from\nthe passed node. For more reference see\n<a href=\"http://www.w3.org/TR/CSS21/box.html#box-dimensions\">\nhttp://www.w3.org/TR/CSS21/box.html#box-dimensions</a>.",

88154

"itemtype": "method",

88155

"name": "_getBoxSurroundingInfo",

88156

"params": [

88157

{

88158

"name": "node",

88159

"description": "",

88160

"type": "Node"

88161

}

88162

],

88163

"access": "private",

88164

"tagname": "",

88165

"return": {

88166

"description": "",

88167

"type": "Object"

88168

},

88169

"class": "Resize",

88170

"module": "resize"

88171

},

88172

{

88173

"file": "resize/js/resize-base.js",

88174

"line": 1071,

88175

"description": "Sync the Resize UI with internal values from\n<a href=\"Resize.html#property_info\">info</a>.",

88176

"itemtype": "method",

88177

"name": "_syncUI",

88178

"access": "protected",

88179

"tagname": "",

88180

"class": "Resize",

88181

"module": "resize"

88182

},

88183

{

88184

"file": "resize/js/resize-base.js",

88185

"line": 1106,

88186

"description": "Update <code>instance.changeHeightHandles,\ninstance.changeLeftHandles, instance.changeTopHandles,\ninstance.changeWidthHandles</code> information.",

88187

"itemtype": "method",

88188

"name": "_updateChangeHandleInfo",

88189

"access": "private",

88190

"tagname": "",

88191

"class": "Resize",

88192

"module": "resize"

88193

},

88194

{

88195

"file": "resize/js/resize-base.js",

88196

"line": 1123,

88197

"description": "Update <a href=\"Resize.html#property_info\">info</a> values (bottom, actXY, left, top, offsetHeight, offsetWidth, right).",

88198

"itemtype": "method",

88199

"name": "_updateInfo",

88200

"access": "private",

88201

"tagname": "",

88202

"class": "Resize",

88203

"module": "resize"

88204

},

88205

{

88206

"file": "resize/js/resize-base.js",

88207

"line": 1135,

88208

"description": "Update properties\n<a href=\"Resize.html#property_nodeSurrounding\">nodeSurrounding</a>,\n<a href=\"Resize.html#property_nodeSurrounding\">wrapperSurrounding</a>,\n<a href=\"Resize.html#property_nodeSurrounding\">totalVSurrounding</a>,\n<a href=\"Resize.html#property_nodeSurrounding\">totalHSurrounding</a>.",

88209

"itemtype": "method",

88210

"name": "_updateSurroundingInfo",

88211

"access": "private",

88212

"tagname": "",

88213

"class": "Resize",

88214

"module": "resize"

88215

},

88216

{

88217

"file": "resize/js/resize-base.js",

88218

"line": 1159,

88219

"description": "Set the active state of the handles.",

88220

"itemtype": "method",

88221

"name": "_setActiveHandlesUI",

88222

"params": [

88223

{

88224

"name": "val",

88225

"description": "True to activate the handles, false to deactivate.",

88226

"type": "Boolean"

88227

}

88228

],

88229

"access": "protected",

88230

"tagname": "",

88231

"class": "Resize",

88232

"module": "resize"

88233

},

88234

{

88235

"file": "resize/js/resize-base.js",

88236

"line": 1187,

88237

"description": "Setter for the handles attribute",

88238

"itemtype": "method",

88239

"name": "_setHandles",

88240

"access": "protected",

88241

"tagname": "",

88242

"params": [

88243

{

88244

"name": "val",

88245

"description": "",

88246

"type": "String"

88247

}

88248

],

88249

"class": "Resize",

88250

"module": "resize"

88251

},

88252

{

88253

"file": "resize/js/resize-base.js",

88254

"line": 1226,

88255

"description": "Set the visibility of the handles.",

88256

"itemtype": "method",

88257

"name": "_setHideHandlesUI",

88258

"params": [

88259

{

88260

"name": "val",

88261

"description": "True to hide the handles, false to show.",

88262

"type": "Boolean"

88263

}

88264

],

88265

"access": "protected",

88266

"tagname": "",

88267

"class": "Resize",

88268

"module": "resize"

88269

},

88270

{

88271

"file": "resize/js/resize-base.js",

88272

"line": 1247,

88273

"description": "Setter for the wrap attribute",

88274

"itemtype": "method",

88275

"name": "_setWrap",

88276

"access": "protected",

88277

"tagname": "",

88278

"params": [

88279

{

88280

"name": "val",

88281

"description": "",

88282

"type": "Boolean"

88283

}

88284

],

88285

"class": "Resize",

88286

"module": "resize"

88287

},

88288

{

88289

"file": "resize/js/resize-base.js",

88290

"line": 1268,

88291

"description": "Default resize:mouseUp handler",

88292

"itemtype": "method",

88293

"name": "_defMouseUpFn",

88294

"params": [

88295

{

88296

"name": "event",

88297

"description": "The Event object",

88298

"type": "EventFacade"

88299

}

88300

],

88301

"access": "protected",

88302

"tagname": "",

88303

"class": "Resize",

88304

"module": "resize"

88305

},

88306

{

88307

"file": "resize/js/resize-base.js",

88308

"line": 1281,

88309

"description": "Default resize:resize handler",

88310

"itemtype": "method",

88311

"name": "_defResizeFn",

88312

"params": [

88313

{

88314

"name": "event",

88315

"description": "The Event object",

88316

"type": "EventFacade"

88317

}

88318

],

88319

"access": "protected",

88320

"tagname": "",

88321

"class": "Resize",

88322

"module": "resize"

88323

},

88324

{

88325

"file": "resize/js/resize-base.js",

88326

"line": 1294,

88327

"description": "Logic method for _defResizeFn. Allow AOP.",

88328

"itemtype": "method",

88329

"name": "_resize",

88330

"params": [

88331

{

88332

"name": "event",

88333

"description": "The Event object",

88334

"type": "EventFacade"

88335

}

88336

],

88337

"access": "protected",

88338

"tagname": "",

88339

"class": "Resize",

88340

"module": "resize"

88341

},

88342

{

88343

"file": "resize/js/resize-base.js",

88344

"line": 1310,

88345

"description": "Default resize:align handler",

88346

"itemtype": "method",

88347

"name": "_defResizeAlignFn",

88348

"params": [

88349

{

88350

"name": "event",

88351

"description": "The Event object",

88352

"type": "EventFacade"

88353

}

88354

],

88355

"access": "protected",

88356

"tagname": "",

88357

"class": "Resize",

88358

"module": "resize"

88359

},

88360

{

88361

"file": "resize/js/resize-base.js",

88362

"line": 1323,

88363

"description": "Logic method for _defResizeAlignFn. Allow AOP.",

88364

"itemtype": "method",

88365

"name": "_resizeAlign",

88366

"params": [

88367

{

88368

"name": "event",

88369

"description": "The Event object",

88370

"type": "EventFacade"

88371

}

88372

],

88373

"access": "protected",

88374

"tagname": "",

88375

"class": "Resize",

88376

"module": "resize"

88377

},

88378

{

88379

"file": "resize/js/resize-base.js",

88380

"line": 1361,

88381

"description": "Default resize:end handler",

88382

"itemtype": "method",

88383

"name": "_defResizeEndFn",

88384

"params": [

88385

{

88386

"name": "event",

88387

"description": "The Event object",

88388

"type": "EventFacade"

88389

}

88390

],

88391

"access": "protected",

88392

"tagname": "",

88393

"class": "Resize",

88394

"module": "resize"

88395

},

88396

{

88397

"file": "resize/js/resize-base.js",

88398

"line": 1374,

88399

"description": "Logic method for _defResizeEndFn. Allow AOP.",

88400

"itemtype": "method",

88401

"name": "_resizeEnd",

88402

"params": [

88403

{

88404

"name": "event",

88405

"description": "The Event object",

88406

"type": "EventFacade"

88407

}

88408

],

88409

"access": "protected",

88410

"tagname": "",

88411

"class": "Resize",

88412

"module": "resize"

88413

},

88414

{

88415

"file": "resize/js/resize-base.js",

88416

"line": 1399,

88417

"description": "Default resize:start handler",

88418

"itemtype": "method",

88419

"name": "_defResizeStartFn",

88420

"params": [

88421

{

88422

"name": "event",

88423

"description": "The Event object",

88424

"type": "EventFacade"

88425

}

88426

],

88427

"access": "protected",

88428

"tagname": "",

88429

"class": "Resize",

88430

"module": "resize"

88431

},

88432

{

88433

"file": "resize/js/resize-base.js",

88434

"line": 1412,

88435

"description": "Logic method for _defResizeStartFn. Allow AOP.",

88436

"itemtype": "method",

88437

"name": "_resizeStart",

88438

"params": [

88439

{

88440

"name": "event",

88441

"description": "The Event object",

88442

"type": "EventFacade"

88443

}

88444

],

88445

"access": "protected",

88446

"tagname": "",

88447

"class": "Resize",

88448

"module": "resize"

88449

},

88450

{

88451

"file": "resize/js/resize-base.js",

88452

"line": 1435,

88453

"description": "Fires the resize:mouseUp event.",

88454

"itemtype": "method",

88455

"name": "_handleMouseUpEvent",

88456

"params": [

88457

{

88458

"name": "event",

88459

"description": "resize:mouseUp event facade",

88460

"type": "EventFacade"

88461

}

88462

],

88463

"access": "protected",

88464

"tagname": "",

88465

"class": "Resize",

88466

"module": "resize"

88467

},

88468

{

88469

"file": "resize/js/resize-base.js",

88470

"line": 1446,

88471

"description": "Fires the resize:resize event.",

88472

"itemtype": "method",

88473

"name": "_handleResizeEvent",

88474

"params": [

88475

{

88476

"name": "event",

88477

"description": "resize:resize event facade",

88478

"type": "EventFacade"

88479

}

88480

],

88481

"access": "protected",

88482

"tagname": "",

88483

"class": "Resize",

88484

"module": "resize"

88485

},

88486

{

88487

"file": "resize/js/resize-base.js",

88488

"line": 1457,

88489

"description": "Fires the resize:align event.",

88490

"itemtype": "method",

88491

"name": "_handleResizeAlignEvent",

88492

"params": [

88493

{

88494

"name": "event",

88495

"description": "resize:resize event facade",

88496

"type": "EventFacade"

88497

}

88498

],

88499

"access": "protected",

88500

"tagname": "",

88501

"class": "Resize",

88502

"module": "resize"

88503

},

88504

{

88505

"file": "resize/js/resize-base.js",

88506

"line": 1468,

88507

"description": "Fires the resize:end event.",

88508

"itemtype": "method",

88509

"name": "_handleResizeEndEvent",

88510

"params": [

88511

{

88512

"name": "event",

88513

"description": "resize:end event facade",

88514

"type": "EventFacade"

88515

}

88516

],

88517

"access": "protected",

88518

"tagname": "",

88519

"class": "Resize",

88520

"module": "resize"

88521

},

88522

{

88523

"file": "resize/js/resize-base.js",

88524

"line": 1479,

88525

"description": "Fires the resize:start event.",

88526

"itemtype": "method",

88527

"name": "_handleResizeStartEvent",

88528

"params": [

88529

{

88530

"name": "event",

88531

"description": "resize:start event facade",

88532

"type": "EventFacade"

88533

}

88534

],

88535

"access": "protected",

88536

"tagname": "",

88537

"class": "Resize",

88538

"module": "resize"

88539

},

88540

{

88541

"file": "resize/js/resize-base.js",

88542

"line": 1494,

88543

"description": "Mouseenter event handler for the <a href=\"Resize.html#attr_wrapper\">wrapper</a>.",

88544

"itemtype": "method",

88545

"name": "_onWrapperMouseEnter",

88546

"params": [

88547

{

88548

"name": "event",

88549

"description": "",

88550

"type": "EventFacade"

88551

}

88552

],

88553

"access": "protected",

88554

"tagname": "",

88555

"class": "Resize",

88556

"module": "resize"

88557

},

88558

{

88559

"file": "resize/js/resize-base.js",

88560

"line": 1509,

88561

"description": "Mouseleave event handler for the <a href=\"Resize.html#attr_wrapper\">wrapper</a>.",

88562

"itemtype": "method",

88563

"name": "_onWrapperMouseLeave",

88564

"params": [

88565

{

88566

"name": "event",

88567

"description": "",

88568

"type": "EventFacade"

88569

}

88570

],

88571

"access": "protected",

88572

"tagname": "",

88573

"class": "Resize",

88574

"module": "resize"

88575

},

88576

{

88577

"file": "resize/js/resize-base.js",

88578

"line": 1524,

88579

"description": "Handles setting the activeHandle from a node, used from startDrag (for touch) and mouseenter (for mouse).",

88580

"itemtype": "method",

88581

"name": "_setHandleFromNode",

88582

"params": [

88583

{

88584

"name": "node",

88585

"description": "",

88586

"type": "Node"

88587

}

88588

],

88589

"access": "protected",

88590

"tagname": "",

88591

"class": "Resize",

88592

"module": "resize"

88593

},

88594

{

88595

"file": "resize/js/resize-base.js",

88596

"line": 1544,

88597

"description": "Mouseenter event handler for the handles.",

88598

"itemtype": "method",

88599

"name": "_onHandleMouseEnter",

88600

"params": [

88601

{

88602

"name": "event",

88603

"description": "",

88604

"type": "EventFacade"

88605

}

88606

],

88607

"access": "protected",

88608

"tagname": "",

88609

"class": "Resize",

88610

"module": "resize"

88611

},

88612

{

88613

"file": "resize/js/resize-base.js",

88614

"line": 1555,

88615

"description": "Mouseout event handler for the handles.",

88616

"itemtype": "method",

88617

"name": "_onHandleMouseLeave",

88618

"params": [

88619

{

88620

"name": "event",

88621

"description": "",

88622

"type": "EventFacade"

88623

}

88624

],

88625

"access": "protected",

88626

"tagname": "",

88627

"class": "Resize",

88628

"module": "resize"

88629

},

88630

{

88631

"file": "resize/js/resize-base.js",

88632

"line": 1570,

88633

"description": "Default value for the wrapper handles node attribute",

88634

"itemtype": "method",

88635

"name": "_valueHandlesWrapper",

88636

"access": "protected",

88637

"tagname": "",

88638

"readonly": "",

88639

"class": "Resize",

88640

"module": "resize"

88641

},

88642

{

88643

"file": "resize/js/resize-base.js",

88644

"line": 1581,

88645

"description": "Default value for the wrapper attribute",

88646

"itemtype": "method",

88647

"name": "_valueWrapper",

88648

"access": "protected",

88649

"tagname": "",

88650

"readonly": "",

88651

"class": "Resize",

88652

"module": "resize"

88653

},

88654

{

88655

"file": "resize/js/resize-constrain.js",

88656

"line": 64,

88657

"description": "Will attempt to constrain the resize node to the boundaries. Arguments: \n'view': Contrain to Viewport \n'#selector_string': Constrain to this node \n'{Region Object}': An Object Literal containing a valid region (top, right, bottom, left) of page positions",

88658

"itemtype": "attribute",

88659

"name": "constrain",

88660

"type": "{String|Object|Node}",

88661

"class": "Plugin.ResizeConstrained",

88662

"module": "resize",

88663

"submodule": "resize-contrain",

88664

"namespace": "Plugin"

88665

},

88666

{

88667

"file": "resize/js/resize-constrain.js",

88668

"line": 83,

88669

"description": "The minimum height of the element",

88670

"itemtype": "attribute",

88671

"name": "minHeight",

88672

"default": "15",

88673

"type": "Number",

88674

"class": "Plugin.ResizeConstrained",

88675

"module": "resize",

88676

"submodule": "resize-contrain",

88677

"namespace": "Plugin"

88678

},

88679

{

88680

"file": "resize/js/resize-constrain.js",

88681

"line": 95,

88682

"description": "The minimum width of the element",

88683

"itemtype": "attribute",

88684

"name": "minWidth",

88685

"default": "15",

88686

"type": "Number",

88687

"class": "Plugin.ResizeConstrained",

88688

"module": "resize",

88689

"submodule": "resize-contrain",

88690

"namespace": "Plugin"

88691

},

88692

{

88693

"file": "resize/js/resize-constrain.js",

88694

"line": 107,

88695

"description": "The maximum height of the element",

88696

"itemtype": "attribute",

88697

"name": "maxHeight",

88698

"default": "Infinity",

88699

"type": "Number",

88700

"class": "Plugin.ResizeConstrained",

88701

"module": "resize",

88702

"submodule": "resize-contrain",

88703

"namespace": "Plugin"

88704

},

88705

{

88706

"file": "resize/js/resize-constrain.js",

88707

"line": 119,

88708

"description": "The maximum width of the element",

88709

"itemtype": "attribute",

88710

"name": "maxWidth",

88711

"default": "Infinity",

88712

"type": "Number",

88713

"class": "Plugin.ResizeConstrained",

88714

"module": "resize",

88715

"submodule": "resize-contrain",

88716

"namespace": "Plugin"

88717

},

88718

{

88719

"file": "resize/js/resize-constrain.js",

88720

"line": 131,

88721

"description": "Maintain the element's ratio when resizing.",

88722

"itemtype": "attribute",

88723

"name": "preserveRatio",

88724

"default": "false",

88725

"type": "boolean",

88726

"class": "Plugin.ResizeConstrained",

88727

"module": "resize",

88728

"submodule": "resize-contrain",

88729

"namespace": "Plugin"

88730

},

88731

{

88732

"file": "resize/js/resize-constrain.js",

88733

"line": 143,

88734

"description": "The number of x ticks to span the resize to.",

88735

"itemtype": "attribute",

88736

"name": "tickX",

88737

"default": "false",

88738

"type": "Number | false",

88739

"class": "Plugin.ResizeConstrained",

88740

"module": "resize",

88741

"submodule": "resize-contrain",

88742

"namespace": "Plugin"

88743

},

88744

{

88745

"file": "resize/js/resize-constrain.js",

88746

"line": 154,

88747

"description": "The number of y ticks to span the resize to.",

88748

"itemtype": "attribute",

88749

"name": "tickY",

88750

"default": "false",

88751

"type": "Number | false",

88752

"class": "Plugin.ResizeConstrained",

88753

"module": "resize",

88754

"submodule": "resize-contrain",

88755

"namespace": "Plugin"

88756

},

88757

{

88758

"file": "resize/js/resize-constrain.js",

88759

"line": 168,

88760

"description": "Stores the <code>constrain</code>\nsurrounding information retrieved from\n<a href=\"Resize.html#method__getBoxSurroundingInfo\">_getBoxSurroundingInfo</a>.",

88761

"itemtype": "property",

88762

"name": "constrainSurrounding",

88763

"type": "Object",

88764

"default": "null",

88765

"class": "Plugin.ResizeConstrained",

88766

"module": "resize",

88767

"submodule": "resize-contrain",

88768

"namespace": "Plugin"

88769

},

88770

{

88771

"file": "resize/js/resize-constrain.js",

88772

"line": 195,

88773

"description": "Helper method to update the current values on\n<a href=\"Resize.html#property_info\">info</a> to respect the\nconstrain node.",

88774

"itemtype": "method",

88775

"name": "_checkConstrain",

88776

"params": [

88777

{

88778

"name": "axis",

88779

"description": "'top' or 'left'",

88780

"type": "String"

88781

},

88782

{

88783

"name": "axisConstrain",

88784

"description": "'bottom' or 'right'",

88785

"type": "String"

88786

},

88787

{

88788

"name": "offset",

88789

"description": "'offsetHeight' or 'offsetWidth'",

88790

"type": "String"

88791

}

88792

],

88793

"access": "protected",

88794

"tagname": "",

88795

"class": "Plugin.ResizeConstrained",

88796

"module": "resize",

88797

"submodule": "resize-contrain",

88798

"namespace": "Plugin"

88799

},

88800

{

88801

"file": "resize/js/resize-constrain.js",

88802

"line": 235,

88803

"description": "Update the current values on <a href=\"Resize.html#property_info\">info</a>\nto respect the maxHeight and minHeight.",

88804

"itemtype": "method",

88805

"name": "_checkHeight",

88806

"access": "protected",

88807

"tagname": "",

88808

"class": "Plugin.ResizeConstrained",

88809

"module": "resize",

88810

"submodule": "resize-contrain",

88811

"namespace": "Plugin"

88812

},

88813

{

88814

"file": "resize/js/resize-constrain.js",

88815

"line": 260,

88816

"description": "Update the current values on <a href=\"Resize.html#property_info\">info</a>\ncalculating the correct ratio for the other values.",

88817

"itemtype": "method",

88818

"name": "_checkRatio",

88819

"access": "protected",

88820

"tagname": "",

88821

"class": "Plugin.ResizeConstrained",

88822

"module": "resize",

88823

"submodule": "resize-contrain",

88824

"namespace": "Plugin"

88825

},

88826

{

88827

"file": "resize/js/resize-constrain.js",

88828

"line": 350,

88829

"description": "Check whether the resizable node is inside the constrain region.",

88830

"itemtype": "method",

88831

"name": "_checkRegion",

88832

"access": "protected",

88833

"tagname": "",

88834

"return": {

88835

"description": "",

88836

"type": "Boolean"

88837

},

88838

"class": "Plugin.ResizeConstrained",

88839

"module": "resize",

88840

"submodule": "resize-contrain",

88841

"namespace": "Plugin"

88842

},

88843

{

88844

"file": "resize/js/resize-constrain.js",

88845

"line": 365,

88846

"description": "Update the current values on <a href=\"Resize.html#property_info\">info</a>\nto respect the maxWidth and minWidth.",

88847

"itemtype": "method",

88848

"name": "_checkWidth",

88849

"access": "protected",

88850

"tagname": "",

88851

"class": "Plugin.ResizeConstrained",

88852

"module": "resize",

88853

"submodule": "resize-contrain",

88854

"namespace": "Plugin"

88855

},

88856

{

88857

"file": "resize/js/resize-constrain.js",

88858

"line": 390,

88859

"description": "Get the constrain region based on the <code>constrain</code>\nattribute.",

88860

"itemtype": "method",

88861

"name": "_getConstrainRegion",

88862

"access": "protected",

88863

"tagname": "",

88864

"return": {

88865

"description": "",

88866

"type": "Object Region"

88867

},

88868

"class": "Plugin.ResizeConstrained",

88869

"module": "resize",

88870

"submodule": "resize-contrain",

88871

"namespace": "Plugin"

88872

},

88873

{

88874

"file": "resize/js/resize-plugin.js",

88875

"line": 37,

88876

"itemtype": "property",

88877

"name": "NAME",

88878

"description": "resize-plugin",

88879

"type": "{String}",

88880

"class": "Plugin.Resize",

88881

"module": "resize",

88882

"submodule": "resize-plugin"

88883

},

88884

{

88885

"file": "resize/js/resize-plugin.js",

88886

"line": 44,

88887

"itemtype": "property",

88888

"name": "NS",

88889

"description": "The Resize instance will be placed on the Node instance under the resize namespace. It can be accessed via Node.resize or Widget.resize;",

88890

"type": "{String}",

88891

"class": "Plugin.Resize",

88892

"module": "resize",

88893

"submodule": "resize-plugin"

88894

},

88895

{

88896

"file": "resize/js/resize-plugin.js",

88897

"line": 51,

88898

"description": "Static property used to define the default attribute\nconfiguration for the Resize plugin.",

88899

"itemtype": "property",

88900

"name": "ATTRS",

88901

"type": "Object",

88902

"static": 1,

88903

"class": "Plugin.Resize",

88904

"module": "resize",

88905

"submodule": "resize-plugin"

88906

},

88907

{

88908

"file": "resize/js/resize-plugin.js",

88909

"line": 61,

88910

"description": "Stores the node that is being resized",

88911

"itemtype": "attribute",

88912

"name": "node",

88913

"default": "undefined",

88914

"access": "public",

88915

"tagname": "",

88916

"class": "Plugin.Resize",

88917

"module": "resize",

88918

"submodule": "resize-plugin"

88919

},

88920

{

88921

"file": "resize/js/resize-plugin.js",

88922

"line": 72,

88923

"description": "Stores the widget that the node belongs to, if one exists",

88924

"itemtype": "attribute",

88925

"name": "widget",

88926

"default": "undefined",

88927

"access": "public",

88928

"tagname": "",

88929

"class": "Plugin.Resize",

88930

"module": "resize",

88931

"submodule": "resize-plugin"

88932

},

88933

{

88934

"file": "resize/js/resize-plugin.js",

88935

"line": 87,

88936

"description": "Stores the values for node and widget, and sets up an event-listener",

88937

"itemtype": "method",

88938

"name": "initializer",

88939

"access": "protected",

88940

"tagname": "",

88941

"class": "Plugin.Resize",

88942

"module": "resize",

88943

"submodule": "resize-plugin"

88944

},

88945

{

88946

"file": "resize/js/resize-plugin.js",

88947

"line": 103,

88948

"description": "Updates the node's (x,y) values if they are changed via resizing.\nIf the node belongs to a widget, passes the widget down to _setWidgetProperties method",

88949

"itemtype": "method",

88950

"name": "_correctDimensions",

88951

"params": [

88952

{

88953

"name": "e",

88954

"description": "The Event object",

88955

"type": "EventFacade"

88956

}

88957

],

88958

"access": "private",

88959

"tagname": "",

88960

"class": "Plugin.Resize",

88961

"module": "resize",

88962

"submodule": "resize-plugin"

88963

},

88964

{

88965

"file": "resize/js/resize-plugin.js",

88966

"line": 140,

88967

"description": "If the host is a widget, then set the width, height. Then look for widgetPosition and set x,y",

88968

"itemtype": "method",

88969

"name": "_setWidgetProperties",

88970

"params": [

88971

{

88972

"name": "e",

88973

"description": "The Event object",

88974

"type": "EventFacade"

88975

},

88976

{

88977

"name": "x",

88978

"description": "Literal containing old x value and current x value",

88979

"type": "Object"

88980

},

88981

{

88982

"name": "y",

88983

"description": "Literal containing old y value and current y value",

88984

"type": "Object"

88985

}

88986

],

88987

"access": "private",

88988

"tagname": "",

88989

"class": "Plugin.Resize",

88990

"module": "resize",

88991

"submodule": "resize-plugin"

88992

},

88993

{

88994

"file": "resize/js/resize-plugin.js",

88995

"line": 183,

88996

"description": "a little utility method that returns a value if the old !== new, otherwise it returns false.",

88997

"itemtype": "method",

88998

"name": "_isDifferent",

88999

"params": [

89000

{

89001

"name": "oldVal",

89002

"description": "",

89003

"type": "Number"

89004

},

89005

{

89006

"name": "newVal",

89007

"description": "",

89008

"type": "Number"

89009

}

89010

],

89011

"access": "private",

89012

"tagname": "",

89013

"class": "Plugin.Resize",

89014

"module": "resize",

89015

"submodule": "resize-plugin"

89016

},

89017

{

89018

"file": "resize/js/resize-proxy.js",

89019

"line": 46,

89020

"description": "The Resize proxy element.",

89021

"itemtype": "attribute",

89022

"name": "proxyNode",

89023

"default": "Generated using an internal HTML markup",

89024

"type": "String|Node",

89025

"class": "Plugin.ResizeProxy",

89026

"module": "resize",

89027

"submodule": "resize-proxy",

89028

"namespace": "Plugin"

89029

},

89030

{

89031

"file": "resize/js/resize-proxy.js",

89032

"line": 63,

89033

"description": "Template used to create the resize proxy.",

89034

"itemtype": "property",

89035

"name": "PROXY_TEMPLATE",

89036

"type": "{String}",

89037

"class": "Plugin.ResizeProxy",

89038

"module": "resize",

89039

"submodule": "resize-proxy",

89040

"namespace": "Plugin"

89041

},

89042

{

89043

"file": "resize/js/resize-proxy.js",

89044

"line": 116,

89045

"description": "Render the <a href=\"ResizeProxy.html#attr_proxyNode\">proxyNode</a> element and\nmake it sibling of the <a href=\"Resize.html#attr_node\">node</a>.",

89046

"itemtype": "method",

89047

"name": "_renderProxy",

89048

"access": "protected",

89049

"tagname": "",

89050

"class": "Plugin.ResizeProxy",

89051

"module": "resize",

89052

"submodule": "resize-proxy",

89053

"namespace": "Plugin"

89054

},

89055

{

89056

"file": "resize/js/resize-proxy.js",

89057

"line": 135,

89058

"description": "Sync the proxy UI with internal values from\n<a href=\"ResizeProxy.html#property_info\">info</a>.",

89059

"itemtype": "method",

89060

"name": "_syncProxyUI",

89061

"access": "protected",

89062

"tagname": "",

89063

"class": "Plugin.ResizeProxy",

89064

"module": "resize",

89065

"submodule": "resize-proxy",

89066

"namespace": "Plugin"

89067

},

89068

{

89069

"file": "scrollview/js/ScrollViewBaseIE.js",

89070

"line": 9,

89071

"description": "Internal method to fix text selection in IE",

89072

"itemtype": "method",

89073

"name": "_fixIESelect",

89074

"access": "private",

89075

"tagname": "",

89076

"params": [

89077

{

89078

"name": "bb",

89079

"description": "The bounding box",

89080

"type": "Node"

89081

},

89082

{

89083

"name": "cb",

89084

"description": "The content box",

89085

"type": "Node"

89086

}

89087

],

89088

"class": "ScrollView",

89089

"module": "scrollview-base-ie"

89090

},

89091

{

89092

"file": "scrollview/js/ScrollViewBaseIE.js",

89093

"line": 29,

89094

"description": "Native onselectstart handle to prevent selection in IE",

89095

"itemtype": "method",

89096

"name": "_iePreventSelect",

89097

"access": "private",

89098

"tagname": "",

89099

"class": "ScrollView",

89100

"module": "scrollview-base-ie"

89101

},

89102

{

89103

"file": "scrollview/js/ScrollViewBaseIE.js",

89104

"line": 40,

89105

"description": "Restores native onselectstart handle, backed up to prevent selection in IE",

89106

"itemtype": "method",

89107

"name": "_ieRestoreSelect",

89108

"access": "private",

89109

"tagname": "",

89110

"class": "ScrollView",

89111

"module": "scrollview-base-ie"

89112

},

89113

{

89114

"file": "scrollview/js/list-plugin.js",

89115

"line": 29,

89116

"description": "The identity of the plugin",

89117

"itemtype": "property",

89118

"name": "NAME",

89119

"type": "String",

89120

"default": "'pluginList'",

89121

"static": 1,

89122

"class": "Plugin.ScrollViewList",

89123

"module": "scrollview-list",

89124

"namespace": "Plugin"

89125

},

89126

{

89127

"file": "scrollview/js/list-plugin.js",

89128

"line": 39,

89129

"description": "The namespace on which the plugin will reside.",

89130

"itemtype": "property",

89131

"name": "NS",

89132

"type": "String",

89133

"default": "'list'",

89134

"static": 1,

89135

"class": "Plugin.ScrollViewList",

89136

"module": "scrollview-list",

89137

"namespace": "Plugin"

89138

},

89139

{

89140

"file": "scrollview/js/list-plugin.js",

89141

"line": 50,

89142

"description": "The default attribute configuration for the plugin",

89143

"itemtype": "property",

89144

"name": "ATTRS",

89145

"type": "Object",

89146

"static": 1,

89147

"class": "Plugin.ScrollViewList",

89148

"module": "scrollview-list",

89149

"namespace": "Plugin"

89150

},

89151

{

89152

"file": "scrollview/js/list-plugin.js",

89153

"line": 59,

89154

"description": "Specifies whether the list elements (the immediate <ul>'s and the immediate <li>'s inside those <ul>'s) have class names attached to them or not",

89155

"itemtype": "attribute",

89156

"name": "isAttached",

89157

"type": "boolean",

89158

"deprecated": true,

89159

"deprecationMessage": "No real use for this attribute on the public API",

89160

"class": "Plugin.ScrollViewList",

89161

"module": "scrollview-list",

89162

"namespace": "Plugin"

89163

},

89164

{

89165

"file": "scrollview/js/list-plugin.js",

89166

"line": 74,

89167

"description": "Designated initializer",

89168

"itemtype": "method",

89169

"name": "initializer",

89170

"class": "Plugin.ScrollViewList",

89171

"module": "scrollview-list",

89172

"namespace": "Plugin"

89173

},

89174

{

89175

"file": "scrollview/js/paginator-plugin.js",

89176

"line": 29,

89177

"description": "The identity of the plugin",

89178

"itemtype": "property",

89179

"name": "NAME",

89180

"type": "String",

89181

"default": "'paginatorPlugin'",

89182

"static": 1,

89183

"class": "Plugin.ScrollViewPaginator",

89184

"module": "scrollview-paginator",

89185

"namespace": "Plugin"

89186

},

89187

{

89188

"file": "scrollview/js/paginator-plugin.js",

89189

"line": 39,

89190

"description": "The namespace on which the plugin will reside",

89191

"itemtype": "property",

89192

"name": "NS",

89193

"type": "String",

89194

"default": "'pages'",

89195

"static": 1,

89196

"class": "Plugin.ScrollViewPaginator",

89197

"module": "scrollview-paginator",

89198

"namespace": "Plugin"

89199

},

89200

{

89201

"file": "scrollview/js/paginator-plugin.js",

89202

"line": 49,

89203

"description": "The default attribute configuration for the plugin",

89204

"itemtype": "property",

89205

"name": "ATTRS",

89206

"type": "Object",

89207

"static": 1,

89208

"class": "Plugin.ScrollViewPaginator",

89209

"module": "scrollview-paginator",

89210

"namespace": "Plugin"

89211

},

89212

{

89213

"file": "scrollview/js/paginator-plugin.js",

89214

"line": 58,

89215

"description": "CSS selector for a page inside the scrollview. The scrollview\nwill snap to the closest page.",

89216

"itemtype": "attribute",

89217

"name": "selector",

89218

"type": "{String}",

89219

"class": "Plugin.ScrollViewPaginator",

89220

"module": "scrollview-paginator",

89221

"namespace": "Plugin"

89222

},

89223

{

89224

"file": "scrollview/js/paginator-plugin.js",

89225

"line": 69,

89226

"description": "The active page number for a paged scrollview",

89227

"itemtype": "attribute",

89228

"name": "index",

89229

"type": "{Number}",

89230

"default": "0",

89231

"class": "Plugin.ScrollViewPaginator",

89232

"module": "scrollview-paginator",

89233

"namespace": "Plugin"

89234

},

89235

{

89236

"file": "scrollview/js/paginator-plugin.js",

89237

"line": 80,

89238

"description": "The active page number for a paged scrollview",

89239

"itemtype": "attribute",

89240

"name": "index",

89241

"type": "{Number}",

89242

"default": "0",

89243

"class": "Plugin.ScrollViewPaginator",

89244

"module": "scrollview-paginator",

89245

"namespace": "Plugin"

89246

},

89247

{

89248

"file": "scrollview/js/paginator-plugin.js",

89249

"line": 91,

89250

"description": "The total number of pages",

89251

"itemtype": "attribute",

89252

"name": "total",

89253

"type": "{Number}",

89254

"default": "0",

89255

"class": "Plugin.ScrollViewPaginator",

89256

"module": "scrollview-paginator",

89257

"namespace": "Plugin"

89258

},

89259

{

89260

"file": "scrollview/js/paginator-plugin.js",

89261

"line": 109,

89262

"description": "Designated initializer",

89263

"itemtype": "method",

89264

"name": "initializer",

89265

"class": "Plugin.ScrollViewPaginator",

89266

"module": "scrollview-paginator",

89267

"namespace": "Plugin"

89268

},

89269

{

89270

"file": "scrollview/js/paginator-plugin.js",

89271

"line": 128,

89272

"description": "Calculate the page boundary offsets",

89273

"itemtype": "method",

89274

"name": "_calcOffsets",

89275

"access": "protected",

89276

"tagname": "",

89277

"class": "Plugin.ScrollViewPaginator",

89278

"module": "scrollview-paginator",

89279

"namespace": "Plugin"

89280

},

89281

{

89282

"file": "scrollview/js/paginator-plugin.js",

89283

"line": 173,

89284

"description": "Return the offset value where scrollview should scroll to.\nNeccesary because index # doesn't nessecarily map up to location in the DOM because of this._manageDOM()",

89285

"itemtype": "method",

89286

"name": "_getTargetOffset",

89287

"params": [

89288

{

89289

"name": "index",

89290

"description": "",

89291

"type": "Number"

89292

}

89293

],

89294

"return": {

89295

"description": "",

89296

"type": "Number"

89297

},

89298

"access": "protected",

89299

"tagname": "",

89300

"class": "Plugin.ScrollViewPaginator",

89301

"module": "scrollview-paginator",

89302

"namespace": "Plugin"

89303

},

89304

{

89305

"file": "scrollview/js/paginator-plugin.js",

89306

"line": 219,

89307

"description": "Executed to respond to the flick event, by over-riding the default flickFrame animation. \nThis is needed to determine if the next or prev page should be activated.",

89308

"itemtype": "method",

89309

"name": "_flickFrame",

89310

"access": "protected",

89311

"tagname": "",

89312

"class": "Plugin.ScrollViewPaginator",

89313

"module": "scrollview-paginator",

89314

"namespace": "Plugin"

89315

},

89316

{

89317

"file": "scrollview/js/paginator-plugin.js",

89318

"line": 244,

89319

"description": "After host render handler",

89320

"itemtype": "method",

89321

"name": "_afterRender",

89322

"params": [

89323

{

89324

"name": "UNKNOWN",

89325

"description": "",

89326

"type": "Event.Facade"

89327

}

89328

],

89329

"access": "protected",

89330

"tagname": "",

89331

"class": "Plugin.ScrollViewPaginator",

89332

"module": "scrollview-paginator",

89333

"namespace": "Plugin"

89334

},

89335

{

89336

"file": "scrollview/js/paginator-plugin.js",

89337

"line": 257,

89338

"description": "scrollEnd handler detects if a page needs to change",

89339

"itemtype": "method",

89340

"name": "_scrollEnded",

89341

"params": [

89342

{

89343

"name": "UNKNOWN",

89344

"description": "",

89345

"type": "Event.Facade"

89346

}

89347

],

89348

"access": "protected",

89349

"tagname": "",

89350

"class": "Plugin.ScrollViewPaginator",

89351

"module": "scrollview-paginator",

89352

"namespace": "Plugin"

89353

},

89354

{

89355

"file": "scrollview/js/paginator-plugin.js",

89356

"line": 294,

89357

"description": "Manages adding & removing slides from the DOM, to improve performance & memory usage",

89358

"since": "3.5.0",

89359

"itemtype": "method",

89360

"name": "_manageDOM",

89361

"access": "protected",

89362

"tagname": "",

89363

"class": "Plugin.ScrollViewPaginator",

89364

"module": "scrollview-paginator",

89365

"namespace": "Plugin"

89366

},

89367

{

89368

"file": "scrollview/js/paginator-plugin.js",

89369

"line": 341,

89370

"description": "index attr change handler",

89371

"itemtype": "method",

89372

"name": "_afterIndexChange",

89373

"params": [

89374

{

89375

"name": "UNKNOWN",

89376

"description": "",

89377

"type": "Event.Facade"

89378

}

89379

],

89380

"access": "protected",

89381

"tagname": "",

89382

"class": "Plugin.ScrollViewPaginator",

89383

"module": "scrollview-paginator",

89384

"namespace": "Plugin"

89385

},

89386

{

89387

"file": "scrollview/js/paginator-plugin.js",

89388

"line": 354,

89389

"description": "Update the UI based on the current page index",

89390

"itemtype": "method",

89391

"name": "_uiIndex",

89392

"params": [

89393

{

89394

"name": "index",

89395

"description": "",

89396

"type": "Number"

89397

}

89398

],

89399

"access": "protected",

89400

"tagname": "",

89401

"class": "Plugin.ScrollViewPaginator",

89402

"module": "scrollview-paginator",

89403

"namespace": "Plugin"

89404

},

89405

{

89406

"file": "scrollview/js/paginator-plugin.js",

89407

"line": 365,

89408

"description": "Scroll to the next page in the scrollview, with animation",

89409

"itemtype": "method",

89410

"name": "next",

89411

"class": "Plugin.ScrollViewPaginator",

89412

"module": "scrollview-paginator",

89413

"namespace": "Plugin"

89414

},

89415

{

89416

"file": "scrollview/js/paginator-plugin.js",

89417

"line": 377,

89418

"description": "Scroll to the previous page in the scrollview, with animation",

89419

"itemtype": "method",

89420

"name": "prev",

89421

"class": "Plugin.ScrollViewPaginator",

89422

"module": "scrollview-paginator",

89423

"namespace": "Plugin"

89424

},

89425

{

89426

"file": "scrollview/js/paginator-plugin.js",

89427

"line": 389,

89428

"description": "Scroll to a given page in the scrollview, with animation.",

89429

"itemtype": "method",

89430

"name": "scrollTo",

89431

"params": [

89432

{

89433

"name": "index",

89434

"description": "The index of the page to scroll to",

89435

"type": "Number"

89436

},

89437

{

89438

"name": "duration",

89439

"description": "The number of ms the animation should last",

89440

"type": "Number"

89441

},

89442

{

89443

"name": "easing",

89444

"description": "The timing function to use in the animation",

89445

"type": "String"

89446

}

89447

],

89448

"class": "Plugin.ScrollViewPaginator",

89449

"module": "scrollview-paginator",

89450

"namespace": "Plugin"

89451

},

89452

{

89453

"file": "scrollview/js/paginator-plugin.js",

89454

"line": 409,

89455

"description": "Snaps the scrollview to the currently selected page",

89456

"itemtype": "method",

89457

"name": "snapToCurrent",

89458

"params": [

89459

{

89460

"name": "duration",

89461

"description": "The number of ms the animation should last",

89462

"type": "Number"

89463

},

89464

{

89465

"name": "easing",

89466

"description": "The timing function to use in the animation",

89467

"type": "String"

89468

}

89469

],

89470

"class": "Plugin.ScrollViewPaginator",

89471

"module": "scrollview-paginator",

89472

"namespace": "Plugin"

89473

},

89474

{

89475

"file": "scrollview/js/paginator-plugin.js",

89476

"line": 432,

89477

"description": "The default snap to current duration and easing values used on scroll end.",

89478

"itemtype": "property",

89479

"name": "SNAP_TO_CURRENT",

89480

"static": 1,

89481

"class": "Plugin.ScrollViewPaginator",

89482

"module": "scrollview-paginator",

89483

"namespace": "Plugin"

89484

},

89485

{

89486

"file": "scrollview/js/scrollbars-plugin.js",

89487

"line": 73,

89488

"description": "The identity of the plugin",

89489

"itemtype": "property",

89490

"name": "NAME",

89491

"type": "String",

89492

"default": "'pluginScrollViewScrollbars'",

89493

"static": 1,

89494

"class": "Plugin.ScrollViewScrollbars",

89495

"module": "scrollview-scrollbars",

89496

"namespace": "Plugin"

89497

},

89498

{

89499

"file": "scrollview/js/scrollbars-plugin.js",

89500

"line": 83,

89501

"description": "The namespace on which the plugin will reside.",

89502

"itemtype": "property",

89503

"name": "NS",

89504

"type": "String",

89505

"default": "'scrollbars'",

89506

"static": 1,

89507

"class": "Plugin.ScrollViewScrollbars",

89508

"module": "scrollview-scrollbars",

89509

"namespace": "Plugin"

89510

},

89511

{

89512

"file": "scrollview/js/scrollbars-plugin.js",

89513

"line": 93,

89514

"description": "HTML template for the scrollbar",

89515

"itemtype": "property",

89516

"name": "SCROLLBAR_TEMPLATE",

89517

"type": "Object",

89518

"static": 1,

89519

"class": "Plugin.ScrollViewScrollbars",

89520

"module": "scrollview-scrollbars",

89521

"namespace": "Plugin"

89522

},

89523

{

89524

"file": "scrollview/js/scrollbars-plugin.js",

89525

"line": 108,

89526

"description": "The default attribute configuration for the plugin",

89527

"itemtype": "property",

89528

"name": "ATTRS",

89529

"type": "Object",

89530

"static": 1,

89531

"class": "Plugin.ScrollViewScrollbars",

89532

"module": "scrollview-scrollbars",

89533

"namespace": "Plugin"

89534

},

89535

{

89536

"file": "scrollview/js/scrollbars-plugin.js",

89537

"line": 117,

89538

"description": "Vertical scrollbar node",

89539

"itemtype": "attribute",

89540

"name": "verticalNode",

89541

"type": "Y.Node",

89542

"class": "Plugin.ScrollViewScrollbars",

89543

"module": "scrollview-scrollbars",

89544

"namespace": "Plugin"

89545

},

89546

{

89547

"file": "scrollview/js/scrollbars-plugin.js",

89548

"line": 128,

89549

"description": "Horizontal scrollbar node",

89550

"itemtype": "attribute",

89551

"name": "horizontalNode",

89552

"type": "Y.Node",

89553

"class": "Plugin.ScrollViewScrollbars",

89554

"module": "scrollview-scrollbars",

89555

"namespace": "Plugin"

89556

},

89557

{

89558

"file": "scrollview/js/scrollbars-plugin.js",

89559

"line": 142,

89560

"description": "Designated initializer",

89561

"itemtype": "method",

89562

"name": "initializer",

89563

"class": "Plugin.ScrollViewScrollbars",

89564

"module": "scrollview-scrollbars",

89565

"namespace": "Plugin"

89566

},

89567

{

89568

"file": "scrollview/js/scrollbars-plugin.js",

89569

"line": 155,

89570

"description": "Set up the DOM nodes for the scrollbars. This method is invoked whenever the\nhost's _uiDimensionsChange fires, giving us the opportunity to remove un-needed\nscrollbars, as well as add one if necessary.",

89571

"itemtype": "method",

89572

"name": "_hostDimensionsChange",

89573

"access": "protected",

89574

"tagname": "",

89575

"class": "Plugin.ScrollViewScrollbars",

89576

"module": "scrollview-scrollbars",

89577

"namespace": "Plugin"

89578

},

89579

{

89580

"file": "scrollview/js/scrollbars-plugin.js",

89581

"line": 174,

89582

"description": "Handler for the scrollEnd event fired by the host. Default implementation flashes the scrollbar",

89583

"itemtype": "method",

89584

"name": "_hostScrollEnd",

89585

"params": [

89586

{

89587

"name": "e",

89588

"description": "The event facade.",

89589

"type": "Event.Facade"

89590

}

89591

],

89592

"class": "Plugin.ScrollViewScrollbars",

89593

"module": "scrollview-scrollbars",

89594

"namespace": "Plugin"

89595

},

89596

{

89597

"file": "scrollview/js/scrollbars-plugin.js",

89598

"line": 186,

89599

"description": "Adds or removes a scrollbar node from the document.",

89600

"itemtype": "method",

89601

"name": "_renderBar",

89602

"access": "private",

89603

"tagname": "",

89604

"params": [

89605

{

89606

"name": "bar",

89607

"description": "The scrollbar node",

89608

"type": "Node"

89609

},

89610

{

89611

"name": "add",

89612

"description": "true, to add the node, false to remove it",

89613

"type": "Boolean"

89614

}

89615

],

89616

"class": "Plugin.ScrollViewScrollbars",

89617

"module": "scrollview-scrollbars",

89618

"namespace": "Plugin"

89619

},

89620

{

89621

"file": "scrollview/js/scrollbars-plugin.js",

89622

"line": 209,

89623

"description": "Caches scrollbar child element information,\nto optimize _update implementation",

89624

"itemtype": "method",

89625

"name": "_setChildCache",

89626

"access": "private",

89627

"tagname": "",

89628

"params": [

89629

{

89630

"name": "node",

89631

"description": "",

89632

"type": "Node"

89633

}

89634

],

89635

"class": "Plugin.ScrollViewScrollbars",

89636

"module": "scrollview-scrollbars",

89637

"namespace": "Plugin"

89638

},

89639

{

89640

"file": "scrollview/js/scrollbars-plugin.js",

89641

"line": 238,

89642

"description": "Clears child cache",

89643

"itemtype": "method",

89644

"name": "_clearChildCache",

89645

"access": "private",

89646

"tagname": "",

89647

"params": [

89648

{

89649

"name": "node",

89650

"description": "",

89651

"type": "Node"

89652

}

89653

],

89654

"class": "Plugin.ScrollViewScrollbars",

89655

"module": "scrollview-scrollbars",

89656

"namespace": "Plugin"

89657

},

89658

{

89659

"file": "scrollview/js/scrollbars-plugin.js",

89660

"line": 249,

89661

"description": "Utility method, to move/resize either vertical or horizontal scrollbars",

89662

"itemtype": "method",

89663

"name": "_updateBar",

89664

"access": "private",

89665

"tagname": "",

89666

"params": [

89667

{

89668

"name": "scrollbar",

89669

"description": "The scrollbar node.",

89670

"type": "Node"

89671

},

89672

{

89673

"name": "current",

89674

"description": "The current scroll position.",

89675

"type": "Number"

89676

},

89677

{

89678

"name": "duration",

89679

"description": "The transition duration.",

89680

"type": "Number"

89681

},

89682

{

89683

"name": "horiz",

89684

"description": "true if horizontal, false if vertical.",

89685

"type": "Boolean"

89686

}

89687

],

89688

"class": "Plugin.ScrollViewScrollbars",

89689

"module": "scrollview-scrollbars",

89690

"namespace": "Plugin"

89691

},

89692

{

89693

"file": "scrollview/js/scrollbars-plugin.js",

89694

"line": 408,

89695

"description": "AOP method, invoked after the host's _uiScrollTo method, \nto position and resize the scroll bars",

89696

"itemtype": "method",

89697

"name": "_update",

89698

"params": [

89699

{

89700

"name": "x",

89701

"description": "The current scrollX value",

89702

"type": "Number"

89703

},

89704

{

89705

"name": "y",

89706

"description": "The current scrollY value",

89707

"type": "Number"

89708

},

89709

{

89710

"name": "duration",

89711

"description": "Number of ms of animation (optional) - used when snapping to bounds",

89712

"type": "Number"

89713

},

89714

{

89715

"name": "easing",

89716

"description": "Optional easing equation to use during the animation, if duration is set",

89717

"type": "String"

89718

}

89719

],

89720

"access": "protected",

89721

"tagname": "",

89722

"class": "Plugin.ScrollViewScrollbars",

89723

"module": "scrollview-scrollbars",

89724

"namespace": "Plugin"

89725

},

89726

{

89727

"file": "scrollview/js/scrollbars-plugin.js",

89728

"line": 440,

89729

"description": "Show the scroll bar indicators",

89730

"itemtype": "method",

89731

"name": "show",

89732

"params": [

89733

{

89734

"name": "animated",

89735

"description": "Whether or not to animate the showing",

89736

"type": "Boolean"

89737

}

89738

],

89739

"class": "Plugin.ScrollViewScrollbars",

89740

"module": "scrollview-scrollbars",

89741

"namespace": "Plugin"

89742

},

89743

{

89744

"file": "scrollview/js/scrollbars-plugin.js",

89745

"line": 450,

89746

"description": "Hide the scroll bar indicators",

89747

"itemtype": "method",

89748

"name": "hide",

89749

"params": [

89750

{

89751

"name": "animated",

89752

"description": "Whether or not to animate the hiding",

89753

"type": "Boolean"

89754

}

89755

],

89756

"class": "Plugin.ScrollViewScrollbars",

89757

"module": "scrollview-scrollbars",

89758

"namespace": "Plugin"

89759

},

89760

{

89761

"file": "scrollview/js/scrollbars-plugin.js",

89762

"line": 460,

89763

"description": "Internal hide/show implementation utility method",

89764

"itemtype": "method",

89765

"name": "_show",

89766

"params": [

89767

{

89768

"name": "show",

89769

"description": "Whether to show or hide the scrollbar",

89770

"type": "Boolean"

89771

},

89772

{

89773

"name": "animated",

89774

"description": "Whether or not to animate while showing/hide",

89775

"type": "Bolean"

89776

}

89777

],

89778

"access": "protected",

89779

"tagname": "",

89780

"class": "Plugin.ScrollViewScrollbars",

89781

"module": "scrollview-scrollbars",

89782

"namespace": "Plugin"

89783

},

89784

{

89785

"file": "scrollview/js/scrollbars-plugin.js",

89786

"line": 498,

89787

"description": "Momentarily flash the scroll bars to indicate current scroll position",

89788

"itemtype": "method",

89789

"name": "flash",

89790

"class": "Plugin.ScrollViewScrollbars",

89791

"module": "scrollview-scrollbars",

89792

"namespace": "Plugin"

89793

},

89794

{

89795

"file": "scrollview/js/scrollbars-plugin.js",

89796

"line": 510,

89797

"description": "Setter for the verticalNode and horizontalNode attributes",

89798

"itemtype": "method",

89799

"name": "_setNode",

89800

"params": [

89801

{

89802

"name": "node",

89803

"description": "The Y.Node instance for the scrollbar",

89804

"type": "Node"

89805

},

89806

{

89807

"name": "name",

89808

"description": "The attribute name",

89809

"type": "String"

89810

}

89811

],

89812

"return": {

89813

"description": "The Y.Node instance for the scrollbar",

89814

"type": "Node"

89815

},

89816

"access": "protected",

89817

"tagname": "",

89818

"class": "Plugin.ScrollViewScrollbars",

89819

"module": "scrollview-scrollbars",

89820

"namespace": "Plugin"

89821

},

89822

{

89823

"file": "scrollview/js/scrollbars-plugin.js",

89824

"line": 534,

89825

"description": "Creates default node instances for scrollbars",

89826

"itemtype": "method",

89827

"name": "_defaultNode",

89828

"return": {

89829

"description": "The Y.Node instance for the scrollbar",

89830

"type": "Node"

89831

},

89832

"access": "protected",

89833

"tagname": "",

89834

"class": "Plugin.ScrollViewScrollbars",

89835

"module": "scrollview-scrollbars",

89836

"namespace": "Plugin"

89837

},

89838

{

89839

"file": "scrollview/js/scrollview-base.js",

89840

"line": 68,

89841

"description": "Designated initializer",

89842

"itemtype": "method",

89843

"name": "initializer",

89844

"class": "ScrollView",

89845

"module": "scrollview-base"

89846

},

89847

{

89848

"file": "scrollview/js/scrollview-base.js",

89849

"line": 74,

89850

"description": "Notification event fired at the end of a scroll transition",

89851

"itemtype": "event",

89852

"name": "scrollEnd",

89853

"params": [

89854

{

89855

"name": "e",

89856

"description": "The default event facade.",

89857

"type": "EventFacade"

89858

}

89859

],

89860

"class": "ScrollView",

89861

"module": "scrollview-base"

89862

},

89863

{

89864

"file": "scrollview/js/scrollview-base.js",

89865

"line": 81,

89866

"description": "Notification event fired at the end of a flick gesture (the flick animation may still be in progress)",

89867

"itemtype": "event",

89868

"name": "flick",

89869

"params": [

89870

{

89871

"name": "e",

89872

"description": "The default event facade.",

89873

"type": "EventFacade"

89874

}

89875

],

89876

"class": "ScrollView",

89877

"module": "scrollview-base"

89878

},

89879

{

89880

"file": "scrollview/js/scrollview-base.js",

89881

"line": 94,

89882

"description": "Override the contentBox sizing method, since the contentBox height\nshould not be that of the boundingBox.",

89883

"itemtype": "method",

89884

"name": "_uiSizeCB",

89885

"access": "protected",

89886

"tagname": "",

89887

"class": "ScrollView",

89888

"module": "scrollview-base"

89889

},

89890

{

89891

"file": "scrollview/js/scrollview-base.js",

89892

"line": 103,

89893

"description": "Content box transition callback",

89894

"itemtype": "method",

89895

"name": "_onTransEnd",

89896

"params": [

89897

{

89898

"name": "e",

89899

"description": "The event facade",

89900

"type": "Event.Facade"

89901

}

89902

],

89903

"access": "private",

89904

"tagname": "",

89905

"class": "ScrollView",

89906

"module": "scrollview-base"

89907

},

89908

{

89909

"file": "scrollview/js/scrollview-base.js",

89910

"line": 114,

89911

"description": "bindUI implementation\n\nHooks up events for the widget",

89912

"itemtype": "method",

89913

"name": "bindUI",

89914

"class": "ScrollView",

89915

"module": "scrollview-base"

89916

},

89917

{

89918

"file": "scrollview/js/scrollview-base.js",

89919

"line": 135,

89920

"itemtype": "method",

89921

"name": "_bindAttrs",

89922

"access": "private",

89923

"tagname": "",

89924

"class": "ScrollView",

89925

"module": "scrollview-base"

89926

},

89927

{

89928

"file": "scrollview/js/scrollview-base.js",

89929

"line": 168,

89930

"description": "Bind (or unbind) gesture move listeners required for drag support",

89931

"itemtype": "method",

89932

"name": "_bindDrag",

89933

"params": [

89934

{

89935

"name": "drag",

89936

"description": "If true, the method binds listener to enable drag (gesturemovestart). If false, the method unbinds gesturemove listeners for drag support.",

89937

"type": "Boolean"

89938

}

89939

],

89940

"access": "private",

89941

"tagname": "",

89942

"class": "ScrollView",

89943

"module": "scrollview-base"

89944

},

89945

{

89946

"file": "scrollview/js/scrollview-base.js",

89947

"line": 185,

89948

"description": "Bind (or unbind) flick listeners.",

89949

"itemtype": "method",

89950

"name": "_bindFlick",

89951

"params": [

89952

{

89953

"name": "flick",

89954

"description": "If truthy, the method binds listeners for flick support. If false, the method unbinds flick listeners.",

89955

"type": "Object|boolean"

89956

}

89957

],

89958

"access": "private",

89959

"tagname": "",

89960

"class": "ScrollView",

89961

"module": "scrollview-base"

89962

},

89963

{

89964

"file": "scrollview/js/scrollview-base.js",

89965

"line": 202,

89966

"description": "Bind (or unbind) mousewheel listeners.",

89967

"itemtype": "method",

89968

"name": "_bindMousewheel",

89969

"params": [

89970

{

89971

"name": "mousewheel",

89972

"description": "If truthy, the method binds listeners for mousewheel support. If false, the method unbinds mousewheel listeners.",

89973

"type": "Object|boolean"

89974

}

89975

],

89976

"access": "private",

89977

"tagname": "",

89978

"class": "ScrollView",

89979

"module": "scrollview-base"

89980

},

89981

{

89982

"file": "scrollview/js/scrollview-base.js",

89983

"line": 222,

89984

"description": "syncUI implementation.\n\nUpdate the scroll position, based on the current value of scrollX/scrollY.",

89985

"itemtype": "method",

89986

"name": "syncUI",

89987

"class": "ScrollView",

89988

"module": "scrollview-base"

89989

},

89990

{

89991

"file": "scrollview/js/scrollview-base.js",

89992

"line": 236,

89993

"description": "Scroll the element to a given xy coordinate",

89994

"itemtype": "method",

89995

"name": "scrollTo",

89996

"params": [

89997

{

89998

"name": "x",

89999

"description": "The x-position to scroll to",

90000

"type": "Number"

90001

},

90002

{

90003

"name": "y",

90004

"description": "The y-position to scroll to",

90005

"type": "Number"

90006

},

90007

{

90008

"name": "duration",

90009

"description": "Duration, in ms, of the scroll animation (default is 0)",

90010

"type": "Number"

90011

},

90012

{

90013

"name": "easing",

90014

"description": "An easing equation if duration is set",

90015

"type": "String"

90016

}

90017

],

90018

"class": "ScrollView",

90019

"module": "scrollview-base"

90020

},

90021

{

90022

"file": "scrollview/js/scrollview-base.js",

90023

"line": 316,

90024

"description": "Utility method, to create the translate transform string with the\nx, y translation amounts provided.",

90025

"itemtype": "method",

90026

"name": "_transform",

90027

"params": [

90028

{

90029

"name": "x",

90030

"description": "Number of pixels to translate along the x axis",

90031

"type": "Number"

90032

},

90033

{

90034

"name": "y",

90035

"description": "Number of pixels to translate along the y axis",

90036

"type": "Number"

90037

}

90038

],

90039

"access": "private",

90040

"tagname": "",

90041

"class": "ScrollView",

90042

"module": "scrollview-base"

90043

},

90044

{

90045

"file": "scrollview/js/scrollview-base.js",

90046

"line": 330,

90047

"description": "Utility method, to move the given element to the given xy position",

90048

"itemtype": "method",

90049

"name": "_moveTo",

90050

"params": [

90051

{

90052

"name": "node",

90053

"description": "The node to move",

90054

"type": "Node"

90055

},

90056

{

90057

"name": "x",

90058

"description": "The x-position to move to",

90059

"type": "Number"

90060

},

90061

{

90062

"name": "y",

90063

"description": "The y-position to move to",

90064

"type": "Number"

90065

}

90066

],

90067

"access": "private",

90068

"tagname": "",

90069

"class": "ScrollView",

90070

"module": "scrollview-base"

90071

},

90072

{

90073

"file": "scrollview/js/scrollview-base.js",

90074

"line": 348,

90075

"description": "Flag driving whether or not we should try and force H/W acceleration when transforming. Currently enabled by default for Webkit.\nUsed by the _transform method.",

90076

"itemtype": "property",

90077

"name": "_forceHWTransforms",

90078

"type": "boolean",

90079

"access": "protected",

90080

"tagname": "",

90081

"class": "ScrollView",

90082

"module": "scrollview-base"

90083

},

90084

{

90085

"file": "scrollview/js/scrollview-base.js",

90086

"line": 358,

90087

"description": "Used to control whether or not ScrollView's internal\ngesturemovestart, gesturemove and gesturemoveend\nevent listeners should preventDefault. The value is an\nobject, with \"start\", \"move\" and \"end\" properties used to \nspecify which events should preventDefault and which shouldn't:\n\n<pre>\n{\n start : false,\n move : true,\n end : false\n}\n</pre>\n\nThe default values are set up in order to prevent panning,\non touch devices, while allowing click listeners on elements inside \nthe ScrollView to be notified as expected.",

90088

"itemtype": "property",

90089

"name": "_prevent",

90090

"type": "Object",

90091

"access": "protected",

90092

"tagname": "",

90093

"class": "ScrollView",

90094

"module": "scrollview-base"

90095

},

90096

{

90097

"file": "scrollview/js/scrollview-base.js",

90098

"line": 387,

90099

"description": "gesturemovestart event handler",

90100

"itemtype": "method",

90101

"name": "_onGestureMoveStart",

90102

"params": [

90103

{

90104

"name": "e",

90105

"description": "The gesturemovestart event facade",

90106

"type": "Event.Facade"

90107

}

90108

],

90109

"access": "private",

90110

"tagname": "",

90111

"class": "ScrollView",

90112

"module": "scrollview-base"

90113

},

90114

{

90115

"file": "scrollview/js/scrollview-base.js",

90116

"line": 415,

90117

"description": "Internal state, defines whether or not the scrollview is currently being dragged",

90118

"itemtype": "property",

90119

"name": "_isDragging",

90120

"type": "boolean",

90121

"access": "protected",

90122

"tagname": "",

90123

"class": "ScrollView",

90124

"module": "scrollview-base"

90125

},

90126

{

90127

"file": "scrollview/js/scrollview-base.js",

90128

"line": 424,

90129

"description": "Internal state, defines whether or not the scrollview is currently animating a flick",

90130

"itemtype": "property",

90131

"name": "_flicking",

90132

"type": "boolean",

90133

"access": "protected",

90134

"tagname": "",

90135

"class": "ScrollView",

90136

"module": "scrollview-base"

90137

},

90138

{

90139

"file": "scrollview/js/scrollview-base.js",

90140

"line": 433,

90141

"description": "Internal state, defines whether or not the scrollview needs to snap to a boundary edge",

90142

"itemtype": "property",

90143

"name": "_snapToEdge",

90144

"type": "boolean",

90145

"access": "protected",

90146

"tagname": "",

90147

"class": "ScrollView",

90148

"module": "scrollview-base"

90149

},

90150

{

90151

"file": "scrollview/js/scrollview-base.js",

90152

"line": 444,

90153

"description": "gesturemove event handler",

90154

"itemtype": "method",

90155

"name": "_onGestureMove",

90156

"params": [

90157

{

90158

"name": "e",

90159

"description": "The gesturemove event facade",

90160

"type": "Event.Facade"

90161

}

90162

],

90163

"access": "private",

90164

"tagname": "",

90165

"class": "ScrollView",

90166

"module": "scrollview-base"

90167

},

90168

{

90169

"file": "scrollview/js/scrollview-base.js",

90170

"line": 472,

90171

"description": "gestureend event handler",

90172

"itemtype": "method",

90173

"name": "_onGestureMoveEnd",

90174

"params": [

90175

{

90176

"name": "e",

90177

"description": "The gesturemoveend event facade",

90178

"type": "Event.Facade"

90179

}

90180

],

90181

"access": "private",

90182

"tagname": "",

90183

"class": "ScrollView",

90184

"module": "scrollview-base"

90185

},

90186

{

90187

"file": "scrollview/js/scrollview-base.js",

90188

"line": 502,

90189

"description": "Internal state, defines whether or not the scrollview has been scrolled half it's width/height",

90190

"itemtype": "property",

90191

"name": "_scrolledHalfway",

90192

"type": "boolean",

90193

"access": "protected",

90194

"tagname": "",

90195

"class": "ScrollView",

90196

"module": "scrollview-base"

90197

},

90198

{

90199

"file": "scrollview/js/scrollview-base.js",

90200

"line": 511,

90201

"description": "Contains the distance (postive or negative) in pixels by which the scrollview was last scrolled. This is useful when\nsetting up click listeners on the scrollview content, which on mouse based devices are always fired, even after a\ndrag/flick. \n\nTouch based devices don't currently fire a click event, if the finger has been moved (beyond a threshold) so this check isn't required,\nif working in a purely touch based environment",

90202

"itemtype": "property",

90203

"name": "lastScrolledAmt",

90204

"type": "Number",

90205

"access": "public",

90206

"tagname": "",

90207

"class": "ScrollView",

90208

"module": "scrollview-base"

90209

},

90210

{

90211

"file": "scrollview/js/scrollview-base.js",

90212

"line": 529,

90213

"description": "Internal state, defines whether or not the scrollview has been scrolled in the forward (distance > 0), or backward (distance < 0) direction",

90214

"itemtype": "property",

90215

"name": "_scrolledForward",

90216

"type": "boolean",

90217

"access": "protected",

90218

"tagname": "",

90219

"class": "ScrollView",

90220

"module": "scrollview-base"

90221

},

90222

{

90223

"file": "scrollview/js/scrollview-base.js",

90224

"line": 573,

90225

"description": "After listener for changes to the scrollX or scrollY attribute",

90226

"itemtype": "method",

90227

"name": "_afterScrollChange",

90228

"params": [

90229

{

90230

"name": "e",

90231

"description": "The event facade",

90232

"type": "Event.Facade"

90233

}

90234

],

90235

"access": "protected",

90236

"tagname": "",

90237

"class": "ScrollView",

90238

"module": "scrollview-base"

90239

},

90240

{

90241

"file": "scrollview/js/scrollview-base.js",

90242

"line": 593,

90243

"description": "After listener for changes to the flick attribute",

90244

"itemtype": "method",

90245

"name": "_afterFlickChange",

90246

"params": [

90247

{

90248

"name": "e",

90249

"description": "The event facade",

90250

"type": "Event.Facade"

90251

}

90252

],

90253

"access": "protected",

90254

"tagname": "",

90255

"class": "ScrollView",

90256

"module": "scrollview-base"

90257

},

90258

{

90259

"file": "scrollview/js/scrollview-base.js",

90260

"line": 604,

90261

"description": "After listener for changes to the disabled attribute",

90262

"itemtype": "method",

90263

"name": "_afterDisabledChange",

90264

"params": [

90265

{

90266

"name": "e",

90267

"description": "The event facade",

90268

"type": "Event.Facade"

90269

}

90270

],

90271

"access": "protected",

90272

"tagname": "",

90273

"class": "ScrollView",

90274

"module": "scrollview-base"

90275

},

90276

{

90277

"file": "scrollview/js/scrollview-base.js",

90278

"line": 616,

90279

"description": "After listener for changes to the drag attribute",

90280

"itemtype": "method",

90281

"name": "_afterDragChange",

90282

"params": [

90283

{

90284

"name": "e",

90285

"description": "The event facade",

90286

"type": "Event.Facade"

90287

}

90288

],

90289

"access": "protected",

90290

"tagname": "",

90291

"class": "ScrollView",

90292

"module": "scrollview-base"

90293

},

90294

{

90295

"file": "scrollview/js/scrollview-base.js",

90296

"line": 627,

90297

"description": "Used to move the ScrollView content",

90298

"itemtype": "method",

90299

"name": "_uiScrollTo",

90300

"params": [

90301

{

90302

"name": "x",

90303

"description": "",

90304

"type": "Number"

90305

},

90306

{

90307

"name": "y",

90308

"description": "",

90309

"type": "Number"

90310

},

90311

{

90312

"name": "duration",

90313

"description": "",

90314

"type": "Number"

90315

},

90316

{

90317

"name": "easing",

90318

"description": "",

90319

"type": "String"

90320

}

90321

],

90322

"access": "protected",

90323

"tagname": "",

90324

"class": "ScrollView",

90325

"module": "scrollview-base"

90326

},

90327

{

90328

"file": "scrollview/js/scrollview-base.js",

90329

"line": 646,

90330

"description": "After listener for the height or width attribute",

90331

"itemtype": "method",

90332

"name": "_afterDimChange",

90333

"params": [

90334

{

90335

"name": "e",

90336

"description": "The event facade",

90337

"type": "Event.Facade"

90338

}

90339

],

90340

"access": "protected",

90341

"tagname": "",

90342

"class": "ScrollView",

90343

"module": "scrollview-base"

90344

},

90345

{

90346

"file": "scrollview/js/scrollview-base.js",

90347

"line": 657,

90348

"description": "Utility method to obtain scrollWidth, scrollHeight,\naccounting for the impact of translate on scrollWidth, scrollHeight",

90349

"itemtype": "method",

90350

"name": "_getScrollDims",

90351

"return": {

90352

"description": "The offsetWidth, offsetHeight, scrollWidth and scrollHeight as an array: [offsetWidth, offsetHeight, scrollWidth, scrollHeight]",

90353

"type": "Array"

90354

},

90355

"access": "private",

90356

"tagname": "",

90357

"class": "ScrollView",

90358

"module": "scrollview-base"

90359

},

90360

{

90361

"file": "scrollview/js/scrollview-base.js",

90362

"line": 699,

90363

"description": "This method gets invoked whenever the height or width attributes change,\nallowing us to determine which scrolling axes need to be enabled.",

90364

"itemtype": "method",

90365

"name": "_uiDimensionsChange",

90366

"access": "protected",

90367

"tagname": "",

90368

"class": "ScrollView",

90369

"module": "scrollview-base"

90370

},

90371

{

90372

"file": "scrollview/js/scrollview-base.js",

90373

"line": 750,

90374

"description": "Internal state, defines whether or not the scrollview can scroll vertically",

90375

"itemtype": "property",

90376

"name": "_scrollsVertical",

90377

"type": "boolean",

90378

"access": "protected",

90379

"tagname": "",

90380

"class": "ScrollView",

90381

"module": "scrollview-base"

90382

},

90383

{

90384

"file": "scrollview/js/scrollview-base.js",

90385

"line": 758,

90386

"description": "Internal state, defines the maximum amount that the scrollview can be scrolled along the Y axis",

90387

"itemtype": "property",

90388

"name": "_maxScrollY",

90389

"type": "number",

90390

"access": "protected",

90391

"tagname": "",

90392

"class": "ScrollView",

90393

"module": "scrollview-base"

90394

},

90395

{

90396

"file": "scrollview/js/scrollview-base.js",

90397

"line": 766,

90398

"description": "Internal state, defines the minimum amount that the scrollview can be scrolled along the Y axis",

90399

"itemtype": "property",

90400

"name": "_minScrollY",

90401

"type": "number",

90402

"access": "protected",

90403

"tagname": "",

90404

"class": "ScrollView",

90405

"module": "scrollview-base"

90406

},

90407

{

90408

"file": "scrollview/js/scrollview-base.js",

90409

"line": 774,

90410

"description": "Internal state, cached scrollHeight, for performance",

90411

"itemtype": "property",

90412

"name": "_scrollHeight",

90413

"type": "number",

90414

"access": "protected",

90415

"tagname": "",

90416

"class": "ScrollView",

90417

"module": "scrollview-base"

90418

},

90419

{

90420

"file": "scrollview/js/scrollview-base.js",

90421

"line": 782,

90422

"description": "Internal state, defines whether or not the scrollview can scroll horizontally",

90423

"itemtype": "property",

90424

"name": "_scrollsHorizontal",

90425

"type": "boolean",

90426

"access": "protected",

90427

"tagname": "",

90428

"class": "ScrollView",

90429

"module": "scrollview-base"

90430

},

90431

{

90432

"file": "scrollview/js/scrollview-base.js",

90433

"line": 790,

90434

"description": "Internal state, defines the maximum amount that the scrollview can be scrolled along the X axis",

90435

"itemtype": "property",

90436

"name": "_maxScrollX",

90437

"type": "number",

90438

"access": "protected",

90439

"tagname": "",

90440

"class": "ScrollView",

90441

"module": "scrollview-base"

90442

},

90443

{

90444

"file": "scrollview/js/scrollview-base.js",

90445

"line": 798,

90446

"description": "Internal state, defines the minimum amount that the scrollview can be scrolled along the X axis",

90447

"itemtype": "property",

90448

"name": "_minScrollX",

90449

"type": "number",

90450

"access": "protected",

90451

"tagname": "",

90452

"class": "ScrollView",

90453

"module": "scrollview-base"

90454

},

90455

{

90456

"file": "scrollview/js/scrollview-base.js",

90457

"line": 806,

90458

"description": "Internal state, cached scrollWidth, for performance",

90459

"itemtype": "property",

90460

"name": "_scrollWidth",

90461

"type": "number",

90462

"access": "protected",

90463

"tagname": "",

90464

"class": "ScrollView",

90465

"module": "scrollview-base"

90466

},

90467

{

90468

"file": "scrollview/js/scrollview-base.js",

90469

"line": 815,

90470

"description": "Execute a flick at the end of a scroll action",

90471

"itemtype": "method",

90472

"name": "_flick",

90473

"params": [

90474

{

90475

"name": "distance",

90476

"description": "The distance (in px) the user scrolled before the flick",

90477

"type": "Number"

90478

},

90479

{

90480

"name": "time",

90481

"description": "The number of ms the scroll event lasted before the flick",

90482

"type": "Number"

90483

}

90484

],

90485

"access": "protected",

90486

"tagname": "",

90487

"class": "ScrollView",

90488

"module": "scrollview-base"

90489

},

90490

{

90491

"file": "scrollview/js/scrollview-base.js",

90492

"line": 830,

90493

"description": "Internal state, currently calculated velocity from the flick",

90494

"itemtype": "property",

90495

"name": "_currentVelocity",

90496

"type": "number",

90497

"access": "protected",

90498

"tagname": "",

90499

"class": "ScrollView",

90500

"module": "scrollview-base"

90501

},

90502

{

90503

"file": "scrollview/js/scrollview-base.js",

90504

"line": 877,

90505

"description": "Execute a single frame in the flick animation",

90506

"itemtype": "method",

90507

"name": "_flickFrame",

90508

"access": "protected",

90509

"tagname": "",

90510

"class": "ScrollView",

90511

"module": "scrollview-base"

90512

},

90513

{

90514

"file": "scrollview/js/scrollview-base.js",

90515

"line": 962,

90516

"description": "Stop the animation timer",

90517

"itemtype": "method",

90518

"name": "_killTimer",

90519

"params": [

90520

{

90521

"name": "fireEvent",

90522

"description": "If true, fire the scrollEnd event",

90523

"type": "Boolean"

90524

}

90525

],

90526

"access": "protected",

90527

"tagname": "",

90528

"class": "ScrollView",

90529

"module": "scrollview-base"

90530

},

90531

{

90532

"file": "scrollview/js/scrollview-base.js",

90533

"line": 981,

90534

"description": "The scrollX, scrollY setter implementation",

90535

"itemtype": "method",

90536

"name": "_setScroll",

90537

"access": "private",

90538

"tagname": "",

90539

"params": [

90540

{

90541

"name": "val",

90542

"description": "",

90543

"type": "Number"

90544

},

90545

{

90546

"name": "dim",

90547

"description": "",

90548

"type": "String"

90549

}

90550

],

90551

"return": {

90552

"description": "The constrained value, if it exceeds min/max range",

90553

"type": "Number"

90554

},

90555

"class": "ScrollView",

90556

"module": "scrollview-base"

90557

},

90558

{

90559

"file": "scrollview/js/scrollview-base.js",

90560

"line": 1016,

90561

"description": "Setter for the scrollX attribute",

90562

"itemtype": "method",

90563

"name": "_setScrollX",

90564

"params": [

90565

{

90566

"name": "val",

90567

"description": "The new scrollX value",

90568

"type": "Number"

90569

}

90570

],

90571

"return": {

90572

"description": "The normalized value",

90573

"type": "Number"

90574

},

90575

"access": "protected",

90576

"tagname": "",

90577

"class": "ScrollView",

90578

"module": "scrollview-base"

90579

},

90580

{

90581

"file": "scrollview/js/scrollview-base.js",

90582

"line": 1028,

90583

"description": "Setter for the scrollY ATTR",

90584

"itemtype": "method",

90585

"name": "_setScrollY",

90586

"params": [

90587

{

90588

"name": "val",

90589

"description": "The new scrollY value",

90590

"type": "Number"

90591

}

90592

],

90593

"return": {

90594

"description": "The normalized value",

90595

"type": "Number"

90596

},

90597

"access": "protected",

90598

"tagname": "",

90599

"class": "ScrollView",

90600

"module": "scrollview-base"

90601

},

90602

{

90603

"file": "scrollview/js/scrollview-base.js",

90604

"line": 1044,

90605

"description": "The identity of the widget.",

90606

"itemtype": "property",

90607

"name": "NAME",

90608

"type": "String",

90609

"default": "'scrollview'",

90610

"readonly": "",

90611

"access": "protected",

90612

"tagname": "",

90613

"static": 1,

90614

"class": "ScrollView",

90615

"module": "scrollview-base"

90616

},

90617

{

90618

"file": "scrollview/js/scrollview-base.js",

90619

"line": 1056,

90620

"description": "Static property used to define the default attribute configuration of\nthe Widget.",

90621

"itemtype": "property",

90622

"name": "ATTRS",

90623

"type": "{Object}",

90624

"access": "protected",

90625

"tagname": "",

90626

"static": 1,

90627

"class": "ScrollView",

90628

"module": "scrollview-base"

90629

},

90630

{

90631

"file": "scrollview/js/scrollview-base.js",

90632

"line": 1067,

90633

"description": "The scroll position in the y-axis",

90634

"itemtype": "attribute",

90635

"name": "scrollY",

90636

"type": "Number",

90637

"default": "0",

90638

"class": "ScrollView",

90639

"module": "scrollview-base"

90640

},

90641

{

90642

"file": "scrollview/js/scrollview-base.js",

90643

"line": 1079,

90644

"description": "The scroll position in the x-axis",

90645

"itemtype": "attribute",

90646

"name": "scrollX",

90647

"type": "Number",

90648

"default": "0",

90649

"class": "ScrollView",

90650

"module": "scrollview-base"

90651

},

90652

{

90653

"file": "scrollview/js/scrollview-base.js",

90654

"line": 1091,

90655

"description": "Drag coefficent for inertial scrolling. The closer to 1 this\nvalue is, the less friction during scrolling.",

90656

"itemtype": "attribute",

90657

"name": "deceleration",

90658

"default": "0.93",

90659

"class": "ScrollView",

90660

"module": "scrollview-base"

90661

},

90662

{

90663

"file": "scrollview/js/scrollview-base.js",

90664

"line": 1102,

90665

"description": "Drag coefficient for intertial scrolling at the upper\nand lower boundaries of the scrollview. Set to 0 to \ndisable \"rubber-banding\".",

90666

"itemtype": "attribute",

90667

"name": "bounce",

90668

"type": "Number",

90669

"default": "0.1",

90670

"class": "ScrollView",

90671

"module": "scrollview-base"

90672

},

90673

{

90674

"file": "scrollview/js/scrollview-base.js",

90675

"line": 1115,

90676

"description": "The minimum distance and/or velocity which define a flick. Can be set to false,\nto disable flick support (note: drag support is enabled/disabled separately)",

90677

"itemtype": "attribute",

90678

"name": "flick",

90679

"type": "Object",

90680

"default": "Object with properties minDistance = 10, minVelocity = 0.3.",

90681

"class": "ScrollView",

90682

"module": "scrollview-base"

90683

},

90684

{

90685

"file": "scrollview/js/scrollview-base.js",

90686

"line": 1130,

90687

"description": "Enable/Disable dragging the ScrollView content (note: flick support is enabled/disabled separately)",

90688

"itemtype": "attribute",

90689

"name": "drag",

90690

"type": "boolean",

90691

"default": "true",

90692

"class": "ScrollView",

90693

"module": "scrollview-base"

90694

},

90695

{

90696

"file": "scrollview/js/scrollview-base.js",

90697

"line": 1141,

90698

"description": "List of class names used in the scrollview's DOM",

90699

"itemtype": "property",

90700

"name": "CLASS_NAMES",

90701

"type": "Object",

90702

"static": 1,

90703

"class": "ScrollView",

90704

"module": "scrollview-base"

90705

},

90706

{

90707

"file": "scrollview/js/scrollview-base.js",

90708

"line": 1150,

90709

"description": "Flag used to source property changes initiated from the DOM",

90710

"itemtype": "property",

90711

"name": "UI_SRC",

90712

"type": "String",

90713

"static": 1,

90714

"default": "\"ui\"",

90715

"class": "ScrollView",

90716

"module": "scrollview-base"

90717

},

90718

{

90719

"file": "scrollview/js/scrollview-base.js",

90720

"line": 1160,

90721

"description": "The default bounce distance in pixels",

90722

"itemtype": "property",

90723

"name": "BOUNCE_RANGE",

90724

"type": "Number",

90725

"static": 1,

90726

"default": "150",

90727

"class": "ScrollView",

90728

"module": "scrollview-base"

90729

},

90730

{

90731

"file": "scrollview/js/scrollview-base.js",

90732

"line": 1170,

90733

"description": "The interval used when animating the flick",

90734

"itemtype": "property",

90735

"name": "FRAME_STEP",

90736

"type": "Number",

90737

"static": 1,

90738

"default": "30",

90739

"class": "ScrollView",

90740

"module": "scrollview-base"

90741

},

90742

{

90743

"file": "scrollview/js/scrollview-base.js",

90744

"line": 1180,

90745

"description": "The default easing used when animating the flick",

90746

"itemtype": "property",

90747

"name": "EASING",

90748

"type": "String",

90749

"static": 1,

90750

"default": "'cubic-bezier(0, 0.1, 0, 1.0)'",

90751

"class": "ScrollView",

90752

"module": "scrollview-base"

90753

},

90754

{

90755

"file": "scrollview/js/scrollview-base.js",

90756

"line": 1190,

90757

"description": "The default easing to use when animating the bounce snap back.",

90758

"itemtype": "property",

90759

"name": "SNAP_EASING",

90760

"type": "String",

90761

"static": 1,

90762

"default": "'ease-out'",

90763

"class": "ScrollView",

90764

"module": "scrollview-base"

90765

},

90766

{

90767

"file": "scrollview/js/scrollview-base.js",

90768

"line": 1200,

90769

"description": "Object map of style property names used to set transition properties.\nDefaults to the vendor prefix established by the Transition module. \nThe configured property names are `_TRANSITION.DURATION` (e.g. \"WebkitTransitionDuration\") and\n`_TRANSITION.PROPERTY (e.g. \"WebkitTransitionProperty\").",

90770

"itemtype": "property",

90771

"name": "_TRANSITION",

90772

"access": "private",

90773

"tagname": "",

90774

"class": "ScrollView",

90775

"module": "scrollview-base"

90776

},

90777

{

90778

"file": "slider/js/clickable-rail.js",

90779

"line": 24,

90780

"description": "Initializes the internal state and sets up events.",

90781

"itemtype": "method",

90782

"name": "_initClickableRail",

90783

"access": "protected",

90784

"tagname": "",

90785

"class": "ClickableRail",

90786

"module": "slider",

90787

"submodule": "clickable-rail"

90788

},

90789

{

90790

"file": "slider/js/clickable-rail.js",

90791

"line": 33,

90792

"description": "Broadcasts when the rail has received a mousedown event and\ntriggers the thumb positioning. Use\n<code>e.preventDefault()</code> or\n<code>set("clickableRail", false)</code> to prevent\nthe thumb positioning.",

90793

"itemtype": "event",

90794

"name": "railMouseDown",

90795

"preventable": "_defRailMouseDownFn",

90796

"class": "ClickableRail",

90797

"module": "slider",

90798

"submodule": "clickable-rail"

90799

},

90800

{

90801

"file": "slider/js/clickable-rail.js",

90802

"line": 51,

90803

"description": "Attaches DOM event subscribers to support rail interaction.",

90804

"itemtype": "method",

90805

"name": "_bindClickableRail",

90806

"access": "protected",

90807

"tagname": "",

90808

"class": "ClickableRail",

90809

"module": "slider",

90810

"submodule": "clickable-rail"

90811

},

90812

{

90813

"file": "slider/js/clickable-rail.js",

90814

"line": 64,

90815

"description": "Detaches DOM event subscribers for cleanup/destruction cycle.",

90816

"itemtype": "method",

90817

"name": "_unbindClickableRail",

90818

"access": "protected",

90819

"tagname": "",

90820

"class": "ClickableRail",

90821

"module": "slider",

90822

"submodule": "clickable-rail"

90823

},

90824

{

90825

"file": "slider/js/clickable-rail.js",

90826

"line": 79,

90827

"description": "Dispatches the railMouseDown event.",

90828

"itemtype": "method",

90829

"name": "_onRailMouseDown",

90830

"params": [

90831

{

90832

"name": "e",

90833

"description": "the mousedown event object",

90834

"type": "DOMEvent"

90835

}

90836

],

90837

"access": "protected",

90838

"tagname": "",

90839

"class": "ClickableRail",

90840

"module": "slider",

90841

"submodule": "clickable-rail"

90842

},

90843

{

90844

"file": "slider/js/clickable-rail.js",

90845

"line": 93,

90846

"description": "Default behavior for the railMouseDown event. Centers the thumb at\nthe click location and passes control to the DDM to behave as though\nthe thumb itself were clicked in preparation for a drag operation.",

90847

"itemtype": "method",

90848

"name": "_defRailMouseDownFn",

90849

"params": [

90850

{

90851

"name": "e",

90852

"description": "the EventFacade for the railMouseDown custom event",

90853

"type": "Event"

90854

}

90855

],

90856

"access": "protected",

90857

"tagname": "",

90858

"class": "ClickableRail",

90859

"module": "slider",

90860

"submodule": "clickable-rail"

90861

},

90862

{

90863

"file": "slider/js/clickable-rail.js",

90864

"line": 149,

90865

"description": "Resolves which thumb to actuate if any. Override this if you want to\nsupport multiple thumbs. By default, returns the Drag instance for\nthe thumb stored by the Slider.",

90866

"itemtype": "method",

90867

"name": "_resolveThumb",

90868

"params": [

90869

{

90870

"name": "e",

90871

"description": "the mousedown event object",

90872

"type": "DOMEvent"

90873

}

90874

],

90875

"return": {

90876

"description": "the Drag instance that should be moved",

90877

"type": "DD.Drag"

90878

},

90879

"access": "protected",

90880

"tagname": "",

90881

"class": "ClickableRail",

90882

"module": "slider",

90883

"submodule": "clickable-rail"

90884

},

90885

{

90886

"file": "slider/js/clickable-rail.js",

90887

"line": 169,

90888

"description": "Calculates the top left position the thumb should be moved to to\nalign the click XY with the center of the specified node.",

90889

"itemtype": "method",

90890

"name": "_getThumbDestination",

90891

"params": [

90892

{

90893

"name": "e",

90894

"description": "The mousedown event object",

90895

"type": "DOMEvent"

90896

},

90897

{

90898

"name": "node",

90899

"description": "The node to position",

90900

"type": "Node"

90901

}

90902

],

90903

"return": {

90904

"description": "the [top, left] pixel position of the destination",

90905

"type": "Array"

90906

},

90907

"access": "protected",

90908

"tagname": "",

90909

"class": "ClickableRail",

90910

"module": "slider",

90911

"submodule": "clickable-rail"

90912

},

90913

{

90914

"file": "slider/js/clickable-rail.js",

90915

"line": 194,

90916

"description": "Enable or disable clickable rail support.",

90917

"itemtype": "attribute",

90918

"name": "clickableRail",

90919

"type": "{Boolean}",

90920

"default": "true",

90921

"class": "ClickableRail",

90922

"module": "slider",

90923

"submodule": "clickable-rail"

90924

},

90925

{

90926

"file": "slider/js/slider-base.js",

90927

"line": 31,

90928

"description": "Construction logic executed during Slider instantiation.",

90929

"itemtype": "method",

90930

"name": "initializer",

90931

"access": "protected",

90932

"tagname": "",

90933

"class": "SliderBase",

90934

"module": "slider",

90935

"submodule": "slider-base"

90936

},

90937

{

90938

"file": "slider/js/slider-base.js",

90939

"line": 38,

90940

"description": "The configured axis, stored for fast lookup since it's a writeOnce\nattribute. This is for use by extension classes. For\nimplementation code, use <code>get( "axis" )</code> for\nauthoritative source. Never write to this property.",

90941

"itemtype": "property",

90942

"name": "axis",

90943

"type": "{String}",

90944

"access": "protected",

90945

"tagname": "",

90946

"class": "SliderBase",

90947

"module": "slider",

90948

"submodule": "slider-base"

90949

},

90950

{

90951

"file": "slider/js/slider-base.js",

90952

"line": 50,

90953

"description": "Cached fast access map for DOM properties and attributes that\npertain to accessing dimensional or positioning information\naccording to the Slider's axis (e.g. "height" vs.\n"width"). Extension classes should add to this collection\nfor axis related strings if necessary.",

90954

"itemtype": "property",

90955

"name": "_key",

90956

"type": "{Object}",

90957

"access": "protected",

90958

"tagname": "",

90959

"class": "SliderBase",

90960

"module": "slider",

90961

"submodule": "slider-base"

90962

},

90963

{

90964

"file": "slider/js/slider-base.js",

90965

"line": 68,

90966

"description": "Signals that the thumb has moved. Payload includes the thumb's\npixel offset from the top/left edge of the rail, and if triggered by\ndragging the thumb, the <code>drag:drag</code> event.",

90967

"itemtype": "event",

90968

"name": "thumbMove",

90969

"params": [

90970

{

90971

"name": "event",

90972

"description": "The event object for the thumbMove with the\n following extra properties:\n <dl>\n <dt>offset</dt>\n <dd>Pixel offset from top/left of the slider to the new\n thumb position</dd>\n <dt>ddEvent (deprecated)</dt>\n <dd><code>drag:drag</code> event from the thumb</dd>\n <dt>originEvent</dt>\n <dd><code>drag:drag</code> event from the thumb</dd>\n </dl>",

90973

"type": "Event"

90974

}

90975

],

90976

"class": "SliderBase",

90977

"module": "slider",

90978

"submodule": "slider-base"

90979

},

90980

{

90981

"file": "slider/js/slider-base.js",

90982

"line": 92,

90983

"description": "Create the DOM structure for the Slider.",

90984

"itemtype": "method",

90985

"name": "renderUI",

90986

"access": "protected",

90987

"tagname": "",

90988

"class": "SliderBase",

90989

"module": "slider",

90990

"submodule": "slider-base"

90991

},

90992

{

90993

"file": "slider/js/slider-base.js",

90994

"line": 101,

90995

"description": "The Node instance of the Slider's rail element. Do not write to\nthis property.",

90996

"itemtype": "property",

90997

"name": "rail",

90998

"type": "{Node}",

90999

"class": "SliderBase",

91000

"module": "slider",

91001

"submodule": "slider-base"

91002

},

91003

{

91004

"file": "slider/js/slider-base.js",

91005

"line": 112,

91006

"description": "The Node instance of the Slider's thumb element. Do not write to\nthis property.",

91007

"itemtype": "property",

91008

"name": "thumb",

91009

"type": "{Node}",

91010

"class": "SliderBase",

91011

"module": "slider",

91012

"submodule": "slider-base"

91013

},

91014

{

91015

"file": "slider/js/slider-base.js",

91016

"line": 129,

91017

"description": "Creates the Slider rail DOM subtree for insertion into the Slider's\n<code>contentBox</code>. Override this method if you want to provide\nthe rail element (presumably from existing markup).",

91018

"itemtype": "method",

91019

"name": "renderRail",

91020

"return": {

91021

"description": "the rail node subtree",

91022

"type": "Node"

91023

},

91024

"class": "SliderBase",

91025

"module": "slider",

91026

"submodule": "slider-base"

91027

},

91028

{

91029

"file": "slider/js/slider-base.js",

91030

"line": 149,

91031

"description": "Sets the rail length according to the <code>length</code> attribute.",

91032

"itemtype": "method",

91033

"name": "_uiSetRailLength",

91034

"params": [

91035

{

91036

"name": "length",

91037

"description": "the length to apply to the rail style",

91038

"type": "String"

91039

}

91040

],

91041

"access": "protected",

91042

"tagname": "",

91043

"class": "SliderBase",

91044

"module": "slider",

91045

"submodule": "slider-base"

91046

},

91047

{

91048

"file": "slider/js/slider-base.js",

91049

"line": 160,

91050

"description": "Creates the Slider thumb DOM subtree for insertion into the Slider's\nrail. Override this method if you want to provide the thumb element\n(presumably from existing markup).",

91051

"itemtype": "method",

91052

"name": "renderThumb",

91053

"return": {

91054

"description": "the thumb node subtree",

91055

"type": "Node"

91056

},

91057

"class": "SliderBase",

91058

"module": "slider",

91059

"submodule": "slider-base"

91060

},

91061

{

91062

"file": "slider/js/slider-base.js",

91063

"line": 184,

91064

"description": "Gives focus to the thumb enabling keyboard access after clicking thumb",

91065

"itemtype": "method",

91066

"name": "_onThumbClick",

91067

"access": "protected",

91068

"tagname": "",

91069

"class": "SliderBase",

91070

"module": "slider",

91071

"submodule": "slider-base"

91072

},

91073

{

91074

"file": "slider/js/slider-base.js",

91075

"line": 195,

91076

"description": "Creates the Y.DD.Drag instance used to handle the thumb movement and\nbinds Slider interaction to the configured value model.",

91077

"itemtype": "method",

91078

"name": "bindUI",

91079

"access": "protected",

91080

"tagname": "",

91081

"class": "SliderBase",

91082

"module": "slider",

91083

"submodule": "slider-base"

91084

},

91085

{

91086

"file": "slider/js/slider-base.js",

91087

"line": 231,

91088

"description": "increments Slider value by a minor increment",

91089

"itemtype": "method",

91090

"name": "_incrMinor",

91091

"access": "protected",

91092

"tagname": "",

91093

"class": "SliderBase",

91094

"module": "slider",

91095

"submodule": "slider-base"

91096

},

91097

{

91098

"file": "slider/js/slider-base.js",

91099

"line": 241,

91100

"description": "decrements Slider value by a minor increment",

91101

"itemtype": "method",

91102

"name": "_decrMinor",

91103

"access": "protected",

91104

"tagname": "",

91105

"class": "SliderBase",

91106

"module": "slider",

91107

"submodule": "slider-base"

91108

},

91109

{

91110

"file": "slider/js/slider-base.js",

91111

"line": 251,

91112

"description": "increments Slider value by a major increment",

91113

"itemtype": "method",

91114

"name": "_incrMajor",

91115

"access": "protected",

91116

"tagname": "",

91117

"class": "SliderBase",

91118

"module": "slider",

91119

"submodule": "slider-base"

91120

},

91121

{

91122

"file": "slider/js/slider-base.js",

91123

"line": 261,

91124

"description": "decrements Slider value by a major increment",

91125

"itemtype": "method",

91126

"name": "_decrMajor",

91127

"access": "protected",

91128

"tagname": "",

91129

"class": "SliderBase",

91130

"module": "slider",

91131

"submodule": "slider-base"

91132

},

91133

{

91134

"file": "slider/js/slider-base.js",

91135

"line": 271,

91136

"description": "sets the Slider value to the min value.",

91137

"itemtype": "method",

91138

"name": "_setToMin",

91139

"access": "protected",

91140

"tagname": "",

91141

"class": "SliderBase",

91142

"module": "slider",

91143

"submodule": "slider-base"

91144

},

91145

{

91146

"file": "slider/js/slider-base.js",

91147

"line": 281,

91148

"description": "sets the Slider value to the max value.",

91149

"itemtype": "method",

91150

"name": "_setToMax",

91151

"access": "protected",

91152

"tagname": "",

91153

"class": "SliderBase",

91154

"module": "slider",

91155

"submodule": "slider-base"

91156

},

91157

{

91158

"file": "slider/js/slider-base.js",

91159

"line": 291,

91160

"description": "sets the Slider's value in response to key events.\nLeft and right keys are in a separate method \nin case an implementation wants to increment values\nbut needs left and right arrow keys for other purposes.",

91161

"itemtype": "method",

91162

"name": "_onDirectionKey",

91163

"params": [

91164

{

91165

"name": "e",

91166

"description": "the key event",

91167

"type": "Event"

91168

}

91169

],

91170

"access": "protected",

91171

"tagname": "",

91172

"class": "SliderBase",

91173

"module": "slider",

91174

"submodule": "slider-base"

91175

},

91176

{

91177

"file": "slider/js/slider-base.js",

91178

"line": 327,

91179

"description": "sets the Slider's value in response to left or right key events",

91180

"itemtype": "method",

91181

"name": "_onLeftRightKey",

91182

"params": [

91183

{

91184

"name": "e",

91185

"description": "the key event",

91186

"type": "Event"

91187

}

91188

],

91189

"access": "protected",

91190

"tagname": "",

91191

"class": "SliderBase",

91192

"module": "slider",

91193

"submodule": "slider-base"

91194

},

91195

{

91196

"file": "slider/js/slider-base.js",

91197

"line": 348,

91198

"description": "sets the Slider's value in response to left or right key events when a meta (mac command/apple) key is also pressed",

91199

"itemtype": "method",

91200

"name": "_onLeftRightKeyMeta",

91201

"params": [

91202

{

91203

"name": "e",

91204

"description": "the key event",

91205

"type": "Event"

91206

}

91207

],

91208

"access": "protected",

91209

"tagname": "",

91210

"class": "SliderBase",

91211

"module": "slider",

91212

"submodule": "slider-base"

91213

},

91214

{

91215

"file": "slider/js/slider-base.js",

91216

"line": 373,

91217

"description": "Makes the thumb draggable and constrains it to the rail.",

91218

"itemtype": "method",

91219

"name": "_bindThumbDD",

91220

"access": "protected",

91221

"tagname": "",

91222

"class": "SliderBase",

91223

"module": "slider",

91224

"submodule": "slider-base"

91225

},

91226

{

91227

"file": "slider/js/slider-base.js",

91228

"line": 385,

91229

"description": "The DD.Drag instance linked to the thumb node.",

91230

"itemtype": "property",

91231

"name": "_dd",

91232

"type": "{DD.Drag}",

91233

"access": "protected",

91234

"tagname": "",

91235

"class": "SliderBase",

91236

"module": "slider",

91237

"submodule": "slider-base"

91238

},

91239

{

91240

"file": "slider/js/slider-base.js",

91241

"line": 408,

91242

"description": "Stub implementation. Override this (presumably in a class extension) to\ninitialize any value logic that depends on the presence of the Drag\ninstance.",

91243

"itemtype": "method",

91244

"name": "_bindValueLogic",

91245

"access": "protected",

91246

"tagname": "",

91247

"class": "SliderBase",

91248

"module": "slider",

91249

"submodule": "slider-base"

91250

},

91251

{

91252

"file": "slider/js/slider-base.js",

91253

"line": 418,

91254

"description": "Moves the thumb to pixel offset position along the rail.",

91255

"itemtype": "method",

91256

"name": "_uiMoveThumb",

91257

"params": [

91258

{

91259

"name": "offset",

91260

"description": "the pixel offset to set as left or top style",

91261

"type": "Number"

91262

},

91263

{

91264

"name": "options",

91265

"description": "Details to send with the `thumbMove` event",

91266

"type": "Object",

91267

"optional": true

91268

}

91269

],

91270

"access": "protected",

91271

"tagname": "",

91272

"class": "SliderBase",

91273

"module": "slider",

91274

"submodule": "slider-base"

91275

},

91276

{

91277

"file": "slider/js/slider-base.js",

91278

"line": 439,

91279

"description": "Dispatches the <code>slideStart</code> event.",

91280

"itemtype": "method",

91281

"name": "_onDragStart",

91282

"params": [

91283

{

91284

"name": "e",

91285

"description": "the <code>drag:start</code> event from the thumb",

91286

"type": "Event"

91287

}

91288

],

91289

"access": "protected",

91290

"tagname": "",

91291

"class": "SliderBase",

91292

"module": "slider",

91293

"submodule": "slider-base"

91294

},

91295

{

91296

"file": "slider/js/slider-base.js",

91297

"line": 447,

91298

"description": "Signals the beginning of a thumb drag operation. Payload includes\nthe thumb's drag:start event.",

91299

"itemtype": "event",

91300

"name": "slideStart",

91301

"params": [

91302

{

91303

"name": "event",

91304

"description": "The event object for the slideStart with the\n following extra properties:\n <dl>\n <dt>ddEvent (deprecated)</dt>\n <dd><code>drag:start</code> event from the thumb</dd>\n <dt>originEvent</dt>\n <dd><code>drag:start</code> event from the thumb</dd>\n </dl>",

91305

"type": "Event"

91306

}

91307

],

91308

"class": "SliderBase",

91309

"module": "slider",

91310

"submodule": "slider-base"

91311

},

91312

{

91313

"file": "slider/js/slider-base.js",

91314

"line": 467,

91315

"description": "Dispatches the <code>thumbMove</code> event.",

91316

"itemtype": "method",

91317

"name": "_afterDrag",

91318

"params": [

91319

{

91320

"name": "e",

91321

"description": "the <code>drag:drag</code> event from the thumb",

91322

"type": "Event"

91323

}

91324

],

91325

"access": "protected",

91326

"tagname": "",

91327

"class": "SliderBase",

91328

"module": "slider",

91329

"submodule": "slider-base"

91330

},

91331

{

91332

"file": "slider/js/slider-base.js",

91333

"line": 486,

91334

"description": "Dispatches the <code>slideEnd</code> event.",

91335

"itemtype": "method",

91336

"name": "_onDragEnd",

91337

"params": [

91338

{

91339

"name": "e",

91340

"description": "the <code>drag:end</code> event from the thumb",

91341

"type": "Event"

91342

}

91343

],

91344

"access": "protected",

91345

"tagname": "",

91346

"class": "SliderBase",

91347

"module": "slider",

91348

"submodule": "slider-base"

91349

},

91350

{

91351

"file": "slider/js/slider-base.js",

91352

"line": 494,

91353

"description": "Signals the end of a thumb drag operation. Payload includes\nthe thumb's drag:end event.",

91354

"itemtype": "event",

91355

"name": "slideEnd",

91356

"params": [

91357

{

91358

"name": "event",

91359

"description": "The event object for the slideEnd with the\n following extra properties:\n <dl>\n <dt>ddEvent (deprecated)</dt>\n <dd><code>drag:end</code> event from the thumb</dd>\n <dt>originEvent</dt>\n <dd><code>drag:end</code> event from the thumb</dd>\n </dl>",

91360

"type": "Event"

91361

}

91362

],

91363

"class": "SliderBase",

91364

"module": "slider",

91365

"submodule": "slider-base"

91366

},

91367

{

91368

"file": "slider/js/slider-base.js",

91369

"line": 514,

91370

"description": "Locks or unlocks the thumb.",

91371

"itemtype": "method",

91372

"name": "_afterDisabledChange",

91373

"params": [

91374

{

91375

"name": "e",

91376

"description": "The disabledChange event object",

91377

"type": "Event"

91378

}

91379

],

91380

"access": "protected",

91381

"tagname": "",

91382

"class": "SliderBase",

91383

"module": "slider",

91384

"submodule": "slider-base"

91385

},

91386

{

91387

"file": "slider/js/slider-base.js",

91388

"line": 525,

91389

"description": "Handles changes to the <code>length</code> attribute. By default, it\ntriggers an update to the UI.",

91390

"itemtype": "method",

91391

"name": "_afterLengthChange",

91392

"params": [

91393

{

91394

"name": "e",

91395

"description": "The lengthChange event object",

91396

"type": "Event"

91397

}

91398

],

91399

"access": "protected",

91400

"tagname": "",

91401

"class": "SliderBase",

91402

"module": "slider",

91403

"submodule": "slider-base"

91404

},

91405

{

91406

"file": "slider/js/slider-base.js",

91407

"line": 541,

91408

"description": "Synchronizes the DOM state with the attribute settings.",

91409

"itemtype": "method",

91410

"name": "syncUI",

91411

"class": "SliderBase",

91412

"module": "slider",

91413

"submodule": "slider-base"

91414

},

91415

{

91416

"file": "slider/js/slider-base.js",

91417

"line": 558,

91418

"description": "Stub implementation. Override this (presumably in a class extension) to\nensure the thumb is in the correct position according to the value\nalogorithm.\ninstance.",

91419

"itemtype": "method",

91420

"name": "_syncThumbPosition",

91421

"access": "protected",

91422

"tagname": "",

91423

"class": "SliderBase",

91424

"module": "slider",

91425

"submodule": "slider-base"

91426

},

91427

{

91428

"file": "slider/js/slider-base.js",

91429

"line": 569,

91430

"description": "Validates the axis is "x" or "y" (case insensitive).\nConverts to lower case for storage.",

91431

"itemtype": "method",

91432

"name": "_setAxis",

91433

"params": [

91434

{

91435

"name": "v",

91436

"description": "proposed value for the axis attribute",

91437

"type": "String"

91438

}

91439

],

91440

"return": {

91441

"description": "lowercased first character of the input string",

91442

"type": "String"

91443

},

91444

"access": "protected",

91445

"tagname": "",

91446

"class": "SliderBase",

91447

"module": "slider",

91448

"submodule": "slider-base"

91449

},

91450

{

91451

"file": "slider/js/slider-base.js",

91452

"line": 584,

91453

"description": "Ensures the stored length value is a string with a quantity and unit.\nUnit will be defaulted to "px" if not included. Rejects\nvalues less than or equal to 0 and those that don't at least start with\na number.\n\nCurrently only pixel lengths are supported.",

91454

"itemtype": "method",

91455

"name": "_setLength",

91456

"params": [

91457

{

91458

"name": "v",

91459

"description": "proposed value for the length attribute",

91460

"type": "String"

91461

}

91462

],

91463

"return": {

91464

"description": "the sanitized value",

91465

"type": "String"

91466

},

91467

"access": "protected",

91468

"tagname": "",

91469

"class": "SliderBase",

91470

"module": "slider",

91471

"submodule": "slider-base"

91472

},

91473

{

91474

"file": "slider/js/slider-base.js",

91475

"line": 606,

91476

"description": "Defaults the thumbURL attribute according to the current skin, or\n"sam" if none can be determined. Horizontal Sliders will have\ntheir <code>thumbUrl</code> attribute set to\n<code>"/configured/yui/builddir/slider-base/assets/skins/sam/thumb-x.png"</code>\nAnd vertical thumbs will get\n<code>"/configured/yui/builddir/slider-base/assets/skins/sam/thumb-y.png"</code>",

91477

"itemtype": "method",

91478

"name": "_initThumbUrl",

91479

"access": "protected",

91480

"tagname": "",

91481

"class": "SliderBase",

91482

"module": "slider",

91483

"submodule": "slider-base"

91484

},

91485

{

91486

"file": "slider/js/slider-base.js",

91487

"line": 635,

91488

"description": "Bounding box template that will contain the Slider's DOM subtree. s are used to support inline-block styling.",

91489

"itemtype": "property",

91490

"name": "BOUNDING_TEMPLATE",

91491

"type": "{String}",

91492

"default": "",

91493

"class": "SliderBase",

91494

"module": "slider",

91495

"submodule": "slider-base"

91496

},

91497

{

91498

"file": "slider/js/slider-base.js",

91499

"line": 644,

91500

"description": "Content box template that will contain the Slider's rail and thumb.",

91501

"itemtype": "property",

91502

"name": "CONTENT_TEMPLATE",

91503

"type": "{String}",

91504

"default": "",

91505

"class": "SliderBase",

91506

"module": "slider",

91507

"submodule": "slider-base"

91508

},

91509

{

91510

"file": "slider/js/slider-base.js",

91511

"line": 653,

91512

"description": "Rail template that will contain the end caps and the thumb.\n{placeholder}s are used for template substitution at render time.",

91513

"itemtype": "property",

91514

"name": "RAIL_TEMPLATE",

91515

"type": "{String}",

91516

"default": "",

91517

"class": "SliderBase",

91518

"module": "slider",

91519

"submodule": "slider-base"

91520

},

91521

{

91522

"file": "slider/js/slider-base.js",

91523

"line": 666,

91524

"description": "Thumb template that will contain the thumb image and shadow. <img>\ntags are used instead of background images to avoid a flicker bug in IE.\n{placeholder}s are used for template substitution at render time.",

91525

"itemtype": "property",

91526

"name": "THUMB_TEMPLATE",

91527

"type": "{String}",

91528

"default": "<img src=\"{thumbShadowUrl}\" alt=\"Slider thumb shadow\" class=\"{thumbShadowClass}\"><img src=\"{thumbImageUrl}\" alt=\"Slider thumb\" class=\"{thumbImageClass}\">",

91529

"class": "SliderBase",

91530

"module": "slider",

91531

"submodule": "slider-base"

91532

},

91533

{

91534

"file": "slider/js/slider-base.js",

91535

"line": 688,

91536

"description": "The identity of the widget.",

91537

"itemtype": "property",

91538

"name": "NAME",

91539

"type": "String",

91540

"default": "'sliderBase'",

91541

"readonly": "",

91542

"access": "protected",

91543

"tagname": "",

91544

"static": 1,

91545

"class": "SliderBase",

91546

"module": "slider",

91547

"submodule": "slider-base"

91548

},

91549

{

91550

"file": "slider/js/slider-base.js",

91551

"line": 700,

91552

"description": "Static property used to define the default attribute configuration of\nthe Widget.",

91553

"itemtype": "property",

91554

"name": "ATTRS",

91555

"type": "{Object}",

91556

"access": "protected",

91557

"tagname": "",

91558

"static": 1,

91559

"class": "SliderBase",

91560

"module": "slider",

91561

"submodule": "slider-base"

91562

},

91563

{

91564

"file": "slider/js/slider-base.js",

91565

"line": 711,

91566

"description": "Axis upon which the Slider's thumb moves. "x" for\nhorizontal, "y" for vertical.",

91567

"itemtype": "attribute",

91568

"name": "axis",

91569

"type": "{String}",

91570

"default": ""x"",

91571

"writeonce": "",

91572

"class": "SliderBase",

91573

"module": "slider",

91574

"submodule": "slider-base"

91575

},

91576

{

91577

"file": "slider/js/slider-base.js",

91578

"line": 727,

91579

"description": "The length of the rail (exclusive of the end caps if positioned by\nCSS). This corresponds to the movable range of the thumb.",

91580

"itemtype": "attribute",

91581

"name": "length",

91582

"type": "{String | Number} e.g. \"200px\" or 200",

91583

"default": "150px",

91584

"class": "SliderBase",

91585

"module": "slider",

91586

"submodule": "slider-base"

91587

},

91588

{

91589

"file": "slider/js/slider-base.js",

91590

"line": 740,

91591

"description": "Path to the thumb image. This will be used as both the thumb and\nshadow as a sprite. Defaults at render() to thumb-x.png or\nthumb-y.png in the skin directory of the current skin.",

91592

"itemtype": "attribute",

91593

"name": "thumbUrl",

91594

"type": "{String}",

91595

"default": "thumb-x.png or thumb-y.png in the sam skin directory of the\n current build path for Slider",

91596

"class": "SliderBase",

91597

"module": "slider",

91598

"submodule": "slider-base"

91599

},

91600

{

91601

"file": "slider/js/value-range.js",

91602

"line": 37,

91603

"description": "Factor used to translate value -> position -> value.",

91604

"itemtype": "property",

91605

"name": "_factor",

91606

"type": "{Number}",

91607

"access": "protected",

91608

"tagname": "",

91609

"class": "SliderValueRange",

91610

"module": "slider",

91611

"submodule": "slider-value-range"

91612

},

91613

{

91614

"file": "slider/js/value-range.js",

91615

"line": 46,

91616

"description": "Stub for construction logic. Override if extending this class and\nyou need to set something up during the initializer phase.",

91617

"itemtype": "method",

91618

"name": "_initSliderValueRange",

91619

"access": "protected",

91620

"tagname": "",

91621

"class": "SliderValueRange",

91622

"module": "slider",

91623

"submodule": "slider-value-range"

91624

},

91625

{

91626

"file": "slider/js/value-range.js",

91627

"line": 55,

91628

"description": "Override of stub method in SliderBase that is called at the end of\nits bindUI stage of render(). Subscribes to internal events to\ntrigger UI and related state updates.",

91629

"itemtype": "method",

91630

"name": "_bindValueLogic",

91631

"access": "protected",

91632

"tagname": "",

91633

"class": "SliderValueRange",

91634

"module": "slider",

91635

"submodule": "slider-value-range"

91636

},

91637

{

91638

"file": "slider/js/value-range.js",

91639

"line": 71,

91640

"description": "Move the thumb to appropriate position if necessary. Also resets\nthe cached offsets and recalculates the conversion factor to\ntranslate position to value.",

91641

"itemtype": "method",

91642

"name": "_syncThumbPosition",

91643

"access": "protected",

91644

"tagname": "",

91645

"class": "SliderValueRange",

91646

"module": "slider",

91647

"submodule": "slider-value-range"

91648

},

91649

{

91650

"file": "slider/js/value-range.js",

91651

"line": 85,

91652

"description": "Calculates and caches\n(range between max and min) / (rail length)\nfor fast runtime calculation of position -> value.",

91653

"itemtype": "method",

91654

"name": "_calculateFactor",

91655

"access": "protected",

91656

"tagname": "",

91657

"class": "SliderValueRange",

91658

"module": "slider",

91659

"submodule": "slider-value-range"

91660

},

91661

{

91662

"file": "slider/js/value-range.js",

91663

"line": 111,

91664

"description": "Dispatch the new position of the thumb into the value setting\noperations.",

91665

"itemtype": "method",

91666

"name": "_defThumbMoveFn",

91667

"params": [

91668

{

91669

"name": "e",

91670

"description": "The host's thumbMove event",

91671

"type": "EventFacade"

91672

}

91673

],

91674

"access": "protected",

91675

"tagname": "",

91676

"class": "SliderValueRange",

91677

"module": "slider",

91678

"submodule": "slider-value-range"

91679

},

91680

{

91681

"file": "slider/js/value-range.js",

91682

"line": 126,

91683

"description": "Converts a pixel position into a value. Calculates current\nthumb offset from the leading edge of the rail multiplied by the\nratio of <code>(max - min) / (constraining dim)</code>.\n\nOverride this if you want to use a different value mapping\nalgorithm.",

91684

"itemtype": "method",

91685

"name": "_offsetToValue",

91686

"params": [

91687

{

91688

"name": "offset",

91689

"description": "X or Y pixel offset",

91690

"type": "Number"

91691

}

91692

],

91693

"return": {

91694

"description": "Value corresponding to the provided pixel offset",

91695

"type": "Mixed"

91696

},

91697

"access": "protected",

91698

"tagname": "",

91699

"class": "SliderValueRange",

91700

"module": "slider",

91701

"submodule": "slider-value-range"

91702

},

91703

{

91704

"file": "slider/js/value-range.js",

91705

"line": 147,

91706

"description": "Converts a value into a pixel offset for use in positioning\nthe thumb according to the reverse of the\n<code>_offsetToValue( xy )</code> operation.",

91707

"itemtype": "method",

91708

"name": "_valueToOffset",

91709

"params": [

91710

{

91711

"name": "val",

91712

"description": "The value to map to pixel X or Y position",

91713

"type": "Number"

91714

}

91715

],

91716

"return": {

91717

"description": "The pixel offset",

91718

"type": "Number"

91719

},

91720

"access": "protected",

91721

"tagname": "",

91722

"class": "SliderValueRange",

91723

"module": "slider",

91724

"submodule": "slider-value-range"

91725

},

91726

{

91727

"file": "slider/js/value-range.js",

91728

"line": 164,

91729

"description": "Returns the current value. Override this if you want to introduce\noutput formatting. Otherwise equivalent to slider.get( \"value\" );",

91730

"itemtype": "method",

91731

"name": "getValue",

91732

"return": {

91733

"description": "",

91734

"type": "Number"

91735

},

91736

"class": "SliderValueRange",

91737

"module": "slider",

91738

"submodule": "slider-value-range"

91739

},

91740

{

91741

"file": "slider/js/value-range.js",

91742

"line": 175,

91743

"description": "Updates the current value. Override this if you want to introduce\ninput value parsing or preprocessing. Otherwise equivalent to\nslider.set( \"value\", v );",

91744

"itemtype": "method",

91745

"name": "setValue",

91746

"params": [

91747

{

91748

"name": "val",

91749

"description": "The new value",

91750

"type": "Number"

91751

}

91752

],

91753

"return": {

91754

"description": "",

91755

"type": "Slider"

91756

},

91757

"chainable": 1,

91758

"class": "SliderValueRange",

91759

"module": "slider",

91760

"submodule": "slider-value-range"

91761

},

91762

{

91763

"file": "slider/js/value-range.js",

91764

"line": 189,

91765

"description": "Update position according to new min value. If the new min results\nin the current value being out of range, the value is set to the\ncloser of min or max.",

91766

"itemtype": "method",

91767

"name": "_afterMinChange",

91768

"params": [

91769

{

91770

"name": "e",

91771

"description": "The <code>min</code> attribute change event.",

91772

"type": "EventFacade"

91773

}

91774

],

91775

"access": "protected",

91776

"tagname": "",

91777

"class": "SliderValueRange",

91778

"module": "slider",

91779

"submodule": "slider-value-range"

91780

},

91781

{

91782

"file": "slider/js/value-range.js",

91783

"line": 204,

91784

"description": "Update position according to new max value. If the new max results\nin the current value being out of range, the value is set to the\ncloser of min or max.",

91785

"itemtype": "method",

91786

"name": "_afterMaxChange",

91787

"params": [

91788

{

91789

"name": "e",

91790

"description": "The <code>max</code> attribute change event.",

91791

"type": "EventFacade"

91792

}

91793

],

91794

"access": "protected",

91795

"tagname": "",

91796

"class": "SliderValueRange",

91797

"module": "slider",

91798

"submodule": "slider-value-range"

91799

},

91800

{

91801

"file": "slider/js/value-range.js",

91802

"line": 219,

91803

"description": "Verifies that the current value is within the min - max range. If\nnot, value is set to either min or max, depending on which is\ncloser.",

91804

"itemtype": "method",

91805

"name": "_verifyValue",

91806

"access": "protected",

91807

"tagname": "",

91808

"class": "SliderValueRange",

91809

"module": "slider",

91810

"submodule": "slider-value-range"

91811

},

91812

{

91813

"file": "slider/js/value-range.js",

91814

"line": 239,

91815

"description": "Propagate change to the thumb position unless the change originated\nfrom the thumbMove event.",

91816

"itemtype": "method",

91817

"name": "_afterValueChange",

91818

"params": [

91819

{

91820

"name": "e",

91821

"description": "The <code>valueChange</code> event.",

91822

"type": "EventFacade"

91823

}

91824

],

91825

"access": "protected",

91826

"tagname": "",

91827

"class": "SliderValueRange",

91828

"module": "slider",

91829

"submodule": "slider-value-range"

91830

},

91831

{

91832

"file": "slider/js/value-range.js",

91833

"line": 255,

91834

"description": "Positions the thumb in accordance with the translated value.",

91835

"itemtype": "method",

91836

"name": "_setPosition",

91837

"params": [

91838

{

91839

"name": "value",

91840

"description": "Value to translate to a pixel position",

91841

"type": "Number"

91842

},

91843

{

91844

"name": "options",

91845

"description": "Details object to pass to `_uiMoveThumb`",

91846

"type": "Object",

91847

"optional": true

91848

}

91849

],

91850

"access": "protected",

91851

"tagname": "",

91852

"class": "SliderValueRange",

91853

"module": "slider",

91854

"submodule": "slider-value-range"

91855

},

91856

{

91857

"file": "slider/js/value-range.js",

91858

"line": 267,

91859

"description": "Validates new values assigned to <code>min</code> attribute. Numbers\nare acceptable. Override this to enforce different rules.",

91860

"itemtype": "method",

91861

"name": "_validateNewMin",

91862

"params": [

91863

{

91864

"name": "value",

91865

"description": "Value assigned to <code>min</code> attribute.",

91866

"type": "Any"

91867

}

91868

],

91869

"return": {

91870

"description": "True for numbers. False otherwise.",

91871

"type": "Boolean"

91872

},

91873

"access": "protected",

91874

"tagname": "",

91875

"class": "SliderValueRange",

91876

"module": "slider",

91877

"submodule": "slider-value-range"

91878

},

91879

{

91880

"file": "slider/js/value-range.js",

91881

"line": 280,

91882

"description": "Validates new values assigned to <code>max</code> attribute. Numbers\nare acceptable. Override this to enforce different rules.",

91883

"itemtype": "method",

91884

"name": "_validateNewMax",

91885

"params": [

91886

{

91887

"name": "value",

91888

"description": "Value assigned to <code>max</code> attribute.",

91889

"type": "Mixed"

91890

}

91891

],

91892

"return": {

91893

"description": "True for numbers. False otherwise.",

91894

"type": "Boolean"

91895

},

91896

"access": "protected",

91897

"tagname": "",

91898

"class": "SliderValueRange",

91899

"module": "slider",

91900

"submodule": "slider-value-range"

91901

},

91902

{

91903

"file": "slider/js/value-range.js",

91904

"line": 293,

91905

"description": "Restricts new values assigned to <code>value</code> attribute to be\nbetween the configured <code>min</code> and <code>max</code>.\nRounds to nearest integer value.",

91906

"itemtype": "method",

91907

"name": "_setNewValue",

91908

"params": [

91909

{

91910

"name": "value",

91911

"description": "Value assigned to <code>value</code> attribute",

91912

"type": "Number"

91913

}

91914

],

91915

"return": {

91916

"description": "Normalized and constrained value",

91917

"type": "Number"

91918

},

91919

"access": "protected",

91920

"tagname": "",

91921

"class": "SliderValueRange",

91922

"module": "slider",

91923

"submodule": "slider-value-range"

91924

},

91925

{

91926

"file": "slider/js/value-range.js",

91927

"line": 307,

91928

"description": "Returns the nearest valid value to the value input. If the provided\nvalue is outside the min - max range, accounting for min > max\nscenarios, the nearest of either min or max is returned. Otherwise,\nthe provided value is returned.",

91929

"itemtype": "method",

91930

"name": "_nearestValue",

91931

"params": [

91932

{

91933

"name": "value",

91934

"description": "Value to test against current min - max range",

91935

"type": "Mixed"

91936

}

91937

],

91938

"return": {

91939

"description": "Current min, max, or value if within range",

91940

"type": "Number"

91941

},

91942

"access": "protected",

91943

"tagname": "",

91944

"class": "SliderValueRange",

91945

"module": "slider",

91946

"submodule": "slider-value-range"

91947

},

91948

{

91949

"file": "slider/js/value-range.js",

91950

"line": 337,

91951

"description": "Attributes that will be added onto host class.",

91952

"itemtype": "property",

91953

"name": "ATTRS",

91954

"type": "{Object}",

91955

"static": 1,

91956

"access": "protected",

91957

"tagname": "",

91958

"class": "SliderValueRange",

91959

"module": "slider",

91960

"submodule": "slider-value-range"

91961

},

91962

{

91963

"file": "slider/js/value-range.js",

91964

"line": 346,

91965

"description": "The value associated with the farthest top, left position of the\nrail. Can be greater than the configured <code>max</code> if you\nwant values to increase from right-to-left or bottom-to-top.",

91966

"itemtype": "attribute",

91967

"name": "min",

91968

"type": "{ Number }",

91969

"default": "0",

91970

"class": "SliderValueRange",

91971

"module": "slider",

91972

"submodule": "slider-value-range"

91973

},

91974

{

91975

"file": "slider/js/value-range.js",

91976

"line": 360,

91977

"description": "The value associated with the farthest bottom, right position of\nthe rail. Can be less than the configured <code>min</code> if\nyou want values to increase from right-to-left or bottom-to-top.",

91978

"itemtype": "attribute",

91979

"name": "max",

91980

"type": "{ Number }",

91981

"default": "100",

91982

"class": "SliderValueRange",

91983

"module": "slider",

91984

"submodule": "slider-value-range"

91985

},

91986

{

91987

"file": "slider/js/value-range.js",

91988

"line": 374,

91989

"description": "amount to increment/decrement the Slider value\nwhen the arrow up/down/left/right keys are pressed",

91990

"itemtype": "attribute",

91991

"name": "minorStep",

91992

"type": "{Number}",

91993

"default": "1",

91994

"class": "SliderValueRange",

91995

"module": "slider",

91996

"submodule": "slider-value-range"

91997

},

91998

{

91999

"file": "slider/js/value-range.js",

92000

"line": 386,

92001

"description": "amount to increment/decrement the Slider value\nwhen the page up/down keys are pressed",

92002

"itemtype": "attribute",

92003

"name": "majorStep",

92004

"type": "{Number}",

92005

"default": "10",

92006

"class": "SliderValueRange",

92007

"module": "slider",

92008

"submodule": "slider-value-range"

92009

},

92010

{

92011

"file": "slider/js/value-range.js",

92012

"line": 398,

92013

"description": "The value associated with the thumb's current position on the\nrail. Defaults to the value inferred from the thumb's current\nposition. Specifying value in the constructor will move the\nthumb to the position that corresponds to the supplied value.",

92014

"itemtype": "attribute",

92015

"name": "value",

92016

"type": "{ Number }",

92017

"default": "(inferred from current thumb position)",

92018

"class": "SliderValueRange",

92019

"module": "slider",

92020

"submodule": "slider-value-range"

92021

},

92022

{

92023

"file": "sortable/js/sortable-scroll.js",

92024

"line": 37,

92025

"itemtype": "property",

92026

"name": "NAME",

92027

"default": "SortScroll",

92028

"readonly": "",

92029

"access": "protected",

92030

"tagname": "",

92031

"static": 1,

92032

"description": "The name of the class.",

92033

"type": "{String}",

92034

"class": "Plugin.SortScroll",

92035

"module": "sortable",

92036

"submodule": "sortable-scroll",

92037

"namespace": "Plugin"

92038

},

92039

{

92040

"file": "sortable/js/sortable-scroll.js",

92041

"line": 47,

92042

"itemtype": "property",

92043

"name": "NS",

92044

"default": "scroll",

92045

"readonly": "",

92046

"access": "protected",

92047

"tagname": "",

92048

"static": 1,

92049

"description": "The scroll instance.",

92050

"type": "{String}",

92051

"class": "Plugin.SortScroll",

92052

"module": "sortable",

92053

"submodule": "sortable-scroll",

92054

"namespace": "Plugin"

92055

},

92056

{

92057

"file": "sortable/js/sortable.js",

92058

"line": 29,

92059

"itemtype": "property",

92060

"name": "delegate",

92061

"type": "DD.Delegate",

92062

"description": "A reference to the DD.Delegate instance.",

92063

"class": "Sortable",

92064

"module": "sortable"

92065

},

92066

{

92067

"file": "sortable/js/sortable.js",

92068

"line": 86,

92069

"access": "private",

92070

"tagname": "",

92071

"itemtype": "method",

92072

"name": "_onDropOver",

92073

"params": [

92074

{

92075

"name": "Event",

92076

"description": "e The Event Object"

92077

}

92078

],

92079

"description": "Handles the DropOver event to append a drop node to an empty target",

92080

"class": "Sortable",

92081

"module": "sortable"

92082

},

92083

{

92084

"file": "sortable/js/sortable.js",

92085

"line": 100,

92086

"access": "private",

92087

"tagname": "",

92088

"itemtype": "method",

92089

"name": "_onDragOver",

92090

"params": [

92091

{

92092

"name": "Event",

92093

"description": "e The Event Object"

92094

}

92095

],

92096

"description": "Handles the DragOver event that moves the object in the list or to another list.",

92097

"class": "Sortable",

92098

"module": "sortable"

92099

},

92100

{

92101

"file": "sortable/js/sortable.js",

92102

"line": 175,

92103

"access": "private",

92104

"tagname": "",

92105

"itemtype": "method",

92106

"name": "_onDragStart",

92107

"params": [

92108

{

92109

"name": "Event",

92110

"description": "e The Event Object"

92111

}

92112

],

92113

"description": "Handles the DragStart event and initializes some settings.",

92114

"class": "Sortable",

92115

"module": "sortable"

92116

},

92117

{

92118

"file": "sortable/js/sortable.js",

92119

"line": 186,

92120

"access": "private",

92121

"tagname": "",

92122

"itemtype": "method",

92123

"name": "_onDragEnd",

92124

"params": [

92125

{

92126

"name": "Event",

92127

"description": "e The Event Object"

92128

}

92129

],

92130

"description": "Handles the DragEnd event that cleans up the settings in the drag:start event.",

92131

"class": "Sortable",

92132

"module": "sortable"

92133

},

92134

{

92135

"file": "sortable/js/sortable.js",

92136

"line": 200,

92137

"itemtype": "method",

92138

"name": "plug",

92139

"params": [

92140

{

92141

"name": "Class",

92142

"description": "cls The class to plug"

92143

},

92144

{

92145

"name": "Object",

92146

"description": "config The class config"

92147

}

92148

],

92149

"description": "Passthrough to the DD.Delegate.ddplug method",

92150

"chainable": 1,

92151

"class": "Sortable",

92152

"module": "sortable"

92153

},

92154

{

92155

"file": "sortable/js/sortable.js",

92156

"line": 216,

92157

"itemtype": "method",

92158

"name": "sync",

92159

"description": "Passthrough to the DD.Delegate syncTargets method.",

92160

"chainable": 1,

92161

"class": "Sortable",

92162

"module": "sortable"

92163

},

92164

{

92165

"file": "sortable/js/sortable.js",

92166

"line": 229,

92167

"itemtype": "method",

92168

"name": "join",

92169

"params": [

92170

{

92171

"name": "Sortable",

92172

"description": "sel The Sortable list to join with"

92173

},

92174

{

92175

"name": "String",

92176

"description": "type The type of join to do: full, inner, outer, none. Default: full"

92177

}

92178

],

92179

"description": "Join this Sortable with another Sortable instance.\n<ul>\n <li>full: Exchange nodes with both lists.</li>\n <li>inner: Items can go into this list from the joined list.</li>\n <li>outer: Items can go out of the joined list into this list.</li>\n <li>none: Removes the join.</li>\n</ul>",

92180

"chainable": 1,

92181

"class": "Sortable",

92182

"module": "sortable"

92183

},

92184

{

92185

"file": "sortable/js/sortable.js",

92186

"line": 259,

92187

"access": "private",

92188

"tagname": "",

92189

"itemtype": "method",

92190

"name": "_join_none",

92191

"params": [

92192

{

92193

"name": "Sortable",

92194

"description": "sel The Sortable to remove the join from"

92195

}

92196

],

92197

"description": "Removes the join with the passed Sortable.",

92198

"class": "Sortable",

92199

"module": "sortable"

92200

},

92201

{

92202

"file": "sortable/js/sortable.js",

92203

"line": 269,

92204

"access": "private",

92205

"tagname": "",

92206

"itemtype": "method",

92207

"name": "_join_full",

92208

"params": [

92209

{

92210

"name": "Sortable",

92211

"description": "sel The Sortable list to join with"

92212

}

92213

],

92214

"description": "Joins both of the Sortables together.",

92215

"class": "Sortable",

92216

"module": "sortable"

92217

},

92218

{

92219

"file": "sortable/js/sortable.js",

92220

"line": 279,

92221

"access": "private",

92222

"tagname": "",

92223

"itemtype": "method",

92224

"name": "_join_outer",

92225

"params": [

92226

{

92227

"name": "Sortable",

92228

"description": "sel The Sortable list to join with"

92229

}

92230

],

92231

"description": "Allows this Sortable to accept items from the passed Sortable.",

92232

"class": "Sortable",

92233

"module": "sortable"

92234

},

92235

{

92236

"file": "sortable/js/sortable.js",

92237

"line": 288,

92238

"access": "private",

92239

"tagname": "",

92240

"itemtype": "method",

92241

"name": "_join_inner",

92242

"params": [

92243

{

92244

"name": "Sortable",

92245

"description": "sel The Sortable list to join with"

92246

}

92247

],

92248

"description": "Allows this Sortable to give items to the passed Sortable.",

92249

"class": "Sortable",

92250

"module": "sortable"

92251

},

92252

{

92253

"file": "sortable/js/sortable.js",

92254

"line": 297,

92255

"description": "A custom callback to allow a user to extract some sort of id or any other data from the node to use in the \"ordering list\" and then that data should be returned from the callback.",

92256

"itemtype": "method",

92257

"name": "getOrdering",

92258

"params": [

92259

{

92260

"name": "Function",

92261

"description": "callback"

92262

}

92263

],

92264

"return": {

92265

"description": "Array"

92266

},

92267

"class": "Sortable",

92268

"module": "sortable"

92269

},

92270

{

92271

"file": "sortable/js/sortable.js",

92272

"line": 320,

92273

"itemtype": "attribute",

92274

"name": "handles",

92275

"description": "Drag handles to pass on to the internal DD.Delegate instance.",

92276

"type": "Array",

92277

"class": "Sortable",

92278

"module": "sortable"

92279

},

92280

{

92281

"file": "sortable/js/sortable.js",

92282

"line": 328,

92283

"itemtype": "attribute",

92284

"name": "container",

92285

"description": "A selector query to get the container to listen for mousedown events on. All \"nodes\" should be a child of this container.",

92286

"type": "String",

92287

"class": "Sortable",

92288

"module": "sortable"

92289

},

92290

{

92291

"file": "sortable/js/sortable.js",

92292

"line": 336,

92293

"itemtype": "attribute",

92294

"name": "nodes",

92295

"description": "A selector query to get the children of the \"container\" to make draggable elements from.",

92296

"type": "String",

92297

"class": "Sortable",

92298

"module": "sortable"

92299

},

92300

{

92301

"file": "sortable/js/sortable.js",

92302

"line": 344,

92303

"itemtype": "attribute",

92304

"name": "opacity",

92305

"description": "The opacity to change the proxy item to when dragging.",

92306

"type": "String",

92307

"class": "Sortable",

92308

"module": "sortable"

92309

},

92310

{

92311

"file": "sortable/js/sortable.js",

92312

"line": 352,

92313

"itemtype": "attribute",

92314

"name": "opacityNode",

92315

"description": "The node to set opacity on when dragging (dragNode or currentNode). Default: currentNode.",

92316

"type": "String",

92317

"class": "Sortable",

92318

"module": "sortable"

92319

},

92320

{

92321

"file": "sortable/js/sortable.js",

92322

"line": 360,

92323

"itemtype": "attribute",

92324

"name": "id",

92325

"description": "The id of this Sortable, used to get a reference to this Sortable list from another list.",

92326

"type": "String",

92327

"class": "Sortable",

92328

"module": "sortable"

92329

},

92330

{

92331

"file": "sortable/js/sortable.js",

92332

"line": 368,

92333

"itemtype": "attribute",

92334

"name": "moveType",

92335

"description": "How should an item move to another list: insert, swap, move, copy. Default: insert",

92336

"type": "String",

92337

"class": "Sortable",

92338

"module": "sortable"

92339

},

92340

{

92341

"file": "sortable/js/sortable.js",

92342

"line": 376,

92343

"itemtype": "attribute",

92344

"name": "invalid",

92345

"description": "A selector string to test if a list item is invalid and not sortable",

92346

"type": "String",

92347

"class": "Sortable",

92348

"module": "sortable"

92349

},

92350

{

92351

"file": "sortable/js/sortable.js",

92352

"line": 385,

92353

"static": 1,

92354

"itemtype": "property",

92355

"name": "_sortables",

92356

"access": "private",

92357

"tagname": "",

92358

"type": "Array",

92359

"description": "Hash map of all Sortables on the page.",

92360

"class": "Sortable",

92361

"module": "sortable"

92362

},

92363

{

92364

"file": "sortable/js/sortable.js",

92365

"line": 393,

92366

"static": 1,

92367

"itemtype": "method",

92368

"name": "_test",

92369

"params": [

92370

{

92371

"name": "node",

92372

"description": "The node instance to test.",

92373

"type": "Node"

92374

},

92375

{

92376

"name": "test",

92377

"description": "The node instance or selector string to test against.",

92378

"type": "String|Node"

92379

}

92380

],

92381

"description": "Test a Node or a selector for the container",

92382

"class": "Sortable",

92383

"module": "sortable"

92384

},

92385

{

92386

"file": "sortable/js/sortable.js",

92387

"line": 407,

92388

"static": 1,

92389

"itemtype": "method",

92390

"name": "getSortable",

92391

"params": [

92392

{

92393

"name": "node",

92394

"description": "The node instance or selector string to use to find a Sortable instance.",

92395

"type": "String|Node"

92396

}

92397

],

92398

"description": "Get a Sortable instance back from a node reference or a selector string.",

92399

"class": "Sortable",

92400

"module": "sortable"

92401

},

92402

{

92403

"file": "sortable/js/sortable.js",

92404

"line": 423,

92405

"static": 1,

92406

"itemtype": "method",

92407

"name": "reg",

92408

"params": [

92409

{

92410

"name": "Sortable",

92411

"description": "s A Sortable instance."

92412

}

92413

],

92414

"description": "Register a Sortable instance with the singleton to allow lookups later.",

92415

"class": "Sortable",

92416

"module": "sortable"

92417

},

92418

{

92419

"file": "sortable/js/sortable.js",

92420

"line": 432,

92421

"static": 1,

92422

"itemtype": "method",

92423

"name": "unreg",

92424

"params": [

92425

{

92426

"name": "Sortable",

92427

"description": "s A Sortable instance."

92428

}

92429

],

92430

"description": "Unregister a Sortable instance with the singleton.",

92431

"class": "Sortable",

92432

"module": "sortable"

92433

},

92434

{

92435

"file": "sortable/js/sortable.js",

92436

"line": 450,

92437

"itemtype": "event",

92438

"name": "copy",

92439

"description": "A Sortable node was moved with a copy.",

92440

"params": [

92441

{

92442

"name": "event",

92443

"description": "An Event Facade object",

92444

"type": "Event.Facade",

92445

"props": [

92446

{

92447

"name": "same",

92448

"description": "Moved to the same list.",

92449

"type": "Boolean"

92450

},

92451

{

92452

"name": "drag",

92453

"description": "The drag instance.",

92454

"type": "DD.Drag"

92455

},

92456

{

92457

"name": "drop",

92458

"description": "The drop instance.",

92459

"type": "DD.Drop"

92460

}

92461

]

92462

}

92463

],

92464

"type": "{Event.Custom}",

92465

"class": "Sortable",

92466

"module": "sortable"

92467

},

92468

{

92469

"file": "sortable/js/sortable.js",

92470

"line": 459,

92471

"itemtype": "event",

92472

"name": "move",

92473

"description": "A Sortable node was moved with a move.",

92474

"params": [

92475

{

92476

"name": "event",

92477

"description": "An Event Facade object with the following specific property added:",

92478

"type": "Event.Facade",

92479

"props": [

92480

{

92481

"name": "same",

92482

"description": "Moved to the same list.",

92483

"type": "Boolean"

92484

},

92485

{

92486

"name": "drag",

92487

"description": "The drag instance.",

92488

"type": "DD.Drag"

92489

},

92490

{

92491

"name": "drop",

92492

"description": "The drop instance.",

92493

"type": "DD.Drop"

92494

}

92495

]

92496

}

92497

],

92498

"type": "{Event.Custom}",

92499

"class": "Sortable",

92500

"module": "sortable"

92501

},

92502

{

92503

"file": "sortable/js/sortable.js",

92504

"line": 468,

92505

"itemtype": "event",

92506

"name": "insert",

92507

"description": "A Sortable node was moved with an insert.",

92508

"params": [

92509

{

92510

"name": "event",

92511

"description": "An Event Facade object with the following specific property added:",

92512

"type": "Event.Facade",

92513

"props": [

92514

{

92515

"name": "same",

92516

"description": "Moved to the same list.",

92517

"type": "Boolean"

92518

},

92519

{

92520

"name": "drag",

92521

"description": "The drag instance.",

92522

"type": "DD.Drag"

92523

},

92524

{

92525

"name": "drop",

92526

"description": "The drop instance.",

92527

"type": "DD.Drop"

92528

}

92529

]

92530

}

92531

],

92532

"type": "{Event.Custom}",

92533

"class": "Sortable",

92534

"module": "sortable"

92535

},

92536

{

92537

"file": "sortable/js/sortable.js",

92538

"line": 477,

92539

"itemtype": "event",

92540

"name": "swap",

92541

"description": "A Sortable node was moved with a swap.",

92542

"params": [

92543

{

92544

"name": "event",

92545

"description": "An Event Facade object with the following specific property added:",

92546

"type": "Event.Facade",

92547

"props": [

92548

{

92549

"name": "same",

92550

"description": "Moved to the same list.",

92551

"type": "Boolean"

92552

},

92553

{

92554

"name": "drag",

92555

"description": "The drag instance.",

92556

"type": "DD.Drag"

92557

},

92558

{

92559

"name": "drop",

92560

"description": "The drop instance.",

92561

"type": "DD.Drop"

92562

}

92563

]

92564

}

92565

],

92566

"type": "{Event.Custom}",

92567

"class": "Sortable",

92568

"module": "sortable"

92569

},

92570

{

92571

"file": "sortable/js/sortable.js",

92572

"line": 486,

92573

"itemtype": "event",

92574

"name": "moved",

92575

"description": "A Sortable node was moved.",

92576

"params": [

92577

{

92578

"name": "event",

92579

"description": "An Event Facade object with the following specific property added:",

92580

"type": "Event.Facade",

92581

"props": [

92582

{

92583

"name": "same",

92584

"description": "Moved to the same list.",

92585

"type": "Boolean"

92586

},

92587

{

92588

"name": "drag",

92589

"description": "The drag instance.",

92590

"type": "DD.Drag"

92591

},

92592

{

92593

"name": "drop",

92594

"description": "The drop instance.",

92595

"type": "DD.Drop"

92596

}

92597

]

92598

}

92599

],

92600

"type": "{Event.Custom}",

92601

"class": "Sortable",

92602

"module": "sortable"

92603

},

92604

{

92605

"file": "stylesheet/js/stylesheet.js",

92606

"line": 219,

92607

"description": "Get the unique stamp for this StyleSheet instance",

92608

"itemtype": "method",

92609

"name": "getId",

92610

"return": {

92611

"description": "the static id",

92612

"type": "Number"

92613

},

92614

"class": "StyleSheet",

92615

"module": "stylesheet"

92616

},

92617

{

92618

"file": "stylesheet/js/stylesheet.js",

92619

"line": 227,

92620

"description": "Enable all the rules in the sheet",

92621

"itemtype": "method",

92622

"name": "enable",

92623

"return": {

92624

"description": "",

92625

"type": "StyleSheet"

92626

},

92627

"chainable": 1,

92628

"class": "StyleSheet",

92629

"module": "stylesheet"

92630

},

92631

{

92632

"file": "stylesheet/js/stylesheet.js",

92633

"line": 236,

92634

"description": "Disable all the rules in the sheet. Rules may be changed while the\nStyleSheet is disabled.",

92635

"itemtype": "method",

92636

"name": "disable",

92637

"return": {

92638

"description": "",

92639

"type": "StyleSheet"

92640

},

92641

"chainable": 1,

92642

"class": "StyleSheet",

92643

"module": "stylesheet"

92644

},

92645

{

92646

"file": "stylesheet/js/stylesheet.js",

92647

"line": 246,

92648

"description": "Returns false if the StyleSheet is disabled. Otherwise true.",

92649

"itemtype": "method",

92650

"name": "isEnabled",

92651

"return": {

92652

"description": "",

92653

"type": "Boolean"

92654

},

92655

"class": "StyleSheet",

92656

"module": "stylesheet"

92657

},

92658

{

92659

"file": "stylesheet/js/stylesheet.js",

92660

"line": 254,

92661

"description": "Set style properties for a provided selector string.\nIf the selector includes commas, it will be split into individual\nselectors and applied accordingly. If the selector string does not\nhave a corresponding rule in the sheet, it will be added.\n\nThe object properties in the second parameter must be the JavaScript\nnames of style properties. E.g. fontSize rather than font-size.\n\nThe float style property will be set by any of "float",\n"styleFloat", or "cssFloat".",

92662

"itemtype": "method",

92663

"name": "set",

92664

"params": [

92665

{

92666

"name": "sel",

92667

"description": "the selector string to apply the changes to",

92668

"type": "String"

92669

},

92670

{

92671

"name": "css",

92672

"description": "Object literal of style properties and new values",

92673

"type": "Object"

92674

}

92675

],

92676

"return": {

92677

"description": "",

92678

"type": "StyleSheet"

92679

},

92680

"chainable": 1,

92681

"class": "StyleSheet",

92682

"module": "stylesheet"

92683

},

92684

{

92685

"file": "stylesheet/js/stylesheet.js",

92686

"line": 314,

92687

"description": "Unset style properties for a provided selector string, removing\ntheir effect from the style cascade.\n\nIf the selector includes commas, it will be split into individual\nselectors and applied accordingly. If there are no properties\nremaining in the rule after unsetting, the rule is removed.\n\nThe style property or properties in the second parameter must be the\nJavaScript style property names. E.g. fontSize rather than font-size.\n\nThe float style property will be unset by any of "float",\n"styleFloat", or "cssFloat".",

92688

"itemtype": "method",

92689

"name": "unset",

92690

"params": [

92691

{

92692

"name": "sel",

92693

"description": "the selector string to apply the changes to",

92694

"type": "String"

92695

},

92696

{

92697

"name": "css",

92698

"description": "style property name or Array of names",

92699

"type": "String|Array"

92700

}

92701

],

92702

"return": {

92703

"description": "",

92704

"type": "StyleSheet"

92705

},

92706

"chainable": 1,

92707

"class": "StyleSheet",

92708

"module": "stylesheet"

92709

},

92710

{

92711

"file": "stylesheet/js/stylesheet.js",

92712

"line": 379,

92713

"description": "Get the current cssText for a rule or the entire sheet. If the\nselector param is supplied, only the cssText for that rule will be\nreturned, if found. If the selector string targets multiple\nselectors separated by commas, the cssText of the first rule only\nwill be returned. If no selector string, the stylesheet's full\ncssText will be returned.",

92714

"itemtype": "method",

92715

"name": "getCssText",

92716

"params": [

92717

{

92718

"name": "sel",

92719

"description": "Selector string",

92720

"type": "String"

92721

}

92722

],

92723

"return": {

92724

"description": "",

92725

"type": "String"

92726

},

92727

"class": "StyleSheet",

92728

"module": "stylesheet"

92729

},

92730

{

92731

"file": "stylesheet/js/stylesheet.js",

92732

"line": 458,

92733

"description": "Converts an object literal of style properties and values into a string\nof css text. This can then be assigned to el.style.cssText.\n\nThe optional second parameter is a cssText string representing the\nstarting state of the style prior to alterations. This is most often\nextracted from the eventual target's current el.style.cssText.",

92734

"itemtype": "method",

92735

"name": "toCssText",

92736

"params": [

92737

{

92738

"name": "css",

92739

"description": "object literal of style properties and values",

92740

"type": "Object"

92741

},

92742

{

92743

"name": "cssText",

92744

"description": "(optional) starting cssText value",

92745

"type": "String"

92746

}

92747

],

92748

"return": {

92749

"description": "the resulting cssText string",

92750

"type": "String"

92751

},

92752

"static": 1,

92753

"class": "StyleSheet",

92754

"module": "stylesheet"

92755

},

92756

{

92757

"file": "stylesheet/js/stylesheet.js",

92758

"line": 487,

92759

"description": "Registers a StyleSheet instance in the static registry by the given name",

92760

"itemtype": "method",

92761

"name": "register",

92762

"params": [

92763

{

92764

"name": "name",

92765

"description": "the name to assign the StyleSheet in the registry",

92766

"type": "String"

92767

},

92768

{

92769

"name": "sheet",

92770

"description": "The StyleSheet instance",

92771

"type": "StyleSheet"

92772

}

92773

],

92774

"return": {

92775

"description": "false if no name or sheet is not a StyleSheet\n instance. true otherwise.",

92776

"type": "Boolean"

92777

},

92778

"static": 1,

92779

"class": "StyleSheet",

92780

"module": "stylesheet"

92781

},

92782

{

92783

"file": "stylesheet/js/stylesheet.js",

92784

"line": 502,

92785

"description": "Determines if a selector string is safe to use. Used internally\nin set to prevent IE from locking up when attempting to add a rule for a\n"bad selector".\n\nBad selectors are considered to be any string containing unescaped\n`~!@$%^&()+=|{}[];'\"?< or space. Also forbidden are . or # followed by\nanything other than an alphanumeric. Additionally -abc or .-abc or\n#_abc or '# ' all fail. There are likely more failure cases, so\nplease file a bug if you encounter one.",

92786

"itemtype": "method",

92787

"name": "isValidSelector",

92788

"params": [

92789

{

92790

"name": "sel",

92791

"description": "the selector string",

92792

"type": "String"

92793

}

92794

],

92795

"return": {

92796

"description": "",

92797

"type": "Boolean"

92798

},

92799

"static": 1,

92800

"class": "StyleSheet",

92801

"module": "stylesheet"

92802

},

92803

{

92804

"file": "substitute/js/substitute.js",

92805

"line": 16,

92806

"description": "Does {placeholder} substitution on a string. The object passed as the\nsecond parameter provides values to replace the {placeholder}s.\n{placeholder} token names must match property names of the object. For\nexample\n\n`var greeting = Y.substitute(\"Hello, {who}!\", { who: \"World\" });`\n\n{placeholder} tokens that are undefined on the object map will be left in\ntact (leaving unsightly \"{placeholder}\"s in the output string). If your\nreplacement strings *should* include curly braces, use `{LBRACE}` and\n`{RBRACE}` in your object map string value.\n\nIf a function is passed as a third argument, it will be called for each\n{placeholder} found. The {placeholder} name is passed as the first value\nand the value from the object map is passed as the second. If the\n{placeholder} contains a space, the first token will be used to identify\nthe object map property and the remainder will be passed as a third\nargument to the function. See below for an example.\n\nIf the value in the object map for a given {placeholder} is an object and\nthe `dump` module is loaded, the replacement value will be the string\nresult of calling `Y.dump(...)` with the object as input. Include a\nnumeric second token in the {placeholder} to configure the depth of the call\nto `Y.dump(...)`, e.g. \"{someObject 2}\". See the\n<a href=\"../classes/YUI.html#method_dump\">`dump`</a> method for details.",

92807

"itemtype": "method",

92808

"name": "substitute",

92809

"params": [

92810

{

92811

"name": "s",

92812

"description": "The string that will be modified.",

92813

"type": "String"

92814

},

92815

{

92816

"name": "o",

92817

"description": "An object containing the replacement values.",

92818

"type": "Object"

92819

},

92820

{

92821

"name": "f",

92822

"description": "An optional function that can be used to\n process each match. It receives the key,\n value, and any extra metadata included with\n the key inside of the braces.",

92823

"type": "Function"

92824

},

92825

{

92826

"name": "recurse",

92827

"description": "if true, the replacement will be recursive,\n letting you have replacement tokens in replacement text.\n The default is false.",

92828

"type": "Boolean"

92829

}

92830

],

92831

"return": {

92832

"description": "the substituted string.",

92833

"type": "String"

92834

},

92835

"example": [

92836

"\n\n function getAttrVal(key, value, name) {\n // Return a string describing the named attribute and its value if\n // the first token is @. Otherwise, return the value from the\n // replacement object.\n if (key === \"@\") {\n value += name + \" Value: \" + myObject.get(name);\n }\n return value;\n }\n\n // Assuming myObject.set('foo', 'flowers'),\n // => \"Attr: foo Value: flowers\"\n var attrVal = Y.substitute(\"{@ foo}\", { \"@\": \"Attr: \" }, getAttrVal);"

92837

],

92838

"class": "YUI~substitute",

92839

"module": "substitute"

92840

},

92841

{

92842

"file": "swf/js/swf.js",

92843

"line": 111,

92844

"description": "Fired when the Flash player version on the user's machine is\nbelow the required value.",

92845

"itemtype": "event",

92846

"name": "wrongflashversion",

92847

"class": "SWF",

92848

"module": "swf"

92849

},

92850

{

92851

"file": "swf/js/swf.js",

92852

"line": 124,

92853

"access": "private",

92854

"tagname": "The static collection of all instances of the SWFs on the page.",

92855

"itemtype": "property",

92856

"name": "_instances",

92857

"type": "Object",

92858

"class": "SWF",

92859

"module": "swf"

92860

},

92861

{

92862

"file": "swf/js/swf.js",

92863

"line": 133,

92864

"access": "private",

92865

"tagname": "Handles an event coming from within the SWF and delegate it\nto a specific instance of SWF.",

92866

"itemtype": "method",

92867

"name": "eventHandler",

92868

"params": [

92869

{

92870

"name": "swfid",

92871

"description": "the id of the SWF dispatching the event",

92872

"type": "String"

92873

},

92874

{

92875

"name": "event",

92876

"description": "the event being transmitted.",

92877

"type": "Object"

92878

}

92879

],

92880

"class": "SWF",

92881

"module": "swf"

92882

},

92883

{

92884

"file": "swf/js/swf.js",

92885

"line": 146,

92886

"access": "private",

92887

"tagname": "Propagates a specific event from Flash to JS.",

92888

"itemtype": "method",

92889

"name": "_eventHandler",

92890

"params": [

92891

{

92892

"name": "event",

92893

"description": "The event to be propagated from Flash.",

92894

"type": "Object"

92895

}

92896

],

92897

"class": "SWF",

92898

"module": "swf"

92899

},

92900

{

92901

"file": "swf/js/swf.js",

92902

"line": 163,

92903

"description": "Calls a specific function exposed by the SWF's\nExternalInterface.",

92904

"itemtype": "method",

92905

"name": "callSWF",

92906

"params": [

92907

{

92908

"name": "func",

92909

"description": "the name of the function to call",

92910

"type": "String"

92911

},

92912

{

92913

"name": "args",

92914

"description": "the set of arguments to pass to the function.",

92915

"type": "Array"

92916

}

92917

],

92918

"class": "SWF",

92919

"module": "swf"

92920

},

92921

{

92922

"file": "swf/js/swf.js",

92923

"line": 183,

92924

"description": "Public accessor to the unique name of the SWF instance.",

92925

"itemtype": "method",

92926

"name": "toString",

92927

"return": {

92928

"description": "Unique name of the SWF instance.",

92929

"type": "String"

92930

},

92931

"class": "SWF",

92932

"module": "swf"

92933

},

92934

{

92935

"file": "swfdetect/js/swfdetect.js",

92936

"line": 74,

92937

"description": "Returns the version of either the Flash Player plugin (in Mozilla/WebKit/Opera browsers),\nor the Flash Player ActiveX control (in IE), as a String of the form \"MM.mm.rr\", where\nMM is the major version, mm is the minor version, and rr is the revision.",

92938

"itemtype": "method",

92939

"name": "getFlashVersion",

92940

"class": "SWFDetect",

92941

"module": "swfdetect"

92942

},

92943

{

92944

"file": "swfdetect/js/swfdetect.js",

92945

"line": 85,

92946

"description": "Checks whether the version of the Flash player installed on the user's machine is greater\nthan or equal to the one specified. If it is, this method returns true; it is false otherwise.",

92947

"itemtype": "method",

92948

"name": "isFlashVersionAtLeast",

92949

"return": {

92950

"description": "Whether the Flash player version is greater than or equal to the one specified.",

92951

"type": "Boolean"

92952

},

92953

"params": [

92954

{

92955

"name": "flashMajor",

92956

"description": "The Major version of the Flash player to compare against.",

92957

"type": "Int"

92958

},

92959

{

92960

"name": "flashMinor",

92961

"description": "The Minor version of the Flash player to compare against.",

92962

"type": "Int"

92963

},

92964

{

92965

"name": "flashRev",

92966

"description": "The Revision version of the Flash player to compare against.",

92967

"type": "Int"

92968

}

92969

],

92970

"class": "SWFDetect",

92971

"module": "swfdetect"

92972

},

92973

{

92974

"file": "tabview/js/tab.js",

92975

"line": 155,

92976

"itemtype": "attribute",

92977

"name": "triggerEvent",

92978

"default": "\"click\"",

92979

"type": "String",

92980

"class": "Tab",

92981

"module": "swfdetect"

92982

},

92983

{

92984

"file": "tabview/js/tab.js",

92985

"line": 164,

92986

"itemtype": "attribute",

92987

"name": "label",

92988

"type": "HTML",

92989

"class": "Tab",

92990

"module": "swfdetect"

92991

},

92992

{

92993

"file": "tabview/js/tab.js",

92994

"line": 173,

92995

"itemtype": "attribute",

92996

"name": "content",

92997

"type": "HTML",

92998

"class": "Tab",

92999

"module": "swfdetect"

93000

},

93001

{

93002

"file": "tabview/js/tab.js",

93003

"line": 182,

93004

"itemtype": "attribute",

93005

"name": "panelNode",

93006

"type": "Y.Node",

93007

"class": "Tab",

93008

"module": "swfdetect"

93009

},

93010

{

93011

"file": "test/js/ArrayAssert.js",

93012

"line": 17,

93013

"description": "Simple indexOf() implementation for an array. Defers to native\nif available.",

93014

"params": [

93015

{

93016

"name": "haystack",

93017

"description": "The array to search.",

93018

"type": "Array"

93019

},

93020

{

93021

"name": "needle",

93022

"description": "The value to locate.",

93023

"type": "Variant"

93024

}

93025

],

93026

"return": {

93027

"description": "The index of the needle if found or -1 if not.",

93028

"type": "Int"

93029

},

93030

"itemtype": "method",

93031

"name": "_indexOf",

93032

"access": "private",

93033

"tagname": "",

93034

"class": "Test.ArrayAssert",

93035

"module": "test",

93036

"namespace": "Test"

93037

},

93038

{

93039

"file": "test/js/ArrayAssert.js",

93040

"line": 39,

93041

"description": "Simple some() implementation for an array. Defers to native\nif available.",

93042

"params": [

93043

{

93044

"name": "haystack",

93045

"description": "The array to search.",

93046

"type": "Array"

93047

},

93048

{

93049

"name": "matcher",

93050

"description": "The function to run on each value.",

93051

"type": "Function"

93052

}

93053

],

93054

"return": {

93055

"description": "True if any value, when run through the matcher,\n returns true.",

93056

"type": "Boolean"

93057

},

93058

"itemtype": "method",

93059

"name": "_some",

93060

"access": "private",

93061

"tagname": "",

93062

"class": "Test.ArrayAssert",

93063

"module": "test",

93064

"namespace": "Test"

93065

},

93066

{

93067

"file": "test/js/ArrayAssert.js",

93068

"line": 62,

93069

"description": "Asserts that a value is present in an array. This uses the triple equals \nsign so no type cohersion may occur.",

93070

"params": [

93071

{

93072

"name": "needle",

93073

"description": "The value that is expected in the array.",

93074

"type": "Object"

93075

},

93076

{

93077

"name": "haystack",

93078

"description": "An array of values.",

93079

"type": "Array"

93080

},

93081

{

93082

"name": "message",

93083

"description": "(Optional) The message to display if the assertion fails.",

93084

"type": "String"

93085

}

93086

],

93087

"itemtype": "method",

93088

"name": "contains",

93089

"static": 1,

93090

"class": "Test.ArrayAssert",

93091

"module": "test",

93092

"namespace": "Test"

93093

},

93094

{

93095

"file": "test/js/ArrayAssert.js",

93096

"line": 81,

93097

"description": "Asserts that a set of values are present in an array. This uses the triple equals \nsign so no type cohersion may occur. For this assertion to pass, all values must\nbe found.",

93098

"params": [

93099

{

93100

"name": "needles",

93101

"description": "An array of values that are expected in the array.",

93102

"type": "Object[]"

93103

},

93104

{

93105

"name": "haystack",

93106

"description": "An array of values to check.",

93107

"type": "Array"

93108

},

93109

{

93110

"name": "message",

93111

"description": "(Optional) The message to display if the assertion fails.",

93112

"type": "String"

93113

}

93114

],

93115

"itemtype": "method",

93116

"name": "containsItems",

93117

"static": 1,

93118

"class": "Test.ArrayAssert",

93119

"module": "test",

93120

"namespace": "Test"

93121

},

93122

{

93123

"file": "test/js/ArrayAssert.js",

93124

"line": 103,

93125

"description": "Asserts that a value matching some condition is present in an array. This uses\na function to determine a match.",

93126

"params": [

93127

{

93128

"name": "matcher",

93129

"description": "A function that returns true if the items matches or false if not.",

93130

"type": "Function"

93131

},

93132

{

93133

"name": "haystack",

93134

"description": "An array of values.",

93135

"type": "Array"

93136

},

93137

{

93138

"name": "message",

93139

"description": "(Optional) The message to display if the assertion fails.",

93140

"type": "String"

93141

}

93142

],

93143

"itemtype": "method",

93144

"name": "containsMatch",

93145

"static": 1,

93146

"class": "Test.ArrayAssert",

93147

"module": "test",

93148

"namespace": "Test"

93149

},

93150

{

93151

"file": "test/js/ArrayAssert.js",

93152

"line": 126,

93153

"description": "Asserts that a value is not present in an array. This uses the triple equals \nAsserts that a value is not present in an array. This uses the triple equals \nsign so no type cohersion may occur.",

93154

"params": [

93155

{

93156

"name": "needle",

93157

"description": "The value that is expected in the array.",

93158

"type": "Object"

93159

},

93160

{

93161

"name": "haystack",

93162

"description": "An array of values.",

93163

"type": "Array"

93164

},

93165

{

93166

"name": "message",

93167

"description": "(Optional) The message to display if the assertion fails.",

93168

"type": "String"

93169

}

93170

],

93171

"itemtype": "method",

93172

"name": "doesNotContain",

93173

"static": 1,

93174

"class": "Test.ArrayAssert",

93175

"module": "test",

93176

"namespace": "Test"

93177

},

93178

{

93179

"file": "test/js/ArrayAssert.js",

93180

"line": 146,

93181

"description": "Asserts that a set of values are not present in an array. This uses the triple equals \nsign so no type cohersion may occur. For this assertion to pass, all values must\nnot be found.",

93182

"params": [

93183

{

93184

"name": "needles",

93185

"description": "An array of values that are not expected in the array.",

93186

"type": "Object[]"

93187

},

93188

{

93189

"name": "haystack",

93190

"description": "An array of values to check.",

93191

"type": "Array"

93192

},

93193

{

93194

"name": "message",

93195

"description": "(Optional) The message to display if the assertion fails.",

93196

"type": "String"

93197

}

93198

],

93199

"itemtype": "method",

93200

"name": "doesNotContainItems",

93201

"static": 1,

93202

"class": "Test.ArrayAssert",

93203

"module": "test",

93204

"namespace": "Test"

93205

},

93206

{

93207

"file": "test/js/ArrayAssert.js",

93208

"line": 169,

93209

"description": "Asserts that no values matching a condition are present in an array. This uses\na function to determine a match.",

93210

"params": [

93211

{

93212

"name": "matcher",

93213

"description": "A function that returns true if the item matches or false if not.",

93214

"type": "Function"

93215

},

93216

{

93217

"name": "haystack",

93218

"description": "An array of values.",

93219

"type": "Array"

93220

},

93221

{

93222

"name": "message",

93223

"description": "(Optional) The message to display if the assertion fails.",

93224

"type": "String"

93225

}

93226

],

93227

"itemtype": "method",

93228

"name": "doesNotContainMatch",

93229

"static": 1,

93230

"class": "Test.ArrayAssert",

93231

"module": "test",

93232

"namespace": "Test"

93233

},

93234

{

93235

"file": "test/js/ArrayAssert.js",

93236

"line": 193,

93237

"description": "Asserts that the given value is contained in an array at the specified index.\nThis uses the triple equals sign so no type cohersion will occur.",

93238

"params": [

93239

{

93240

"name": "needle",

93241

"description": "The value to look for.",

93242

"type": "Object"

93243

},

93244

{

93245

"name": "haystack",

93246

"description": "The array to search in.",

93247

"type": "Array"

93248

},

93249

{

93250

"name": "index",

93251

"description": "The index at which the value should exist.",

93252

"type": "Int"

93253

},

93254

{

93255

"name": "message",

93256

"description": "(Optional) The message to display if the assertion fails.",

93257

"type": "String"

93258

}

93259

],

93260

"itemtype": "method",

93261

"name": "indexOf",

93262

"static": 1,

93263

"class": "Test.ArrayAssert",

93264

"module": "test",

93265

"namespace": "Test"

93266

},

93267

{

93268

"file": "test/js/ArrayAssert.js",

93269

"line": 221,

93270

"description": "Asserts that the values in an array are equal, and in the same position,\nas values in another array. This uses the double equals sign\nso type cohersion may occur. Note that the array objects themselves\nneed not be the same for this test to pass.",

93271

"params": [

93272

{

93273

"name": "expected",

93274

"description": "An array of the expected values.",

93275

"type": "Array"

93276

},

93277

{

93278

"name": "actual",

93279

"description": "Any array of the actual values.",

93280

"type": "Array"

93281

},

93282

{

93283

"name": "message",

93284

"description": "(Optional) The message to display if the assertion fails.",

93285

"type": "String"

93286

}

93287

],

93288

"itemtype": "method",

93289

"name": "itemsAreEqual",

93290

"static": 1,

93291

"class": "Test.ArrayAssert",

93292

"module": "test",

93293

"namespace": "Test"

93294

},

93295

{

93296

"file": "test/js/ArrayAssert.js",

93297

"line": 255,

93298

"description": "Asserts that the values in an array are equivalent, and in the same position,\nas values in another array. This uses a function to determine if the values\nare equivalent. Note that the array objects themselves\nneed not be the same for this test to pass.",

93299

"params": [

93300

{

93301

"name": "expected",

93302

"description": "An array of the expected values.",

93303

"type": "Array"

93304

},

93305

{

93306

"name": "actual",

93307

"description": "Any array of the actual values.",

93308

"type": "Array"

93309

},

93310

{

93311

"name": "comparator",

93312

"description": "A function that returns true if the values are equivalent\n or false if not.",

93313

"type": "Function"

93314

},

93315

{

93316

"name": "message",

93317

"description": "(Optional) The message to display if the assertion fails.",

93318

"type": "String"

93319

}

93320

],

93321

"return": {

93322

"description": "",

93323

"type": "Void"

93324

},

93325

"itemtype": "method",

93326

"name": "itemsAreEquivalent",

93327

"static": 1,

93328

"class": "Test.ArrayAssert",

93329

"module": "test",

93330

"namespace": "Test"

93331

},

93332

{

93333

"file": "test/js/ArrayAssert.js",

93334

"line": 292,

93335

"description": "Asserts that an array is empty.",

93336

"params": [

93337

{

93338

"name": "actual",

93339

"description": "The array to test.",

93340

"type": "Array"

93341

},

93342

{

93343

"name": "message",

93344

"description": "(Optional) The message to display if the assertion fails.",

93345

"type": "String"

93346

}

93347

],

93348

"itemtype": "method",

93349

"name": "isEmpty",

93350

"static": 1,

93351

"class": "Test.ArrayAssert",

93352

"module": "test",

93353

"namespace": "Test"

93354

},

93355

{

93356

"file": "test/js/ArrayAssert.js",

93357

"line": 306,

93358

"description": "Asserts that an array is not empty.",

93359

"params": [

93360

{

93361

"name": "actual",

93362

"description": "The array to test.",

93363

"type": "Array"

93364

},

93365

{

93366

"name": "message",

93367

"description": "(Optional) The message to display if the assertion fails.",

93368

"type": "String"

93369

}

93370

],

93371

"itemtype": "method",

93372

"name": "isNotEmpty",

93373

"static": 1,

93374

"class": "Test.ArrayAssert",

93375

"module": "test",

93376

"namespace": "Test"

93377

},

93378

{

93379

"file": "test/js/ArrayAssert.js",

93380

"line": 320,

93381

"description": "Asserts that the values in an array are the same, and in the same position,\nas values in another array. This uses the triple equals sign\nso no type cohersion will occur. Note that the array objects themselves\nneed not be the same for this test to pass.",

93382

"params": [

93383

{

93384

"name": "expected",

93385

"description": "An array of the expected values.",

93386

"type": "Array"

93387

},

93388

{

93389

"name": "actual",

93390

"description": "Any array of the actual values.",

93391

"type": "Array"

93392

},

93393

{

93394

"name": "message",

93395

"description": "(Optional) The message to display if the assertion fails.",

93396

"type": "String"

93397

}

93398

],

93399

"itemtype": "method",

93400

"name": "itemsAreSame",

93401

"static": 1,

93402

"class": "Test.ArrayAssert",

93403

"module": "test",

93404

"namespace": "Test"

93405

},

93406

{

93407

"file": "test/js/ArrayAssert.js",

93408

"line": 349,

93409

"description": "Asserts that the given value is contained in an array at the specified index,\nstarting from the back of the array.\nThis uses the triple equals sign so no type cohersion will occur.",

93410

"params": [

93411

{

93412

"name": "needle",

93413

"description": "The value to look for.",

93414

"type": "Object"

93415

},

93416

{

93417

"name": "haystack",

93418

"description": "The array to search in.",

93419

"type": "Array"

93420

},

93421

{

93422

"name": "index",

93423

"description": "The index at which the value should exist.",

93424

"type": "Int"

93425

},

93426

{

93427

"name": "message",

93428

"description": "(Optional) The message to display if the assertion fails.",

93429

"type": "String"

93430

}

93431

],

93432

"itemtype": "method",

93433

"name": "lastIndexOf",

93434

"static": 1,

93435

"class": "Test.ArrayAssert",

93436

"module": "test",

93437

"namespace": "Test"

93438

},

93439

{

93440

"file": "test/js/Assert.js",

93441

"line": 13,

93442

"description": "The number of assertions performed.",

93443

"itemtype": "property",

93444

"name": "_asserts",

93445

"type": "int",

93446

"access": "private",

93447

"tagname": "",

93448

"class": "Test.Assert",

93449

"module": "test",

93450

"namespace": "Test"

93451

},

93452

{

93453

"file": "test/js/Assert.js",

93454

"line": 25,

93455

"description": "Formats a message so that it can contain the original assertion message\nin addition to the custom message.",

93456

"params": [

93457

{

93458

"name": "customMessage",

93459

"description": "The message passed in by the developer.",

93460

"type": "String"

93461

},

93462

{

93463

"name": "defaultMessage",

93464

"description": "The message created by the error by default.",

93465

"type": "String"

93466

}

93467

],

93468

"return": {

93469

"description": "The final error message, containing either or both.",

93470

"type": "String"

93471

},

93472

"access": "protected",

93473

"tagname": "",

93474

"static": 1,

93475

"itemtype": "method",

93476

"name": "_formatMessage",

93477

"class": "Test.Assert",

93478

"module": "test",

93479

"namespace": "Test"

93480

},

93481

{

93482

"file": "test/js/Assert.js",

93483

"line": 43,

93484

"description": "Returns the number of assertions that have been performed.",

93485

"itemtype": "method",

93486

"name": "_getCount",

93487

"access": "protected",

93488

"tagname": "",

93489

"static": 1,

93490

"class": "Test.Assert",

93491

"module": "test",

93492

"namespace": "Test"

93493

},

93494

{

93495

"file": "test/js/Assert.js",

93496

"line": 53,

93497

"description": "Increments the number of assertions that have been performed.",

93498

"itemtype": "method",

93499

"name": "_increment",

93500

"access": "protected",

93501

"tagname": "",

93502

"static": 1,

93503

"class": "Test.Assert",

93504

"module": "test",

93505

"namespace": "Test"

93506

},

93507

{

93508

"file": "test/js/Assert.js",

93509

"line": 63,

93510

"description": "Resets the number of assertions that have been performed to 0.",

93511

"itemtype": "method",

93512

"name": "_reset",

93513

"access": "protected",

93514

"tagname": "",

93515

"static": 1,

93516

"class": "Test.Assert",

93517

"module": "test",

93518

"namespace": "Test"

93519

},

93520

{

93521

"file": "test/js/Assert.js",

93522

"line": 77,

93523

"description": "Forces an assertion error to occur.",

93524

"params": [

93525

{

93526

"name": "message",

93527

"description": "(Optional) The message to display with the failure.",

93528

"type": "String"

93529

}

93530

],

93531

"itemtype": "method",

93532

"name": "fail",

93533

"static": 1,

93534

"class": "Test.Assert",

93535

"module": "test",

93536

"namespace": "Test"

93537

},

93538

{

93539

"file": "test/js/Assert.js",

93540

"line": 87,

93541

"description": "A marker that the test should pass.",

93542

"itemtype": "method",

93543

"name": "pass",

93544

"static": 1,

93545

"class": "Test.Assert",

93546

"module": "test",

93547

"namespace": "Test"

93548

},

93549

{

93550

"file": "test/js/Assert.js",

93551

"line": 100,

93552

"description": "Asserts that a value is equal to another. This uses the double equals sign\nso type cohersion may occur.",

93553

"params": [

93554

{

93555

"name": "expected",

93556

"description": "The expected value.",

93557

"type": "Object"

93558

},

93559

{

93560

"name": "actual",

93561

"description": "The actual value to test.",

93562

"type": "Object"

93563

},

93564

{

93565

"name": "message",

93566

"description": "(Optional) The message to display if the assertion fails.",

93567

"type": "String"

93568

}

93569

],

93570

"itemtype": "method",

93571

"name": "areEqual",

93572

"static": 1,

93573

"class": "Test.Assert",

93574

"module": "test",

93575

"namespace": "Test"

93576

},

93577

{

93578

"file": "test/js/Assert.js",

93579

"line": 116,

93580

"description": "Asserts that a value is not equal to another. This uses the double equals sign\nso type cohersion may occur.",

93581

"params": [

93582

{

93583

"name": "unexpected",

93584

"description": "The unexpected value.",

93585

"type": "Object"

93586

},

93587

{

93588

"name": "actual",

93589

"description": "The actual value to test.",

93590

"type": "Object"

93591

},

93592

{

93593

"name": "message",

93594

"description": "(Optional) The message to display if the assertion fails.",

93595

"type": "String"

93596

}

93597

],

93598

"itemtype": "method",

93599

"name": "areNotEqual",

93600

"static": 1,

93601

"class": "Test.Assert",

93602

"module": "test",

93603

"namespace": "Test"

93604

},

93605

{

93606

"file": "test/js/Assert.js",

93607

"line": 133,

93608

"description": "Asserts that a value is not the same as another. This uses the triple equals sign\nso no type cohersion may occur.",

93609

"params": [

93610

{

93611

"name": "unexpected",

93612

"description": "The unexpected value.",

93613

"type": "Object"

93614

},

93615

{

93616

"name": "actual",

93617

"description": "The actual value to test.",

93618

"type": "Object"

93619

},

93620

{

93621

"name": "message",

93622

"description": "(Optional) The message to display if the assertion fails.",

93623

"type": "String"

93624

}

93625

],

93626

"itemtype": "method",

93627

"name": "areNotSame",

93628

"static": 1,

93629

"class": "Test.Assert",

93630

"module": "test",

93631

"namespace": "Test"

93632

},

93633

{

93634

"file": "test/js/Assert.js",

93635

"line": 149,

93636

"description": "Asserts that a value is the same as another. This uses the triple equals sign\nso no type cohersion may occur.",

93637

"params": [

93638

{

93639

"name": "expected",

93640

"description": "The expected value.",

93641

"type": "Object"

93642

},

93643

{

93644

"name": "actual",

93645

"description": "The actual value to test.",

93646

"type": "Object"

93647

},

93648

{

93649

"name": "message",

93650

"description": "(Optional) The message to display if the assertion fails.",

93651

"type": "String"

93652

}

93653

],

93654

"itemtype": "method",

93655

"name": "areSame",

93656

"static": 1,

93657

"class": "Test.Assert",

93658

"module": "test",

93659

"namespace": "Test"

93660

},

93661

{

93662

"file": "test/js/Assert.js",

93663

"line": 169,

93664

"description": "Asserts that a value is false. This uses the triple equals sign\nso no type cohersion may occur.",

93665

"params": [

93666

{

93667

"name": "actual",

93668

"description": "The actual value to test.",

93669

"type": "Object"

93670

},

93671

{

93672

"name": "message",

93673

"description": "(Optional) The message to display if the assertion fails.",

93674

"type": "String"

93675

}

93676

],

93677

"itemtype": "method",

93678

"name": "isFalse",

93679

"static": 1,

93680

"class": "Test.Assert",

93681

"module": "test",

93682

"namespace": "Test"

93683

},

93684

{

93685

"file": "test/js/Assert.js",

93686

"line": 184,

93687

"description": "Asserts that a value is true. This uses the triple equals sign\nso no type cohersion may occur.",

93688

"params": [

93689

{

93690

"name": "actual",

93691

"description": "The actual value to test.",

93692

"type": "Object"

93693

},

93694

{

93695

"name": "message",

93696

"description": "(Optional) The message to display if the assertion fails.",

93697

"type": "String"

93698

}

93699

],

93700

"itemtype": "method",

93701

"name": "isTrue",

93702

"static": 1,

93703

"class": "Test.Assert",

93704

"module": "test",

93705

"namespace": "Test"

93706

},

93707

{

93708

"file": "test/js/Assert.js",

93709

"line": 204,

93710

"description": "Asserts that a value is not a number.",

93711

"params": [

93712

{

93713

"name": "actual",

93714

"description": "The value to test.",

93715

"type": "Object"

93716

},

93717

{

93718

"name": "message",

93719

"description": "(Optional) The message to display if the assertion fails.",

93720

"type": "String"

93721

}

93722

],

93723

"itemtype": "method",

93724

"name": "isNaN",

93725

"static": 1,

93726

"class": "Test.Assert",

93727

"module": "test",

93728

"namespace": "Test"

93729

},

93730

{

93731

"file": "test/js/Assert.js",

93732

"line": 218,

93733

"description": "Asserts that a value is not the special NaN value.",

93734

"params": [

93735

{

93736

"name": "actual",

93737

"description": "The value to test.",

93738

"type": "Object"

93739

},

93740

{

93741

"name": "message",

93742

"description": "(Optional) The message to display if the assertion fails.",

93743

"type": "String"

93744

}

93745

],

93746

"itemtype": "method",

93747

"name": "isNotNaN",

93748

"static": 1,

93749

"class": "Test.Assert",

93750

"module": "test",

93751

"namespace": "Test"

93752

},

93753

{

93754

"file": "test/js/Assert.js",

93755

"line": 232,

93756

"description": "Asserts that a value is not null. This uses the triple equals sign\nso no type cohersion may occur.",

93757

"params": [

93758

{

93759

"name": "actual",

93760

"description": "The actual value to test.",

93761

"type": "Object"

93762

},

93763

{

93764

"name": "message",

93765

"description": "(Optional) The message to display if the assertion fails.",

93766

"type": "String"

93767

}

93768

],

93769

"itemtype": "method",

93770

"name": "isNotNull",

93771

"static": 1,

93772

"class": "Test.Assert",

93773

"module": "test",

93774

"namespace": "Test"

93775

},

93776

{

93777

"file": "test/js/Assert.js",

93778

"line": 247,

93779

"description": "Asserts that a value is not undefined. This uses the triple equals sign\nso no type cohersion may occur.",

93780

"params": [

93781

{

93782

"name": "actual",

93783

"description": "The actual value to test.",

93784

"type": "Object"

93785

},

93786

{

93787

"name": "message",

93788

"description": "(Optional) The message to display if the assertion fails.",

93789

"type": "String"

93790

}

93791

],

93792

"itemtype": "method",

93793

"name": "isNotUndefined",

93794

"static": 1,

93795

"class": "Test.Assert",

93796

"module": "test",

93797

"namespace": "Test"

93798

},

93799

{

93800

"file": "test/js/Assert.js",

93801

"line": 262,

93802

"description": "Asserts that a value is null. This uses the triple equals sign\nso no type cohersion may occur.",

93803

"params": [

93804

{

93805

"name": "actual",

93806

"description": "The actual value to test.",

93807

"type": "Object"

93808

},

93809

{

93810

"name": "message",

93811

"description": "(Optional) The message to display if the assertion fails.",

93812

"type": "String"

93813

}

93814

],

93815

"itemtype": "method",

93816

"name": "isNull",

93817

"static": 1,

93818

"class": "Test.Assert",

93819

"module": "test",

93820

"namespace": "Test"

93821

},

93822

{

93823

"file": "test/js/Assert.js",

93824

"line": 277,

93825

"description": "Asserts that a value is undefined. This uses the triple equals sign\nso no type cohersion may occur.",

93826

"params": [

93827

{

93828

"name": "actual",

93829

"description": "The actual value to test.",

93830

"type": "Object"

93831

},

93832

{

93833

"name": "message",

93834

"description": "(Optional) The message to display if the assertion fails.",

93835

"type": "String"

93836

}

93837

],

93838

"itemtype": "method",

93839

"name": "isUndefined",

93840

"static": 1,

93841

"class": "Test.Assert",

93842

"module": "test",

93843

"namespace": "Test"

93844

},

93845

{

93846

"file": "test/js/Assert.js",

93847

"line": 296,

93848

"description": "Asserts that a value is an array.",

93849

"params": [

93850

{

93851

"name": "actual",

93852

"description": "The value to test.",

93853

"type": "Object"

93854

},

93855

{

93856

"name": "message",

93857

"description": "(Optional) The message to display if the assertion fails.",

93858

"type": "String"

93859

}

93860

],

93861

"itemtype": "method",

93862

"name": "isArray",

93863

"static": 1,

93864

"class": "Test.Assert",

93865

"module": "test",

93866

"namespace": "Test"

93867

},

93868

{

93869

"file": "test/js/Assert.js",

93870

"line": 316,

93871

"description": "Asserts that a value is a Boolean.",

93872

"params": [

93873

{

93874

"name": "actual",

93875

"description": "The value to test.",

93876

"type": "Object"

93877

},

93878

{

93879

"name": "message",

93880

"description": "(Optional) The message to display if the assertion fails.",

93881

"type": "String"

93882

}

93883

],

93884

"itemtype": "method",

93885

"name": "isBoolean",

93886

"static": 1,

93887

"class": "Test.Assert",

93888

"module": "test",

93889

"namespace": "Test"

93890

},

93891

{

93892

"file": "test/js/Assert.js",

93893

"line": 330,

93894

"description": "Asserts that a value is a function.",

93895

"params": [

93896

{

93897

"name": "actual",

93898

"description": "The value to test.",

93899

"type": "Object"

93900

},

93901

{

93902

"name": "message",

93903

"description": "(Optional) The message to display if the assertion fails.",

93904

"type": "String"

93905

}

93906

],

93907

"itemtype": "method",

93908

"name": "isFunction",

93909

"static": 1,

93910

"class": "Test.Assert",

93911

"module": "test",

93912

"namespace": "Test"

93913

},

93914

{

93915

"file": "test/js/Assert.js",

93916

"line": 344,

93917

"description": "Asserts that a value is an instance of a particular object. This may return\nincorrect results when comparing objects from one frame to constructors in\nanother frame. For best results, don't use in a cross-frame manner.",

93918

"params": [

93919

{

93920

"name": "expected",

93921

"description": "The function that the object should be an instance of.",

93922

"type": "Function"

93923

},

93924

{

93925

"name": "actual",

93926

"description": "The object to test.",

93927

"type": "Object"

93928

},

93929

{

93930

"name": "message",

93931

"description": "(Optional) The message to display if the assertion fails.",

93932

"type": "String"

93933

}

93934

],

93935

"itemtype": "method",

93936

"name": "isInstanceOf",

93937

"static": 1,

93938

"class": "Test.Assert",

93939

"module": "test",

93940

"namespace": "Test"

93941

},

93942

{

93943

"file": "test/js/Assert.js",

93944

"line": 361,

93945

"description": "Asserts that a value is a number.",

93946

"params": [

93947

{

93948

"name": "actual",

93949

"description": "The value to test.",

93950

"type": "Object"

93951

},

93952

{

93953

"name": "message",

93954

"description": "(Optional) The message to display if the assertion fails.",

93955

"type": "String"

93956

}

93957

],

93958

"itemtype": "method",

93959

"name": "isNumber",

93960

"static": 1,

93961

"class": "Test.Assert",

93962

"module": "test",

93963

"namespace": "Test"

93964

},

93965

{

93966

"file": "test/js/Assert.js",

93967

"line": 375,

93968

"description": "Asserts that a value is an object.",

93969

"params": [

93970

{

93971

"name": "actual",

93972

"description": "The value to test.",

93973

"type": "Object"

93974

},

93975

{

93976

"name": "message",

93977

"description": "(Optional) The message to display if the assertion fails.",

93978

"type": "String"

93979

}

93980

],

93981

"itemtype": "method",

93982

"name": "isObject",

93983

"static": 1,

93984

"class": "Test.Assert",

93985

"module": "test",

93986

"namespace": "Test"

93987

},

93988

{

93989

"file": "test/js/Assert.js",

93990

"line": 389,

93991

"description": "Asserts that a value is a string.",

93992

"params": [

93993

{

93994

"name": "actual",

93995

"description": "The value to test.",

93996

"type": "Object"

93997

},

93998

{

93999

"name": "message",

94000

"description": "(Optional) The message to display if the assertion fails.",

94001

"type": "String"

94002

}

94003

],

94004

"itemtype": "method",

94005

"name": "isString",

94006

"static": 1,

94007

"class": "Test.Assert",

94008

"module": "test",

94009

"namespace": "Test"

94010

},

94011

{

94012

"file": "test/js/Assert.js",

94013

"line": 403,

94014

"description": "Asserts that a value is of a particular type.",

94015

"params": [

94016

{

94017

"name": "expectedType",

94018

"description": "The expected type of the variable.",

94019

"type": "String"

94020

},

94021

{

94022

"name": "actualValue",

94023

"description": "The actual value to test.",

94024

"type": "Object"

94025

},

94026

{

94027

"name": "message",

94028

"description": "(Optional) The message to display if the assertion fails.",

94029

"type": "String"

94030

}

94031

],

94032

"itemtype": "method",

94033

"name": "isTypeOf",

94034

"static": 1,

94035

"class": "Test.Assert",

94036

"module": "test",

94037

"namespace": "Test"

94038

},

94039

{

94040

"file": "test/js/Assert.js",

94041

"line": 422,

94042

"description": "Asserts that executing a particular method should throw an error of\na specific type. This is a replacement for _should.error.",

94043

"params": [

94044

{

94045

"name": "expectedError",

94046

"description": "If a string, this\n is the error message that the error must have; if a function, this\n is the constructor that should have been used to create the thrown\n error; if an object, this is an instance of a particular error type\n with a specific error message (both must match).",

94047

"type": "String|Function|Object"

94048

},

94049

{

94050

"name": "method",

94051

"description": "The method to execute that should throw the error.",

94052

"type": "Function"

94053

},

94054

{

94055

"name": "message",

94056

"description": "(Optional) The message to display if the assertion\n fails.",

94057

"type": "String"

94058

}

94059

],

94060

"itemtype": "method",

94061

"name": "throwsError",

94062

"return": {

94063

"description": "",

94064

"type": "Void"

94065

},

94066

"static": 1,

94067

"class": "Test.Assert",

94068

"module": "test",

94069

"namespace": "Test"

94070

},

94071

{

94072

"file": "test/js/AssertionError.js",

94073

"line": 14,

94074

"description": "Error message. Must be duplicated to ensure browser receives it.",

94075

"type": "String",

94076

"itemtype": "property",

94077

"name": "message",

94078

"class": "Test.AssertionError",

94079

"module": "test",

94080

"namespace": "Test"

94081

},

94082

{

94083

"file": "test/js/AssertionError.js",

94084

"line": 21,

94085

"description": "The name of the error that occurred.",

94086

"type": "String",

94087

"itemtype": "property",

94088

"name": "name",

94089

"class": "Test.AssertionError",

94090

"module": "test",

94091

"namespace": "Test"

94092

},

94093

{

94094

"file": "test/js/AssertionError.js",

94095

"line": 34,

94096

"description": "Returns a fully formatted error for an assertion failure. This should\nbe overridden by all subclasses to provide specific information.",

94097

"itemtype": "method",

94098

"name": "getMessage",

94099

"return": {

94100

"description": "A string describing the error.",

94101

"type": "String"

94102

},

94103

"class": "Test.AssertionError",

94104

"module": "test",

94105

"namespace": "Test"

94106

},

94107

{

94108

"file": "test/js/AssertionError.js",

94109

"line": 44,

94110

"description": "Returns a string representation of the error.",

94111

"itemtype": "method",

94112

"name": "toString",

94113

"return": {

94114

"description": "A string representation of the error.",

94115

"type": "String"

94116

},

94117

"class": "Test.AssertionError",

94118

"module": "test",

94119

"namespace": "Test"

94120

},

94121

{

94122

"file": "test/js/ComparisonFailure.js",

94123

"line": 20,

94124

"description": "The expected value.",

94125

"type": "Object",

94126

"itemtype": "property",

94127

"name": "expected",

94128

"class": "Test.ComparisonFailure",

94129

"module": "test",

94130

"namespace": "Test"

94131

},

94132

{

94133

"file": "test/js/ComparisonFailure.js",

94134

"line": 27,

94135

"description": "The actual value.",

94136

"type": "Object",

94137

"itemtype": "property",

94138

"name": "actual",

94139

"class": "Test.ComparisonFailure",

94140

"module": "test",

94141

"namespace": "Test"

94142

},

94143

{

94144

"file": "test/js/ComparisonFailure.js",

94145

"line": 34,

94146

"description": "The name of the error that occurred.",

94147

"type": "String",

94148

"itemtype": "property",

94149

"name": "name",

94150

"class": "Test.ComparisonFailure",

94151

"module": "test",

94152

"namespace": "Test"

94153

},

94154

{

94155

"file": "test/js/ComparisonFailure.js",

94156

"line": 49,

94157

"description": "Returns a fully formatted error for an assertion failure. This message\nprovides information about the expected and actual values.",

94158

"itemtype": "method",

94159

"name": "getMessage",

94160

"return": {

94161

"description": "A string describing the error.",

94162

"type": "String"

94163

},

94164

"class": "Test.ComparisonFailure",

94165

"module": "test",

94166

"namespace": "Test"

94167

},

94168

{

94169

"file": "test/js/CoverageFormat.js",

94170

"line": 10,

94171

"description": "Returns the coverage report in JSON format. This is the straight\nJSON representation of the native coverage report.",

94172

"params": [

94173

{

94174

"name": "coverage",

94175

"description": "The coverage report object.",

94176

"type": "Object"

94177

}

94178

],

94179

"return": {

94180

"description": "A JSON-formatted string of coverage data.",

94181

"type": "String"

94182

},

94183

"itemtype": "method",

94184

"name": "JSON",

94185

"class": "Test.CoverageFormat",

94186

"module": "test",

94187

"namespace": "Test.CoverageFormat"

94188

},

94189

{

94190

"file": "test/js/CoverageFormat.js",

94191

"line": 22,

94192

"description": "Returns the coverage report in a JSON format compatible with\nXdebug. See <a href=\"http://www.xdebug.com/docs/code_coverage\">Xdebug Documentation</a>\nfor more information. Note: function coverage is not available\nin this format.",

94193

"params": [

94194

{

94195

"name": "coverage",

94196

"description": "The coverage report object.",

94197

"type": "Object"

94198

}

94199

],

94200

"return": {

94201

"description": "A JSON-formatted string of coverage data.",

94202

"type": "String"

94203

},

94204

"itemtype": "method",

94205

"name": "XdebugJSON",

94206

"class": "Test.CoverageFormat",

94207

"module": "test",

94208

"namespace": "Test.CoverageFormat"

94209

},

94210

{

94211

"file": "test/js/DateAssert.js",

94212

"line": 14,

94213

"description": "Asserts that a date's month, day, and year are equal to another date's.",

94214

"params": [

94215

{

94216

"name": "expected",

94217

"description": "The expected date.",

94218

"type": "Date"

94219

},

94220

{

94221

"name": "actual",

94222

"description": "The actual date to test.",

94223

"type": "Date"

94224

},

94225

{

94226

"name": "message",

94227

"description": "(Optional) The message to display if the assertion fails.",

94228

"type": "String"

94229

}

94230

],

94231

"itemtype": "method",

94232

"name": "datesAreEqual",

94233

"static": 1,

94234

"class": "Test.DateAssert",

94235

"module": "test",

94236

"namespace": "Test"

94237

},

94238

{

94239

"file": "test/js/DateAssert.js",

94240

"line": 50,

94241

"description": "Asserts that a date's hour, minutes, and seconds are equal to another date's.",

94242

"params": [

94243

{

94244

"name": "expected",

94245

"description": "The expected date.",

94246

"type": "Date"

94247

},

94248

{

94249

"name": "actual",

94250

"description": "The actual date to test.",

94251

"type": "Date"

94252

},

94253

{

94254

"name": "message",

94255

"description": "(Optional) The message to display if the assertion fails.",

94256

"type": "String"

94257

}

94258

],

94259

"itemtype": "method",

94260

"name": "timesAreEqual",

94261

"static": 1,

94262

"class": "Test.DateAssert",

94263

"module": "test",

94264

"namespace": "Test"

94265

},

94266

{

94267

"file": "test/js/EventTarget.js",

94268

"line": 11,

94269

"description": "Event handlers for the various events.",

94270

"type": "Object",

94271

"access": "private",

94272

"tagname": "",

94273

"itemtype": "property",

94274

"name": "_handlers",

94275

"static": 1,

94276

"class": "Test.EventTarget",

94277

"module": "test",

94278

"namespace": "Test"

94279

},

94280

{

94281

"file": "test/js/EventTarget.js",

94282

"line": 31,

94283

"description": "Adds a listener for a given event type.",

94284

"params": [

94285

{

94286

"name": "type",

94287

"description": "The type of event to add a listener for.",

94288

"type": "String"

94289

},

94290

{

94291

"name": "listener",

94292

"description": "The function to call when the event occurs.",

94293

"type": "Function"

94294

}

94295

],

94296

"return": {

94297

"description": "",

94298

"type": "Void"

94299

},

94300

"itemtype": "method",

94301

"name": "attach",

94302

"class": "Test.EventTarget",

94303

"module": "test",

94304

"namespace": "Test"

94305

},

94306

{

94307

"file": "test/js/EventTarget.js",

94308

"line": 46,

94309

"description": "Adds a listener for a given event type.",

94310

"params": [

94311

{

94312

"name": "type",

94313

"description": "The type of event to add a listener for.",

94314

"type": "String"

94315

},

94316

{

94317

"name": "listener",

94318

"description": "The function to call when the event occurs.",

94319

"type": "Function"

94320

}

94321

],

94322

"return": {

94323

"description": "",

94324

"type": "Void"

94325

},

94326

"itemtype": "method",

94327

"name": "subscribe",

94328

"deprecated": true,

94329

"class": "Test.EventTarget",

94330

"module": "test",

94331

"namespace": "Test"

94332

},

94333

{

94334

"file": "test/js/EventTarget.js",

94335

"line": 58,

94336

"description": "Fires an event based on the passed-in object.",

94337

"params": [

94338

{

94339

"name": "event",

94340

"description": "An object with at least a 'type' attribute\n or a string indicating the event name.",

94341

"type": "Object|String"

94342

}

94343

],

94344

"return": {

94345

"description": "",

94346

"type": "Void"

94347

},

94348

"itemtype": "method",

94349

"name": "fire",

94350

"class": "Test.EventTarget",

94351

"module": "test",

94352

"namespace": "Test"

94353

},

94354

{

94355

"file": "test/js/EventTarget.js",

94356

"line": 85,

94357

"description": "Removes a listener for a given event type.",

94358

"params": [

94359

{

94360

"name": "type",

94361

"description": "The type of event to remove a listener from.",

94362

"type": "String"

94363

},

94364

{

94365

"name": "listener",

94366

"description": "The function to remove from the event.",

94367

"type": "Function"

94368

}

94369

],

94370

"return": {

94371

"description": "",

94372

"type": "Void"

94373

},

94374

"itemtype": "method",

94375

"name": "detach",

94376

"class": "Test.EventTarget",

94377

"module": "test",

94378

"namespace": "Test"

94379

},

94380

{

94381

"file": "test/js/EventTarget.js",

94382

"line": 104,

94383

"description": "Removes a listener for a given event type.",

94384

"params": [

94385

{

94386

"name": "type",

94387

"description": "The type of event to remove a listener from.",

94388

"type": "String"

94389

},

94390

{

94391

"name": "listener",

94392

"description": "The function to remove from the event.",

94393

"type": "Function"

94394

}

94395

],

94396

"return": {

94397

"description": "",

94398

"type": "Void"

94399

},

94400

"itemtype": "method",

94401

"name": "unsubscribe",

94402

"deprecated": true,

94403

"class": "Test.EventTarget",

94404

"module": "test",

94405

"namespace": "Test"

94406

},

94407

{

94408

"file": "test/js/Mock.js",

94409

"line": 45,

94410

"description": "Assigns an expectation to a mock object. This is used to create\nmethods and properties on the mock object that are monitored for\ncalls and changes, respectively.",

94411

"params": [

94412

{

94413

"name": "mock",

94414

"description": "The object to add the expectation to.",

94415

"type": "Object"

94416

},

94417

{

94418

"name": "expectation",

94419

"description": "An object defining the expectation. For\n a method, the keys \"method\" and \"args\" are required with\n an optional \"returns\" key available. For properties, the keys\n \"property\" and \"value\" are required.",

94420

"type": "Object"

94421

}

94422

],

94423

"return": {

94424

"description": "",

94425

"type": "Void"

94426

},

94427

"itemtype": "method",

94428

"name": "expect",

94429

"static": 1,

94430

"class": "Test.Mock",

94431

"module": "test",

94432

"namespace": "Test"

94433

},

94434

{

94435

"file": "test/js/Mock.js",

94436

"line": 127,

94437

"description": "Verifies that all expectations of a mock object have been met and\nthrows an assertion error if not.",

94438

"params": [

94439

{

94440

"name": "mock",

94441

"description": "The object to verify..",

94442

"type": "Object"

94443

}

94444

],

94445

"return": {

94446

"description": "",

94447

"type": "Void"

94448

},

94449

"itemtype": "method",

94450

"name": "verify",

94451

"static": 1,

94452

"class": "Test.Mock",

94453

"module": "test",

94454

"namespace": "Test"

94455

},

94456

{

94457

"file": "test/js/Mock.js",

94458

"line": 178,

94459

"description": "Predefined matcher to match any value.",

94460

"itemtype": "property",

94461

"name": "Any",

94462

"static": 1,

94463

"type": "Function",

94464

"class": "Test.Mock.Value",

94465

"module": "test",

94466

"namespace": "Test.Mock"

94467

},

94468

{

94469

"file": "test/js/Mock.js",

94470

"line": 186,

94471

"description": "Predefined matcher to match boolean values.",

94472

"itemtype": "property",

94473

"name": "Boolean",

94474

"static": 1,

94475

"type": "Function",

94476

"class": "Test.Mock.Value",

94477

"module": "test",

94478

"namespace": "Test.Mock"

94479

},

94480

{

94481

"file": "test/js/Mock.js",

94482

"line": 194,

94483

"description": "Predefined matcher to match number values.",

94484

"itemtype": "property",

94485

"name": "Number",

94486

"static": 1,

94487

"type": "Function",

94488

"class": "Test.Mock.Value",

94489

"module": "test",

94490

"namespace": "Test.Mock"

94491

},

94492

{

94493

"file": "test/js/Mock.js",

94494

"line": 202,

94495

"description": "Predefined matcher to match string values.",

94496

"itemtype": "property",

94497

"name": "String",

94498

"static": 1,

94499

"type": "Function",

94500

"class": "Test.Mock.Value",

94501

"module": "test",

94502

"namespace": "Test.Mock"

94503

},

94504

{

94505

"file": "test/js/Mock.js",

94506

"line": 210,

94507

"description": "Predefined matcher to match object values.",

94508

"itemtype": "property",

94509

"name": "Object",

94510

"static": 1,

94511

"type": "Function",

94512

"class": "Test.Mock.Value",

94513

"module": "test",

94514

"namespace": "Test.Mock"

94515

},

94516

{

94517

"file": "test/js/Mock.js",

94518

"line": 218,

94519

"description": "Predefined matcher to match function values.",

94520

"itemtype": "property",

94521

"name": "Function",

94522

"static": 1,

94523

"type": "Function",

94524

"class": "Test.Mock.Value",

94525

"module": "test",

94526

"namespace": "Test.Mock"

94527

},

94528

{

94529

"file": "test/js/ObjectAssert.js",

94530

"line": 12,

94531

"description": "Asserts that an object has all of the same properties\nand property values as the other.",

94532

"params": [

94533

{

94534

"name": "expected",

94535

"description": "The object with all expected properties and values.",

94536

"type": "Object"

94537

},

94538

{

94539

"name": "actual",

94540

"description": "The object to inspect.",

94541

"type": "Object"

94542

},

94543

{

94544

"name": "message",

94545

"description": "(Optional) The message to display if the assertion fails.",

94546

"type": "String"

94547

}

94548

],

94549

"itemtype": "method",

94550

"name": "areEqual",

94551

"static": 1,

94552

"deprecated": true,

94553

"class": "Test.ObjectAssert",

94554

"module": "test",

94555

"namespace": "Test"

94556

},

94557

{

94558

"file": "test/js/ObjectAssert.js",

94559

"line": 43,

94560

"description": "Asserts that an object has a property with the given name.",

94561

"params": [

94562

{

94563

"name": "propertyName",

94564

"description": "The name of the property to test.",

94565

"type": "String"

94566

},

94567

{

94568

"name": "object",

94569

"description": "The object to search.",

94570

"type": "Object"

94571

},

94572

{

94573

"name": "message",

94574

"description": "(Optional) The message to display if the assertion fails.",

94575

"type": "String"

94576

}

94577

],

94578

"itemtype": "method",

94579

"name": "hasKey",

94580

"static": 1,

94581

"deprecated": true,

94582

"deprecationMessage": "Use ownsOrInheritsKey() instead",

94583

"class": "Test.ObjectAssert",

94584

"module": "test",

94585

"namespace": "Test"

94586

},

94587

{

94588

"file": "test/js/ObjectAssert.js",

94589

"line": 56,

94590

"description": "Asserts that an object has all properties of a reference object.",

94591

"params": [

94592

{

94593

"name": "properties",

94594

"description": "An array of property names that should be on the object.",

94595

"type": "Array"

94596

},

94597

{

94598

"name": "object",

94599

"description": "The object to search.",

94600

"type": "Object"

94601

},

94602

{

94603

"name": "message",

94604

"description": "(Optional) The message to display if the assertion fails.",

94605

"type": "String"

94606

}

94607

],

94608

"itemtype": "method",

94609

"name": "hasKeys",

94610

"static": 1,

94611

"deprecated": true,

94612

"deprecationMessage": "Use ownsOrInheritsKeys() instead",

94613

"class": "Test.ObjectAssert",

94614

"module": "test",

94615

"namespace": "Test"

94616

},

94617

{

94618

"file": "test/js/ObjectAssert.js",

94619

"line": 69,

94620

"description": "Asserts that a property with the given name exists on an object's prototype.",

94621

"params": [

94622

{

94623

"name": "propertyName",

94624

"description": "The name of the property to test.",

94625

"type": "String"

94626

},

94627

{

94628

"name": "object",

94629

"description": "The object to search.",

94630

"type": "Object"

94631

},

94632

{

94633

"name": "message",

94634

"description": "(Optional) The message to display if the assertion fails.",

94635

"type": "String"

94636

}

94637

],

94638

"itemtype": "method",

94639

"name": "inheritsKey",

94640

"static": 1,

94641

"class": "Test.ObjectAssert",

94642

"module": "test",

94643

"namespace": "Test"

94644

},

94645

{

94646

"file": "test/js/ObjectAssert.js",

94647

"line": 84,

94648

"description": "Asserts that all properties exist on an object prototype.",

94649

"params": [

94650

{

94651

"name": "properties",

94652

"description": "An array of property names that should be on the object.",

94653

"type": "Array"

94654

},

94655

{

94656

"name": "object",

94657

"description": "The object to search.",

94658

"type": "Object"

94659

},

94660

{

94661

"name": "message",

94662

"description": "(Optional) The message to display if the assertion fails.",

94663

"type": "String"

94664

}

94665

],

94666

"itemtype": "method",

94667

"name": "inheritsKeys",

94668

"static": 1,

94669

"class": "Test.ObjectAssert",

94670

"module": "test",

94671

"namespace": "Test"

94672

},

94673

{

94674

"file": "test/js/ObjectAssert.js",

94675

"line": 101,

94676

"description": "Asserts that a property with the given name exists on an object instance (not on its prototype).",

94677

"params": [

94678

{

94679

"name": "propertyName",

94680

"description": "The name of the property to test.",

94681

"type": "String"

94682

},

94683

{

94684

"name": "object",

94685

"description": "The object to search.",

94686

"type": "Object"

94687

},

94688

{

94689

"name": "message",

94690

"description": "(Optional) The message to display if the assertion fails.",

94691

"type": "String"

94692

}

94693

],

94694

"itemtype": "method",

94695

"name": "ownsKey",

94696

"static": 1,

94697

"class": "Test.ObjectAssert",

94698

"module": "test",

94699

"namespace": "Test"

94700

},

94701

{

94702

"file": "test/js/ObjectAssert.js",

94703

"line": 116,

94704

"description": "Asserts that all properties exist on an object instance (not on its prototype).",

94705

"params": [

94706

{

94707

"name": "properties",

94708

"description": "An array of property names that should be on the object.",

94709

"type": "Array"

94710

},

94711

{

94712

"name": "object",

94713

"description": "The object to search.",

94714

"type": "Object"

94715

},

94716

{

94717

"name": "message",

94718

"description": "(Optional) The message to display if the assertion fails.",

94719

"type": "String"

94720

}

94721

],

94722

"itemtype": "method",

94723

"name": "ownsKeys",

94724

"static": 1,

94725

"class": "Test.ObjectAssert",

94726

"module": "test",

94727

"namespace": "Test"

94728

},

94729

{

94730

"file": "test/js/ObjectAssert.js",

94731

"line": 133,

94732

"description": "Asserts that an object owns no properties.",

94733

"params": [

94734

{

94735

"name": "object",

94736

"description": "The object to check.",

94737

"type": "Object"

94738

},

94739

{

94740

"name": "message",

94741

"description": "(Optional) The message to display if the assertion fails.",

94742

"type": "String"

94743

}

94744

],

94745

"itemtype": "method",

94746

"name": "ownsNoKeys",

94747

"static": 1,

94748

"class": "Test.ObjectAssert",

94749

"module": "test",

94750

"namespace": "Test"

94751

},

94752

{

94753

"file": "test/js/ObjectAssert.js",

94754

"line": 156,

94755

"description": "Asserts that an object has a property with the given name.",

94756

"params": [

94757

{

94758

"name": "propertyName",

94759

"description": "The name of the property to test.",

94760

"type": "String"

94761

},

94762

{

94763

"name": "object",

94764

"description": "The object to search.",

94765

"type": "Object"

94766

},

94767

{

94768

"name": "message",

94769

"description": "(Optional) The message to display if the assertion fails.",

94770

"type": "String"

94771

}

94772

],

94773

"itemtype": "method",

94774

"name": "ownsOrInheritsKey",

94775

"static": 1,

94776

"class": "Test.ObjectAssert",

94777

"module": "test",

94778

"namespace": "Test"

94779

},

94780

{

94781

"file": "test/js/ObjectAssert.js",

94782

"line": 171,

94783

"description": "Asserts that an object has all properties of a reference object.",

94784

"params": [

94785

{

94786

"name": "properties",

94787

"description": "An array of property names that should be on the object.",

94788

"type": "Array"

94789

},

94790

{

94791

"name": "object",

94792

"description": "The object to search.",

94793

"type": "Object"

94794

},

94795

{

94796

"name": "message",

94797

"description": "(Optional) The message to display if the assertion fails.",

94798

"type": "String"

94799

}

94800

],

94801

"itemtype": "method",

94802

"name": "ownsOrInheritsKeys",

94803

"static": 1,

94804

"class": "Test.ObjectAssert",

94805

"module": "test",

94806

"namespace": "Test"

94807

},

94808

{

94809

"file": "test/js/Reporter.js",

94810

"line": 14,

94811

"description": "The URL to submit the data to.",

94812

"type": "String",

94813

"itemtype": "property",

94814

"name": "url",

94815

"class": "Test.Reporter",

94816

"module": "test",

94817

"namespace": "Test"

94818

},

94819

{

94820

"file": "test/js/Reporter.js",

94821

"line": 21,

94822

"description": "The formatting function to call when submitting the data.",

94823

"type": "Function",

94824

"itemtype": "property",

94825

"name": "format",

94826

"class": "Test.Reporter",

94827

"module": "test",

94828

"namespace": "Test"

94829

},

94830

{

94831

"file": "test/js/Reporter.js",

94832

"line": 28,

94833

"description": "Extra fields to submit with the request.",

94834

"type": "Object",

94835

"itemtype": "property",

94836

"name": "_fields",

94837

"access": "private",

94838

"tagname": "",

94839

"class": "Test.Reporter",

94840

"module": "test",

94841

"namespace": "Test"

94842

},

94843

{

94844

"file": "test/js/Reporter.js",

94845

"line": 36,

94846

"description": "The form element used to submit the results.",

94847

"type": "HTMLFormElement",

94848

"itemtype": "property",

94849

"name": "_form",

94850

"access": "private",

94851

"tagname": "",

94852

"class": "Test.Reporter",

94853

"module": "test",

94854

"namespace": "Test"

94855

},

94856

{

94857

"file": "test/js/Reporter.js",

94858

"line": 44,

94859

"description": "Iframe used as a target for form submission.",

94860

"type": "HTMLIFrameElement",

94861

"itemtype": "property",

94862

"name": "_iframe",

94863

"access": "private",

94864

"tagname": "",

94865

"class": "Test.Reporter",

94866

"module": "test",

94867

"namespace": "Test"

94868

},

94869

{

94870

"file": "test/js/Reporter.js",

94871

"line": 58,

94872

"description": "Adds a field to the form that submits the results.",

94873

"params": [

94874

{

94875

"name": "name",

94876

"description": "The name of the field.",

94877

"type": "String"

94878

},

94879

{

94880

"name": "value",

94881

"description": "The value of the field.",

94882

"type": "Variant"

94883

}

94884

],

94885

"return": {

94886

"description": "",

94887

"type": "Void"

94888

},

94889

"itemtype": "method",

94890

"name": "addField",

94891

"class": "Test.Reporter",

94892

"module": "test",

94893

"namespace": "Test"

94894

},

94895

{

94896

"file": "test/js/Reporter.js",

94897

"line": 69,

94898

"description": "Removes all previous defined fields.",

94899

"return": {

94900

"description": "",

94901

"type": "Void"

94902

},

94903

"itemtype": "method",

94904

"name": "clearFields",

94905

"class": "Test.Reporter",

94906

"module": "test",

94907

"namespace": "Test"

94908

},

94909

{

94910

"file": "test/js/Reporter.js",

94911

"line": 78,

94912

"description": "Cleans up the memory associated with the TestReporter, removing DOM elements\nthat were created.",

94913

"return": {

94914

"description": "",

94915

"type": "Void"

94916

},

94917

"itemtype": "method",

94918

"name": "destroy",

94919

"class": "Test.Reporter",

94920

"module": "test",

94921

"namespace": "Test"

94922

},

94923

{

94924

"file": "test/js/Reporter.js",

94925

"line": 96,

94926

"description": "Sends the report to the server.",

94927

"params": [

94928

{

94929

"name": "results",

94930

"description": "The results object created by TestRunner.",

94931

"type": "Object"

94932

}

94933

],

94934

"return": {

94935

"description": "",

94936

"type": "Void"

94937

},

94938

"itemtype": "method",

94939

"name": "report",

94940

"class": "Test.Reporter",

94941

"module": "test",

94942

"namespace": "Test"

94943

},

94944

{

94945

"file": "test/js/Results.js",

94946

"line": 13,

94947

"description": "Name of the test, test case, or test suite.",

94948

"type": "String",

94949

"itemtype": "property",

94950

"name": "name",

94951

"class": "Test.Results",

94952

"module": "test",

94953

"namespace": "Test"

94954

},

94955

{

94956

"file": "test/js/Results.js",

94957

"line": 20,

94958

"description": "Number of passed tests.",

94959

"type": "int",

94960

"itemtype": "property",

94961

"name": "passed",

94962

"class": "Test.Results",

94963

"module": "test",

94964

"namespace": "Test"

94965

},

94966

{

94967

"file": "test/js/Results.js",

94968

"line": 27,

94969

"description": "Number of failed tests.",

94970

"type": "int",

94971

"itemtype": "property",

94972

"name": "failed",

94973

"class": "Test.Results",

94974

"module": "test",

94975

"namespace": "Test"

94976

},

94977

{

94978

"file": "test/js/Results.js",

94979

"line": 34,

94980

"description": "Number of errors that occur in non-test methods.",

94981

"type": "int",

94982

"itemtype": "property",

94983

"name": "errors",

94984

"class": "Test.Results",

94985

"module": "test",

94986

"namespace": "Test"

94987

},

94988

{

94989

"file": "test/js/Results.js",

94990

"line": 41,

94991

"description": "Number of ignored tests.",

94992

"type": "int",

94993

"itemtype": "property",

94994

"name": "ignored",

94995

"class": "Test.Results",

94996

"module": "test",

94997

"namespace": "Test"

94998

},

94999

{

95000

"file": "test/js/Results.js",

95001

"line": 48,

95002

"description": "Number of total tests.",

95003

"type": "int",

95004

"itemtype": "property",

95005

"name": "total",

95006

"class": "Test.Results",

95007

"module": "test",

95008

"namespace": "Test"

95009

},

95010

{

95011

"file": "test/js/Results.js",

95012

"line": 55,

95013

"description": "Amount of time (ms) it took to complete testing.",

95014

"type": "int",

95015

"itemtype": "property",

95016

"name": "duration",

95017

"class": "Test.Results",

95018

"module": "test",

95019

"namespace": "Test"

95020

},

95021

{

95022

"file": "test/js/Results.js",

95023

"line": 63,

95024

"description": "Includes results from another results object into this one.",

95025

"params": [

95026

{

95027

"name": "result",

95028

"description": "The results object to include.",

95029

"type": "Test.Results"

95030

}

95031

],

95032

"itemtype": "method",

95033

"name": "include",

95034

"return": {

95035

"description": "",

95036

"type": "Void"

95037

},

95038

"class": "Test.Results",

95039

"module": "test",

95040

"namespace": "Test"

95041

},

95042

{

95043

"file": "test/js/ShouldError.js",

95044

"line": 17,

95045

"description": "The name of the error that occurred.",

95046

"type": "String",

95047

"itemtype": "property",

95048

"name": "name",

95049

"class": "Test.ShouldError",

95050

"module": "test",

95051

"namespace": "Test"

95052

},

95053

{

95054

"file": "test/js/ShouldFail.js",

95055

"line": 17,

95056

"description": "The name of the error that occurred.",

95057

"type": "String",

95058

"itemtype": "property",

95059

"name": "name",

95060

"class": "Test.ShouldFail",

95061

"module": "test",

95062

"namespace": "Test"

95063

},

95064

{

95065

"file": "test/js/TestCase.js",

95066

"line": 36,

95067

"description": "Method to call from an async init method to\nrestart the test case. When called, returns a function\nthat should be called when tests are ready to continue.",

95068

"itemtype": "method",

95069

"name": "callback",

95070

"return": {

95071

"description": "The function to call as a callback.",

95072

"type": "Function"

95073

},

95074

"class": "Test.TestCase",

95075

"module": "test",

95076

"namespace": "Test"

95077

},

95078

{

95079

"file": "test/js/TestCase.js",

95080

"line": 47,

95081

"description": "Resumes a paused test and runs the given function.",

95082

"params": [

95083

{

95084

"name": "segment",

95085

"description": "(Optional) The function to run.\n If omitted, the test automatically passes.",

95086

"type": "Function"

95087

}

95088

],

95089

"return": {

95090

"description": "",

95091

"type": "Void"

95092

},

95093

"itemtype": "method",

95094

"name": "resume",

95095

"class": "Test.TestCase",

95096

"module": "test",

95097

"namespace": "Test"

95098

},

95099

{

95100

"file": "test/js/TestCase.js",

95101

"line": 58,

95102

"description": "Causes the test case to wait a specified amount of time and then\ncontinue executing the given code.",

95103

"params": [

95104

{

95105

"name": "segment",

95106

"description": "(Optional) The function to run after the delay.\n If omitted, the TestRunner will wait until resume() is called.",

95107

"type": "Function"

95108

},

95109

{

95110

"name": "delay",

95111

"description": "(Optional) The number of milliseconds to wait before running\n the function. If omitted, defaults to zero.",

95112

"type": "Int"

95113

}

95114

],

95115

"return": {

95116

"description": "",

95117

"type": "Void"

95118

},

95119

"itemtype": "method",

95120

"name": "wait",

95121

"class": "Test.TestCase",

95122

"module": "test",

95123

"namespace": "Test"

95124

},

95125

{

95126

"file": "test/js/TestCase.js",

95127

"line": 86,

95128

"description": "Asserts that a given condition is true. If not, then a YUITest.AssertionError object is thrown\nand the test fails.",

95129

"itemtype": "method",

95130

"name": "assert",

95131

"params": [

95132

{

95133

"name": "condition",

95134

"description": "The condition to test.",

95135

"type": "Boolean"

95136

},

95137

{

95138

"name": "message",

95139

"description": "The message to display if the assertion fails.",

95140

"type": "String"

95141

}

95142

],

95143

"class": "Test.TestCase",

95144

"module": "test",

95145

"namespace": "Test"

95146

},

95147

{

95148

"file": "test/js/TestCase.js",

95149

"line": 100,

95150

"description": "Forces an assertion error to occur. Shortcut for YUITest.Assert.fail().",

95151

"itemtype": "method",

95152

"name": "fail",

95153

"params": [

95154

{

95155

"name": "message",

95156

"description": "(Optional) The message to display with the failure.",

95157

"type": "String"

95158

}

95159

],

95160

"class": "Test.TestCase",

95161

"module": "test",

95162

"namespace": "Test"

95163

},

95164

{

95165

"file": "test/js/TestCase.js",

95166

"line": 113,

95167

"description": "Function to run once before tests start to run.\nThis executes before the first call to setUp().",

95168

"itemtype": "method",

95169

"name": "init",

95170

"class": "Test.TestCase",

95171

"module": "test",

95172

"namespace": "Test"

95173

},

95174

{

95175

"file": "test/js/TestCase.js",

95176

"line": 122,

95177

"description": "Function to run once after tests finish running.\nThis executes after the last call to tearDown().",

95178

"itemtype": "method",

95179

"name": "destroy",

95180

"class": "Test.TestCase",

95181

"module": "test",

95182

"namespace": "Test"

95183

},

95184

{

95185

"file": "test/js/TestCase.js",

95186

"line": 131,

95187

"description": "Function to run before each test is executed.",

95188

"return": {

95189

"description": "",

95190

"type": "Void"

95191

},

95192

"itemtype": "method",

95193

"name": "setUp",

95194

"class": "Test.TestCase",

95195

"module": "test",

95196

"namespace": "Test"

95197

},

95198

{

95199

"file": "test/js/TestCase.js",

95200

"line": 140,

95201

"description": "Function to run after each test is executed.",

95202

"return": {

95203

"description": "",

95204

"type": "Void"

95205

},

95206

"itemtype": "method",

95207

"name": "tearDown",

95208

"class": "Test.TestCase",

95209

"module": "test",

95210

"namespace": "Test"

95211

},

95212

{

95213

"file": "test/js/TestFormat.js",

95214

"line": 33,

95215

"description": "Returns test results formatted as a JSON string. Requires JSON utility.",

95216

"params": [

95217

{

95218

"name": "result",

95219

"description": "The results object created by TestRunner.",

95220

"type": "Object"

95221

}

95222

],

95223

"return": {

95224

"description": "A JSON-formatted string of results.",

95225

"type": "String"

95226

},

95227

"itemtype": "method",

95228

"name": "JSON",

95229

"static": 1,

95230

"class": "Test.TestFormat",

95231

"module": "test",

95232

"namespace": "Test"

95233

},

95234

{

95235

"file": "test/js/TestFormat.js",

95236

"line": 44,

95237

"description": "Returns test results formatted as an XML string.",

95238

"params": [

95239

{

95240

"name": "result",

95241

"description": "The results object created by TestRunner.",

95242

"type": "Object"

95243

}

95244

],

95245

"return": {

95246

"description": "An XML-formatted string of results.",

95247

"type": "String"

95248

},

95249

"itemtype": "method",

95250

"name": "XML",

95251

"static": 1,

95252

"class": "Test.TestFormat",

95253

"module": "test",

95254

"namespace": "Test"

95255

},

95256

{

95257

"file": "test/js/TestFormat.js",

95258

"line": 83,

95259

"description": "Returns test results formatted in JUnit XML format.",

95260

"params": [

95261

{

95262

"name": "result",

95263

"description": "The results object created by TestRunner.",

95264

"type": "Object"

95265

}

95266

],

95267

"return": {

95268

"description": "An XML-formatted string of results.",

95269

"type": "String"

95270

},

95271

"itemtype": "method",

95272

"name": "JUnitXML",

95273

"static": 1,

95274

"class": "Test.TestFormat",

95275

"module": "test",

95276

"namespace": "Test"

95277

},

95278

{

95279

"file": "test/js/TestFormat.js",

95280

"line": 159,

95281

"description": "Returns test results formatted in TAP format.\nFor more information, see <a href=\"http://testanything.org/\">Test Anything Protocol</a>.",

95282

"params": [

95283

{

95284

"name": "result",

95285

"description": "The results object created by TestRunner.",

95286

"type": "Object"

95287

}

95288

],

95289

"return": {

95290

"description": "A TAP-formatted string of results.",

95291

"type": "String"

95292

},

95293

"itemtype": "method",

95294

"name": "TAP",

95295

"static": 1,

95296

"class": "Test.TestFormat",

95297

"module": "test",

95298

"namespace": "Test"

95299

},

95300

{

95301

"file": "test/js/TestRunner.js",

95302

"line": 45,

95303

"description": "The TestSuite, TestCase, or test function represented by this node.",

95304

"type": "Variant",

95305

"itemtype": "property",

95306

"name": "testObject",

95307

"class": "TestNode",

95308

"module": "test"

95309

},

95310

{

95311

"file": "test/js/TestRunner.js",

95312

"line": 52,

95313

"description": "Pointer to this node's first child.",

95314

"type": "TestNode",

95315

"itemtype": "property",

95316

"name": "firstChild",

95317

"class": "TestNode",

95318

"module": "test"

95319

},

95320

{

95321

"file": "test/js/TestRunner.js",

95322

"line": 59,

95323

"description": "Pointer to this node's last child.",

95324

"type": "TestNode",

95325

"itemtype": "property",

95326

"name": "lastChild",

95327

"class": "TestNode",

95328

"module": "test"

95329

},

95330

{

95331

"file": "test/js/TestRunner.js",

95332

"line": 66,

95333

"description": "Pointer to this node's parent.",

95334

"type": "TestNode",

95335

"itemtype": "property",

95336

"name": "parent",

95337

"class": "TestNode",

95338

"module": "test"

95339

},

95340

{

95341

"file": "test/js/TestRunner.js",

95342

"line": 73,

95343

"description": "Pointer to this node's next sibling.",

95344

"type": "TestNode",

95345

"itemtype": "property",

95346

"name": "next",

95347

"class": "TestNode",

95348

"module": "test"

95349

},

95350

{

95351

"file": "test/js/TestRunner.js",

95352

"line": 80,

95353

"description": "Test results for this test object.",

95354

"type": "object",

95355

"itemtype": "property",

95356

"name": "results",

95357

"class": "TestNode",

95358

"module": "test"

95359

},

95360

{

95361

"file": "test/js/TestRunner.js",

95362

"line": 100,

95363

"description": "Appends a new test object (TestSuite, TestCase, or test function name) as a child\nof this node.",

95364

"params": [

95365

{

95366

"name": "testObject",

95367

"description": "A TestSuite, TestCase, or the name of a test function.",

95368

"type": "Variant"

95369

}

95370

],

95371

"return": {

95372

"description": "",

95373

"type": "Void"

95374

},

95375

"itemtype": "method",

95376

"name": "appendChild",

95377

"class": "TestNode",

95378

"module": "test"

95379

},

95380

{

95381

"file": "test/js/TestRunner.js",

95382

"line": 133,

95383

"description": "Suite on which to attach all TestSuites and TestCases to be run.",

95384

"type": "YUITest.TestSuite",

95385

"itemtype": "property",

95386

"name": "masterSuite",

95387

"static": 1,

95388

"access": "private",

95389

"tagname": "",

95390

"class": "Test.Runner",

95391

"module": "test",

95392

"namespace": "Test"

95393

},

95394

{

95395

"file": "test/js/TestRunner.js",

95396

"line": 142,

95397

"description": "Pointer to the current node in the test tree.",

95398

"type": "TestNode",

95399

"access": "private",

95400

"tagname": "",

95401

"itemtype": "property",

95402

"name": "_cur",

95403

"static": 1,

95404

"class": "Test.Runner",

95405

"module": "test",

95406

"namespace": "Test"

95407

},

95408

{

95409

"file": "test/js/TestRunner.js",

95410

"line": 151,

95411

"description": "Pointer to the root node in the test tree.",

95412

"type": "TestNode",

95413

"access": "private",

95414

"tagname": "",

95415

"itemtype": "property",

95416

"name": "_root",

95417

"static": 1,

95418

"class": "Test.Runner",

95419

"module": "test",

95420

"namespace": "Test"

95421

},

95422

{

95423

"file": "test/js/TestRunner.js",

95424

"line": 160,

95425

"description": "Indicates if the TestRunner will log events or not.",

95426

"type": "Boolean",

95427

"itemtype": "property",

95428

"name": "_log",

95429

"access": "private",

95430

"tagname": "",

95431

"static": 1,

95432

"class": "Test.Runner",

95433

"module": "test",

95434

"namespace": "Test"

95435

},

95436

{

95437

"file": "test/js/TestRunner.js",

95438

"line": 169,

95439

"description": "Indicates if the TestRunner is waiting as a result of\nwait() being called.",

95440

"type": "Boolean",

95441

"itemtype": "property",

95442

"name": "_waiting",

95443

"access": "private",

95444

"tagname": "",

95445

"static": 1,

95446

"class": "Test.Runner",

95447

"module": "test",

95448

"namespace": "Test"

95449

},

95450

{

95451

"file": "test/js/TestRunner.js",

95452

"line": 179,

95453

"description": "Indicates if the TestRunner is currently running tests.",

95454

"type": "Boolean",

95455

"access": "private",

95456

"tagname": "",

95457

"itemtype": "property",

95458

"name": "_running",

95459

"static": 1,

95460

"class": "Test.Runner",

95461

"module": "test",

95462

"namespace": "Test"

95463

},

95464

{

95465

"file": "test/js/TestRunner.js",

95466

"line": 188,

95467

"description": "Holds copy of the results object generated when all tests are\ncomplete.",

95468

"type": "Object",

95469

"access": "private",

95470

"tagname": "",

95471

"itemtype": "property",

95472

"name": "_lastResults",

95473

"static": 1,

95474

"class": "Test.Runner",

95475

"module": "test",

95476

"namespace": "Test"

95477

},

95478

{

95479

"file": "test/js/TestRunner.js",

95480

"line": 198,

95481

"description": "Data object that is passed around from method to method.",

95482

"type": "Object",

95483

"access": "private",

95484

"tagname": "",

95485

"itemtype": "property",

95486

"name": "_data",

95487

"static": 1,

95488

"class": "Test.Runner",

95489

"module": "test",

95490

"namespace": "Test"

95491

},

95492

{

95493

"file": "test/js/TestRunner.js",

95494

"line": 207,

95495

"description": "The list of test groups to run. The list is represented\nby a comma delimited string with commas at the start and\nend.",

95496

"type": "String",

95497

"access": "private",

95498

"tagname": "",

95499

"itemtype": "property",

95500

"name": "_groups",

95501

"static": 1,

95502

"class": "Test.Runner",

95503

"module": "test",

95504

"namespace": "Test"

95505

},

95506

{

95507

"file": "test/js/TestRunner.js",

95508

"line": 222,

95509

"description": "If true, YUITest will not fire an error for tests with no Asserts.",

95510

"itemtype": "property",

95511

"name": "_ignoreEmpty",

95512

"access": "private",

95513

"tagname": "",

95514

"type": "Boolean",

95515

"static": 1,

95516

"class": "Test.Runner",

95517

"module": "test",

95518

"namespace": "Test"

95519

},

95520

{

95521

"file": "test/js/TestRunner.js",

95522

"line": 238,

95523

"description": "Fires when a test case is opened but before the first \ntest is executed.",

95524

"itemtype": "event",

95525

"name": "testcasebegin",

95526

"static": 1,

95527

"class": "Test.Runner",

95528

"module": "test",

95529

"namespace": "Test"

95530

},

95531

{

95532

"file": "test/js/TestRunner.js",

95533

"line": 246,

95534

"description": "Fires when all tests in a test case have been executed.",

95535

"itemtype": "event",

95536

"name": "testcasecomplete",

95537

"static": 1,

95538

"class": "Test.Runner",

95539

"module": "test",

95540

"namespace": "Test"

95541

},

95542

{

95543

"file": "test/js/TestRunner.js",

95544

"line": 253,

95545

"description": "Fires when a test suite is opened but before the first \ntest is executed.",

95546

"itemtype": "event",

95547

"name": "testsuitebegin",

95548

"static": 1,

95549

"class": "Test.Runner",

95550

"module": "test",

95551

"namespace": "Test"

95552

},

95553

{

95554

"file": "test/js/TestRunner.js",

95555

"line": 261,

95556

"description": "Fires when all test cases in a test suite have been\ncompleted.",

95557

"itemtype": "event",

95558

"name": "testsuitecomplete",

95559

"static": 1,

95560

"class": "Test.Runner",

95561

"module": "test",

95562

"namespace": "Test"

95563

},

95564

{

95565

"file": "test/js/TestRunner.js",

95566

"line": 269,

95567

"description": "Fires when a test has passed.",

95568

"itemtype": "event",

95569

"name": "pass",

95570

"static": 1,

95571

"class": "Test.Runner",

95572

"module": "test",

95573

"namespace": "Test"

95574

},

95575

{

95576

"file": "test/js/TestRunner.js",

95577

"line": 276,

95578

"description": "Fires when a test has failed.",

95579

"itemtype": "event",

95580

"name": "fail",

95581

"static": 1,

95582

"class": "Test.Runner",

95583

"module": "test",

95584

"namespace": "Test"

95585

},

95586

{

95587

"file": "test/js/TestRunner.js",

95588

"line": 283,

95589

"description": "Fires when a non-test method has an error.",

95590

"itemtype": "event",

95591

"name": "error",

95592

"static": 1,

95593

"class": "Test.Runner",

95594

"module": "test",

95595

"namespace": "Test"

95596

},

95597

{

95598

"file": "test/js/TestRunner.js",

95599

"line": 290,

95600

"description": "Fires when a test has been ignored.",

95601

"itemtype": "event",

95602

"name": "ignore",

95603

"static": 1,

95604

"class": "Test.Runner",

95605

"module": "test",

95606

"namespace": "Test"

95607

},

95608

{

95609

"file": "test/js/TestRunner.js",

95610

"line": 297,

95611

"description": "Fires when all test suites and test cases have been completed.",

95612

"itemtype": "event",

95613

"name": "complete",

95614

"static": 1,

95615

"class": "Test.Runner",

95616

"module": "test",

95617

"namespace": "Test"

95618

},

95619

{

95620

"file": "test/js/TestRunner.js",

95621

"line": 304,

95622

"description": "Fires when the run() method is called.",

95623

"itemtype": "event",

95624

"name": "begin",

95625

"static": 1,

95626

"class": "Test.Runner",

95627

"module": "test",

95628

"namespace": "Test"

95629

},

95630

{

95631

"file": "test/js/TestRunner.js",

95632

"line": 315,

95633

"description": "Adds a test case to the test tree as a child of the specified node.",

95634

"params": [

95635

{

95636

"name": "parentNode",

95637

"description": "The node to add the test case to as a child.",

95638

"type": "TestNode"

95639

},

95640

{

95641

"name": "testCase",

95642

"description": "The test case to add.",

95643

"type": "Test.TestCase"

95644

}

95645

],

95646

"return": {

95647

"description": "",

95648

"type": "Void"

95649

},

95650

"static": 1,

95651

"access": "private",

95652

"tagname": "",

95653

"itemtype": "method",

95654

"name": "_addTestCaseToTestTree",

95655

"class": "Test.Runner",

95656

"module": "test",

95657

"namespace": "Test"

95658

},

95659

{

95660

"file": "test/js/TestRunner.js",

95661

"line": 340,

95662

"description": "Adds a test suite to the test tree as a child of the specified node.",

95663

"params": [

95664

{

95665

"name": "parentNode",

95666

"description": "The node to add the test suite to as a child.",

95667

"type": "TestNode"

95668

},

95669

{

95670

"name": "testSuite",

95671

"description": "The test suite to add.",

95672

"type": "Test.TestSuite"

95673

}

95674

],

95675

"return": {

95676

"description": "",

95677

"type": "Void"

95678

},

95679

"static": 1,

95680

"access": "private",

95681

"tagname": "",

95682

"itemtype": "method",

95683

"name": "_addTestSuiteToTestTree",

95684

"class": "Test.Runner",

95685

"module": "test",

95686

"namespace": "Test"

95687

},

95688

{

95689

"file": "test/js/TestRunner.js",

95690

"line": 364,

95691

"description": "Builds the test tree based on items in the master suite. The tree is a hierarchical\nrepresentation of the test suites, test cases, and test functions. The resulting tree\nis stored in _root and the pointer _cur is set to the root initially.",

95692

"return": {

95693

"description": "",

95694

"type": "Void"

95695

},

95696

"static": 1,

95697

"access": "private",

95698

"tagname": "",

95699

"itemtype": "method",

95700

"name": "_buildTestTree",

95701

"class": "Test.Runner",

95702

"module": "test",

95703

"namespace": "Test"

95704

},

95705

{

95706

"file": "test/js/TestRunner.js",

95707

"line": 393,

95708

"description": "Handles the completion of a test object's tests. Tallies test results \nfrom one level up to the next.",

95709

"params": [

95710

{

95711

"name": "node",

95712

"description": "The TestNode representing the test object.",

95713

"type": "TestNode"

95714

}

95715

],

95716

"return": {

95717

"description": "",

95718

"type": "Void"

95719

},

95720

"itemtype": "method",

95721

"name": "_handleTestObjectComplete",

95722

"access": "private",

95723

"tagname": "",

95724

"class": "Test.Runner",

95725

"module": "test",

95726

"namespace": "Test"

95727

},

95728

{

95729

"file": "test/js/TestRunner.js",

95730

"line": 428,

95731

"description": "Retrieves the next node in the test tree.",

95732

"return": {

95733

"description": "The next node in the test tree or null if the end is reached.",

95734

"type": "TestNode"

95735

},

95736

"access": "private",

95737

"tagname": "",

95738

"static": 1,

95739

"itemtype": "method",

95740

"name": "_next",

95741

"class": "Test.Runner",

95742

"module": "test",

95743

"namespace": "Test"

95744

},

95745

{

95746

"file": "test/js/TestRunner.js",

95747

"line": 467,

95748

"description": "Executes a non-test method (init, setUp, tearDown, destroy)\nand traps an errors. If an error occurs, an error event is\nfired.",

95749

"params": [

95750

{

95751

"name": "node",

95752

"description": "The test node in the testing tree.",

95753

"type": "Object"

95754

},

95755

{

95756

"name": "methodName",

95757

"description": "The name of the method to execute.",

95758

"type": "String"

95759

},

95760

{

95761

"name": "allowAsync",

95762

"description": "Determines if the method can be called asynchronously.",

95763

"type": "Boolean"

95764

}

95765

],

95766

"return": {

95767

"description": "True if an async method was called, false if not.",

95768

"type": "Boolean"

95769

},

95770

"itemtype": "method",

95771

"name": "_execNonTestMethod",

95772

"access": "private",

95773

"tagname": "",

95774

"class": "Test.Runner",

95775

"module": "test",

95776

"namespace": "Test"

95777

},

95778

{

95779

"file": "test/js/TestRunner.js",

95780

"line": 504,

95781

"description": "Runs a test case or test suite, returning the results.",

95782

"params": [

95783

{

95784

"name": "testObject",

95785

"description": "The test case or test suite to run.",

95786

"type": "Test.TestCase|YUITest.TestSuite"

95787

}

95788

],

95789

"return": {

95790

"description": "Results of the execution with properties passed, failed, and total.",

95791

"type": "Object"

95792

},

95793

"access": "private",

95794

"tagname": "",

95795

"itemtype": "method",

95796

"name": "_run",

95797

"static": 1,

95798

"class": "Test.Runner",

95799

"module": "test",

95800

"namespace": "Test"

95801

},

95802

{

95803

"file": "test/js/TestRunner.js",

95804

"line": 739,

95805

"description": "Handles an error as if it occurred within the currently executing\ntest. This is for mock methods that may be called asynchronously\nand therefore out of the scope of the TestRunner. Previously, this\nerror would bubble up to the browser. Now, this method is used\nto tell TestRunner about the error. This should never be called\nby anyplace other than the Mock object.",

95806

"params": [

95807

{

95808

"name": "error",

95809

"description": "The error object.",

95810

"type": "Error"

95811

}

95812

],

95813

"return": {

95814

"description": "",

95815

"type": "Void"

95816

},

95817

"itemtype": "method",

95818

"name": "_handleError",

95819

"access": "private",

95820

"tagname": "",

95821

"static": 1,

95822

"class": "Test.Runner",

95823

"module": "test",

95824

"namespace": "Test"

95825

},

95826

{

95827

"file": "test/js/TestRunner.js",

95828

"line": 764,

95829

"description": "Runs a single test based on the data provided in the node.",

95830

"itemtype": "method",

95831

"name": "_runTest",

95832

"params": [

95833

{

95834

"name": "node",

95835

"description": "The TestNode representing the test to run.",

95836

"type": "TestNode"

95837

}

95838

],

95839

"return": {

95840

"description": "",

95841

"type": "Void"

95842

},

95843

"static": 1,

95844

"access": "private",

95845

"tagname": "",

95846

"class": "Test.Runner",

95847

"module": "test",

95848

"namespace": "Test"

95849

},

95850

{

95851

"file": "test/js/TestRunner.js",

95852

"line": 827,

95853

"description": "Retrieves the name of the current result set.",

95854

"return": {

95855

"description": "The name of the result set.",

95856

"type": "String"

95857

},

95858

"itemtype": "method",

95859

"name": "getName",

95860

"class": "Test.Runner",

95861

"module": "test",

95862

"namespace": "Test"

95863

},

95864

{

95865

"file": "test/js/TestRunner.js",

95866

"line": 836,

95867

"description": "The name assigned to the master suite of the TestRunner. This is the name\nthat is output as the root's name when results are retrieved.",

95868

"params": [

95869

{

95870

"name": "name",

95871

"description": "The name of the result set.",

95872

"type": "String"

95873

}

95874

],

95875

"return": {

95876

"description": "",

95877

"type": "Void"

95878

},

95879

"itemtype": "method",

95880

"name": "setName",

95881

"class": "Test.Runner",

95882

"module": "test",

95883

"namespace": "Test"

95884

},

95885

{

95886

"file": "test/js/TestRunner.js",

95887

"line": 851,

95888

"description": "Adds a test suite or test case to the list of test objects to run.",

95889

"params": [

95890

{

95891

"name": "testObject",

95892

"description": "Either a TestCase or a TestSuite that should be run."

95893

}

95894

],

95895

"return": {

95896

"description": "",

95897

"type": "Void"

95898

},

95899

"itemtype": "method",

95900

"name": "add",

95901

"static": 1,

95902

"class": "Test.Runner",

95903

"module": "test",

95904

"namespace": "Test"

95905

},

95906

{

95907

"file": "test/js/TestRunner.js",

95908

"line": 863,

95909

"description": "Removes all test objects from the runner.",

95910

"return": {

95911

"description": "",

95912

"type": "Void"

95913

},

95914

"itemtype": "method",

95915

"name": "clear",

95916

"static": 1,

95917

"class": "Test.Runner",

95918

"module": "test",

95919

"namespace": "Test"

95920

},

95921

{

95922

"file": "test/js/TestRunner.js",

95923

"line": 873,

95924

"description": "Indicates if the TestRunner is waiting for a test to resume",

95925

"return": {

95926

"description": "True if the TestRunner is waiting, false if not.",

95927

"type": "Boolean"

95928

},

95929

"itemtype": "method",

95930

"name": "isWaiting",

95931

"static": 1,

95932

"class": "Test.Runner",

95933

"module": "test",

95934

"namespace": "Test"

95935

},

95936

{

95937

"file": "test/js/TestRunner.js",

95938

"line": 883,

95939

"description": "Indicates that the TestRunner is busy running tests and therefore can't\nbe stopped and results cannot be gathered.",

95940

"return": {

95941

"description": "True if the TestRunner is running, false if not.",

95942

"type": "Boolean"

95943

},

95944

"itemtype": "method",

95945

"name": "isRunning",

95946

"class": "Test.Runner",

95947

"module": "test",

95948

"namespace": "Test"

95949

},

95950

{

95951

"file": "test/js/TestRunner.js",

95952

"line": 893,

95953

"description": "Returns the last complete results set from the TestRunner. Null is returned\nif the TestRunner is running or no tests have been run.",

95954

"params": [

95955

{

95956

"name": "format",

95957

"description": "(Optional) A test format to return the results in.",

95958

"type": "Function"

95959

}

95960

],

95961

"return": {

95962

"description": "Either the results object or, if a test format is \n passed as the argument, a string representing the results in a specific\n format.",

95963

"type": "Object|String"

95964

},

95965

"itemtype": "method",

95966

"name": "getResults",

95967

"class": "Test.Runner",

95968

"module": "test",

95969

"namespace": "Test"

95970

},

95971

{

95972

"file": "test/js/TestRunner.js",

95973

"line": 914,

95974

"description": "Returns the coverage report for the files that have been executed.\nThis returns only coverage information for files that have been\ninstrumented using YUI Test Coverage and only those that were run\nin the same pass.",

95975

"params": [

95976

{

95977

"name": "format",

95978

"description": "(Optional) A coverage format to return results in.",

95979

"type": "Function"

95980

}

95981

],

95982

"return": {

95983

"description": "Either the coverage object or, if a coverage\n format is specified, a string representing the results in that format.",

95984

"type": "Object|String"

95985

},

95986

"itemtype": "method",

95987

"name": "getCoverage",

95988

"class": "Test.Runner",

95989

"module": "test",

95990

"namespace": "Test"

95991

},

95992

{

95993

"file": "test/js/TestRunner.js",

95994

"line": 936,

95995

"description": "Used to continue processing when a method marked with\n\"async:\" is executed. This should not be used in test\nmethods, only in init(). Each argument is a string, and\nwhen the returned function is executed, the arguments\nare assigned to the context data object using the string\nas the key name (value is the argument itself).",

95996

"access": "private",

95997

"tagname": "",

95998

"return": {

95999

"description": "A callback function.",

96000

"type": "Function"

96001

},

96002

"itemtype": "method",

96003

"name": "callback",

96004

"class": "Test.Runner",

96005

"module": "test",

96006

"namespace": "Test"

96007

},

96008

{

96009

"file": "test/js/TestRunner.js",

96010

"line": 960,

96011

"description": "Resumes the TestRunner after wait() was called.",

96012

"params": [

96013

{

96014

"name": "segment",

96015

"description": "The function to run as the rest\n of the haulted test.",

96016

"type": "Function"

96017

}

96018

],

96019

"return": {

96020

"description": "",

96021

"type": "Void"

96022

},

96023

"itemtype": "method",

96024

"name": "resume",

96025

"static": 1,

96026

"class": "Test.Runner",

96027

"module": "test",

96028

"namespace": "Test"

96029

},

96030

{

96031

"file": "test/js/TestRunner.js",

96032

"line": 976,

96033

"description": "Runs the test suite.",

96034

"params": [

96035

{

96036

"name": "options",

96037

"description": "(Optional) Options for the runner:\n <code>oldMode</code> indicates the TestRunner should work in the YUI <= 2.8 way\n of internally managing test suites. <code>groups</code> is an array\n of test groups indicating which tests to run.",

96038

"type": "Object|Boolean"

96039

}

96040

],

96041

"return": {

96042

"description": "",

96043

"type": "Void"

96044

},

96045

"itemtype": "method",

96046

"name": "run",

96047

"static": 1,

96048

"class": "Test.Runner",

96049

"module": "test",

96050

"namespace": "Test"

96051

},

96052

{

96053

"file": "test/js/TestSuite.js",

96054

"line": 14,

96055

"description": "The name of the test suite.",

96056

"type": "String",

96057

"itemtype": "property",

96058

"name": "name",

96059

"class": "Test.TestSuite",

96060

"module": "test",

96061

"namespace": "Test"

96062

},

96063

{

96064

"file": "test/js/TestSuite.js",

96065

"line": 21,

96066

"description": "Array of test suites and test cases.",

96067

"type": "Array",

96068

"itemtype": "property",

96069

"name": "items",

96070

"access": "private",

96071

"tagname": "",

96072

"class": "Test.TestSuite",

96073

"module": "test",

96074

"namespace": "Test"

96075

},

96076

{

96077

"file": "test/js/TestSuite.js",

96078

"line": 52,

96079

"description": "Adds a test suite or test case to the test suite.",

96080

"params": [

96081

{

96082

"name": "testObject",

96083

"description": "The test suite or test case to add.",

96084

"type": "Test.TestSuite||YUITest.TestCase"

96085

}

96086

],

96087

"return": {

96088

"description": "",

96089

"type": "Void"

96090

},

96091

"itemtype": "method",

96092

"name": "add",

96093

"class": "Test.TestSuite",

96094

"module": "test",

96095

"namespace": "Test"

96096

},

96097

{

96098

"file": "test/js/TestSuite.js",

96099

"line": 69,

96100

"description": "Function to run before each test is executed.",

96101

"return": {

96102

"description": "",

96103

"type": "Void"

96104

},

96105

"itemtype": "method",

96106

"name": "setUp",

96107

"class": "Test.TestSuite",

96108

"module": "test",

96109

"namespace": "Test"

96110

},

96111

{

96112

"file": "test/js/TestSuite.js",

96113

"line": 77,

96114

"description": "Function to run after each test is executed.",

96115

"return": {

96116

"description": "",

96117

"type": "Void"

96118

},

96119

"itemtype": "method",

96120

"name": "tearDown",

96121

"class": "Test.TestSuite",

96122

"module": "test",

96123

"namespace": "Test"

96124

},

96125

{

96126

"file": "test/js/UnexpectedError.js",

96127

"line": 19,

96128

"description": "The unexpected error that occurred.",

96129

"type": "Error",

96130

"itemtype": "property",

96131

"name": "cause",

96132

"class": "Test.UnexpectedError",

96133

"module": "test",

96134

"namespace": "Test"

96135

},

96136

{

96137

"file": "test/js/UnexpectedError.js",

96138

"line": 26,

96139

"description": "The name of the error that occurred.",

96140

"type": "String",

96141

"itemtype": "property",

96142

"name": "name",

96143

"class": "Test.UnexpectedError",

96144

"module": "test",

96145

"namespace": "Test"

96146

},

96147

{

96148

"file": "test/js/UnexpectedError.js",

96149

"line": 33,

96150

"description": "Stack information for the error (if provided).",

96151

"type": "String",

96152

"itemtype": "property",

96153

"name": "stack",

96154

"class": "Test.UnexpectedError",

96155

"module": "test",

96156

"namespace": "Test"

96157

},

96158

{

96159

"file": "test/js/UnexpectedValue.js",

96160

"line": 20,

96161

"description": "The unexpected value.",

96162

"type": "Object",

96163

"itemtype": "property",

96164

"name": "unexpected",

96165

"class": "Test.UnexpectedValue",

96166

"module": "test",

96167

"namespace": "Test"

96168

},

96169

{

96170

"file": "test/js/UnexpectedValue.js",

96171

"line": 27,

96172

"description": "The name of the error that occurred.",

96173

"type": "String",

96174

"itemtype": "property",

96175

"name": "name",

96176

"class": "Test.UnexpectedValue",

96177

"module": "test",

96178

"namespace": "Test"

96179

},

96180

{

96181

"file": "test/js/UnexpectedValue.js",

96182

"line": 42,

96183

"description": "Returns a fully formatted error for an assertion failure. This message\nprovides information about the expected and actual values.",

96184

"itemtype": "method",

96185

"name": "getMessage",

96186

"return": {

96187

"description": "A string describing the error.",

96188

"type": "String"

96189

},

96190

"class": "Test.UnexpectedValue",

96191

"module": "test",

96192

"namespace": "Test"

96193

},

96194

{

96195

"file": "test/js/Wait.js",

96196

"line": 15,

96197

"description": "The segment of code to run when the wait is over.",

96198

"type": "Function",

96199

"itemtype": "property",

96200

"name": "segment",

96201

"class": "Test.Wait",

96202

"module": "test",

96203

"namespace": "Test"

96204

},

96205

{

96206

"file": "test/js/Wait.js",

96207

"line": 22,

96208

"description": "The delay before running the segment of code.",

96209

"type": "int",

96210

"itemtype": "property",

96211

"name": "delay",

96212

"class": "Test.Wait",

96213

"module": "test",

96214

"namespace": "Test"

96215

},

96216

{

96217

"file": "test/js/YTestWrapAfter.js",

96218

"line": 27,

96219

"description": "Asserts that a given condition is true. If not, then a Y.Assert.Error object is thrown\nand the test fails.",

96220

"itemtype": "method",

96221

"name": "assert",

96222

"params": [

96223

{

96224

"name": "condition",

96225

"description": "The condition to test.",

96226

"type": "Boolean"

96227

},

96228

{

96229

"name": "message",

96230

"description": "The message to display if the assertion fails.",

96231

"type": "String"

96232

}

96233

],

96234

"static": 1,

96235

"class": "YUI",

96236

"module": "test"

96237

},

96238

{

96239

"file": "test/js/YTestWrapAfter.js",

96240

"line": 43,

96241

"description": "Forces an assertion error to occur. Shortcut for Y.Assert.fail().",

96242

"itemtype": "method",

96243

"name": "fail",

96244

"params": [

96245

{

96246

"name": "message",

96247

"description": "(Optional) The message to display with the failure.",

96248

"type": "String"

96249

}

96250

],

96251

"static": 1,

96252

"class": "YUI",

96253

"module": "test"

96254

},

96255

{

96256

"file": "text/js/text-accentfold.js",

96257

"line": 64,

96258

"description": "Returns <code>true</code> if the specified string contains one or more\ncharacters that can be folded, <code>false</code> otherwise.",

96259

"itemtype": "method",

96260

"name": "canFold",

96261

"params": [

96262

{

96263

"name": "string",

96264

"description": "String to test.",

96265

"type": "String"

96266

}

96267

],

96268

"return": {

96269

"description": "",

96270

"type": "Boolean"

96271

},

96272

"static": 1,

96273

"class": "Text.AccentFold",

96274

"module": "text",

96275

"submodule": "text-accentfold"

96276

},

96277

{

96278

"file": "text/js/text-accentfold.js",

96279

"line": 86,

96280

"description": "Compares the accent-folded versions of two strings and returns\n<code>true</code> if they're the same, <code>false</code> otherwise. If\na custom comparison function is supplied, the accent-folded strings will\nbe passed to that function for comparison.",

96281

"itemtype": "method",

96282

"name": "compare",

96283

"params": [

96284

{

96285

"name": "a",

96286

"description": "First string to compare.",

96287

"type": "String"

96288

},

96289

{

96290

"name": "b",

96291

"description": "Second string to compare.",

96292

"type": "String"

96293

},

96294

{

96295

"name": "func",

96296

"description": "(optional) Custom comparison function. Should\n return a truthy or falsy value.",

96297

"type": "Function"

96298

}

96299

],

96300

"return": {

96301

"description": "Results of the comparison.",

96302

"type": "Boolean"

96303

},

96304

"static": 1,

96305

"class": "Text.AccentFold",

96306

"module": "text",

96307

"submodule": "text-accentfold"

96308

},

96309

{

96310

"file": "text/js/text-accentfold.js",

96311

"line": 107,

96312

"description": "\nReturns a copy of haystack containing only the strings for which\nthe supplied function returns <code>true</code>.\n\n\n\nWhile comparisons will be made using accent-folded strings, the returned\narray of matches will contain the original strings that were passed in.\n",

96313

"itemtype": "method",

96314

"name": "filter",

96315

"params": [

96316

{

96317

"name": "haystack",

96318

"description": "Array of strings to filter.",

96319

"type": "Array"

96320

},

96321

{

96322

"name": "func",

96323

"description": "Comparison function. Will receive an accent-folded\n haystack string as an argument, and should return a truthy or falsy\n value.",

96324

"type": "Function"

96325

}

96326

],

96327

"return": {

96328

"description": "Filtered copy of haystack.",

96329

"type": "Array"

96330

},

96331

"static": 1,

96332

"class": "Text.AccentFold",

96333

"module": "text",

96334

"submodule": "text-accentfold"

96335

},

96336

{

96337

"file": "text/js/text-accentfold.js",

96338

"line": 132,

96339

"description": "Accent-folds the specified string or array of strings and returns a copy\nin which common accented letters have been converted to their closest\nnon-accented, lowercase forms.",

96340

"itemtype": "method",

96341

"name": "fold",

96342

"params": [

96343

{

96344

"name": "input",

96345

"description": "String or array of strings to be folded.",

96346

"type": "String|Array"

96347

}

96348

],

96349

"return": {

96350

"description": "Folded string or array of strings.",

96351

"type": "String|Array"

96352

},

96353

"static": 1,

96354

"class": "Text.AccentFold",

96355

"module": "text",

96356

"submodule": "text-accentfold"

96357

},

96358

{

96359

"file": "text/js/text-wordbreak.js",

96360

"line": 75,

96361

"description": "Splits the specified string into an array of individual words.",

96362

"itemtype": "method",

96363

"name": "getWords",

96364

"params": [

96365

{

96366

"name": "string",

96367

"description": "String to split.",

96368

"type": "String"

96369

},

96370

{

96371

"name": "options",

96372

"description": "(optional) Options object containing zero or more\n of the following properties:\n\n<dl>\n <dt>ignoreCase (Boolean)</dt>\n <dd>\n If <code>true</code>, the string will be converted to lowercase\n before being split. Default is <code>false</code>.\n </dd>\n\n <dt>includePunctuation (Boolean)</dt>\n <dd>\n If <code>true</code>, the returned array will include punctuation\n characters. Default is <code>false</code>.\n </dd>\n\n <dt>includeWhitespace (Boolean)</dt>\n <dd>\n If <code>true</code>, the returned array will include whitespace\n characters. Default is <code>false</code>.\n </dd>\n</dl>",

96373

"type": "Object"

96374

}

96375

],

96376

"return": {

96377

"description": "Array of words.",

96378

"type": "Array"

96379

},

96380

"static": 1,

96381

"class": "Text.WordBreak",

96382

"module": "text",

96383

"submodule": "text-wordbreak"

96384

},

96385

{

96386

"file": "text/js/text-wordbreak.js",

96387

"line": 154,

96388

"description": "Returns an array containing only unique words from the specified string.\nFor example, the string <code>'foo bar baz foo'</code> would result in\nthe array <code>['foo', 'bar', 'baz']</code>.",

96389

"itemtype": "method",

96390

"name": "getUniqueWords",

96391

"params": [

96392

{

96393

"name": "string",

96394

"description": "String to split.",

96395

"type": "String"

96396

},

96397

{

96398

"name": "options",

96399

"description": "(optional) Options (see <code>getWords()</code>\n for details).",

96400

"type": "Object"

96401

}

96402

],

96403

"return": {

96404

"description": "Array of unique words.",

96405

"type": "Array"

96406

},

96407

"static": 1,

96408

"class": "Text.WordBreak",

96409

"module": "text",

96410

"submodule": "text-wordbreak"

96411

},

96412

{

96413

"file": "text/js/text-wordbreak.js",

96414

"line": 170,

96415

"description": "\nReturns <code>true</code> if there is a word boundary between the\nspecified character index and the next character index (or the end of the\nstring).\n\n\n\nNote that there are always word breaks at the beginning and end of a\nstring, so <code>isWordBoundary('', 0)</code> and\n<code>isWordBoundary('a', 0)</code> will both return <code>true</code>.\n",

96416

"itemtype": "method",

96417

"name": "isWordBoundary",

96418

"params": [

96419

{

96420

"name": "string",

96421

"description": "String to test.",

96422

"type": "String"

96423

},

96424

{

96425

"name": "index",

96426

"description": "Character index to test within the string.",

96427

"type": "Number"

96428

}

96429

],

96430

"return": {

96431

"description": "<code>true</code> for a word boundary,\n <code>false</code> otherwise.",

96432

"type": "Boolean"

96433

},

96434

"static": 1,

96435

"class": "Text.WordBreak",

96436

"module": "text",

96437

"submodule": "text-wordbreak"

96438

},

96439

{

96440

"file": "text/js/text-wordbreak.js",

96441

"line": 196,

96442

"description": "Returns a character classification map for the specified string.",

96443

"itemtype": "method",

96444

"name": "_classify",

96445

"params": [

96446

{

96447

"name": "string",

96448

"description": "String to classify.",

96449

"type": "String"

96450

}

96451

],

96452

"return": {

96453

"description": "Classification map.",

96454

"type": "Array"

96455

},

96456

"access": "protected",

96457

"tagname": "",

96458

"static": 1,

96459

"class": "Text.WordBreak",

96460

"module": "text",

96461

"submodule": "text-wordbreak"

96462

},

96463

{

96464

"file": "text/js/text-wordbreak.js",

96465

"line": 234,

96466

"description": "\nReturns <code>true</code> if there is a word boundary between the\nspecified character index and the next character index (or the end of the\nstring).\n\n\n\nNote that there are always word breaks at the beginning and end of a\nstring, so <code>_isWordBoundary('', 0)</code> and\n<code>_isWordBoundary('a', 0)</code> will both return <code>true</code>.\n",

96467

"itemtype": "method",

96468

"name": "_isWordBoundary",

96469

"params": [

96470

{

96471

"name": "map",

96472

"description": "Character classification map generated by\n <code>_classify</code>.",

96473

"type": "Array"

96474

},

96475

{

96476

"name": "index",

96477

"description": "Character index to test.",

96478

"type": "Number"

96479

}

96480

],

96481

"return": {

96482

"description": "",

96483

"type": "Boolean"

96484

},

96485

"access": "protected",

96486

"tagname": "",

96487

"static": 1,

96488

"class": "Text.WordBreak",

96489

"module": "text",

96490

"submodule": "text-wordbreak"

96491

},

96492

{

96493

"file": "transition/js/transition-native.js",

96494

"line": 243,

96495

"description": "Starts or an animation.",

96496

"itemtype": "method",

96497

"name": "run",

96498

"chainable": 1,

96499

"access": "private",

96500

"tagname": "",

96501

"class": "Transition",

96502

"module": "transition"

96503

},

96504

{

96505

"file": "transition/js/transition-native.js",

96506

"line": 444,

96507

"description": "Animate one or more css properties to a given value. Requires the \"transition\" module.\n<pre>example usage:\n Y.one('#demo').transition({\n duration: 1, // in seconds, default is 0.5\n easing: 'ease-out', // default is 'ease'\n delay: '1', // delay start for 1 second, default is 0\n\n height: '10px',\n width: '10px',\n\n opacity: { // per property\n value: 0,\n duration: 2,\n delay: 2,\n easing: 'ease-in'\n }\n });\n</pre>",

96508

"itemtype": "method",

96509

"name": "transition",

96510

"params": [

96511

{

96512

"name": "config",

96513

"description": "An object containing one or more style properties, a duration and an easing.",

96514

"type": "Object"

96515

},

96516

{

96517

"name": "callback",

96518

"description": "A function to run after the transition has completed.",

96519

"type": "Function"

96520

}

96521

],

96522

"chainable": 1,

96523

"class": "Node",

96524

"module": "transition"

96525

},

96526

{

96527

"file": "transition/js/transition-native.js",

96528

"line": 563,

96529

"description": "Animate one or more css properties to a given value. Requires the \"transition\" module.\n<pre>example usage:\n Y.all('.demo').transition({\n duration: 1, // in seconds, default is 0.5\n easing: 'ease-out', // default is 'ease'\n delay: '1', // delay start for 1 second, default is 0\n\n height: '10px',\n width: '10px',\n\n opacity: { // per property\n value: 0,\n duration: 2,\n delay: 2,\n easing: 'ease-in'\n }\n });\n</pre>",

96530

"itemtype": "method",

96531

"name": "transition",

96532

"params": [

96533

{

96534

"name": "config",

96535

"description": "An object containing one or more style properties, a duration and an easing.",

96536

"type": "Object"

96537

},

96538

{

96539

"name": "callback",

96540

"description": "A function to run after the transition has completed. The callback fires\n once per item in the NodeList.",

96541

"type": "Function"

96542

}

96543

],

96544

"chainable": 1,

96545

"class": "NodeList",

96546

"module": "transition"

96547

},

96548

{

96549

"file": "uploader/js/uploader-flash.js",

96550

"line": 36,

96551

"description": "Stored value of the current button state (based on \nmouse events dispatched by the Flash player)",

96552

"itemtype": "property",

96553

"name": "_buttonState",

96554

"type": "{String}",

96555

"access": "protected",

96556

"tagname": "",

96557

"class": "UploaderFlash",

96558

"module": "uploader-flash"

96559

},

96560

{

96561

"file": "uploader/js/uploader-flash.js",

96562

"line": 45,

96563

"description": "Stored value of the current button focus state (based \non keyboard and mouse events).",

96564

"itemtype": "property",

96565

"name": "_buttonFocus",

96566

"type": "{Boolean}",

96567

"access": "protected",

96568

"tagname": "",

96569

"class": "UploaderFlash",

96570

"module": "uploader-flash"

96571

},

96572

{

96573

"file": "uploader/js/uploader-flash.js",

96574

"line": 54,

96575

"description": "Stored value of the unique id for the container that holds the \nFlash uploader.",

96576

"itemtype": "property",

96577

"name": "_swfContainerId",

96578

"type": "{String}",

96579

"access": "protected",

96580

"tagname": "",

96581

"class": "UploaderFlash",

96582

"module": "uploader-flash"

96583

},

96584

{

96585

"file": "uploader/js/uploader-flash.js",

96586

"line": 64,

96587

"description": "Stored reference to the instance of SWF used to host the\nFlash uploader.",

96588

"itemtype": "property",

96589

"name": "_swfReference",

96590

"type": "{SWF}",

96591

"access": "protected",

96592

"tagname": "",

96593

"class": "UploaderFlash",

96594

"module": "uploader-flash"

96595

},

96596

{

96597

"file": "uploader/js/uploader-flash.js",

96598

"line": 74,

96599

"description": "Stored reference to the instance of Uploader.Queue used to manage\nthe upload process. This is a read-only property that only exists\nduring an active upload process. Only one queue can be active at\na time; if an upload start is attempted while a queue is active,\nit will be ignored.",

96600

"itemtype": "property",

96601

"name": "queue",

96602

"type": "{Y.Uploader.Queue}",

96603

"class": "UploaderFlash",

96604

"module": "uploader-flash"

96605

},

96606

{

96607

"file": "uploader/js/uploader-flash.js",

96608

"line": 86,

96609

"description": "Stored event bindings for keyboard navigation to and from the uploader.",

96610

"itemtype": "property",

96611

"name": "_tabElementBindings",

96612

"type": "{Object}",

96613

"access": "protected",

96614

"tagname": "",

96615

"class": "UploaderFlash",

96616

"module": "uploader-flash"

96617

},

96618

{

96619

"file": "uploader/js/uploader-flash.js",

96620

"line": 96,

96621

"description": "Construction logic executed during UploaderFlash instantiation.",

96622

"itemtype": "method",

96623

"name": "initializer",

96624

"access": "protected",

96625

"tagname": "",

96626

"class": "UploaderFlash",

96627

"module": "uploader-flash"

96628

},

96629

{

96630

"file": "uploader/js/uploader-flash.js",

96631

"line": 114,

96632

"description": "Signals that files have been selected.",

96633

"itemtype": "event",

96634

"name": "fileselect",

96635

"params": [

96636

{

96637

"name": "event",

96638

"description": "The event object for the `fileselect` with the\n following payload:\n <dl>\n <dt>fileList</dt>\n <dd>An `Array` of files selected by the user, encapsulated\n in Y.FileFlash objects.</dd>\n </dl>",

96639

"type": "Event"

96640

}

96641

],

96642

"class": "UploaderFlash",

96643

"module": "uploader-flash"

96644

},

96645

{

96646

"file": "uploader/js/uploader-flash.js",

96647

"line": 128,

96648

"description": "Signals that an upload of multiple files has been started.",

96649

"itemtype": "event",

96650

"name": "uploadstart",

96651

"params": [

96652

{

96653

"name": "event",

96654

"description": "The event object for the `uploadstart`.",

96655

"type": "Event"

96656

}

96657

],

96658

"class": "UploaderFlash",

96659

"module": "uploader-flash"

96660

},

96661

{

96662

"file": "uploader/js/uploader-flash.js",

96663

"line": 136,

96664

"description": "Signals that an upload of a specific file has started.",

96665

"itemtype": "event",

96666

"name": "fileuploadstart",

96667

"params": [

96668

{

96669

"name": "event",

96670

"description": "The event object for the `fileuploadstart` with the\n following payload:\n <dl>\n <dt>file</dt>\n <dd>A reference to the Y.File that dispatched the event.</dd>\n <dt>originEvent</dt>\n <dd>The original event dispatched by Y.File.</dd>\n </dl>",

96671

"type": "Event"

96672

}

96673

],

96674

"class": "UploaderFlash",

96675

"module": "uploader-flash"

96676

},

96677

{

96678

"file": "uploader/js/uploader-flash.js",

96679

"line": 151,

96680

"description": "Reports on upload progress of a specific file.",

96681

"itemtype": "event",

96682

"name": "uploadprogress",

96683

"params": [

96684

{

96685

"name": "event",

96686

"description": "The event object for the `uploadprogress` with the\n following payload:\n <dl>\n <dt>bytesLoaded</dt>\n <dd>The number of bytes of the file that has been uploaded</dd>\n <dt>bytesTotal</dt>\n <dd>The total number of bytes in the file</dd>\n <dt>percentLoaded</dt>\n <dd>The fraction of the file that has been uploaded, out of 100</dd>\n <dt>originEvent</dt>\n <dd>The original event dispatched by the SWF uploader</dd>\n </dl>",

96687

"type": "Event"

96688

}

96689

],

96690

"class": "UploaderFlash",

96691

"module": "uploader-flash"

96692

},

96693

{

96694

"file": "uploader/js/uploader-flash.js",

96695

"line": 170,

96696

"description": "Reports on the total upload progress of the file list.",

96697

"itemtype": "event",

96698

"name": "totaluploadprogress",

96699

"params": [

96700

{

96701

"name": "event",

96702

"description": "The event object for the `totaluploadprogress` with the\n following payload:\n <dl>\n <dt>bytesLoaded</dt>\n <dd>The number of bytes of the file list that has been uploaded</dd>\n <dt>bytesTotal</dt>\n <dd>The total number of bytes in the file list</dd>\n <dt>percentLoaded</dt>\n <dd>The fraction of the file list that has been uploaded, out of 100</dd>\n </dl>",

96703

"type": "Event"

96704

}

96705

],

96706

"class": "UploaderFlash",

96707

"module": "uploader-flash"

96708

},

96709

{

96710

"file": "uploader/js/uploader-flash.js",

96711

"line": 187,

96712

"description": "Signals that a single file upload has been completed.",

96713

"itemtype": "event",

96714

"name": "uploadcomplete",

96715

"params": [

96716

{

96717

"name": "event",

96718

"description": "The event object for the `uploadcomplete` with the\n following payload:\n <dl>\n <dt>file</dt>\n <dd>The pointer to the instance of `Y.File` whose upload has been completed.</dd>\n <dt>originEvent</dt>\n <dd>The original event fired by the SWF Uploader</dd>\n <dt>data</dt>\n <dd>Data returned by the server.</dd>\n </dl>",

96719

"type": "Event"

96720

}

96721

],

96722

"class": "UploaderFlash",

96723

"module": "uploader-flash"

96724

},

96725

{

96726

"file": "uploader/js/uploader-flash.js",

96727

"line": 204,

96728

"description": "Signals that the upload process of the entire file list has been completed.",

96729

"itemtype": "event",

96730

"name": "alluploadscomplete",

96731

"params": [

96732

{

96733

"name": "event",

96734

"description": "The event object for the `alluploadscomplete`.",

96735

"type": "Event"

96736

}

96737

],

96738

"class": "UploaderFlash",

96739

"module": "uploader-flash"

96740

},

96741

{

96742

"file": "uploader/js/uploader-flash.js",

96743

"line": 212,

96744

"description": "Signals that a error has occurred in a specific file's upload process.",

96745

"itemtype": "event",

96746

"name": "uploaderror",

96747

"params": [

96748

{

96749

"name": "event",

96750

"description": "The event object for the `uploaderror` with the\n following payload:\n <dl>\n <dt>originEvent</dt>\n <dd>The original error event fired by the SWF Uploader. </dd>\n <dt>file</dt>\n <dd>The pointer at the instance of Y.FileFlash that returned the error.</dd>\n <dt>source</dt>\n <dd>The source of the upload error, either \"io\" or \"http\"</dd> \n <dt>message</dt>\n <dd>The message that accompanied the error. Corresponds to the text of\n the error in cases where source is \"io\", and to the HTTP status for\n cases where source is \"http\".</dd> \n </dl>",

96751

"type": "Event"

96752

}

96753

],

96754

"class": "UploaderFlash",

96755

"module": "uploader-flash"

96756

},

96757

{

96758

"file": "uploader/js/uploader-flash.js",

96759

"line": 233,

96760

"description": "Signals that a mouse has begun hovering over the `Select Files` button.",

96761

"itemtype": "event",

96762

"name": "mouseenter",

96763

"params": [

96764

{

96765

"name": "event",

96766

"description": "The event object for the `mouseenter` event.",

96767

"type": "Event"

96768

}

96769

],

96770

"class": "UploaderFlash",

96771

"module": "uploader-flash"

96772

},

96773

{

96774

"file": "uploader/js/uploader-flash.js",

96775

"line": 241,

96776

"description": "Signals that a mouse has stopped hovering over the `Select Files` button.",

96777

"itemtype": "event",

96778

"name": "mouseleave",

96779

"params": [

96780

{

96781

"name": "event",

96782

"description": "The event object for the `mouseleave` event.",

96783

"type": "Event"

96784

}

96785

],

96786

"class": "UploaderFlash",

96787

"module": "uploader-flash"

96788

},

96789

{

96790

"file": "uploader/js/uploader-flash.js",

96791

"line": 249,

96792

"description": "Signals that a mouse button has been pressed over the `Select Files` button.",

96793

"itemtype": "event",

96794

"name": "mousedown",

96795

"params": [

96796

{

96797

"name": "event",

96798

"description": "The event object for the `mousedown` event.",

96799

"type": "Event"

96800

}

96801

],

96802

"class": "UploaderFlash",

96803

"module": "uploader-flash"

96804

},

96805

{

96806

"file": "uploader/js/uploader-flash.js",

96807

"line": 257,

96808

"description": "Signals that a mouse button has been released over the `Select Files` button.",

96809

"itemtype": "event",

96810

"name": "mouseup",

96811

"params": [

96812

{

96813

"name": "event",

96814

"description": "The event object for the `mouseup` event.",

96815

"type": "Event"

96816

}

96817

],

96818

"class": "UploaderFlash",

96819

"module": "uploader-flash"

96820

},

96821

{

96822

"file": "uploader/js/uploader-flash.js",

96823

"line": 265,

96824

"description": "Signals that a mouse has been clicked over the `Select Files` button.",

96825

"itemtype": "event",

96826

"name": "click",

96827

"params": [

96828

{

96829

"name": "event",

96830

"description": "The event object for the `click` event.",

96831

"type": "Event"

96832

}

96833

],

96834

"class": "UploaderFlash",

96835

"module": "uploader-flash"

96836

},

96837

{

96838

"file": "uploader/js/uploader-flash.js",

96839

"line": 274,

96840

"description": "Creates the DOM structure for the UploaderFlash.\nUploaderFlash's DOM structure consists of two layers: the base \"Select Files\"\nbutton that can be replaced by the developer's widget of choice; and a transparent\nFlash overlay positoned above the button that captures all input events.\nThe `position` style attribute of the `boundingBox` of the `Uploader` widget\nis forced to be `relative`, in order to accommodate the Flash player overlay\n(which is `position`ed `absolute`ly).",

96841

"itemtype": "method",

96842

"name": "renderUI",

96843

"access": "protected",

96844

"tagname": "",

96845

"class": "UploaderFlash",

96846

"module": "uploader-flash"

96847

},

96848

{

96849

"file": "uploader/js/uploader-flash.js",

96850

"line": 307,

96851

"description": "Binds handlers to the UploaderFlash UI events and propagates attribute\nvalues to the Flash player.\nThe propagation of initial values is set to occur once the Flash player \ninstance is ready (as indicated by the `swfReady` event.)",

96852

"itemtype": "method",

96853

"name": "bindUI",

96854

"access": "protected",

96855

"tagname": "",

96856

"class": "UploaderFlash",

96857

"module": "uploader-flash"

96858

},

96859

{

96860

"file": "uploader/js/uploader-flash.js",

96861

"line": 366,

96862

"description": "Attaches keyboard bindings to enabling tabbing to and from the instance of the Flash\nplayer in the Uploader widget. If the previous and next elements are specified, the\nkeyboard bindings enable the user to tab from the `tabElements[\"from\"]` node to the \nFlash-powered \"Select Files\" button, and to the `tabElements[\"to\"]` node.",

96863

"itemtype": "method",

96864

"name": "_attachTabElements",

96865

"access": "protected",

96866

"tagname": "",

96867

"params": [

96868

{

96869

"name": "ev",

96870

"description": "Optional event payload if called as a `tabElementsChange` handler.",

96871

"type": "Event"

96872

}

96873

],

96874

"class": "UploaderFlash",

96875

"module": "uploader-flash"

96876

},

96877

{

96878

"file": "uploader/js/uploader-flash.js",

96879

"line": 430,

96880

"description": "Adds or removes a specified state CSS class to the underlying uploader button.",

96881

"itemtype": "method",

96882

"name": "_setButtonClass",

96883

"access": "protected",

96884

"tagname": "",

96885

"params": [

96886

{

96887

"name": "state",

96888

"description": "The name of the state enumerated in `buttonClassNames` attribute\nfrom which to derive the needed class name.",

96889

"type": "String"

96890

},

96891

{

96892

"name": "add",

96893

"description": "A Boolean indicating whether to add or remove the class.",

96894

"type": "Boolean"

96895

}

96896

],

96897

"class": "UploaderFlash",

96898

"module": "uploader-flash"

96899

},

96900

{

96901

"file": "uploader/js/uploader-flash.js",

96902

"line": 449,

96903

"description": "Syncs the state of the `fileFilters` attribute between the instance of UploaderFlash\nand the Flash player.",

96904

"itemtype": "method",

96905

"name": "_setFileFilters",

96906

"access": "private",

96907

"tagname": "",

96908

"class": "UploaderFlash",

96909

"module": "uploader-flash"

96910

},

96911

{

96912

"file": "uploader/js/uploader-flash.js",

96913

"line": 465,

96914

"description": "Syncs the state of the `multipleFiles` attribute between this class\nand the Flash uploader.",

96915

"itemtype": "method",

96916

"name": "_setMultipleFiles",

96917

"access": "private",

96918

"tagname": "",

96919

"class": "UploaderFlash",

96920

"module": "uploader-flash"

96921

},

96922

{

96923

"file": "uploader/js/uploader-flash.js",

96924

"line": 478,

96925

"description": "Syncs the state of the `enabled` attribute between this class\nand the Flash uploader.",

96926

"itemtype": "method",

96927

"name": "_triggerEnabled",

96928

"access": "private",

96929

"tagname": "",

96930

"class": "UploaderFlash",

96931

"module": "uploader-flash"

96932

},

96933

{

96934

"file": "uploader/js/uploader-flash.js",

96935

"line": 498,

96936

"description": "Adjusts the content of the `fileList` based on the results of file selection\nand the `appendNewFiles` attribute. If the `appendNewFiles` attribute is true,\nthen selected files are appended to the existing list; otherwise, the list is\ncleared and populated with the newly selected files.",

96937

"itemtype": "method",

96938

"name": "_updateFileList",

96939

"params": [

96940

{

96941

"name": "ev",

96942

"description": "The file selection event received from the uploader.",

96943

"type": "Event"

96944

}

96945

],

96946

"access": "private",

96947

"tagname": "",

96948

"class": "UploaderFlash",

96949

"module": "uploader-flash"

96950

},

96951

{

96952

"file": "uploader/js/uploader-flash.js",

96953

"line": 547,

96954

"description": "Handles and retransmits events fired by `Y.FileFlash` and `Y.Uploader.Queue`.",

96955

"itemtype": "method",

96956

"name": "_uploadEventHandler",

96957

"params": [

96958

{

96959

"name": "event",

96960

"description": "The event dispatched during the upload process."

96961

}

96962

],

96963

"access": "private",

96964

"tagname": "",

96965

"class": "UploaderFlash",

96966

"module": "uploader-flash"

96967

},

96968

{

96969

"file": "uploader/js/uploader-flash.js",

96970

"line": 581,

96971

"description": "Starts the upload of a specific file.",

96972

"itemtype": "method",

96973

"name": "upload",

96974

"params": [

96975

{

96976

"name": "file",

96977

"description": "Reference to the instance of the file to be uploaded.",

96978

"type": "Y.FileFlash"

96979

},

96980

{

96981

"name": "url",

96982

"description": "The URL to upload the file to.",

96983

"type": "String"

96984

},

96985

{

96986

"name": "postVars",

96987

"description": "(optional) A set of key-value pairs to send as variables along with the file upload HTTP request.\n If not specified, the values from the attribute `postVarsPerFile` are used instead.",

96988

"type": "Object"

96989

}

96990

],

96991

"class": "UploaderFlash",

96992

"module": "uploader-flash"

96993

},

96994

{

96995

"file": "uploader/js/uploader-flash.js",

96996

"line": 610,

96997

"description": "Starts the upload of all files on the file list, using an automated queue.",

96998

"itemtype": "method",

96999

"name": "uploadAll",

97000

"params": [

97001

{

97002

"name": "url",

97003

"description": "The URL to upload the files to.",

97004

"type": "String"

97005

},

97006

{

97007

"name": "postVars",

97008

"description": "(optional) A set of key-value pairs to send as variables along with the file upload HTTP request.\n If not specified, the values from the attribute `postVarsPerFile` are used instead.",

97009

"type": "Object"

97010

}

97011

],

97012

"class": "UploaderFlash",

97013

"module": "uploader-flash"

97014

},

97015

{

97016

"file": "uploader/js/uploader-flash.js",

97017

"line": 622,

97018

"description": "Starts the upload of the files specified in the first argument, using an automated queue.",

97019

"itemtype": "method",

97020

"name": "uploadThese",

97021

"params": [

97022

{

97023

"name": "files",

97024

"description": "The list of files to upload.",

97025

"type": "Array"

97026

},

97027

{

97028

"name": "url",

97029

"description": "The URL to upload the files to.",

97030

"type": "String"

97031

},

97032

{

97033

"name": "postVars",

97034

"description": "(optional) A set of key-value pairs to send as variables along with the file upload HTTP request.\n If not specified, the values from the attribute `postVarsPerFile` are used instead.",

97035

"type": "Object"

97036

}

97037

],

97038

"class": "UploaderFlash",

97039

"module": "uploader-flash"

97040

},

97041

{

97042

"file": "uploader/js/uploader-flash.js",

97043

"line": 658,

97044

"description": "The template for the Flash player container. Since the Flash player container needs\nto completely overlay the &lquot;Select Files&rqot; control, it's positioned absolutely,\nwith width and height set to 100% of the parent.",

97045

"itemtype": "property",

97046

"name": "FLASH_CONTAINER",

97047

"type": "{String}",

97048

"static": 1,

97049

"default": "\"<div id='{swfContainerId}' style='position:absolute; top:0px; left: 0px; margin: 0; padding: 0; border: 0; width:100%; height:100%'></div>\"",

97050

"class": "UploaderFlash",

97051

"module": "uploader-flash"

97052

},

97053

{

97054

"file": "uploader/js/uploader-flash.js",

97055

"line": 670,

97056

"description": "The template for the \"Select Files\" button.",

97057

"itemtype": "property",

97058

"name": "SELECT_FILES_BUTTON",

97059

"type": "{String}",

97060

"static": 1,

97061

"default": "\"<button type='button' class='yui3-button' tabindex='-1'>{selectButtonLabel}</button>\"",

97062

"class": "UploaderFlash",

97063

"module": "uploader-flash"

97064

},

97065

{

97066

"file": "uploader/js/uploader-flash.js",

97067

"line": 680,

97068

"description": "The static property reflecting the type of uploader that `Y.Uploader`\naliases. The UploaderFlash value is `\"flash\"`.",

97069

"itemtype": "property",

97070

"name": "TYPE",

97071

"type": "{String}",

97072

"static": 1,

97073

"class": "UploaderFlash",

97074

"module": "uploader-flash"

97075

},

97076

{

97077

"file": "uploader/js/uploader-flash.js",

97078

"line": 690,

97079

"description": "The identity of the widget.",

97080

"itemtype": "property",

97081

"name": "NAME",

97082

"type": "String",

97083

"default": "'uploader'",

97084

"readonly": "",

97085

"access": "protected",

97086

"tagname": "",

97087

"static": 1,

97088

"class": "UploaderFlash",

97089

"module": "uploader-flash"

97090

},

97091

{

97092

"file": "uploader/js/uploader-flash.js",

97093

"line": 702,

97094

"description": "Static property used to define the default attribute configuration of\nthe Widget.",

97095

"itemtype": "property",

97096

"name": "ATTRS",

97097

"type": "{Object}",

97098

"access": "protected",

97099

"tagname": "",

97100

"static": 1,

97101

"class": "UploaderFlash",

97102

"module": "uploader-flash"

97103

},

97104

{

97105

"file": "uploader/js/uploader-flash.js",

97106

"line": 713,

97107

"description": "A Boolean indicating whether newly selected files should be appended \nto the existing file list, or whether they should replace it.",

97108

"itemtype": "attribute",

97109

"name": "appendNewFiles",

97110

"type": "{Boolean}",

97111

"default": "true",

97112

"class": "UploaderFlash",

97113

"module": "uploader-flash"

97114

},

97115

{

97116

"file": "uploader/js/uploader-flash.js",

97117

"line": 725,

97118

"description": "The names of CSS classes that correspond to different button states\nof the \"Select Files\" control. These classes are assigned to the \n\"Select Files\" control based on the mouse states reported by the\nFlash player. The keys for the class names are:\n<ul>\n <li> `hover`: the class corresponding to mouse hovering over\n the \"Select Files\" button.</li>\n <li> `active`: the class corresponding to mouse down state of\n the \"Select Files\" button.</li>\n <li> `disabled`: the class corresponding to the disabled state\n of the \"Select Files\" button.</li>\n <li> `focus`: the class corresponding to the focused state of\n the \"Select Files\" button.</li>\n</ul>",

97119

"itemtype": "attribute",

97120

"name": "buttonClassNames",

97121

"type": "{Object}",

97122

"default": "{ hover: \"yui3-button-hover\",\n active: \"yui3-button-active\",\n disabled: \"yui3-button-disabled\",\n focus: \"yui3-button-selected\"\n }",

97123

"class": "UploaderFlash",

97124

"module": "uploader-flash"

97125

},

97126

{

97127

"file": "uploader/js/uploader-flash.js",

97128

"line": 757,

97129

"description": "A Boolean indicating whether the uploader is enabled or disabled for user input.",

97130

"itemtype": "attribute",

97131

"name": "enabled",

97132

"type": "{Boolean}",

97133

"default": "true",

97134

"class": "UploaderFlash",

97135

"module": "uploader-flash"

97136

},

97137

{

97138

"file": "uploader/js/uploader-flash.js",

97139

"line": 768,

97140

"description": "The action performed when an upload error occurs for a specific file being uploaded.\nThe possible values are: \n<ul>\n <li> `UploaderQueue.CONTINUE`: the error is ignored and the upload process is continued.</li>\n <li> `UploaderQueue.STOP`: the upload process is stopped as soon as any other parallel file\n uploads are finished.</li>\n <li> `UploaderQueue.RESTART_ASAP`: the file is added back to the front of the queue.</li>\n <li> `UploaderQueue.RESTART_AFTER`: the file is added to the back of the queue.</li>\n</ul>",

97141

"itemtype": "attribute",

97142

"name": "errorAction",

97143

"type": "{String}",

97144

"default": "UploaderQueue.CONTINUE",

97145

"class": "UploaderFlash",

97146

"module": "uploader-flash"

97147

},

97148

{

97149

"file": "uploader/js/uploader-flash.js",

97150

"line": 789,

97151

"description": "An array indicating what fileFilters should be applied to the file\nselection dialog. Each element in the array should be an object with\nthe following key-value pairs:\n{\n description : String \n extensions: String of the form &lquot;*.ext1;*.ext2;*.ext3;...&rquot;\n}",

97152

"itemtype": "attribute",

97153

"name": "fileFilters",

97154

"type": "{Array}",

97155

"default": "null",

97156

"class": "UploaderFlash",

97157

"module": "uploader-flash"

97158

},

97159

{

97160

"file": "uploader/js/uploader-flash.js",

97161

"line": 805,

97162

"description": "A String specifying what should be the POST field name for the file\ncontent in the upload request.",

97163

"itemtype": "attribute",

97164

"name": "fileFieldName",

97165

"type": "{String}",

97166

"default": "Filedata",

97167

"class": "UploaderFlash",

97168

"module": "uploader-flash"

97169

},

97170

{

97171

"file": "uploader/js/uploader-flash.js",

97172

"line": 817,

97173

"description": "The array of files to be uploaded. All elements in the array\nmust be instances of `Y.FileFlash` and be instantiated with a `fileId`\nretrieved from an instance of the uploader.",

97174

"itemtype": "attribute",

97175

"name": "fileList",

97176

"type": "{Array}",

97177

"default": "[]",

97178

"class": "UploaderFlash",

97179

"module": "uploader-flash"

97180

},

97181

{

97182

"file": "uploader/js/uploader-flash.js",

97183

"line": 830,

97184

"description": "A Boolean indicating whether multiple file selection is enabled.",

97185

"itemtype": "attribute",

97186

"name": "multipleFiles",

97187

"type": "{Boolean}",

97188

"default": "false",

97189

"class": "UploaderFlash",

97190

"module": "uploader-flash"

97191

},

97192

{

97193

"file": "uploader/js/uploader-flash.js",

97194

"line": 841,

97195

"description": "An object, keyed by `fileId`, containing sets of key-value pairs\nthat should be passed as POST variables along with each corresponding\nfile. This attribute is only used if no POST variables are specifed\nin the upload method call.",

97196

"itemtype": "attribute",

97197

"name": "postVarsPerFile",

97198

"type": "{Object}",

97199

"default": "{}",

97200

"class": "UploaderFlash",

97201

"module": "uploader-flash"

97202

},

97203

{

97204

"file": "uploader/js/uploader-flash.js",

97205

"line": 855,

97206

"description": "The label for the \"Select Files\" widget. This is the value that replaces the\n`{selectButtonLabel}` token in the `SELECT_FILES_BUTTON` template.",

97207

"itemtype": "attribute",

97208

"name": "selectButtonLabel",

97209

"type": "{String}",

97210

"default": "\"Select Files\"",

97211

"class": "UploaderFlash",

97212

"module": "uploader-flash"

97213

},

97214

{

97215

"file": "uploader/js/uploader-flash.js",

97216

"line": 867,

97217

"description": "The widget that serves as the \"Select Files\" control for the file uploader",

97218

"itemtype": "attribute",

97219

"name": "selectFilesButton",

97220

"type": "{Node | Widget}",

97221

"default": "A standard HTML button with YUI CSS Button skin.",

97222

"class": "UploaderFlash",

97223

"module": "uploader-flash"

97224

},

97225

{

97226

"file": "uploader/js/uploader-flash.js",

97227

"line": 881,

97228

"description": "The number of files that can be uploaded\nsimultaneously if the automatic queue management\nis used. This value can be in the range between 2\nand 5.",

97229

"itemtype": "attribute",

97230

"name": "simLimit",

97231

"type": "{Number}",

97232

"default": "2",

97233

"class": "UploaderFlash",

97234

"module": "uploader-flash"

97235

},

97236

{

97237

"file": "uploader/js/uploader-flash.js",

97238

"line": 898,

97239

"description": "The URL to the SWF file of the flash uploader. A copy local to\nthe server that hosts the page on which the uploader appears is\nrecommended.",

97240

"itemtype": "attribute",

97241

"name": "swfURL",

97242

"type": "{String}",

97243

"default": "\"CDN Prefix + uploader/assets/flashuploader.swf\" with a \nrandom GET parameter for IE (to prevent buggy behavior when the SWF \nis cached).",

97244

"class": "UploaderFlash",

97245

"module": "uploader-flash"

97246

},

97247

{

97248

"file": "uploader/js/uploader-flash.js",

97249

"line": 920,

97250

"description": "The id's or `Node` references of the DOM elements that precede\nand follow the `Select Files` button in the tab order. Specifying\nthese allows keyboard navigation to and from the Flash player\nlayer of the uploader.\nThe two keys corresponding to the DOM elements are:\n <ul>\n <li> `from`: the id or the `Node` reference corresponding to the\n DOM element that precedes the `Select Files` button in the tab order.</li>\n <li> `to`: the id or the `Node` reference corresponding to the\n DOM element that follows the `Select Files` button in the tab order.</li>\n</ul>",

97251

"itemtype": "attribute",

97252

"name": "tabElements",

97253

"type": "{Object}",

97254

"default": "null",

97255

"class": "UploaderFlash",

97256

"module": "uploader-flash"

97257

},

97258

{

97259

"file": "uploader/js/uploader-flash.js",

97260

"line": 940,

97261

"description": "The URL to which file upload requested are POSTed. Only used if a different url is not passed to the upload method call.",

97262

"itemtype": "attribute",

97263

"name": "uploadURL",

97264

"type": "{String}",

97265

"default": "\"\"",

97266

"class": "UploaderFlash",

97267

"module": "uploader-flash"

97268

},

97269

{

97270

"file": "uploader/js/uploader-html5.js",

97271

"line": 31,

97272

"description": "Stored reference to the instance of the file input field used to \ninitiate the file selection dialog.",

97273

"itemtype": "property",

97274

"name": "_fileInputField",

97275

"type": "{Node}",

97276

"access": "protected",

97277

"tagname": "",

97278

"class": "UploaderHTML5",

97279

"module": "uploader-html5"

97280

},

97281

{

97282

"file": "uploader/js/uploader-html5.js",

97283

"line": 41,

97284

"description": "Stored reference to the click event binding of the `Select Files`\nbutton.",

97285

"itemtype": "property",

97286

"name": "_buttonBinding",

97287

"type": "{EventHandle}",

97288

"access": "protected",

97289

"tagname": "",

97290

"class": "UploaderHTML5",

97291

"module": "uploader-html5"

97292

},

97293

{

97294

"file": "uploader/js/uploader-html5.js",

97295

"line": 51,

97296

"description": "Stored reference to the instance of Uploader.Queue used to manage\nthe upload process. This is a read-only property that only exists\nduring an active upload process. Only one queue can be active at\na time; if an upload start is attempted while a queue is active,\nit will be ignored.",

97297

"itemtype": "property",

97298

"name": "queue",

97299

"type": "{Y.Uploader.Queue}",

97300

"class": "UploaderHTML5",

97301

"module": "uploader-html5"

97302

},

97303

{

97304

"file": "uploader/js/uploader-html5.js",

97305

"line": 65,

97306

"description": "Construction logic executed during UploaderHTML5 instantiation.",

97307

"itemtype": "method",

97308

"name": "initializer",

97309

"access": "protected",

97310

"tagname": "",

97311

"class": "UploaderHTML5",

97312

"module": "uploader-html5"

97313

},

97314

{

97315

"file": "uploader/js/uploader-html5.js",

97316

"line": 78,

97317

"description": "Signals that files have been selected.",

97318

"itemtype": "event",

97319

"name": "fileselect",

97320

"params": [

97321

{

97322

"name": "event",

97323

"description": "The event object for the `fileselect` with the\n following payload:\n <dl>\n <dt>fileList</dt>\n <dd>An `Array` of files selected by the user, encapsulated\n in Y.FileHTML5 objects.</dd>\n </dl>",

97324

"type": "Event"

97325

}

97326

],

97327

"class": "UploaderHTML5",

97328

"module": "uploader-html5"

97329

},

97330

{

97331

"file": "uploader/js/uploader-html5.js",

97332

"line": 92,

97333

"description": "Signals that an upload of multiple files has been started.",

97334

"itemtype": "event",

97335

"name": "uploadstart",

97336

"params": [

97337

{

97338

"name": "event",

97339

"description": "The event object for the `uploadstart`.",

97340

"type": "Event"

97341

}

97342

],

97343

"class": "UploaderHTML5",

97344

"module": "uploader-html5"

97345

},

97346

{

97347

"file": "uploader/js/uploader-html5.js",

97348

"line": 100,

97349

"description": "Signals that an upload of a specific file has started.",

97350

"itemtype": "event",

97351

"name": "fileuploadstart",

97352

"params": [

97353

{

97354

"name": "event",

97355

"description": "The event object for the `fileuploadstart` with the\n following payload:\n <dl>\n <dt>file</dt>\n <dd>A reference to the Y.File that dispatched the event.</dd>\n <dt>originEvent</dt>\n <dd>The original event dispatched by Y.File.</dd>\n </dl>",

97356

"type": "Event"

97357

}

97358

],

97359

"class": "UploaderHTML5",

97360

"module": "uploader-html5"

97361

},

97362

{

97363

"file": "uploader/js/uploader-html5.js",

97364

"line": 115,

97365

"description": "Reports on upload progress of a specific file.",

97366

"itemtype": "event",

97367

"name": "uploadprogress",

97368

"params": [

97369

{

97370

"name": "event",

97371

"description": "The event object for the `uploadprogress` with the\n following payload:\n <dl>\n <dt>file</dt>\n <dd>The pointer to the instance of `Y.File` that dispatched the event.</dd>\n <dt>bytesLoaded</dt>\n <dd>The number of bytes of the file that has been uploaded</dd>\n <dt>bytesTotal</dt>\n <dd>The total number of bytes in the file</dd>\n <dt>percentLoaded</dt>\n <dd>The fraction of the file that has been uploaded, out of 100</dd>\n <dt>originEvent</dt>\n <dd>The original event dispatched by the HTML5 uploader</dd>\n </dl>",

97372

"type": "Event"

97373

}

97374

],

97375

"class": "UploaderHTML5",

97376

"module": "uploader-html5"

97377

},

97378

{

97379

"file": "uploader/js/uploader-html5.js",

97380

"line": 136,

97381

"description": "Reports on the total upload progress of the file list.",

97382

"itemtype": "event",

97383

"name": "totaluploadprogress",

97384

"params": [

97385

{

97386

"name": "event",

97387

"description": "The event object for the `totaluploadprogress` with the\n following payload:\n <dl>\n <dt>bytesLoaded</dt>\n <dd>The number of bytes of the file list that has been uploaded</dd>\n <dt>bytesTotal</dt>\n <dd>The total number of bytes in the file list</dd>\n <dt>percentLoaded</dt>\n <dd>The fraction of the file list that has been uploaded, out of 100</dd>\n </dl>",

97388

"type": "Event"

97389

}

97390

],

97391

"class": "UploaderHTML5",

97392

"module": "uploader-html5"

97393

},

97394

{

97395

"file": "uploader/js/uploader-html5.js",

97396

"line": 153,

97397

"description": "Signals that a single file upload has been completed.",

97398

"itemtype": "event",

97399

"name": "uploadcomplete",

97400

"params": [

97401

{

97402

"name": "event",

97403

"description": "The event object for the `uploadcomplete` with the\n following payload:\n <dl>\n <dt>file</dt>\n <dd>The pointer to the instance of `Y.File` whose upload has been completed.</dd>\n <dt>originEvent</dt>\n <dd>The original event fired by the SWF Uploader</dd>\n <dt>data</dt>\n <dd>Data returned by the server.</dd>\n </dl>",

97404

"type": "Event"

97405

}

97406

],

97407

"class": "UploaderHTML5",

97408

"module": "uploader-html5"

97409

},

97410

{

97411

"file": "uploader/js/uploader-html5.js",

97412

"line": 170,

97413

"description": "Signals that the upload process of the entire file list has been completed.",

97414

"itemtype": "event",

97415

"name": "alluploadscomplete",

97416

"params": [

97417

{

97418

"name": "event",

97419

"description": "The event object for the `alluploadscomplete`.",

97420

"type": "Event"

97421

}

97422

],

97423

"class": "UploaderHTML5",

97424

"module": "uploader-html5"

97425

},

97426

{

97427

"file": "uploader/js/uploader-html5.js",

97428

"line": 178,

97429

"description": "Signals that a error has occurred in a specific file's upload process.",

97430

"itemtype": "event",

97431

"name": "uploaderror",

97432

"params": [

97433

{

97434

"name": "event",

97435

"description": "The event object for the `uploaderror` with the\n following payload:\n <dl>\n <dt>originEvent</dt>\n <dd>The original error event fired by the HTML5 Uploader. </dd>\n <dt>file</dt>\n <dd>The pointer at the instance of Y.File that returned the error.</dd> \n <dt>status</dt>\n <dd>The status reported by the XMLHttpRequest object.</dd>\n <dt>statusText</dt>\n <dd>The statusText reported by the XMLHttpRequest object.</dd> \n </dl>",

97436

"type": "Event"

97437

}

97438

],

97439

"class": "UploaderHTML5",

97440

"module": "uploader-html5"

97441

},

97442

{

97443

"file": "uploader/js/uploader-html5.js",

97444

"line": 197,

97445

"description": "Signals that a dragged object has entered into the uploader's associated drag-and-drop area.",

97446

"itemtype": "event",

97447

"name": "dragenter",

97448

"params": [

97449

{

97450

"name": "event",

97451

"description": "The event object for the `dragenter`.",

97452

"type": "Event"

97453

}

97454

],

97455

"class": "UploaderHTML5",

97456

"module": "uploader-html5"

97457

},

97458

{

97459

"file": "uploader/js/uploader-html5.js",

97460

"line": 205,

97461

"description": "Signals that an object has been dragged over the uploader's associated drag-and-drop area.",

97462

"itemtype": "event",

97463

"name": "dragover",

97464

"params": [

97465

{

97466

"name": "event",

97467

"description": "The event object for the `dragover`.",

97468

"type": "Event"

97469

}

97470

],

97471

"class": "UploaderHTML5",

97472

"module": "uploader-html5"

97473

},

97474

{

97475

"file": "uploader/js/uploader-html5.js",

97476

"line": 213,

97477

"description": "Signals that an object has been dragged off of the uploader's associated drag-and-drop area.",

97478

"itemtype": "event",

97479

"name": "dragleave",

97480

"params": [

97481

{

97482

"name": "event",

97483

"description": "The event object for the `dragleave`.",

97484

"type": "Event"

97485

}

97486

],

97487

"class": "UploaderHTML5",

97488

"module": "uploader-html5"

97489

},

97490

{

97491

"file": "uploader/js/uploader-html5.js",

97492

"line": 221,

97493

"description": "Signals that an object has been dropped over the uploader's associated drag-and-drop area.",

97494

"itemtype": "event",

97495

"name": "drop",

97496

"params": [

97497

{

97498

"name": "event",

97499

"description": "The event object for the `drop`.",

97500

"type": "Event"

97501

}

97502

],

97503

"class": "UploaderHTML5",

97504

"module": "uploader-html5"

97505

},

97506

{

97507

"file": "uploader/js/uploader-html5.js",

97508

"line": 231,

97509

"description": "Create the DOM structure for the UploaderHTML5.\nUploaderHTML5's DOM structure consists of a \"Select Files\" button that can \nbe replaced by the developer's widget of choice; and a hidden file input field\nthat is used to instantiate the File Select dialog.",

97510

"itemtype": "method",

97511

"name": "renderUI",

97512

"access": "protected",

97513

"tagname": "",

97514

"class": "UploaderHTML5",

97515

"module": "uploader-html5"

97516

},

97517

{

97518

"file": "uploader/js/uploader-html5.js",

97519

"line": 251,

97520

"description": "Binds to the UploaderHTML5 UI and subscribes to the necessary events.",

97521

"itemtype": "method",

97522

"name": "bindUI",

97523

"access": "protected",

97524

"tagname": "",

97525

"class": "UploaderHTML5",

97526

"module": "uploader-html5"

97527

},

97528

{

97529

"file": "uploader/js/uploader-html5.js",

97530

"line": 275,

97531

"description": "Binds the specified drop area's drag and drop events to the\nuploader's custom handler.",

97532

"itemtype": "method",

97533

"name": "_bindDropArea",

97534

"access": "protected",

97535

"tagname": "",

97536

"class": "UploaderHTML5",

97537

"module": "uploader-html5"

97538

},

97539

{

97540

"file": "uploader/js/uploader-html5.js",

97541

"line": 302,

97542

"description": "Binds the instantiation of the file select dialog to the current file select\ncontrol.",

97543

"itemtype": "method",

97544

"name": "_bindSelectButton",

97545

"access": "protected",

97546

"tagname": "",

97547

"class": "UploaderHTML5",

97548

"module": "uploader-html5"

97549

},

97550

{

97551

"file": "uploader/js/uploader-html5.js",

97552

"line": 313,

97553

"description": "Handles the drag and drop events from the uploader's specified drop\narea.",

97554

"itemtype": "method",

97555

"name": "_ddEventHandler",

97556

"access": "protected",

97557

"tagname": "",

97558

"class": "UploaderHTML5",

97559

"module": "uploader-html5"

97560

},

97561

{

97562

"file": "uploader/js/uploader-html5.js",

97563

"line": 355,

97564

"description": "Adds or removes a specified state CSS class to the underlying uploader button.",

97565

"itemtype": "method",

97566

"name": "_setButtonClass",

97567

"access": "protected",

97568

"tagname": "",

97569

"params": [

97570

{

97571

"name": "state",

97572

"description": "The name of the state enumerated in `buttonClassNames` attribute\nfrom which to derive the needed class name.",

97573

"type": "String"

97574

},

97575

{

97576

"name": "add",

97577

"description": "A Boolean indicating whether to add or remove the class.",

97578

"type": "Boolean"

97579

}

97580

],

97581

"class": "UploaderHTML5",

97582

"module": "uploader-html5"

97583

},

97584

{

97585

"file": "uploader/js/uploader-html5.js",

97586

"line": 373,

97587

"description": "Syncs the state of the `multipleFiles` attribute between this class\nand the file input field.",

97588

"itemtype": "method",

97589

"name": "_setMultipleFiles",

97590

"access": "protected",

97591

"tagname": "",

97592

"class": "UploaderHTML5",

97593

"module": "uploader-html5"

97594

},

97595

{

97596

"file": "uploader/js/uploader-html5.js",

97597

"line": 389,

97598

"description": "Syncs the state of the `enabled` attribute between this class\nand the underlying button.",

97599

"itemtype": "method",

97600

"name": "_triggerEnabled",

97601

"access": "private",

97602

"tagname": "",

97603

"class": "UploaderHTML5",

97604

"module": "uploader-html5"

97605

},

97606

{

97607

"file": "uploader/js/uploader-html5.js",

97608

"line": 410,

97609

"description": "Adjusts the content of the `fileList` based on the results of file selection\nand the `appendNewFiles` attribute. If the `appendNewFiles` attribute is true,\nthen selected files are appended to the existing list; otherwise, the list is\ncleared and populated with the newly selected files.",

97610

"itemtype": "method",

97611

"name": "_updateFileList",

97612

"params": [

97613

{

97614

"name": "ev",

97615

"description": "The file selection event received from the uploader.",

97616

"type": "Event"

97617

}

97618

],

97619

"access": "protected",

97620

"tagname": "",

97621

"class": "UploaderHTML5",

97622

"module": "uploader-html5"

97623

},

97624

{

97625

"file": "uploader/js/uploader-html5.js",

97626

"line": 438,

97627

"description": "Handles and retransmits events fired by `Y.File` and `Y.Uploader.Queue`.",

97628

"itemtype": "method",

97629

"name": "_uploadEventHandler",

97630

"params": [

97631

{

97632

"name": "event",

97633

"description": "The event dispatched during the upload process."

97634

}

97635

],

97636

"access": "protected",

97637

"tagname": "",

97638

"class": "UploaderHTML5",

97639

"module": "uploader-html5"

97640

},

97641

{

97642

"file": "uploader/js/uploader-html5.js",

97643

"line": 471,

97644

"description": "Opens the File Selection dialog by simulating a click on the file input field.",

97645

"itemtype": "method",

97646

"name": "openFileSelectDialog",

97647

"class": "UploaderHTML5",

97648

"module": "uploader-html5"

97649

},

97650

{

97651

"file": "uploader/js/uploader-html5.js",

97652

"line": 483,

97653

"description": "Starts the upload of a specific file.",

97654

"itemtype": "method",

97655

"name": "upload",

97656

"params": [

97657

{

97658

"name": "file",

97659

"description": "Reference to the instance of the file to be uploaded.",

97660

"type": "Y.File"

97661

},

97662

{

97663

"name": "url",

97664

"description": "The URL to upload the file to.",

97665

"type": "String"

97666

},

97667

{

97668

"name": "postVars",

97669

"description": "(optional) A set of key-value pairs to send as variables along with the file upload HTTP request.\n If not specified, the values from the attribute `postVarsPerFile` are used instead.",

97670

"type": "Object"

97671

}

97672

],

97673

"class": "UploaderHTML5",

97674

"module": "uploader-html5"

97675

},

97676

{

97677

"file": "uploader/js/uploader-html5.js",

97678

"line": 511,

97679

"description": "Starts the upload of all files on the file list, using an automated queue.",

97680

"itemtype": "method",

97681

"name": "uploadAll",

97682

"params": [

97683

{

97684

"name": "url",

97685

"description": "The URL to upload the files to.",

97686

"type": "String"

97687

},

97688

{

97689

"name": "postVars",

97690

"description": "(optional) A set of key-value pairs to send as variables along with the file upload HTTP request.\n If not specified, the values from the attribute `postVarsPerFile` are used instead.",

97691

"type": "Object"

97692

}

97693

],

97694

"class": "UploaderHTML5",

97695

"module": "uploader-html5"

97696

},

97697

{

97698

"file": "uploader/js/uploader-html5.js",

97699

"line": 523,

97700

"description": "Starts the upload of the files specified in the first argument, using an automated queue.",

97701

"itemtype": "method",

97702

"name": "uploadThese",

97703

"params": [

97704

{

97705

"name": "files",

97706

"description": "The list of files to upload.",

97707

"type": "Array"

97708

},

97709

{

97710

"name": "url",

97711

"description": "The URL to upload the files to.",

97712

"type": "String"

97713

},

97714

{

97715

"name": "postVars",

97716

"description": "(optional) A set of key-value pairs to send as variables along with the file upload HTTP request.\n If not specified, the values from the attribute `postVarsPerFile` are used instead.",

97717

"type": "Object"

97718

}

97719

],

97720

"class": "UploaderHTML5",

97721

"module": "uploader-html5"

97722

},

97723

{

97724

"file": "uploader/js/uploader-html5.js",

97725

"line": 558,

97726

"description": "The template for the hidden file input field container. The file input field will only\naccept clicks if its visibility is set to hidden (and will not if it's `display` value\nis set to `none`)",

97727

"itemtype": "property",

97728

"name": "HTML5FILEFIELD_TEMPLATE",

97729

"type": "{String}",

97730

"static": 1,

97731

"class": "UploaderHTML5",

97732

"module": "uploader-html5"

97733

},

97734

{

97735

"file": "uploader/js/uploader-html5.js",

97736

"line": 569,

97737

"description": "The template for the \"Select Files\" button.",

97738

"itemtype": "property",

97739

"name": "SELECT_FILES_BUTTON",

97740

"type": "{String}",

97741

"static": 1,

97742

"default": "\"<button type='button' class='yui3-button' role='button' aria-label='{selectButtonLabel}' tabindex='{tabIndex}'>{selectButtonLabel}</button>\"",

97743

"class": "UploaderHTML5",

97744

"module": "uploader-html5"

97745

},

97746

{

97747

"file": "uploader/js/uploader-html5.js",

97748

"line": 579,

97749

"description": "The static property reflecting the type of uploader that `Y.Uploader`\naliases. The UploaderHTML5 value is `\"html5\"`.",

97750

"itemtype": "property",

97751

"name": "TYPE",

97752

"type": "{String}",

97753

"static": 1,

97754

"class": "UploaderHTML5",

97755

"module": "uploader-html5"

97756

},

97757

{

97758

"file": "uploader/js/uploader-html5.js",

97759

"line": 589,

97760

"description": "The identity of the widget.",

97761

"itemtype": "property",

97762

"name": "NAME",

97763

"type": "String",

97764

"default": "'uploader'",

97765

"readonly": "",

97766

"access": "protected",

97767

"tagname": "",

97768

"static": 1,

97769

"class": "UploaderHTML5",

97770

"module": "uploader-html5"

97771

},

97772

{

97773

"file": "uploader/js/uploader-html5.js",

97774

"line": 601,

97775

"description": "Static property used to define the default attribute configuration of\nthe Widget.",

97776

"itemtype": "property",

97777

"name": "ATTRS",

97778

"type": "{Object}",

97779

"access": "protected",

97780

"tagname": "",

97781

"static": 1,

97782

"class": "UploaderHTML5",

97783

"module": "uploader-html5"

97784

},

97785

{

97786

"file": "uploader/js/uploader-html5.js",

97787

"line": 612,

97788

"description": "A Boolean indicating whether newly selected files should be appended \nto the existing file list, or whether they should replace it.",

97789

"itemtype": "attribute",

97790

"name": "appendNewFiles",

97791

"type": "{Boolean}",

97792

"default": "true",

97793

"class": "UploaderHTML5",

97794

"module": "uploader-html5"

97795

},

97796

{

97797

"file": "uploader/js/uploader-html5.js",

97798

"line": 624,

97799

"description": "The names of CSS classes that correspond to different button states\nof the \"Select Files\" control. These classes are assigned to the \n\"Select Files\" control based on the configuration of the uploader.\nCurrently, the only class name used is that corresponding to the \n`disabled` state of the uploader. Other button states should be managed\ndirectly via CSS selectors.\n<ul>\n <li> `disabled`: the class corresponding to the disabled state\n of the \"Select Files\" button.</li>\n</ul>",

97800

"itemtype": "attribute",

97801

"name": "buttonClassNames",

97802

"type": "{Object}",

97803

"default": "{\n disabled: \"yui3-button-disabled\"\n }",

97804

"class": "UploaderHTML5",

97805

"module": "uploader-html5"

97806

},

97807

{

97808

"file": "uploader/js/uploader-html5.js",

97809

"line": 650,

97810

"description": "The node that serves as the drop target for files.",

97811

"itemtype": "attribute",

97812

"name": "dragAndDropArea",

97813

"type": "{Node}",

97814

"default": "null",

97815

"class": "UploaderHTML5",

97816

"module": "uploader-html5"

97817

},

97818

{

97819

"file": "uploader/js/uploader-html5.js",

97820

"line": 664,

97821

"description": "A Boolean indicating whether the uploader is enabled or disabled for user input.",

97822

"itemtype": "attribute",

97823

"name": "enabled",

97824

"type": "{Boolean}",

97825

"default": "true",

97826

"class": "UploaderHTML5",

97827

"module": "uploader-html5"

97828

},

97829

{

97830

"file": "uploader/js/uploader-html5.js",

97831

"line": 675,

97832

"description": "The action performed when an upload error occurs for a specific file being uploaded.\nThe possible values are: \n<ul>\n <li> `UploaderQueue.CONTINUE`: the error is ignored and the upload process is continued.</li>\n <li> `UploaderQueue.STOP`: the upload process is stopped as soon as any other parallel file\n uploads are finished.</li>\n <li> `UploaderQueue.RESTART_ASAP`: the file is added back to the front of the queue.</li>\n <li> `UploaderQueue.RESTART_AFTER`: the file is added to the back of the queue.</li>\n</ul>",

97833

"itemtype": "attribute",

97834

"name": "errorAction",

97835

"type": "{String}",

97836

"default": "UploaderQueue.CONTINUE",

97837

"class": "UploaderHTML5",

97838

"module": "uploader-html5"

97839

},

97840

{

97841

"file": "uploader/js/uploader-html5.js",

97842

"line": 695,

97843

"description": "A String specifying what should be the POST field name for the file\ncontent in the upload request.",

97844

"itemtype": "attribute",

97845

"name": "fileFieldName",

97846

"type": "{String}",

97847

"default": "Filedata",

97848

"class": "UploaderHTML5",

97849

"module": "uploader-html5"

97850

},

97851

{

97852

"file": "uploader/js/uploader-html5.js",

97853

"line": 707,

97854

"description": "The array of files to be uploaded. All elements in the array\nmust be instances of `Y.File` and be instantiated with an instance\nof native JavaScript File() class.",

97855

"itemtype": "attribute",

97856

"name": "fileList",

97857

"type": "{Array}",

97858

"default": "[]",

97859

"class": "UploaderHTML5",

97860

"module": "uploader-html5"

97861

},

97862

{

97863

"file": "uploader/js/uploader-html5.js",

97864

"line": 720,

97865

"description": "A Boolean indicating whether multiple file selection is enabled.",

97866

"itemtype": "attribute",

97867

"name": "multipleFiles",

97868

"type": "{Boolean}",

97869

"default": "false",

97870

"class": "UploaderHTML5",

97871

"module": "uploader-html5"

97872

},

97873

{

97874

"file": "uploader/js/uploader-html5.js",

97875

"line": 731,

97876

"description": "An object, keyed by `fileId`, containing sets of key-value pairs\nthat should be passed as POST variables along with each corresponding\nfile. This attribute is only used if no POST variables are specifed\nin the upload method call.",

97877

"itemtype": "attribute",

97878

"name": "postVarsPerFile",

97879

"type": "{Object}",

97880

"default": "{}",

97881

"class": "UploaderHTML5",

97882

"module": "uploader-html5"

97883

},

97884

{

97885

"file": "uploader/js/uploader-html5.js",

97886

"line": 745,

97887

"description": "The label for the \"Select Files\" widget. This is the value that replaces the\n`{selectButtonLabel}` token in the `SELECT_FILES_BUTTON` template.",

97888

"itemtype": "attribute",

97889

"name": "selectButtonLabel",

97890

"type": "{String}",

97891

"default": "\"Select Files\"",

97892

"class": "UploaderHTML5",

97893

"module": "uploader-html5"

97894

},

97895

{

97896

"file": "uploader/js/uploader-html5.js",

97897

"line": 757,

97898

"description": "The widget that serves as the \"Select Files control for the file uploader",

97899

"itemtype": "attribute",

97900

"name": "selectFilesButton",

97901

"type": "{Node | Widget}",

97902

"default": "A standard HTML button with YUI CSS Button skin.",

97903

"class": "UploaderHTML5",

97904

"module": "uploader-html5"

97905

},

97906

{

97907

"file": "uploader/js/uploader-html5.js",

97908

"line": 772,

97909

"description": "The number of files that can be uploaded\nsimultaneously if the automatic queue management\nis used. This value can be in the range between 2\nand 5.",

97910

"itemtype": "attribute",

97911

"name": "simLimit",

97912

"type": "{Number}",

97913

"default": "2",

97914

"class": "UploaderHTML5",

97915

"module": "uploader-html5"

97916

},

97917

{

97918

"file": "uploader/js/uploader-html5.js",

97919

"line": 789,

97920

"description": "The URL to which file upload requested are POSTed. Only used if a different url is not passed to the upload method call.",

97921

"itemtype": "attribute",

97922

"name": "uploadURL",

97923

"type": "{String}",

97924

"default": "\"\"",

97925

"class": "UploaderHTML5",

97926

"module": "uploader-html5"

97927

},

97928

{

97929

"file": "uploader/js/uploader-queue.js",

97930

"line": 40,

97931

"description": "Stored value of the current queue state",

97932

"itemtype": "property",

97933

"name": "_currentState",

97934

"type": "{String}",

97935

"access": "protected",

97936

"tagname": "",

97937

"default": "UploaderQueue.STOPPED",

97938

"class": "Uploader.Queue",

97939

"module": "uploader-queue"

97940

},

97941

{

97942

"file": "uploader/js/uploader-queue.js",

97943

"line": 49,

97944

"description": "Construction logic executed during UploaderQueue instantiation.",

97945

"itemtype": "method",

97946

"name": "initializer",

97947

"access": "protected",

97948

"tagname": "",

97949

"class": "Uploader.Queue",

97950

"module": "uploader-queue"

97951

},

97952

{

97953

"file": "uploader/js/uploader-queue.js",

97954

"line": 59,

97955

"description": "Handles and retransmits upload start event.",

97956

"itemtype": "method",

97957

"name": "_uploadStartHandler",

97958

"params": [

97959

{

97960

"name": "event",

97961

"description": "The event dispatched during the upload process."

97962

}

97963

],

97964

"access": "private",

97965

"tagname": "",

97966

"class": "Uploader.Queue",

97967

"module": "uploader-queue"

97968

},

97969

{

97970

"file": "uploader/js/uploader-queue.js",

97971

"line": 74,

97972

"description": "Handles and retransmits upload error event.",

97973

"itemtype": "method",

97974

"name": "_uploadErrorHandler",

97975

"params": [

97976

{

97977

"name": "event",

97978

"description": "The event dispatched during the upload process."

97979

}

97980

],

97981

"access": "private",

97982

"tagname": "",

97983

"class": "Uploader.Queue",

97984

"module": "uploader-queue"

97985

},

97986

{

97987

"file": "uploader/js/uploader-queue.js",

97988

"line": 108,

97989

"description": "Launches the upload of the next file in the queue.",

97990

"itemtype": "method",

97991

"name": "_startNextFile",

97992

"access": "private",

97993

"tagname": "",

97994

"class": "Uploader.Queue",

97995

"module": "uploader-queue"

97996

},

97997

{

97998

"file": "uploader/js/uploader-queue.js",

97999

"line": 134,

98000

"description": "Register a new upload process.",

98001

"itemtype": "method",

98002

"name": "_registerUpload",

98003

"access": "private",

98004

"tagname": "",

98005

"class": "Uploader.Queue",

98006

"module": "uploader-queue"

98007

},

98008

{

98009

"file": "uploader/js/uploader-queue.js",

98010

"line": 145,

98011

"description": "Unregisters a new upload process.",

98012

"itemtype": "method",

98013

"name": "_unregisterUpload",

98014

"access": "private",

98015

"tagname": "",

98016

"class": "Uploader.Queue",

98017

"module": "uploader-queue"

98018

},

98019

{

98020

"file": "uploader/js/uploader-queue.js",

98021

"line": 158,

98022

"description": "Handles and retransmits upload complete event.",

98023

"itemtype": "method",

98024

"name": "_uploadCompleteHandler",

98025

"params": [

98026

{

98027

"name": "event",

98028

"description": "The event dispatched during the upload process."

98029

}

98030

],

98031

"access": "private",

98032

"tagname": "",

98033

"class": "Uploader.Queue",

98034

"module": "uploader-queue"

98035

},

98036

{

98037

"file": "uploader/js/uploader-queue.js",

98038

"line": 203,

98039

"description": "Handles and retransmits upload progress event.",

98040

"itemtype": "method",

98041

"name": "_uploadProgressHandler",

98042

"params": [

98043

{

98044

"name": "event",

98045

"description": "The event dispatched during the upload process."

98046

}

98047

],

98048

"access": "private",

98049

"tagname": "",

98050

"class": "Uploader.Queue",

98051

"module": "uploader-queue"

98052

},

98053

{

98054

"file": "uploader/js/uploader-queue.js",

98055

"line": 233,

98056

"description": "Starts uploading the queued up file list.",

98057

"itemtype": "method",

98058

"name": "startUpload",

98059

"class": "Uploader.Queue",

98060

"module": "uploader-queue"

98061

},

98062

{

98063

"file": "uploader/js/uploader-queue.js",

98064

"line": 253,

98065

"description": "Pauses the upload process. The ongoing file uploads\nwill complete after this method is called, but no\nnew ones will be launched.",

98066

"itemtype": "method",

98067

"name": "pauseUpload",

98068

"class": "Uploader.Queue",

98069

"module": "uploader-queue"

98070

},

98071

{

98072

"file": "uploader/js/uploader-queue.js",

98073

"line": 264,

98074

"description": "Restarts a paused upload process.",

98075

"itemtype": "method",

98076

"name": "restartUpload",

98077

"class": "Uploader.Queue",

98078

"module": "uploader-queue"

98079

},

98080

{

98081

"file": "uploader/js/uploader-queue.js",

98082

"line": 276,

98083

"description": "If a particular file is stuck in an ongoing upload without\nany progress events, this method allows to force its reupload\nby cancelling its upload and immediately relaunching it.",

98084

"itemtype": "method",

98085

"name": "forceReupload",

98086

"params": [

98087

{

98088

"name": "file",

98089

"description": "The file to force reupload on.",

98090

"type": "Y.File"

98091

}

98092

],

98093

"class": "Uploader.Queue",

98094

"module": "uploader-queue"

98095

},

98096

{

98097

"file": "uploader/js/uploader-queue.js",

98098

"line": 294,

98099

"description": "Add a new file to the top of the queue (the upload will be\nlaunched as soon as the current number of uploading files\ndrops below the maximum permissible value).",

98100

"itemtype": "method",

98101

"name": "addToQueueTop",

98102

"params": [

98103

{

98104

"name": "file",

98105

"description": "The file to add to the top of the queue.",

98106

"type": "Y.File"

98107

}

98108

],

98109

"class": "Uploader.Queue",

98110

"module": "uploader-queue"

98111

},

98112

{

98113

"file": "uploader/js/uploader-queue.js",

98114

"line": 306,

98115

"description": "Add a new file to the bottom of the queue (the upload will be\nlaunched after all the other queued files are uploaded.)",

98116

"itemtype": "method",

98117

"name": "addToQueueBottom",

98118

"params": [

98119

{

98120

"name": "file",

98121

"description": "The file to add to the bottom of the queue.",

98122

"type": "Y.File"

98123

}

98124

],

98125

"class": "Uploader.Queue",

98126

"module": "uploader-queue"

98127

},

98128

{

98129

"file": "uploader/js/uploader-queue.js",

98130

"line": 317,

98131

"description": "Cancels a specific file's upload. If no argument is passed,\nall ongoing uploads are cancelled and the upload process is\nstopped.",

98132

"itemtype": "method",

98133

"name": "cancelUpload",

98134

"params": [

98135

{

98136

"name": "file",

98137

"description": "An optional parameter - the file whose upload\nshould be cancelled.",

98138

"type": "Y.File"

98139

}

98140

],

98141

"class": "Uploader.Queue",

98142

"module": "uploader-queue"

98143

},

98144

{

98145

"file": "uploader/js/uploader-queue.js",

98146

"line": 359,

98147

"description": "Static constant for the value of the `errorAction` attribute:\nprescribes the queue to continue uploading files in case of \nan error.",

98148

"itemtype": "property",

98149

"name": "CONTINUE",

98150

"readonly": "",

98151

"type": "{String}",

98152

"static": 1,

98153

"class": "Uploader.Queue",

98154

"module": "uploader-queue"

98155

},

98156

{

98157

"file": "uploader/js/uploader-queue.js",

98158

"line": 370,

98159

"description": "Static constant for the value of the `errorAction` attribute:\nprescribes the queue to stop uploading files in case of \nan error.",

98160

"itemtype": "property",

98161

"name": "STOP",

98162

"readonly": "",

98163

"type": "{String}",

98164

"static": 1,

98165

"class": "Uploader.Queue",

98166

"module": "uploader-queue"

98167

},

98168

{

98169

"file": "uploader/js/uploader-queue.js",

98170

"line": 381,

98171

"description": "Static constant for the value of the `errorAction` attribute:\nprescribes the queue to restart a file upload immediately in case of \nan error.",

98172

"itemtype": "property",

98173

"name": "RESTART_ASAP",

98174

"readonly": "",

98175

"type": "{String}",

98176

"static": 1,

98177

"class": "Uploader.Queue",

98178

"module": "uploader-queue"

98179

},

98180

{

98181

"file": "uploader/js/uploader-queue.js",

98182

"line": 392,

98183

"description": "Static constant for the value of the `errorAction` attribute:\nprescribes the queue to restart an errored out file upload after \nother files have finished uploading.",

98184

"itemtype": "property",

98185

"name": "RESTART_AFTER",

98186

"readonly": "",

98187

"type": "{String}",

98188

"static": 1,

98189

"class": "Uploader.Queue",

98190

"module": "uploader-queue"

98191

},

98192

{

98193

"file": "uploader/js/uploader-queue.js",

98194

"line": 403,

98195

"description": "Static constant for the value of the `_currentState` property:\nimplies that the queue is currently not uploading files.",

98196

"itemtype": "property",

98197

"name": "STOPPED",

98198

"readonly": "",

98199

"type": "{String}",

98200

"static": 1,

98201

"class": "Uploader.Queue",

98202

"module": "uploader-queue"

98203

},

98204

{

98205

"file": "uploader/js/uploader-queue.js",

98206

"line": 413,

98207

"description": "Static constant for the value of the `_currentState` property:\nimplies that the queue is currently uploading files.",

98208

"itemtype": "property",

98209

"name": "UPLOADING",

98210

"readonly": "",

98211

"type": "{String}",

98212

"static": 1,

98213

"class": "Uploader.Queue",

98214

"module": "uploader-queue"

98215

},

98216

{

98217

"file": "uploader/js/uploader-queue.js",

98218

"line": 423,

98219

"description": "The identity of the class.",

98220

"itemtype": "property",

98221

"name": "NAME",

98222

"type": "String",

98223

"default": "'uploaderqueue'",

98224

"readonly": "",

98225

"access": "protected",

98226

"tagname": "",

98227

"static": 1,

98228

"class": "Uploader.Queue",

98229

"module": "uploader-queue"

98230

},

98231

{

98232

"file": "uploader/js/uploader-queue.js",

98233

"line": 435,

98234

"description": "Static property used to define the default attribute configuration of\nthe class.",

98235

"itemtype": "property",

98236

"name": "ATTRS",

98237

"type": "{Object}",

98238

"access": "protected",

98239

"tagname": "",

98240

"static": 1,

98241

"class": "Uploader.Queue",

98242

"module": "uploader-queue"

98243

},

98244

{

98245

"file": "uploader/js/uploader-queue.js",

98246

"line": 446,

98247

"description": "Maximum number of simultaneous uploads; must be in the\nrange between 1 and 5. The value of `2` is default. It\nis recommended that this value does not exceed 3.",

98248

"itemtype": "property",

98249

"name": "simUploads",

98250

"type": "Number",

98251

"default": "2",

98252

"class": "Uploader.Queue",

98253

"module": "uploader-queue"

98254

},

98255

{

98256

"file": "uploader/js/uploader-queue.js",

98257

"line": 461,

98258

"description": "The action to take in case of error. The valid values for this attribute are: \n`Y.Uploader.Queue.CONTINUE` (the upload process should continue on other files, \nignoring the error), `Y.Uploader.Queue.STOP` (the upload process \nshould stop completely), `Y.Uploader.Queue.RESTART_ASAP` (the upload \nshould restart immediately on the errored out file and continue as planned), or\nY.Uploader.Queue.RESTART_AFTER (the upload of the errored out file should restart\nafter all other files have uploaded)",

98259

"itemtype": "property",

98260

"name": "errorAction",

98261

"type": "String",

98262

"default": "Y.Uploader.Queue.CONTINUE",

98263

"class": "Uploader.Queue",

98264

"module": "uploader-queue"

98265

},

98266

{

98267

"file": "uploader/js/uploader-queue.js",

98268

"line": 480,

98269

"description": "The total number of bytes that has been uploaded.",

98270

"itemtype": "property",

98271

"name": "bytesUploaded",

98272

"type": "Number",

98273

"class": "Uploader.Queue",

98274

"module": "uploader-queue"

98275

},

98276

{

98277

"file": "uploader/js/uploader-queue.js",

98278

"line": 490,

98279

"description": "The total number of bytes in the queue.",

98280

"itemtype": "property",

98281

"name": "bytesTotal",

98282

"type": "Number",

98283

"class": "Uploader.Queue",

98284

"module": "uploader-queue"

98285

},

98286

{

98287

"file": "uploader/js/uploader-queue.js",

98288

"line": 500,

98289

"description": "The queue file list. This file list should only be modified\nbefore the upload has been started; modifying it after starting\nthe upload has no effect, and `addToQueueTop` or `addToQueueBottom` methods\nshould be used instead.",

98290

"itemtype": "property",

98291

"name": "fileList",

98292

"type": "Number",

98293

"class": "Uploader.Queue",

98294

"module": "uploader-queue"

98295

},

98296

{

98297

"file": "uploader/js/uploader-queue.js",

98298

"line": 521,

98299

"description": "A String specifying what should be the POST field name for the file\ncontent in the upload request.",

98300

"itemtype": "attribute",

98301

"name": "fileFieldName",

98302

"type": "{String}",

98303

"default": "Filedata",

98304

"class": "Uploader.Queue",

98305

"module": "uploader-queue"

98306

},

98307

{

98308

"file": "uploader/js/uploader-queue.js",

98309

"line": 533,

98310

"description": "The URL to POST the file upload requests to.",

98311

"itemtype": "attribute",

98312

"name": "uploadURL",

98313

"type": "{String}",

98314

"default": "\"\"",

98315

"class": "Uploader.Queue",

98316

"module": "uploader-queue"

98317

},

98318

{

98319

"file": "uploader/js/uploader-queue.js",

98320

"line": 543,

98321

"description": "An object, keyed by `fileId`, containing sets of key-value pairs\nthat should be passed as POST variables along with each corresponding\nfile.",

98322

"itemtype": "attribute",

98323

"name": "perFileParameters",

98324

"type": "{Object}",

98325

"default": "{}",

98326

"class": "Uploader.Queue",

98327

"module": "uploader-queue"

98328

},

98329

{

98330

"file": "uploader/js/uploader.js",

98331

"line": 20,

98332

"description": "The static property reflecting the type of uploader that `Y.Uploader`\naliases. The possible values are:\n<ul>\n<li>`\"html5\"`: Y.Uploader is an alias for <a href=\"UploaderHTML5.html\">Y.UploaderHTML5</a></li>\n<li>`\"flash\"`: Y.Uploader is an alias for <a href=\"UploaderFlash.html\">Y.UploaderFlash</a></li>\n<li>`\"none\"`: Neither Flash not HTML5 are available, and Y.Uploader does\nnot reference an actual implementation.</li>\n</ul>",

98333

"itemtype": "property",

98334

"name": "TYPE",

98335

"type": "{String}",

98336

"static": 1,

98337

"class": "Uploader",

98338

"module": "uploader"

98339

},

98340

{

98341

"file": "widget-anim/js/WidgetAnim.js",

98342

"line": 40,

98343

"description": "The namespace for the plugin. This will be the property on the widget, which will \nreference the plugin instance, when it's plugged in.",

98344

"itemtype": "property",

98345

"name": "NS",

98346

"static": 1,

98347

"type": "String",

98348

"default": "\"anim\"",

98349

"class": "Plugin.WidgetAnim",

98350

"module": "widget-anim",

98351

"namespace": "Plugin"

98352

},

98353

{

98354

"file": "widget-anim/js/WidgetAnim.js",

98355

"line": 51,

98356

"description": "The NAME of the WidgetAnim class. Used to prefix events generated\nby the plugin class.",

98357

"itemtype": "property",

98358

"name": "NAME",

98359

"static": 1,

98360

"type": "String",

98361

"default": "\"pluginWidgetAnim\"",

98362

"class": "Plugin.WidgetAnim",

98363

"module": "widget-anim",

98364

"namespace": "Plugin"

98365

},

98366

{

98367

"file": "widget-anim/js/WidgetAnim.js",

98368

"line": 62,

98369

"description": "Pre-Packaged Animation implementations, which can be used for animShow and animHide attribute \nvalues.",

98370

"itemtype": "property",

98371

"name": "ANIMATIONS",

98372

"static": 1,

98373

"type": "Object",

98374

"default": "\"pluginWidgetAnim\"",

98375

"class": "Plugin.WidgetAnim",

98376

"module": "widget-anim",

98377

"namespace": "Plugin"

98378

},

98379

{

98380

"file": "widget-anim/js/WidgetAnim.js",

98381

"line": 107,

98382

"description": "Static property used to define the default attribute \nconfiguration for the plugin.",

98383

"itemtype": "property",

98384

"name": "ATTRS",

98385

"type": "Object",

98386

"static": 1,

98387

"class": "Plugin.WidgetAnim",

98388

"module": "widget-anim",

98389

"namespace": "Plugin"

98390

},

98391

{

98392

"file": "widget-anim/js/WidgetAnim.js",

98393

"line": 117,

98394

"description": "Default duration in seconds. Used as the default duration for the default animation implementations",

98395

"itemtype": "attribute",

98396

"name": "duration",

98397

"type": "Number",

98398

"default": "0.2 (seconds",

98399

"class": "Plugin.WidgetAnim",

98400

"module": "widget-anim",

98401

"namespace": "Plugin"

98402

},

98403

{

98404

"file": "widget-anim/js/WidgetAnim.js",

98405

"line": 128,

98406

"description": "Default animation instance used for showing the widget (opacity fade-in)",

98407

"itemtype": "attribute",

98408

"name": "animShow",

98409

"type": "Anim",

98410

"default": "WidgetAnim.ANIMATIONS.fadeIn",

98411

"class": "Plugin.WidgetAnim",

98412

"module": "widget-anim",

98413

"namespace": "Plugin"

98414

},

98415

{

98416

"file": "widget-anim/js/WidgetAnim.js",

98417

"line": 139,

98418

"description": "Default animation instance used for hiding the widget (opacity fade-out)",

98419

"itemtype": "attribute",

98420

"name": "animHide",

98421

"type": "Anim",

98422

"default": "WidgetAnim.ANIMATIONS.fadeOut",

98423

"class": "Plugin.WidgetAnim",

98424

"module": "widget-anim",

98425

"namespace": "Plugin"

98426

},

98427

{

98428

"file": "widget-anim/js/WidgetAnim.js",

98429

"line": 153,

98430

"description": "The initializer lifecycle implementation. Modifies the host widget's \nvisibililty implementation to add animation.",

98431

"itemtype": "method",

98432

"name": "initializer",

98433

"params": [

98434

{

98435

"name": "config",

98436

"description": "The user configuration for the plugin",

98437

"type": "Object"

98438

}

98439

],

98440

"class": "Plugin.WidgetAnim",

98441

"module": "widget-anim",

98442

"namespace": "Plugin"

98443

},

98444

{

98445

"file": "widget-anim/js/WidgetAnim.js",

98446

"line": 171,

98447

"description": "The initializer destructor implementation. Responsible for destroying the configured\nanimation instances.",

98448

"itemtype": "method",

98449

"name": "destructor",

98450

"class": "Plugin.WidgetAnim",

98451

"module": "widget-anim",

98452

"namespace": "Plugin"

98453

},

98454

{

98455

"file": "widget-anim/js/WidgetAnim.js",

98456

"line": 182,

98457

"description": "The injected method used to override the host widget's _uiSetVisible implementation with\nan animated version of the same.\n\nThis method replaces the default _uiSetVisible handler\nWidget provides, by injecting itself before _uiSetVisible,\nand preventing the default behavior. ",

98458

"itemtype": "method",

98459

"name": "_uiAnimSetVisible",

98460

"access": "protected",

98461

"tagname": "",

98462

"params": [

98463

{

98464

"name": "val",

98465

"description": "true, if making the widget visible. false, if hiding it.",

98466

"type": "Boolean"

98467

}

98468

],

98469

"class": "Plugin.WidgetAnim",

98470

"module": "widget-anim",

98471

"namespace": "Plugin"

98472

},

98473

{

98474

"file": "widget-anim/js/WidgetAnim.js",

98475

"line": 207,

98476

"description": "The original Widget _uiSetVisible implementation. This currently needs to be replicated,\nso it can be invoked before or after the animation starts or stops, since the original\nmethods is not available to the AOP implementation.",

98477

"itemtype": "method",

98478

"name": "_uiSetVisible",

98479

"params": [

98480

{

98481

"name": "val",

98482

"description": "true, if making the widget visible. false, if hiding it.",

98483

"type": "Boolean"

98484

}

98485

],

98486

"access": "private",

98487

"tagname": "",

98488

"class": "Plugin.WidgetAnim",

98489

"module": "widget-anim",

98490

"namespace": "Plugin"

98491

},

98492

{

98493

"file": "widget-anim/js/WidgetAnim.js",

98494

"line": 223,

98495

"description": "Binds a listener to invoke the original visibility handling when the animShow animation is started",

98496

"itemtype": "method",

98497

"name": "_bindAnimShow",

98498

"access": "private",

98499

"tagname": "",

98500

"class": "Plugin.WidgetAnim",

98501

"module": "widget-anim",

98502

"namespace": "Plugin"

98503

},

98504

{

98505

"file": "widget-anim/js/WidgetAnim.js",

98506

"line": 237,

98507

"description": "Binds a listener to invoke the original visibility handling when the animHide animation is complete",

98508

"itemtype": "method",

98509

"name": "_bindAnimHide",

98510

"access": "private",

98511

"tagname": "",

98512

"class": "Plugin.WidgetAnim",

98513

"module": "widget-anim",

98514

"namespace": "Plugin"

98515

},

98516

{

98517

"file": "widget-autohide/js/Widget-Autohide.js",

98518

"line": 46,

98519

"description": "Static property used to define the default attribute\nconfiguration introduced by WidgetAutohide.",

98520

"itemtype": "property",

98521

"name": "ATTRS",

98522

"static": 1,

98523

"type": "Object",

98524

"class": "WidgetAutohide",

98525

"module": "widget-autohide"

98526

},

98527

{

98528

"file": "widget-autohide/js/Widget-Autohide.js",

98529

"line": 57,

98530

"itemtype": "attribute",

98531

"name": "hideOn",

98532

"type": "array",

98533

"description": "An array of objects corresponding to the nodes, events, and keycodes to hide the widget on.\nThe implementer can supply an array of objects, with each object having the following properties:\neventName: (string, required): The eventName to listen to.\nnode: (Y.Node, optional): The Y.Node that will fire the event (defaults to the boundingBox of the widget)\nkeyCode: (string, optional): If listening for key events, specify the keyCode\nBy default, this attribute consists of one object which will cause the widget to hide if the\nescape key is pressed.",

98534

"class": "WidgetAutohide",

98535

"module": "widget-autohide"

98536

},

98537

{

98538

"file": "widget-autohide/js/Widget-Autohide.js",

98539

"line": 95,

98540

"description": "Binds event listeners to the widget.\n\nThis method in invoked after bindUI is invoked for the Widget class\nusing YUI's aop infrastructure.\n",

98541

"itemtype": "method",

98542

"name": "_bindUIAutohide",

98543

"access": "protected",

98544

"tagname": "",

98545

"class": "WidgetAutohide",

98546

"module": "widget-autohide"

98547

},

98548

{

98549

"file": "widget-autohide/js/Widget-Autohide.js",

98550

"line": 110,

98551

"description": "Syncs up the widget based on its current state. In particular, removes event listeners if\nwidget is not visible, and attaches them otherwise.\n\nThis method in invoked after syncUI is invoked for the Widget class\nusing YUI's aop infrastructure.\n",

98552

"itemtype": "method",

98553

"name": "_syncUIAutohide",

98554

"access": "protected",

98555

"tagname": "",

98556

"class": "WidgetAutohide",

98557

"module": "widget-autohide"

98558

},

98559

{

98560

"file": "widget-autohide/js/Widget-Autohide.js",

98561

"line": 127,

98562

"description": "Removes event listeners if widget is not visible, and attaches them otherwise.",

98563

"itemtype": "method",

98564

"name": "_uiSetHostVisibleAutohide",

98565

"access": "protected",

98566

"tagname": "",

98567

"class": "WidgetAutohide",

98568

"module": "widget-autohide"

98569

},

98570

{

98571

"file": "widget-autohide/js/Widget-Autohide.js",

98572

"line": 143,

98573

"description": "Iterates through all objects in the hideOn attribute and creates event listeners.",

98574

"itemtype": "method",

98575

"name": "_attachUIHandlesAutohide",

98576

"access": "protected",

98577

"tagname": "",

98578

"class": "WidgetAutohide",

98579

"module": "widget-autohide"

98580

},

98581

{

98582

"file": "widget-autohide/js/Widget-Autohide.js",

98583

"line": 192,

98584

"description": "Detaches all event listeners created by this extension",

98585

"itemtype": "method",

98586

"name": "_detachUIHandlesAutohide",

98587

"access": "protected",

98588

"tagname": "",

98589

"class": "WidgetAutohide",

98590

"module": "widget-autohide"

98591

},

98592

{

98593

"file": "widget-autohide/js/Widget-Autohide.js",

98594

"line": 206,

98595

"description": "Default function called when the visibility of the widget changes. Determines\nwhether to attach or detach event listeners based on the visibility of the widget.",

98596

"itemtype": "method",

98597

"name": "_afterHostVisibleChangeAutohide",

98598

"access": "protected",

98599

"tagname": "",

98600

"class": "WidgetAutohide",

98601

"module": "widget-autohide"

98602

},

98603

{

98604

"file": "widget-autohide/js/Widget-Autohide.js",

98605

"line": 218,

98606

"description": "Default function called when hideOn Attribute is changed. Remove existing listeners and create new listeners.",

98607

"itemtype": "method",

98608

"name": "_afterHideOnChange",

98609

"class": "WidgetAutohide",

98610

"module": "widget-autohide"

98611

},

98612

{

98613

"file": "widget-buttons/js/widget-buttons.js",

98614

"line": 55,

98615

"description": "Collection containing a widget's buttons.\n\nThe collection is an Object which contains an Array of `Y.Node`s for every\n`WidgetStdMod` section (header, body, footer) which has one or more buttons.\nAll button nodes have the `Y.Plugin.Button` plugin applied.\n\nThis attribute is very flexible in the values it will accept. `buttons` can\nbe specified as a single Array, or an Object of Arrays keyed to a particular\nsection.\n\nAll specified values will be normalized to this type of structure:\n\n {\n header: [...],\n footer: [...]\n }\n\nA button can be specified as a `Y.Node`, config Object, or String name for a\npredefined button on the `BUTTONS` prototype property. When a config Object\nis provided, it will be merged with any defaults provided by a button with\nthe same `name` defined on the `BUTTONS` property.\n\nSee `addButton()` for the detailed list of configuration properties.\n\nFor convenience, a widget's buttons will always persist and remain rendered\nafter header/body/footer content updates. Buttons should be removed by\nupdating this attribute or using the `removeButton()` method.",

98616

"example": [

98617

"\n {\n // Uses predefined \"close\" button by string name.\n header: ['close'],\n\n footer: [\n {\n name : 'cancel',\n label : 'Cancel',\n action: 'hide'\n },\n\n {\n name : 'okay',\n label : 'Okay',\n isDefault: true,\n\n events: {\n click: function (e) {\n this.hide();\n }\n }\n }\n ]\n }"

98618

],

98619

"itemtype": "attribute",

98620

"name": "buttons",

98621

"type": "Object",

98622

"default": "{}",

98623

"since": "3.4.0",

98624

"class": "WidgetButtons",

98625

"module": "widget-buttons"

98626

},

98627

{

98628

"file": "widget-buttons/js/widget-buttons.js",

98629

"line": 121,

98630

"description": "The current default button as configured through this widget's `buttons`.\n\nA button can be configured as the default button in the following ways:\n\n * As a config Object with an `isDefault` property:\n `{label: 'Okay', isDefault: true}`.\n\n * As a Node with a `data-default` attribute:\n `<button data-default=\"true\">Okay</button>`.\n\nThis attribute is **read-only**; anytime there are changes to this widget's\n`buttons`, the `defaultButton` will be updated if needed.\n\n**Note:** If two or more buttons are configured to be the default button,\nthe last one wins.",

98631

"itemtype": "attribute",

98632

"name": "defaultButton",

98633

"type": "Node",

98634

"default": "null",

98635

"readonly": "",

98636

"since": "3.5.0",

98637

"class": "WidgetButtons",

98638

"module": "widget-buttons"

98639

},

98640

{

98641

"file": "widget-buttons/js/widget-buttons.js",

98642

"line": 150,

98643

"description": "CSS classes used by `WidgetButtons`.",

98644

"itemtype": "property",

98645

"name": "CLASS_NAMES",

98646

"type": "Object",

98647

"static": 1,

98648

"since": "3.5.0",

98649

"class": "WidgetButtons",

98650

"module": "widget-buttons"

98651

},

98652

{

98653

"file": "widget-buttons/js/widget-buttons.js",

98654

"line": 170,

98655

"description": "The list of button configuration properties which are specific to\n`WidgetButtons` and should not be passed to `Y.Plugin.Button.createNode()`.",

98656

"itemtype": "property",

98657

"name": "NON_BUTTON_NODE_CFG",

98658

"type": "Array",

98659

"static": 1,

98660

"since": "3.5.0",

98661

"class": "WidgetButtons",

98662

"module": "widget-buttons"

98663

},

98664

{

98665

"file": "widget-buttons/js/widget-buttons.js",

98666

"line": 186,

98667

"description": "Collection of predefined buttons mapped by name -> config.\n\nThese button configurations will serve as defaults for any button added to a\nwidget's buttons which have the same `name`.\n\nSee `addButton()` for a list of possible configuration values.",

98668

"itemtype": "property",

98669

"name": "BUTTONS",

98670

"type": "Object",

98671

"default": "{}",

98672

"see": [

98673

"addButton()"

98674

],

98675

"since": "3.5.0",

98676

"class": "WidgetButtons",

98677

"module": "widget-buttons"

98678

},

98679

{

98680

"file": "widget-buttons/js/widget-buttons.js",

98681

"line": 202,

98682

"description": "The HTML template to use when creating the node which wraps all buttons of a\nsection. By default it will have the CSS class: \"yui3-widget-buttons\".",

98683

"itemtype": "property",

98684

"name": "BUTTONS_TEMPLATE",

98685

"type": "String",

98686

"default": "\"\"",

98687

"since": "3.5.0",

98688

"class": "WidgetButtons",

98689

"module": "widget-buttons"

98690

},

98691

{

98692

"file": "widget-buttons/js/widget-buttons.js",

98693

"line": 213,

98694

"description": "The default section to render buttons in when no section is specified.",

98695

"itemtype": "property",

98696

"name": "DEFAULT_BUTTONS_SECTION",

98697

"type": "String",

98698

"default": "Y.WidgetStdMod.FOOTER",

98699

"since": "3.5.0",

98700

"class": "WidgetButtons",

98701

"module": "widget-buttons"

98702

},

98703

{

98704

"file": "widget-buttons/js/widget-buttons.js",

98705

"line": 225,

98706

"description": "A map of button node `_yuid` -> event-handle for all button nodes which were\ncreated by this widget.",

98707

"itemtype": "property",

98708

"name": "_buttonsHandles",

98709

"type": "Object",

98710

"access": "protected",

98711

"tagname": "",

98712

"since": "3.5.0",

98713

"class": "WidgetButtons",

98714

"module": "widget-buttons"

98715

},

98716

{

98717

"file": "widget-buttons/js/widget-buttons.js",

98718

"line": 235,

98719

"description": "A map of this widget's `buttons`, both name -> button and\nsection:name -> button.",

98720

"itemtype": "property",

98721

"name": "_buttonsMap",

98722

"type": "Object",

98723

"access": "protected",

98724

"tagname": "",

98725

"since": "3.5.0",

98726

"class": "WidgetButtons",

98727

"module": "widget-buttons"

98728

},

98729

{

98730

"file": "widget-buttons/js/widget-buttons.js",

98731

"line": 245,

98732

"description": "Internal reference to this widget's default button.",

98733

"itemtype": "property",

98734

"name": "_defaultButton",

98735

"type": "Node",

98736

"access": "protected",

98737

"tagname": "",

98738

"since": "3.5.0",

98739

"class": "WidgetButtons",

98740

"module": "widget-buttons"

98741

},

98742

{

98743

"file": "widget-buttons/js/widget-buttons.js",

98744

"line": 281,

98745

"description": "Adds a button to this widget.\n\nThe new button node will have the `Y.Plugin.Button` plugin applied, be added\nto this widget's `buttons`, and rendered in the specified `section` at the\nspecified `index` (or end of the section when no `index` is provided). If\nthe section does not exist, it will be created.\n\nThis fires the `buttonsChange` event and adds the following properties to\nthe event facade:\n\n * `button`: The button node or config object to add.\n\n * `section`: The `WidgetStdMod` section (header/body/footer) where the\n button will be added.\n\n * `index`: The index at which the button will be in the section.\n\n * `src`: \"add\"\n\n**Note:** The `index` argument will be passed to the Array `splice()`\nmethod, therefore a negative value will insert the `button` that many items\nfrom the end. The `index` property on the `buttonsChange` event facade is\nthe index at which the `button` was added.",

98746

"itemtype": "method",

98747

"name": "addButton",

98748

"params": [

98749

{

98750

"name": "button",

98751

"description": "The button to add. This can be a `Y.Node`\n instance, config Object, or String name for a predefined button on the\n `BUTTONS` prototype property. When a config Object is provided, it will\n be merged with any defaults provided by any `srcNode` and/or a button\n with the same `name` defined on the `BUTTONS` property. The following\n are the possible configuration properties beyond what Node plugins\n accept by default:",

98752

"type": "Node|Object|String",

98753

"props": [

98754

{

98755

"name": "action",

98756

"description": "The default handler that should\n be called when the button is clicked. A String name of a Function that\n exists on the `context` object can also be provided. **Note:**\n Specifying a set of `events` will override this setting.",

98757

"type": "Function|String",

98758

"optional": true

98759

},

98760

{

98761

"name": "classNames",

98762

"description": "Additional CSS classes to add\n to the button node.",

98763

"type": "String|String[]",

98764

"optional": true

98765

},

98766

{

98767

"name": "context",

98768

"description": "Context which any `events` or\n `action` should be called with. Defaults to `this`, the widget.\n **Note:** `e.target` will access the button node in the event handlers.",

98769

"type": "Object",

98770

"optional": true,

98771

"optdefault": "this"

98772

},

98773

{

98774

"name": "disabled",

98775

"description": "Whether the button should be\n disabled.",

98776

"type": "Boolean",

98777

"optional": true,

98778

"optdefault": "false"

98779

},

98780

{

98781

"name": "events",

98782

"description": "Event name, or set of\n events and handlers to bind to the button node. **See:** `Y.Node.on()`,\n this value is passed as the first argument to `on()`.",

98783

"type": "String|Object",

98784

"optional": true,

98785

"optdefault": "\"click\""

98786

},

98787

{

98788

"name": "isDefault",

98789

"description": "Whether the button is the\n default button.",

98790

"type": "Boolean",

98791

"optional": true,

98792

"optdefault": "false"

98793

},

98794

{

98795

"name": "label",

98796

"description": "The visible text/value displayed in the\n button.",

98797

"type": "String",

98798

"optional": true

98799

},

98800

{

98801

"name": "name",

98802

"description": "A name which can later be used to reference\n this button. If a button is defined on the `BUTTONS` property with this\n same name, its configuration properties will be merged in as defaults.",

98803

"type": "String",

98804

"optional": true

98805

},

98806

{

98807

"name": "section",

98808

"description": "The `WidgetStdMod` section (header, body,\n footer) where the button should be added.",

98809

"type": "String",

98810

"optional": true

98811

},

98812

{

98813

"name": "srcNode",

98814

"description": "An existing Node to use for the button,\n default values will be seeded from this node, but are overriden by any\n values specified in the config object. By default a new <button>\n node will be created.",

98815

"type": "Node",

98816

"optional": true

98817

},

98818

{

98819

"name": "template",

98820

"description": "A specific template to use when creating\n a new button node (e.g. \"<a />\"). **Note:** Specifying a `srcNode`\n will overide this.",

98821

"type": "String",

98822

"optional": true

98823

}

98824

]

98825

},

98826

{

98827

"name": "section",

98828

"description": "The `WidgetStdMod` section\n (header/body/footer) where the button should be added. This takes\n precedence over the `button.section` configuration property.",

98829

"type": "String",

98830

"optional": true,

98831

"optdefault": "\"footer\""

98832

},

98833

{

98834

"name": "index",

98835

"description": "The index at which the button should be inserted. If\n not specified, the button will be added to the end of the section. This\n value is passed to the Array `splice()` method, therefore a negative\n value will insert the `button` that many items from the end.",

98836

"type": "Number",

98837

"optional": true

98838

}

98839

],

98840

"chainable": 1,

98841

"see": [

98842

"Plugin.Button.createNode()"

98843

],

98844

"since": "3.4.0",

98845

"class": "WidgetButtons",

98846

"module": "widget-buttons"

98847

},

98848

{

98849

"file": "widget-buttons/js/widget-buttons.js",

98850

"line": 385,

98851

"description": "Returns a button node from this widget's `buttons`.",

98852

"itemtype": "method",

98853

"name": "getButton",

98854

"params": [

98855

{

98856

"name": "name",

98857

"description": "The string name or index of the button.",

98858

"type": "Number|String"

98859

},

98860

{

98861

"name": "section",

98862

"description": "The `WidgetStdMod` section\n (header/body/footer) where the button exists. Only applicable when\n looking for a button by numerical index, or by name but scoped to a\n particular section.",

98863

"type": "String",

98864

"optional": true,

98865

"optdefault": "\"footer\""

98866

}

98867

],

98868

"return": {

98869

"description": "The button node.",

98870

"type": "Node"

98871

},

98872

"since": "3.5.0",

98873

"class": "WidgetButtons",

98874

"module": "widget-buttons"

98875

},

98876

{

98877

"file": "widget-buttons/js/widget-buttons.js",

98878

"line": 415,

98879

"description": "Removes a button from this widget.\n\nThe button will be removed from this widget's `buttons` and its DOM. Any\nevent subscriptions on the button which were created by this widget will be\ndetached. If the content section becomes empty after removing the button\nnode, then the section will also be removed.\n\nThis fires the `buttonsChange` event and adds the following properties to\nthe event facade:\n\n * `button`: The button node to remove.\n\n * `section`: The `WidgetStdMod` section (header/body/footer) where the\n button should be removed from.\n\n * `index`: The index at which the button exists in the section.\n\n * `src`: \"remove\"",

98880

"itemtype": "method",

98881

"name": "removeButton",

98882

"params": [

98883

{

98884

"name": "button",

98885

"description": "The button to remove. This can be a\n `Y.Node` instance, index, or String name of a button.",

98886

"type": "Node|Number|String"

98887

},

98888

{

98889

"name": "section",

98890

"description": "The `WidgetStdMod` section\n (header/body/footer) where the button exists. Only applicable when\n removing a button by numerical index, or by name but scoped to a\n particular section.",

98891

"type": "String",

98892

"optional": true,

98893

"optdefault": "\"footer\""

98894

}

98895

],

98896

"chainable": 1,

98897

"since": "3.5.0",

98898

"class": "WidgetButtons",

98899

"module": "widget-buttons"

98900

},

98901

{

98902

"file": "widget-buttons/js/widget-buttons.js",

98903

"line": 493,

98904

"description": "Binds UI event listeners. This method is inserted via AOP, and will execute\nafter `bindUI()`.",

98905

"itemtype": "method",

98906

"name": "_bindUIButtons",

98907

"access": "protected",

98908

"tagname": "",

98909

"since": "3.4.0",

98910

"class": "WidgetButtons",

98911

"module": "widget-buttons"

98912

},

98913

{

98914

"file": "widget-buttons/js/widget-buttons.js",

98915

"line": 515,

98916

"description": "Returns a button node based on the specified `button` node or configuration.\n\nThe button node will either be created via `Y.Plugin.Button.createNode()`,\nor when `button` is specified as a node already, it will by `plug()`ed with\n`Y.Plugin.Button`.",

98917

"itemtype": "method",

98918

"name": "_createButton",

98919

"params": [

98920

{

98921

"name": "button",

98922

"description": "Button node or configuration object.",

98923

"type": "Node|Object"

98924

}

98925

],

98926

"return": {

98927

"description": "The button node.",

98928

"type": "Node"

98929

},

98930

"access": "protected",

98931

"tagname": "",

98932

"since": "3.5.0",

98933

"class": "WidgetButtons",

98934

"module": "widget-buttons"

98935

},

98936

{

98937

"file": "widget-buttons/js/widget-buttons.js",

98938

"line": 580,

98939

"description": "Returns the buttons container for the specified `section`, passing a truthy\nvalue for `create` will create the node if it does not already exist.\n\n**Note:** It is up to the caller to properly insert the returned container\nnode into the content section.",

98940

"itemtype": "method",

98941

"name": "_getButtonContainer",

98942

"params": [

98943

{

98944

"name": "section",

98945

"description": "The `WidgetStdMod` section (header/body/footer).",

98946

"type": "String"

98947

},

98948

{

98949

"name": "create",

98950

"description": "Whether the buttons container should be created if\n it does not already exist.",

98951

"type": "Boolean"

98952

}

98953

],

98954

"return": {

98955

"description": "The buttons container node for the specified `section`.",

98956

"type": "Node"

98957

},

98958

"access": "protected",

98959

"tagname": "",

98960

"see": [

98961

"BUTTONS_TEMPLATE"

98962

],

98963

"since": "3.5.0",

98964

"class": "WidgetButtons",

98965

"module": "widget-buttons"

98966

},

98967

{

98968

"file": "widget-buttons/js/widget-buttons.js",

98969

"line": 615,

98970

"description": "Returns whether or not the specified `button` is configured to be the\ndefault button.\n\nWhen a button node is specified, the button's `getData()` method will be\nused to determine if the button is configured to be the default. When a\nbutton config object is specified, the `isDefault` prop will determine\nwhether the button is the default.\n\n**Note:** `<button data-default=\"true\"></button>` is supported via the\n`button.getData('default')` API call.",

98971

"itemtype": "method",

98972

"name": "_getButtonDefault",

98973

"params": [

98974

{

98975

"name": "button",

98976

"description": "The button node or configuration object.",

98977

"type": "Node|Object"

98978

}

98979

],

98980

"return": {

98981

"description": "Whether the button is configured to be the default button.",

98982

"type": "Boolean"

98983

},

98984

"access": "protected",

98985

"tagname": "",

98986

"since": "3.5.0",

98987

"class": "WidgetButtons",

98988

"module": "widget-buttons"

98989

},

98990

{

98991

"file": "widget-buttons/js/widget-buttons.js",

98992

"line": 644,

98993

"description": "Returns the name of the specified `button`.\n\nWhen a button node is specified, the button's `getData('name')` method is\npreferred, but will fallback to `get('name')`, and the result will determine\nthe button's name. When a button config object is specified, the `name` prop\nwill determine the button's name.\n\n**Note:** `<button data-name=\"foo\"></button>` is supported via the\n`button.getData('name')` API call.",

98994

"itemtype": "method",

98995

"name": "_getButtonName",

98996

"params": [

98997

{

98998

"name": "button",

98999

"description": "The button node or configuration object.",

99000

"type": "Node|Object"

99001

}

99002

],

99003

"return": {

99004

"description": "The name of the button.",

99005

"type": "String"

99006

},

99007

"access": "protected",

99008

"tagname": "",

99009

"since": "3.5.0",

99010

"class": "WidgetButtons",

99011

"module": "widget-buttons"

99012

},

99013

{

99014

"file": "widget-buttons/js/widget-buttons.js",

99015

"line": 673,

99016

"description": "Getter for the `buttons` attribute. A copy of the `buttons` object is\nreturned so the stored state cannot be modified by the callers of\n`get('buttons')`.\n\nThis will recreate a copy of the `buttons` object, and each section array\n(the button nodes are *not* copied/cloned.)",

99017

"itemtype": "method",

99018

"name": "_getButtons",

99019

"params": [

99020

{

99021

"name": "buttons",

99022

"description": "The widget's current `buttons` state.",

99023

"type": "Object"

99024

}

99025

],

99026

"return": {

99027

"description": "A copy of the widget's current `buttons` state.",

99028

"type": "Object"

99029

},

99030

"access": "protected",

99031

"tagname": "",

99032

"since": "3.5.0",

99033

"class": "WidgetButtons",

99034

"module": "widget-buttons"

99035

},

99036

{

99037

"file": "widget-buttons/js/widget-buttons.js",

99038

"line": 699,

99039

"description": "Adds the specified `button` to the buttons map (both name -> button and\nsection:name -> button), and sets the button as the default if it is\nconfigured as the default button.\n\n**Note:** If two or more buttons are configured with the same `name` and/or\nconfigured to be the default button, the last one wins.",

99040

"itemtype": "method",

99041

"name": "_mapButton",

99042

"params": [

99043

{

99044

"name": "button",

99045

"description": "The button node to map.",

99046

"type": "Node"

99047

},

99048

{

99049

"name": "section",

99050

"description": "The `WidgetStdMod` section (header/body/footer).",

99051

"type": "String"

99052

}

99053

],

99054

"access": "protected",

99055

"tagname": "",

99056

"since": "3.5.0",

99057

"class": "WidgetButtons",

99058

"module": "widget-buttons"

99059

},

99060

{

99061

"file": "widget-buttons/js/widget-buttons.js",

99062

"line": 729,

99063

"description": "Adds the specified `buttons` to the buttons map (both name -> button and\nsection:name -> button), and set the a button as the default if one is\nconfigured as the default button.\n\n**Note:** This will clear all previous button mappings and null-out any\nprevious default button! If two or more buttons are configured with the same\n`name` and/or configured to be the default button, the last one wins.",

99064

"itemtype": "method",

99065

"name": "_mapButtons",

99066

"params": [

99067

{

99068

"name": "buttons",

99069

"description": "The button nodes to map.",

99070

"type": "Node[]"

99071

}

99072

],

99073

"access": "protected",

99074

"tagname": "",

99075

"since": "3.5.0",

99076

"class": "WidgetButtons",

99077

"module": "widget-buttons"

99078

},

99079

{

99080

"file": "widget-buttons/js/widget-buttons.js",

99081

"line": 756,

99082

"description": "Returns a copy of the specified `config` object merged with any defaults\nprovided by a `srcNode` and/or a predefined configuration for a button\nwith the same `name` on the `BUTTONS` property.",

99083

"itemtype": "method",

99084

"name": "_mergeButtonConfig",

99085

"params": [

99086

{

99087

"name": "config",

99088

"description": "Button configuration object, or string name.",

99089

"type": "Object|String"

99090

}

99091

],

99092

"return": {

99093

"description": "A copy of the button configuration object merged with any\n defaults.",

99094

"type": "Object"

99095

},

99096

"access": "protected",

99097

"tagname": "",

99098

"since": "3.5.0",

99099

"class": "WidgetButtons",

99100

"module": "widget-buttons"

99101

},

99102

{

99103

"file": "widget-buttons/js/widget-buttons.js",

99104

"line": 805,

99105

"description": "`HTML_PARSER` implementation for the `buttons` attribute.\n\n**Note:** To determine a button node's name its `data-name` and `name`\nattributes are examined. Whether the button should be the default is\ndetermined by its `data-default` attribute.",

99106

"itemtype": "method",

99107

"name": "_parseButtons",

99108

"params": [

99109

{

99110

"name": "srcNode",

99111

"description": "This widget's srcNode to search for buttons.",

99112

"type": "Node"

99113

}

99114

],

99115

"return": {

99116

"description": "`buttons` Config object parsed from this widget's DOM.",

99117

"type": "Null|Object"

99118

},

99119

"access": "protected",

99120

"tagname": "",

99121

"since": "3.5.0",

99122

"class": "WidgetButtons",

99123

"module": "widget-buttons"

99124

},

99125

{

99126

"file": "widget-buttons/js/widget-buttons.js",

99127

"line": 846,

99128

"description": "Setter for the `buttons` attribute. This processes the specified `config`\nand returns a new `buttons` object which is stored as the new state; leaving\nthe original, specified `config` unmodified.\n\nThe button nodes will either be created via `Y.Plugin.Button.createNode()`,\nor when a button is already a Node already, it will by `plug()`ed with\n`Y.Plugin.Button`.",

99129

"itemtype": "method",

99130

"name": "_setButtons",

99131

"params": [

99132

{

99133

"name": "config",

99134

"description": "The `buttons` configuration to process.",

99135

"type": "Array|Object"

99136

}

99137

],

99138

"return": {

99139

"description": "The processed `buttons` object which represents the new\n state.",

99140

"type": "Object"

99141

},

99142

"access": "protected",

99143

"tagname": "",

99144

"since": "3.5.0",

99145

"class": "WidgetButtons",

99146

"module": "widget-buttons"

99147

},

99148

{

99149

"file": "widget-buttons/js/widget-buttons.js",

99150

"line": 902,

99151

"description": "Syncs this widget's current button-related state to its DOM. This method is\ninserted via AOP, and will execute after `syncUI()`.",

99152

"itemtype": "method",

99153

"name": "_syncUIButtons",

99154

"access": "protected",

99155

"tagname": "",

99156

"since": "3.4.0",

99157

"class": "WidgetButtons",

99158

"module": "widget-buttons"

99159

},

99160

{

99161

"file": "widget-buttons/js/widget-buttons.js",

99162

"line": 916,

99163

"description": "Inserts the specified `button` node into this widget's DOM at the specified\n`section` and `index` and updates the section content.\n\nThe section and button container nodes will be created if they do not\nalready exist.",

99164

"itemtype": "method",

99165

"name": "_uiInsertButton",

99166

"params": [

99167

{

99168

"name": "button",

99169

"description": "The button node to insert into this widget's DOM.",

99170

"type": "Node"

99171

},

99172

{

99173

"name": "section",

99174

"description": "The `WidgetStdMod` section (header/body/footer).",

99175

"type": "String"

99176

},

99177

{

99178

"name": "index",

99179

"description": "Index at which the `button` should be positioned.",

99180

"type": "Number"

99181

}

99182

],

99183

"access": "protected",

99184

"tagname": "",

99185

"since": "3.5.0",

99186

"class": "WidgetButtons",

99187

"module": "widget-buttons"

99188

},

99189

{

99190

"file": "widget-buttons/js/widget-buttons.js",

99191

"line": 942,

99192

"description": "Removes the button node from this widget's DOM and detaches any event\nsubscriptions on the button that were created by this widget. The section\ncontent will be updated unless `{preserveContent: true}` is passed in the\n`options`.\n\nBy default the button container node will be removed when this removes the\nlast button of the specified `section`; and if no other content remains in\nthe section node, it will also be removed.",

99193

"itemtype": "method",

99194

"name": "_uiRemoveButton",

99195

"params": [

99196

{

99197

"name": "button",

99198

"description": "The button to remove and destroy.",

99199

"type": "Node"

99200

},

99201

{

99202

"name": "section",

99203

"description": "The `WidgetStdMod` section (header/body/footer).",

99204

"type": "String"

99205

},

99206

{

99207

"name": "options",

99208

"description": "Additional options.",

99209

"type": "Object",

99210

"optional": true,

99211

"props": [

99212

{

99213

"name": "preserveContent",

99214

"description": "Whether the section\n content should be updated.",

99215

"type": "Boolean",

99216

"optional": true,

99217

"optdefault": "false"

99218

}

99219

]

99220

}

99221

],

99222

"access": "protected",

99223

"tagname": "",

99224

"since": "3.5.0",

99225

"class": "WidgetButtons",

99226

"module": "widget-buttons"

99227

},

99228

{

99229

"file": "widget-buttons/js/widget-buttons.js",

99230

"line": 989,

99231

"description": "Sets the current `buttons` state to this widget's DOM by rendering the\nspecified collection of `buttons` and updates the contents of each section\nas needed.\n\nButton nodes which already exist in the DOM will remain intact, or will be\nmoved if they should be in a new position. Old button nodes which are no\nlonger represented in the specified `buttons` collection will be removed,\nand any event subscriptions on the button which were created by this widget\nwill be detached.\n\nIf the button nodes in this widget's DOM actually change, then each content\nsection will be updated (or removed) appropriately.",

99232

"itemtype": "method",

99233

"name": "_uiSetButtons",

99234

"params": [

99235

{

99236

"name": "buttons",

99237

"description": "The current `buttons` state to visually represent.",

99238

"type": "Object"

99239

}

99240

],

99241

"access": "protected",

99242

"tagname": "",

99243

"since": "3.5.0",

99244

"class": "WidgetButtons",

99245

"module": "widget-buttons"

99246

},

99247

{

99248

"file": "widget-buttons/js/widget-buttons.js",

99249

"line": 1073,

99250

"description": "Adds the \"yui3-button-primary\" CSS class to the new `defaultButton` and\nremoves it from the old default button.",

99251

"itemtype": "method",

99252

"name": "_uiSetDefaultButton",

99253

"params": [

99254

{

99255

"name": "newButton",

99256

"description": "The new `defaultButton`.",

99257

"type": "Node"

99258

},

99259

{

99260

"name": "oldButton",

99261

"description": "The old `defaultButton`.",

99262

"type": "Node"

99263

}

99264

],

99265

"access": "protected",

99266

"tagname": "",

99267

"since": "3.5.0",

99268

"class": "WidgetButtons",

99269

"module": "widget-buttons"

99270

},

99271

{

99272

"file": "widget-buttons/js/widget-buttons.js",

99273

"line": 1090,

99274

"description": "Focuses this widget's `defaultButton` if there is one and this widget is\nvisible.",

99275

"itemtype": "method",

99276

"name": "_uiSetVisibleButtons",

99277

"params": [

99278

{

99279

"name": "visible",

99280

"description": "Whether this widget is visible.",

99281

"type": "Boolean"

99282

}

99283

],

99284

"access": "protected",

99285

"tagname": "",

99286

"since": "3.5.0",

99287

"class": "WidgetButtons",

99288

"module": "widget-buttons"

99289

},

99290

{

99291

"file": "widget-buttons/js/widget-buttons.js",

99292

"line": 1108,

99293

"description": "Removes the specified `button` from the buttons map (both name -> button and\nsection:name -> button), and nulls-out the `defaultButton` if it is\ncurrently the default button.",

99294

"itemtype": "method",

99295

"name": "_unMapButton",

99296

"params": [

99297

{

99298

"name": "button",

99299

"description": "The button node to remove from the buttons map.",

99300

"type": "Node"

99301

},

99302

{

99303

"name": "section",

99304

"description": "The `WidgetStdMod` section (header/body/footer).",

99305

"type": "String"

99306

}

99307

],

99308

"access": "protected",

99309

"tagname": "",

99310

"since": "3.5.0",

99311

"class": "WidgetButtons",

99312

"module": "widget-buttons"

99313

},

99314

{

99315

"file": "widget-buttons/js/widget-buttons.js",

99316

"line": 1144,

99317

"description": "Updates the `defaultButton` attribute if it needs to be updated by comparing\nits current value with the protected `_defaultButton` property.",

99318

"itemtype": "method",

99319

"name": "_updateDefaultButton",

99320

"access": "protected",

99321

"tagname": "",

99322

"since": "3.5.0",

99323

"class": "WidgetButtons",

99324

"module": "widget-buttons"

99325

},

99326

{

99327

"file": "widget-buttons/js/widget-buttons.js",

99328

"line": 1160,

99329

"description": "Updates the content attribute which corresponds to the specified `section`.\n\nThe method updates the section's content to its current `childNodes`\n(text and/or HTMLElement), or will null-out its contents if the section is\nempty. It also specifies a `src` of `buttons` on the change event facade.",

99330

"itemtype": "method",

99331

"name": "_updateContentButtons",

99332

"params": [

99333

{

99334

"name": "section",

99335

"description": "The `WidgetStdMod` section (header/body/footer) to\n update.",

99336

"type": "String"

99337

}

99338

],

99339

"access": "protected",

99340

"tagname": "",

99341

"since": "3.5.0",

99342

"class": "WidgetButtons",

99343

"module": "widget-buttons"

99344

},

99345

{

99346

"file": "widget-buttons/js/widget-buttons.js",

99347

"line": 1184,

99348

"description": "Handles this widget's `buttonsChange` event which fires anytime the\n`buttons` attribute is modified.\n\n**Note:** This method special-cases the `buttons` modifications caused by\n`addButton()` and `removeButton()`, both of which set the `src` property on\nthe event facade to \"add\" and \"remove\" respectively.",

99349

"itemtype": "method",

99350

"name": "_afterButtonsChange",

99351

"params": [

99352

{

99353

"name": "e",

99354

"description": "",

99355

"type": "EventFacade"

99356

}

99357

],

99358

"access": "protected",

99359

"tagname": "",

99360

"since": "3.4.0",

99361

"class": "WidgetButtons",

99362

"module": "widget-buttons"

99363

},

99364

{

99365

"file": "widget-buttons/js/widget-buttons.js",

99366

"line": 1233,

99367

"description": "Handles this widget's `headerContentChange`, `bodyContentChange`,\n`footerContentChange` events by making sure the `buttons` remain rendered\nafter changes to the content areas.\n\nThese events are very chatty, so extra caution is taken to avoid doing extra\nwork or getting into an infinite loop.",

99368

"itemtype": "method",

99369

"name": "_afterContentChangeButtons",

99370

"params": [

99371

{

99372

"name": "e",

99373

"description": "",

99374

"type": "EventFacade"

99375

}

99376

],

99377

"access": "protected",

99378

"tagname": "",

99379

"since": "3.5.0",

99380

"class": "WidgetButtons",

99381

"module": "widget-buttons"

99382

},

99383

{

99384

"file": "widget-buttons/js/widget-buttons.js",

99385

"line": 1257,

99386

"description": "Handles this widget's `defaultButtonChange` event by adding the\n\"yui3-button-primary\" CSS class to the new `defaultButton` and removing it\nfrom the old default button.",

99387

"itemtype": "method",

99388

"name": "_afterDefaultButtonChange",

99389

"params": [

99390

{

99391

"name": "e",

99392

"description": "",

99393

"type": "EventFacade"

99394

}

99395

],

99396

"access": "protected",

99397

"tagname": "",

99398

"since": "3.5.0",

99399

"class": "WidgetButtons",

99400

"module": "widget-buttons"

99401

},

99402

{

99403

"file": "widget-buttons/js/widget-buttons.js",

99404

"line": 1271,

99405

"description": "Handles this widget's `visibleChange` event by focusing the `defaultButton`\nif there is one.",

99406

"itemtype": "method",

99407

"name": "_afterVisibleChangeButtons",

99408

"params": [

99409

{

99410

"name": "e",

99411

"description": "",

99412

"type": "EventFacade"

99413

}

99414

],

99415

"access": "protected",

99416

"tagname": "",

99417

"since": "3.5.0",

99418

"class": "WidgetButtons",

99419

"module": "widget-buttons"

99420

},

99421

{

99422

"file": "widget-child/js/Widget-Child.js",

99423

"line": 26,

99424

"itemtype": "attribute",

99425

"name": "selected",

99426

"type": "Number",

99427

"default": "0",

99428

"description": "Number indicating if the Widget is selected. Possible \nvalues are:\n<dl>\n<dt>0</dt> <dd>(Default) Not selected</dd>\n<dt>1</dt> <dd>Fully selected</dd>\n<dt>2</dt> <dd>Partially selected</dd>\n</dl>",

99429

"class": "WidgetChild",

99430

"module": "widget-child"

99431

},

99432

{

99433

"file": "widget-child/js/Widget-Child.js",

99434

"line": 45,

99435

"itemtype": "attribute",

99436

"name": "index",

99437

"type": "Number",

99438

"readonly": "",

99439

"description": "Number representing the Widget's ordinal position in its \nparent Widget.",

99440

"class": "WidgetChild",

99441

"module": "widget-child"

99442

},

99443

{

99444

"file": "widget-child/js/Widget-Child.js",

99445

"line": 70,

99446

"itemtype": "attribute",

99447

"name": "parent",

99448

"type": "Widget",

99449

"readonly": "",

99450

"description": "Retrieves the parent of the Widget in the object hierarchy.",

99451

"class": "WidgetChild",

99452

"module": "widget-child"

99453

},

99454

{

99455

"file": "widget-child/js/Widget-Child.js",

99456

"line": 82,

99457

"itemtype": "attribute",

99458

"name": "depth",

99459

"type": "Number",

99460

"default": "-1",

99461

"readonly": "",

99462

"description": "Number representing the depth of this Widget relative to \nthe root Widget in the object heirarchy.",

99463

"class": "WidgetChild",

99464

"module": "widget-child"

99465

},

99466

{

99467

"file": "widget-child/js/Widget-Child.js",

99468

"line": 116,

99469

"itemtype": "attribute",

99470

"name": "root",

99471

"type": "Widget",

99472

"readonly": "",

99473

"description": "Returns the root Widget in the object hierarchy. If the\nROOT_TYPE property is set, the search for the root Widget will be \nconstrained to parent Widgets of the specified type.",

99474

"class": "WidgetChild",

99475

"module": "widget-child"

99476

},

99477

{

99478

"file": "widget-child/js/Widget-Child.js",

99479

"line": 152,

99480

"description": "Constructor reference used to determine the root of a Widget-based \nobject tree.\n\nCurrently used to control the behavior of the <code>root</code> \nattribute so that recursing up the object heirarchy can be constrained \nto a specific type of Widget. Widget authors should set this property\nto the constructor function for a given Widget implementation.\n",

99481

"itemtype": "property",

99482

"name": "ROOT_TYPE",

99483

"type": "Object",

99484

"class": "WidgetChild",

99485

"module": "widget-child"

99486

},

99487

{

99488

"file": "widget-child/js/Widget-Child.js",

99489

"line": 167,

99490

"description": "Returns the node on which to bind delegate listeners.\n\nOverride of Widget's implementation of _getUIEventNode() to ensure that \nall event listeners are bound to the Widget's topmost DOM element.\nThis ensures that the firing of each type of Widget UI event (click,\nmousedown, etc.) is facilitated by a single, top-level, delegated DOM\nevent listener.",

99491

"itemtype": "method",

99492

"name": "_getUIEventNode",

99493

"access": "protected",

99494

"tagname": "",

99495

"class": "Widget",

99496

"module": "widget-child"

99497

},

99498

{

99499

"file": "widget-child/js/Widget-Child.js",

99500

"line": 191,

99501

"itemtype": "method",

99502

"name": "next",

99503

"description": "Returns the Widget's next sibling.",

99504

"params": [

99505

{

99506

"name": "circular",

99507

"description": "Boolean indicating if the parent's first child \nshould be returned if the child has no next sibling.",

99508

"type": "Boolean"

99509

}

99510

],

99511

"return": {

99512

"description": "Widget instance.",

99513

"type": "Widget"

99514

},

99515

"class": "Widget",

99516

"module": "widget-child"

99517

},

99518

{

99519

"file": "widget-child/js/Widget-Child.js",

99520

"line": 216,

99521

"itemtype": "method",

99522

"name": "previous",

99523

"description": "Returns the Widget's previous sibling.",

99524

"params": [

99525

{

99526

"name": "circular",

99527

"description": "Boolean indicating if the parent's last child \nshould be returned if the child has no previous sibling.",

99528

"type": "Boolean"

99529

}

99530

],

99531

"return": {

99532

"description": "Widget instance.",

99533

"type": "Widget"

99534

},

99535

"class": "Widget",

99536

"module": "widget-child"

99537

},

99538

{

99539

"file": "widget-child/js/Widget-Child.js",

99540

"line": 267,

99541

"itemtype": "method",

99542

"name": "isRoot",

99543

"description": "Determines if the Widget is the root Widget in the \nobject hierarchy.",

99544

"return": {

99545

"description": "Boolean indicating if Widget is the root Widget in the \nobject hierarchy.",

99546

"type": "Boolean"

99547

},

99548

"class": "Widget",

99549

"module": "widget-child"

99550

},

99551

{

99552

"file": "widget-child/js/Widget-Child.js",

99553

"line": 279,

99554

"itemtype": "method",

99555

"name": "ancestor",

99556

"description": "Returns the Widget instance at the specified depth.",

99557

"params": [

99558

{

99559

"name": "depth",

99560

"description": "Number representing the depth of the ancestor.",

99561

"type": "Number"

99562

}

99563

],

99564

"return": {

99565

"description": "Widget instance.",

99566

"type": "Widget"

99567

},

99568

"class": "Widget",

99569

"module": "widget-child"

99570

},

99571

{

99572

"file": "widget-child/js/Widget-Child.js",

99573

"line": 305,

99574

"description": "Updates the UI to reflect the <code>selected</code> attribute value.",

99575

"itemtype": "method",

99576

"name": "_uiSetChildSelected",

99577

"access": "protected",

99578

"tagname": "",

99579

"params": [

99580

{

99581

"name": "selected",

99582

"description": "The selected value to be reflected in the UI.",

99583

"type": "Number"

99584

}

99585

],

99586

"class": "Widget",

99587

"module": "widget-child"

99588

},

99589

{

99590

"file": "widget-child/js/Widget-Child.js",

99591

"line": 327,

99592

"description": "Default attribute change listener for the <code>selected</code> \nattribute, responsible for updating the UI, in response to \nattribute changes.",

99593

"itemtype": "method",

99594

"name": "_afterChildSelectedChange",

99595

"access": "protected",

99596

"tagname": "",

99597

"params": [

99598

{

99599

"name": "event",

99600

"description": "The event facade for the attribute change.",

99601

"type": "EventFacade"

99602

}

99603

],

99604

"class": "Widget",

99605

"module": "widget-child"

99606

},

99607

{

99608

"file": "widget-child/js/Widget-Child.js",

99609

"line": 341,

99610

"description": "Synchronizes the UI to match the WidgetChild state.\n\nThis method is invoked after bindUI is invoked for the Widget class\nusing YUI's aop infrastructure.\n",

99611

"itemtype": "method",

99612

"name": "_syncUIChild",

99613

"access": "protected",

99614

"tagname": "",

99615

"class": "Widget",

99616

"module": "widget-child"

99617

},

99618

{

99619

"file": "widget-child/js/Widget-Child.js",

99620

"line": 356,

99621

"description": "Binds event listeners responsible for updating the UI state in response \nto WidgetChild related state changes.\n\nThis method is invoked after bindUI is invoked for the Widget class\nusing YUI's aop infrastructure.\n",

99622

"itemtype": "method",

99623

"name": "_bindUIChild",

99624

"access": "protected",

99625

"tagname": "",

99626

"class": "Widget",

99627

"module": "widget-child"

99628

},

99629

{

99630

"file": "widget-modality/js/Widget-Modality.js",

99631

"line": 64,

99632

"description": "Static property used to define the default attribute\nconfiguration introduced by WidgetModality.",

99633

"itemtype": "property",

99634

"name": "ATTRS",

99635

"static": 1,

99636

"type": "Object",

99637

"class": "WidgetModality",

99638

"module": "widget-modality"

99639

},

99640

{

99641

"file": "widget-modality/js/Widget-Modality.js",

99642

"line": 73,

99643

"itemtype": "attribute",

99644

"name": "maskNode",

99645

"type": "Y.Node",

99646

"description": "Returns a Y.Node instance of the node being used as the mask.",

99647

"class": "WidgetModality",

99648

"module": "widget-modality"

99649

},

99650

{

99651

"file": "widget-modality/js/Widget-Modality.js",

99652

"line": 85,

99653

"itemtype": "attribute",

99654

"name": "modal",

99655

"type": "boolean",

99656

"description": "Whether the widget should be modal or not.",

99657

"class": "WidgetModality",

99658

"module": "widget-modality"

99659

},

99660

{

99661

"file": "widget-modality/js/Widget-Modality.js",

99662

"line": 96,

99663

"itemtype": "attribute",

99664

"name": "focusOn",

99665

"type": "array",

99666

"description": "An array of objects corresponding to the nodes and events that will trigger a re-focus back on the widget.\nThe implementer can supply an array of objects, with each object having the following properties:\neventName: (string, required): The eventName to listen to.\nnode: (Y.Node, optional): The Y.Node that will fire the event (defaults to the boundingBox of the widget)\nBy default, this attribute consists of two objects which will cause the widget to re-focus if anything\noutside the widget is clicked on or focussed upon.",

99667

"class": "WidgetModality",

99668

"module": "widget-modality"

99669

},

99670

{

99671

"file": "widget-modality/js/Widget-Modality.js",

99672

"line": 130,

99673

"description": "Returns the mask if it exists on the page - otherwise creates a mask. There's only\none mask on a page at a given time.\n\nThis method in invoked internally by the getter of the maskNode ATTR.\n",

99674

"itemtype": "method",

99675

"name": "_GET_MASK",

99676

"static": 1,

99677

"class": "WidgetModality",

99678

"module": "widget-modality"

99679

},

99680

{

99681

"file": "widget-modality/js/Widget-Modality.js",

99682

"line": 179,

99683

"description": "A stack of Y.Widget objects representing the current hierarchy of modal widgets presently displayed on the screen",

99684

"itemtype": "property",

99685

"name": "STACK",

99686

"class": "WidgetModality",

99687

"module": "widget-modality"

99688

},

99689

{

99690

"file": "widget-modality/js/Widget-Modality.js",

99691

"line": 204,

99692

"description": "Adds modal class to the bounding box of the widget\n\nThis method in invoked after renderUI is invoked for the Widget class\nusing YUI's aop infrastructure.\n",

99693

"itemtype": "method",

99694

"name": "_renderUIModal",

99695

"access": "protected",

99696

"tagname": "",

99697

"class": "WidgetModality",

99698

"module": "widget-modality"

99699

},

99700

{

99701

"file": "widget-modality/js/Widget-Modality.js",

99702

"line": 229,

99703

"description": "Hooks up methods to be executed when the widget's visibility or z-index changes\n\nThis method in invoked after bindUI is invoked for the Widget class\nusing YUI's aop infrastructure.\n",

99704

"itemtype": "method",

99705

"name": "_bindUIModal",

99706

"access": "protected",

99707

"tagname": "",

99708

"class": "WidgetModality",

99709

"module": "widget-modality"

99710

},

99711

{

99712

"file": "widget-modality/js/Widget-Modality.js",

99713

"line": 257,

99714

"description": "Syncs the mask with the widget's current state, namely the visibility and z-index of the widget\n\nThis method in invoked after syncUI is invoked for the Widget class\nusing YUI's aop infrastructure.\n",

99715

"itemtype": "method",

99716

"name": "_syncUIModal",

99717

"access": "protected",

99718

"tagname": "",

99719

"class": "WidgetModality",

99720

"module": "widget-modality"

99721

},

99722

{

99723

"file": "widget-modality/js/Widget-Modality.js",

99724

"line": 275,

99725

"description": "Provides mouse and tab focus to the widget's bounding box.",

99726

"itemtype": "method",

99727

"name": "_focus",

99728

"class": "WidgetModality",

99729

"module": "widget-modality"

99730

},

99731

{

99732

"file": "widget-modality/js/Widget-Modality.js",

99733

"line": 288,

99734

"description": "Blurs the widget.",

99735

"itemtype": "method",

99736

"name": "_blur",

99737

"class": "WidgetModality",

99738

"module": "widget-modality"

99739

},

99740

{

99741

"file": "widget-modality/js/Widget-Modality.js",

99742

"line": 298,

99743

"description": "Returns the Y.Node instance of the maskNode",

99744

"itemtype": "method",

99745

"name": "_getMaskNode",

99746

"return": {

99747

"description": "The Y.Node instance of the mask, as returned from WidgetModal._GET_MASK",

99748

"type": "Node"

99749

},

99750

"class": "WidgetModality",

99751

"module": "widget-modality"

99752

},

99753

{

99754

"file": "widget-modality/js/Widget-Modality.js",

99755

"line": 309,

99756

"description": "Performs events attaching/detaching, stack shifting and mask repositioning based on the visibility of the widget",

99757

"itemtype": "method",

99758

"name": "_uiSetHostVisibleModal",

99759

"params": [

99760

{

99761

"name": "Whether",

99762

"description": "the widget is visible or not",

99763

"type": "Boolean"

99764

}

99765

],

99766

"class": "WidgetModality",

99767

"module": "widget-modality"

99768

},

99769

{

99770

"file": "widget-modality/js/Widget-Modality.js",

99771

"line": 375,

99772

"description": "Sets the z-index of the mask node.",

99773

"itemtype": "method",

99774

"name": "_uiSetHostZIndexModal",

99775

"params": [

99776

{

99777

"name": "Z-Index",

99778

"description": "of the widget",

99779

"type": "Number"

99780

}

99781

],

99782

"class": "WidgetModality",

99783

"module": "widget-modality"

99784

},

99785

{

99786

"file": "widget-modality/js/Widget-Modality.js",

99787

"line": 389,

99788

"description": "Attaches UI Listeners for \"clickoutside\" and \"focusoutside\" on the\nwidget. When these events occur, and the widget is modal, focus is\nshifted back onto the widget.",

99789

"itemtype": "method",

99790

"name": "_attachUIHandlesModal",

99791

"class": "WidgetModality",

99792

"module": "widget-modality"

99793

},

99794

{

99795

"file": "widget-modality/js/Widget-Modality.js",

99796

"line": 448,

99797

"description": "Detaches all UI Listeners that were set in _attachUIHandlesModal from the widget.",

99798

"itemtype": "method",

99799

"name": "_detachUIHandlesModal",

99800

"class": "WidgetModality",

99801

"module": "widget-modality"

99802

},

99803

{

99804

"file": "widget-modality/js/Widget-Modality.js",

99805

"line": 460,

99806

"description": "Default function that is called when visibility is changed on the widget.",

99807

"itemtype": "method",

99808

"name": "_afterHostVisibleChangeModal",

99809

"params": [

99810

{

99811

"name": "e",

99812

"description": "The event facade of the change",

99813

"type": "EventFacade"

99814

}

99815

],

99816

"class": "WidgetModality",

99817

"module": "widget-modality"

99818

},

99819

{

99820

"file": "widget-modality/js/Widget-Modality.js",

99821

"line": 471,

99822

"description": "Default function that is called when z-index is changed on the widget.",

99823

"itemtype": "method",

99824

"name": "_afterHostZIndexChangeModal",

99825

"params": [

99826

{

99827

"name": "e",

99828

"description": "The event facade of the change",

99829

"type": "EventFacade"

99830

}

99831

],

99832

"class": "WidgetModality",

99833

"module": "widget-modality"

99834

},

99835

{

99836

"file": "widget-modality/js/Widget-Modality.js",

99837

"line": 482,

99838

"description": "Returns a boolean representing whether the current widget is in a \"nested modality\" state.\nThis is done by checking the number of widgets currently on the stack.",

99839

"itemtype": "method",

99840

"name": "isNested",

99841

"access": "public",

99842

"tagname": "",

99843

"class": "WidgetModality",

99844

"module": "widget-modality"

99845

},

99846

{

99847

"file": "widget-modality/js/Widget-Modality.js",

99848

"line": 495,

99849

"description": "Repositions the mask in the DOM for nested modality cases.",

99850

"itemtype": "method",

99851

"name": "_repositionMask",

99852

"params": [

99853

{

99854

"name": "nextElem",

99855

"description": "The Y.Widget instance that will be visible in the stack once the current widget is closed.",

99856

"type": "Widget"

99857

}

99858

],

99859

"class": "WidgetModality",

99860

"module": "widget-modality"

99861

},

99862

{

99863

"file": "widget-modality/js/Widget-Modality.js",

99864

"line": 529,

99865

"description": "Resyncs the mask in the viewport for browsers that don't support fixed positioning",

99866

"itemtype": "method",

99867

"name": "_resyncMask",

99868

"params": [

99869

{

99870

"name": "nextElem",

99871

"description": "The Y.Widget instance that will be visible in the stack once the current widget is closed.",

99872

"type": "Y.Widget"

99873

}

99874

],

99875

"access": "private",

99876

"tagname": "",

99877

"class": "WidgetModality",

99878

"module": "widget-modality"

99879

},

99880

{

99881

"file": "widget-modality/js/Widget-Modality.js",

99882

"line": 552,

99883

"description": "Default function called when focusOn Attribute is changed. Remove existing listeners and create new listeners.",

99884

"itemtype": "method",

99885

"name": "_afterFocusOnChange",

99886

"class": "WidgetModality",

99887

"module": "widget-modality"

99888

},

99889

{

99890

"file": "widget-parent/js/Widget-Parent.js",

99891

"line": 29,

99892

"description": "Fires when a Widget is add as a child. The event object will have a \n'child' property that returns a reference to the child Widget, as well \nas an 'index' property that returns a reference to the index specified \nwhen the add() method was called.\n\nSubscribers to the \"on\" moment of this event, will be notified \nbefore a child is added.\n\n\nSubscribers to the \"after\" moment of this event, will be notified\nafter a child is added.\n",

99893

"itemtype": "event",

99894

"name": "addChild",

99895

"preventable": "_defAddChildFn",

99896

"params": [

99897

{

99898

"name": "e",

99899

"description": "The Event Facade",

99900

"type": "EventFacade"

99901

}

99902

],

99903

"class": "WidgetParent",

99904

"module": "widget-parent"

99905

},

99906

{

99907

"file": "widget-parent/js/Widget-Parent.js",

99908

"line": 53,

99909

"description": "Fires when a child Widget is removed. The event object will have a \n'child' property that returns a reference to the child Widget, as well \nas an 'index' property that returns a reference child's ordinal position.\n\nSubscribers to the \"on\" moment of this event, will be notified \nbefore a child is removed.\n\n\nSubscribers to the \"after\" moment of this event, will be notified\nafter a child is removed.\n",

99910

"itemtype": "event",

99911

"name": "removeChild",

99912

"preventable": "_defRemoveChildFn",

99913

"params": [

99914

{

99915

"name": "e",

99916

"description": "The Event Facade",

99917

"type": "EventFacade"

99918

}

99919

],

99920

"class": "WidgetParent",

99921

"module": "widget-parent"

99922

},

99923

{

99924

"file": "widget-parent/js/Widget-Parent.js",

99925

"line": 106,

99926

"itemtype": "attribute",

99927

"name": "defaultChildType",

99928

"type": "{String|Object}",

99929

"description": "String representing the default type of the children \nmanaged by this Widget. Can also supply default type as a constructor\nreference.",

99930

"class": "WidgetParent",

99931

"module": "widget-parent"

99932

},

99933

{

99934

"file": "widget-parent/js/Widget-Parent.js",

99935

"line": 128,

99936

"itemtype": "attribute",

99937

"name": "activeDescendant",

99938

"type": "Widget",

99939

"readonly": "",

99940

"description": "Returns the Widget's currently focused descendant Widget.",

99941

"class": "WidgetParent",

99942

"module": "widget-parent"

99943

},

99944

{

99945

"file": "widget-parent/js/Widget-Parent.js",

99946

"line": 139,

99947

"itemtype": "attribute",

99948

"name": "multiple",

99949

"type": "Boolean",

99950

"default": "false",

99951

"writeonce": "",

99952

"description": "Boolean indicating if multiple children can be selected at \nonce. Whether or not multiple selection is enabled is always delegated\nto the value of the <code>multiple</code> attribute of the root widget\nin the object hierarchy.",

99953

"class": "WidgetParent",

99954

"module": "widget-parent"

99955

},

99956

{

99957

"file": "widget-parent/js/Widget-Parent.js",

99958

"line": 161,

99959

"itemtype": "attribute",

99960

"name": "selection",

99961

"type": "{ArrayList|Widget}",

99962

"readonly": "",

99963

"description": "Returns the currently selected child Widget. If the \n<code>mulitple</code> attribte is set to <code>true</code> will \nreturn an Y.ArrayList instance containing the currently selected \nchildren. If no children are selected, will return null.",

99964

"class": "WidgetParent",

99965

"module": "widget-parent"

99966

},

99967

{

99968

"file": "widget-parent/js/Widget-Parent.js",

99969

"line": 209,

99970

"description": "The destructor implementation for Parent widgets. Destroys all children.",

99971

"itemtype": "method",

99972

"name": "destructor",

99973

"class": "WidgetParent",

99974

"module": "widget-parent"

99975

},

99976

{

99977

"file": "widget-parent/js/Widget-Parent.js",

99978

"line": 217,

99979

"description": "Destroy event listener for each child Widget, responsible for removing \nthe destroyed child Widget from the parent's internal array of children\n(_items property).",

99980

"itemtype": "method",

99981

"name": "_afterDestroyChild",

99982

"access": "protected",

99983

"tagname": "",

99984

"params": [

99985

{

99986

"name": "event",

99987

"description": "The event facade for the attribute change.",

99988

"type": "EventFacade"

99989

}

99990

],

99991

"class": "WidgetParent",

99992

"module": "widget-parent"

99993

},

99994

{

99995

"file": "widget-parent/js/Widget-Parent.js",

99996

"line": 234,

99997

"description": "Attribute change listener for the <code>selection</code> \nattribute, responsible for setting the value of the \nparent's <code>selected</code> attribute.",

99998

"itemtype": "method",

99999

"name": "_afterSelectionChange",

100000

"access": "protected",

100001

"tagname": "",

100002

"params": [

100003

{

100004

"name": "event",

100005

"description": "The event facade for the attribute change.",

100006

"type": "EventFacade"

100007

}

100008

],

100009

"class": "WidgetParent",

100010

"module": "widget-parent"

100011

},

100012

{

100013

"file": "widget-parent/js/Widget-Parent.js",

100014

"line": 271,

100015

"description": "Attribute change listener for the <code>activeDescendant</code> \nattribute, responsible for setting the value of the \nparent's <code>activeDescendant</code> attribute.",

100016

"itemtype": "method",

100017

"name": "_afterActiveDescendantChange",

100018

"access": "protected",

100019

"tagname": "",

100020

"params": [

100021

{

100022

"name": "event",

100023

"description": "The event facade for the attribute change.",

100024

"type": "EventFacade"

100025

}

100026

],

100027

"class": "WidgetParent",

100028

"module": "widget-parent"

100029

},

100030

{

100031

"file": "widget-parent/js/Widget-Parent.js",

100032

"line": 288,

100033

"description": "Attribute change listener for the <code>selected</code> \nattribute, responsible for syncing the selected state of all children to \nmatch that of their parent Widget.",

100034

"itemtype": "method",

100035

"name": "_afterParentSelectedChange",

100036

"access": "protected",

100037

"tagname": "",

100038

"params": [

100039

{

100040

"name": "event",

100041

"description": "The event facade for the attribute change.",

100042

"type": "EventFacade"

100043

}

100044

],

100045

"class": "WidgetParent",

100046

"module": "widget-parent"

100047

},

100048

{

100049

"file": "widget-parent/js/Widget-Parent.js",

100050

"line": 320,

100051

"description": "Default setter for <code>selection</code> attribute changes.",

100052

"itemtype": "method",

100053

"name": "_setSelection",

100054

"access": "protected",

100055

"tagname": "",

100056

"params": [

100057

{

100058

"name": "child",

100059

"description": "Widget or Array of Widget instances.",

100060

"type": "Widget|Array"

100061

}

100062

],

100063

"return": {

100064

"description": "Widget or Array of Widget instances.",

100065

"type": "Widget|Array"

100066

},

100067

"class": "WidgetParent",

100068

"module": "widget-parent"

100069

},

100070

{

100071

"file": "widget-parent/js/Widget-Parent.js",

100072

"line": 363,

100073

"description": "Attribute change listener for the <code>selected</code> \nattribute of child Widgets, responsible for setting the value of the \nparent's <code>selection</code> attribute.",

100074

"itemtype": "method",

100075

"name": "_updateSelection",

100076

"access": "protected",

100077

"tagname": "",

100078

"params": [

100079

{

100080

"name": "event",

100081

"description": "The event facade for the attribute change.",

100082

"type": "EventFacade"

100083

}

100084

],

100085

"class": "WidgetParent",

100086

"module": "widget-parent"

100087

},

100088

{

100089

"file": "widget-parent/js/Widget-Parent.js",

100090

"line": 405,

100091

"description": "Attribute change listener for the <code>focused</code> \nattribute of child Widgets, responsible for setting the value of the \nparent's <code>activeDescendant</code> attribute.",

100092

"itemtype": "method",

100093

"name": "_updateActiveDescendant",

100094

"access": "protected",

100095

"tagname": "",

100096

"params": [

100097

{

100098

"name": "event",

100099

"description": "The event facade for the attribute change.",

100100

"type": "EventFacade"

100101

}

100102

],

100103

"class": "WidgetParent",

100104

"module": "widget-parent"

100105

},

100106

{

100107

"file": "widget-parent/js/Widget-Parent.js",

100108

"line": 419,

100109

"description": "Creates an instance of a child Widget using the specified configuration.\nBy default Widget instances will be created of the type specified \nby the <code>defaultChildType</code> attribute. Types can be explicitly\ndefined via the <code>childType</code> property of the configuration object\nliteral. The use of the <code>type</code> property has been deprecated, but \nwill still be used as a fallback, if <code>childType</code> is not defined,\nfor backwards compatibility.",

100110

"itemtype": "method",

100111

"name": "_createChild",

100112

"access": "protected",

100113

"tagname": "",

100114

"params": [

100115

{

100116

"name": "config",

100117

"description": "Object literal representing the configuration \nused to create an instance of a Widget.",

100118

"type": "Object"

100119

}

100120

],

100121

"class": "WidgetParent",

100122

"module": "widget-parent"

100123

},

100124

{

100125

"file": "widget-parent/js/Widget-Parent.js",

100126

"line": 462,

100127

"description": "Default addChild handler",

100128

"itemtype": "method",

100129

"name": "_defAddChildFn",

100130

"access": "protected",

100131

"tagname": "",

100132

"params": [

100133

{

100134

"name": "event",

100135

"description": "The Event object",

100136

"type": "EventFacade"

100137

},

100138

{

100139

"name": "child",

100140

"description": "The Widget instance, or configuration \nobject for the Widget to be added as a child.",

100141

"type": "Widget"

100142

},

100143

{

100144

"name": "index",

100145

"description": "Number representing the position at \nwhich the child will be inserted.",

100146

"type": "Number"

100147

}

100148

],

100149

"class": "WidgetParent",

100150

"module": "widget-parent"

100151

},

100152

{

100153

"file": "widget-parent/js/Widget-Parent.js",

100154

"line": 502,

100155

"description": "Default removeChild handler",

100156

"itemtype": "method",

100157

"name": "_defRemoveChildFn",

100158

"access": "protected",

100159

"tagname": "",

100160

"params": [

100161

{

100162

"name": "event",

100163

"description": "The Event object",

100164

"type": "EventFacade"

100165

},

100166

{

100167

"name": "child",

100168

"description": "The Widget instance to be removed.",

100169

"type": "Widget"

100170

},

100171

{

100172

"name": "index",

100173

"description": "Number representing the index of the Widget to \nbe removed.",

100174

"type": "Number"

100175

}

100176

],

100177

"class": "WidgetParent",

100178

"module": "widget-parent"

100179

},

100180

{

100181

"file": "widget-parent/js/Widget-Parent.js",

100182

"line": 533,

100183

"itemtype": "method",

100184

"name": "_add",

100185

"access": "protected",

100186

"tagname": "",

100187

"params": [

100188

{

100189

"name": "child",

100190

"description": "The Widget instance, or configuration \nobject for the Widget to be added as a child.",

100191

"type": "Widget|Object"

100192

},

100193

{

100194

"name": "child",

100195

"description": "Array of Widget instances, or configuration \nobjects for the Widgets to be added as a children.",

100196

"type": "Array"

100197

},

100198

{

100199

"name": "index",

100200

"description": "(Optional.) Number representing the position at \nwhich the child should be inserted.",

100201

"type": "Number"

100202

}

100203

],

100204

"description": "Adds a Widget as a child. If the specified Widget already\nhas a parent it will be removed from its current parent before\nbeing added as a child.",

100205

"return": {

100206

"description": "Successfully added Widget or Array containing the \nsuccessfully added Widget instance(s). If no children where added, will \nwill return undefined.",

100207

"type": "Widget|Array"

100208

},

100209

"class": "WidgetParent",

100210

"module": "widget-parent"

100211

},

100212

{

100213

"file": "widget-parent/js/Widget-Parent.js",

100214

"line": 596,

100215

"itemtype": "method",

100216

"name": "add",

100217

"params": [

100218

{

100219

"name": "child",

100220

"description": "The Widget instance, or configuration \nobject for the Widget to be added as a child. The configuration object\nfor the child can include a <code>childType</code> property, which is either\na constructor function or a string which names a constructor function on the \nY instance (e.g. \"Tab\" would refer to Y.Tab) (<code>childType</code> used to be \nnamed <code>type</code>, support for which has been deprecated, but is still\nmaintained for backward compatibility. <code>childType</code> takes precedence\nover <code>type</code> if both are defined.",

100221

"type": "Widget|Object"

100222

},

100223

{

100224

"name": "child",

100225

"description": "Array of Widget instances, or configuration \nobjects for the Widgets to be added as a children.",

100226

"type": "Array"

100227

},

100228

{

100229

"name": "index",

100230

"description": "(Optional.) Number representing the position at \nwhich the child should be inserted.",

100231

"type": "Number"

100232

}

100233

],

100234

"description": "Adds a Widget as a child. If the specified Widget already\nhas a parent it will be removed from its current parent before\nbeing added as a child.",

100235

"return": {

100236

"description": "Y.ArrayList containing the successfully added \nWidget instance(s). If no children where added, will return an empty \nY.ArrayList instance.",

100237

"type": "ArrayList"

100238

},

100239

"class": "WidgetParent",

100240

"module": "widget-parent"

100241

},

100242

{

100243

"file": "widget-parent/js/Widget-Parent.js",

100244

"line": 627,

100245

"itemtype": "method",

100246

"name": "remove",

100247

"params": [

100248

{

100249

"name": "index",

100250

"description": "(Optional.) Number representing the index of the \nchild to be removed.",

100251

"type": "Number"

100252

}

100253

],

100254

"description": "Removes the Widget from its parent. Optionally, can remove\na child by specifying its index.",

100255

"return": {

100256

"description": "Widget instance that was successfully removed, otherwise\nundefined.",

100257

"type": "Widget"

100258

},

100259

"class": "WidgetParent",

100260

"module": "widget-parent"

100261

},

100262

{

100263

"file": "widget-parent/js/Widget-Parent.js",

100264

"line": 650,

100265

"itemtype": "method",

100266

"name": "removeAll",

100267

"description": "Removes all of the children from the Widget.",

100268

"return": {

100269

"description": "Y.ArrayList instance containing Widgets that were \nsuccessfully removed. If no children where removed, will return an empty \nY.ArrayList instance.",

100270

"type": "ArrayList"

100271

},

100272

"class": "WidgetParent",

100273

"module": "widget-parent"

100274

},

100275

{

100276

"file": "widget-parent/js/Widget-Parent.js",

100277

"line": 676,

100278

"description": "Selects the child at the given index (zero-based).",

100279

"itemtype": "method",

100280

"name": "selectChild",

100281

"params": [

100282

{

100283

"name": "i",

100284

"description": "the index of the child to be selected",

100285

"type": "Number"

100286

}

100287

],

100288

"class": "WidgetParent",

100289

"module": "widget-parent"

100290

},

100291

{

100292

"file": "widget-parent/js/Widget-Parent.js",

100293

"line": 686,

100294

"description": "Selects all children.",

100295

"itemtype": "method",

100296

"name": "selectAll",

100297

"class": "WidgetParent",

100298

"module": "widget-parent"

100299

},

100300

{

100301

"file": "widget-parent/js/Widget-Parent.js",

100302

"line": 695,

100303

"description": "Deselects all children.",

100304

"itemtype": "method",

100305

"name": "deselectAll",

100306

"class": "WidgetParent",

100307

"module": "widget-parent"

100308

},

100309

{

100310

"file": "widget-parent/js/Widget-Parent.js",

100311

"line": 704,

100312

"description": "Updates the UI in response to a child being added.",

100313

"itemtype": "method",

100314

"name": "_uiAddChild",

100315

"access": "protected",

100316

"tagname": "",

100317

"params": [

100318

{

100319

"name": "child",

100320

"description": "The child Widget instance to render.",

100321

"type": "Widget"

100322

},

100323

{

100324

"name": "parentNode",

100325

"description": "The Node under which the \nchild Widget is to be rendered.",

100326

"type": "Object"

100327

}

100328

],

100329

"class": "WidgetParent",

100330

"module": "widget-parent"

100331

},

100332

{

100333

"file": "widget-parent/js/Widget-Parent.js",

100334

"line": 760,

100335

"description": "Updates the UI in response to a child being removed.",

100336

"itemtype": "method",

100337

"name": "_uiRemoveChild",

100338

"access": "protected",

100339

"tagname": "",

100340

"params": [

100341

{

100342

"name": "child",

100343

"description": "The child Widget instance to render.",

100344

"type": "Widget"

100345

}

100346

],

100347

"class": "WidgetParent",

100348

"module": "widget-parent"

100349

},

100350

{

100351

"file": "widget-parent/js/Widget-Parent.js",

100352

"line": 787,

100353

"description": "Sets up DOM and CustomEvent listeners for the parent widget.\n\nThis method in invoked after bindUI is invoked for the Widget class\nusing YUI's aop infrastructure.\n",

100354

"itemtype": "method",

100355

"name": "_bindUIParent",

100356

"access": "protected",

100357

"tagname": "",

100358

"class": "WidgetParent",

100359

"module": "widget-parent"

100360

},

100361

{

100362

"file": "widget-parent/js/Widget-Parent.js",

100363

"line": 802,

100364

"description": "Renders all child Widgets for the parent.\n\nThis method in invoked after renderUI is invoked for the Widget class\nusing YUI's aop infrastructure.\n",

100365

"itemtype": "method",

100366

"name": "_renderChildren",

100367

"access": "protected",

100368

"tagname": "",

100369

"class": "WidgetParent",

100370

"module": "widget-parent"

100371

},

100372

{

100373

"file": "widget-parent/js/Widget-Parent.js",

100374

"line": 813,

100375

"description": "By default WidgetParent will render it's children to the parent's content box.\n\nIf the children need to be rendered somewhere else, the _childrenContainer property\ncan be set to the Node which the children should be rendered to. This property should be\nset before the _renderChildren method is invoked, ideally in your renderUI method, \nas soon as you create the element to be rendered to.",

100376

"access": "protected",

100377

"tagname": "",

100378

"itemtype": "property",

100379

"name": "_childrenContainer",

100380

"value": "The content box",

100381

"type": "Node",

100382

"class": "WidgetParent",

100383

"module": "widget-parent"

100384

},

100385

{

100386

"file": "widget-parent/js/Widget-Parent.js",

100387

"line": 835,

100388

"description": "Destroys all child Widgets for the parent.\n\nThis method is invoked before the destructor is invoked for the Widget \nclass using YUI's aop infrastructure.\n",

100389

"itemtype": "method",

100390

"name": "_destroyChildren",

100391

"access": "protected",

100392

"tagname": "",

100393

"class": "WidgetParent",

100394

"module": "widget-parent"

100395

},

100396

{

100397

"file": "widget-position-align/js/Widget-PositionAlign.js",

100398

"line": 48,

100399

"description": "The alignment configuration for this widget.\n\nThe `align` attribute is used to align a reference point on the widget, with\nthe reference point on another `Node`, or the viewport. The object which\n`align` expects has the following properties:\n\n * __`node`__: The `Node` to which the widget is to be aligned. If set to\n `null`, or not provided, the widget is aligned to the viewport.\n\n * __`points`__: A two element Array, defining the two points on the widget\n and `Node`/viewport which are to be aligned. The first element is the\n point on the widget, and the second element is the point on the\n `Node`/viewport. Supported alignment points are defined as static\n properties on `WidgetPositionAlign`.",

100400

"example": [

100401

" Aligns the top-right corner of the widget with the top-left corner \nof the viewport:\n\n myWidget.set('align', {\n points: [Y.WidgetPositionAlign.TR, Y.WidgetPositionAlign.TL]\n });"

100402

],

100403

"itemtype": "attribute",

100404

"name": "align",

100405

"type": "Object",

100406

"default": "null",

100407

"class": "WidgetPositionAlign",

100408

"module": "widget-position-align"

100409

},

100410

{

100411

"file": "widget-position-align/js/Widget-PositionAlign.js",

100412

"line": 79,

100413

"description": "A convenience Attribute, which can be used as a shortcut for the `align` \nAttribute.\n\nIf set to `true`, the widget is centered in the viewport. If set to a `Node` \nreference or valid selector String, the widget will be centered within the \n`Node`. If set to `false`, no center positioning is applied.",

100414

"itemtype": "attribute",

100415

"name": "centered",

100416

"type": "Boolean|Node",

100417

"default": "false",

100418

"class": "WidgetPositionAlign",

100419

"module": "widget-position-align"

100420

},

100421

{

100422

"file": "widget-position-align/js/Widget-PositionAlign.js",

100423

"line": 97,

100424

"description": "An Array of Objects corresponding to the `Node`s and events that will cause\nthe alignment of this widget to be synced to the DOM.\n\nThe `alignOn` Attribute is expected to be an Array of Objects with the \nfollowing properties:\n\n * __`eventName`__: The String event name to listen for.\n\n * __`node`__: The optional `Node` that will fire the event, it can be a \n `Node` reference or a selector String. This will default to the widget's \n `boundingBox`.",

100425

"example": [

100426

" Sync this widget's alignment on window resize:\n\n myWidget.set('alignOn', [\n {\n node : Y.one('win'),\n eventName: 'resize'\n }\n ]);"

100427

],

100428

"itemtype": "attribute",

100429

"name": "alignOn",

100430

"type": "Array",

100431

"default": "[]",

100432

"class": "WidgetPositionAlign",

100433

"module": "widget-position-align"

100434

},

100435

{

100436

"file": "widget-position-align/js/Widget-PositionAlign.js",

100437

"line": 129,

100438

"description": "Constant used to specify the top-left corner for alignment",

100439

"itemtype": "property",

100440

"name": "TL",

100441

"type": "String",

100442

"value": "'tl'",

100443

"static": 1,

100444

"class": "WidgetPositionAlign",

100445

"module": "widget-position-align"

100446

},

100447

{

100448

"file": "widget-position-align/js/Widget-PositionAlign.js",

100449

"line": 139,

100450

"description": "Constant used to specify the top-right corner for alignment",

100451

"itemtype": "property",

100452

"name": "TR",

100453

"type": "String",

100454

"value": "'tr'",

100455

"static": 1,

100456

"class": "WidgetPositionAlign",

100457

"module": "widget-position-align"

100458

},

100459

{

100460

"file": "widget-position-align/js/Widget-PositionAlign.js",

100461

"line": 149,

100462

"description": "Constant used to specify the bottom-left corner for alignment",

100463

"itemtype": "property",

100464

"name": "BL",

100465

"type": "String",

100466

"value": "'bl'",

100467

"static": 1,

100468

"class": "WidgetPositionAlign",

100469

"module": "widget-position-align"

100470

},

100471

{

100472

"file": "widget-position-align/js/Widget-PositionAlign.js",

100473

"line": 159,

100474

"description": "Constant used to specify the bottom-right corner for alignment",

100475

"itemtype": "property",

100476

"name": "BR",

100477

"type": "String",

100478

"value": "'br'",

100479

"static": 1,

100480

"class": "WidgetPositionAlign",

100481

"module": "widget-position-align"

100482

},

100483

{

100484

"file": "widget-position-align/js/Widget-PositionAlign.js",

100485

"line": 169,

100486

"description": "Constant used to specify the top edge-center point for alignment",

100487

"itemtype": "property",

100488

"name": "TC",

100489

"type": "String",

100490

"value": "'tc'",

100491

"static": 1,

100492

"class": "WidgetPositionAlign",

100493

"module": "widget-position-align"

100494

},

100495

{

100496

"file": "widget-position-align/js/Widget-PositionAlign.js",

100497

"line": 179,

100498

"description": "Constant used to specify the right edge, center point for alignment",

100499

"itemtype": "property",

100500

"name": "RC",

100501

"type": "String",

100502

"value": "'rc'",

100503

"static": 1,

100504

"class": "WidgetPositionAlign",

100505

"module": "widget-position-align"

100506

},

100507

{

100508

"file": "widget-position-align/js/Widget-PositionAlign.js",

100509

"line": 189,

100510

"description": "Constant used to specify the bottom edge, center point for alignment",

100511

"itemtype": "property",

100512

"name": "BC",

100513

"type": "String",

100514

"value": "'bc'",

100515

"static": 1,

100516

"class": "WidgetPositionAlign",

100517

"module": "widget-position-align"

100518

},

100519

{

100520

"file": "widget-position-align/js/Widget-PositionAlign.js",

100521

"line": 199,

100522

"description": "Constant used to specify the left edge, center point for alignment",

100523

"itemtype": "property",

100524

"name": "LC",

100525

"type": "String",

100526

"value": "'lc'",

100527

"static": 1,

100528

"class": "WidgetPositionAlign",

100529

"module": "widget-position-align"

100530

},

100531

{

100532

"file": "widget-position-align/js/Widget-PositionAlign.js",

100533

"line": 209,

100534

"description": "Constant used to specify the center of widget/node/viewport for alignment",

100535

"itemtype": "property",

100536

"name": "CC",

100537

"type": "String",

100538

"value": "'cc'",

100539

"static": 1,

100540

"class": "WidgetPositionAlign",

100541

"module": "widget-position-align"

100542

},

100543

{

100544

"file": "widget-position-align/js/Widget-PositionAlign.js",

100545

"line": 222,

100546

"description": "Holds the alignment-syncing event handles.",

100547

"itemtype": "property",

100548

"name": "_posAlignUIHandles",

100549

"type": "Array",

100550

"default": "null",

100551

"access": "protected",

100552

"tagname": "",

100553

"class": "WidgetPositionAlign",

100554

"module": "widget-position-align"

100555

},

100556

{

100557

"file": "widget-position-align/js/Widget-PositionAlign.js",

100558

"line": 238,

100559

"description": "Bind event listeners responsible for updating the UI state in response to\nthe widget's position-align related state changes.\n\nThis method is invoked after `bindUI` has been invoked for the `Widget`\nclass using the AOP infrastructure.",

100560

"itemtype": "method",

100561

"name": "_bindUIPosAlign",

100562

"access": "protected",

100563

"tagname": "",

100564

"class": "WidgetPositionAlign",

100565

"module": "widget-position-align"

100566

},

100567

{

100568

"file": "widget-position-align/js/Widget-PositionAlign.js",

100569

"line": 254,

100570

"description": "Synchronizes the current `align` Attribute value to the DOM.\n\nThis method is invoked after `syncUI` has been invoked for the `Widget`\nclass using the AOP infrastructure.",

100571

"itemtype": "method",

100572

"name": "_syncUIPosAlign",

100573

"access": "protected",

100574

"tagname": "",

100575

"class": "WidgetPositionAlign",

100576

"module": "widget-position-align"

100577

},

100578

{

100579

"file": "widget-position-align/js/Widget-PositionAlign.js",

100580

"line": 275,

100581

"description": "Aligns this widget to the provided `Node` (or viewport) using the provided\npoints. This method can be invoked with no arguments which will cause the \nwidget's current `align` Attribute value to be synced to the DOM.",

100582

"example": [

100583

" Aligning to the top-left corner of the `<body>`:\n\n myWidget.align('body',\n [Y.WidgetPositionAlign.TL, Y.WidgetPositionAlign.TR]);"

100584

],

100585

"itemtype": "method",

100586

"name": "align",

100587

"params": [

100588

{

100589

"name": "node",

100590

"description": "A reference (or selector String) for the\n `Node` which with the widget is to be aligned. If null is passed in, the\n widget will be aligned with the viewport.",

100591

"type": "Node|String|null",

100592

"optional": true

100593

},

100594

{

100595

"name": "points",

100596

"description": "A two item array specifying the points on the \n widget and `Node`/viewport which will to be aligned. The first entry is \n the point on the widget, and the second entry is the point on the \n `Node`/viewport. Valid point references are defined as static constants on \n the `WidgetPositionAlign` extension.",

100597

"type": "Array[2]",

100598

"optional": true

100599

}

100600

],

100601

"chainable": 1,

100602

"class": "WidgetPositionAlign",

100603

"module": "widget-position-align"

100604

},

100605

{

100606

"file": "widget-position-align/js/Widget-PositionAlign.js",

100607

"line": 311,

100608

"description": "Centers the widget in the viewport, or if a `Node` is passed in, it will \nbe centered to that `Node`.",

100609

"itemtype": "method",

100610

"name": "centered",

100611

"params": [

100612

{

100613

"name": "node",

100614

"description": "A `Node` reference or selector String defining \n the `Node` which the widget should be centered. If a `Node` is not passed\n in, then the widget will be centered to the viewport.",

100615

"type": "Node|String",

100616

"optional": true

100617

}

100618

],

100619

"chainable": 1,

100620

"class": "WidgetPositionAlign",

100621

"module": "widget-position-align"

100622

},

100623

{

100624

"file": "widget-position-align/js/Widget-PositionAlign.js",

100625

"line": 327,

100626

"description": "Default setter for `center` Attribute changes. Sets up the appropriate\nvalue, and passes it through the to the align attribute.",

100627

"itemtype": "method",

100628

"name": "_setAlignCenter",

100629

"params": [

100630

{

100631

"name": "val",

100632

"description": "The Attribute value being set.",

100633

"type": "Boolean|Node"

100634

}

100635

],

100636

"return": {

100637

"description": "the value passed in.",

100638

"type": "Boolean|Node"

100639

},

100640

"access": "protected",

100641

"tagname": "",

100642

"class": "WidgetPositionAlign",

100643

"module": "widget-position-align"

100644

},

100645

{

100646

"file": "widget-position-align/js/Widget-PositionAlign.js",

100647

"line": 347,

100648

"description": "Updates the UI to reflect the `align` value passed in.\n\n**Note:** See the `align` Attribute documentation, for the Object structure\nexpected.",

100649

"itemtype": "method",

100650

"name": "_uiSetAlign",

100651

"params": [

100652

{

100653

"name": "node",

100654

"description": "The node to align to, or null to indicate\n the viewport.",

100655

"type": "Node|String|null",

100656

"optional": true

100657

},

100658

{

100659

"name": "points",

100660

"description": "The alignment points.",

100661

"type": "Array"

100662

}

100663

],

100664

"access": "protected",

100665

"tagname": "",

100666

"class": "WidgetPositionAlign",

100667

"module": "widget-position-align"

100668

},

100669

{

100670

"file": "widget-position-align/js/Widget-PositionAlign.js",

100671

"line": 441,

100672

"description": "Attaches or detaches alignment-syncing event handlers based on the widget's\n`visible` Attribute state.",

100673

"itemtype": "method",

100674

"name": "_uiSetVisiblePosAlign",

100675

"params": [

100676

{

100677

"name": "visible",

100678

"description": "The current value of the widget's `visible`\n Attribute.",

100679

"type": "Boolean"

100680

}

100681

],

100682

"access": "protected",

100683

"tagname": "",

100684

"class": "WidgetPositionAlign",

100685

"module": "widget-position-align"

100686

},

100687

{

100688

"file": "widget-position-align/js/Widget-PositionAlign.js",

100689

"line": 458,

100690

"description": "Attaches the alignment-syncing event handlers.",

100691

"itemtype": "method",

100692

"name": "_attachPosAlignUIHandles",

100693

"access": "protected",

100694

"tagname": "",

100695

"class": "WidgetPositionAlign",

100696

"module": "widget-position-align"

100697

},

100698

{

100699

"file": "widget-position-align/js/Widget-PositionAlign.js",

100700

"line": 486,

100701

"description": "Detaches the alignment-syncing event handlers.",

100702

"itemtype": "method",

100703

"name": "_detachPosAlignUIHandles",

100704

"access": "protected",

100705

"tagname": "",

100706

"class": "WidgetPositionAlign",

100707

"module": "widget-position-align"

100708

},

100709

{

100710

"file": "widget-position-align/js/Widget-PositionAlign.js",

100711

"line": 502,

100712

"description": "Helper method, used to align the given point on the widget, with the XY page\ncoordinates provided.",

100713

"itemtype": "method",

100714

"name": "_doAlign",

100715

"params": [

100716

{

100717

"name": "widgetPoint",

100718

"description": "Supported point constant\n (e.g. WidgetPositionAlign.TL)",

100719

"type": "String"

100720

},

100721

{

100722

"name": "x",

100723

"description": "X page coordinate to align to.",

100724

"type": "Number"

100725

},

100726

{

100727

"name": "y",

100728

"description": "Y page coordinate to align to.",

100729

"type": "Number"

100730

}

100731

],

100732

"access": "private",

100733

"tagname": "",

100734

"class": "WidgetPositionAlign",

100735

"module": "widget-position-align"

100736

},

100737

{

100738

"file": "widget-position-align/js/Widget-PositionAlign.js",

100739

"line": 590,

100740

"description": "Returns the region of the passed-in `Node`, or the viewport region if\ncalling with passing in a `Node`.",

100741

"itemtype": "method",

100742

"name": "_getRegion",

100743

"params": [

100744

{

100745

"name": "node",

100746

"description": "The node to get the region of.",

100747

"type": "Node",

100748

"optional": true

100749

}

100750

],

100751

"return": {

100752

"description": "The node's region.",

100753

"type": "Object"

100754

},

100755

"access": "private",

100756

"tagname": "",

100757

"class": "WidgetPositionAlign",

100758

"module": "widget-position-align"

100759

},

100760

{

100761

"file": "widget-position-align/js/Widget-PositionAlign.js",

100762

"line": 616,

100763

"description": "Handles `alignChange` events by updating the UI in response to `align`\nAttribute changes.",

100764

"itemtype": "method",

100765

"name": "_afterAlignChange",

100766

"params": [

100767

{

100768

"name": "e",

100769

"description": "",

100770

"type": "EventFacade"

100771

}

100772

],

100773

"access": "protected",

100774

"tagname": "",

100775

"class": "WidgetPositionAlign",

100776

"module": "widget-position-align"

100777

},

100778

{

100779

"file": "widget-position-align/js/Widget-PositionAlign.js",

100780

"line": 631,

100781

"description": "Handles `alignOnChange` events by updating the alignment-syncing event\nhandlers.",

100782

"itemtype": "method",

100783

"name": "_afterAlignOnChange",

100784

"params": [

100785

{

100786

"name": "e",

100787

"description": "",

100788

"type": "EventFacade"

100789

}

100790

],

100791

"access": "protected",

100792

"tagname": "",

100793

"class": "WidgetPositionAlign",

100794

"module": "widget-position-align"

100795

},

100796

{

100797

"file": "widget-position-constrain/js/Widget-PositionConstrain.js",

100798

"line": 46,

100799

"description": "Static property used to define the default attribute \nconfiguration introduced by WidgetPositionConstrain.",

100800

"itemtype": "property",

100801

"name": "ATTRS",

100802

"type": "Object",

100803

"static": 1,

100804

"class": "WidgetPositionConstrain",

100805

"module": "widget-position-constrain"

100806

},

100807

{

100808

"file": "widget-position-constrain/js/Widget-PositionConstrain.js",

100809

"line": 56,

100810

"itemtype": "attribute",

100811

"name": "constrain",

100812

"type": "boolean | Node",

100813

"default": "null",

100814

"description": "The node to constrain the widget's bounding box to, when setting xy. Can also be\nset to true, to constrain to the viewport.",

100815

"class": "WidgetPositionConstrain",

100816

"module": "widget-position-constrain"

100817

},

100818

{

100819

"file": "widget-position-constrain/js/Widget-PositionConstrain.js",

100820

"line": 68,

100821

"itemtype": "attribute",

100822

"name": "preventOverlap",

100823

"type": "boolean",

100824

"description": "If set to true, and WidgetPositionAlign is also added to the Widget, \nconstrained positioning will attempt to prevent the widget's bounding box from overlapping \nthe element to which it has been aligned, by flipping the orientation of the alignment\nfor corner based alignments",

100825

"class": "WidgetPositionConstrain",

100826

"module": "widget-position-constrain"

100827

},

100828

{

100829

"file": "widget-position-constrain/js/Widget-PositionConstrain.js",

100830

"line": 81,

100831

"itemtype": "property",

100832

"name": "_PREVENT_OVERLAP",

100833

"static": 1,

100834

"access": "protected",

100835

"tagname": "",

100836

"type": "Object",

100837

"description": "The set of positions for which to prevent\noverlap.",

100838

"class": "WidgetPositionConstrain",

100839

"module": "widget-position-constrain"

100840

},

100841

{

100842

"file": "widget-position-constrain/js/Widget-PositionConstrain.js",

100843

"line": 106,

100844

"description": "Calculates the constrained positions for the XY positions provided, using\nthe provided node argument is passed in. If no node value is passed in, the value of \nthe \"constrain\" attribute is used.",

100845

"itemtype": "method",

100846

"name": "getConstrainedXY",

100847

"params": [

100848

{

100849

"name": "xy",

100850

"description": "The xy values to constrain",

100851

"type": "Array"

100852

},

100853

{

100854

"name": "node",

100855

"description": "Optional. The node to constrain to, or true for the viewport",

100856

"type": "Node | boolean"

100857

}

100858

],

100859

"return": {

100860

"description": "The constrained xy values",

100861

"type": "Array"

100862

},

100863

"class": "WidgetPositionConstrain",

100864

"module": "widget-position-constrain"

100865

},

100866

{

100867

"file": "widget-position-constrain/js/Widget-PositionConstrain.js",

100868

"line": 128,

100869

"description": "Constrains the widget's bounding box to a node (or the viewport). If xy or node are not \npassed in, the current position and the value of \"constrain\" will be used respectively.\n\nThe widget's position will be changed to the constrained position.",

100870

"itemtype": "method",

100871

"name": "constrain",

100872

"params": [

100873

{

100874

"name": "xy",

100875

"description": "Optional. The xy values to constrain",

100876

"type": "Array"

100877

},

100878

{

100879

"name": "node",

100880

"description": "Optional. The node to constrain to, or true for the viewport",

100881

"type": "Node | boolean"

100882

}

100883

],

100884

"class": "WidgetPositionConstrain",

100885

"module": "widget-position-constrain"

100886

},

100887

{

100888

"file": "widget-position-constrain/js/Widget-PositionConstrain.js",

100889

"line": 153,

100890

"description": "The setter implementation for the \"constrain\" attribute.",

100891

"itemtype": "method",

100892

"name": "_setConstrain",

100893

"access": "protected",

100894

"tagname": "",

100895

"params": [

100896

{

100897

"name": "val",

100898

"description": "The attribute value",

100899

"type": "Node | boolean"

100900

}

100901

],

100902

"class": "WidgetPositionConstrain",

100903

"module": "widget-position-constrain"

100904

},

100905

{

100906

"file": "widget-position-constrain/js/Widget-PositionConstrain.js",

100907

"line": 164,

100908

"description": "The method which performs the actual constrain calculations for a given axis (\"x\" or \"y\") based\non the regions provided.",

100909

"itemtype": "method",

100910

"name": "_constrain",

100911

"access": "protected",

100912

"tagname": "",

100913

"params": [

100914

{

100915

"name": "val",

100916

"description": "The value to constrain",

100917

"type": "Number"

100918

},

100919

{

100920

"name": "axis",

100921

"description": "The axis to use for constrainment",

100922

"type": "String"

100923

},

100924

{

100925

"name": "nodeRegion",

100926

"description": "The region of the node to constrain",

100927

"type": "Region"

100928

},

100929

{

100930

"name": "constrainingRegion",

100931

"description": "The region of the node (or viewport) to constrain to",

100932

"type": "Region"

100933

}

100934

],

100935

"return": {

100936

"description": "The constrained value",

100937

"type": "Number"

100938

},

100939

"class": "WidgetPositionConstrain",

100940

"module": "widget-position-constrain"

100941

},

100942

{

100943

"file": "widget-position-constrain/js/Widget-PositionConstrain.js",

100944

"line": 208,

100945

"description": "The method which performs the preventOverlap calculations for a given axis (\"x\" or \"y\") based\non the value and regions provided.",

100946

"itemtype": "method",

100947

"name": "_preventOverlap",

100948

"access": "protected",

100949

"tagname": "",

100950

"params": [

100951

{

100952

"name": "val",

100953

"description": "The value being constrain",

100954

"type": "Number"

100955

},

100956

{

100957

"name": "axis",

100958

"description": "The axis to being constrained",

100959

"type": "String"

100960

},

100961

{

100962

"name": "nodeRegion",

100963

"description": "The region of the node being constrained",

100964

"type": "Region"

100965

},

100966

{

100967

"name": "constrainingRegion",

100968

"description": "The region of the node (or viewport) we need to constrain to",

100969

"type": "Region"

100970

}

100971

],

100972

"return": {

100973

"description": "The constrained value",

100974

"type": "Number"

100975

},

100976

"class": "WidgetPositionConstrain",

100977

"module": "widget-position-constrain"

100978

},

100979

{

100980

"file": "widget-position-constrain/js/Widget-PositionConstrain.js",

100981

"line": 259,

100982

"description": "Binds event listeners responsible for updating the UI state in response to \nWidget constrained positioning related state changes.\n\nThis method is invoked after bindUI is invoked for the Widget class\nusing YUI's aop infrastructure.\n",

100983

"itemtype": "method",

100984

"name": "_bindUIPosConstrained",

100985

"access": "protected",

100986

"tagname": "",

100987

"class": "WidgetPositionConstrain",

100988

"module": "widget-position-constrain"

100989

},

100990

{

100991

"file": "widget-position-constrain/js/Widget-PositionConstrain.js",

100992

"line": 275,

100993

"description": "After change listener for the \"constrain\" attribute, responsible\nfor updating the UI, in response to attribute changes.",

100994

"itemtype": "method",

100995

"name": "_afterConstrainChange",

100996

"access": "protected",

100997

"tagname": "",

100998

"params": [

100999

{

101000

"name": "e",

101001

"description": "The event facade",

101002

"type": "EventFacade"

101003

}

101004

],

101005

"class": "WidgetPositionConstrain",

101006

"module": "widget-position-constrain"

101007

},

101008

{

101009

"file": "widget-position-constrain/js/Widget-PositionConstrain.js",

101010

"line": 287,

101011

"description": "Updates the UI if enabling constraints, and sets up the xyChange event listeners\nto constrain whenever the widget is moved. Disabling constraints removes the listeners.",

101012

"itemtype": "method",

101013

"name": "enable or disable constraints listeners",

101014

"access": "private",

101015

"tagname": "",

101016

"params": [

101017

{

101018

"name": "enable",

101019

"description": "Enable or disable constraints",

101020

"type": "Boolean"

101021

}

101022

],

101023

"class": "WidgetPositionConstrain",

101024

"module": "widget-position-constrain"

101025

},

101026

{

101027

"file": "widget-position-constrain/js/Widget-PositionConstrain.js",

101028

"line": 305,

101029

"description": "The on change listener for the \"xy\" attribute. Modifies the event facade's\nnewVal property with the constrained XY value.",

101030

"itemtype": "method",

101031

"name": "_constrainOnXYChange",

101032

"access": "protected",

101033

"tagname": "",

101034

"params": [

101035

{

101036

"name": "e",

101037

"description": "The event facade for the attribute change",

101038

"type": "EventFacade"

101039

}

101040

],

101041

"class": "WidgetPositionConstrain",

101042

"module": "widget-position-constrain"

101043

},

101044

{

101045

"file": "widget-position-constrain/js/Widget-PositionConstrain.js",

101046

"line": 319,

101047

"description": "Utility method to normalize region retrieval from a node instance, \nor the viewport, if no node is provided.",

101048

"itemtype": "method",

101049

"name": "_getRegion",

101050

"access": "private",

101051

"tagname": "",

101052

"params": [

101053

{

101054

"name": "node",

101055

"description": "Optional.",

101056

"type": "Node"

101057

}

101058

],

101059

"class": "WidgetPositionConstrain",

101060

"module": "widget-position-constrain"

101061

},

101062

{

101063

"file": "widget-position/js/Widget-Position.js",

101064

"line": 40,

101065

"description": "Static property used to define the default attribute \nconfiguration introduced by WidgetPosition.",

101066

"itemtype": "property",

101067

"name": "ATTRS",

101068

"static": 1,

101069

"type": "Object",

101070

"class": "WidgetPosition",

101071

"module": "widget-position"

101072

},

101073

{

101074

"file": "widget-position/js/Widget-Position.js",

101075

"line": 50,

101076

"itemtype": "attribute",

101077

"name": "x",

101078

"type": "number",

101079

"default": "0",

101080

"description": "Page X co-ordinate for the widget. This attribute acts as a facade for the \nxy attribute. Changes in position can be monitored by listening for xyChange events.",

101081

"class": "WidgetPosition",

101082

"module": "widget-position"

101083

},

101084

{

101085

"file": "widget-position/js/Widget-Position.js",

101086

"line": 68,

101087

"itemtype": "attribute",

101088

"name": "y",

101089

"type": "number",

101090

"default": "0",

101091

"description": "Page Y co-ordinate for the widget. This attribute acts as a facade for the \nxy attribute. Changes in position can be monitored by listening for xyChange events.",

101092

"class": "WidgetPosition",

101093

"module": "widget-position"

101094

},

101095

{

101096

"file": "widget-position/js/Widget-Position.js",

101097

"line": 86,

101098

"itemtype": "attribute",

101099

"name": "xy",

101100

"type": "Array",

101101

"default": "[0,0]",

101102

"description": "Page XY co-ordinate pair for the widget.",

101103

"class": "WidgetPosition",

101104

"module": "widget-position"

101105

},

101106

{

101107

"file": "widget-position/js/Widget-Position.js",

101108

"line": 101,

101109

"description": "Default class used to mark the boundingBox of a positioned widget.",

101110

"itemtype": "property",

101111

"name": "POSITIONED_CLASS_NAME",

101112

"type": "String",

101113

"default": "\"yui-widget-positioned\"",

101114

"static": 1,

101115

"class": "WidgetPosition",

101116

"module": "widget-position"

101117

},

101118

{

101119

"file": "widget-position/js/Widget-Position.js",

101120

"line": 113,

101121

"description": "Creates/Initializes the DOM to support xy page positioning.\n\nThis method in invoked after renderUI is invoked for the Widget class\nusing YUI's aop infrastructure.\n",

101122

"itemtype": "method",

101123

"name": "_renderUIPosition",

101124

"access": "protected",

101125

"tagname": "",

101126

"class": "WidgetPosition",

101127

"module": "widget-position"

101128

},

101129

{

101130

"file": "widget-position/js/Widget-Position.js",

101131

"line": 126,

101132

"description": "Synchronizes the UI to match the Widgets xy page position state.\n\nThis method in invoked after syncUI is invoked for the Widget class\nusing YUI's aop infrastructure.\n",

101133

"itemtype": "method",

101134

"name": "_syncUIPosition",

101135

"access": "protected",

101136

"tagname": "",

101137

"class": "WidgetPosition",

101138

"module": "widget-position"

101139

},

101140

{

101141

"file": "widget-position/js/Widget-Position.js",

101142

"line": 143,

101143

"description": "Binds event listeners responsible for updating the UI state in response to \nWidget position related state changes.\n\nThis method in invoked after bindUI is invoked for the Widget class\nusing YUI's aop infrastructure.\n",

101144

"itemtype": "method",

101145

"name": "_bindUIPosition",

101146

"access": "protected",

101147

"tagname": "",

101148

"class": "WidgetPosition",

101149

"module": "widget-position"

101150

},

101151

{

101152

"file": "widget-position/js/Widget-Position.js",

101153

"line": 157,

101154

"description": "Moves the Widget to the specified page xy co-ordinate position.",

101155

"itemtype": "method",

101156

"name": "move",

101157

"params": [

101158

{

101159

"name": "x",

101160

"description": "The new x position",

101161

"type": "Number"

101162

},

101163

{

101164

"name": "y",

101165

"description": "The new y position\nOr",

101166

"type": "Number"

101167

},

101168

{

101169

"name": "x,",

101170

"description": "y values passed as an array ([x, y]), to support\nsimple pass through of Node.getXY results",

101171

"type": "Array"

101172

}

101173

],

101174

"class": "WidgetPosition",

101175

"module": "widget-position"

101176

},

101177

{

101178

"file": "widget-position/js/Widget-Position.js",

101179

"line": 174,

101180

"description": "Synchronizes the Panel's \"xy\", \"x\", and \"y\" properties with the \nWidget's position in the DOM.",

101181

"itemtype": "method",

101182

"name": "syncXY",

101183

"class": "WidgetPosition",

101184

"module": "widget-position"

101185

},

101186

{

101187

"file": "widget-position/js/Widget-Position.js",

101188

"line": 184,

101189

"description": "Default validator for the XY attribute",

101190

"itemtype": "method",

101191

"name": "_validateXY",

101192

"access": "protected",

101193

"tagname": "",

101194

"params": [

101195

{

101196

"name": "val",

101197

"description": "The XY page co-ordinate value which is being set.",

101198

"type": "Array"

101199

}

101200

],

101201

"return": {

101202

"description": "true if valid, false if not.",

101203

"type": "Boolean"

101204

},

101205

"class": "WidgetPosition",

101206

"module": "widget-position"

101207

},

101208

{

101209

"file": "widget-position/js/Widget-Position.js",

101210

"line": 196,

101211

"description": "Default setter for the X attribute. The setter passes the X value through\nto the XY attribute, which is the sole store for the XY state.",

101212

"itemtype": "method",

101213

"name": "_setX",

101214

"access": "protected",

101215

"tagname": "",

101216

"params": [

101217

{

101218

"name": "val",

101219

"description": "The X page co-ordinate value",

101220

"type": "Number"

101221

}

101222

],

101223

"class": "WidgetPosition",

101224

"module": "widget-position"

101225

},

101226

{

101227

"file": "widget-position/js/Widget-Position.js",

101228

"line": 208,

101229

"description": "Default setter for the Y attribute. The setter passes the Y value through\nto the XY attribute, which is the sole store for the XY state.",

101230

"itemtype": "method",

101231

"name": "_setY",

101232

"access": "protected",

101233

"tagname": "",

101234

"params": [

101235

{

101236

"name": "val",

101237

"description": "The Y page co-ordinate value",

101238

"type": "Number"

101239

}

101240

],

101241

"class": "WidgetPosition",

101242

"module": "widget-position"

101243

},

101244

{

101245

"file": "widget-position/js/Widget-Position.js",

101246

"line": 220,

101247

"description": "Default getter for the X attribute. The value is retrieved from \nthe XY attribute, which is the sole store for the XY state.",

101248

"itemtype": "method",

101249

"name": "_getX",

101250

"access": "protected",

101251

"tagname": "",

101252

"return": {

101253

"description": "The X page co-ordinate value",

101254

"type": "Number"

101255

},

101256

"class": "WidgetPosition",

101257

"module": "widget-position"

101258

},

101259

{

101260

"file": "widget-position/js/Widget-Position.js",

101261

"line": 232,

101262

"description": "Default getter for the Y attribute. The value is retrieved from \nthe XY attribute, which is the sole store for the XY state.",

101263

"itemtype": "method",

101264

"name": "_getY",

101265

"access": "protected",

101266

"tagname": "",

101267

"return": {

101268

"description": "The Y page co-ordinate value",

101269

"type": "Number"

101270

},

101271

"class": "WidgetPosition",

101272

"module": "widget-position"

101273

},

101274

{

101275

"file": "widget-position/js/Widget-Position.js",

101276

"line": 244,

101277

"description": "Default attribute change listener for the xy attribute, responsible\nfor updating the UI, in response to attribute changes.",

101278

"itemtype": "method",

101279

"name": "_afterXYChange",

101280

"access": "protected",

101281

"tagname": "",

101282

"params": [

101283

{

101284

"name": "e",

101285

"description": "The event facade for the attribute change",

101286

"type": "EventFacade"

101287

}

101288

],

101289

"class": "WidgetPosition",

101290

"module": "widget-position"

101291

},

101292

{

101293

"file": "widget-position/js/Widget-Position.js",

101294

"line": 258,

101295

"description": "Updates the UI to reflect the XY page co-ordinates passed in.",

101296

"itemtype": "method",

101297

"name": "_uiSetXY",

101298

"access": "protected",

101299

"tagname": "",

101300

"params": [

101301

{

101302

"name": "val",

101303

"description": "The XY page co-ordinates value to be reflected in the UI",

101304

"type": "String"

101305

}

101306

],

101307

"class": "WidgetPosition",

101308

"module": "widget-position"

101309

},

101310

{

101311

"file": "widget-stack/js/Widget-Stack.js",

101312

"line": 65,

101313

"description": "Static property used to define the default attribute\nconfiguration introduced by WidgetStack.",

101314

"itemtype": "property",

101315

"name": "ATTRS",

101316

"type": "Object",

101317

"static": 1,

101318

"class": "WidgetStack",

101319

"module": "widget-stack"

101320

},

101321

{

101322

"file": "widget-stack/js/Widget-Stack.js",

101323

"line": 74,

101324

"itemtype": "attribute",

101325

"name": "shim",

101326

"type": "boolean",

101327

"default": "false, for all browsers other than IE6, for which a shim is enabled by default.",

101328

"description": "Boolean flag to indicate whether or not a shim should be added to the Widgets\nboundingBox, to protect it from select box bleedthrough.",

101329

"class": "WidgetStack",

101330

"module": "widget-stack"

101331

},

101332

{

101333

"file": "widget-stack/js/Widget-Stack.js",

101334

"line": 86,

101335

"itemtype": "attribute",

101336

"name": "zIndex",

101337

"type": "number",

101338

"default": "0",

101339

"description": "The z-index to apply to the Widgets boundingBox. Non-numerical values for\nzIndex will be converted to 0",

101340

"class": "WidgetStack",

101341

"module": "widget-stack"

101342

},

101343

{

101344

"file": "widget-stack/js/Widget-Stack.js",

101345

"line": 99,

101346

"description": "The HTML parsing rules for the WidgetStack class.",

101347

"itemtype": "property",

101348

"name": "HTML_PARSER",

101349

"static": 1,

101350

"type": "Object",

101351

"class": "WidgetStack",

101352

"module": "widget-stack"

101353

},

101354

{

101355

"file": "widget-stack/js/Widget-Stack.js",

101356

"line": 112,

101357

"description": "Default class used to mark the shim element",

101358

"itemtype": "property",

101359

"name": "SHIM_CLASS_NAME",

101360

"type": "String",

101361

"static": 1,

101362

"default": "\"yui3-widget-shim\"",

101363

"class": "WidgetStack",

101364

"module": "widget-stack"

101365

},

101366

{

101367

"file": "widget-stack/js/Widget-Stack.js",

101368

"line": 122,

101369

"description": "Default class used to mark the boundingBox of a stacked widget.",

101370

"itemtype": "property",

101371

"name": "STACKED_CLASS_NAME",

101372

"type": "String",

101373

"static": 1,

101374

"default": "\"yui3-widget-stacked\"",

101375

"class": "WidgetStack",

101376

"module": "widget-stack"

101377

},

101378

{

101379

"file": "widget-stack/js/Widget-Stack.js",

101380

"line": 132,

101381

"description": "Default markup template used to generate the shim element.",

101382

"itemtype": "property",

101383

"name": "SHIM_TEMPLATE",

101384

"type": "String",

101385

"static": 1,

101386

"class": "WidgetStack",

101387

"module": "widget-stack"

101388

},

101389

{

101390

"file": "widget-stack/js/Widget-Stack.js",

101391

"line": 143,

101392

"description": "Synchronizes the UI to match the Widgets stack state. This method in\ninvoked after syncUI is invoked for the Widget class using YUI's aop infrastructure.",

101393

"itemtype": "method",

101394

"name": "_syncUIStack",

101395

"access": "protected",

101396

"tagname": "",

101397

"class": "WidgetStack",

101398

"module": "widget-stack"

101399

},

101400

{

101401

"file": "widget-stack/js/Widget-Stack.js",

101402

"line": 155,

101403

"description": "Binds event listeners responsible for updating the UI state in response to\nWidget stack related state changes.\n\nThis method is invoked after bindUI is invoked for the Widget class\nusing YUI's aop infrastructure.\n",

101404

"itemtype": "method",

101405

"name": "_bindUIStack",

101406

"access": "protected",

101407

"tagname": "",

101408

"class": "WidgetStack",

101409

"module": "widget-stack"

101410

},

101411

{

101412

"file": "widget-stack/js/Widget-Stack.js",

101413

"line": 170,

101414

"description": "Creates/Initializes the DOM to support stackability.\n\nThis method in invoked after renderUI is invoked for the Widget class\nusing YUI's aop infrastructure.\n",

101415

"itemtype": "method",

101416

"name": "_renderUIStack",

101417

"access": "protected",

101418

"tagname": "",

101419

"class": "WidgetStack",

101420

"module": "widget-stack"

101421

},

101422

{

101423

"file": "widget-stack/js/Widget-Stack.js",

101424

"line": 183,

101425

"description": "Parses a `zIndex` attribute value from this widget's `srcNode`.",

101426

"itemtype": "method",

101427

"name": "_parseZIndex",

101428

"params": [

101429

{

101430

"name": "srcNode",

101431

"description": "The node to parse a `zIndex` value from.",

101432

"type": "Node"

101433

}

101434

],

101435

"return": {

101436

"description": "The parsed `zIndex` value.",

101437

"type": "Mixed"

101438

},

101439

"access": "protected",

101440

"tagname": "",

101441

"class": "WidgetStack",

101442

"module": "widget-stack"

101443

},

101444

{

101445

"file": "widget-stack/js/Widget-Stack.js",

101446

"line": 218,

101447

"description": "Default setter for zIndex attribute changes. Normalizes zIndex values to\nnumbers, converting non-numerical values to 0.",

101448

"itemtype": "method",

101449

"name": "_setZIndex",

101450

"access": "protected",

101451

"tagname": "",

101452

"params": [

101453

{

101454

"name": "zIndex",

101455

"description": "",

101456

"type": "String | Number"

101457

}

101458

],

101459

"return": {

101460

"description": "Normalized zIndex",

101461

"type": "Number"

101462

},

101463

"class": "WidgetStack",

101464

"module": "widget-stack"

101465

},

101466

{

101467

"file": "widget-stack/js/Widget-Stack.js",

101468

"line": 237,

101469

"description": "Default attribute change listener for the shim attribute, responsible\nfor updating the UI, in response to attribute changes.",

101470

"itemtype": "method",

101471

"name": "_afterShimChange",

101472

"access": "protected",

101473

"tagname": "",

101474

"params": [

101475

{

101476

"name": "e",

101477

"description": "The event facade for the attribute change",

101478

"type": "EventFacade"

101479

}

101480

],

101481

"class": "WidgetStack",

101482

"module": "widget-stack"

101483

},

101484

{

101485

"file": "widget-stack/js/Widget-Stack.js",

101486

"line": 249,

101487

"description": "Default attribute change listener for the zIndex attribute, responsible\nfor updating the UI, in response to attribute changes.",

101488

"itemtype": "method",

101489

"name": "_afterZIndexChange",

101490

"access": "protected",

101491

"tagname": "",

101492

"params": [

101493

{

101494

"name": "e",

101495

"description": "The event facade for the attribute change",

101496

"type": "EventFacade"

101497

}

101498

],

101499

"class": "WidgetStack",

101500

"module": "widget-stack"

101501

},

101502

{

101503

"file": "widget-stack/js/Widget-Stack.js",

101504

"line": 261,

101505

"description": "Updates the UI to reflect the zIndex value passed in.",

101506

"itemtype": "method",

101507

"name": "_uiSetZIndex",

101508

"access": "protected",

101509

"tagname": "",

101510

"params": [

101511

{

101512

"name": "zIndex",

101513

"description": "The zindex to be reflected in the UI",

101514

"type": "Number"

101515

}

101516

],

101517

"class": "WidgetStack",

101518

"module": "widget-stack"

101519

},

101520

{

101521

"file": "widget-stack/js/Widget-Stack.js",

101522

"line": 272,

101523

"description": "Updates the UI to enable/disable the shim. If the widget is not currently visible,\ncreation of the shim is deferred until it is made visible, for performance reasons.",

101524

"itemtype": "method",

101525

"name": "_uiSetShim",

101526

"access": "protected",

101527

"tagname": "",

101528

"params": [

101529

{

101530

"name": "enable",

101531

"description": "If true, creates/renders the shim, if false, removes it.",

101532

"type": "Boolean"

101533

}

101534

],

101535

"class": "WidgetStack",

101536

"module": "widget-stack"

101537

},

101538

{

101539

"file": "widget-stack/js/Widget-Stack.js",

101540

"line": 301,

101541

"description": "Sets up change handlers for the visible attribute, to defer shim creation/rendering\nuntil the Widget is made visible.",

101542

"itemtype": "method",

101543

"name": "_renderShimDeferred",

101544

"access": "private",

101545

"tagname": "",

101546

"class": "WidgetStack",

101547

"module": "widget-stack"

101548

},

101549

{

101550

"file": "widget-stack/js/Widget-Stack.js",

101551

"line": 327,

101552

"description": "Sets up event listeners to resize the shim when the size of the Widget changes.\n\nNOTE: This method is only used for IE6 currently, since IE6 doesn't support a way to\nresize the shim purely through CSS, when the Widget does not have an explicit width/height\nset.\n",

101553

"itemtype": "method",

101554

"name": "_addShimResizeHandlers",

101555

"access": "private",

101556

"tagname": "",

101557

"class": "WidgetStack",

101558

"module": "widget-stack"

101559

},

101560

{

101561

"file": "widget-stack/js/Widget-Stack.js",

101562

"line": 350,

101563

"description": "Detaches any handles stored for the provided key",

101564

"itemtype": "method",

101565

"name": "_detachStackHandles",

101566

"params": [

101567

{

101568

"name": "String",

101569

"description": "handleKey The key defining the group of handles which should be detached"

101570

}

101571

],

101572

"access": "private",

101573

"tagname": "",

101574

"class": "WidgetStack",

101575

"module": "widget-stack"

101576

},

101577

{

101578

"file": "widget-stack/js/Widget-Stack.js",

101579

"line": 368,

101580

"description": "Creates the shim element and adds it to the DOM",

101581

"itemtype": "method",

101582

"name": "_renderShim",

101583

"access": "private",

101584

"tagname": "",

101585

"class": "WidgetStack",

101586

"module": "widget-stack"

101587

},

101588

{

101589

"file": "widget-stack/js/Widget-Stack.js",

101590

"line": 387,

101591

"description": "Removes the shim from the DOM, and detaches any related event\nlisteners.",

101592

"itemtype": "method",

101593

"name": "_destroyShim",

101594

"access": "private",

101595

"tagname": "",

101596

"class": "WidgetStack",

101597

"module": "widget-stack"

101598

},

101599

{

101600

"file": "widget-stack/js/Widget-Stack.js",

101601

"line": 404,

101602

"description": "For IE6, synchronizes the size and position of iframe shim to that of\nWidget bounding box which it is protecting. For all other browsers,\nthis method does not do anything.",

101603

"itemtype": "method",

101604

"name": "sizeShim",

101605

"class": "WidgetStack",

101606

"module": "widget-stack"

101607

},

101608

{

101609

"file": "widget-stack/js/Widget-Stack.js",

101610

"line": 421,

101611

"description": "Creates a cloned shim node, using the SHIM_TEMPLATE html template, for use on a new instance.",

101612

"itemtype": "method",

101613

"name": "_getShimTemplate",

101614

"access": "private",

101615

"tagname": "",

101616

"return": {

101617

"description": "node A new shim Node instance.",

101618

"type": "Node"

101619

},

101620

"class": "WidgetStack",

101621

"module": "widget-stack"

101622

},

101623

{

101624

"file": "widget-stdmod/js/Widget-StdMod.js",

101625

"line": 69,

101626

"description": "Constant used to refer the the standard module header, in methods which expect a section specifier",

101627

"itemtype": "property",

101628

"name": "HEADER",

101629

"static": 1,

101630

"type": "String",

101631

"class": "WidgetStdMod",

101632

"module": "widget-stdmod"

101633

},

101634

{

101635

"file": "widget-stdmod/js/Widget-StdMod.js",

101636

"line": 78,

101637

"description": "Constant used to refer the the standard module body, in methods which expect a section specifier",

101638

"itemtype": "property",

101639

"name": "BODY",

101640

"static": 1,

101641

"type": "String",

101642

"class": "WidgetStdMod",

101643

"module": "widget-stdmod"

101644

},

101645

{

101646

"file": "widget-stdmod/js/Widget-StdMod.js",

101647

"line": 87,

101648

"description": "Constant used to refer the the standard module footer, in methods which expect a section specifier",

101649

"itemtype": "property",

101650

"name": "FOOTER",

101651

"static": 1,

101652

"type": "String",

101653

"class": "WidgetStdMod",

101654

"module": "widget-stdmod"

101655

},

101656

{

101657

"file": "widget-stdmod/js/Widget-StdMod.js",

101658

"line": 96,

101659

"description": "Constant used to specify insertion position, when adding content to sections of the standard module in\nmethods which expect a \"where\" argument.\n\nInserts new content before the sections existing content.\n",

101660

"itemtype": "property",

101661

"name": "AFTER",

101662

"static": 1,

101663

"type": "String",

101664

"class": "WidgetStdMod",

101665

"module": "widget-stdmod"

101666

},

101667

{

101668

"file": "widget-stdmod/js/Widget-StdMod.js",

101669

"line": 108,

101670

"description": "Constant used to specify insertion position, when adding content to sections of the standard module in\nmethods which expect a \"where\" argument.\n\nInserts new content before the sections existing content.\n",

101671

"itemtype": "property",

101672

"name": "BEFORE",

101673

"static": 1,

101674

"type": "String",

101675

"class": "WidgetStdMod",

101676

"module": "widget-stdmod"

101677

},

101678

{

101679

"file": "widget-stdmod/js/Widget-StdMod.js",

101680

"line": 119,

101681

"description": "Constant used to specify insertion position, when adding content to sections of the standard module in\nmethods which expect a \"where\" argument.\n\nReplaces the sections existing content, with new content.\n",

101682

"itemtype": "property",

101683

"name": "REPLACE",

101684

"static": 1,

101685

"type": "String",

101686

"class": "WidgetStdMod",

101687

"module": "widget-stdmod"

101688

},

101689

{

101690

"file": "widget-stdmod/js/Widget-StdMod.js",

101691

"line": 139,

101692

"description": "Static property used to define the default attribute\nconfiguration introduced by WidgetStdMod.",

101693

"itemtype": "property",

101694

"name": "ATTRS",

101695

"type": "Object",

101696

"static": 1,

101697

"class": "WidgetStdMod",

101698

"module": "widget-stdmod"

101699

},

101700

{

101701

"file": "widget-stdmod/js/Widget-StdMod.js",

101702

"line": 149,

101703

"itemtype": "attribute",

101704

"name": "headerContent",

101705

"type": "HTML",

101706

"default": "undefined",

101707

"description": "The content to be added to the header section. This will replace any existing content\nin the header. If you want to append, or insert new content, use the <a href=\"#method_setStdModContent\">setStdModContent</a> method.",

101708

"class": "WidgetStdMod",

101709

"module": "widget-stdmod"

101710

},

101711

{

101712

"file": "widget-stdmod/js/Widget-StdMod.js",

101713

"line": 160,

101714

"itemtype": "attribute",

101715

"name": "footerContent",

101716

"type": "HTML",

101717

"default": "undefined",

101718

"description": "The content to be added to the footer section. This will replace any existing content\nin the footer. If you want to append, or insert new content, use the <a href=\"#method_setStdModContent\">setStdModContent</a> method.",

101719

"class": "WidgetStdMod",

101720

"module": "widget-stdmod"

101721

},

101722

{

101723

"file": "widget-stdmod/js/Widget-StdMod.js",

101724

"line": 171,

101725

"itemtype": "attribute",

101726

"name": "bodyContent",

101727

"type": "HTML",

101728

"default": "undefined",

101729

"description": "The content to be added to the body section. This will replace any existing content\nin the body. If you want to append, or insert new content, use the <a href=\"#method_setStdModContent\">setStdModContent</a> method.",

101730

"class": "WidgetStdMod",

101731

"module": "widget-stdmod"

101732

},

101733

{

101734

"file": "widget-stdmod/js/Widget-StdMod.js",

101735

"line": 182,

101736

"itemtype": "attribute",

101737

"name": "fillHeight",

101738

"type": "{String}",

101739

"default": "WidgetStdMod.BODY",

101740

"description": "The section (WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER) which should be resized to fill the height of the standard module, when a\nheight is set on the Widget. If a height is not set on the widget, then all sections are sized based on\ntheir content.",

101741

"class": "WidgetStdMod",

101742

"module": "widget-stdmod"

101743

},

101744

{

101745

"file": "widget-stdmod/js/Widget-StdMod.js",

101746

"line": 198,

101747

"description": "The HTML parsing rules for the WidgetStdMod class.",

101748

"itemtype": "property",

101749

"name": "HTML_PARSER",

101750

"static": 1,

101751

"type": "Object",

101752

"class": "WidgetStdMod",

101753

"module": "widget-stdmod"

101754

},

101755

{

101756

"file": "widget-stdmod/js/Widget-StdMod.js",

101757

"line": 219,

101758

"description": "Static hash of default class names used for the header,\nbody and footer sections of the standard module, keyed by\nthe section identifier (WidgetStdMod.STD_HEADER, WidgetStdMod.STD_BODY, WidgetStdMod.STD_FOOTER)",

101759

"itemtype": "property",

101760

"name": "SECTION_CLASS_NAMES",

101761

"static": 1,

101762

"type": "Object",

101763

"class": "WidgetStdMod",

101764

"module": "widget-stdmod"

101765

},

101766

{

101767

"file": "widget-stdmod/js/Widget-StdMod.js",

101768

"line": 234,

101769

"description": "The template HTML strings for each of the standard module sections. Section entries are keyed by the section constants,\nWidgetStdMod.HEADER, WidgetStdMod.BODY, WidgetStdMod.FOOTER, and contain the HTML to be added for each section.\ne.g.\n<pre>\n {\n header : '<div class=\"yui-widget-hd\"></div>',\n body : '<div class=\"yui-widget-bd\"></div>',\n footer : '<div class=\"yui-widget-ft\"></div>'\n }\n</pre>",

101770

"itemtype": "property",

101771

"name": "TEMPLATES",

101772

"type": "Object",

101773

"static": 1,

101774

"class": "WidgetStdMod",

101775

"module": "widget-stdmod"

101776

},

101777

{

101778

"file": "widget-stdmod/js/Widget-StdMod.js",

101779

"line": 257,

101780

"description": "Synchronizes the UI to match the Widgets standard module state.\n\nThis method is invoked after syncUI is invoked for the Widget class\nusing YUI's aop infrastructure.\n",

101781

"itemtype": "method",

101782

"name": "_syncUIStdMod",

101783

"access": "protected",

101784

"tagname": "",

101785

"class": "WidgetStdMod",

101786

"module": "widget-stdmod"

101787

},

101788

{

101789

"file": "widget-stdmod/js/Widget-StdMod.js",

101790

"line": 284,

101791

"description": "Creates/Initializes the DOM for standard module support.\n\nThis method is invoked after renderUI is invoked for the Widget class\nusing YUI's aop infrastructure.\n",

101792

"itemtype": "method",

101793

"name": "_renderUIStdMod",

101794

"access": "protected",

101795

"tagname": "",

101796

"class": "WidgetStdMod",

101797

"module": "widget-stdmod"

101798

},

101799

{

101800

"file": "widget-stdmod/js/Widget-StdMod.js",

101801

"line": 310,

101802

"description": "Binds event listeners responsible for updating the UI state in response to\nWidget standard module related state changes.\n\nThis method is invoked after bindUI is invoked for the Widget class\nusing YUI's aop infrastructure.\n",

101803

"itemtype": "method",

101804

"name": "_bindUIStdMod",

101805

"access": "protected",

101806

"tagname": "",

101807

"class": "WidgetStdMod",

101808

"module": "widget-stdmod"

101809

},

101810

{

101811

"file": "widget-stdmod/js/Widget-StdMod.js",

101812

"line": 330,

101813

"description": "Default attribute change listener for the headerContent attribute, responsible\nfor updating the UI, in response to attribute changes.",

101814

"itemtype": "method",

101815

"name": "_afterHeaderChange",

101816

"access": "protected",

101817

"tagname": "",

101818

"params": [

101819

{

101820

"name": "e",

101821

"description": "The event facade for the attribute change",

101822

"type": "EventFacade"

101823

}

101824

],

101825

"class": "WidgetStdMod",

101826

"module": "widget-stdmod"

101827

},

101828

{

101829

"file": "widget-stdmod/js/Widget-StdMod.js",

101830

"line": 344,

101831

"description": "Default attribute change listener for the bodyContent attribute, responsible\nfor updating the UI, in response to attribute changes.",

101832

"itemtype": "method",

101833

"name": "_afterBodyChange",

101834

"access": "protected",

101835

"tagname": "",

101836

"params": [

101837

{

101838

"name": "e",

101839

"description": "The event facade for the attribute change",

101840

"type": "EventFacade"

101841

}

101842

],

101843

"class": "WidgetStdMod",

101844

"module": "widget-stdmod"

101845

},

101846

{

101847

"file": "widget-stdmod/js/Widget-StdMod.js",

101848

"line": 358,

101849

"description": "Default attribute change listener for the footerContent attribute, responsible\nfor updating the UI, in response to attribute changes.",

101850

"itemtype": "method",

101851

"name": "_afterFooterChange",

101852

"access": "protected",

101853

"tagname": "",

101854

"params": [

101855

{

101856

"name": "e",

101857

"description": "The event facade for the attribute change",

101858

"type": "EventFacade"

101859

}

101860

],

101861

"class": "WidgetStdMod",

101862

"module": "widget-stdmod"

101863

},

101864

{

101865

"file": "widget-stdmod/js/Widget-StdMod.js",

101866

"line": 372,

101867

"description": "Default attribute change listener for the fillHeight attribute, responsible\nfor updating the UI, in response to attribute changes.",

101868

"itemtype": "method",

101869

"name": "_afterFillHeightChange",

101870

"access": "protected",

101871

"tagname": "",

101872

"params": [

101873

{

101874

"name": "e",

101875

"description": "The event facade for the attribute change",

101876

"type": "EventFacade"

101877

}

101878

],

101879

"class": "WidgetStdMod",

101880

"module": "widget-stdmod"

101881

},

101882

{

101883

"file": "widget-stdmod/js/Widget-StdMod.js",

101884

"line": 384,

101885

"description": "Default validator for the fillHeight attribute. Verifies that the\nvalue set is a valid section specifier - one of WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER,\nor a falsey value if fillHeight is to be disabled.",

101886

"itemtype": "method",

101887

"name": "_validateFillHeight",

101888

"access": "protected",

101889

"tagname": "",

101890

"params": [

101891

{

101892

"name": "val",

101893

"description": "The section which should be setup to fill height, or false/null to disable fillHeight",

101894

"type": "String"

101895

}

101896

],

101897

"return": {

101898

"description": "true if valid, false if not"

101899

},

101900

"class": "WidgetStdMod",

101901

"module": "widget-stdmod"

101902

},

101903

{

101904

"file": "widget-stdmod/js/Widget-StdMod.js",

101905

"line": 398,

101906

"description": "Updates the rendered UI, to resize the provided section so that the standard module fills out\nthe specified widget height. Note: This method does not check whether or not a height is set\non the Widget.",

101907

"itemtype": "method",

101908

"name": "_uiSetFillHeight",

101909

"access": "protected",

101910

"tagname": "",

101911

"params": [

101912

{

101913

"name": "fillSection",

101914

"description": "A valid section specifier - one of WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER",

101915

"type": "String"

101916

}

101917

],

101918

"class": "WidgetStdMod",

101919

"module": "widget-stdmod"

101920

},

101921

{

101922

"file": "widget-stdmod/js/Widget-StdMod.js",

101923

"line": 422,

101924

"description": "Updates the rendered UI, to resize the current section specified by the fillHeight attribute, so\nthat the standard module fills out the Widget height. If a height has not been set on Widget,\nthe section is not resized (height is set to \"auto\").",

101925

"itemtype": "method",

101926

"name": "_fillHeight",

101927

"access": "private",

101928

"tagname": "",

101929

"class": "WidgetStdMod",

101930

"module": "widget-stdmod"

101931

},

101932

{

101933

"file": "widget-stdmod/js/Widget-StdMod.js",

101934

"line": 439,

101935

"description": "Updates the rendered UI, adding the provided content (either an HTML string, or node reference),\nto the specified section. The content is either added before, after or replaces existing content\nin the section, based on the value of the <code>where</code> argument.",

101936

"itemtype": "method",

101937

"name": "_uiSetStdMod",

101938

"access": "protected",

101939

"tagname": "",

101940

"params": [

101941

{

101942

"name": "section",

101943

"description": "The section to be updated. Either WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER.",

101944

"type": "String"

101945

},

101946

{

101947

"name": "content",

101948

"description": "The new content (either as an HTML string, or Node reference) to add to the section",

101949

"type": "String | Node"

101950

},

101951

{

101952

"name": "where",

101953

"description": "Optional. Either WidgetStdMod.AFTER, WidgetStdMod.BEFORE or WidgetStdMod.REPLACE.\nIf not provided, the content will replace existing content in the section.",

101954

"type": "String"

101955

}

101956

],

101957

"class": "WidgetStdMod",

101958

"module": "widget-stdmod"

101959

},

101960

{

101961

"file": "widget-stdmod/js/Widget-StdMod.js",

101962

"line": 466,

101963

"description": "Creates the DOM node for the given section, and inserts it into the correct location in the contentBox.",

101964

"itemtype": "method",

101965

"name": "_renderStdMod",

101966

"access": "protected",

101967

"tagname": "",

101968

"params": [

101969

{

101970

"name": "section",

101971

"description": "The section to create/render. Either WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER.",

101972

"type": "String"

101973

}

101974

],

101975

"return": {

101976

"description": "A reference to the added section node",

101977

"type": "Node"

101978

},

101979

"class": "WidgetStdMod",

101980

"module": "widget-stdmod"

101981

},

101982

{

101983

"file": "widget-stdmod/js/Widget-StdMod.js",

101984

"line": 489,

101985

"description": "Removes the DOM node for the given section.",

101986

"itemtype": "method",

101987

"name": "_eraseStdMod",

101988

"access": "protected",

101989

"tagname": "",

101990

"params": [

101991

{

101992

"name": "section",

101993

"description": "The section to remove. Either WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER.",

101994

"type": "String"

101995

}

101996

],

101997

"class": "WidgetStdMod",

101998

"module": "widget-stdmod"

101999

},

102000

{

102001

"file": "widget-stdmod/js/Widget-StdMod.js",

102002

"line": 504,

102003

"description": "Helper method to insert the Node for the given section into the correct location in the contentBox.",

102004

"itemtype": "method",

102005

"name": "_insertStdModSection",

102006

"access": "private",

102007

"tagname": "",

102008

"params": [

102009

{

102010

"name": "contentBox",

102011

"description": "A reference to the Widgets content box.",

102012

"type": "Node"

102013

},

102014

{

102015

"name": "section",

102016

"description": "The section to create/render. Either WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER.",

102017

"type": "String"

102018

},

102019

{

102020

"name": "sectionNode",

102021

"description": "The Node for the section.",

102022

"type": "Node"

102023

}

102024

],

102025

"class": "WidgetStdMod",

102026

"module": "widget-stdmod"

102027

},

102028

{

102029

"file": "widget-stdmod/js/Widget-StdMod.js",

102030

"line": 532,

102031

"description": "Gets a new Node reference for the given standard module section, by cloning\nthe stored template node.",

102032

"itemtype": "method",

102033

"name": "_getStdModTemplate",

102034

"access": "protected",

102035

"tagname": "",

102036

"params": [

102037

{

102038

"name": "section",

102039

"description": "The section to create a new node for. Either WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER.",

102040

"type": "String"

102041

}

102042

],

102043

"return": {

102044

"description": "The new Node instance for the section",

102045

"type": "Node"

102046

},

102047

"class": "WidgetStdMod",

102048

"module": "widget-stdmod"

102049

},

102050

{

102051

"file": "widget-stdmod/js/Widget-StdMod.js",

102052

"line": 545,

102053

"description": "Helper method to add content to a StdMod section node.\nThe content is added either before, after or replaces the existing node content\nbased on the value of the <code>where</code> argument.",

102054

"itemtype": "method",

102055

"name": "_addStdModContent",

102056

"access": "private",

102057

"tagname": "",

102058

"params": [

102059

{

102060

"name": "node",

102061

"description": "The section Node to be updated.",

102062

"type": "Node"

102063

},

102064

{

102065

"name": "children",

102066

"description": "The new content Node, NodeList or String to be added to section Node provided.",

102067

"type": "Node|NodeList|String"

102068

},

102069

{

102070

"name": "where",

102071

"description": "Optional. Either WidgetStdMod.AFTER, WidgetStdMod.BEFORE or WidgetStdMod.REPLACE.\nIf not provided, the content will replace existing content in the Node.",

102072

"type": "String"

102073

}

102074

],

102075

"class": "WidgetStdMod",

102076

"module": "widget-stdmod"

102077

},

102078

{

102079

"file": "widget-stdmod/js/Widget-StdMod.js",

102080

"line": 575,

102081

"description": "Helper method to obtain the precise height of the node provided, including padding and border.\nThe height could be a sub-pixel value for certain browsers, such as Firefox 3.",

102082

"itemtype": "method",

102083

"name": "_getPreciseHeight",

102084

"access": "private",

102085

"tagname": "",

102086

"params": [

102087

{

102088

"name": "node",

102089

"description": "The node for which the precise height is required.",

102090

"type": "Node"

102091

}

102092

],

102093

"return": {

102094

"description": "The height of the Node including borders and padding, possibly a float.",

102095

"type": "Number"

102096

},

102097

"class": "WidgetStdMod",

102098

"module": "widget-stdmod"

102099

},

102100

{

102101

"file": "widget-stdmod/js/Widget-StdMod.js",

102102

"line": 598,

102103

"description": "Helper method to to find the rendered node for the given section,\nif it exists.",

102104

"itemtype": "method",

102105

"name": "_findStdModSection",

102106

"access": "private",

102107

"tagname": "",

102108

"params": [

102109

{

102110

"name": "section",

102111

"description": "The section for which the render Node is to be found. Either WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER.",

102112

"type": "String"

102113

}

102114

],

102115

"return": {

102116

"description": "The rendered node for the given section, or null if not found.",

102117

"type": "Node"

102118

},

102119

"class": "WidgetStdMod",

102120

"module": "widget-stdmod"

102121

},

102122

{

102123

"file": "widget-stdmod/js/Widget-StdMod.js",

102124

"line": 611,

102125

"description": "Utility method, used by WidgetStdMods HTML_PARSER implementation\nto extract data for each section from markup.",

102126

"itemtype": "method",

102127

"name": "_parseStdModHTML",

102128

"access": "private",

102129

"tagname": "",

102130

"params": [

102131

{

102132

"name": "section",

102133

"description": "",

102134

"type": "String"

102135

}

102136

],

102137

"return": {

102138

"description": "Inner HTML string with the contents of the section",

102139

"type": "String"

102140

},

102141

"class": "WidgetStdMod",

102142

"module": "widget-stdmod"

102143

},

102144

{

102145

"file": "widget-stdmod/js/Widget-StdMod.js",

102146

"line": 637,

102147

"description": "This method is injected before the _applyParsedConfig step in\nthe application of HTML_PARSER, and sets up the state to\nidentify whether or not we should remove the current DOM content\nor not, based on whether or not the current content attribute value\nwas extracted from the DOM, or provided by the user configuration",

102148

"itemtype": "method",

102149

"name": "_applyStdModParsedConfig",

102150

"access": "private",

102151

"tagname": "",

102152

"class": "WidgetStdMod",

102153

"module": "widget-stdmod"

102154

},

102155

{

102156

"file": "widget-stdmod/js/Widget-StdMod.js",

102157

"line": 656,

102158

"description": "Retrieves the child nodes (content) of a standard module section",

102159

"itemtype": "method",

102160

"name": "_getStdModContent",

102161

"access": "private",

102162

"tagname": "",

102163

"params": [

102164

{

102165

"name": "section",

102166

"description": "The standard module section whose child nodes are to be retrieved. Either WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER.",

102167

"type": "String"

102168

}

102169

],

102170

"return": {

102171

"description": "The child node collection of the standard module section.",

102172

"type": "Node"

102173

},

102174

"class": "WidgetStdMod",

102175

"module": "widget-stdmod"

102176

},

102177

{

102178

"file": "widget-stdmod/js/Widget-StdMod.js",

102179

"line": 668,

102180

"description": "Updates the body section of the standard module with the content provided (either an HTML string, or node reference).\n\nThis method can be used instead of the corresponding section content attribute if you'd like to retain the current content of the section,\nand insert content before or after it, by specifying the <code>where</code> argument.\n",

102181

"itemtype": "method",

102182

"name": "setStdModContent",

102183

"params": [

102184

{

102185

"name": "section",

102186

"description": "The standard module section whose content is to be updated. Either WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER.",

102187

"type": "String"

102188

},

102189

{

102190

"name": "content",

102191

"description": "The content to be added, either an HTML string or a Node reference.",

102192

"type": "String | Node"

102193

},

102194

{

102195

"name": "where",

102196

"description": "Optional. Either WidgetStdMod.AFTER, WidgetStdMod.BEFORE or WidgetStdMod.REPLACE.\nIf not provided, the content will replace existing content in the section.",

102197

"type": "String"

102198

}

102199

],

102200

"class": "WidgetStdMod",

102201

"module": "widget-stdmod"

102202

},

102203

{

102204

"file": "widget-stdmod/js/Widget-StdMod.js",

102205

"line": 686,

102206

"description": "Returns the node reference for the specified `section`.\n\n**Note:** The DOM is not queried for the node reference. The reference\nstored by the widget instance is returned if it was set. Passing a\ntruthy for `forceCreate` will create the section node if it does not\nalready exist.",

102207

"itemtype": "method",

102208

"name": "getStdModNode",

102209

"params": [

102210

{

102211

"name": "section",

102212

"description": "The section whose node reference is required.\n Either `WidgetStdMod.HEADER`, `WidgetStdMod.BODY`, or\n `WidgetStdMod.FOOTER`.",

102213

"type": "String"

102214

},

102215

{

102216

"name": "forceCreate",

102217

"description": "Whether the section node should be created\n if it does not already exist.",

102218

"type": "Boolean"

102219

}

102220

],

102221

"return": {

102222

"description": "The node reference for the `section`, or null if not set.",

102223

"type": "Node"

102224

},

102225

"class": "WidgetStdMod",

102226

"module": "widget-stdmod"

102227

},

102228

{

102229

"file": "widget-stdmod/js/Widget-StdMod.js",

102230

"line": 712,

102231

"description": "Sets the height on the provided header, body or footer element to\nfill out the height of the Widget. It determines the height of the\nwidgets bounding box, based on it's configured height value, and\nsets the height of the provided section to fill out any\nspace remaining after the other standard module section heights\nhave been accounted for.\n\nNOTE: This method is not designed to work if an explicit\nheight has not been set on the Widget, since for an \"auto\" height Widget,\nthe heights of the header/body/footer will drive the height of the Widget.",

102232

"itemtype": "method",

102233

"name": "fillHeight",

102234

"params": [

102235

{

102236

"name": "node",

102237

"description": "The node which should be resized to fill out the height\nof the Widget bounding box. Should be a standard module section node which belongs\nto the widget.",

102238

"type": "Node"

102239

}

102240

],

102241

"class": "WidgetStdMod",

102242

"module": "widget-stdmod"

102243

},

102244

{

102245

"file": "widget/js/Widget.js",

102246

"line": 113,

102247

"description": "Static property provides a string to identify the class.\n\nCurrently used to apply class identifiers to the bounding box \nand to classify events fired by the widget.\n",

102248

"itemtype": "property",

102249

"name": "NAME",

102250

"type": "String",

102251

"static": 1,

102252

"class": "Widget",

102253

"module": "widget",

102254

"submodule": "widget-base"

102255

},

102256

{

102257

"file": "widget/js/Widget.js",

102258

"line": 126,

102259

"description": "Constant used to identify state changes originating from\nthe DOM (as opposed to the JavaScript model).",

102260

"itemtype": "property",

102261

"name": "UI_SRC",

102262

"type": "String",

102263

"static": 1,

102264

"final": 1,

102265

"class": "Widget",

102266

"module": "widget",

102267

"submodule": "widget-base"

102268

},

102269

{

102270

"file": "widget/js/Widget.js",

102271

"line": 137,

102272

"description": "Static property used to define the default attribute \nconfiguration for the Widget.",

102273

"itemtype": "property",

102274

"name": "ATTRS",

102275

"type": "Object",

102276

"static": 1,

102277

"class": "Widget",

102278

"module": "widget",

102279

"submodule": "widget-base"

102280

},

102281

{

102282

"file": "widget/js/Widget.js",

102283

"line": 149,

102284

"itemtype": "attribute",

102285

"name": "id",

102286

"writeonce": "",

102287

"default": "Generated using guid()",

102288

"type": "String",

102289

"class": "Widget",

102290

"module": "widget",

102291

"submodule": "widget-base"

102292

},

102293

{

102294

"file": "widget/js/Widget.js",

102295

"line": 161,

102296

"description": "Flag indicating whether or not this Widget\nhas been through the render lifecycle phase.",

102297

"itemtype": "attribute",

102298

"name": "rendered",

102299

"readonly": "",

102300

"default": "false",

102301

"type": "boolean",

102302

"class": "Widget",

102303

"module": "widget",

102304

"submodule": "widget-base"

102305

},

102306

{

102307

"file": "widget/js/Widget.js",

102308

"line": 175,

102309

"itemtype": "attribute",

102310

"name": "boundingBox",

102311

"description": "The outermost DOM node for the Widget, used for sizing and positioning \nof a Widget as well as a containing element for any decorator elements used \nfor skinning.",

102312

"type": "String | Node",

102313

"writeonce": "",

102314

"class": "Widget",

102315

"module": "widget",

102316

"submodule": "widget-base"

102317

},

102318

{

102319

"file": "widget/js/Widget.js",

102320

"line": 189,

102321

"itemtype": "attribute",

102322

"name": "contentBox",

102323

"description": "A DOM node that is a direct descendant of a Widget's bounding box that \nhouses its content.",

102324

"type": "String | Node",

102325

"writeonce": "",

102326

"class": "Widget",

102327

"module": "widget",

102328

"submodule": "widget-base"

102329

},

102330

{

102331

"file": "widget/js/Widget.js",

102332

"line": 202,

102333

"itemtype": "attribute",

102334

"name": "tabIndex",

102335

"description": "Number (between -32767 to 32767) indicating the widget's \nposition in the default tab flow. The value is used to set the \n\"tabIndex\" attribute on the widget's bounding box. Negative values allow\nthe widget to receive DOM focus programmatically (by calling the focus\nmethod), while being removed from the default tab flow. A value of \nnull removes the \"tabIndex\" attribute from the widget's bounding box.",

102336

"type": "Number",

102337

"default": "null",

102338

"class": "Widget",

102339

"module": "widget",

102340

"submodule": "widget-base"

102341

},

102342

{

102343

"file": "widget/js/Widget.js",

102344

"line": 218,

102345

"itemtype": "attribute",

102346

"name": "focused",

102347

"description": "Boolean indicating if the Widget, or one of its descendants, \nhas focus.",

102348

"readonly": "",

102349

"default": "false",

102350

"type": "boolean",

102351

"class": "Widget",

102352

"module": "widget",

102353

"submodule": "widget-base"

102354

},

102355

{

102356

"file": "widget/js/Widget.js",

102357

"line": 231,

102358

"itemtype": "attribute",

102359

"name": "disabled",

102360

"description": "Boolean indicating if the Widget should be disabled. The disabled implementation\nis left to the specific classes extending widget.",

102361

"default": "false",

102362

"type": "boolean",

102363

"class": "Widget",

102364

"module": "widget",

102365

"submodule": "widget-base"

102366

},

102367

{

102368

"file": "widget/js/Widget.js",

102369

"line": 242,

102370

"itemtype": "attribute",

102371

"name": "visible",

102372

"description": "Boolean indicating weather or not the Widget is visible.",

102373

"default": "TRUE",

102374

"type": "boolean",

102375

"class": "Widget",

102376

"module": "widget",

102377

"submodule": "widget-base"

102378

},

102379

{

102380

"file": "widget/js/Widget.js",

102381

"line": 252,

102382

"itemtype": "attribute",

102383

"name": "height",

102384

"description": "String with units, or number, representing the height of the Widget. If a number is provided,\nthe default unit, defined by the Widgets DEF_UNIT, property is used.",

102385

"default": "EMPTY_STR",

102386

"type": "{String | Number}",

102387

"class": "Widget",

102388

"module": "widget",

102389

"submodule": "widget-base"

102390

},

102391

{

102392

"file": "widget/js/Widget.js",

102393

"line": 263,

102394

"itemtype": "attribute",

102395

"name": "width",

102396

"description": "String with units, or number, representing the width of the Widget. If a number is provided,\nthe default unit, defined by the Widgets DEF_UNIT, property is used.",

102397

"default": "EMPTY_STR",

102398

"type": "{String | Number}",

102399

"class": "Widget",

102400

"module": "widget",

102401

"submodule": "widget-base"

102402

},

102403

{

102404

"file": "widget/js/Widget.js",

102405

"line": 274,

102406

"itemtype": "attribute",

102407

"name": "strings",

102408

"description": "Collection of strings used to label elements of the Widget's UI.",

102409

"default": "null",

102410

"type": "Object",

102411

"class": "Widget",

102412

"module": "widget",

102413

"submodule": "widget-base"

102414

},

102415

{

102416

"file": "widget/js/Widget.js",

102417

"line": 286,

102418

"description": "Whether or not to render the widget automatically after init, and optionally, to which parent node.",

102419

"itemtype": "attribute",

102420

"name": "render",

102421

"type": "boolean | Node",

102422

"writeonce": "",

102423

"class": "Widget",

102424

"module": "widget",

102425

"submodule": "widget-base"

102426

},

102427

{

102428

"file": "widget/js/Widget.js",

102429

"line": 298,

102430

"description": "The css prefix which the static Widget.getClassName method should use when constructing class names",

102431

"itemtype": "property",

102432

"name": "CSS_PREFIX",

102433

"type": "String",

102434

"default": "Widget.NAME.toLowerCase()",

102435

"access": "private",

102436

"tagname": "",

102437

"static": 1,

102438

"class": "Widget",

102439

"module": "widget",

102440

"submodule": "widget-base"

102441

},

102442

{

102443

"file": "widget/js/Widget.js",

102444

"line": 309,

102445

"description": "Generate a standard prefixed classname for the Widget, prefixed by the default prefix defined\nby the <code>Y.config.classNamePrefix</code> attribute used by <code>ClassNameManager</code> and \n<code>Widget.NAME.toLowerCase()</code> (e.g. \"yui-widget-xxxxx-yyyyy\", based on default values for \nthe prefix and widget class name).\n\nThe instance based version of this method can be used to generate standard prefixed classnames,\nbased on the instances NAME, as opposed to Widget.NAME. This method should be used when you\nneed to use a constant class name across different types instances.\n",

102446

"itemtype": "method",

102447

"name": "getClassName",

102448

"params": [

102449

{

102450

"name": "args",

102451

"description": "0..n strings which should be concatenated, using the default separator defined by ClassNameManager, to create the class name",

102452

"type": "String*",

102453

"multiple": true

102454

}

102455

],

102456

"class": "Widget",

102457

"module": "widget",

102458

"submodule": "widget-base"

102459

},

102460

{

102461

"file": "widget/js/Widget.js",

102462

"line": 329,

102463

"description": "Returns the widget instance whose bounding box contains, or is, the given node. \n\nIn the case of nested widgets, the nearest bounding box ancestor is used to\nreturn the widget instance.\n",

102464

"itemtype": "method",

102465

"name": "getByNode",

102466

"static": 1,

102467

"params": [

102468

{

102469

"name": "node",

102470

"description": "The node for which to return a Widget instance. If a selector\nstring is passed in, which selects more than one node, the first node found is used.",

102471

"type": "Node | String"

102472

}

102473

],

102474

"return": {

102475

"description": "Widget instance, or null if not found.",

102476

"type": "Widget"

102477

},

102478

"class": "Widget",

102479

"module": "widget",

102480

"submodule": "widget-base"

102481

},

102482

{

102483

"file": "widget/js/Widget.js",

102484

"line": 360,

102485

"description": "Returns a class name prefixed with the the value of the \n<code>YUI.config.classNamePrefix</code> attribute + the instances <code>NAME</code> property.\nUses <code>YUI.config.classNameDelimiter</code> attribute to delimit the provided strings.\ne.g. \n<code>\n<pre>\n // returns \"yui-slider-foo-bar\", for a slider instance\n var scn = slider.getClassName('foo','bar');\n\n // returns \"yui-overlay-foo-bar\", for an overlay instance\n var ocn = overlay.getClassName('foo','bar');\n</pre>\n</code>",

102486

"itemtype": "method",

102487

"name": "getClassName",

102488

"params": [

102489

{

102490

"name": "+",

102491

"description": "One or more classname bits to be joined and prefixed",

102492

"type": "String"

102493

}

102494

],

102495

"class": "Widget",

102496

"module": "widget",

102497

"submodule": "widget-base"

102498

},

102499

{

102500

"file": "widget/js/Widget.js",

102501

"line": 382,

102502

"description": "Initializer lifecycle implementation for the Widget class. Registers the \nwidget instance, and runs through the Widget's HTML_PARSER definition.",

102503

"itemtype": "method",

102504

"name": "initializer",

102505

"access": "protected",

102506

"tagname": "",

102507

"params": [

102508

{

102509

"name": "config",

102510

"description": "Configuration object literal for the widget",

102511

"type": "Object"

102512

}

102513

],

102514

"class": "Widget",

102515

"module": "widget",

102516

"submodule": "widget-base"

102517

},

102518

{

102519

"file": "widget/js/Widget.js",

102520

"line": 398,

102521

"description": "Notification event, which widget implementations can fire, when\nthey change the content of the widget. This event has no default\nbehavior and cannot be prevented, so the \"on\" or \"after\"\nmoments are effectively equivalent (with on listeners being invoked before \nafter listeners).",

102522

"itemtype": "event",

102523

"name": "widget:contentUpdate",

102524

"preventable": "false",

102525

"params": [

102526

{

102527

"name": "e",

102528

"description": "The Event Facade",

102529

"type": "EventFacade"

102530

}

102531

],

102532

"class": "Widget",

102533

"module": "widget",

102534

"submodule": "widget-base"

102535

},

102536

{

102537

"file": "widget/js/Widget.js",

102538

"line": 415,

102539

"description": "Utility method used to add an entry to the boundingBox id to instance map. \n\nThis method can be used to populate the instance with lazily created boundingBox Node references.",

102540

"itemtype": "method",

102541

"name": "_mapInstance",

102542

"params": [

102543

{

102544

"name": "The",

102545

"description": "boundingBox id",

102546

"type": "String"

102547

}

102548

],

102549

"access": "protected",

102550

"tagname": "",

102551

"class": "Widget",

102552

"module": "widget",

102553

"submodule": "widget-base"

102554

},

102555

{

102556

"file": "widget/js/Widget.js",

102557

"line": 430,

102558

"description": "Destructor lifecycle implementation for the Widget class. Purges events attached\nto the bounding box and content box, removes them from the DOM and removes \nthe Widget from the list of registered widgets.",

102559

"itemtype": "method",

102560

"name": "destructor",

102561

"access": "protected",

102562

"tagname": "",

102563

"class": "Widget",

102564

"module": "widget",

102565

"submodule": "widget-base"

102566

},

102567

{

102568

"file": "widget/js/Widget.js",

102569

"line": 455,

102570

"description": "\nDestroy lifecycle method. Fires the destroy\nevent, prior to invoking destructors for the\nclass hierarchy.\n\nOverrides Base's implementation, to support arguments to destroy\n\n\nSubscribers to the destroy\nevent can invoke preventDefault on the event object, to prevent destruction\nfrom proceeding.\n",

102571

"itemtype": "method",

102572

"name": "destroy",

102573

"params": [

102574

{

102575

"name": "destroyAllNodes",

102576

"description": "If true, all nodes contained within the Widget are removed and destroyed. Defaults to false due to potentially high run-time cost.",

102577

"type": "Boolean"

102578

}

102579

],

102580

"return": {

102581

"description": "A reference to this object",

102582

"type": "Widget"

102583

},

102584

"chainable": 1,

102585

"class": "Widget",

102586

"module": "widget",

102587

"submodule": "widget-base"

102588

},

102589

{

102590

"file": "widget/js/Widget.js",

102591

"line": 478,

102592

"description": "Removes and destroys the widgets rendered boundingBox, contentBox,\nand detaches bound UI events.",

102593

"itemtype": "method",

102594

"name": "_destroyBox",

102595

"access": "protected",

102596

"tagname": "",

102597

"class": "Widget",

102598

"module": "widget",

102599

"submodule": "widget-base"

102600

},

102601

{

102602

"file": "widget/js/Widget.js",

102603

"line": 514,

102604

"description": "Establishes the initial DOM for the widget. Invoking this\nmethod will lead to the creating of all DOM elements for\nthe widget (or the manipulation of existing DOM elements \nfor the progressive enhancement use case).\n\nThis method should only be invoked once for an initialized\nwidget.\n\n\nIt delegates to the widget specific renderer method to do\nthe actual work.\n",

102605

"itemtype": "method",

102606

"name": "render",

102607

"chainable": 1,

102608

"final": 1,

102609

"params": [

102610

{

102611

"name": "parentNode",

102612

"description": "Optional. The Node under which the \nWidget is to be rendered. This can be a Node instance or a CSS selector string. \n\nIf the selector string returns more than one Node, the first node will be used \nas the parentNode. NOTE: This argument is required if both the boundingBox and contentBox\nare not currently in the document. If it's not provided, the Widget will be rendered\nto the body of the current document in this case.\n",

102613

"type": "Object | String"

102614

}

102615

],

102616

"class": "Widget",

102617

"module": "widget",

102618

"submodule": "widget-base"

102619

},

102620

{

102621

"file": "widget/js/Widget.js",

102622

"line": 544,

102623

"description": "Lifecycle event for the render phase, fired prior to rendering the UI \nfor the widget (prior to invoking the widget's renderer method).\n\nSubscribers to the \"on\" moment of this event, will be notified \nbefore the widget is rendered.\n\n\nSubscribers to the \"after\" moment of this event, will be notified\nafter rendering is complete.\n",

102624

"itemtype": "event",

102625

"name": "widget:render",

102626

"preventable": "_defRenderFn",

102627

"params": [

102628

{

102629

"name": "e",

102630

"description": "The Event Facade",

102631

"type": "EventFacade"

102632

}

102633

],

102634

"class": "Widget",

102635

"module": "widget",

102636

"submodule": "widget-base"

102637

},

102638

{

102639

"file": "widget/js/Widget.js",

102640

"line": 572,

102641

"description": "Default render handler",

102642

"itemtype": "method",

102643

"name": "_defRenderFn",

102644

"access": "protected",

102645

"tagname": "",

102646

"params": [

102647

{

102648

"name": "e",

102649

"description": "The Event object",

102650

"type": "EventFacade"

102651

},

102652

{

102653

"name": "parentNode",

102654

"description": "The parent node to render to, if passed in to the <code>render</code> method",

102655

"type": "Node"

102656

}

102657

],

102658

"class": "Widget",

102659

"module": "widget",

102660

"submodule": "widget-base"

102661

},

102662

{

102663

"file": "widget/js/Widget.js",

102664

"line": 589,

102665

"description": "Creates DOM (or manipulates DOM for progressive enhancement)\nThis method is invoked by render() and is not chained \nautomatically for the class hierarchy (unlike initializer, destructor) \nso it should be chained manually for subclasses if required.",

102666

"itemtype": "method",

102667

"name": "renderer",

102668

"access": "protected",

102669

"tagname": "",

102670

"class": "Widget",

102671

"module": "widget",

102672

"submodule": "widget-base"

102673

},

102674

{

102675

"file": "widget/js/Widget.js",

102676

"line": 612,

102677

"description": "Configures/Sets up listeners to bind Widget State to UI/DOM\n\nThis method is not called by framework and is not chained \nautomatically for the class hierarchy.",

102678

"itemtype": "method",

102679

"name": "bindUI",

102680

"access": "protected",

102681

"tagname": "",

102682

"class": "Widget",

102683

"module": "widget",

102684

"submodule": "widget-base"

102685

},

102686

{

102687

"file": "widget/js/Widget.js",

102688

"line": 623,

102689

"description": "Adds nodes to the DOM \n\nThis method is not called by framework and is not chained \nautomatically for the class hierarchy.",

102690

"itemtype": "method",

102691

"name": "renderUI",

102692

"access": "protected",

102693

"tagname": "",

102694

"class": "Widget",

102695

"module": "widget",

102696

"submodule": "widget-base"

102697

},

102698

{

102699

"file": "widget/js/Widget.js",

102700

"line": 634,

102701

"description": "Refreshes the rendered UI, based on Widget State\n\nThis method is not called by framework and is not chained\nautomatically for the class hierarchy.",

102702

"itemtype": "method",

102703

"name": "syncUI",

102704

"access": "protected",

102705

"tagname": "",

102706

"class": "Widget",

102707

"module": "widget",

102708

"submodule": "widget-base"

102709

},

102710

{

102711

"file": "widget/js/Widget.js",

102712

"line": 646,

102713

"itemtype": "method",

102714

"name": "hide",

102715

"description": "Hides the Widget by setting the \"visible\" attribute to \"false\".",

102716

"chainable": 1,

102717

"class": "Widget",

102718

"module": "widget",

102719

"submodule": "widget-base"

102720

},

102721

{

102722

"file": "widget/js/Widget.js",

102723

"line": 655,

102724

"itemtype": "method",

102725

"name": "show",

102726

"description": "Shows the Widget by setting the \"visible\" attribute to \"true\".",

102727

"chainable": 1,

102728

"class": "Widget",

102729

"module": "widget",

102730

"submodule": "widget-base"

102731

},

102732

{

102733

"file": "widget/js/Widget.js",

102734

"line": 664,

102735

"itemtype": "method",

102736

"name": "focus",

102737

"description": "Causes the Widget to receive the focus by setting the \"focused\" \nattribute to \"true\".",

102738

"chainable": 1,

102739

"class": "Widget",

102740

"module": "widget",

102741

"submodule": "widget-base"

102742

},

102743

{

102744

"file": "widget/js/Widget.js",

102745

"line": 674,

102746

"itemtype": "method",

102747

"name": "blur",

102748

"description": "Causes the Widget to lose focus by setting the \"focused\" attribute \nto \"false\"",

102749

"chainable": 1,

102750

"class": "Widget",

102751

"module": "widget",

102752

"submodule": "widget-base"

102753

},

102754

{

102755

"file": "widget/js/Widget.js",

102756

"line": 684,

102757

"itemtype": "method",

102758

"name": "enable",

102759

"description": "Set the Widget's \"disabled\" attribute to \"false\".",

102760

"chainable": 1,

102761

"class": "Widget",

102762

"module": "widget",

102763

"submodule": "widget-base"

102764

},

102765

{

102766

"file": "widget/js/Widget.js",

102767

"line": 693,

102768

"itemtype": "method",

102769

"name": "disable",

102770

"description": "Set the Widget's \"disabled\" attribute to \"true\".",

102771

"chainable": 1,

102772

"class": "Widget",

102773

"module": "widget",

102774

"submodule": "widget-base"

102775

},

102776

{

102777

"file": "widget/js/Widget.js",

102778

"line": 702,

102779

"itemtype": "method",

102780

"name": "_uiSizeCB",

102781

"access": "protected",

102782

"tagname": "",

102783

"params": [

102784

{

102785

"name": "expand",

102786

"description": "",

102787

"type": "Boolean"

102788

}

102789

],

102790

"class": "Widget",

102791

"module": "widget",

102792

"submodule": "widget-base"

102793

},

102794

{

102795

"file": "widget/js/Widget.js",

102796

"line": 711,

102797

"description": "Helper method to collect the boundingBox and contentBox and append to the provided parentNode, if not\nalready a child. The owner document of the boundingBox, or the owner document of the contentBox will be used \nas the document into which the Widget is rendered if a parentNode is node is not provided. If both the boundingBox and\nthe contentBox are not currently in the document, and no parentNode is provided, the widget will be rendered \nto the current document's body.",

102798

"itemtype": "method",

102799

"name": "_renderBox",

102800

"access": "private",

102801

"tagname": "",

102802

"params": [

102803

{

102804

"name": "parentNode",

102805

"description": "The parentNode to render the widget to. If not provided, and both the boundingBox and\nthe contentBox are not currently in the document, the widget will be rendered to the current document's body.",

102806

"type": "Node"

102807

}

102808

],

102809

"class": "Widget",

102810

"module": "widget",

102811

"submodule": "widget-base"

102812

},

102813

{

102814

"file": "widget/js/Widget.js",

102815

"line": 757,

102816

"description": "Setter for the boundingBox attribute",

102817

"itemtype": "method",

102818

"name": "_setBB",

102819

"access": "private",

102820

"tagname": "",

102821

"params": [

102822

{

102823

"name": "Node/String",

102824

"description": ""

102825

}

102826

],

102827

"return": {

102828

"description": "Node"

102829

},

102830

"class": "Widget",

102831

"module": "widget",

102832

"submodule": "widget-base"

102833

},

102834

{

102835

"file": "widget/js/Widget.js",

102836

"line": 769,

102837

"description": "Setter for the contentBox attribute",

102838

"itemtype": "method",

102839

"name": "_setCB",

102840

"access": "private",

102841

"tagname": "",

102842

"params": [

102843

{

102844

"name": "node",

102845

"description": "",

102846

"type": "Node|String"

102847

}

102848

],

102849

"return": {

102850

"description": "Node"

102851

},

102852

"class": "Widget",

102853

"module": "widget",

102854

"submodule": "widget-base"

102855

},

102856

{

102857

"file": "widget/js/Widget.js",

102858

"line": 781,

102859

"description": "Returns the default value for the contentBox attribute. \n\nFor the Widget class, this will be the srcNode if provided, otherwise null (resulting in\na new contentBox node instance being created)",

102860

"itemtype": "method",

102861

"name": "_defaultCB",

102862

"access": "protected",

102863

"tagname": "",

102864

"class": "Widget",

102865

"module": "widget",

102866

"submodule": "widget-base"

102867

},

102868

{

102869

"file": "widget/js/Widget.js",

102870

"line": 794,

102871

"description": "Helper method to set the bounding/content box, or create it from\nthe provided template if not found.",

102872

"itemtype": "method",

102873

"name": "_setBox",

102874

"access": "private",

102875

"tagname": "",

102876

"params": [

102877

{

102878

"name": "id",

102879

"description": "The node's id attribute",

102880

"type": "String"

102881

},

102882

{

102883

"name": "node",

102884

"description": "The node reference",

102885

"type": "Node|String"

102886

},

102887

{

102888

"name": "template",

102889

"description": "HTML string template for the node",

102890

"type": "String"

102891

}

102892

],

102893

"return": {

102894

"description": "The node",

102895

"type": "Node"

102896

},

102897

"class": "Widget",

102898

"module": "widget",

102899

"submodule": "widget-base"

102900

},

102901

{

102902

"file": "widget/js/Widget.js",

102903

"line": 814,

102904

"description": "Initializes the UI state for the Widget's bounding/content boxes.",

102905

"itemtype": "method",

102906

"name": "_renderUI",

102907

"access": "protected",

102908

"tagname": "",

102909

"class": "Widget",

102910

"module": "widget",

102911

"submodule": "widget-base"

102912

},

102913

{

102914

"file": "widget/js/Widget.js",

102915

"line": 825,

102916

"description": "Applies standard class names to the boundingBox and contentBox",

102917

"itemtype": "method",

102918

"name": "_renderBoxClassNames",

102919

"access": "protected",

102920

"tagname": "",

102921

"class": "Widget",

102922

"module": "widget",

102923

"submodule": "widget-base"

102924

},

102925

{

102926

"file": "widget/js/Widget.js",

102927

"line": 849,

102928

"description": "Removes class names representative of the widget's loading state from \nthe boundingBox.",

102929

"itemtype": "method",

102930

"name": "_removeLoadingClassNames",

102931

"access": "protected",

102932

"tagname": "",

102933

"class": "Widget",

102934

"module": "widget",

102935

"submodule": "widget-base"

102936

},

102937

{

102938

"file": "widget/js/Widget.js",

102939

"line": 870,

102940

"description": "Sets up DOM and CustomEvent listeners for the widget.",

102941

"itemtype": "method",

102942

"name": "_bindUI",

102943

"access": "protected",

102944

"tagname": "",

102945

"class": "Widget",

102946

"module": "widget",

102947

"submodule": "widget-base"

102948

},

102949

{

102950

"file": "widget/js/Widget.js",

102951

"line": 881,

102952

"itemtype": "method",

102953

"name": "_unbindUI",

102954

"access": "protected",

102955

"tagname": "",

102956

"class": "Widget",

102957

"module": "widget",

102958

"submodule": "widget-base"

102959

},

102960

{

102961

"file": "widget/js/Widget.js",

102962

"line": 889,

102963

"description": "Sets up DOM listeners, on elements rendered by the widget.",

102964

"itemtype": "method",

102965

"name": "_bindDOM",

102966

"access": "protected",

102967

"tagname": "",

102968

"class": "Widget",

102969

"module": "widget",

102970

"submodule": "widget-base"

102971

},

102972

{

102973

"file": "widget/js/Widget.js",

102974

"line": 920,

102975

"itemtype": "method",

102976

"name": "_unbindDOM",

102977

"access": "protected",

102978

"tagname": "",

102979

"class": "Widget",

102980

"module": "widget",

102981

"submodule": "widget-base"

102982

},

102983

{

102984

"file": "widget/js/Widget.js",

102985

"line": 951,

102986

"description": "Updates the widget UI to reflect the attribute state.",

102987

"itemtype": "method",

102988

"name": "_syncUI",

102989

"access": "protected",

102990

"tagname": "",

102991

"class": "Widget",

102992

"module": "widget",

102993

"submodule": "widget-base"

102994

},

102995

{

102996

"file": "widget/js/Widget.js",

102997

"line": 961,

102998

"description": "Sets the height on the widget's bounding box element",

102999

"itemtype": "method",

103000

"name": "_uiSetHeight",

103001

"access": "protected",

103002

"tagname": "",

103003

"params": [

103004

{

103005

"name": "val",

103006

"description": "",

103007

"type": "String | Number"

103008

}

103009

],

103010

"class": "Widget",

103011

"module": "widget",

103012

"submodule": "widget-base"

103013

},

103014

{

103015

"file": "widget/js/Widget.js",

103016

"line": 973,

103017

"description": "Sets the width on the widget's bounding box element",

103018

"itemtype": "method",

103019

"name": "_uiSetWidth",

103020

"access": "protected",

103021

"tagname": "",

103022

"params": [

103023

{

103024

"name": "val",

103025

"description": "",

103026

"type": "String | Number"

103027

}

103028

],

103029

"class": "Widget",

103030

"module": "widget",

103031

"submodule": "widget-base"

103032

},

103033

{

103034

"file": "widget/js/Widget.js",

103035

"line": 984,

103036

"itemtype": "method",

103037

"name": "_uiSetDim",

103038

"access": "private",

103039

"tagname": "",

103040

"params": [

103041

{

103042

"name": "dim",

103043

"description": "The dimension - \"width\" or \"height\"",

103044

"type": "String"

103045

},

103046

{

103047

"name": "val",

103048

"description": "The value to set",

103049

"type": "Number | String"

103050

}

103051

],

103052

"class": "Widget",

103053

"module": "widget",

103054

"submodule": "widget-base"

103055

},

103056

{

103057

"file": "widget/js/Widget.js",

103058

"line": 994,

103059

"description": "Sets the visible state for the UI",

103060

"itemtype": "method",

103061

"name": "_uiSetVisible",

103062

"access": "protected",

103063

"tagname": "",

103064

"params": [

103065

{

103066

"name": "val",

103067

"description": "",

103068

"type": "Boolean"

103069

}

103070

],

103071

"class": "Widget",

103072

"module": "widget",

103073

"submodule": "widget-base"

103074

},

103075

{

103076

"file": "widget/js/Widget.js",

103077

"line": 1005,

103078

"description": "Sets the disabled state for the UI",

103079

"itemtype": "method",

103080

"name": "_uiSetDisabled",

103081

"access": "protected",

103082

"tagname": "",

103083

"params": [

103084

{

103085

"name": "val",

103086

"description": "",

103087

"type": "Boolean"

103088

}

103089

],

103090

"class": "Widget",

103091

"module": "widget",

103092

"submodule": "widget-base"

103093

},

103094

{

103095

"file": "widget/js/Widget.js",

103096

"line": 1016,

103097

"description": "Sets the focused state for the UI",

103098

"itemtype": "method",

103099

"name": "_uiSetFocused",

103100

"access": "protected",

103101

"tagname": "",

103102

"params": [

103103

{

103104

"name": "val",

103105

"description": "",

103106

"type": "Boolean"

103107

},

103108

{

103109

"name": "src",

103110

"description": "String representing the source that triggered an update to \nthe UI.",

103111

"type": "String"

103112

}

103113

],

103114

"class": "Widget",

103115

"module": "widget",

103116

"submodule": "widget-base"

103117

},

103118

{

103119

"file": "widget/js/Widget.js",

103120

"line": 1038,

103121

"description": "Set the tabIndex on the widget's rendered UI",

103122

"itemtype": "method",

103123

"name": "_uiSetTabIndex",

103124

"access": "protected",

103125

"tagname": "",

103126

"params": [

103127

{

103128

"name": "Number",

103129

"description": ""

103130

}

103131

],

103132

"class": "Widget",

103133

"module": "widget",

103134

"submodule": "widget-base"

103135

},

103136

{

103137

"file": "widget/js/Widget.js",

103138

"line": 1055,

103139

"itemtype": "method",

103140

"name": "_onDocMouseDown",

103141

"description": "\"mousedown\" event handler for the owner document of the \nwidget's bounding box.",

103142

"access": "protected",

103143

"tagname": "",

103144

"params": [

103145

{

103146

"name": "evt",

103147

"description": "The event facade for the DOM focus event",

103148

"type": "EventFacade"

103149

}

103150

],

103151

"class": "Widget",

103152

"module": "widget",

103153

"submodule": "widget-base"

103154

},

103155

{

103156

"file": "widget/js/Widget.js",

103157

"line": 1068,

103158

"description": "DOM focus event handler, used to sync the state of the Widget with the DOM",

103159

"itemtype": "method",

103160

"name": "_onDocFocus",

103161

"access": "protected",

103162

"tagname": "",

103163

"params": [

103164

{

103165

"name": "evt",

103166

"description": "The event facade for the DOM focus event",

103167

"type": "EventFacade"

103168

}

103169

],

103170

"class": "Widget",

103171

"module": "widget",

103172

"submodule": "widget-base"

103173

},

103174

{

103175

"file": "widget/js/Widget.js",

103176

"line": 1094,

103177

"description": "Generic toString implementation for all widgets.",

103178

"itemtype": "method",

103179

"name": "toString",

103180

"return": {

103181

"description": "The default string value for the widget [ displays the NAME of the instance, and the unique id ]",

103182

"type": "String"

103183

},

103184

"class": "Widget",

103185

"module": "widget",

103186

"submodule": "widget-base"

103187

},

103188

{

103189

"file": "widget/js/Widget.js",

103190

"line": 1105,

103191

"description": "Default unit to use for dimension values",

103192

"itemtype": "property",

103193

"name": "DEF_UNIT",

103194

"type": "String",

103195

"class": "Widget",

103196

"module": "widget",

103197

"submodule": "widget-base"

103198

},

103199

{

103200

"file": "widget/js/Widget.js",

103201

"line": 1113,

103202

"description": "Default node to render the bounding box to. If not set,\nwill default to the current document body.",

103203

"itemtype": "property",

103204

"name": "DEF_PARENT_NODE",

103205

"type": "String | Node",

103206

"class": "Widget",

103207

"module": "widget",

103208

"submodule": "widget-base"

103209

},

103210

{

103211

"file": "widget/js/Widget.js",

103212

"line": 1122,

103213

"description": "Property defining the markup template for content box. If your Widget doesn't\nneed the dual boundingBox/contentBox structure, set CONTENT_TEMPLATE to null,\nand contentBox and boundingBox will both point to the same Node.",

103214

"itemtype": "property",

103215

"name": "CONTENT_TEMPLATE",

103216

"type": "String",

103217

"class": "Widget",

103218

"module": "widget",

103219

"submodule": "widget-base"

103220

},

103221

{

103222

"file": "widget/js/Widget.js",

103223

"line": 1132,

103224

"description": "Property defining the markup template for bounding box.",

103225

"itemtype": "property",

103226

"name": "BOUNDING_TEMPLATE",

103227

"type": "String",

103228

"class": "Widget",

103229

"module": "widget",

103230

"submodule": "widget-base"

103231

},

103232

{

103233

"file": "widget/js/Widget.js",

103234

"line": 1140,

103235

"itemtype": "method",

103236

"name": "_guid",

103237

"access": "protected",

103238

"tagname": "",

103239

"class": "Widget",

103240

"module": "widget",

103241

"submodule": "widget-base"

103242

},

103243

{

103244

"file": "widget/js/Widget.js",

103245

"line": 1148,

103246

"itemtype": "method",

103247

"name": "_validTabIndex",

103248

"access": "protected",

103249

"tagname": "",

103250

"params": [

103251

{

103252

"name": "tabIndex",

103253

"description": "",

103254

"type": "Number"

103255

}

103256

],

103257

"class": "Widget",

103258

"module": "widget",

103259

"submodule": "widget-base"

103260

},

103261

{

103262

"file": "widget/js/Widget.js",

103263

"line": 1157,

103264

"description": "Binds after listeners for the list of attributes provided",

103265

"itemtype": "method",

103266

"name": "_bindAttrUI",

103267

"access": "private",

103268

"tagname": "",

103269

"params": [

103270

{

103271

"name": "attrs",

103272

"description": "",

103273

"type": "Array"

103274

}

103275

],

103276

"class": "Widget",

103277

"module": "widget",

103278

"submodule": "widget-base"

103279

},

103280

{

103281

"file": "widget/js/Widget.js",

103282

"line": 1173,

103283

"description": "Invokes the _uiSet=ATTR NAME> method for the list of attributes provided",

103284

"itemtype": "method",

103285

"name": "_syncAttrUI",

103286

"access": "private",

103287

"tagname": "",

103288

"params": [

103289

{

103290

"name": "attrs",

103291

"description": "",

103292

"type": "Array"

103293

}

103294

],

103295

"class": "Widget",

103296

"module": "widget",

103297

"submodule": "widget-base"

103298

},

103299

{

103300

"file": "widget/js/Widget.js",

103301

"line": 1188,

103302

"itemtype": "method",

103303

"name": "_setAttrUI",

103304

"access": "private",

103305

"tagname": "",

103306

"params": [

103307

{

103308

"name": "e",

103309

"description": "",

103310

"type": "EventFacade"

103311

}

103312

],

103313

"class": "Widget",

103314

"module": "widget",

103315

"submodule": "widget-base"

103316

},

103317

{

103318

"file": "widget/js/Widget.js",

103319

"line": 1199,

103320

"description": "The default setter for the strings attribute. Merges partial sets\ninto the full string set, to allow users to partial sets of strings",

103321

"itemtype": "method",

103322

"name": "_strSetter",

103323

"access": "protected",

103324

"tagname": "",

103325

"params": [

103326

{

103327

"name": "strings",

103328

"description": "",

103329

"type": "Object"

103330

}

103331

],

103332

"return": {

103333

"description": "The full set of strings to set",

103334

"type": "String"

103335

},

103336

"class": "Widget",

103337

"module": "widget",

103338

"submodule": "widget-base"

103339

},

103340

{

103341

"file": "widget/js/Widget.js",

103342

"line": 1212,

103343

"description": "Helper method to get a specific string value",

103344

"deprecated": true,

103345

"deprecationMessage": "Used by deprecated WidgetLocale implementations.",

103346

"itemtype": "method",

103347

"name": "getString",

103348

"params": [

103349

{

103350

"name": "key",

103351

"description": "",

103352

"type": "String"

103353

}

103354

],

103355

"return": {

103356

"description": "The string",

103357

"type": "String"

103358

},

103359

"class": "Widget",

103360

"module": "widget",

103361

"submodule": "widget-base"

103362

},

103363

{

103364

"file": "widget/js/Widget.js",

103365

"line": 1224,

103366

"description": "Helper method to get the complete set of strings for the widget",

103367

"deprecated": true,

103368

"deprecationMessage": "Used by deprecated WidgetLocale implementations.",

103369

"itemtype": "method",

103370

"name": "getStrings",

103371

"params": [

103372

{

103373

"name": "key",

103374

"description": "",

103375

"type": "String"

103376

}

103377

],

103378

"return": {

103379

"description": "The strings",

103380

"type": "String"

103381

},

103382

"class": "Widget",

103383

"module": "widget",

103384

"submodule": "widget-base"

103385

},

103386

{

103387

"file": "widget/js/Widget.js",

103388

"line": 1236,

103389

"description": "The lists of UI attributes to bind and sync for widget's _bindUI and _syncUI implementations",

103390

"itemtype": "property",

103391

"name": "_UI_ATTRS",

103392

"type": "Object",

103393

"access": "private",

103394

"tagname": "",

103395

"class": "Widget",

103396

"module": "widget",

103397

"submodule": "widget-base"

103398

},

103399

{

103400

"file": "widget/js/WidgetHTMLParser.js",

103401

"line": 17,

103402

"description": "Object hash, defining how attribute values are to be parsed from\nmarkup contained in the widget's content box. e.g.:\n<pre>\n {\n // Set single Node references using selector syntax \n // (selector is run through node.one)\n titleNode: \"span.yui-title\",\n // Set NodeList references using selector syntax \n // (array indicates selector is to be run through node.all)\n listNodes: [\"li.yui-item\"],\n // Set other attribute types, using a parse function. \n // Context is set to the widget instance.\n label: function(contentBox) {\n return contentBox.one(\"span.title\").get(\"innerHTML\");\n }\n }\n</pre>",

103403

"itemtype": "property",

103404

"name": "HTML_PARSER",

103405

"type": "Object",

103406

"static": 1,

103407

"class": "Widget",

103408

"module": "widget",

103409

"submodule": "widget-htmlparser"

103410

},

103411

{

103412

"file": "widget/js/WidgetHTMLParser.js",

103413

"line": 42,

103414

"description": "The build configuration for the Widget class.\n\nDefines the static fields which need to be aggregated,\nwhen this class is used as the main class passed to \nthe <a href=\"Base.html#method_build\">Base.build</a> method.\n",

103415

"itemtype": "property",

103416

"name": "_buildCfg",

103417

"type": "Object",

103418

"static": 1,

103419

"final": 1,

103420

"access": "private",

103421

"tagname": "",

103422

"class": "Widget",

103423

"module": "widget",

103424

"submodule": "widget-htmlparser"

103425

},

103426

{

103427

"file": "widget/js/WidgetHTMLParser.js",

103428

"line": 59,

103429

"description": "The DOM node to parse for configuration values, passed to the Widget's HTML_PARSER definition",

103430

"itemtype": "attribute",

103431

"name": "srcNode",

103432

"type": "String | Node",

103433

"writeonce": "",

103434

"class": "Widget",

103435

"module": "widget",

103436

"submodule": "widget-htmlparser"

103437

},

103438

{

103439

"file": "widget/js/WidgetHTMLParser.js",

103440

"line": 75,

103441

"itemtype": "method",

103442

"name": "_getSrcNode",

103443

"access": "protected",

103444

"tagname": "",

103445

"return": {

103446

"description": "The Node to apply HTML_PARSER to",

103447

"type": "Node"

103448

},

103449

"class": "Widget",

103450

"module": "widget",

103451

"submodule": "widget-htmlparser"

103452

},

103453

{

103454

"file": "widget/js/WidgetHTMLParser.js",

103455

"line": 84,

103456

"itemtype": "method",

103457

"name": "_applyParsedConfig",

103458

"access": "protected",

103459

"tagname": "",

103460

"return": {

103461

"description": "The merged configuration literal",

103462

"type": "Object"

103463

},

103464

"class": "Widget",

103465

"module": "widget",

103466

"submodule": "widget-htmlparser"

103467

},

103468

{

103469

"file": "widget/js/WidgetHTMLParser.js",

103470

"line": 93,

103471

"description": "Utilitity method used to apply the <code>HTML_PARSER</code> configuration for the \ninstance, to retrieve config data values.",

103472

"itemtype": "method",

103473

"name": "_applyParser",

103474

"access": "protected",

103475

"tagname": "",

103476

"params": [

103477

{

103478

"name": "config",

103479

"description": "User configuration object (will be populated with values from Node)",

103480

"type": "Object"

103481

}

103482

],

103483

"class": "Widget",

103484

"module": "widget",

103485

"submodule": "widget-htmlparser"

103486

},

103487

{

103488

"file": "widget/js/WidgetHTMLParser.js",

103489

"line": 135,

103490

"description": "Gets the HTML_PARSER definition for this instance, by merging HTML_PARSER\ndefinitions across the class hierarchy.",

103491

"access": "private",

103492

"tagname": "",

103493

"itemtype": "method",

103494

"name": "_getHtmlParser",

103495

"return": {

103496

"description": "HTML_PARSER definition for this instance",

103497

"type": "Object"

103498

},

103499

"class": "Widget",

103500

"module": "widget",

103501

"submodule": "widget-htmlparser"

103502

},

103503

{

103504

"file": "widget/js/WidgetLocale.js",

103505

"line": 14,

103506

"itemtype": "attribute",

103507

"name": "locale",

103508

"deprecated": true,

103509

"deprecationMessage": "Use Y.config.lang and Y.Intl externalization support",

103510

"description": "The default locale for the widget. NOTE: Using get/set on the \"strings\" attribute will\nreturn/set strings for this locale.",

103511

"default": "\"en\"",

103512

"type": "String",

103513

"class": "Widget",

103514

"module": "widget-locale"

103515

},

103516

{

103517

"file": "widget/js/WidgetLocale.js",

103518

"line": 32,

103519

"description": "Sets strings for a particular locale, merging with any existing\nstrings which may already be defined for the locale.",

103520

"itemtype": "method",

103521

"name": "_setStrings",

103522

"access": "protected",

103523

"tagname": "",

103524

"params": [

103525

{

103526

"name": "strings",

103527

"description": "The hash of string key/values to set",

103528

"type": "Object"

103529

},

103530

{

103531

"name": "locale",

103532

"description": "The locale for the string values being set",

103533

"type": "Object"

103534

}

103535

],

103536

"class": "Widget",

103537

"module": "widget-locale"

103538

},

103539

{

103540

"file": "widget/js/WidgetLocale.js",

103541

"line": 53,

103542

"description": "Returns the strings key/value hash for a paricular locale, without locale lookup applied.",

103543

"itemtype": "method",

103544

"name": "_getStrings",

103545

"access": "protected",

103546

"tagname": "",

103547

"params": [

103548

{

103549

"name": "locale",

103550

"description": "",

103551

"type": "Object"

103552

}

103553

],

103554

"class": "Widget",

103555

"module": "widget-locale"

103556

},

103557

{

103558

"file": "widget/js/WidgetLocale.js",

103559

"line": 64,

103560

"description": "Gets the entire strings hash for a particular locale, performing locale lookup.\n\nIf no values of the key are defined for a particular locale the value for the \ndefault locale (in initial locale set for the class) is returned.\n",

103561

"itemtype": "method",

103562

"name": "getStrings",

103563

"params": [

103564

{

103565

"name": "locale",

103566

"description": "(optional) The locale for which the string value is required. Defaults to the current locale, if not provided.",

103567

"type": "String"

103568

}

103569

],

103570

"class": "Widget",

103571

"module": "widget-locale"

103572

},

103573

{

103574

"file": "widget/js/WidgetLocale.js",

103575

"line": 107,

103576

"description": "Gets the string for a particular key, for a particular locale, performing locale lookup.\n\nIf no values if defined for the key, for the given locale, the value for the \ndefault locale (in initial locale set for the class) is returned.\n",

103577

"itemtype": "method",

103578

"name": "getString",

103579

"params": [

103580

{

103581

"name": "key",

103582

"description": "The key.",

103583

"type": "String"

103584

},

103585

{

103586

"name": "locale",

103587

"description": "(optional) The locale for which the string value is required. Defaults to the current locale, if not provided.",

103588

"type": "String"

103589

}

103590

],

103591

"class": "Widget",

103592

"module": "widget-locale"

103593

},

103594

{

103595

"file": "widget/js/WidgetLocale.js",

103596

"line": 150,

103597

"description": "Returns the default locale for the widget (the locale value defined by the\nwidget class, or provided by the user during construction).",

103598

"itemtype": "method",

103599

"name": "getDefaultLocale",

103600

"return": {

103601

"description": "The default locale for the widget",

103602

"type": "String"

103603

},

103604

"class": "Widget",

103605

"module": "widget-locale"

103606

},

103607

{

103608

"file": "widget/js/WidgetSkin.js",

103609

"line": 13,

103610

"description": "Returns the name of the skin that's currently applied to the widget.\nThis is only really useful after the widget's DOM structure is in the\ndocument, either by render or by progressive enhancement. Searches up\nthe Widget's ancestor axis for a class yui3-skin-(name), and returns the\n(name) portion. Otherwise, returns null.",

103611

"itemtype": "method",

103612

"name": "getSkinName",

103613

"return": {

103614

"description": "the name of the skin, or null (yui3-skin-sam => sam)",

103615

"type": "String"

103616

},

103617

"class": "Widget",

103618

"module": "widget",

103619

"submodule": "widget-skin"

103620

},

103621

{

103622

"file": "widget/js/WidgetUIEvents.js",

103623

"line": 20,

103624

"description": "Destructor logic for UI event infrastructure,\ninvoked during Widget destruction.",

103625

"itemtype": "method",

103626

"name": "_destroyUIEvents",

103627

"access": "private",

103628

"tagname": "",

103629

"class": "Widget",

103630

"module": "widget",

103631

"submodule": "widget-uievents"

103632

},

103633

{

103634

"file": "widget/js/WidgetUIEvents.js",

103635

"line": 52,

103636

"description": "Map of DOM events that should be fired as Custom Events by the \nWidget instance.",

103637

"itemtype": "property",

103638

"name": "UI_EVENTS",

103639

"type": "Object",

103640

"class": "Widget",

103641

"module": "widget",

103642

"submodule": "widget-uievents"

103643

},

103644

{

103645

"file": "widget/js/WidgetUIEvents.js",

103646

"line": 62,

103647

"description": "Returns the node on which to bind delegate listeners.",

103648

"itemtype": "method",

103649

"name": "_getUIEventNode",

103650

"access": "protected",

103651

"tagname": "",

103652

"class": "Widget",

103653

"module": "widget",

103654

"submodule": "widget-uievents"

103655

},

103656

{

103657

"file": "widget/js/WidgetUIEvents.js",

103658

"line": 73,

103659

"description": "Binds a delegated DOM event listener of the specified type to the \nWidget's outtermost DOM element to facilitate the firing of a Custom\nEvent of the same type for the Widget instance.",

103660

"itemtype": "method",

103661

"name": "_createUIEvent",

103662

"params": [

103663

{

103664

"name": "type",

103665

"description": "String representing the name of the event",

103666

"type": "String"

103667

}

103668

],

103669

"access": "private",

103670

"tagname": "",

103671

"class": "Widget",

103672

"module": "widget",

103673

"submodule": "widget-uievents"

103674

},

103675

{

103676

"file": "widget/js/WidgetUIEvents.js",

103677

"line": 117,

103678

"description": "This method is used to determine if we should fire\nthe UI Event or not. The default implementation makes sure\nthat for nested delegates (nested unrelated widgets), we don't \nfire the UI event listener more than once at each level.\n\nFor example, without the additional filter, if you have nested \nwidgets, each widget will have a delegate listener. If you \nclick on the inner widget, the inner delegate listener's \nfilter will match once, but the outer will match twice \n(based on delegate's design) - once for the inner widget, \nand once for the outer.",

103679

"itemtype": "method",

103680

"name": "_filterUIEvent",

103681

"params": [

103682

{

103683

"name": "evt",

103684

"description": "",

103685

"type": "DOMEventFacade"

103686

}

103687

],

103688

"return": {

103689

"description": "true if it's OK to fire the custom UI event, false if not.",

103690

"type": "Boolean"

103691

},

103692

"access": "private",

103693

"tagname": "",

103694

"class": "Widget",

103695

"module": "widget",

103696

"submodule": "widget-uievents"

103697

},

103698

{

103699

"file": "widget/js/WidgetUIEvents.js",

103700

"line": 143,

103701

"description": "Determines if the specified event is a UI event.",

103702

"access": "private",

103703

"tagname": "",

103704

"itemtype": "method",

103705

"name": "_isUIEvent",

103706

"params": [

103707

{

103708

"name": "type",

103709

"description": "String representing the name of the event",

103710

"type": "String"

103711

}

103712

],

103713

"return": {

103714

"description": "Event Returns the name of the UI Event, otherwise \nundefined.",

103715

"type": "String"

103716

},

103717

"class": "Widget",

103718

"module": "widget",

103719

"submodule": "widget-uievents"

103720

},

103721

{

103722

"file": "widget/js/WidgetUIEvents.js",

103723

"line": 176,

103724

"description": "Sets up infrastructure required to fire a UI event.",

103725

"access": "private",

103726

"tagname": "",

103727

"itemtype": "method",

103728

"name": "_initUIEvent",

103729

"params": [

103730

{

103731

"name": "type",

103732

"description": "String representing the name of the event",

103733

"type": "String"

103734

}

103735

],

103736

"return": {

103737

"description": "",

103738

"type": "String"

103739

},

103740

"class": "Widget",

103741

"module": "widget",

103742

"submodule": "widget-uievents"

103743

},

103744

{

103745

"file": "yql/js/yql.js",

103746

"line": 35,

103747

"access": "private",

103748

"tagname": "",

103749

"itemtype": "property",

103750

"name": "_jsonp",

103751

"description": "Reference to the JSONP instance used to make the queries",

103752

"class": "YQLRequest",

103753

"module": "yql"

103754

},

103755

{

103756

"file": "yql/js/yql.js",

103757

"line": 41,

103758

"access": "private",

103759

"tagname": "",

103760

"itemtype": "property",

103761

"name": "_opts",

103762

"description": "Holder for the opts argument",

103763

"class": "YQLRequest",

103764

"module": "yql"

103765

},

103766

{

103767

"file": "yql/js/yql.js",

103768

"line": 47,

103769

"access": "private",

103770

"tagname": "",

103771

"itemtype": "property",

103772

"name": "_callback",

103773

"description": "Holder for the callback argument",

103774

"class": "YQLRequest",

103775

"module": "yql"

103776

},

103777

{

103778

"file": "yql/js/yql.js",

103779

"line": 53,

103780

"access": "private",

103781

"tagname": "",

103782

"itemtype": "property",

103783

"name": "_params",

103784

"description": "Holder for the params argument",

103785

"class": "YQLRequest",

103786

"module": "yql"

103787

},

103788

{

103789

"file": "yql/js/yql.js",

103790

"line": 59,

103791

"itemtype": "method",

103792

"name": "send",

103793

"description": "The method that executes the YQL Request.",

103794

"chainable": 1,

103795

"return": {

103796

"description": "",

103797

"type": "YQLRequest"

103798

},

103799

"class": "YQLRequest",

103800

"module": "yql"

103801

},

103802

{

103803

"file": "yql/js/yql.js",

103804

"line": 95,

103805

"static": 1,

103806

"itemtype": "property",

103807

"name": "FORMAT",

103808

"description": "Default format to use: json",

103809

"class": "YQLRequest",

103810

"module": "yql"

103811

},

103812

{

103813

"file": "yql/js/yql.js",

103814

"line": 101,

103815

"static": 1,

103816

"itemtype": "property",

103817

"name": "PROTO",

103818

"description": "Default protocol to use: http",

103819

"class": "YQLRequest",

103820

"module": "yql"

103821

},

103822

{

103823

"file": "yql/js/yql.js",

103824

"line": 107,

103825

"static": 1,

103826

"itemtype": "property",

103827

"name": "BASE_URL",

103828

"description": "The base URL to query: query.yahooapis.com/v1/public/yql?",

103829

"class": "YQLRequest",

103830

"module": "yql"

103831

},

103832

{

103833

"file": "yql/js/yql.js",

103834

"line": 113,

103835

"static": 1,

103836

"itemtype": "property",

103837

"name": "ENV",

103838

"description": "The environment file to load: http://datatables.org/alltables.env",

103839

"class": "YQLRequest",

103840

"module": "yql"

103841

},

103842

{

103843

"file": "yui-throttle/js/throttle.js",

103844

"line": 20,

103845

"description": "Throttles a call to a method based on the time between calls.",

103846

"itemtype": "method",

103847

"name": "throttle",

103848

"params": [

103849

{

103850

"name": "fn",

103851

"description": "The function call to throttle.",

103852

"type": "Function"

103853

},

103854

{

103855

"name": "ms",

103856

"description": "The number of milliseconds to throttle the method call.\nCan set globally with Y.config.throttleTime or by call. Passing a -1 will\ndisable the throttle. Defaults to 150.",

103857

"type": "Int"

103858

}

103859

],

103860

"return": {

103861

"description": "Returns a wrapped function that calls fn throttled.",

103862

"type": "Function"

103863

},

103864

"since": "3.1.0",

103865

"class": "YUI",

103866

"module": "yui",

103867

"submodule": "yui-throttle"

103868

},

103869

{

103870

"file": "yui/js/features.js",

103871

"line": 16,

103872

"description": "Object hash of all registered feature tests",

103873

"itemtype": "property",

103874

"name": "tests",

103875

"type": "Object",

103876

"class": "Features",

103877

"module": "features"

103878

},

103879

{

103880

"file": "yui/js/features.js",

103881

"line": 23,

103882

"description": "Add a test to the system\n\n ```\n Y.Features.add(\"load\", \"1\", {});\n ```",

103883

"itemtype": "method",

103884

"name": "add",

103885

"params": [

103886

{

103887

"name": "cat",

103888

"description": "The category, right now only 'load' is supported",

103889

"type": "String"

103890

},

103891

{

103892

"name": "name",

103893

"description": "The number sequence of the test, how it's reported in the URL or config: 1, 2, 3",

103894

"type": "String"

103895

},

103896

{

103897

"name": "o",

103898

"description": "Object containing test properties",

103899

"type": "Object",

103900

"props": [

103901

{

103902

"name": "name",

103903

"description": "The name of the test",

103904

"type": "String"

103905

},

103906

{

103907

"name": "test",

103908

"description": "The test function to execute, the only argument to the function is the `Y` instance",

103909

"type": "Function"

103910

},

103911

{

103912

"name": "trigger",

103913

"description": "The module that triggers this test.",

103914

"type": "String"

103915

}

103916

]

103917

}

103918

],

103919

"class": "Features",

103920

"module": "features"

103921

},

103922

{

103923

"file": "yui/js/features.js",

103924

"line": 42,

103925

"description": "Execute all tests of a given category and return the serialized results\n\n ```\n caps=1:1;2:1;3:0\n ```",

103926

"itemtype": "method",

103927

"name": "all",

103928

"params": [

103929

{

103930

"name": "cat",

103931

"description": "The category to execute",

103932

"type": "String"

103933

},

103934

{

103935

"name": "args",

103936

"description": "The arguments to pass to the test function",

103937

"type": "Array"

103938

}

103939

],

103940

"return": {

103941

"description": "A semi-colon separated string of tests and their success/failure: 1:1;2:1;3:0",

103942

"type": "String"

103943

},

103944

"class": "Features",

103945

"module": "features"

103946

},

103947

{

103948

"file": "yui/js/features.js",

103949

"line": 65,

103950

"description": "Run a sepecific test and return a Boolean response.\n\n ```\n Y.Features.test(\"load\", \"1\");\n ```",

103951

"itemtype": "method",

103952

"name": "test",

103953

"params": [

103954

{

103955

"name": "cat",

103956

"description": "The category of the test to run",

103957

"type": "String"

103958

},

103959

{

103960

"name": "name",

103961

"description": "The name of the test to run",

103962

"type": "String"

103963

},

103964

{

103965

"name": "args",

103966

"description": "The arguments to pass to the test function",

103967

"type": "Array"

103968

}

103969

],

103970

"return": {

103971

"description": "True or false if the test passed/failed.",

103972

"type": "Boolean"

103973

},

103974

"class": "Features",

103975

"module": "features"

103976

},

103977

{

103978

"file": "yui/js/intl-base.js",

103979

"line": 14,

103980

"description": "Returns the language among those available that\nbest matches the preferred language list, using the Lookup\nalgorithm of BCP 47.\nIf none of the available languages meets the user's preferences,\nthen \"\" is returned.\nExtended language ranges are not supported.",

103981

"itemtype": "method",

103982

"name": "lookupBestLang",

103983

"params": [

103984

{

103985

"name": "preferredLanguages",

103986

"description": "The list of preferred\nlanguages in descending preference order, represented as BCP 47\nlanguage tags. A string array or a comma-separated list.",

103987

"type": "String[] | String"

103988

},

103989

{

103990

"name": "availableLanguages",

103991

"description": "The list of languages\nthat the application supports, represented as BCP 47 language\ntags.",

103992

"type": "String[]"

103993

}

103994

],

103995

"return": {

103996

"description": "The available language that best matches the\npreferred language list, or \"\".",

103997

"type": "String"

103998

},

103999

"since": "3.1.0",

104000

"class": "Intl",

104001

"module": "features"

104002

},

104003

{

104004

"file": "yui/js/queue-base.js",

104005

"line": 23,

104006

"description": "Initialize the queue",

104007

"itemtype": "method",

104008

"name": "_init",

104009

"access": "protected",

104010

"tagname": "",

104011

"class": "Queue",

104012

"module": "yui",

104013

"submodule": "yui-base"

104014

},

104015

{

104016

"file": "yui/js/queue-base.js",

104017

"line": 30,

104018

"description": "The collection of enqueued items",

104019

"itemtype": "property",

104020

"name": "_q",

104021

"type": "Array",

104022

"access": "protected",

104023

"tagname": "",

104024

"class": "Queue",

104025

"module": "yui",

104026

"submodule": "yui-base"

104027

},

104028

{

104029

"file": "yui/js/queue-base.js",

104030

"line": 40,

104031

"description": "Get the next item in the queue. FIFO support",

104032

"itemtype": "method",

104033

"name": "next",

104034

"return": {

104035

"description": "the next item in the queue.",

104036

"type": "MIXED"

104037

},

104038

"class": "Queue",

104039

"module": "yui",

104040

"submodule": "yui-base"

104041

},

104042

{

104043

"file": "yui/js/queue-base.js",

104044

"line": 50,

104045

"description": "Get the last in the queue. LIFO support.",

104046

"itemtype": "method",

104047

"name": "last",

104048

"return": {

104049

"description": "the last item in the queue.",

104050

"type": "MIXED"

104051

},

104052

"class": "Queue",

104053

"module": "yui",

104054

"submodule": "yui-base"

104055

},

104056

{

104057

"file": "yui/js/queue-base.js",

104058

"line": 60,

104059

"description": "Add 0..n items to the end of the queue.",

104060

"itemtype": "method",

104061

"name": "add",

104062

"params": [

104063

{

104064

"name": "item",

104065

"description": "0..n items.",

104066

"type": "MIXED",

104067

"multiple": true

104068

}

104069

],

104070

"return": {

104071

"description": "this queue.",

104072

"type": "Object"

104073

},

104074

"class": "Queue",

104075

"module": "yui",

104076

"submodule": "yui-base"

104077

},

104078

{

104079

"file": "yui/js/queue-base.js",

104080

"line": 73,

104081

"description": "Returns the current number of queued items.",

104082

"itemtype": "method",

104083

"name": "size",

104084

"return": {

104085

"description": "The size.",

104086

"type": "Number"

104087

},

104088

"class": "Queue",

104089

"module": "yui",

104090

"submodule": "yui-base"

104091

},

104092

{

104093

"file": "yui/js/yui-array.js",

104094

"line": 64,

104095

"description": "Dedupes an array of strings, returning an array that's guaranteed to contain\nonly one copy of a given string.\n\nThis method differs from `Array.unique()` in that it's optimized for use only\nwith strings, whereas `unique` may be used with other types (but is slower).\nUsing `dedupe()` with non-string values may result in unexpected behavior.",

104096

"itemtype": "method",

104097

"name": "dedupe",

104098

"params": [

104099

{

104100

"name": "array",

104101

"description": "Array of strings to dedupe.",

104102

"type": "String[]"

104103

}

104104

],

104105

"return": {

104106

"description": "Deduped copy of _array_.",

104107

"type": "Array"

104108

},

104109

"static": 1,

104110

"since": "3.4.0",

104111

"class": "Array",

104112

"module": "yui",

104113

"submodule": "yui-base"

104114

},

104115

{

104116

"file": "yui/js/yui-array.js",

104117

"line": 95,

104118

"description": "Executes the supplied function on each item in the array. This method wraps\nthe native ES5 `Array.forEach()` method if available.",

104119

"itemtype": "method",

104120

"name": "each",

104121

"params": [

104122

{

104123

"name": "array",

104124

"description": "Array to iterate.",

104125

"type": "Array"

104126

},

104127

{

104128

"name": "fn",

104129

"description": "Function to execute on each item in the array. The function\n will receive the following arguments:",

104130

"type": "Function",

104131

"props": [

104132

{

104133

"name": "item",

104134

"description": "Current array item.",

104135

"type": "Any"

104136

},

104137

{

104138

"name": "index",

104139

"description": "Current array index.",

104140

"type": "Number"

104141

},

104142

{

104143

"name": "array",

104144

"description": "Array being iterated.",

104145

"type": "Array"

104146

}

104147

]

104148

},

104149

{

104150

"name": "thisObj",

104151

"description": "`this` object to use when calling _fn_.",

104152

"type": "Object",

104153

"optional": true

104154

}

104155

],

104156

"return": {

104157

"description": "The YUI instance.",

104158

"type": "YUI"

104159

},

104160

"static": 1,

104161

"class": "Array",

104162

"module": "yui",

104163

"submodule": "yui-base"

104164

},

104165

{

104166

"file": "yui/js/yui-array.js",

104167

"line": 123,

104168

"description": "Alias for `each()`.",

104169

"itemtype": "method",

104170

"name": "forEach",

104171

"static": 1,

104172

"class": "Array",

104173

"module": "yui",

104174

"submodule": "yui-base"

104175

},

104176

{

104177

"file": "yui/js/yui-array.js",

104178

"line": 130,

104179

"description": "Returns an object using the first array as keys and the second as values. If\nthe second array is not provided, or if it doesn't contain the same number of\nvalues as the first array, then `true` will be used in place of the missing\nvalues.",

104180

"example": [

104181

"\n\n Y.Array.hash(['a', 'b', 'c'], ['foo', 'bar']);\n // => {a: 'foo', b: 'bar', c: true}"

104182

],

104183

"itemtype": "method",

104184

"name": "hash",

104185

"params": [

104186

{

104187

"name": "keys",

104188

"description": "Array of strings to use as keys.",

104189

"type": "String[]"

104190

},

104191

{

104192

"name": "values",

104193

"description": "Array to use as values.",

104194

"type": "Array",

104195

"optional": true

104196

}

104197

],

104198

"return": {

104199

"description": "Hash using the first array as keys and the second as values.",

104200

"type": "Object"

104201

},

104202

"static": 1,

104203

"class": "Array",

104204

"module": "yui",

104205

"submodule": "yui-base"

104206

},

104207

{

104208

"file": "yui/js/yui-array.js",

104209

"line": 161,

104210

"description": "Returns the index of the first item in the array that's equal (using a strict\nequality check) to the specified _value_, or `-1` if the value isn't found.\n\nThis method wraps the native ES5 `Array.indexOf()` method if available.",

104211

"itemtype": "method",

104212

"name": "indexOf",

104213

"params": [

104214

{

104215

"name": "array",

104216

"description": "Array to search.",

104217

"type": "Array"

104218

},

104219

{

104220

"name": "value",

104221

"description": "Value to search for.",

104222

"type": "Any"

104223

},

104224

{

104225

"name": "from",

104226

"description": "The index at which to begin the search.",

104227

"type": "Number",

104228

"optional": true,

104229

"optdefault": "0"

104230

}

104231

],

104232

"return": {

104233

"description": "Index of the item strictly equal to _value_, or `-1` if not\n found.",

104234

"type": "Number"

104235

},

104236

"static": 1,

104237

"class": "Array",

104238

"module": "yui",

104239

"submodule": "yui-base"

104240

},

104241

{

104242

"file": "yui/js/yui-array.js",

104243

"line": 201,

104244

"description": "Numeric sort convenience function.\n\nThe native `Array.prototype.sort()` function converts values to strings and\nsorts them in lexicographic order, which is unsuitable for sorting numeric\nvalues. Provide `Array.numericSort` as a custom sort function when you want\nto sort values in numeric order.",

104245

"example": [

104246

"\n\n [42, 23, 8, 16, 4, 15].sort(Y.Array.numericSort);\n // => [4, 8, 15, 16, 23, 42]"

104247

],

104248

"itemtype": "method",

104249

"name": "numericSort",

104250

"params": [

104251

{

104252

"name": "a",

104253

"description": "First value to compare.",

104254

"type": "Number"

104255

},

104256

{

104257

"name": "b",

104258

"description": "Second value to compare.",

104259

"type": "Number"

104260

}

104261

],

104262

"return": {

104263

"description": "Difference between _a_ and _b_.",

104264

"type": "Number"

104265

},

104266

"static": 1,

104267

"class": "Array",

104268

"module": "yui",

104269

"submodule": "yui-base"

104270

},

104271

{

104272

"file": "yui/js/yui-array.js",

104273

"line": 224,

104274

"description": "Executes the supplied function on each item in the array. Returning a truthy\nvalue from the function will stop the processing of remaining items.",

104275

"itemtype": "method",

104276

"name": "some",

104277

"params": [

104278

{

104279

"name": "array",

104280

"description": "Array to iterate over.",

104281

"type": "Array"

104282

},

104283

{

104284

"name": "fn",

104285

"description": "Function to execute on each item. The function will receive\n the following arguments:",

104286

"type": "Function",

104287

"props": [

104288

{

104289

"name": "value",

104290

"description": "Current array item.",

104291

"type": "Any"

104292

},

104293

{

104294

"name": "index",

104295

"description": "Current array index.",

104296

"type": "Number"

104297

},

104298

{

104299

"name": "array",

104300

"description": "Array being iterated over.",

104301

"type": "Array"

104302

}

104303

]

104304

},

104305

{

104306

"name": "thisObj",

104307

"description": "`this` object to use when calling _fn_.",

104308

"type": "Object",

104309

"optional": true

104310

}

104311

],

104312

"return": {

104313

"description": "`true` if the function returns a truthy value on any of the\n items in the array; `false` otherwise.",

104314

"type": "Boolean"

104315

},

104316

"static": 1,

104317

"class": "Array",

104318

"module": "yui",

104319

"submodule": "yui-base"

104320

},

104321

{

104322

"file": "yui/js/yui-array.js",

104323

"line": 252,

104324

"description": "Evaluates _obj_ to determine if it's an array, an array-like collection, or\nsomething else. This is useful when working with the function `arguments`\ncollection and `HTMLElement` collections.\n\nNote: This implementation doesn't consider elements that are also\ncollections, such as `<form>` and `<select>`, to be array-like.",

104325

"itemtype": "method",

104326

"name": "test",

104327

"params": [

104328

{

104329

"name": "obj",

104330

"description": "Object to test.",

104331

"type": "Object"

104332

}

104333

],

104334

"return": {

104335

"description": "A number indicating the results of the test:\n\n * 0: Neither an array nor an array-like collection.\n * 1: Real array.\n * 2: Array-like collection.",

104336

"type": "Number"

104337

},

104338

"static": 1,

104339

"class": "Array",

104340

"module": "yui",

104341

"submodule": "yui-base"

104342

},

104343

{

104344

"file": "yui/js/yui-core.js",

104345

"line": 15,

104346

"description": "Returns a wrapper for a function which caches the return value of that function,\nkeyed off of the combined string representation of the argument values provided\nwhen the wrapper is called.\n\nCalling this function again with the same arguments will return the cached value\nrather than executing the wrapped function.\n\nNote that since the cache is keyed off of the string representation of arguments\npassed to the wrapper function, arguments that aren't strings and don't provide\na meaningful `toString()` method may result in unexpected caching behavior. For\nexample, the objects `{}` and `{foo: 'bar'}` would both be converted to the\nstring `[object Object]` when used as a cache key.",

104347

"itemtype": "method",

104348

"name": "cached",

104349

"params": [

104350

{

104351

"name": "source",

104352

"description": "The function to memoize.",

104353

"type": "Function"

104354

},

104355

{

104356

"name": "cache",

104357

"description": "Object in which to store cached values. You may seed\n this object with pre-existing cached values if desired.",

104358

"type": "Object",

104359

"optional": true,

104360

"optdefault": "{}"

104361

},

104362

{

104363

"name": "refetch",

104364

"description": "If supplied, this value is compared with the cached value\n using a `==` comparison. If the values are equal, the wrapped function is\n executed again even though a cached value exists.",

104365

"type": "Any",

104366

"optional": true

104367

}

104368

],

104369

"return": {

104370

"description": "Wrapped function.",

104371

"type": "Function"

104372

},

104373

"class": "YUI",

104374

"module": "yui",

104375

"submodule": "yui-base"

104376

},

104377

{

104378

"file": "yui/js/yui-core.js",

104379

"line": 55,

104380

"description": "Returns the `location` object from the window/frame in which this YUI instance\noperates, or `undefined` when executing in a non-browser environment\n(e.g. Node.js).\n\nIt is _not_ recommended to hold references to the `window.location` object\noutside of the scope of a function in which its properties are being accessed or\nits methods are being called. This is because of a nasty bug/issue that exists\nin both Safari and MobileSafari browsers:\n[WebKit Bug 34679](https://bugs.webkit.org/show_bug.cgi?id=34679).",

104381

"itemtype": "method",

104382

"name": "getLocation",

104383

"return": {

104384

"description": "The `location` object from the window/frame in which this YUI\n instance operates.",

104385

"type": "Location"

104386

},

104387

"since": "3.5.0",

104388

"class": "YUI",

104389

"module": "yui",

104390

"submodule": "yui-base"

104391

},

104392

{

104393

"file": "yui/js/yui-core.js",

104394

"line": 84,

104395

"description": "Returns a new object containing all of the properties of all the supplied\nobjects. The properties from later objects will overwrite those in earlier\nobjects.\n\nPassing in a single object will create a shallow copy of it. For a deep copy,\nuse `clone()`.",

104396

"itemtype": "method",

104397

"name": "merge",

104398

"params": [

104399

{

104400

"name": "objects",

104401

"description": "One or more objects to merge.",

104402

"type": "Object",

104403

"multiple": true

104404

}

104405

],

104406

"return": {

104407

"description": "A new merged object.",

104408

"type": "Object"

104409

},

104410

"class": "YUI",

104411

"module": "yui",

104412

"submodule": "yui-base"

104413

},

104414

{

104415

"file": "yui/js/yui-core.js",

104416

"line": 109,

104417

"description": "Mixes _supplier_'s properties into _receiver_.\n\nProperties on _receiver_ or _receiver_'s prototype will not be overwritten or\nshadowed unless the _overwrite_ parameter is `true`, and will not be merged\nunless the _merge_ parameter is `true`.\n\nIn the default mode (0), only properties the supplier owns are copied (prototype\nproperties are not copied). The following copying modes are available:\n\n * `0`: _Default_. Object to object.\n * `1`: Prototype to prototype.\n * `2`: Prototype to prototype and object to object.\n * `3`: Prototype to object.\n * `4`: Object to prototype.",

104418

"itemtype": "method",

104419

"name": "mix",

104420

"params": [

104421

{

104422

"name": "receiver",

104423

"description": "The object or function to receive the mixed\n properties.",

104424

"type": "Function|Object"

104425

},

104426

{

104427

"name": "supplier",

104428

"description": "The object or function supplying the\n properties to be mixed.",

104429

"type": "Function|Object"

104430

},

104431

{

104432

"name": "overwrite",

104433

"description": "If `true`, properties that already exist\n on the receiver will be overwritten with properties from the supplier.",

104434

"type": "Boolean",

104435

"optional": true,

104436

"optdefault": "false"

104437

},

104438

{

104439

"name": "whitelist",

104440

"description": "An array of property names to copy. If\n specified, only the whitelisted properties will be copied, and all others\n will be ignored.",

104441

"type": "String[]",

104442

"optional": true

104443

},

104444

{

104445

"name": "mode",

104446

"description": "Mix mode to use. See above for available modes.",

104447

"type": "Number",

104448

"optional": true,

104449

"optdefault": "0"

104450

},

104451

{

104452

"name": "merge",

104453

"description": "If `true`, objects and arrays that already\n exist on the receiver will have the corresponding object/array from the\n supplier merged into them, rather than being skipped or overwritten. When\n both _overwrite_ and _merge_ are `true`, _merge_ takes precedence.",

104454

"type": "Boolean",

104455

"optional": true,

104456

"optdefault": "false"

104457

}

104458

],

104459

"return": {

104460

"description": "The receiver, or the YUI instance if the\n specified receiver is falsy.",

104461

"type": "Function|Object|YUI"

104462

},

104463

"class": "YUI",

104464

"module": "yui",

104465

"submodule": "yui-base"

104466

},

104467

{

104468

"file": "yui/js/yui-lang.js",

104469

"line": 39,

104470

"description": "Returns `true` if the given function appears to be implemented in native code,\n`false` otherwise. Will always return `false` -- even in ES5-capable browsers --\nif the `useNativeES5` YUI config option is set to `false`.\n\nThis isn't guaranteed to be 100% accurate and won't work for anything other than\nfunctions, but it can be useful for determining whether a function like\n`Array.prototype.forEach` is native or a JS shim provided by another library.\n\nThere's a great article by @kangax discussing certain flaws with this technique:\n<http://perfectionkills.com/detecting-built-in-host-methods/>\n\nWhile his points are valid, it's still possible to benefit from this function\nas long as it's used carefully and sparingly, and in such a way that false\nnegatives have minimal consequences. It's used internally to avoid using\npotentially broken non-native ES5 shims that have been added to the page by\nother libraries.",

104471

"itemtype": "method",

104472

"name": "_isNative",

104473

"params": [

104474

{

104475

"name": "fn",

104476

"description": "Function to test.",

104477

"type": "Function"

104478

}

104479

],

104480

"return": {

104481

"description": "`true` if _fn_ appears to be native, `false` otherwise.",

104482

"type": "Boolean"

104483

},

104484

"static": 1,

104485

"access": "protected",

104486

"tagname": "",

104487

"since": "3.5.0",

104488

"class": "Lang",

104489

"module": "yui",

104490

"submodule": "yui-base"

104491

},

104492

{

104493

"file": "yui/js/yui-lang.js",

104494

"line": 70,

104495

"description": "Determines whether or not the provided item is an array.\n\nReturns `false` for array-like collections such as the function `arguments`\ncollection or `HTMLElement` collections. Use `Y.Array.test()` if you want to\ntest for an array-like collection.",

104496

"itemtype": "method",

104497

"name": "isArray",

104498

"params": [

104499

{

104500

"name": "o",

104501

"description": "The object to test."

104502

}

104503

],

104504

"return": {

104505

"description": "true if o is an array.",

104506

"type": "Boolean"

104507

},

104508

"static": 1,

104509

"class": "Lang",

104510

"module": "yui",

104511

"submodule": "yui-base"

104512

},

104513

{

104514

"file": "yui/js/yui-lang.js",

104515

"line": 86,

104516

"description": "Determines whether or not the provided item is a boolean.",

104517

"itemtype": "method",

104518

"name": "isBoolean",

104519

"static": 1,

104520

"params": [

104521

{

104522

"name": "o",

104523

"description": "The object to test."

104524

}

104525

],

104526

"return": {

104527

"description": "true if o is a boolean.",

104528

"type": "Boolean"

104529

},

104530

"class": "Lang",

104531

"module": "yui",

104532

"submodule": "yui-base"

104533

},

104534

{

104535

"file": "yui/js/yui-lang.js",

104536

"line": 97,

104537

"description": "Determines whether or not the supplied item is a date instance.",

104538

"itemtype": "method",

104539

"name": "isDate",

104540

"static": 1,

104541

"params": [

104542

{

104543

"name": "o",

104544

"description": "The object to test."

104545

}

104546

],

104547

"return": {

104548

"description": "true if o is a date.",

104549

"type": "Boolean"

104550

},

104551

"class": "Lang",

104552

"module": "yui",

104553

"submodule": "yui-base"

104554

},

104555

{

104556

"file": "yui/js/yui-lang.js",

104557

"line": 108,

104558

"description": "\nDetermines whether or not the provided item is a function.\nNote: Internet Explorer thinks certain functions are objects:\n\n\n<pre>\nvar obj = document.createElement(\"object\");\nY.Lang.isFunction(obj.getAttribute) // reports false in IE\n \nvar input = document.createElement(\"input\"); // append to body\nY.Lang.isFunction(input.focus) // reports false in IE\n</pre>\n\n\nYou will have to implement additional tests if these functions\nmatter to you.\n",

104559

"itemtype": "method",

104560

"name": "isFunction",

104561

"static": 1,

104562

"params": [

104563

{

104564

"name": "o",

104565

"description": "The object to test."

104566

}

104567

],

104568

"return": {

104569

"description": "true if o is a function.",

104570

"type": "Boolean"

104571

},

104572

"class": "Lang",

104573

"module": "yui",

104574

"submodule": "yui-base"

104575

},

104576

{

104577

"file": "yui/js/yui-lang.js",

104578

"line": 136,

104579

"description": "Determines whether or not the provided item is null.",

104580

"itemtype": "method",

104581

"name": "isNull",

104582

"static": 1,

104583

"params": [

104584

{

104585

"name": "o",

104586

"description": "The object to test."

104587

}

104588

],

104589

"return": {

104590

"description": "true if o is null.",

104591

"type": "Boolean"

104592

},

104593

"class": "Lang",

104594

"module": "yui",

104595

"submodule": "yui-base"

104596

},

104597

{

104598

"file": "yui/js/yui-lang.js",

104599

"line": 147,

104600

"description": "Determines whether or not the provided item is a legal number.",

104601

"itemtype": "method",

104602

"name": "isNumber",

104603

"static": 1,

104604

"params": [

104605

{

104606

"name": "o",

104607

"description": "The object to test."

104608

}

104609

],

104610

"return": {

104611

"description": "true if o is a number.",

104612

"type": "Boolean"

104613

},

104614

"class": "Lang",

104615

"module": "yui",

104616

"submodule": "yui-base"

104617

},

104618

{

104619

"file": "yui/js/yui-lang.js",

104620

"line": 158,

104621

"description": "Determines whether or not the provided item is of type object\nor function. Note that arrays are also objects, so\n<code>Y.Lang.isObject([]) === true</code>.",

104622

"itemtype": "method",

104623

"name": "isObject",

104624

"static": 1,

104625

"params": [

104626

{

104627

"name": "o",

104628

"description": "The object to test."

104629

},

104630

{

104631

"name": "failfn",

104632

"description": "fail if the input is a function.",

104633

"type": "Boolean"

104634

}

104635

],

104636

"return": {

104637

"description": "true if o is an object.",

104638

"type": "Boolean"

104639

},

104640

"see": [

104641

"isPlainObject"

104642

],

104643

"class": "Lang",

104644

"module": "yui",

104645

"submodule": "yui-base"

104646

},

104647

{

104648

"file": "yui/js/yui-lang.js",

104649

"line": 175,

104650

"description": "Determines whether or not the provided item is a string.",

104651

"itemtype": "method",

104652

"name": "isString",

104653

"static": 1,

104654

"params": [

104655

{

104656

"name": "o",

104657

"description": "The object to test."

104658

}

104659

],

104660

"return": {

104661

"description": "true if o is a string.",

104662

"type": "Boolean"

104663

},

104664

"class": "Lang",

104665

"module": "yui",

104666

"submodule": "yui-base"

104667

},

104668

{

104669

"file": "yui/js/yui-lang.js",

104670

"line": 186,

104671

"description": "Determines whether or not the provided item is undefined.",

104672

"itemtype": "method",

104673

"name": "isUndefined",

104674

"static": 1,

104675

"params": [

104676

{

104677

"name": "o",

104678

"description": "The object to test."

104679

}

104680

],

104681

"return": {

104682

"description": "true if o is undefined.",

104683

"type": "Boolean"

104684

},

104685

"class": "Lang",

104686

"module": "yui",

104687

"submodule": "yui-base"

104688

},

104689

{

104690

"file": "yui/js/yui-lang.js",

104691

"line": 197,

104692

"description": "A convenience method for detecting a legitimate non-null value.\nReturns false for null/undefined/NaN, true for other values,\nincluding 0/false/''",

104693

"itemtype": "method",

104694

"name": "isValue",

104695

"static": 1,

104696

"params": [

104697

{

104698

"name": "o",

104699

"description": "The item to test."

104700

}

104701

],

104702

"return": {

104703

"description": "true if it is not null/undefined/NaN || false.",

104704

"type": "Boolean"

104705

},

104706

"class": "Lang",

104707

"module": "yui",

104708

"submodule": "yui-base"

104709

},

104710

{

104711

"file": "yui/js/yui-lang.js",

104712

"line": 222,

104713

"description": "Returns the current time in milliseconds.",

104714

"itemtype": "method",

104715

"name": "now",

104716

"return": {

104717

"description": "Current time in milliseconds.",

104718

"type": "Number"

104719

},

104720

"static": 1,

104721

"since": "3.3.0",

104722

"class": "Lang",

104723

"module": "yui",

104724

"submodule": "yui-base"

104725

},

104726

{

104727

"file": "yui/js/yui-lang.js",

104728

"line": 234,

104729

"description": "Lightweight version of <code>Y.substitute</code>. Uses the same template\nstructure as <code>Y.substitute</code>, but doesn't support recursion,\nauto-object coersion, or formats.",

104730

"itemtype": "method",

104731

"name": "sub",

104732

"params": [

104733

{

104734

"name": "s",

104735

"description": "String to be modified.",

104736

"type": "String"

104737

},

104738

{

104739

"name": "o",

104740

"description": "Object containing replacement values.",

104741

"type": "Object"

104742

}

104743

],

104744

"return": {

104745

"description": "the substitute result.",

104746

"type": "String"

104747

},

104748

"static": 1,

104749

"since": "3.2.0",

104750

"class": "Lang",

104751

"module": "yui",

104752

"submodule": "yui-base"

104753

},

104754

{

104755

"file": "yui/js/yui-lang.js",

104756

"line": 251,

104757

"description": "Returns a string without any leading or trailing whitespace. If\nthe input is not a string, the input will be returned untouched.",

104758

"itemtype": "method",

104759

"name": "trim",

104760

"static": 1,

104761

"params": [

104762

{

104763

"name": "s",

104764

"description": "the string to trim.",

104765

"type": "String"

104766

}

104767

],

104768

"return": {

104769

"description": "the trimmed string.",

104770

"type": "String"

104771

},

104772

"class": "Lang",

104773

"module": "yui",

104774

"submodule": "yui-base"

104775

},

104776

{

104777

"file": "yui/js/yui-lang.js",

104778

"line": 269,

104779

"description": "Returns a string without any leading whitespace.",

104780

"itemtype": "method",

104781

"name": "trimLeft",

104782

"static": 1,

104783

"params": [

104784

{

104785

"name": "s",

104786

"description": "the string to trim.",

104787

"type": "String"

104788

}

104789

],

104790

"return": {

104791

"description": "the trimmed string.",

104792

"type": "String"

104793

},

104794

"class": "Lang",

104795

"module": "yui",

104796

"submodule": "yui-base"

104797

},

104798

{

104799

"file": "yui/js/yui-lang.js",

104800

"line": 282,

104801

"description": "Returns a string without any trailing whitespace.",

104802

"itemtype": "method",

104803

"name": "trimRight",

104804

"static": 1,

104805

"params": [

104806

{

104807

"name": "s",

104808

"description": "the string to trim.",

104809

"type": "String"

104810

}

104811

],

104812

"return": {

104813

"description": "the trimmed string.",

104814

"type": "String"

104815

},

104816

"class": "Lang",

104817

"module": "yui",

104818

"submodule": "yui-base"

104819

},

104820

{

104821

"file": "yui/js/yui-lang.js",

104822

"line": 295,

104823

"description": "Returns one of the following strings, representing the type of the item passed\nin:\n\n * \"array\"\n * \"boolean\"\n * \"date\"\n * \"error\"\n * \"function\"\n * \"null\"\n * \"number\"\n * \"object\"\n * \"regexp\"\n * \"string\"\n * \"undefined\"\n\nKnown issues:\n\n * `typeof HTMLElementCollection` returns function in Safari, but\n `Y.Lang.type()` reports \"object\", which could be a good thing --\n but it actually caused the logic in <code>Y.Lang.isObject</code> to fail.",

104824

"itemtype": "method",

104825

"name": "type",

104826

"params": [

104827

{

104828

"name": "o",

104829

"description": "the item to test."

104830

}

104831

],

104832

"return": {

104833

"description": "the detected type.",

104834

"type": "String"

104835

},

104836

"static": 1,

104837

"class": "Lang",

104838

"module": "yui",

104839

"submodule": "yui-base"

104840

},

104841

{

104842

"file": "yui/js/yui-later.js",

104843

"line": 10,

104844

"description": "Executes the supplied function in the context of the supplied\nobject 'when' milliseconds later. Executes the function a\nsingle time unless periodic is set to true.",

104845

"itemtype": "method",

104846

"name": "later",

104847

"params": [

104848

{

104849

"name": "when",

104850

"description": "the number of milliseconds to wait until the fn\nis executed.",

104851

"type": "Int"

104852

},

104853

{

104854

"name": "o",

104855

"description": "the context object."

104856

},

104857

{

104858

"name": "fn",

104859

"description": "the function to execute or the name of\nthe method in the 'o' object to execute.",

104860

"type": "Function|String"

104861

},

104862

{

104863

"name": "data",

104864

"description": "[Array] data that is provided to the function. This\naccepts either a single item or an array. If an array is provided,\nthe function is executed with one parameter for each array item.\nIf you need to pass a single array parameter, it needs to be wrapped\nin an array [myarray].\n\nNote: native methods in IE may not have the call and apply methods.\nIn this case, it will work, but you are limited to four arguments."

104865

},

104866

{

104867

"name": "periodic",

104868

"description": "if true, executes continuously at supplied\ninterval until canceled.",

104869

"type": "Boolean"

104870

}

104871

],

104872

"return": {

104873

"description": "a timer object. Call the cancel() method on this\nobject to stop the timer.",

104874

"type": "Object"

104875

},

104876

"class": "YUI",

104877

"module": "yui",

104878

"submodule": "yui-later"

104879

},

104880

{

104881

"file": "yui/js/yui-log.js",

104882

"line": 17,

104883

"description": "If the 'debug' config is true, a 'yui:log' event will be\ndispatched, which the Console widget and anything else\ncan consume. If the 'useBrowserConsole' config is true, it will\nwrite to the browser console if available. YUI-specific log\nmessages will only be present in the -debug versions of the\nJS files. The build system is supposed to remove log statements\nfrom the raw and minified versions of the files.",

104884

"itemtype": "method",

104885

"name": "log",

104886

"params": [

104887

{

104888

"name": "msg",

104889

"description": "The message to log.",

104890

"type": "String"

104891

},

104892

{

104893

"name": "cat",

104894

"description": "The log category for the message. Default\n categories are \"info\", \"warn\", \"error\", time\".\n Custom categories can be used as well. (opt).",

104895

"type": "String"

104896

},

104897

{

104898

"name": "src",

104899

"description": "The source of the the message (opt).",

104900

"type": "String"

104901

},

104902

{

104903

"name": "silent",

104904

"description": "If true, the log event won't fire.",

104905

"type": "Boolean"

104906

}

104907

],

104908

"return": {

104909

"description": "YUI instance.",

104910

"type": "YUI"

104911

},

104912

"class": "YUI",

104913

"module": "yui",

104914

"submodule": "yui-log"

104915

},

104916

{

104917

"file": "yui/js/yui-log.js",

104918

"line": 89,

104919

"description": "Write a system message. This message will be preserved in the\nminified and raw versions of the YUI files, unlike log statements.",

104920

"itemtype": "method",

104921

"name": "message",

104922

"params": [

104923

{

104924

"name": "msg",

104925

"description": "The message to log.",

104926

"type": "String"

104927

},

104928

{

104929

"name": "cat",

104930

"description": "The log category for the message. Default\n categories are \"info\", \"warn\", \"error\", time\".\n Custom categories can be used as well. (opt).",

104931

"type": "String"

104932

},

104933

{

104934

"name": "src",

104935

"description": "The source of the the message (opt).",

104936

"type": "String"

104937

},

104938

{

104939

"name": "silent",

104940

"description": "If true, the log event won't fire.",

104941

"type": "Boolean"

104942

}

104943

],

104944

"return": {

104945

"description": "YUI instance.",

104946

"type": "YUI"

104947

},

104948

"class": "YUI",

104949

"module": "yui",

104950

"submodule": "yui-log"

104951

},

104952

{

104953

"file": "yui/js/yui-object.js",

104954

"line": 20,

104955

"description": "Returns a new object that uses _obj_ as its prototype. This method wraps the\nnative ES5 `Object.create()` method if available, but doesn't currently\npass through `Object.create()`'s second argument (properties) in order to\nensure compatibility with older browsers.",

104956

"itemtype": "method",

104957

"name": "()",

104958

"params": [

104959

{

104960

"name": "obj",

104961

"description": "Prototype object.",

104962

"type": "Object"

104963

}

104964

],

104965

"return": {

104966

"description": "New object using _obj_ as its prototype.",

104967

"type": "Object"

104968

},

104969

"static": 1,

104970

"class": "Object",

104971

"module": "yui",

104972

"submodule": "yui-base"

104973

},

104974

{

104975

"file": "yui/js/yui-object.js",

104976

"line": 49,

104977

"description": "Property names that IE doesn't enumerate in for..in loops, even when they\nshould be enumerable. When `_hasEnumBug` is `true`, it's necessary to\nmanually enumerate these properties.",

104978

"itemtype": "property",

104979

"name": "_forceEnum",

104980

"type": "String[]",

104981

"access": "protected",

104982

"tagname": "",

104983

"static": 1,

104984

"class": "Object",

104985

"module": "yui",

104986

"submodule": "yui-base"

104987

},

104988

{

104989

"file": "yui/js/yui-object.js",

104990

"line": 68,

104991

"description": "`true` if this browser has the JScript enumeration bug that prevents\nenumeration of the properties named in the `_forceEnum` array, `false`\notherwise.\n\nSee:\n - <https://developer.mozilla.org/en/ECMAScript_DontEnum_attribute#JScript_DontEnum_Bug>\n - <http://whattheheadsaid.com/2010/10/a-safer-object-keys-compatibility-implementation>",

104992

"itemtype": "property",

104993

"name": "_hasEnumBug",

104994

"type": "Boolean",

104995

"access": "protected",

104996

"tagname": "",

104997

"static": 1,

104998

"class": "Object",

104999

"module": "yui",

105000

"submodule": "yui-base"

105001

},

105002

{

105003

"file": "yui/js/yui-object.js",

105004

"line": 84,

105005

"description": "`true` if this browser incorrectly considers the `prototype` property of\nfunctions to be enumerable. Currently known to affect Opera 11.50.",

105006

"itemtype": "property",

105007

"name": "_hasProtoEnumBug",

105008

"type": "Boolean",

105009

"access": "protected",

105010

"tagname": "",

105011

"static": 1,

105012

"class": "Object",

105013

"module": "yui",

105014

"submodule": "yui-base"

105015

},

105016

{

105017

"file": "yui/js/yui-object.js",

105018

"line": 95,

105019

"description": "Returns `true` if _key_ exists on _obj_, `false` if _key_ doesn't exist or\nexists only on _obj_'s prototype. This is essentially a safer version of\n`obj.hasOwnProperty()`.",

105020

"itemtype": "method",

105021

"name": "owns",

105022

"params": [

105023

{

105024

"name": "obj",

105025

"description": "Object to test.",

105026

"type": "Object"

105027

},

105028

{

105029

"name": "key",

105030

"description": "Property name to look for.",

105031

"type": "String"

105032

}

105033

],

105034

"return": {

105035

"description": "`true` if _key_ exists on _obj_, `false` otherwise.",

105036

"type": "Boolean"

105037

},

105038

"static": 1,

105039

"class": "Object",

105040

"module": "yui",

105041

"submodule": "yui-base"

105042

},

105043

{

105044

"file": "yui/js/yui-object.js",

105045

"line": 110,

105046

"description": "Alias for `owns()`.",

105047

"itemtype": "method",

105048

"name": "hasKey",

105049

"params": [

105050

{

105051

"name": "obj",

105052

"description": "Object to test.",

105053

"type": "Object"

105054

},

105055

{

105056

"name": "key",

105057

"description": "Property name to look for.",

105058

"type": "String"

105059

}

105060

],

105061

"return": {

105062

"description": "`true` if _key_ exists on _obj_, `false` otherwise.",

105063

"type": "Boolean"

105064

},

105065

"static": 1,

105066

"class": "Object",

105067

"module": "yui",

105068

"submodule": "yui-base"

105069

},

105070

{

105071

"file": "yui/js/yui-object.js",

105072

"line": 121,

105073

"description": "Returns an array containing the object's enumerable keys. Does not include\nprototype keys or non-enumerable keys.\n\nNote that keys are returned in enumeration order (that is, in the same order\nthat they would be enumerated by a `for-in` loop), which may not be the same\nas the order in which they were defined.\n\nThis method is an alias for the native ES5 `Object.keys()` method if\navailable.",

105074

"example": [

105075

"\n\n Y.Object.keys({a: 'foo', b: 'bar', c: 'baz'});\n // => ['a', 'b', 'c']"

105076

],

105077

"itemtype": "method",

105078

"name": "keys",

105079

"params": [

105080

{

105081

"name": "obj",

105082

"description": "An object.",

105083

"type": "Object"

105084

}

105085

],

105086

"return": {

105087

"description": "Array of keys.",

105088

"type": "String[]"

105089

},

105090

"static": 1,

105091

"class": "Object",

105092

"module": "yui",

105093

"submodule": "yui-base"

105094

},

105095

{

105096

"file": "yui/js/yui-object.js",

105097

"line": 177,

105098

"description": "Returns an array containing the values of the object's enumerable keys.\n\nNote that values are returned in enumeration order (that is, in the same\norder that they would be enumerated by a `for-in` loop), which may not be the\nsame as the order in which they were defined.",

105099

"example": [

105100

"\n\n Y.Object.values({a: 'foo', b: 'bar', c: 'baz'});\n // => ['foo', 'bar', 'baz']"

105101

],

105102

"itemtype": "method",

105103

"name": "values",

105104

"params": [

105105

{

105106

"name": "obj",

105107

"description": "An object.",

105108

"type": "Object"

105109

}

105110

],

105111

"return": {

105112

"description": "Array of values.",

105113

"type": "Array"

105114

},

105115

"static": 1,

105116

"class": "Object",

105117

"module": "yui",

105118

"submodule": "yui-base"

105119

},

105120

{

105121

"file": "yui/js/yui-object.js",

105122

"line": 207,

105123

"description": "Returns the number of enumerable keys owned by an object.",

105124

"itemtype": "method",

105125

"name": "size",

105126

"params": [

105127

{

105128

"name": "obj",

105129

"description": "An object.",

105130

"type": "Object"

105131

}

105132

],

105133

"return": {

105134

"description": "The object's size.",

105135

"type": "Number"

105136

},

105137

"static": 1,

105138

"class": "Object",

105139

"module": "yui",

105140

"submodule": "yui-base"

105141

},

105142

{

105143

"file": "yui/js/yui-object.js",

105144

"line": 223,

105145

"description": "Returns `true` if the object owns an enumerable property with the specified\nvalue.",

105146

"itemtype": "method",

105147

"name": "hasValue",

105148

"params": [

105149

{

105150

"name": "obj",

105151

"description": "An object.",

105152

"type": "Object"

105153

},

105154

{

105155

"name": "value",

105156

"description": "The value to search for.",

105157

"type": "Any"

105158

}

105159

],

105160

"return": {

105161

"description": "`true` if _obj_ contains _value_, `false` otherwise.",

105162

"type": "Boolean"

105163

},

105164

"static": 1,

105165

"class": "Object",

105166

"module": "yui",

105167

"submodule": "yui-base"

105168

},

105169

{

105170

"file": "yui/js/yui-object.js",

105171

"line": 237,

105172

"description": "Executes a function on each enumerable property in _obj_. The function\nreceives the value, the key, and the object itself as parameters (in that\norder).\n\nBy default, only properties owned by _obj_ are enumerated. To include\nprototype properties, set the _proto_ parameter to `true`.",

105173

"itemtype": "method",

105174

"name": "each",

105175

"params": [

105176

{

105177

"name": "obj",

105178

"description": "Object to enumerate.",

105179

"type": "Object"

105180

},

105181

{

105182

"name": "fn",

105183

"description": "Function to execute on each enumerable property.",

105184

"type": "Function",

105185

"props": [

105186

{

105187

"name": "value",

105188

"description": "Value of the current property.",

105189

"type": "Mixed"

105190

},

105191

{

105192

"name": "key",

105193

"description": "Key of the current property.",

105194

"type": "String"

105195

},

105196

{

105197

"name": "obj",

105198

"description": "Object being enumerated.",

105199

"type": "Object"

105200

}

105201

]

105202

},

105203

{

105204

"name": "thisObj",

105205

"description": "`this` object to use when calling _fn_.",

105206

"type": "Object",

105207

"optional": true

105208

},

105209

{

105210

"name": "proto",

105211

"description": "Include prototype properties.",

105212

"type": "Boolean",

105213

"optional": true,

105214

"optdefault": "false"

105215

}

105216

],

105217

"return": {

105218

"description": "the YUI instance.",

105219

"type": "YUI"

105220

},

105221

"chainable": 1,

105222

"static": 1,

105223

"class": "Object",

105224

"module": "yui",

105225

"submodule": "yui-base"

105226

},

105227

{

105228

"file": "yui/js/yui-object.js",

105229

"line": 269,

105230

"description": "Executes a function on each enumerable property in _obj_, but halts if the\nfunction returns a truthy value. The function receives the value, the key,\nand the object itself as paramters (in that order).\n\nBy default, only properties owned by _obj_ are enumerated. To include\nprototype properties, set the _proto_ parameter to `true`.",

105231

"itemtype": "method",

105232

"name": "some",

105233

"params": [

105234

{

105235

"name": "obj",

105236

"description": "Object to enumerate.",

105237

"type": "Object"

105238

},

105239

{

105240

"name": "fn",

105241

"description": "Function to execute on each enumerable property.",

105242

"type": "Function",

105243

"props": [

105244

{

105245

"name": "value",

105246

"description": "Value of the current property.",

105247

"type": "Mixed"

105248

},

105249

{

105250

"name": "key",

105251

"description": "Key of the current property.",

105252

"type": "String"

105253

},

105254

{

105255

"name": "obj",

105256

"description": "Object being enumerated.",

105257

"type": "Object"

105258

}

105259

]

105260

},

105261

{

105262

"name": "thisObj",

105263

"description": "`this` object to use when calling _fn_.",

105264

"type": "Object",

105265

"optional": true

105266

},

105267

{

105268

"name": "proto",

105269

"description": "Include prototype properties.",

105270

"type": "Boolean",

105271

"optional": true,

105272

"optdefault": "false"

105273

}

105274

],

105275

"return": {

105276

"description": "`true` if any execution of _fn_ returns a truthy value,\n `false` otherwise.",

105277

"type": "Boolean"

105278

},

105279

"static": 1,

105280

"class": "Object",

105281

"module": "yui",

105282

"submodule": "yui-base"

105283

},

105284

{

105285

"file": "yui/js/yui-object.js",

105286

"line": 303,

105287

"description": "Retrieves the sub value at the provided path,\nfrom the value object provided.",

105288

"itemtype": "method",

105289

"name": "getValue",

105290

"static": 1,

105291

"params": [

105292

{

105293

"name": "o",

105294

"description": "The object from which to extract the property value."

105295

},

105296

{

105297

"name": "path",

105298

"description": "A path array, specifying the object traversal path\nfrom which to obtain the sub value.",

105299

"type": "Array"

105300

}

105301

],

105302

"return": {

105303

"description": "The value stored in the path, undefined if not found,\nundefined if the source is not an object. Returns the source object\nif an empty path is provided.",

105304

"type": "Any"

105305

},

105306

"class": "Object",

105307

"module": "yui",

105308

"submodule": "yui-base"

105309

},

105310

{

105311

"file": "yui/js/yui-object.js",

105312

"line": 332,

105313

"description": "Sets the sub-attribute value at the provided path on the\nvalue object. Returns the modified value object, or\nundefined if the path is invalid.",

105314

"itemtype": "method",

105315

"name": "setValue",

105316

"static": 1,

105317

"params": [

105318

{

105319

"name": "o",

105320

"description": "The object on which to set the sub value."

105321

},

105322

{

105323

"name": "path",

105324

"description": "A path array, specifying the object traversal path\n at which to set the sub value.",

105325

"type": "Array"

105326

},

105327

{

105328

"name": "val",

105329

"description": "The new value for the sub-attribute.",

105330

"type": "Any"

105331

}

105332

],

105333

"return": {

105334

"description": "The modified object, with the new sub value set, or\n undefined, if the path was invalid.",

105335

"type": "Object"

105336

},

105337

"class": "Object",

105338

"module": "yui",

105339

"submodule": "yui-base"

105340

},

105341

{

105342

"file": "yui/js/yui-object.js",

105343

"line": 367,

105344

"description": "Returns `true` if the object has no enumerable properties of its own.",

105345

"itemtype": "method",

105346

"name": "isEmpty",

105347

"params": [

105348

{

105349

"name": "obj",

105350

"description": "An object.",

105351

"type": "Object"

105352

}

105353

],

105354

"return": {

105355

"description": "`true` if the object is empty.",

105356

"type": "Boolean"

105357

},

105358

"static": 1,

105359

"since": "3.2.0",

105360

"class": "Object",

105361

"module": "yui",

105362

"submodule": "yui-base"

105363

},

105364

{

105365

"file": "yui/js/yui-ua.js",

105366

"line": 25,

105367

"description": "Static method on `YUI.Env` for parsing a UA string. Called at instantiation\nto populate `Y.UA`.",

105368

"static": 1,

105369

"itemtype": "method",

105370

"name": "parseUA",

105371

"params": [

105372

{

105373

"name": "subUA",

105374

"description": "UA string to parse",

105375

"type": "String",

105376

"optional": true,

105377

"optdefault": "navigator.userAgent"

105378

}

105379

],

105380

"return": {

105381

"description": "The Y.UA object",

105382

"type": "Object"

105383

},

105384

"class": "UA",

105385

"module": "yui",

105386

"submodule": "yui-base"

105387

},

105388

{

105389

"file": "yui/js/yui-ua.js",

105390

"line": 49,

105391

"description": "Internet Explorer version number or 0. Example: 6",

105392

"itemtype": "property",

105393

"name": "ie",

105394

"type": "float",

105395

"static": 1,

105396

"class": "UA",

105397

"module": "yui",

105398

"submodule": "yui-base"

105399

},

105400

{

105401

"file": "yui/js/yui-ua.js",

105402

"line": 57,

105403

"description": "Opera version number or 0. Example: 9.2",

105404

"itemtype": "property",

105405

"name": "opera",

105406

"type": "float",

105407

"static": 1,

105408

"class": "UA",

105409

"module": "yui",

105410

"submodule": "yui-base"

105411

},

105412

{

105413

"file": "yui/js/yui-ua.js",

105414

"line": 65,

105415

"description": "Gecko engine revision number. Will evaluate to 1 if Gecko\nis detected but the revision could not be found. Other browsers\nwill be 0. Example: 1.8\n<pre>\nFirefox 1.0.0.4: 1.7.8 <-- Reports 1.7\nFirefox 1.5.0.9: 1.8.0.9 <-- 1.8\nFirefox 2.0.0.3: 1.8.1.3 <-- 1.81\nFirefox 3.0 <-- 1.9\nFirefox 3.5 <-- 1.91\n</pre>",

105416

"itemtype": "property",

105417

"name": "gecko",

105418

"type": "float",

105419

"static": 1,

105420

"class": "UA",

105421

"module": "yui",

105422

"submodule": "yui-base"

105423

},

105424

{

105425

"file": "yui/js/yui-ua.js",

105426

"line": 82,

105427

"description": "AppleWebKit version. KHTML browsers that are not WebKit browsers\nwill evaluate to 1, other browsers 0. Example: 418.9\n<pre>\nSafari 1.3.2 (312.6): 312.8.1 <-- Reports 312.8 -- currently the\n latest available for Mac OSX 10.3.\nSafari 2.0.2: 416 <-- hasOwnProperty introduced\nSafari 2.0.4: 418 <-- preventDefault fixed\nSafari 2.0.4 (419.3): 418.9.1 <-- One version of Safari may run\n different versions of webkit\nSafari 2.0.4 (419.3): 419 <-- Tiger installations that have been\n updated, but not updated\n to the latest patch.\nWebkit 212 nightly: 522+ <-- Safari 3.0 precursor (with native\nSVG and many major issues fixed).\nSafari 3.0.4 (523.12) 523.12 <-- First Tiger release - automatic\nupdate from 2.x via the 10.4.11 OS patch.\nWebkit nightly 1/2008:525+ <-- Supports DOMContentLoaded event.\n yahoo.com user agent hack removed.\n</pre>\nhttp://en.wikipedia.org/wiki/Safari_version_history",

105428

"itemtype": "property",

105429

"name": "webkit",

105430

"type": "float",

105431

"static": 1,

105432

"class": "UA",

105433

"module": "yui",

105434

"submodule": "yui-base"

105435

},

105436

{

105437

"file": "yui/js/yui-ua.js",

105438

"line": 109,

105439

"description": "Safari will be detected as webkit, but this property will also\nbe populated with the Safari version number",

105440

"itemtype": "property",

105441

"name": "safari",

105442

"type": "float",

105443

"static": 1,

105444

"class": "UA",

105445

"module": "yui",

105446

"submodule": "yui-base"

105447

},

105448

{

105449

"file": "yui/js/yui-ua.js",

105450

"line": 118,

105451

"description": "Chrome will be detected as webkit, but this property will also\nbe populated with the Chrome version number",

105452

"itemtype": "property",

105453

"name": "chrome",

105454

"type": "float",

105455

"static": 1,

105456

"class": "UA",

105457

"module": "yui",

105458

"submodule": "yui-base"

105459

},

105460

{

105461

"file": "yui/js/yui-ua.js",

105462

"line": 127,

105463

"description": "The mobile property will be set to a string containing any relevant\nuser agent information when a modern mobile browser is detected.\nCurrently limited to Safari on the iPhone/iPod Touch, Nokia N-series\ndevices with the WebKit-based browser, and Opera Mini.",

105464

"itemtype": "property",

105465

"name": "mobile",

105466

"type": "string",

105467

"default": "null",

105468

"static": 1,

105469

"class": "UA",

105470

"module": "yui",

105471

"submodule": "yui-base"

105472

},

105473

{

105474

"file": "yui/js/yui-ua.js",

105475

"line": 139,

105476

"description": "Adobe AIR version number or 0. Only populated if webkit is detected.\nExample: 1.0",

105477

"itemtype": "property",

105478

"name": "air",

105479

"type": "float",

105480

"class": "UA",

105481

"module": "yui",

105482

"submodule": "yui-base"

105483

},

105484

{

105485

"file": "yui/js/yui-ua.js",

105486

"line": 146,

105487

"description": "Detects Apple iPad's OS version",

105488

"itemtype": "property",

105489

"name": "ipad",

105490

"type": "float",

105491

"static": 1,

105492

"class": "UA",

105493

"module": "yui",

105494

"submodule": "yui-base"

105495

},

105496

{

105497

"file": "yui/js/yui-ua.js",

105498

"line": 153,

105499

"description": "Detects Apple iPhone's OS version",

105500

"itemtype": "property",

105501

"name": "iphone",

105502

"type": "float",

105503

"static": 1,

105504

"class": "UA",

105505

"module": "yui",

105506

"submodule": "yui-base"

105507

},

105508

{

105509

"file": "yui/js/yui-ua.js",

105510

"line": 160,

105511

"description": "Detects Apples iPod's OS version",

105512

"itemtype": "property",

105513

"name": "ipod",

105514

"type": "float",

105515

"static": 1,

105516

"class": "UA",

105517

"module": "yui",

105518

"submodule": "yui-base"

105519

},

105520

{

105521

"file": "yui/js/yui-ua.js",

105522

"line": 167,

105523

"description": "General truthy check for iPad, iPhone or iPod",

105524

"itemtype": "property",

105525

"name": "ios",

105526

"type": "float",

105527

"default": "null",

105528

"static": 1,

105529

"class": "UA",

105530

"module": "yui",

105531

"submodule": "yui-base"

105532

},

105533

{

105534

"file": "yui/js/yui-ua.js",

105535

"line": 175,

105536

"description": "Detects Googles Android OS version",

105537

"itemtype": "property",

105538

"name": "android",

105539

"type": "float",

105540

"static": 1,

105541

"class": "UA",

105542

"module": "yui",

105543

"submodule": "yui-base"

105544

},

105545

{

105546

"file": "yui/js/yui-ua.js",

105547

"line": 182,

105548

"description": "Detects Kindle Silk",

105549

"itemtype": "property",

105550

"name": "silk",

105551

"type": "float",

105552

"static": 1,

105553

"class": "UA",

105554

"module": "yui",

105555

"submodule": "yui-base"

105556

},

105557

{

105558

"file": "yui/js/yui-ua.js",

105559

"line": 189,

105560

"description": "Detects Kindle Silk Acceleration",

105561

"itemtype": "property",

105562

"name": "accel",

105563

"type": "Boolean",

105564

"static": 1,

105565

"class": "UA",

105566

"module": "yui",

105567

"submodule": "yui-base"

105568

},

105569

{

105570

"file": "yui/js/yui-ua.js",

105571

"line": 196,

105572

"description": "Detects Palms WebOS version",

105573

"itemtype": "property",

105574

"name": "webos",

105575

"type": "float",

105576

"static": 1,

105577

"class": "UA",

105578

"module": "yui",

105579

"submodule": "yui-base"

105580

},

105581

{

105582

"file": "yui/js/yui-ua.js",

105583

"line": 204,

105584

"description": "Google Caja version number or 0.",

105585

"itemtype": "property",

105586

"name": "caja",

105587

"type": "float",

105588

"class": "UA",

105589

"module": "yui",

105590

"submodule": "yui-base"

105591

},

105592

{

105593

"file": "yui/js/yui-ua.js",

105594

"line": 211,

105595

"description": "Set to true if the page appears to be in SSL",

105596

"itemtype": "property",

105597

"name": "secure",

105598

"type": "boolean",

105599

"static": 1,

105600

"class": "UA",

105601

"module": "yui",

105602

"submodule": "yui-base"

105603

},

105604

{

105605

"file": "yui/js/yui-ua.js",

105606

"line": 219,

105607

"description": "The operating system. Currently only detecting windows or macintosh",

105608

"itemtype": "property",

105609

"name": "os",

105610

"type": "string",

105611

"default": "null",

105612

"static": 1,

105613

"class": "UA",

105614

"module": "yui",

105615

"submodule": "yui-base"

105616

},

105617

{

105618

"file": "yui/js/yui-ua.js",

105619

"line": 228,

105620

"description": "The Nodejs Version",

105621

"itemtype": "property",

105622

"name": "nodejs",

105623

"type": "float",

105624

"default": "0",

105625

"static": 1,

105626

"class": "UA",

105627

"module": "yui",

105628

"submodule": "yui-base"

105629

},

105630

{

105631

"file": "yui/js/yui-ua.js",

105632

"line": 246,

105633

"description": "The User Agent string that was parsed",

105634

"itemtype": "property",

105635

"name": "userAgent",

105636

"type": "String",

105637

"static": 1,

105638

"class": "UA",

105639

"module": "yui",

105640

"submodule": "yui-base"

105641

},

105642

{

105643

"file": "yui/js/yui-ua.js",

105644

"line": 422,

105645

"description": "Performs a simple comparison between two version numbers, accounting for\nstandard versioning logic such as the fact that \"535.8\" is a lower version than\n\"535.24\", even though a simple numerical comparison would indicate that it's\ngreater. Also accounts for cases such as \"1.1\" vs. \"1.1.0\", which are\nconsidered equivalent.\n\nReturns -1 if version _a_ is lower than version _b_, 0 if they're equivalent,\n1 if _a_ is higher than _b_.\n\nVersions may be numbers or strings containing numbers and dots. For example,\nboth `535` and `\"535.8.10\"` are acceptable. A version string containing\nnon-numeric characters, like `\"535.8.beta\"`, may produce unexpected results.",

105646

"itemtype": "method",

105647

"name": "compareVersions",

105648

"params": [

105649

{

105650

"name": "a",

105651

"description": "First version number to compare.",

105652

"type": "Number|String"

105653

},

105654

{

105655

"name": "b",

105656

"description": "Second version number to compare.",

105657

"type": "Number|String"

105658

}

105659

],

105660

"return": {

105661

"description": "-1 if _a_ is lower than _b_, 0 if they're equivalent, 1 if _a_ is\n higher than _b_."

105662

},

105663

"class": "UA",

105664

"module": "yui",

105665

"submodule": "yui-base"

105666

},

105667

{

105668

"file": "yui/js/yui.js",

105669

"line": 69,

105670

"description": "YUI.GlobalConfig is a master configuration that might span\nmultiple contexts in a non-browser environment. It is applied\nfirst to all instances in all contexts.",

105671

"itemtype": "property",

105672

"name": "GlobalConfig",

105673

"type": "{Object}",

105674

"global": "",

105675

"static": 1,

105676

"example": [

105677

"\n\n\n YUI.GlobalConfig = {\n filter: 'debug'\n };\n\n YUI().use('node', function(Y) {\n //debug files used here\n });\n\n YUI({\n filter: 'min'\n }).use('node', function(Y) {\n //min files used here\n });\n"

105678

],

105679

"class": "YUI",

105680

"module": "yui",

105681

"submodule": "yui-base"

105682

},

105683

{

105684

"file": "yui/js/yui.js",

105685

"line": 99,

105686

"description": "YUI_config is a page-level config. It is applied to all\ninstances created on the page. This is applied after\nYUI.GlobalConfig, and before the instance level configuration\nobjects.",

105687

"global": "",

105688

"itemtype": "property",

105689

"name": "YUI_config",

105690

"type": "{Object}",

105691

"example": [

105692

"\n\n\n //Single global var to include before YUI seed file\n YUI_config = {\n filter: 'debug'\n };\n\n YUI().use('node', function(Y) {\n //debug files used here\n });\n\n YUI({\n filter: 'min'\n }).use('node', function(Y) {\n //min files used here\n });"

105693

],

105694

"class": "YUI",

105695

"module": "yui",

105696

"submodule": "yui-base"

105697

},

105698

{

105699

"file": "yui/js/yui.js",

105700

"line": 239,

105701

"description": "Applies a new configuration object to the YUI instance config.\nThis will merge new group/module definitions, and will also\nupdate the loader cache if necessary. Updating Y.config directly\nwill not update the cache.",

105702

"itemtype": "method",

105703

"name": "applyConfig",

105704

"params": [

105705

{

105706

"name": "o",

105707

"description": "the configuration object.",

105708

"type": "Object"

105709

}

105710

],

105711

"since": "3.2.0",

105712

"class": "YUI",

105713

"module": "yui",

105714

"submodule": "yui-base"

105715

},

105716

{

105717

"file": "yui/js/yui.js",

105718

"line": 286,

105719

"description": "Old way to apply a config to the instance (calls `applyConfig` under the hood)",

105720

"access": "private",

105721

"tagname": "",

105722

"itemtype": "method",

105723

"name": "_config",

105724

"params": [

105725

{

105726

"name": "o",

105727

"description": "The config to apply",

105728

"type": "Object"

105729

}

105730

],

105731

"class": "YUI",

105732

"module": "yui",

105733

"submodule": "yui-base"

105734

},

105735

{

105736

"file": "yui/js/yui.js",

105737

"line": 296,

105738

"description": "Initialize this YUI instance",

105739

"access": "private",

105740

"tagname": "",

105741

"itemtype": "method",

105742

"name": "_init",

105743

"class": "YUI",

105744

"module": "yui",

105745

"submodule": "yui-base"

105746

},

105747

{

105748

"file": "yui/js/yui.js",

105749

"line": 308,

105750

"description": "The version number of the YUI instance.",

105751

"itemtype": "property",

105752

"name": "version",

105753

"type": "string",

105754

"class": "YUI",

105755

"module": "yui",

105756

"submodule": "yui-base"

105757

},

105758

{

105759

"file": "yui/js/yui.js",

105760

"line": 470,

105761

"description": "Finishes the instance setup. Attaches whatever modules were defined\nwhen the yui modules was registered.",

105762

"itemtype": "method",

105763

"name": "_setup",

105764

"access": "private",

105765

"tagname": "",

105766

"class": "YUI",

105767

"module": "yui",

105768

"submodule": "yui-base"

105769

},

105770

{

105771

"file": "yui/js/yui.js",

105772

"line": 499,

105773

"description": "Executes a method on a YUI instance with\nthe specified id if the specified method is whitelisted.",

105774

"itemtype": "method",

105775

"name": "applyTo",

105776

"params": [

105777

{

105778

"name": "id",

105779

"description": "the YUI instance id.",

105780

"type": "String"

105781

},

105782

{

105783

"name": "method",

105784

"description": "the name of the method to exectute.\nEx: 'Object.keys'.",

105785

"type": "String"

105786

},

105787

{

105788

"name": "args",

105789

"description": "the arguments to apply to the method.",

105790

"type": "Array"

105791

}

105792

],

105793

"return": {

105794

"description": "the return value from the applied method or null.",

105795

"type": "Object"

105796

},

105797

"class": "YUI",

105798

"module": "yui",

105799

"submodule": "yui-base"

105800

},

105801

{

105802

"file": "yui/js/yui.js",

105803

"line": 531,

105804

"description": "Registers a module with the YUI global. The easiest way to create a\nfirst-class YUI module is to use the YUI component build tool.\n\nhttp://yuilibrary.com/projects/builder\n\nThe build system will produce the `YUI.add` wrapper for you module, along\nwith any configuration info required for the module.",

105805

"itemtype": "method",

105806

"name": "add",

105807

"params": [

105808

{

105809

"name": "name",

105810

"description": "module name.",

105811

"type": "String"

105812

},

105813

{

105814

"name": "fn",

105815

"description": "entry point into the module that is used to bind module to the YUI instance.",

105816

"type": "Function",

105817

"props": [

105818

{

105819

"name": "Y",

105820

"description": "The YUI instance this module is executed in.",

105821

"type": "YUI"

105822

},

105823

{

105824

"name": "name",

105825

"description": "The name of the module",

105826

"type": "String"

105827

}

105828

]

105829

},

105830

{

105831

"name": "version",

105832

"description": "version string.",

105833

"type": "String"

105834

},

105835

{

105836

"name": "details",

105837

"description": "optional config data:",

105838

"type": "Object",

105839

"props": [

105840

{

105841

"name": "requires",

105842

"description": "features that must be present before this module can be attached.",

105843

"type": "Array"

105844

},

105845

{

105846

"name": "optional",

105847

"description": "optional features that should be present if loadOptional\n is defined. Note: modules are not often loaded this way in YUI 3,\n but this field is still useful to inform the user that certain\n features in the component will require additional dependencies.",

105848

"type": "Array"

105849

},

105850

{

105851

"name": "use",

105852

"description": "features that are included within this module which need to\n be attached automatically when this module is attached. This\n supports the YUI 3 rollup system -- a module with submodules\n defined will need to have the submodules listed in the 'use'\n config. The YUI component build tool does this for you.",

105853

"type": "Array"

105854

}

105855

]

105856

}

105857

],

105858

"return": {

105859

"description": "the YUI instance.",

105860

"type": "YUI"

105861

},

105862

"example": [

105863

"\n\n YUI.add('davglass', function(Y, name) {\n Y.davglass = function() {\n alert('Dav was here!');\n };\n }, '3.4.0', { requires: ['yui-base', 'harley-davidson', 'mt-dew'] });\n"

105864

],

105865

"class": "YUI",

105866

"module": "yui",

105867

"submodule": "yui-base"

105868

},

105869

{

105870

"file": "yui/js/yui.js",

105871

"line": 596,

105872

"description": "Executes the function associated with each required\nmodule, binding the module to the YUI instance.",

105873

"params": [

105874

{

105875

"name": "r",

105876

"description": "The array of modules to attach",

105877

"type": "Array"

105878

},

105879

{

105880

"name": "moot",

105881

"description": "Don't throw a warning if the module is not attached",

105882

"type": "Boolean",

105883

"optional": true,

105884

"optdefault": "false"

105885

}

105886

],

105887

"itemtype": "method",

105888

"name": "_attach",

105889

"access": "private",

105890

"tagname": "",

105891

"class": "YUI",

105892

"module": "yui",

105893

"submodule": "yui-base"

105894

},

105895

{

105896

"file": "yui/js/yui.js",

105897

"line": 724,

105898

"description": "Attaches one or more modules to the YUI instance. When this\nis executed, the requirements are analyzed, and one of\nseveral things can happen:\n\n * All requirements are available on the page -- The modules\n are attached to the instance. If supplied, the use callback\n is executed synchronously.\n\n * Modules are missing, the Get utility is not available OR\n the 'bootstrap' config is false -- A warning is issued about\n the missing modules and all available modules are attached.\n\n * Modules are missing, the Loader is not available but the Get\n utility is and boostrap is not false -- The loader is bootstrapped\n before doing the following....\n\n * Modules are missing and the Loader is available -- The loader\n expands the dependency tree and fetches missing modules. When\n the loader is finshed the callback supplied to use is executed\n asynchronously.",

105899

"itemtype": "method",

105900

"name": "use",

105901

"params": [

105902

{

105903

"name": "modules",

105904

"description": "1-n modules to bind (uses arguments array).",

105905

"type": "String|Array",

105906

"multiple": true

105907

},

105908

{

105909

"name": "callback",

105910

"description": "callback function executed when\nthe instance has the required functionality. If included, it\nmust be the last parameter.",

105911

"type": "Function",

105912

"optional": true,

105913

"props": [

105914

{

105915

"name": "Y",

105916

"description": "The `YUI` instance created for this sandbox",

105917

"type": "YUI"

105918

},

105919

{

105920

"name": "data",

105921

"description": "Object data returned from `Loader`.",

105922

"type": "Object"

105923

}

105924

]

105925

}

105926

],

105927

"example": [

105928

"\n // loads and attaches dd and its dependencies\n YUI().use('dd', function(Y) {});\n\n // loads and attaches dd and node as well as all of their dependencies (since 3.4.0)\n YUI().use(['dd', 'node'], function(Y) {});\n\n // attaches all modules that are available on the page\n YUI().use('*', function(Y) {});\n\n // intrinsic YUI gallery support (since 3.1.0)\n YUI().use('gallery-yql', function(Y) {});\n\n // intrinsic YUI 2in3 support (since 3.1.0)\n YUI().use('yui2-datatable', function(Y) {});"

105929

],

105930

"return": {

105931

"description": "the YUI instance.",

105932

"type": "YUI"

105933

},

105934

"class": "YUI",

105935

"module": "yui",

105936

"submodule": "yui-base"

105937

},

105938

{

105939

"file": "yui/js/yui.js",

105940

"line": 820,

105941

"description": "Notify handler from Loader for attachment/load errors",

105942

"itemtype": "method",

105943

"name": "_notify",

105944

"params": [

105945

{

105946

"name": "callback",

105947

"description": "The callback to pass to the `Y.config.loadErrorFn`",

105948

"type": "Function"

105949

},

105950

{

105951

"name": "response",

105952

"description": "The response returned from Loader",

105953

"type": "Object"

105954

},

105955

{

105956

"name": "args",

105957

"description": "The aruments passed from Loader",

105958

"type": "Array"

105959

}

105960

],

105961

"access": "private",

105962

"tagname": "",

105963

"class": "YUI",

105964

"module": "yui",

105965

"submodule": "yui-base"

105966

},

105967

{

105968

"file": "yui/js/yui.js",

105969

"line": 840,

105970

"description": "This private method is called from the `use` method queue. To ensure that only one set of loading\nlogic is performed at a time.",

105971

"itemtype": "method",

105972

"name": "_use",

105973

"access": "private",

105974

"tagname": "",

105975

"params": [

105976

{

105977

"name": "args",

105978

"description": "1-n modules to bind (uses arguments array).",

105979

"type": "String",

105980

"multiple": true

105981

},

105982

{

105983

"name": "*callback",

105984

"description": "callback function executed when\nthe instance has the required functionality. If included, it\nmust be the last parameter.",

105985

"type": "Function"

105986

}

105987

],

105988

"class": "YUI",

105989

"module": "yui",

105990

"submodule": "yui-base"

105991

},

105992

{

105993

"file": "yui/js/yui.js",

105994

"line": 1073,

105995

"description": "Adds a namespace object onto the YUI global if called statically.\n\n // creates YUI.your.namespace.here as nested objects\n YUI.namespace(\"your.namespace.here\");\n\nIf called as a method on a YUI instance, it creates the\nnamespace on the instance.\n\n // creates Y.property.package\n Y.namespace(\"property.package\");\n\nDots in the input string cause `namespace` to create nested objects for\neach token. If any part of the requested namespace already exists, the\ncurrent object will be left in place. This allows multiple calls to\n`namespace` to preserve existing namespaced properties.\n\nIf the first token in the namespace string is \"YAHOO\", the token is\ndiscarded.\n\nBe careful with namespace tokens. Reserved words may work in some browsers\nand not others. For instance, the following will fail in some browsers\nbecause the supported version of JavaScript reserves the word \"long\":\n\n Y.namespace(\"really.long.nested.namespace\");\n\nNote: If you pass multiple arguments to create multiple namespaces, only\nthe last one created is returned from this function.",

105996

"itemtype": "method",

105997

"name": "namespace",

105998

"params": [

105999

{

106000

"name": "namespace",

106001

"description": "namespaces to create.",

106002

"type": "String",

106003

"multiple": true

106004

}

106005

],

106006

"return": {

106007

"description": "A reference to the last namespace object created.",

106008

"type": "Object"

106009

},

106010

"class": "YUI",

106011

"module": "yui",

106012

"submodule": "yui-base"

106013

},

106014

{

106015

"file": "yui/js/yui.js",

106016

"line": 1132,

106017

"description": "Report an error. The reporting mechanism is controlled by\nthe `throwFail` configuration attribute. If throwFail is\nnot specified, the message is written to the Logger, otherwise\na JS error is thrown. If an `errorFn` is specified in the config\nit must return `true` to keep the error from being thrown.",

106018

"itemtype": "method",

106019

"name": "error",

106020

"params": [

106021

{

106022

"name": "msg",

106023

"description": "the error message.",

106024

"type": "String"

106025

},

106026

{

106027

"name": "e",

106028

"description": "Optional JS error that was caught, or an error string.",

106029

"type": "Error|String"

106030

},

106031

{

106032

"name": "src",

106033

"description": "Optional additional info (passed to `Y.config.errorFn` and `Y.message`)\nand `throwFail` is specified, this error will be re-thrown."

106034

}

106035

],

106036

"return": {

106037

"description": "this YUI instance.",

106038

"type": "YUI"

106039

},

106040

"class": "YUI",

106041

"module": "yui",

106042

"submodule": "yui-base"

106043

},

106044

{

106045

"file": "yui/js/yui.js",

106046

"line": 1163,

106047

"description": "Generate an id that is unique among all YUI instances",

106048

"itemtype": "method",

106049

"name": "guid",

106050

"params": [

106051

{

106052

"name": "pre",

106053

"description": "optional guid prefix.",

106054

"type": "String"

106055

}

106056

],

106057

"return": {

106058

"description": "the guid.",

106059

"type": "String"

106060

},

106061

"class": "YUI",

106062

"module": "yui",

106063

"submodule": "yui-base"

106064

},

106065

{

106066

"file": "yui/js/yui.js",

106067

"line": 1174,

106068

"description": "Returns a `guid` associated with an object. If the object\ndoes not have one, a new one is created unless `readOnly`\nis specified.",

106069

"itemtype": "method",

106070

"name": "stamp",

106071

"params": [

106072

{

106073

"name": "o",

106074

"description": "The object to stamp.",

106075

"type": "Object"

106076

},

106077

{

106078

"name": "readOnly",

106079

"description": "if `true`, a valid guid will only\nbe returned if the object has one assigned to it.",

106080

"type": "Boolean"

106081

}

106082

],

106083

"return": {

106084

"description": "The object's guid or null.",

106085

"type": "String"

106086

},

106087

"class": "YUI",

106088

"module": "yui",

106089

"submodule": "yui-base"

106090

},

106091

{

106092

"file": "yui/js/yui.js",

106093

"line": 1211,

106094

"description": "Destroys the YUI instance",

106095

"itemtype": "method",

106096

"name": "destroy",

106097

"since": "3.3.0",

106098

"class": "YUI",

106099

"module": "yui",

106100

"submodule": "yui-base"

106101

},

106102

{

106103

"file": "yui/js/yui.js",

106104

"line": 1226,

106105

"description": "instanceof check for objects that works around\nmemory leak in IE when the item tested is\nwindow/document",

106106

"itemtype": "method",

106107

"name": "instanceOf",

106108

"params": [

106109

{

106110

"name": "o",

106111

"description": "The object to check.",

106112

"type": "Object"

106113

},

106114

{

106115

"name": "type",

106116

"description": "The class to check against.",

106117

"type": "Object"

106118

}

106119

],

106120

"since": "3.3.0",

106121

"class": "YUI",

106122

"module": "yui",

106123

"submodule": "yui-base"

106124

},

106125

{

106126

"file": "yui/js/yui.js",

106127

"line": 1246,

106128

"description": "Static method on the Global YUI object to apply a config to all YUI instances.\nIt's main use case is \"mashups\" where several third party scripts are trying to write to\na global YUI config at the same time. This way they can all call `YUI.applyConfig({})` instead of\noverwriting other scripts configs.",

106129

"static": 1,

106130

"since": "3.5.0",

106131

"itemtype": "method",

106132

"name": "applyConfig",

106133

"params": [

106134

{

106135

"name": "o",

106136

"description": "the configuration object.",

106137

"type": "Object"

106138

}

106139

],

106140

"example": [

106141

"\n\n YUI.applyConfig({\n modules: {\n davglass: {\n fullpath: './davglass.js'\n }\n }\n });\n\n YUI.applyConfig({\n modules: {\n foo: {\n fullpath: './foo.js'\n }\n }\n });\n\n YUI().use('davglass', function(Y) {\n //Module davglass will be available here..\n });\n"

106142

],

106143

"class": "YUI",

106144

"module": "yui",

106145

"submodule": "yui-base"

106146

},

106147

{

106148

"file": "yui/js/yui.js",

106149

"line": 1329,

106150

"description": "Allows the YUI seed file to fetch the loader component and library\nmetadata to dynamically load additional dependencies.",

106151

"itemtype": "property",

106152

"name": "bootstrap",

106153

"type": "boolean",

106154

"default": "true",

106155

"class": "config",

106156

"module": "yui",

106157

"submodule": "yui-base"

106158

},

106159

{

106160

"file": "yui/js/yui.js",

106161

"line": 1338,

106162

"description": "Turns on writing Ylog messages to the browser console.",

106163

"itemtype": "property",

106164

"name": "debug",

106165

"type": "boolean",

106166

"default": "true",

106167

"class": "config",

106168

"module": "yui",

106169

"submodule": "yui-base"

106170

},

106171

{

106172

"file": "yui/js/yui.js",

106173

"line": 1346,

106174

"description": "Log to the browser console if debug is on and the browser has a\nsupported console.",

106175

"itemtype": "property",

106176

"name": "useBrowserConsole",

106177

"type": "boolean",

106178

"default": "true",

106179

"class": "config",

106180

"module": "yui",

106181

"submodule": "yui-base"

106182

},

106183

{

106184

"file": "yui/js/yui.js",

106185

"line": 1355,

106186

"description": "A hash of log sources that should be logged. If specified, only\nlog messages from these sources will be logged.",

106187

"itemtype": "property",

106188

"name": "logInclude",

106189

"type": "object",

106190

"class": "config",

106191

"module": "yui",

106192

"submodule": "yui-base"

106193

},

106194

{

106195

"file": "yui/js/yui.js",

106196

"line": 1363,

106197

"description": "A hash of log sources that should be not be logged. If specified,\nall sources are logged if not on this list.",

106198

"itemtype": "property",

106199

"name": "logExclude",

106200

"type": "object",

106201

"class": "config",

106202

"module": "yui",

106203

"submodule": "yui-base"

106204

},

106205

{

106206

"file": "yui/js/yui.js",

106207

"line": 1371,

106208

"description": "Set to true if the yui seed file was dynamically loaded in\norder to bootstrap components relying on the window load event\nand the `domready` custom event.",

106209

"itemtype": "property",

106210

"name": "injected",

106211

"type": "boolean",

106212

"default": "false",

106213

"class": "config",

106214

"module": "yui",

106215

"submodule": "yui-base"

106216

},

106217

{

106218

"file": "yui/js/yui.js",

106219

"line": 1381,

106220

"description": "If `throwFail` is set, `Y.error` will generate or re-throw a JS Error.\nOtherwise the failure is logged.",

106221

"itemtype": "property",

106222

"name": "throwFail",

106223

"type": "boolean",

106224

"default": "true",

106225

"class": "config",

106226

"module": "yui",

106227

"submodule": "yui-base"

106228

},

106229

{

106230

"file": "yui/js/yui.js",

106231

"line": 1390,

106232

"description": "The window/frame that this instance should operate in.",

106233

"itemtype": "property",

106234

"name": "win",

106235

"type": "Window",

106236

"default": "the window hosting YUI",

106237

"class": "config",

106238

"module": "yui",

106239

"submodule": "yui-base"

106240

},

106241

{

106242

"file": "yui/js/yui.js",

106243

"line": 1398,

106244

"description": "The document associated with the 'win' configuration.",

106245

"itemtype": "property",

106246

"name": "doc",

106247

"type": "Document",

106248

"default": "the document hosting YUI",

106249

"class": "config",

106250

"module": "yui",

106251

"submodule": "yui-base"

106252

},

106253

{

106254

"file": "yui/js/yui.js",

106255

"line": 1406,

106256

"description": "A list of modules that defines the YUI core (overrides the default list).",

106257

"itemtype": "property",

106258

"name": "core",

106259

"type": "Array",

106260

"default": "[ get,features,intl-base,yui-log,yui-later,loader-base, loader-rollup, loader-yui3 ]",

106261

"class": "config",

106262

"module": "yui",

106263

"submodule": "yui-base"

106264

},

106265

{

106266

"file": "yui/js/yui.js",

106267

"line": 1414,

106268

"description": "A list of languages in order of preference. This list is matched against\nthe list of available languages in modules that the YUI instance uses to\ndetermine the best possible localization of language sensitive modules.\nLanguages are represented using BCP 47 language tags, such as \"en-GB\" for\nEnglish as used in the United Kingdom, or \"zh-Hans-CN\" for simplified\nChinese as used in China. The list can be provided as a comma-separated\nlist or as an array.",

106269

"itemtype": "property",

106270

"name": "lang",

106271

"type": "string|string[]",

106272

"class": "config",

106273

"module": "yui",

106274

"submodule": "yui-base"

106275

},

106276

{

106277

"file": "yui/js/yui.js",

106278

"line": 1427,

106279

"description": "The default date format",

106280

"itemtype": "property",

106281

"name": "dateFormat",

106282

"type": "string",

106283

"deprecated": true,

106284

"deprecationMessage": "use configuration in `DataType.Date.format()` instead.",

106285

"class": "config",

106286

"module": "yui",

106287

"submodule": "yui-base"

106288

},

106289

{

106290

"file": "yui/js/yui.js",

106291

"line": 1434,

106292

"description": "The default locale",

106293

"itemtype": "property",

106294

"name": "locale",

106295

"type": "string",

106296

"deprecated": true,

106297

"deprecationMessage": "use `config.lang` instead.",

106298

"class": "config",

106299

"module": "yui",

106300

"submodule": "yui-base"

106301

},

106302

{

106303

"file": "yui/js/yui.js",

106304

"line": 1441,

106305

"description": "The default interval when polling in milliseconds.",

106306

"itemtype": "property",

106307

"name": "pollInterval",

106308

"type": "int",

106309

"default": "20",

106310

"class": "config",

106311

"module": "yui",

106312

"submodule": "yui-base"

106313

},

106314

{

106315

"file": "yui/js/yui.js",

106316

"line": 1448,

106317

"description": "The number of dynamic nodes to insert by default before\nautomatically removing them. This applies to script nodes\nbecause removing the node will not make the evaluated script\nunavailable. Dynamic CSS is not auto purged, because removing\na linked style sheet will also remove the style definitions.",

106318

"itemtype": "property",

106319

"name": "purgethreshold",

106320

"type": "int",

106321

"default": "20",

106322

"class": "config",

106323

"module": "yui",

106324

"submodule": "yui-base"

106325

},

106326

{

106327

"file": "yui/js/yui.js",

106328

"line": 1459,

106329

"description": "The default interval when polling in milliseconds.",

106330

"itemtype": "property",

106331

"name": "windowResizeDelay",

106332

"type": "int",

106333

"default": "40",

106334

"class": "config",

106335

"module": "yui",

106336

"submodule": "yui-base"

106337

},

106338

{

106339

"file": "yui/js/yui.js",

106340

"line": 1466,

106341

"description": "Base directory for dynamic loading",

106342

"itemtype": "property",

106343

"name": "base",

106344

"type": "string",

106345

"class": "config",

106346

"module": "yui",

106347

"submodule": "yui-base"

106348

},

106349

{

106350

"file": "yui/js/yui.js",

106351

"line": 1479,

106352

"description": "The YUI combo service base dir. Ex: `http://yui.yahooapis.com/combo?`\nFor dynamic loading.",

106353

"itemtype": "property",

106354

"name": "comboBase",

106355

"type": "string",

106356

"class": "config",

106357

"module": "yui",

106358

"submodule": "yui-base"

106359

},

106360

{

106361

"file": "yui/js/yui.js",

106362

"line": 1486,

106363

"description": "The root path to prepend to module path for the combo service.\nEx: 3.0.0b1/build/\nFor dynamic loading.",

106364

"itemtype": "property",

106365

"name": "root",

106366

"type": "string",

106367

"class": "config",

106368

"module": "yui",

106369

"submodule": "yui-base"

106370

},

106371

{

106372

"file": "yui/js/yui.js",

106373

"line": 1494,

106374

"description": "A filter to apply to result urls. This filter will modify the default\npath for all modules. The default path for the YUI library is the\nminified version of the files (e.g., event-min.js). The filter property\ncan be a predefined filter or a custom filter. The valid predefined\nfilters are:\n<dl>\n <dt>DEBUG</dt>\n <dd>Selects the debug versions of the library (e.g., event-debug.js).\n This option will automatically include the Logger widget</dd>\n <dt>RAW</dt>\n <dd>Selects the non-minified version of the library (e.g., event.js).</dd>\n</dl>\nYou can also define a custom filter, which must be an object literal\ncontaining a search expression and a replace string:\n\n myFilter: {\n 'searchExp': \"-min\\\\.js\",\n 'replaceStr': \"-debug.js\"\n }\n\nFor dynamic loading.",

106375

"itemtype": "property",

106376

"name": "filter",

106377

"type": "string|object",

106378

"class": "config",

106379

"module": "yui",

106380

"submodule": "yui-base"

106381

},

106382

{

106383

"file": "yui/js/yui.js",

106384

"line": 1521,

106385

"description": "The `skin` config let's you configure application level skin\ncustomizations. It contains the following attributes which\ncan be specified to override the defaults:\n\n // The default skin, which is automatically applied if not\n // overriden by a component-specific skin definition.\n // Change this in to apply a different skin globally\n defaultSkin: 'sam',\n\n // This is combined with the loader base property to get\n // the default root directory for a skin.\n base: 'assets/skins/',\n\n // Any component-specific overrides can be specified here,\n // making it possible to load different skins for different\n // components. It is possible to load more than one skin\n // for a given component as well.\n overrides: {\n slider: ['capsule', 'round']\n }\n\nFor dynamic loading.",

106386

"itemtype": "property",

106387

"name": "skin",

106388

"class": "config",

106389

"module": "yui",

106390

"submodule": "yui-base"

106391

},

106392

{

106393

"file": "yui/js/yui.js",

106394

"line": 1548,

106395

"description": "Hash of per-component filter specification. If specified for a given\ncomponent, this overrides the filter config.\n\nFor dynamic loading.",

106396

"itemtype": "property",

106397

"name": "filters",

106398

"class": "config",

106399

"module": "yui",

106400

"submodule": "yui-base"

106401

},

106402

{

106403

"file": "yui/js/yui.js",

106404

"line": 1557,

106405

"description": "Use the YUI combo service to reduce the number of http connections\nrequired to load your dependencies. Turning this off will\ndisable combo handling for YUI and all module groups configured\nwith a combo service.\n\nFor dynamic loading.",

106406

"itemtype": "property",

106407

"name": "combine",

106408

"type": "boolean",

106409

"default": "true if 'base' is not supplied, false if it is.",

106410

"class": "config",

106411

"module": "yui",

106412

"submodule": "yui-base"

106413

},

106414

{

106415

"file": "yui/js/yui.js",

106416

"line": 1570,

106417

"description": "A list of modules that should never be dynamically loaded",

106418

"itemtype": "property",

106419

"name": "ignore",

106420

"type": "string[]",

106421

"class": "config",

106422

"module": "yui",

106423

"submodule": "yui-base"

106424

},

106425

{

106426

"file": "yui/js/yui.js",

106427

"line": 1577,

106428

"description": "A list of modules that should always be loaded when required, even if already\npresent on the page.",

106429

"itemtype": "property",

106430

"name": "force",

106431

"type": "string[]",

106432

"class": "config",

106433

"module": "yui",

106434

"submodule": "yui-base"

106435

},

106436

{

106437

"file": "yui/js/yui.js",

106438

"line": 1585,

106439

"description": "Node or id for a node that should be used as the insertion point for new\nnodes. For dynamic loading.",

106440

"itemtype": "property",

106441

"name": "insertBefore",

106442

"type": "string",

106443

"class": "config",

106444

"module": "yui",

106445

"submodule": "yui-base"

106446

},

106447

{

106448

"file": "yui/js/yui.js",

106449

"line": 1593,

106450

"description": "Object literal containing attributes to add to dynamically loaded script\nnodes.",

106451

"itemtype": "property",

106452

"name": "jsAttributes",

106453

"type": "string",

106454

"class": "config",

106455

"module": "yui",

106456

"submodule": "yui-base"

106457

},

106458

{

106459

"file": "yui/js/yui.js",

106460

"line": 1600,

106461

"description": "Object literal containing attributes to add to dynamically loaded link\nnodes.",

106462

"itemtype": "property",

106463

"name": "cssAttributes",

106464

"type": "string",

106465

"class": "config",

106466

"module": "yui",

106467

"submodule": "yui-base"

106468

},

106469

{

106470

"file": "yui/js/yui.js",

106471

"line": 1607,

106472

"description": "Number of milliseconds before a timeout occurs when dynamically\nloading nodes. If not set, there is no timeout.",

106473

"itemtype": "property",

106474

"name": "timeout",

106475

"type": "int",

106476

"class": "config",

106477

"module": "yui",

106478

"submodule": "yui-base"

106479

},

106480

{

106481

"file": "yui/js/yui.js",

106482

"line": 1614,

106483

"description": "Callback for the 'CSSComplete' event. When dynamically loading YUI\ncomponents with CSS, this property fires when the CSS is finished\nloading but script loading is still ongoing. This provides an\nopportunity to enhance the presentation of a loading page a little\nbit before the entire loading process is done.",

106484

"itemtype": "property",

106485

"name": "onCSS",

106486

"type": "function",

106487

"class": "config",

106488

"module": "yui",

106489

"submodule": "yui-base"

106490

},

106491

{

106492

"file": "yui/js/yui.js",

106493

"line": 1625,

106494

"description": "A hash of module definitions to add to the list of YUI components.\nThese components can then be dynamically loaded side by side with\nYUI via the `use()` method. This is a hash, the key is the module\nname, and the value is an object literal specifying the metdata\nfor the module. See `Loader.addModule` for the supported module\nmetadata fields. Also see groups, which provides a way to\nconfigure the base and combo spec for a set of modules.\n\n modules: {\n mymod1: {\n requires: ['node'],\n fullpath: '/mymod1/mymod1.js'\n },\n mymod2: {\n requires: ['mymod1'],\n fullpath: '/mymod2/mymod2.js'\n },\n mymod3: '/js/mymod3.js',\n mycssmod: '/css/mycssmod.css'\n }",

106495

"itemtype": "property",

106496

"name": "modules",

106497

"type": "object",

106498

"class": "config",

106499

"module": "yui",

106500

"submodule": "yui-base"

106501

},

106502

{

106503

"file": "yui/js/yui.js",

106504

"line": 1652,

106505

"description": "Aliases are dynamic groups of modules that can be used as\nshortcuts.\n\n YUI({\n aliases: {\n davglass: [ 'node', 'yql', 'dd' ],\n mine: [ 'davglass', 'autocomplete']\n }\n }).use('mine', function(Y) {\n //Node, YQL, DD & AutoComplete available here..\n });",

106506

"itemtype": "property",

106507

"name": "aliases",

106508

"type": "object",

106509

"class": "config",

106510

"module": "yui",

106511

"submodule": "yui-base"

106512

},

106513

{

106514

"file": "yui/js/yui.js",

106515

"line": 1669,

106516

"description": "A hash of module group definitions. It for each group you\ncan specify a list of modules and the base path and\ncombo spec to use when dynamically loading the modules.\n\n groups: {\n yui2: {\n // specify whether or not this group has a combo service\n combine: true,\n\n // The comboSeperator to use with this group's combo handler\n comboSep: ';',\n\n // The maxURLLength for this server\n maxURLLength: 500,\n\n // the base path for non-combo paths\n base: 'http://yui.yahooapis.com/2.8.0r4/build/',\n\n // the path to the combo service\n comboBase: 'http://yui.yahooapis.com/combo?',\n\n // a fragment to prepend to the path attribute when\n // when building combo urls\n root: '2.8.0r4/build/',\n\n // the module definitions\n modules: {\n yui2_yde: {\n path: \"yahoo-dom-event/yahoo-dom-event.js\"\n },\n yui2_anim: {\n path: \"animation/animation.js\",\n requires: ['yui2_yde']\n }\n }\n }\n }",

106517

"itemtype": "property",

106518

"name": "groups",

106519

"type": "object",

106520

"class": "config",

106521

"module": "yui",

106522

"submodule": "yui-base"

106523

},

106524

{

106525

"file": "yui/js/yui.js",

106526

"line": 1712,

106527

"description": "The loader 'path' attribute to the loader itself. This is combined\nwith the 'base' attribute to dynamically load the loader component\nwhen boostrapping with the get utility alone.",

106528

"itemtype": "property",

106529

"name": "loaderPath",

106530

"type": "string",

106531

"default": "loader/loader-min.js",

106532

"class": "config",

106533

"module": "yui",

106534

"submodule": "yui-base"

106535

},

106536

{

106537

"file": "yui/js/yui.js",

106538

"line": 1722,

106539

"description": "Specifies whether or not YUI().use(...) will attempt to load CSS\nresources at all. Any truthy value will cause CSS dependencies\nto load when fetching script. The special value 'force' will\ncause CSS dependencies to be loaded even if no script is needed.",

106540

"itemtype": "property",

106541

"name": "fetchCSS",

106542

"type": "boolean|string",

106543

"default": "true",

106544

"class": "config",

106545

"module": "yui",

106546

"submodule": "yui-base"

106547

},

106548

{

106549

"file": "yui/js/yui.js",

106550

"line": 1733,

106551

"description": "The default gallery version to build gallery module urls",

106552

"itemtype": "property",

106553

"name": "gallery",

106554

"type": "string",

106555

"since": "3.1.0",

106556

"class": "config",

106557

"module": "yui",

106558

"submodule": "yui-base"

106559

},

106560

{

106561

"file": "yui/js/yui.js",

106562

"line": 1740,

106563

"description": "The default YUI 2 version to build yui2 module urls. This is for\nintrinsic YUI 2 support via the 2in3 project. Also see the '2in3'\nconfig for pulling different revisions of the wrapped YUI 2\nmodules.",

106564

"since": "3.1.0",

106565

"itemtype": "property",

106566

"name": "yui2",

106567

"type": "string",

106568

"default": "2.9.0",

106569

"class": "config",

106570

"module": "yui",

106571

"submodule": "yui-base"

106572

},

106573

{

106574

"file": "yui/js/yui.js",

106575

"line": 1751,

106576

"description": "The 2in3 project is a deployment of the various versions of YUI 2\ndeployed as first-class YUI 3 modules. Eventually, the wrapper\nfor the modules will change (but the underlying YUI 2 code will\nbe the same), and you can select a particular version of\nthe wrapper modules via this config.",

106577

"since": "3.1.0",

106578

"itemtype": "property",

106579

"name": "2in3",

106580

"type": "string",

106581

"default": "4",

106582

"class": "config",

106583

"module": "yui",

106584

"submodule": "yui-base"

106585

},

106586

{

106587

"file": "yui/js/yui.js",

106588

"line": 1763,

106589

"description": "Alternative console log function for use in environments without\na supported native console. The function is executed in the\nYUI instance context.",

106590

"since": "3.1.0",

106591

"itemtype": "property",

106592

"name": "logFn",

106593

"type": "Function",

106594

"class": "config",

106595

"module": "yui",

106596

"submodule": "yui-base"

106597

},

106598

{

106599

"file": "yui/js/yui.js",

106600

"line": 1772,

106601

"description": "A callback to execute when Y.error is called. It receives the\nerror message and an javascript error object if Y.error was\nexecuted because a javascript error was caught. The function\nis executed in the YUI instance context. Returning `true` from this\nfunction will stop the Error from being thrown.",

106602

"since": "3.2.0",

106603

"itemtype": "property",

106604

"name": "errorFn",

106605

"type": "Function",

106606

"class": "config",

106607

"module": "yui",

106608

"submodule": "yui-base"

106609

},

106610

{

106611

"file": "yui/js/yui.js",

106612

"line": 1784,

106613

"description": "A callback to execute when the loader fails to load one or\nmore resource. This could be because of a script load\nfailure. It can also fail if a javascript module fails\nto register itself, but only when the 'requireRegistration'\nis true. If this function is defined, the use() callback will\nonly be called when the loader succeeds, otherwise it always\nexecutes unless there was a javascript error when attaching\na module.",

106614

"since": "3.3.0",

106615

"itemtype": "property",

106616

"name": "loadErrorFn",

106617

"type": "Function",

106618

"class": "config",

106619

"module": "yui",

106620

"submodule": "yui-base"

106621

},

106622

{

106623

"file": "yui/js/yui.js",

106624

"line": 1799,

106625

"description": "When set to true, the YUI loader will expect that all modules\nit is responsible for loading will be first-class YUI modules\nthat register themselves with the YUI global. If this is\nset to true, loader will fail if the module registration fails\nto happen after the script is loaded.",

106626

"since": "3.3.0",

106627

"itemtype": "property",

106628

"name": "requireRegistration",

106629

"type": "boolean",

106630

"default": "false",

106631

"class": "config",

106632

"module": "yui",

106633

"submodule": "yui-base"

106634

},

106635

{

106636

"file": "yui/js/yui.js",

106637

"line": 1812,

106638

"description": "Cache serviced use() requests.",

106639

"since": "3.3.0",

106640

"itemtype": "property",

106641

"name": "cacheUse",

106642

"type": "boolean",

106643

"default": "true",

106644

"deprecated": true,

106645

"deprecationMessage": "no longer used",

106646

"class": "config",

106647

"module": "yui",

106648

"submodule": "yui-base"

106649

},

106650

{

106651

"file": "yui/js/yui.js",

106652

"line": 1821,

106653

"description": "Whether or not YUI should use native ES5 functionality when available for\nfeatures like `Y.Array.each()`, `Y.Object()`, etc. When `false`, YUI will\nalways use its own fallback implementations instead of relying on ES5\nfunctionality, even when it's available.",

106654

"itemtype": "method",

106655

"name": "useNativeES5",

106656

"type": "Boolean",

106657

"default": "true",

106658

"since": "3.5.0",

106659

"class": "config",

106660

"module": "yui",

106661

"submodule": "yui-base"

106662

}

106663

]

106664

}

b'\\ No newline at end of file'