~bcsaller/juju-gui/charmFind

<p>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.</p>

1339

</div>

1340

1341

1342

1343

<h2>Constructor</h2>

1344

1345

<h3 class="name"><code>Plugin.DDConstrained</code></h3>

1346

1347

1348

1349

1350

1351

1352

1353

1354

1355

1356

1357

1358

1359

1360

1361

1362

1363

1364

1365

1366

1367

<p>

1368

1369

Defined in

1370

1371

1372

1373

1374

<a href="../files/dd_js_constrain.js.html#l8"><code>dd/js/constrain.js:8</code></a>

1375

1376

</p>

1377

1378

1379

1380

1381

1382

</div>

1383

1384

1385

1386

</div>

1387

1388

1389

1390

1391

1392

1393

</div>

1394

1395

</div>

1396

1397

1398

1399

1400

<li class="api-class-tab index"><a href="#index">Index</a></li>

1401

1402

1403

<li class="api-class-tab methods"><a href="#methods">Methods</a></li>

1404

1405

1406

<li class="api-class-tab properties"><a href="#properties">Properties</a></li>

1407

1408

1409

<li class="api-class-tab attrs"><a href="#attrs">Attributes</a></li>

1410

1411

1412

<li class="api-class-tab events"><a href="#events">Events</a></li>

1413

1414

</ul>

1415

1416

<div>

1417

1418

<h2 class="off-left">Item Index</h2>

1419

1420

1421

1422

<h3>Methods</h3>

1423

1424

1425

1426

1427

<a href="#method__addAttrs">_addAttrs</a>

1428

1429

1430

</li>

1431

1432

1433

<a href="#method__addLazyAttr">_addLazyAttr</a>

1434

1435

1436

</li>

1437

1438

1439

<a href="#method__aggregateAttrs">_aggregateAttrs</a>

1440

1441

1442

</li>

1443

1444

1445

<a href="#method__attrCfgHash">_attrCfgHash</a>

1446

1447

1448

</li>

1449

1450

1451

<a href="#method__baseDestroy">_baseDestroy</a>

1452

1453

1454

</li>

1455

1456

1457

<a href="#method__baseInit">_baseInit</a>

1458

1459

1460

</li>

1461

1462

1463

<a href="#method__cacheRegion">_cacheRegion</a>

1464

1465

1466

</li>

1467

1468

1469

<a href="#method__checkRegion">_checkRegion</a>

1470

1471

1472

</li>

1473

1474

1475

<a href="#method__checkTicks">_checkTicks</a>

1476

1477

1478

</li>

1479

1480

1481

<a href="#method__createEvents">_createEvents</a>

1482

1483

1484

</li>

1485

1486

1487

<a href="#method__defAttrChangeFn">_defAttrChangeFn</a>

1488

1489

1490

</li>

1491

1492

1493

<a href="#method__defDestroyFn">_defDestroyFn</a>

1494

1495

1496

</li>

1497

1498

1499

<a href="#method__defInitFn">_defInitFn</a>

1500

1501

1502

</li>

1503

1504

1505

<a href="#method__destroyHierarchy">_destroyHierarchy</a>

1506

1507

1508

</li>

1509

1510

1511

<a href="#method__filterAdHocAttrs">_filterAdHocAttrs</a>

1512

1513

1514

</li>

1515

1516

1517

<a href="#method__filterAttrCfs">_filterAttrCfs</a>

1518

1519

1520

</li>

1521

1522

1523

<a href="#method__fireAttrChange">_fireAttrChange</a>

1524

1525

1526

</li>

1527

1528

1529

<a href="#method__getAttr">_getAttr</a>

1530

1531

1532

</li>

1533

1534

1535

<a href="#method__getAttrCfg">_getAttrCfg</a>

1536

1537

1538

</li>

1539

1540

1541

<a href="#method__getAttrCfgs">_getAttrCfgs</a>

1542

1543

1544

</li>

1545

1546

1547

<a href="#method__getAttrInitVal">_getAttrInitVal</a>

1548

1549

1550

</li>

1551

1552

1553

<a href="#method__getAttrs">_getAttrs</a>

1554

1555

1556

</li>

1557

1558

1559

<a href="#method__getClasses">_getClasses</a>

1560

1561

1562

</li>

1563

1564

1565

<a href="#method__getConstraint">_getConstraint</a>

1566

1567

1568

</li>

1569

1570

1571

<a href="#method__getStateVal">_getStateVal</a>

1572

1573

1574

</li>

1575

1576

1577

<a href="#method__getType">_getType</a>

1578

1579

1580

</li>

1581

1582

1583

<a href="#method__handleEnd">_handleEnd</a>

1584

1585

1586

</li>

1587

1588

1589

<a href="#method__handleStart">_handleStart</a>

1590

1591

1592

</li>

1593

1594

1595

<a href="#method__initAttrHost">_initAttrHost</a>

1596

1597

1598

</li>

1599

1600

1601

<a href="#method__initAttribute">_initAttribute</a>

1602

1603

1604

</li>

1605

1606

1607

<a href="#method__initAttrs">_initAttrs</a>

1608

1609

1610

</li>

1611

1612

1613

<a href="#method__initBase">_initBase</a>

1614

1615

1616

</li>

1617

1618

1619

<a href="#method__initHierarchy">_initHierarchy</a>

1620

1621

1622

</li>

1623

1624

1625

<a href="#method__initHierarchyData">_initHierarchyData</a>

1626

1627

1628

</li>

1629

1630

1631

<a href="#method__isLazyAttr">_isLazyAttr</a>

1632

1633

1634

</li>

1635

1636

1637

<a href="#method__monitor">_monitor</a>

1638

1639

1640

</li>

1641

1642

1643

<a href="#method__normAttrVals">_normAttrVals</a>

1644

1645

1646

</li>

1647

1648

1649

<a href="#method__parseType">_parseType</a>

1650

1651

1652

</li>

1653

1654

1655

<a href="#method__preInitEventCfg">_preInitEventCfg</a>

1656

1657

1658

</li>

1659

1660

1661

<a href="#method__protectAttrs">_protectAttrs</a>

1662

1663

1664

</li>

1665

1666

1667

1668

1669

1670

</li>

1671

1672

1673

<a href="#method__setAttr">_setAttr</a>

1674

1675

1676

</li>

1677

1678

1679

<a href="#method__setAttrs">_setAttrs</a>

1680

1681

1682

</li>

1683

1684

1685

<a href="#method__setAttrVal">_setAttrVal</a>

1686

1687

1688

</li>

1689

1690

1691

<a href="#method__setStateVal">_setStateVal</a>

1692

1693

1694

</li>

1695

1696

1697

<a href="#method__tickAlignX">_tickAlignX</a>

1698

1699

1700

</li>

1701

1702

1703

<a href="#method__tickAlignY">_tickAlignY</a>

1704

1705

1706

</li>

1707

1708

1709

<a href="#method_addAttr">addAttr</a>

1710

1711

1712

</li>

1713

1714

1715

<a href="#method_addAttrs">addAttrs</a>

1716

1717

1718

</li>

1719

1720

1721

<a href="#method_addTarget">addTarget</a>

1722

1723

1724

</li>

1725

1726

1727

<a href="#method_after">after</a>

1728

1729

1730

</li>

1731

1732

1733

<a href="#method_align">align</a>

1734

1735

1736

</li>

1737

1738

1739

<a href="#method_attrAdded">attrAdded</a>

1740

1741

1742

</li>

1743

1744

1745

<a href="#method_before">before</a>

1746

1747

1748

</li>

1749

1750

1751

<a href="#method_bubble">bubble</a>

1752

1753

1754

</li>

1755

1756

1757

<a href="#method_destroy">destroy</a>

1758

1759

1760

</li>

1761

1762

1763

<a href="#method_detach">detach</a>

1764

1765

1766

</li>

1767

1768

1769

<a href="#method_detachAll">detachAll</a>

1770

1771

1772

</li>

1773

1774

1775

1776

1777

1778

</li>

1779

1780

1781

1782

1783

1784

</li>

1785

1786

1787

1788

1789

1790

</li>

1791

1792

1793

<a href="#method_getAttrs">getAttrs</a>

1794

1795

1796

</li>

1797

1798

1799

<a href="#method_getEvent">getEvent</a>

1800

1801

1802

</li>

1803

1804

1805

<a href="#method_getRegion">getRegion</a>

1806

1807

1808

</li>

1809

1810

1811

<a href="#method_getTargets">getTargets</a>

1812

1813

1814

</li>

1815

1816

1817

1818

1819

1820

</li>

1821

1822

1823

<a href="#method_inRegion">inRegion</a>

1824

1825

1826

</li>

1827

1828

1829

<a href="#method_modifyAttr">modifyAttr</a>

1830

1831

1832

</li>

1833

1834

1835

1836

1837

1838

</li>

1839

1840

1841

1842

1843

1844

</li>

1845

1846

1847

<a href="#method_onceAfter">onceAfter</a>

1848

1849

1850

</li>

1851

1852

1853

<a href="#method_parseType">parseType</a>

1854

1855

1856

</li>

1857

1858

1859

<a href="#method_publish">publish</a>

1860

1861

1862

</li>

1863

1864

1865

<a href="#method_removeAttr">removeAttr</a>

1866

1867

1868

</li>

1869

1870

1871

<a href="#method_removeTarget">removeTarget</a>

1872

1873

1874

</li>

1875

1876

1877

<a href="#method_reset">reset</a>

1878

1879

1880

</li>

1881

1882

1883

<a href="#method_resetCache">resetCache</a>

1884

1885

1886

</li>

1887

1888

1889

1890

1891

1892

</li>

1893

1894

1895

<a href="#method_setAttrs">setAttrs</a>

1896

1897

1898

</li>

1899

1900

1901

<a href="#method_subscribe">subscribe</a>

1902

1903

1904

</li>

1905

1906

1907

<a href="#method_toString">toString</a>

1908

1909

1910

</li>

1911

1912

1913

<a href="#method_unsubscribe">unsubscribe</a>

1914

1915

1916

</li>

1917

1918

1919

<a href="#method_unsubscribeAll">unsubscribeAll</a>

1920

1921

1922

</li>

1923

1924

</ul>

1925

</div>

1926

1927

1928

1929

1930

<h3>Properties</h3>

1931

1932

1933

1934

1935

<a href="#property__allowAdHocAttrs">_allowAdHocAttrs</a>

1936

1937

1938

</li>

1939

1940

1941

<a href="#property__cacheHandle">_cacheHandle</a>

1942

1943

1944

</li>

1945

1946

1947

<a href="#property__regionCache">_regionCache</a>

1948

1949

1950

</li>

1951

1952

1953

1954

1955

1956

</li>

1957

1958

1959

1960

1961

1962

<span class="flag static">static</span>

1963

1964

</li>

1965

1966

</ul>

1967

</div>

1968

1969

1970

1971

1972

<h3>Attributes</h3>

1973

1974

1975

1976

1977

<a href="#attr_cacheRegion">cacheRegion</a>

1978

</li>

1979

1980

1981

<a href="#attr_constrain">constrain</a>

1982

</li>

1983

1984

1985

<a href="#attr_constrain2node">constrain2node</a>

1986

</li>

1987

1988

1989

<a href="#attr_constrain2region">constrain2region</a>

1990

</li>

1991

1992

1993

<a href="#attr_constrain2view">constrain2view</a>

1994

</li>

1995

1996

1997

<a href="#attr_destroyed">destroyed</a>

1998

</li>

1999

2000

2001

<a href="#attr_gutter">gutter</a>

2002

</li>

2003

2004

2005

<a href="#attr_initialized">initialized</a>

2006

</li>

2007

2008

2009

<a href="#attr_stickX">stickX</a>

2010

</li>

2011

2012

2013

<a href="#attr_stickY">stickY</a>

2014

</li>

2015

2016

2017

<a href="#attr_tickX">tickX</a>

2018

</li>

2019

2020

2021

<a href="#attr_tickXArray">tickXArray</a>

2022

</li>

2023

2024

2025

<a href="#attr_tickY">tickY</a>

2026

</li>

2027

2028

2029

<a href="#attr_tickYArray">tickYArray</a>

2030

</li>

2031

2032

</ul>

2033

</div>

2034

2035

2036

2037

2038

<h3>Events</h3>

2039

2040

2041

2042

2043

<a href="#event_destroy">destroy</a>

2044

2045

2046

</li>

2047

2048

2049

<a href="#event_drag:tickAlignX">drag:tickAlignX</a>

2050

2051

2052

</li>

2053

2054

2055

<a href="#event_drag:tickAlignY">drag:tickAlignY</a>

2056

2057

2058

</li>

2059

2060

2061

2062

2063

2064

</li>

2065

2066

</ul>

2067

</div>

2068

2069

</div>

2070

2071

2072

2073

<h2 class="off-left">Methods</h2>

2074

2075

2076

2077

<h3 class="name"><code>_addAttrs</code></h3>

2078

2079

2080

2081

2082

2083

2084

2085

2086

2087

</li>

2088

2089

2090

2091

<code>values</code>

2092

2093

</li>

2094

2095

2096

2097

2098

2099

</li>

2100

2101

</ul><span class="paren">)</span>

2102

</div>

2103

2104

2105

2106

2107

2108

2109

2110

<span class="flag private">private</span>

2111

2112

2113

2114

2115

2116

2117

2118

2119

2120

2121

2122

<p>Inherited from

2123

<a href="../classes/AttributeCore.html#method__addAttrs">AttributeCore</a>:

2124

2125

2126

2127

<a href="../files/attribute_js_AttributeCore.js.html#l740"><code>attribute/js/AttributeCore.js:740</code></a>

2128

2129

</p>

2130

2131

2132

2133

2134

2135

</div>

2136

2137

2138

<p>Implementation behind the public addAttrs method. </p>

2139

2140

<p>This method is invoked directly by get if it encounters a scenario

2141

in which an attribute's valueFn attempts to obtain the

2142

value an attribute in the same group of attributes, which has not yet

2143

been added (on demand initialization).</p>

2144

</div>

2145

2146

2147

2148

<h4>Parameters:</h4>

2149

2150

2151

2152

2153

2154

2155

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

2156

2157

2158

2159

2160

2161

<p>An object with attribute name/configuration pairs.</p>

2162

</div>

2163

2164

2165

</li>

2166

2167

2168

2169

<code class="param-name">values</code>

2170

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

2171

2172

2173

2174

2175

2176

<p>An object with attribute name/value pairs, defining the initial values to apply.

2177

Values defined in the cfgs argument will be over-written by values in this argument unless defined as read only.</p>

2178

</div>

2179

2180

2181

</li>

2182

2183

2184

2185

2186

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

2187

2188

2189

2190

2191

2192

<p>Whether or not to delay the intialization of these attributes until the first call to get/set.

2193

Individual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration.

2194

See <a href="#method_addAttr">addAttr</a>.</p>

2195

</div>

2196

2197

2198

</li>

2199

2200

</ul>

2201

</div>

2202

2203

2204

2205

2206

2207

</div>

2208

2209

2210

2211

<h3 class="name"><code>_addLazyAttr</code></h3>

2212

2213

2214

2215

2216

2217

2218

2219

2220

2221

</li>

2222

2223

</ul><span class="paren">)</span>

2224

</div>

2225

2226

2227

2228

2229

2230

2231

2232

<span class="flag private">private</span>

2233

2234

2235

2236

2237

2238

2239

2240

2241

2242

2243

2244

<p>Inherited from

2245

<a href="../classes/AttributeCore.html#method__addLazyAttr">AttributeCore</a>:

2246

2247

2248

2249

<a href="../files/attribute_js_AttributeCore.js.html#l312"><code>attribute/js/AttributeCore.js:312</code></a>

2250

2251

</p>

2252

2253

2254

2255

2256

2257

</div>

2258

2259

2260

<p>Finishes initializing an attribute which has been lazily added.</p>

2261

</div>

2262

2263

2264

2265

<h4>Parameters:</h4>

2266

2267

2268

2269

2270

2271

2272

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

2273

2274

2275

2276

2277

2278

<p>The name of the attribute</p>

2279

</div>

2280

2281

2282

</li>

2283

2284

</ul>

2285

</div>

2286

2287

2288

2289

2290

2291

</div>

2292

2293

2294

2295

<h3 class="name"><code>_aggregateAttrs</code></h3>

2296

2297

2298

2299

2300

2301

2302

2303

<code>allAttrs</code>

2304

2305

</li>

2306

2307

</ul><span class="paren">)</span>

2308

</div>

2309

2310

2311

2312

2313

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

2314

</span>

2315

2316

2317

2318

2319

2320

<span class="flag private">private</span>

2321

2322

2323

2324

2325

2326

2327

2328

2329

2330

2331

2332

<p>Inherited from

2333

<a href="../classes/BaseCore.html#method__aggregateAttrs">BaseCore</a>:

2334

2335

2336

2337

<a href="../files/base_js_BaseCore.js.html#l426"><code>base/js/BaseCore.js:426</code></a>

2338

2339

</p>

2340

2341

2342

2343

2344

2345

</div>

2346

2347

2348

<p>A helper method, used by _initHierarchyData to aggregate

2349

attribute configuration across the instances class hierarchy.</p>

2350

2351

<p>The method will protect the attribute configuration value to protect the statically defined

2352

default value in ATTRS if required (if the value is an object literal, array or the

2353

attribute configuration has cloneDefaultValue set to shallow or deep).</p>

2354

</div>

2355

2356

2357

2358

<h4>Parameters:</h4>

2359

2360

2361

2362

2363

2364

<code class="param-name">allAttrs</code>

2365

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>

2366

2367

2368

2369

2370

2371

<p>An array of ATTRS definitions across classes in the hierarchy

2372

(subclass first, Base last)</p>

2373

</div>

2374

2375

2376

</li>

2377

2378

</ul>

2379

</div>

2380

2381

2382

2383

2384

<h4>Returns:</h4>

2385

2386

2387

2388

2389

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:

2390

2391

The aggregate set of ATTRS definitions for the instance

2392

2393

</div>

2394

</div>

2395

2396

2397

2398

</div>

2399

2400

2401

2402

<h3 class="name"><code>_attrCfgHash</code></h3>

2403

2404

2405

2406

2407

2408

2409

2410

2411

2412

2413

<span class="flag private">private</span>

2414

2415

2416

2417

2418

2419

2420

2421

2422

2423

2424

<p>Inherited from

2425

2426

BaseCore

2427

</a>

2428

2429

but overwritten in

2430

2431

2432

2433

2434

2435

</p>

2436

2437

2438

2439

2440

2441

</div>

2442

2443

2444

<p>Utility method to define the attribute hash used to filter/whitelist property mixes for

2445

this class.</p>

2446

</div>

2447

2448

2449

2450

2451

2452

2453

</div>

2454

2455

2456

2457

<h3 class="name"><code>_baseDestroy</code></h3>

2458

2459

2460

2461

2462

2463

2464

2465

2466

2467

2468

<span class="flag private">private</span>

2469

2470

2471

2472

2473

2474

2475

2476

2477

2478

2479

2480

<p>Inherited from

2481

<a href="../classes/BaseCore.html#method__baseDestroy">BaseCore</a>:

2482

2483

2484

2485

<a href="../files/base_js_BaseCore.js.html#l263"><code>base/js/BaseCore.js:263</code></a>

2486

2487

</p>

2488

2489

2490

2491

2492

2493

</div>

2494

2495

2496

<p>Internal destroy implementation for BaseCore</p>

2497

</div>

2498

2499

2500

2501

2502

2503

2504

</div>

2505

2506

2507

2508

<h3 class="name"><code>_baseInit</code></h3>

2509

2510

2511

2512

2513

2514

2515

2516

2517

2518

2519

<span class="flag private">private</span>

2520

2521

2522

2523

2524

2525

2526

2527

2528

2529

2530

2531

<p>Inherited from

2532

<a href="../classes/BaseCore.html#method__baseInit">BaseCore</a>:

2533

2534

2535

2536

<a href="../files/base_js_BaseCore.js.html#l235"><code>base/js/BaseCore.js:235</code></a>

2537

2538

</p>

2539

2540

2541

2542

2543

2544

</div>

2545

2546

2547

<p>Internal initialization implementation for BaseCore</p>

2548

</div>

2549

2550

2551

2552

2553

2554

2555

</div>

2556

2557

2558

2559

<h3 class="name"><code>_cacheRegion</code></h3>

2560

2561

2562

2563

2564

2565

2566

2567

2568

2569

2570

<span class="flag private">private</span>

2571

2572

2573

2574

2575

2576

2577

2578

2579

2580

2581

2582

2583

<p>

2584

2585

Defined in

2586

2587

2588

2589

2590

<a href="../files/dd_js_constrain.js.html#l258"><code>dd/js/constrain.js:258</code></a>

2591

2592

</p>

2593

2594

2595

2596

2597

2598

</div>

2599

2600

2601

<p>Get's the region and caches it, called from window.resize and when the cache is null</p>

2602

</div>

2603

2604

2605

2606

2607

2608

2609

</div>

2610

2611

2612

2613

<h3 class="name"><code>_checkRegion</code></h3>

2614

2615

2616

2617

2618

2619

2620

2621

2622

2623

</li>

2624

2625

</ul><span class="paren">)</span>

2626

</div>

2627

2628

2629

2630

2631

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>

2632

</span>

2633

2634

2635

2636

2637

2638

<span class="flag private">private</span>

2639

2640

2641

2642

2643

2644

2645

2646

2647

2648

2649

2650

2651

<p>

2652

2653

Defined in

2654

2655

2656

2657

2658

<a href="../files/dd_js_constrain.js.html#l334"><code>dd/js/constrain.js:334</code></a>

2659

2660

</p>

2661

2662

2663

2664

2665

2666

</div>

2667

2668

2669

<p>Check if xy is inside a given region, if not change to it be inside.</p>

2670

</div>

2671

2672

2673

2674

<h4>Parameters:</h4>

2675

2676

2677

2678

2679

2680

2681

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>

2682

2683

2684

2685

2686

2687

<p>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.</p>

2688

</div>

2689

2690

2691

</li>

2692

2693

</ul>

2694

</div>

2695

2696

2697

2698

2699

<h4>Returns:</h4>

2700

2701

2702

2703

2704

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>:

2705

2706

The new XY that is inside the region

2707

2708

</div>

2709

</div>

2710

2711

2712

2713

</div>

2714

2715

2716

2717

<h3 class="name"><code>_checkTicks</code></h3>

2718

2719

2720

2721

2722

2723

2724

2725

2726

2727

</li>

2728

2729

2730

2731

2732

2733

</li>

2734

2735

</ul><span class="paren">)</span>

2736

</div>

2737

2738

2739

2740

2741

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>

2742

</span>

2743

2744

2745

2746

2747

2748

<span class="flag private">private</span>

2749

2750

2751

2752

2753

2754

2755

2756

2757

2758

2759

2760

2761

<p>

2762

2763

Defined in

2764

2765

2766

2767

2768

<a href="../files/dd_js_constrain.js.html#l424"><code>dd/js/constrain.js:424</code></a>

2769

2770

</p>

2771

2772

2773

2774

2775

2776

</div>

2777

2778

2779

<p>This method delegates the proper helper method for tick calculations</p>

2780

</div>

2781

2782

2783

2784

<h4>Parameters:</h4>

2785

2786

2787

2788

2789

2790

2791

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>

2792

2793

2794

2795

2796

2797

<p>The XY coords for the Drag</p>

2798

</div>

2799

2800

2801

</li>

2802

2803

2804

2805

2806

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

2807

2808

2809

2810

2811

2812

<p>The optional region that we are bound to.</p>

2813

</div>

2814

2815

2816

</li>

2817

2818

</ul>

2819

</div>

2820

2821

2822

2823

2824

<h4>Returns:</h4>

2825

2826

2827

2828

2829

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>:

2830

2831

The calced XY coords

2832

2833

</div>

2834

</div>

2835

2836

2837

2838

</div>

2839

2840

2841

2842

<h3 class="name"><code>_createEvents</code></h3>

2843

2844

2845

2846

2847

2848

2849

2850

2851

2852

2853

<span class="flag private">private</span>

2854

2855

2856

2857

2858

2859

2860

2861

2862

2863

2864

2865

2866

<p>

2867

2868

Defined in

2869

2870

2871

2872

2873

<a href="../files/dd_js_constrain.js.html#l204"><code>dd/js/constrain.js:204</code></a>

2874

2875

</p>

2876

2877

2878

2879

2880

2881

</div>

2882

2883

2884

<p>This method creates all the events for this Event Target and publishes them so we get Event Bubbling.</p>

2885

</div>

2886

2887

2888

2889

2890

2891

2892

</div>

2893

2894

2895

2896

<h3 class="name"><code>_defAttrChangeFn</code></h3>

2897

2898

2899

2900

2901

2902

2903

2904

2905

2906

</li>

2907

2908

</ul><span class="paren">)</span>

2909

</div>

2910

2911

2912

2913

2914

2915

2916

2917

<span class="flag private">private</span>

2918

2919

2920

2921

2922

2923

2924

2925

2926

2927

2928

2929

<p>Inherited from

2930

<a href="../classes/AttributeEvents.html#method__defAttrChangeFn">AttributeEvents</a>:

2931

2932

2933

2934

<a href="../files/attribute_js_AttributeEvents.js.html#l148"><code>attribute/js/AttributeEvents.js:148</code></a>

2935

2936

</p>

2937

2938

2939

2940

2941

2942

</div>

2943

2944

2945

<p>Default function for attribute change events.</p>

2946

</div>

2947

2948

2949

2950

<h4>Parameters:</h4>

2951

2952

2953

2954

2955

2956

2957

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

2958

2959

2960

2961

2962

2963

<p>The event object for attribute change events.</p>

2964

</div>

2965

2966

2967

</li>

2968

2969

</ul>

2970

</div>

2971

2972

2973

2974

2975

2976

</div>

2977

2978

2979

2980

<h3 class="name"><code>_defDestroyFn</code></h3>

2981

2982

2983

2984

2985

2986

2987

2988

2989

2990

</li>

2991

2992

</ul><span class="paren">)</span>

2993

</div>

2994

2995

2996

2997

2998

2999

3000

3001

<span class="flag protected">protected</span>

3002

3003

3004

3005

3006

3007

3008

3009

3010

3011

3012

3013

<p>Inherited from

3014

<a href="../classes/Base.html#method__defDestroyFn">Base</a>:

3015

3016

3017

3018

3019

3020

</p>

3021

3022

3023

3024

3025

3026

</div>

3027

3028

3029

<p>Default destroy event handler</p>

3030

</div>

3031

3032

3033

3034

<h4>Parameters:</h4>

3035

3036

3037

3038

3039

3040

3041

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

3042

3043

3044

3045

3046

3047

<p>Event object</p>

3048

</div>

3049

3050

3051

</li>

3052

3053

</ul>

3054

</div>

3055

3056

3057

3058

3059

3060

</div>

3061

3062

3063

3064

<h3 class="name"><code>_defInitFn</code></h3>

3065

3066

3067

3068

3069

3070

3071

3072

3073

3074

</li>

3075

3076

</ul><span class="paren">)</span>

3077

</div>

3078

3079

3080

3081

3082

3083

3084

3085

<span class="flag protected">protected</span>

3086

3087

3088

3089

3090

3091

3092

3093

3094

3095

3096

3097

<p>Inherited from

3098

<a href="../classes/Base.html#method__defInitFn">Base</a>:

3099

3100

3101

3102

3103

3104

</p>

3105

3106

3107

3108

3109

3110

</div>

3111

3112

3113

<p>Default init event handler</p>

3114

</div>

3115

3116

3117

3118

<h4>Parameters:</h4>

3119

3120

3121

3122

3123

3124

3125

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

3126

3127

3128

3129

3130

3131

<p>Event object, with a cfg property which

3132

refers to the configuration object passed to the constructor.</p>

3133

</div>

3134

3135

3136

</li>

3137

3138

</ul>

3139

</div>

3140

3141

3142

3143

3144

3145

</div>

3146

3147

3148

3149

<h3 class="name"><code>_destroyHierarchy</code></h3>

3150

3151

3152

3153

3154

3155

3156

3157

3158

3159

3160

<span class="flag private">private</span>

3161

3162

3163

3164

3165

3166

3167

3168

3169

3170

3171

3172

<p>Inherited from

3173

<a href="../classes/BaseCore.html#method__destroyHierarchy">BaseCore</a>:

3174

3175

3176

3177

<a href="../files/base_js_BaseCore.js.html#l559"><code>base/js/BaseCore.js:559</code></a>

3178

3179

</p>

3180

3181

3182

3183

3184

3185

</div>

3186

3187

3188

<p>Destroys the class hierarchy for this instance by invoking

3189

the destructor method on the prototype of each class in the hierarchy.</p>

3190

</div>

3191

3192

3193

3194

3195

3196

3197

</div>

3198

3199

3200

3201

<h3 class="name"><code>_filterAdHocAttrs</code></h3>

3202

3203

3204

3205

3206

3207

3208

3209

<code>allAttrs</code>

3210

3211

</li>

3212

3213

3214

3215

<code>userVals</code>

3216

3217

</li>

3218

3219

</ul><span class="paren">)</span>

3220

</div>

3221

3222

3223

3224

3225

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

3226

</span>

3227

3228

3229

3230

3231

3232

<span class="flag private">private</span>

3233

3234

3235

3236

3237

3238

3239

3240

3241

3242

3243

3244

<p>Inherited from

3245

<a href="../classes/BaseCore.html#method__filterAdHocAttrs">BaseCore</a>:

3246

3247

3248

3249

<a href="../files/base_js_BaseCore.js.html#l342"><code>base/js/BaseCore.js:342</code></a>

3250

3251

</p>

3252

3253

3254

3255

3256

3257

</div>

3258

3259

3260

3261

</div>

3262

3263

3264

3265

<h4>Parameters:</h4>

3266

3267

3268

3269

3270

3271

<code class="param-name">allAttrs</code>

3272

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

3273

3274

3275

3276

3277

3278

<p>The set of all attribute configurations for this instance.

3279

Attributes will be removed from this set, if they belong to the filtered class, so

3280

that by the time all classes are processed, allCfgs will be empty.</p>

3281

</div>

3282

3283

3284

</li>

3285

3286

3287

3288

<code class="param-name">userVals</code>

3289

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

3290

3291

3292

3293

3294

3295

<p>The config object passed in by the user, from which adhoc attrs are to be filtered.</p>

3296

</div>

3297

3298

3299

</li>

3300

3301

</ul>

3302

</div>

3303

3304

3305

3306

3307

<h4>Returns:</h4>

3308

3309

3310

3311

3312

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:

3313

3314

The set of adhoc attributes passed in, in the form

3315

of an object with attribute name/configuration pairs.

3316

3317

</div>

3318

</div>

3319

3320

3321

3322

</div>

3323

3324

3325

3326

<h3 class="name"><code>_filterAttrCfs</code></h3>

3327

3328

3329

3330

3331

3332

3333

3334

<code>clazz</code>

3335

3336

</li>

3337

3338

3339

3340

<code>allCfgs</code>

3341

3342

</li>

3343

3344

</ul><span class="paren">)</span>

3345

</div>

3346

3347

3348

3349

3350

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

3351

</span>

3352

3353

3354

3355

3356

3357

<span class="flag private">private</span>

3358

3359

3360

3361

3362

3363

3364

3365

3366

3367

3368

3369

<p>Inherited from

3370

<a href="../classes/BaseCore.html#method__filterAttrCfs">BaseCore</a>:

3371

3372

3373

3374

<a href="../files/base_js_BaseCore.js.html#l310"><code>base/js/BaseCore.js:310</code></a>

3375

3376

</p>

3377

3378

3379

3380

3381

3382

</div>

3383

3384

3385

<p>A helper method used when processing ATTRS across the class hierarchy during

3386

initialization. Returns a disposable object with the attributes defined for

3387

the provided class, extracted from the set of all attributes passed in.</p>

3388

</div>

3389

3390

3391

3392

<h4>Parameters:</h4>

3393

3394

3395

3396

3397

3398

<code class="param-name">clazz</code>

3399

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>

3400

3401

3402

3403

3404

3405

<p>The class for which the desired attributes are required.</p>

3406

</div>

3407

3408

3409

</li>

3410

3411

3412

3413

<code class="param-name">allCfgs</code>

3414

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

3415

3416

3417

3418

3419

3420

<p>The set of all attribute configurations for this instance.

3421

Attributes will be removed from this set, if they belong to the filtered class, so

3422

that by the time all classes are processed, allCfgs will be empty.</p>

3423

</div>

3424

3425

3426

</li>

3427

3428

</ul>

3429

</div>

3430

3431

3432

3433

3434

<h4>Returns:</h4>

3435

3436

3437

3438

3439

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:

3440

3441

The set of attributes belonging to the class passed in, in the form

3442

of an object with attribute name/configuration pairs.

3443

3444

</div>

3445

</div>

3446

3447

3448

3449

</div>

3450

3451

3452

3453

<h3 class="name"><code>_fireAttrChange</code></h3>

3454

3455

3456

3457

3458

3459

3460

3461

<code>attrName</code>

3462

3463

</li>

3464

3465

3466

3467

<code>subAttrName</code>

3468

3469

</li>

3470

3471

3472

3473

<code>currVal</code>

3474

3475

</li>

3476

3477

3478

3479

<code>newVal</code>

3480

3481

</li>

3482

3483

3484

3485

3486

3487

</li>

3488

3489

</ul><span class="paren">)</span>

3490

</div>

3491

3492

3493

3494

3495

3496

3497

3498

<span class="flag private">private</span>

3499

3500

3501

3502

3503

3504

3505

3506

3507

3508

3509

3510

<p>Inherited from

3511

<a href="../classes/AttributeEvents.html#method__fireAttrChange">AttributeEvents</a>:

3512

3513

3514

3515

<a href="../files/attribute_js_AttributeEvents.js.html#l94"><code>attribute/js/AttributeEvents.js:94</code></a>

3516

3517

</p>

3518

3519

3520

3521

3522

3523

</div>

3524

3525

3526

<p>Utility method to help setup the event payload and fire the attribute change event.</p>

3527

</div>

3528

3529

3530

3531

<h4>Parameters:</h4>

3532

3533

3534

3535

3536

3537

<code class="param-name">attrName</code>

3538

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

3539

3540

3541

3542

3543

3544

<p>The name of the attribute</p>

3545

</div>

3546

3547

3548

</li>

3549

3550

3551

3552

<code class="param-name">subAttrName</code>

3553

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

3554

3555

3556

3557

3558

3559

<p>The full path of the property being changed,

3560

if this is a sub-attribute value being change. Otherwise null.</p>

3561

</div>

3562

3563

3564

</li>

3565

3566

3567

3568

<code class="param-name">currVal</code>

3569

3570

3571

3572

3573

3574

3575

<p>The current value of the attribute</p>

3576

</div>

3577

3578

3579

</li>

3580

3581

3582

3583

<code class="param-name">newVal</code>

3584

3585

3586

3587

3588

3589

3590

<p>The new value of the attribute</p>

3591

</div>

3592

3593

3594

</li>

3595

3596

3597

3598

3599

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

3600

3601

3602

3603

3604

3605

<p>Any additional event data to mix into the attribute change event's event facade.</p>

3606

</div>

3607

3608

3609

</li>

3610

3611

</ul>

3612

</div>

3613

3614

3615

3616

3617

3618

</div>

3619

3620

3621

3622

<h3 class="name"><code>_getAttr</code></h3>

3623

3624

3625

3626

3627

3628

3629

3630

3631

3632

</li>

3633

3634

</ul><span class="paren">)</span>

3635

</div>

3636

3637

3638

3639

3640

3641

</span>

3642

3643

3644

3645

3646

3647

<span class="flag protected">protected</span>

3648

3649

3650

3651

3652

3653

3654

3655

<span class="flag chainable">chainable</span>

3656

3657

3658

3659

3660

3661

<p>Inherited from

3662

<a href="../classes/AttributeCore.html#method__getAttr">AttributeCore</a>:

3663

3664

3665

3666

<a href="../files/attribute_js_AttributeCore.js.html#l468"><code>attribute/js/AttributeCore.js:468</code></a>

3667

3668

</p>

3669

3670

3671

3672

3673

3674

</div>

3675

3676

3677

<p>Provides the common implementation for the public get method,

3678

allowing Attribute hosts to over-ride either method.</p>

3679

3680

<p>See <a href="#method_get">get</a> for argument details.</p>

3681

</div>

3682

3683

3684

3685

<h4>Parameters:</h4>

3686

3687

3688

3689

3690

3691

3692

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

3693

3694

3695

3696

3697

3698

<p>The name of the attribute.</p>

3699

</div>

3700

3701

3702

</li>

3703

3704

</ul>

3705

</div>

3706

3707

3708

3709

3710

<h4>Returns:</h4>

3711

3712

3713

3714

3715

<span class="type">Any</span>:

3716

3717

The value of the attribute.

3718

3719

</div>

3720

</div>

3721

3722

3723

3724

</div>

3725

3726

3727

3728

<h3 class="name"><code>_getAttrCfg</code></h3>

3729

3730

3731

3732

3733

3734

3735

3736

3737

3738

</li>

3739

3740

</ul><span class="paren">)</span>

3741

</div>

3742

3743

3744

3745

3746

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

3747

</span>

3748

3749

3750

3751

3752

3753

<span class="flag protected">protected</span>

3754

3755

3756

3757

3758

3759

3760

3761

3762

3763

3764

3765

<p>Inherited from

3766

<a href="../classes/AttributeExtras.html#method__getAttrCfg">AttributeExtras</a>:

3767

3768

3769

3770

<a href="../files/attribute_js_AttributeExtras.js.html#l112"><code>attribute/js/AttributeExtras.js:112</code></a>

3771

3772

</p>

3773

3774

3775

3776

3777

3778

</div>

3779

3780

3781

<p>Returns an object with the configuration properties (and value)

3782

for the given attribute. If attrName is not provided, returns the

3783

configuration properties for all attributes.</p>

3784

</div>

3785

3786

3787

3788

<h4>Parameters:</h4>

3789

3790

3791

3792

3793

3794

3795

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

3796

3797

3798

3799

3800

3801

<p>Optional. The attribute name. If not provided, the method will return the configuration for all attributes.</p>

3802

</div>

3803

3804

3805

</li>

3806

3807

</ul>

3808

</div>

3809

3810

3811

3812

3813

<h4>Returns:</h4>

3814

3815

3816

3817

3818

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:

3819

3820

The configuration properties for the given attribute, or all attributes.

3821

3822

</div>

3823

</div>

3824

3825

3826

3827

</div>

3828

3829

3830

3831

<h3 class="name"><code>_getAttrCfgs</code></h3>

3832

3833

3834

3835

3836

3837

3838

3839

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

3840

</span>

3841

3842

3843

3844

3845

3846

<span class="flag protected">protected</span>

3847

3848

3849

3850

3851

3852

3853

3854

3855

3856

3857

3858

<p>Inherited from

3859

<a href="../classes/BaseCore.html#method__getAttrCfgs">BaseCore</a>:

3860

3861

3862

3863

<a href="../files/base_js_BaseCore.js.html#l293"><code>base/js/BaseCore.js:293</code></a>

3864

3865

</p>

3866

3867

3868

3869

3870

3871

</div>

3872

3873

3874

<p>Returns an aggregated set of attribute configurations, by traversing

3875

the class hierarchy.</p>

3876

</div>

3877

3878

3879

3880

3881

3882

<h4>Returns:</h4>

3883

3884

3885

3886

3887

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:

3888

3889

The hash of attribute configurations, aggregated across classes in the hierarchy

3890

This value is cached the first time the method, or _getClasses, is invoked. Subsequent invocations return

3891

the cached value.

3892

3893

</div>

3894

</div>

3895

3896

3897

3898

</div>

3899

3900

3901

3902

<h3 class="name"><code>_getAttrInitVal</code></h3>

3903

3904

3905

3906

3907

3908

3909

3910

3911

3912

</li>

3913

3914

3915

3916

3917

3918

</li>

3919

3920

3921

3922

<code>initValues</code>

3923

3924

</li>

3925

3926

</ul><span class="paren">)</span>

3927

</div>

3928

3929

3930

3931

3932

3933

</span>

3934

3935

3936

3937

3938

3939

<span class="flag private">private</span>

3940

3941

3942

3943

3944

3945

3946

3947

3948

3949

3950

<p>Inherited from

3951

3952

Attribute

3953

</a>

3954

3955

but overwritten in

3956

3957

3958

3959

<a href="../files/attribute_js_AttributeCore.js.html#l823"><code>attribute/js/AttributeCore.js:823</code></a>

3960

3961

</p>

3962

3963

3964

3965

3966

3967

</div>

3968

3969

3970

<p>Returns the initial value of the given attribute from

3971

either the default configuration provided, or the

3972

over-ridden value if it exists in the set of initValues

3973

provided and the attribute is not read-only.</p>

3974

</div>

3975

3976

3977

3978

<h4>Parameters:</h4>

3979

3980

3981

3982

3983

3984

3985

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

3986

3987

3988

3989

3990

3991

<p>The name of the attribute</p>

3992

</div>

3993

3994

3995

</li>

3996

3997

3998

3999

4000

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

4001

4002

4003

4004

4005

4006

<p>The attribute configuration object</p>

4007

</div>

4008

4009

4010

</li>

4011

4012

4013

4014

<code class="param-name">initValues</code>

4015

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

4016

4017

4018

4019

4020

4021

<p>The object with simple and complex attribute name/value pairs returned from _normAttrVals</p>

4022

</div>

4023

4024

4025

</li>

4026

4027

</ul>

4028

</div>

4029

4030

4031

4032

4033

<h4>Returns:</h4>

4034

4035

4036

4037

4038

<span class="type">Any</span>:

4039

4040

The initial value of the attribute.

4041

4042

</div>

4043

</div>

4044

4045

4046

4047

</div>

4048

4049

4050

4051

<h3 class="name"><code>_getAttrs</code></h3>

4052

4053

4054

4055

4056

4057

4058

4059

<code>attrs</code>

4060

4061

</li>

4062

4063

</ul><span class="paren">)</span>

4064

</div>

4065

4066

4067

4068

4069

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

4070

</span>

4071

4072

4073

4074

4075

4076

<span class="flag protected">protected</span>

4077

4078

4079

4080

4081

4082

4083

4084

4085

4086

4087

4088

<p>Inherited from

4089

<a href="../classes/AttributeCore.html#method__getAttrs">AttributeCore</a>:

4090

4091

4092

4093

<a href="../files/attribute_js_AttributeCore.js.html#l677"><code>attribute/js/AttributeCore.js:677</code></a>

4094

4095

</p>

4096

4097

4098

4099

4100

4101

</div>

4102

4103

4104

<p>Implementation behind the public getAttrs method, to get multiple attribute values.</p>

4105

</div>

4106

4107

4108

4109

<h4>Parameters:</h4>

4110

4111

4112

4113

4114

4115

<code class="param-name">attrs</code>

4116

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a> | boolean</span>

4117

4118

4119

4120

4121

4122

<p>Optional. An array of attribute names. If omitted, all attribute values are

4123

returned. If set to true, all attributes modified from their initial values are returned.</p>

4124

</div>

4125

4126

4127

</li>

4128

4129

</ul>

4130

</div>

4131

4132

4133

4134

4135

<h4>Returns:</h4>

4136

4137

4138

4139

4140

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:

4141

4142

An object with attribute name/value pairs.

4143

4144

</div>

4145

</div>

4146

4147

4148

4149

</div>

4150

4151

4152

4153

<h3 class="name"><code>_getClasses</code></h3>

4154

4155

4156

4157

4158

4159

4160

4161

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function[]</a></span>

4162

</span>

4163

4164

4165

4166

4167

4168

<span class="flag protected">protected</span>

4169

4170

4171

4172

4173

4174

4175

4176

4177

4178

4179

4180

<p>Inherited from

4181

<a href="../classes/BaseCore.html#method__getClasses">BaseCore</a>:

4182

4183

4184

4185

<a href="../files/base_js_BaseCore.js.html#l277"><code>base/js/BaseCore.js:277</code></a>

4186

4187

</p>

4188

4189

4190

4191

4192

4193

</div>

4194

4195

4196

<p>Returns the class hierarchy for this object, with BaseCore being the last class in the array.</p>

4197

</div>

4198

4199

4200

4201

4202

4203

<h4>Returns:</h4>

4204

4205

4206

4207

4208

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function[]</a></span>:

4209

4210

An array of classes (constructor functions), making up the class hierarchy for this object.

4211

This value is cached the first time the method, or _getAttrCfgs, is invoked. Subsequent invocations return the

4212

cached value.

4213

4214

</div>

4215

</div>

4216

4217

4218

4219

</div>

4220

4221

4222

4223

<h3 class="name"><code>_getConstraint</code></h3>

4224

4225

4226

4227

4228

4229

4230

4231

4232

4233

4234

<span class="flag private">private</span>

4235

4236

4237

4238

4239

4240

4241

4242

4243

4244

4245

4246

4247

<p>

4248

4249

Defined in

4250

4251

4252

4253

4254

<a href="../files/dd_js_constrain.js.html#l273"><code>dd/js/constrain.js:273</code></a>

4255

4256

</p>

4257

4258

4259

4260

4261

4262

</div>

4263

4264

4265

<p>Standardizes the 'constraint' attribute</p>

4266

</div>

4267

4268

4269

4270

4271

4272

4273

</div>

4274

4275

4276

4277

<h3 class="name"><code>_getStateVal</code></h3>

4278

4279

4280

4281

4282

4283

4284

4285

4286

4287

</li>

4288

4289

</ul><span class="paren">)</span>

4290

</div>

4291

4292

4293

4294

4295

4296

</span>

4297

4298

4299

4300

4301

4302

<span class="flag private">private</span>

4303

4304

4305

4306

4307

4308

4309

4310

4311

4312

4313

4314

<p>Inherited from

4315

<a href="../classes/AttributeCore.html#method__getStateVal">AttributeCore</a>:

4316

4317

4318

4319

<a href="../files/attribute_js_AttributeCore.js.html#l522"><code>attribute/js/AttributeCore.js:522</code></a>

4320

4321

</p>

4322

4323

4324

4325

4326

4327

</div>

4328

4329

4330

<p>Gets the stored value for the attribute, from either the

4331

internal state object, or the state proxy if it exits</p>

4332

</div>

4333

4334

4335

4336

<h4>Parameters:</h4>

4337

4338

4339

4340

4341

4342

4343

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

4344

4345

4346

4347

4348

4349

<p>The name of the attribute</p>

4350

</div>

4351

4352

4353

</li>

4354

4355

</ul>

4356

</div>

4357

4358

4359

4360

4361

<h4>Returns:</h4>

4362

4363

4364

4365

4366

<span class="type">Any</span>:

4367

4368

The stored value of the attribute

4369

4370

</div>

4371

</div>

4372

4373

4374

4375

</div>

4376

4377

4378

4379

<h3 class="name"><code>_getType</code></h3>

4380

4381

4382

4383

4384

4385

4386

4387

4388

4389

4390

<span class="flag private">private</span>

4391

4392

4393

4394

4395

4396

4397

4398

4399

4400

4401

4402

<p>Inherited from

4403

<a href="../classes/EventTarget.html#method__getType">EventTarget</a>:

4404

4405

4406

4407

<a href="../files/event-custom_js_event-target.js.html#l36"><code>event-custom/js/event-target.js:36</code></a>

4408

4409

</p>

4410

4411

4412

4413

4414

4415

</div>

4416

4417

4418

<p>If the instance has a prefix attribute and the

4419

event type is not prefixed, the instance prefix is

4420

applied to the supplied type.</p>

4421

</div>

4422

4423

4424

4425

4426

4427

4428

</div>

4429

4430

4431

4432

<h3 class="name"><code>_handleEnd</code></h3>

4433

4434

4435

4436

4437

4438

4439

4440

4441

4442

4443

<span class="flag private">private</span>

4444

4445

4446

4447

4448

4449

4450

4451

4452

4453

4454

4455

4456

<p>

4457

4458

Defined in

4459

4460

4461

4462

4463

<a href="../files/dd_js_constrain.js.html#l227"><code>dd/js/constrain.js:227</code></a>

4464

4465

</p>

4466

4467

4468

4469

4470

4471

</div>

4472

4473

4474

<p>Fires on drag:end</p>

4475

</div>

4476

4477

4478

4479

4480

4481

4482

</div>

4483

4484

4485

4486

<h3 class="name"><code>_handleStart</code></h3>

4487

4488

4489

4490

4491

4492

4493

4494

4495

4496

4497

<span class="flag private">private</span>

4498

4499

4500

4501

4502

4503

4504

4505

4506

4507

4508

4509

4510

<p>

4511

4512

Defined in

4513

4514

4515

4516

4517

<a href="../files/dd_js_constrain.js.html#l236"><code>dd/js/constrain.js:236</code></a>

4518

4519

</p>

4520

4521

4522

4523

4524

4525

</div>

4526

4527

4528

<p>Fires on drag:start and clears the _regionCache</p>

4529

</div>

4530

4531

4532

4533

4534

4535

4536

</div>

4537

4538

4539

4540

<h3 class="name"><code>_initAttrHost</code></h3>

4541

4542

4543

4544

4545

4546

4547

4548

<code>attrs</code>

4549

4550

</li>

4551

4552

4553

4554

<code>values</code>

4555

4556

</li>

4557

4558

4559

4560

4561

4562

</li>

4563

4564

</ul><span class="paren">)</span>

4565

</div>

4566

4567

4568

4569

4570

4571

4572

4573

<span class="flag private">private</span>

4574

4575

4576

4577

4578

4579

4580

4581

4582

4583

4584

4585

<p>Inherited from

4586

<a href="../classes/AttributeCore.html#method__initAttrHost">AttributeCore</a>:

4587

4588

4589

4590

<a href="../files/attribute_js_AttributeCore.js.html#l109"><code>attribute/js/AttributeCore.js:109</code></a>

4591

4592

</p>

4593

4594

4595

4596

4597

4598

</div>

4599

4600

4601

<p>Constructor logic for attributes. Initializes the host state, and sets up the inital attributes passed to the

4602

constructor.</p>

4603

</div>

4604

4605

4606

4607

<h4>Parameters:</h4>

4608

4609

4610

4611

4612

4613

<code class="param-name">attrs</code>

4614

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

4615

4616

4617

4618

4619

4620

<p>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.</p>

4621

</div>

4622

4623

4624

</li>

4625

4626

4627

4628

<code class="param-name">values</code>

4629

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

4630

4631

4632

4633

4634

4635

<p>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.</p>

4636

</div>

4637

4638

4639

</li>

4640

4641

4642

4643

4644

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

4645

4646

4647

4648

4649

4650

<p>Whether or not to add attributes lazily (passed through to <a href="#method_addAttrs">addAttrs</a>).</p>

4651

</div>

4652

4653

4654

</li>

4655

4656

</ul>

4657

</div>

4658

4659

4660

4661

4662

4663

</div>

4664

4665

4666

4667

<h3 class="name"><code>_initAttribute</code></h3>

4668

4669

4670

4671

4672

4673

4674

4675

4676

4677

4678

<span class="flag private">private</span>

4679

4680

4681

4682

4683

4684

4685

4686

4687

4688

4689

<p>Inherited from

4690

4691

BaseCore

4692

</a>

4693

4694

but overwritten in

4695

4696

4697

4698

4699

4700

</p>

4701

4702

4703

4704

4705

4706

</div>

4707

4708

4709

<p>Initializes Attribute</p>

4710

</div>

4711

4712

4713

4714

4715

4716

4717

</div>

4718

4719

4720

4721

<h3 class="name"><code>_initAttrs</code></h3>

4722

4723

4724

4725

4726

4727

4728

4729

<code>attrs</code>

4730

4731

</li>

4732

4733

4734

4735

<code>values</code>

4736

4737

</li>

4738

4739

4740

4741

4742

4743

</li>

4744

4745

</ul><span class="paren">)</span>

4746

</div>

4747

4748

4749

4750

4751

4752

4753

4754

<span class="flag protected">protected</span>

4755

4756

4757

4758

4759

4760

4761

4762

4763

4764

4765

4766

<p>Inherited from

4767

<a href="../classes/AttributeCore.html#method__initAttrs">AttributeCore</a>:

4768

4769

4770

4771

<a href="../files/attribute_js_AttributeCore.js.html#l862"><code>attribute/js/AttributeCore.js:862</code></a>

4772

4773

</p>

4774

4775

4776

4777

4778

4779

</div>

4780

4781

4782

<p>Utility method to set up initial attributes defined during construction, either through the constructor.ATTRS property, or explicitly passed in.</p>

4783

</div>

4784

4785

4786

4787

<h4>Parameters:</h4>

4788

4789

4790

4791

4792

4793

<code class="param-name">attrs</code>

4794

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

4795

4796

4797

4798

4799

4800

4801

</div>

4802

4803

4804

</li>

4805

4806

4807

4808

<code class="param-name">values</code>

4809

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

4810

4811

4812

4813

4814

4815

4816

</div>

4817

4818

4819

</li>

4820

4821

4822

4823

4824

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

4825

4826

4827

4828

4829

4830

<p>Whether or not to add attributes lazily (passed through to <a href="#method_addAttrs">addAttrs</a>).</p>

4831

</div>

4832

4833

4834

</li>

4835

4836

</ul>

4837

</div>

4838

4839

4840

4841

4842

4843

</div>

4844

4845

4846

4847

<h3 class="name"><code>_initBase</code></h3>

4848

4849

4850

4851

4852

4853

4854

4855

<code>config</code>

4856

4857

</li>

4858

4859

</ul><span class="paren">)</span>

4860

</div>

4861

4862

4863

4864

4865

4866

4867

4868

<span class="flag private">private</span>

4869

4870

4871

4872

4873

4874

4875

4876

4877

4878

4879

<p>Inherited from

4880

4881

BaseCore

4882

</a>

4883

4884

but overwritten in

4885

4886

4887

4888

4889

4890

</p>

4891

4892

4893

4894

4895

4896

</div>

4897

4898

4899

<p>Internal construction logic for Base.</p>

4900

</div>

4901

4902

4903

4904

<h4>Parameters:</h4>

4905

4906

4907

4908

4909

4910

<code class="param-name">config</code>

4911

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

4912

4913

4914

4915

4916

4917

<p>The constructor configuration object</p>

4918

</div>

4919

4920

4921

</li>

4922

4923

</ul>

4924

</div>

4925

4926

4927

4928

4929

4930

</div>

4931

4932

4933

4934

<h3 class="name"><code>_initHierarchy</code></h3>

4935

4936

4937

4938

4939

4940

4941

4942

<code>userVals</code>

4943

4944

</li>

4945

4946

</ul><span class="paren">)</span>

4947

</div>

4948

4949

4950

4951

4952

4953

4954

4955

<span class="flag private">private</span>

4956

4957

4958

4959

4960

4961

4962

4963

4964

4965

4966

4967

<p>Inherited from

4968

<a href="../classes/BaseCore.html#method__initHierarchy">BaseCore</a>:

4969

4970

4971

4972

<a href="../files/base_js_BaseCore.js.html#l501"><code>base/js/BaseCore.js:501</code></a>

4973

4974

</p>

4975

4976

4977

4978

4979

4980

</div>

4981

4982

4983

<p>Initializes the class hierarchy for the instance, which includes

4984

initializing attributes for each class defined in the class's

4985

static <a href="#property_BaseCore.ATTRS">ATTRS</a> property and

4986

invoking the initializer method on the prototype of each class in the hierarchy.</p>

4987

</div>

4988

4989

4990

4991

<h4>Parameters:</h4>

4992

4993

4994

4995

4996

4997

<code class="param-name">userVals</code>

4998

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

4999

5000

5001

5002

5003

5004

<p>Object with configuration property name/value pairs</p>

5005

</div>

5006

5007

5008

</li>

5009

5010

</ul>

5011

</div>

5012

5013

5014

5015

5016

5017

</div>

5018

5019

5020

5021

<h3 class="name"><code>_initHierarchyData</code></h3>

5022

5023

5024

5025

5026

5027

5028

5029

5030

5031

5032

<span class="flag private">private</span>

5033

5034

5035

5036

5037

5038

5039

5040

5041

5042

5043

5044

<p>Inherited from

5045

<a href="../classes/BaseCore.html#method__initHierarchyData">BaseCore</a>:

5046

5047

5048

5049

<a href="../files/base_js_BaseCore.js.html#l372"><code>base/js/BaseCore.js:372</code></a>

5050

5051

</p>

5052

5053

5054

5055

5056

5057

</div>

5058

5059

5060

<p>A helper method used by _getClasses and _getAttrCfgs, which determines both

5061

the array of classes and aggregate set of attribute configurations

5062

across the class hierarchy for the instance.</p>

5063

</div>

5064

5065

5066

5067

5068

5069

5070

</div>

5071

5072

5073

5074

<h3 class="name"><code>_isLazyAttr</code></h3>

5075

5076

5077

5078

5079

5080

5081

5082

5083

5084

</li>

5085

5086

</ul><span class="paren">)</span>

5087

</div>

5088

5089

5090

5091

5092

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

5093

</span>

5094

5095

5096

5097

5098

5099

<span class="flag private">private</span>

5100

5101

5102

5103

5104

5105

5106

5107

5108

5109

5110

5111

<p>Inherited from

5112

<a href="../classes/AttributeCore.html#method__isLazyAttr">AttributeCore</a>:

5113

5114

5115

5116

<a href="../files/attribute_js_AttributeCore.js.html#l299"><code>attribute/js/AttributeCore.js:299</code></a>

5117

5118

</p>

5119

5120

5121

5122

5123

5124

</div>

5125

5126

5127

<p>Checks whether or not the attribute is one which has been

5128

added lazily and still requires initialization.</p>

5129

</div>

5130

5131

5132

5133

<h4>Parameters:</h4>

5134

5135

5136

5137

5138

5139

5140

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

5141

5142

5143

5144

5145

5146

<p>The name of the attribute</p>

5147

</div>

5148

5149

5150

</li>

5151

5152

</ul>

5153

</div>

5154

5155

5156

5157

5158

<h4>Returns:</h4>

5159

5160

5161

5162

5163

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:

5164

5165

true if it's a lazily added attribute, false otherwise.

5166

5167

</div>

5168

</div>

5169

5170

5171

5172

</div>

5173

5174

5175

5176

<h3 class="name"><code>_monitor</code></h3>

5177

5178

5179

5180

5181

5182

5183

5184

5185

5186

</li>

5187

5188

5189

5190

5191

5192

</li>

5193

5194

5195

5196

5197

5198

</li>

5199

5200

</ul><span class="paren">)</span>

5201

</div>

5202

5203

5204

5205

5206

5207

5208

5209

<span class="flag private">private</span>

5210

5211

5212

5213

5214

5215

5216

5217

5218

5219

5220

5221

<p>Inherited from

5222

<a href="../classes/EventTarget.html#method__monitor">EventTarget</a>:

5223

5224

5225

5226

<a href="../files/event-custom_js_event-target.js.html#l602"><code>event-custom/js/event-target.js:602</code></a>

5227

5228

</p>

5229

5230

5231

5232

5233

5234

</div>

5235

5236

5237

<p>This is the entry point for the event monitoring system.

5238

You can monitor 'attach', 'detach', 'fire', and 'publish'.

5239

When configured, these events generate an event. click ->

5240

click<em>attach, click</em>detach, click_publish -- these can

5241

be subscribed to like other events to monitor the event

5242

system. Inividual published events can have monitoring

5243

turned on or off (publish can't be turned off before it

5244

it published) by setting the events 'monitor' config.</p>

5245

</div>

5246

5247

5248

5249

<h4>Parameters:</h4>

5250

5251

5252

5253

5254

5255

5256

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

5257

5258

5259

5260

5261

5262

<p>'attach', 'detach', 'fire', or 'publish'</p>

5263

</div>

5264

5265

5266

</li>

5267

5268

5269

5270

5271

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

5272

5273

5274

5275

5276

5277

<p>Name of the event being monitored</p>

5278

</div>

5279

5280

5281

</li>

5282

5283

5284

5285

5286

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

5287

5288

5289

5290

5291

5292

<p>Information about the event interaction, such as

5293

fire() args, subscription category, publish config</p>

5294

</div>

5295

5296

5297

</li>

5298

5299

</ul>

5300

</div>

5301

5302

5303

5304

5305

5306

</div>

5307

5308

5309

5310

<h3 class="name"><code>_normAttrVals</code></h3>

5311

5312

5313

5314

5315

5316

5317

5318

<code>valueHash</code>

5319

5320

</li>

5321

5322

</ul><span class="paren">)</span>

5323

</div>

5324

5325

5326

5327

5328

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

5329

</span>

5330

5331

5332

5333

5334

5335

<span class="flag private">private</span>

5336

5337

5338

5339

5340

5341

5342

5343

5344

5345

5346

<p>Inherited from

5347

5348

Attribute

5349

</a>

5350

5351

but overwritten in

5352

5353

5354

5355

<a href="../files/attribute_js_AttributeCore.js.html#l808"><code>attribute/js/AttributeCore.js:808</code></a>

5356

5357

</p>

5358

5359

5360

5361

5362

5363

</div>

5364

5365

5366

<p>Utility method to normalize attribute values. The base implementation

5367

simply merges the hash to protect the original.</p>

5368

</div>

5369

5370

5371

5372

<h4>Parameters:</h4>

5373

5374

5375

5376

5377

5378

<code class="param-name">valueHash</code>

5379

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

5380

5381

5382

5383

5384

5385

<p>An object with attribute name/value pairs</p>

5386

</div>

5387

5388

5389

</li>

5390

5391

</ul>

5392

</div>

5393

5394

5395

5396

5397

<h4>Returns:</h4>

5398

5399

5400

5401

5402

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:

5403

5404

5405

</div>

5406

</div>

5407

5408

5409

5410

</div>

5411

5412

5413

5414

<h3 class="name"><code>_parseType</code></h3>

5415

5416

5417

5418

5419

5420

5421

5422

5423

5424

5425

<span class="flag private">private</span>

5426

5427

5428

5429

5430

5431

5432

5433

5434

5435

5436

5437

<p>Inherited from

5438

<a href="../classes/EventTarget.html#method__parseType">EventTarget</a>:

5439

5440

5441

5442

<a href="../files/event-custom_js_event-target.js.html#l52"><code>event-custom/js/event-target.js:52</code></a>

5443

5444

</p>

5445

5446

5447

5448

5449

5450

</div>

5451

5452

5453

<p>Returns an array with the detach key (if provided),

5454

and the prefixed event name from _getType

5455

Y.on('detachcategory| menu:click', fn)</p>

5456

</div>

5457

5458

5459

5460

5461

5462

5463

</div>

5464

5465

5466

5467

<h3 class="name"><code>_preInitEventCfg</code></h3>

5468

5469

5470

5471

5472

5473

5474

5475

<code>config</code>

5476

5477

</li>

5478

5479

</ul><span class="paren">)</span>

5480

</div>

5481

5482

5483

5484

5485

5486

5487

5488

<span class="flag private">private</span>

5489

5490

5491

5492

5493

5494

5495

5496

5497

5498

5499

5500

<p>Inherited from

5501

<a href="../classes/Base.html#method__preInitEventCfg">Base</a>:

5502

5503

5504

5505

5506

5507

</p>

5508

5509

5510

5511

5512

5513

</div>

5514

5515

5516

<p>Handles the special on, after and target properties which allow the user to

5517

easily configure on and after listeners as well as bubble targets during

5518

construction, prior to init.</p>

5519

</div>

5520

5521

5522

5523

<h4>Parameters:</h4>

5524

5525

5526

5527

5528

5529

<code class="param-name">config</code>

5530

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

5531

5532

5533

5534

5535

5536

<p>The user configuration object</p>

5537

</div>

5538

5539

5540

</li>

5541

5542

</ul>

5543

</div>

5544

5545

5546

5547

5548

5549

</div>

5550

5551

5552

5553

<h3 class="name"><code>_protectAttrs</code></h3>

5554

5555

5556

5557

5558

5559

5560

5561

<code>attrs</code>

5562

5563

</li>

5564

5565

</ul><span class="paren">)</span>

5566

</div>

5567

5568

5569

5570

5571

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

5572

</span>

5573

5574

5575

5576

5577

5578

<span class="flag protected">protected</span>

5579

5580

5581

5582

5583

5584

5585

5586

5587

5588

5589

5590

<p>Inherited from

5591

<a href="../classes/AttributeCore.html#method__protectAttrs">AttributeCore</a>:

5592

5593

5594

5595

<a href="../files/attribute_js_AttributeCore.js.html#l786"><code>attribute/js/AttributeCore.js:786</code></a>

5596

5597

</p>

5598

5599

5600

5601

5602

5603

</div>

5604

5605

5606

<p>Utility method to protect an attribute configuration

5607

hash, by merging the entire object and the individual

5608

attr config objects.</p>

5609

</div>

5610

5611

5612

5613

<h4>Parameters:</h4>

5614

5615

5616

5617

5618

5619

<code class="param-name">attrs</code>

5620

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

5621

5622

5623

5624

5625

5626

<p>A hash of attribute to configuration object pairs.</p>

5627

</div>

5628

5629

5630

</li>

5631

5632

</ul>

5633

</div>

5634

5635

5636

5637

5638

<h4>Returns:</h4>

5639

5640

5641

5642

5643

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:

5644

5645

A protected version of the attrs argument.

5646

5647

</div>

5648

</div>

5649

5650

5651

5652

</div>

5653

5654

5655

5656

5657

5658

5659

5660

5661

5662

5663

5664

5665

5666

</li>

5667

5668

5669

5670

5671

5672

</li>

5673

5674

</ul><span class="paren">)</span>

5675

</div>

5676

5677

5678

5679

5680

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

5681

</span>

5682

5683

5684

5685

5686

5687

<span class="flag protected">protected</span>

5688

5689

5690

5691

5692

5693

5694

5695

<span class="flag chainable">chainable</span>

5696

5697

5698

5699

5700

<p>Inherited from

5701

5702

AttributeEvents

5703

</a>

5704

5705

but overwritten in

5706

5707

5708

5709

<a href="../files/attribute_js_AttributeCore.js.html#l346"><code>attribute/js/AttributeCore.js:346</code></a>

5710

5711

</p>

5712

5713

5714

5715

5716

5717

</div>

5718

5719

5720

<p>Allows setting of readOnly/writeOnce attributes. See <a href="#method_set">set</a> for argument details.</p>

5721

</div>

5722

5723

5724

5725

<h4>Parameters:</h4>

5726

5727

5728

5729

5730

5731

5732

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

5733

5734

5735

5736

5737

5738

<p>The name of the attribute.</p>

5739

</div>

5740

5741

5742

</li>

5743

5744

5745

5746

5747

5748

5749

5750

5751

5752

5753

<p>The value to set the attribute to.</p>

5754

</div>

5755

5756

5757

</li>

5758

5759

</ul>

5760

</div>

5761

5762

5763

5764

5765

<h4>Returns:</h4>

5766

5767

5768

5769

5770

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:

5771

5772

A reference to the host object.

5773

5774

</div>

5775

</div>

5776

5777

5778

5779

</div>

5780

5781

5782

5783

<h3 class="name"><code>_setAttr</code></h3>

5784

5785

5786

5787

5788

5789

5790

5791

5792

5793

</li>

5794

5795

5796

5797

<code>value</code>

5798

5799

</li>

5800

5801

5802

5803

5804

5805

</li>

5806

5807

5808

5809

<code>force</code>

5810

5811

</li>

5812

5813

</ul><span class="paren">)</span>

5814

</div>

5815

5816

5817

5818

5819

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

5820

</span>

5821

5822

5823

5824

5825

5826

<span class="flag protected">protected</span>

5827

5828

5829

5830

5831

5832

5833

5834

<span class="flag chainable">chainable</span>

5835

5836

5837

5838

5839

5840

<p>Inherited from

5841

<a href="../classes/AttributeCore.html#method__setAttr">AttributeCore</a>:

5842

5843

5844

5845

<a href="../files/attribute_js_AttributeCore.js.html#l361"><code>attribute/js/AttributeCore.js:361</code></a>

5846

5847

</p>

5848

5849

5850

5851

5852

5853

</div>

5854

5855

5856

<p>Provides the common implementation for the public set and protected _set methods.</p>

5857

5858

<p>See <a href="#method_set">set</a> for argument details.</p>

5859

</div>

5860

5861

5862

5863

<h4>Parameters:</h4>

5864

5865

5866

5867

5868

5869

5870

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

5871

5872

5873

5874

5875

5876

<p>The name of the attribute.</p>

5877

</div>

5878

5879

5880

</li>

5881

5882

5883

5884

<code class="param-name">value</code>

5885

5886

5887

5888

5889

5890

5891

<p>The value to set the attribute to.</p>

5892

</div>

5893

5894

5895

</li>

5896

5897

5898

5899

5900

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

5901

5902

5903

5904

5905

5906

<p>(Optional) Optional event data to be mixed into

5907

the event facade passed to subscribers of the attribute's change event.

5908

This is currently a hack. There's no real need for the AttributeCore implementation

5909

to support this parameter, but breaking it out into AttributeEvents, results in

5910

additional function hops for the critical path. May change in 3.5.0 PR3.</p>

5911

</div>

5912

5913

5914

</li>

5915

5916

5917

5918

<code class="param-name">force</code>

5919

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

5920

5921

5922

5923

5924

5925

<p>If true, allows the caller to set values for

5926

readOnly or writeOnce attributes which have already been set.</p>

5927

</div>

5928

5929

5930

</li>

5931

5932

</ul>

5933

</div>

5934

5935

5936

5937

5938

<h4>Returns:</h4>

5939

5940

5941

5942

5943

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:

5944

5945

A reference to the host object.

5946

5947

</div>

5948

</div>

5949

5950

5951

5952

</div>

5953

5954

5955

5956

<h3 class="name"><code>_setAttrs</code></h3>

5957

5958

5959

5960

5961

5962

5963

5964

<code>attrs</code>

5965

5966

</li>

5967

5968

</ul><span class="paren">)</span>

5969

</div>

5970

5971

5972

5973

5974

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

5975

</span>

5976

5977

5978

5979

5980

5981

<span class="flag protected">protected</span>

5982

5983

5984

5985

5986

5987

5988

5989

<span class="flag chainable">chainable</span>

5990

5991

5992

5993

5994

5995

<p>Inherited from

5996

<a href="../classes/AttributeCore.html#method__setAttrs">AttributeCore</a>:

5997

5998

5999

6000

<a href="../files/attribute_js_AttributeCore.js.html#l647"><code>attribute/js/AttributeCore.js:647</code></a>

6001

6002

</p>

6003

6004

6005

6006

6007

6008

</div>

6009

6010

6011

<p>Implementation behind the public setAttrs method, to set multiple attribute values.</p>

6012

</div>

6013

6014

6015

6016

<h4>Parameters:</h4>

6017

6018

6019

6020

6021

6022

<code class="param-name">attrs</code>

6023

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

6024

6025

6026

6027

6028

6029

<p>An object with attributes name/value pairs.</p>

6030

</div>

6031

6032

6033

</li>

6034

6035

</ul>

6036

</div>

6037

6038

6039

6040

6041

<h4>Returns:</h4>

6042

6043

6044

6045

6046

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:

6047

6048

A reference to the host object.

6049

6050

</div>

6051

</div>

6052

6053

6054

6055

</div>

6056

6057

6058

6059

<h3 class="name"><code>_setAttrVal</code></h3>

6060

6061

6062

6063

6064

6065

6066

6067

<code>attrName</code>

6068

6069

</li>

6070

6071

6072

6073

<code>subAttrName</code>

6074

6075

</li>

6076

6077

6078

6079

<code>prevVal</code>

6080

6081

</li>

6082

6083

6084

6085

<code>newVal</code>

6086

6087

</li>

6088

6089

</ul><span class="paren">)</span>

6090

</div>

6091

6092

6093

6094

6095

<span class="type">Booolean</span>

6096

</span>

6097

6098

6099

6100

6101

6102

<span class="flag private">private</span>

6103

6104

6105

6106

6107

6108

6109

6110

6111

6112

6113

6114

<p>Inherited from

6115

<a href="../classes/AttributeCore.html#method__setAttrVal">AttributeCore</a>:

6116

6117

6118

6119

<a href="../files/attribute_js_AttributeCore.js.html#l554"><code>attribute/js/AttributeCore.js:554</code></a>

6120

6121

</p>

6122

6123

6124

6125

6126

6127

</div>

6128

6129

6130

<p>Updates the stored value of the attribute in the privately held State object,

6131

if validation and setter passes.</p>

6132

</div>

6133

6134

6135

6136

<h4>Parameters:</h4>

6137

6138

6139

6140

6141

6142

<code class="param-name">attrName</code>

6143

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

6144

6145

6146

6147

6148

6149

<p>The attribute name.</p>

6150

</div>

6151

6152

6153

</li>

6154

6155

6156

6157

<code class="param-name">subAttrName</code>

6158

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

6159

6160

6161

6162

6163

6164

<p>The sub-attribute name, if setting a sub-attribute property ("x.y.z").</p>

6165

</div>

6166

6167

6168

</li>

6169

6170

6171

6172

<code class="param-name">prevVal</code>

6173

6174

6175

6176

6177

6178

6179

<p>The currently stored value of the attribute.</p>

6180

</div>

6181

6182

6183

</li>

6184

6185

6186

6187

<code class="param-name">newVal</code>

6188

6189

6190

6191

6192

6193

6194

<p>The value which is going to be stored.</p>

6195

</div>

6196

6197

6198

</li>

6199

6200

</ul>

6201

</div>

6202

6203

6204

6205

6206

<h4>Returns:</h4>

6207

6208

6209

6210

6211

<span class="type">Booolean</span>:

6212

6213

true if the new attribute value was stored, false if not.

6214

6215

</div>

6216

</div>

6217

6218

6219

6220

</div>

6221

6222

6223

6224

<h3 class="name"><code>_setStateVal</code></h3>

6225

6226

6227

6228

6229

6230

6231

6232

6233

6234

</li>

6235

6236

6237

6238

<code>value</code>

6239

6240

</li>

6241

6242

</ul><span class="paren">)</span>

6243

</div>

6244

6245

6246

6247

6248

6249

6250

6251

<span class="flag private">private</span>

6252

6253

6254

6255

6256

6257

6258

6259

6260

6261

6262

6263

<p>Inherited from

6264

<a href="../classes/AttributeCore.html#method__setStateVal">AttributeCore</a>:

6265

6266

6267

6268

<a href="../files/attribute_js_AttributeCore.js.html#l536"><code>attribute/js/AttributeCore.js:536</code></a>

6269

6270

</p>

6271

6272

6273

6274

6275

6276

</div>

6277

6278

6279

<p>Sets the stored value for the attribute, in either the

6280

internal state object, or the state proxy if it exits</p>

6281

</div>

6282

6283

6284

6285

<h4>Parameters:</h4>

6286

6287

6288

6289

6290

6291

6292

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

6293

6294

6295

6296

6297

6298

<p>The name of the attribute</p>

6299

</div>

6300

6301

6302

</li>

6303

6304

6305

6306

<code class="param-name">value</code>

6307

6308

6309

6310

6311

6312

6313

<p>The value of the attribute</p>

6314

</div>

6315

6316

6317

</li>

6318

6319

</ul>

6320

</div>

6321

6322

6323

6324

6325

6326

</div>

6327

6328

6329

6330

<h3 class="name"><code>_tickAlignX</code></h3>

6331

6332

6333

6334

6335

6336

6337

6338

6339

6340

6341

<span class="flag private">private</span>

6342

6343

6344

6345

6346

6347

6348

6349

6350

6351

6352

6353

6354

<p>

6355

6356

Defined in

6357

6358

6359

6360

6361

<a href="../files/dd_js_constrain.js.html#l453"><code>dd/js/constrain.js:453</code></a>

6362

6363

</p>

6364

6365

6366

6367

6368

6369

</div>

6370

6371

6372

<p>Fires when the actXY[0] reach a new value respecting the tickX gap.</p>

6373

</div>

6374

6375

6376

6377

6378

6379

6380

</div>

6381

6382

6383

6384

<h3 class="name"><code>_tickAlignY</code></h3>

6385

6386

6387

6388

6389

6390

6391

6392

6393

6394

6395

<span class="flag private">private</span>

6396

6397

6398

6399

6400

6401

6402

6403

6404

6405

6406

6407

6408

<p>

6409

6410

Defined in

6411

6412

6413

6414

6415

<a href="../files/dd_js_constrain.js.html#l461"><code>dd/js/constrain.js:461</code></a>

6416

6417

</p>

6418

6419

6420

6421

6422

6423

</div>

6424

6425

6426

<p>Fires when the actXY[1] reach a new value respecting the tickY gap.</p>

6427

</div>

6428

6429

6430

6431

6432

6433

6434

</div>

6435

6436

6437

6438

<h3 class="name"><code>addAttr</code></h3>

6439

6440

6441

6442

6443

6444

6445

6446

6447

6448

</li>

6449

6450

6451

6452

<code>config</code>

6453

6454

</li>

6455

6456

6457

6458

6459

6460

</li>

6461

6462

</ul><span class="paren">)</span>

6463

</div>

6464

6465

6466

6467

6468

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

6469

</span>

6470

6471

6472

6473

6474

6475

6476

6477

6478

6479

6480

6481

<span class="flag chainable">chainable</span>

6482

6483

6484

6485

6486

6487

<p>Inherited from

6488

<a href="../classes/AttributeCore.html#method_addAttr">AttributeCore</a>:

6489

6490

6491

6492

<a href="../files/attribute_js_AttributeCore.js.html#l124"><code>attribute/js/AttributeCore.js:124</code></a>

6493

6494

</p>

6495

6496

6497

6498

6499

6500

</div>

6501

6502

6503

<p>

6504

Adds an attribute with the provided configuration to the host object.

6505

</p>

6506

6507

<p>

6508

The config argument object supports the following properties:

6509

</p>

6510

6511

<dl>

6512

<dt>value <Any></dt>

6513

<dd>The initial value to set on the attribute</dd>

6514

6515

<dt>valueFn <Function | String></dt>

6516

<dd>

6517

<p>A function, which will return the initial value to set on the attribute. This is useful

6518

for cases where the attribute configuration is defined statically, but needs to

6519

reference the host instance ("this") to obtain an initial value. If both the value and valueFn properties are defined,

6520

the value returned by the valueFn has precedence over the value property, unless it returns undefined, in which

6521

case the value property is used.</p>

6522

6523

<p>valueFn can also be set to a string, representing the name of the instance method to be used to retrieve the value.</p>

6524

</dd>

6525

6526

<dt>readOnly <boolean></dt>

6527

<dd>Whether or not the attribute is read only. Attributes having readOnly set to true

6528

cannot be modified by invoking the set method.</dd>

6529

6530

<dt>writeOnce <boolean> or <string></dt>

6531

<dd>

6532

Whether or not the attribute is "write once". Attributes having writeOnce set to true,

6533

can only have their values set once, be it through the default configuration,

6534

constructor configuration arguments, or by invoking set.

6535

<p>The writeOnce attribute can also be set to the string "initOnly", in which case the attribute can only be set during initialization

6536

(when used with Base, this means it can only be set during construction)</p>

6537

</dd>

6538

6539

<dt>setter <Function | String></dt>

6540

<dd>

6541

<p>The setter function used to massage or normalize the value passed to the set method for the attribute.

6542

The value returned by the setter will be the final stored value. Returning

6543

<a href="#property_Attribute.INVALID_VALUE">Attribute.INVALID_VALUE</a>, from the setter will prevent

6544

the value from being stored.

6545

</p>

6546

6547

<p>setter can also be set to a string, representing the name of the instance method to be used as the setter function.</p>

6548

</dd>

6549

6550

<dt>getter <Function | String></dt>

6551

<dd>

6552

<p>

6553

The getter function used to massage or normalize the value returned by the get method for the attribute.

6554

The value returned by the getter function is the value which will be returned to the user when they

6555

invoke get.

6556

</p>

6557

6558

<p>getter can also be set to a string, representing the name of the instance method to be used as the getter function.</p>

6559

</dd>

6560

6561

<dt>validator <Function | String></dt>

6562

<dd>

6563

<p>

6564

The validator function invoked prior to setting the stored value. Returning

6565

false from the validator function will prevent the value from being stored.

6566

</p>

6567

6568

<p>validator can also be set to a string, representing the name of the instance method to be used as the validator function.</p>

6569

</dd>

6570

6571

<dt>lazyAdd <boolean></dt>

6572

<dd>Whether or not to delay initialization of the attribute until the first call to get/set it.

6573

This flag can be used to over-ride lazy initialization on a per attribute basis, when adding multiple attributes through

6574

the <a href="#method_addAttrs">addAttrs</a> method.</dd>

6575

6576

</dl>

6577

6578

<p>The setter, getter and validator are invoked with the value and name passed in as the first and second arguments, and with

6579

the context ("this") set to the host object.</p>

6580

6581

<p>Configuration properties outside of the list mentioned above are considered private properties used internally by attribute,

6582

and are not intended for public use.</p>

6583

</div>

6584

6585

6586

6587

<h4>Parameters:</h4>

6588

6589

6590

6591

6592

6593

6594

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

6595

6596

6597

6598

6599

6600

<p>The name of the attribute.</p>

6601

</div>

6602

6603

6604

</li>

6605

6606

6607

6608

<code class="param-name">config</code>

6609

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

6610

6611

6612

6613

6614

6615

<p>An object with attribute configuration property/value pairs, specifying the configuration for the attribute.</p>

6616

6617

<p>

6618

<strong>NOTE:</strong> The configuration object is modified when adding an attribute, so if you need

6619

to protect the original values, you will need to merge the object.

6620

</p>

6621

</div>

6622

6623

6624

</li>

6625

6626

6627

6628

6629

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

6630

6631

6632

6633

6634

6635

<p>(optional) Whether or not to add this attribute lazily (on the first call to get/set).</p>

6636

</div>

6637

6638

6639

</li>

6640

6641

</ul>

6642

</div>

6643

6644

6645

6646

6647

<h4>Returns:</h4>

6648

6649

6650

6651

6652

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:

6653

6654

A reference to the host object.

6655

6656

</div>

6657

</div>

6658

6659

6660

6661

</div>

6662

6663

6664

6665

<h3 class="name"><code>addAttrs</code></h3>

6666

6667

6668

6669

6670

6671

6672

6673

6674

6675

</li>

6676

6677

6678

6679

<code>values</code>

6680

6681

</li>

6682

6683

6684

6685

6686

6687

</li>

6688

6689

</ul><span class="paren">)</span>

6690

</div>

6691

6692

6693

6694

6695

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

6696

</span>

6697

6698

6699

6700

6701

6702

6703

6704

6705

6706

6707

6708

<span class="flag chainable">chainable</span>

6709

6710

6711

6712

6713

6714

<p>Inherited from

6715

<a href="../classes/AttributeCore.html#method_addAttrs">AttributeCore</a>:

6716

6717

6718

6719

<a href="../files/attribute_js_AttributeCore.js.html#l708"><code>attribute/js/AttributeCore.js:708</code></a>

6720

6721

</p>

6722

6723

6724

6725

6726

6727

</div>

6728

6729

6730

<p>Configures a group of attributes, and sets initial values.</p>

6731

6732

<p>

6733

<strong>NOTE:</strong> This method does not isolate the configuration object by merging/cloning.

6734

The caller is responsible for merging/cloning the configuration object if required.

6735

</p>

6736

</div>

6737

6738

6739

6740

<h4>Parameters:</h4>

6741

6742

6743

6744

6745

6746

6747

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

6748

6749

6750

6751

6752

6753

<p>An object with attribute name/configuration pairs.</p>

6754

</div>

6755

6756

6757

</li>

6758

6759

6760

6761

<code class="param-name">values</code>

6762

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

6763

6764

6765

6766

6767

6768

<p>An object with attribute name/value pairs, defining the initial values to apply.

6769

Values defined in the cfgs argument will be over-written by values in this argument unless defined as read only.</p>

6770

</div>

6771

6772

6773

</li>

6774

6775

6776

6777

6778

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

6779

6780

6781

6782

6783

6784

<p>Whether or not to delay the intialization of these attributes until the first call to get/set.

6785

Individual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration.

6786

See <a href="#method_addAttr">addAttr</a>.</p>

6787

</div>

6788

6789

6790

</li>

6791

6792

</ul>

6793

</div>

6794

6795

6796

6797

6798

<h4>Returns:</h4>

6799

6800

6801

6802

6803

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:

6804

6805

A reference to the host object.

6806

6807

</div>

6808

</div>

6809

6810

6811

6812

</div>

6813

6814

6815

6816

<h3 class="name"><code>addTarget</code></h3>

6817

6818

6819

6820

6821

6822

6823

6824

6825

6826

</li>

6827

6828

</ul><span class="paren">)</span>

6829

</div>

6830

6831

6832

6833

6834

6835

6836

6837

6838

6839

6840

6841

6842

6843

6844

6845

6846

6847

<p>Inherited from

6848

<a href="../classes/EventTarget.html#method_addTarget">EventTarget</a>:

6849

6850

6851

6852

<a href="../files/event-custom_js_event-facade.js.html#l382"><code>event-custom/js/event-facade.js:382</code></a>

6853

6854

</p>

6855

6856

6857

6858

6859

6860

</div>

6861

6862

6863

<p>Registers another EventTarget as a bubble target. Bubble order

6864

is determined by the order registered. Multiple targets can

6865

be specified.</p>

6866

6867

<p>Events can only bubble if emitFacade is true.</p>

6868

6869

<p>Included in the event-custom-complex submodule.</p>

6870

</div>

6871

6872

6873

6874

<h4>Parameters:</h4>

6875

6876

6877

6878

6879

6880

6881

<span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span>

6882

6883

6884

6885

6886

6887

<p>the target to add</p>

6888

</div>

6889

6890

6891

</li>

6892

6893

</ul>

6894

</div>

6895

6896

6897

6898

6899

6900

</div>

6901

6902

6903

6904

<h3 class="name"><code>after</code></h3>

6905

6906

6907

6908

6909

6910

6911

6912

6913

6914

</li>

6915

6916

6917

6918

6919

6920

</li>

6921

6922

6923

6924

<code class="optional">[context]</code>

6925

6926

</li>

6927

6928

6929

6930

6931

6932

</li>

6933

6934

</ul><span class="paren">)</span>

6935

</div>

6936

6937

6938

6939

6940

<span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>

6941

</span>

6942

6943

6944

6945

6946

6947

6948

6949

6950

6951

6952

6953

6954

6955

6956

6957

<p>Inherited from

6958

<a href="../classes/EventTarget.html#method_after">EventTarget</a>:

6959

6960

6961

6962

<a href="../files/event-custom_js_event-target.js.html#l730"><code>event-custom/js/event-target.js:730</code></a>

6963

6964

</p>

6965

6966

6967

6968

6969

6970

</div>

6971

6972

6973

<p>Subscribe to a custom event hosted by this object. The

6974

supplied callback will execute after any listeners add

6975

via the subscribe method, and after the default function,

6976

if configured for the event, has executed.</p>

6977

</div>

6978

6979

6980

6981

<h4>Parameters:</h4>

6982

6983

6984

6985

6986

6987

6988

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

6989

6990

6991

6992

6993

6994

<p>The name of the event</p>

6995

</div>

6996

6997

6998

</li>

6999

7000

7001

7002

7003

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>

7004

7005

7006

7007

7008

7009

<p>The callback to execute in response to the event</p>

7010

</div>

7011

7012

7013

</li>

7014

7015

7016

7017

<code class="param-name optional">[context]</code>

7018

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

7019

<span class="flag optional" title="This parameter is optional.">optional</span>

7020

7021

7022

7023

7024

7025

<p>Override <code>this</code> object in callback</p>

7026

</div>

7027

7028

7029

</li>

7030

7031

7032

7033

7034

7035

<span class="flag optional" title="This parameter is optional.">optional</span>

7036

7037

7038

7039

7040

7041

<p>0..n additional arguments to supply to the subscriber</p>

7042

</div>

7043

7044

7045

</li>

7046

7047

</ul>

7048

</div>

7049

7050

7051

7052

7053

<h4>Returns:</h4>

7054

7055

7056

7057

7058

<span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>:

7059

7060

A subscription handle capable of detaching the

7061

subscription

7062

7063

</div>

7064

</div>

7065

7066

7067

7068

</div>

7069

7070

7071

7072

<h3 class="name"><code>align</code></h3>

7073

7074

7075

7076

7077

7078

7079

7080

7081

7082

7083

7084

7085

7086

7087

7088

7089

7090

7091

7092

7093

7094

<p>

7095

7096

Defined in

7097

7098

7099

7100

7101

<a href="../files/dd_js_constrain.js.html#l380"><code>dd/js/constrain.js:380</code></a>

7102

7103

</p>

7104

7105

7106

7107

7108

7109

</div>

7110

7111

7112

<p>Modifies the Drag.actXY method from the after drag:align event. This is where the constraining happens.</p>

7113

</div>

7114

7115

7116

7117

7118

7119

7120

</div>

7121

7122

7123

7124

<h3 class="name"><code>attrAdded</code></h3>

7125

7126

7127

7128

7129

7130

7131

7132

7133

7134

</li>

7135

7136

</ul><span class="paren">)</span>

7137

</div>

7138

7139

7140

7141

7142

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

7143

</span>

7144

7145

7146

7147

7148

7149

7150

7151

7152

7153

7154

7155

7156

7157

7158

7159

<p>Inherited from

7160

<a href="../classes/AttributeCore.html#method_attrAdded">AttributeCore</a>:

7161

7162

7163

7164

<a href="../files/attribute_js_AttributeCore.js.html#l272"><code>attribute/js/AttributeCore.js:272</code></a>

7165

7166

</p>

7167

7168

7169

7170

7171

7172

</div>

7173

7174

7175

<p>Checks if the given attribute has been added to the host</p>

7176

</div>

7177

7178

7179

7180

<h4>Parameters:</h4>

7181

7182

7183

7184

7185

7186

7187

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

7188

7189

7190

7191

7192

7193

<p>The name of the attribute to check.</p>

7194

</div>

7195

7196

7197

</li>

7198

7199

</ul>

7200

</div>

7201

7202

7203

7204

7205

<h4>Returns:</h4>

7206

7207

7208

7209

7210

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:

7211

7212

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.

7213

7214

</div>

7215

</div>

7216

7217

7218

7219

</div>

7220

7221

7222

7223

<h3 class="name"><code>before</code></h3>

7224

7225

7226

7227

7228

7229

7230

7231

7232

</span>

7233

7234

7235

7236

7237

7238

7239

7240

7241

7242

7243

7244

7245

7246

7247

7248

<p>Inherited from

7249

<a href="../classes/EventTarget.html#method_before">EventTarget</a>:

7250

7251

7252

7253

<a href="../files/event-custom_js_event-target.js.html#l767"><code>event-custom/js/event-target.js:767</code></a>

7254

7255

</p>

7256

7257

7258

7259

7260

7261

</div>

7262

7263

7264

<p>Executes the callback before a DOM event, custom event

7265

or method. If the first argument is a function, it

7266

is assumed the target is a method. For DOM and custom

7267

events, this is an alias for Y.on.</p>

7268

7269

<p>For DOM and custom events:

7270

type, callback, context, 0-n arguments</p>

7271

7272

<p>For methods:

7273

callback, object (method host), methodName, context, 0-n arguments</p>

7274

</div>

7275

7276

7277

7278

7279

7280

<h4>Returns:</h4>

7281

7282

7283

7284

7285

detach handle

7286

7287

</div>

7288

</div>

7289

7290

7291

7292

</div>

7293

7294

7295

7296

<h3 class="name"><code>bubble</code></h3>

7297

7298

7299

7300

7301

7302

7303

7304

7305

7306

</li>

7307

7308

</ul><span class="paren">)</span>

7309

</div>

7310

7311

7312

7313

7314

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

7315

</span>

7316

7317

7318

7319

7320

7321

7322

7323

7324

7325

7326

7327

7328

7329

7330

7331

<p>Inherited from

7332

<a href="../classes/EventTarget.html#method_bubble">EventTarget</a>:

7333

7334

7335

7336

<a href="../files/event-custom_js_event-facade.js.html#l419"><code>event-custom/js/event-facade.js:419</code></a>

7337

7338

</p>

7339

7340

7341

7342

7343

7344

</div>

7345

7346

7347

<p>Propagate an event. Requires the event-custom-complex module.</p>

7348

</div>

7349

7350

7351

7352

<h4>Parameters:</h4>

7353

7354

7355

7356

7357

7358

7359

<span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>

7360

7361

7362

7363

7364

7365

<p>the custom event to propagate</p>

7366

</div>

7367

7368

7369

</li>

7370

7371

</ul>

7372

</div>

7373

7374

7375

7376

7377

<h4>Returns:</h4>

7378

7379

7380

7381

7382

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:

7383

7384

the aggregated return value from Event.Custom.fire

7385

7386

</div>

7387

</div>

7388

7389

7390

7391

</div>

7392

7393

7394

7395

<h3 class="name"><code>destroy</code></h3>

7396

7397

7398

7399

7400

7401

7402

7403

7404

</span>

7405

7406

7407

7408

7409

7410

7411

7412

7413

7414

7415

7416

<span class="flag chainable">chainable</span>

7417

7418

7419

7420

7421

<p>Inherited from

7422

7423

BaseCore

7424

</a>

7425

7426

but overwritten in

7427

7428

7429

7430

7431

7432

</p>

7433

7434

7435

7436

7437

7438

</div>

7439

7440

7441

<p>

7442

Destroy lifecycle method. Fires the destroy

7443

event, prior to invoking destructors for the

7444

class hierarchy.

7445

</p>

7446

7447

<p>

7448

Subscribers to the destroy

7449

event can invoke preventDefault on the event object, to prevent destruction

7450

from proceeding.

7451

</p>

7452

</div>

7453

7454

7455

7456

7457

7458

<h4>Returns:</h4>

7459

7460

7461

7462

7463

<span class="type"><a href="../classes/Base.html" class="crosslink">Base</a></span>:

7464

7465

A reference to this object

7466

7467

</div>

7468

</div>

7469

7470

7471

7472

</div>

7473

7474

7475

7476

<h3 class="name"><code>detach</code></h3>

7477

7478

7479

7480

7481

7482

7483

7484

7485

7486

</li>

7487

7488

7489

7490

7491

7492

</li>

7493

7494

7495

7496

<code>context</code>

7497

7498

</li>

7499

7500

</ul><span class="paren">)</span>

7501

</div>

7502

7503

7504

7505

7506

<span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span>

7507

</span>

7508

7509

7510

7511

7512

7513

7514

7515

7516

7517

7518

7519

7520

7521

7522

7523

<p>Inherited from

7524

<a href="../classes/EventTarget.html#method_detach">EventTarget</a>:

7525

7526

7527

7528

<a href="../files/event-custom_js_event-target.js.html#l345"><code>event-custom/js/event-target.js:345</code></a>

7529

7530

</p>

7531

7532

7533

7534

7535

7536

</div>

7537

7538

7539

<p>Detach one or more listeners the from the specified event</p>

7540

</div>

7541

7542

7543

7544

<h4>Parameters:</h4>

7545

7546

7547

7548

7549

7550

7551

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

7552

7553

7554

7555

7556

7557

<p>Either the handle to the subscriber or the

7558

type of event. If the type

7559

is not specified, it will attempt to remove

7560

the listener from all hosted events.</p>

7561

</div>

7562

7563

7564

</li>

7565

7566

7567

7568

7569

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>

7570

7571

7572

7573

7574

7575

<p>The subscribed function to unsubscribe, if not

7576

supplied, all subscribers will be removed.</p>

7577

</div>

7578

7579

7580

</li>

7581

7582

7583

7584

<code class="param-name">context</code>

7585

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

7586

7587

7588

7589

7590

7591

<p>The custom object passed to subscribe. This is

7592

optional, but if supplied will be used to

7593

disambiguate multiple listeners that are the same

7594

(e.g., you subscribe many object using a function

7595

that lives on the prototype)</p>

7596

</div>

7597

7598

7599

</li>

7600

7601

</ul>

7602

</div>

7603

7604

7605

7606

7607

<h4>Returns:</h4>

7608

7609

7610

7611

7612

<span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span>:

7613

7614

the host

7615

7616

</div>

7617

</div>

7618

7619

7620

7621

</div>

7622

7623

7624

7625

<h3 class="name"><code>detachAll</code></h3>

7626

7627

7628

7629

7630

7631

7632

7633

7634

7635

</li>

7636

7637

</ul><span class="paren">)</span>

7638

</div>

7639

7640

7641

7642

7643

7644

7645

7646

7647

7648

7649

7650

7651

7652

7653

7654

7655

7656

<p>Inherited from

7657

<a href="../classes/EventTarget.html#method_detachAll">EventTarget</a>:

7658

7659

7660

7661

<a href="../files/event-custom_js_event-target.js.html#l465"><code>event-custom/js/event-target.js:465</code></a>

7662

7663

</p>

7664

7665

7666

7667

7668

7669

</div>

7670

7671

7672

<p>Removes all listeners from the specified event. If the event type

7673

is not specified, all listeners from all hosted custom events will

7674

be removed.</p>

7675

</div>

7676

7677

7678

7679

<h4>Parameters:</h4>

7680

7681

7682

7683

7684

7685

7686

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

7687

7688

7689

7690

7691

7692

<p>The type, or name of the event</p>

7693

</div>

7694

7695

7696

</li>

7697

7698

</ul>

7699

</div>

7700

7701

7702

7703

7704

7705

</div>

7706

7707

7708

7709

7710

7711

7712

7713

7714

7715

7716

7717

7718

7719

7720

7721

7722

7723

7724

7725

7726

7727

7728

7729

7730

7731

<p>

7732

7733

Defined in

7734

7735

7736

7737

7738

<a href="../files/dd_js_constrain.js.html#l404"><code>dd/js/constrain.js:404</code></a>

7739

7740

</p>

7741

7742

7743

7744

7745

7746

</div>

7747

7748

7749

<p>Fires after drag:drag. Handle the tickX and tickX align events.</p>

7750

</div>

7751

7752

7753

7754

7755

7756

7757

</div>

7758

7759

7760

7761

7762

7763

7764

7765

7766

7767

7768

7769

7770

7771

</li>

7772

7773

7774

7775

<code>arguments</code>

7776

7777

</li>

7778

7779

</ul><span class="paren">)</span>

7780

</div>

7781

7782

7783

7784

7785

<span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span>

7786

</span>

7787

7788

7789

7790

7791

7792

7793

7794

7795

7796

7797

7798

7799

7800

7801

7802

<p>Inherited from

7803

<a href="../classes/EventTarget.html#method_fire">EventTarget</a>:

7804

7805

7806

7807

<a href="../files/event-custom_js_event-target.js.html#l629"><code>event-custom/js/event-target.js:629</code></a>

7808

7809

</p>

7810

7811

7812

7813

7814

7815

</div>

7816

7817

7818

<p>Fire a custom event by name. The callback functions will be executed

7819

from the context specified when the event was created, and with the

7820

following parameters.</p>

7821

7822

<p>If the custom event object hasn't been created, then the event hasn't

7823

been published and it has no subscribers. For performance sake, we

7824

immediate exit in this case. This means the event won't bubble, so

7825

if the intention is that a bubble target be notified, the event must

7826

be published on this object first.</p>

7827

7828

<p>The first argument is the event type, and any additional arguments are

7829

passed to the listeners as parameters. If the first of these is an

7830

object literal, and the event is configured to emit an event facade,

7831

that object is mixed into the event facade and the facade is provided

7832

in place of the original object.</p>

7833

</div>

7834

7835

7836

7837

<h4>Parameters:</h4>

7838

7839

7840

7841

7842

7843

7844

7845

7846

7847

7848

7849

7850

<p>The type of the event, or an object that contains

7851

a 'type' property.</p>

7852

</div>

7853

7854

7855

</li>

7856

7857

7858

7859

<code class="param-name">arguments</code>

7860

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object*</a></span>

7861

7862

7863

7864

7865

7866

<p>an arbitrary set of parameters to pass to

7867

the handler. If the first of these is an object literal and the event is

7868

configured to emit an event facade, the event facade will replace that

7869

parameter after the properties the object literal contains are copied to

7870

the event facade.</p>

7871

</div>

7872

7873

7874

</li>

7875

7876

</ul>

7877

</div>

7878

7879

7880

7881

7882

<h4>Returns:</h4>

7883

7884

7885

7886

7887

<span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span>:

7888

7889

the event host

7890

7891

</div>

7892

</div>

7893

7894

7895

7896

</div>

7897

7898

7899

7900

7901

7902

7903

7904

7905

7906

7907

7908

7909

7910

</li>

7911

7912

</ul><span class="paren">)</span>

7913

</div>

7914

7915

7916

7917

7918

7919

</span>

7920

7921

7922

7923

7924

7925

7926

7927

7928

7929

7930

7931

7932

7933

7934

7935

<p>Inherited from

7936

<a href="../classes/AttributeCore.html#method_get">AttributeCore</a>:

7937

7938

7939

7940

<a href="../files/attribute_js_AttributeCore.js.html#l283"><code>attribute/js/AttributeCore.js:283</code></a>

7941

7942

</p>

7943

7944

7945

7946

7947

7948

</div>

7949

7950

7951

<p>Returns the current value of the attribute. If the attribute

7952

has been configured with a 'getter' function, this method will delegate

7953

to the 'getter' to obtain the value of the attribute.</p>

7954

</div>

7955

7956

7957

7958

<h4>Parameters:</h4>

7959

7960

7961

7962

7963

7964

7965

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

7966

7967

7968

7969

7970

7971

<p>The name of the attribute. If the value of the attribute is an Object,

7972

dot notation can be used to obtain the value of a property of the object (e.g. <code>get("x.y.z")</code>)</p>

7973

</div>

7974

7975

7976

</li>

7977

7978

</ul>

7979

</div>

7980

7981

7982

7983

7984

<h4>Returns:</h4>

7985

7986

7987

7988

7989

<span class="type">Any</span>:

7990

7991

The value of the attribute

7992

7993

</div>

7994

</div>

7995

7996

7997

7998

</div>

7999

8000

8001

8002

<h3 class="name"><code>getAttrs</code></h3>

8003

8004

8005

8006

8007

8008

8009

8010

<code>attrs</code>

8011

8012

</li>

8013

8014

</ul><span class="paren">)</span>

8015

</div>

8016

8017

8018

8019

8020

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

8021

</span>

8022

8023

8024

8025

8026

8027

8028

8029

8030

8031

8032

8033

8034

8035

8036

8037

<p>Inherited from

8038

<a href="../classes/AttributeCore.html#method_getAttrs">AttributeCore</a>:

8039

8040

8041

8042

<a href="../files/attribute_js_AttributeCore.js.html#l665"><code>attribute/js/AttributeCore.js:665</code></a>

8043

8044

</p>

8045

8046

8047

8048

8049

8050

</div>

8051

8052

8053

<p>Gets multiple attribute values.</p>

8054

</div>

8055

8056

8057

8058

<h4>Parameters:</h4>

8059

8060

8061

8062

8063

8064

<code class="param-name">attrs</code>

8065

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a> | boolean</span>

8066

8067

8068

8069

8070

8071

<p>Optional. An array of attribute names. If omitted, all attribute values are

8072

returned. If set to true, all attributes modified from their initial values are returned.</p>

8073

</div>

8074

8075

8076

</li>

8077

8078

</ul>

8079

</div>

8080

8081

8082

8083

8084

<h4>Returns:</h4>

8085

8086

8087

8088

8089

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:

8090

8091

An object with attribute name/value pairs.

8092

8093

</div>

8094

</div>

8095

8096

8097

8098

</div>

8099

8100

8101

8102

<h3 class="name"><code>getEvent</code></h3>

8103

8104

8105

8106

8107

8108

8109

8110

8111

8112

</li>

8113

8114

8115

8116

<code>prefixed</code>

8117

8118

</li>

8119

8120

</ul><span class="paren">)</span>

8121

</div>

8122

8123

8124

8125

8126

<span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>

8127

</span>

8128

8129

8130

8131

8132

8133

8134

8135

8136

8137

8138

8139

8140

8141

8142

8143

<p>Inherited from

8144

<a href="../classes/EventTarget.html#method_getEvent">EventTarget</a>:

8145

8146

8147

8148

<a href="../files/event-custom_js_event-target.js.html#l712"><code>event-custom/js/event-target.js:712</code></a>

8149

8150

</p>

8151

8152

8153

8154

8155

8156

</div>

8157

8158

8159

<p>Returns the custom event of the provided type has been created, a

8160

falsy value otherwise</p>

8161

</div>

8162

8163

8164

8165

<h4>Parameters:</h4>

8166

8167

8168

8169

8170

8171

8172

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

8173

8174

8175

8176

8177

8178

<p>the type, or name of the event</p>

8179

</div>

8180

8181

8182

</li>

8183

8184

8185

8186

<code class="param-name">prefixed</code>

8187

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

8188

8189

8190

8191

8192

8193

<p>if true, the type is prefixed already</p>

8194

</div>

8195

8196

8197

</li>

8198

8199

</ul>

8200

</div>

8201

8202

8203

8204

8205

<h4>Returns:</h4>

8206

8207

8208

8209

8210

<span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>:

8211

8212

the custom event or null

8213

8214

</div>

8215

</div>

8216

8217

8218

8219

</div>

8220

8221

8222

8223

<h3 class="name"><code>getRegion</code></h3>

8224

8225

8226

8227

8228

8229

8230

8231

8232

8233

</li>

8234

8235

</ul><span class="paren">)</span>

8236

</div>

8237

8238

8239

8240

8241

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

8242

</span>

8243

8244

8245

8246

8247

8248

8249

8250

8251

8252

8253

8254

8255

8256

8257

8258

8259

<p>

8260

8261

Defined in

8262

8263

8264

8265

8266

<a href="../files/dd_js_constrain.js.html#l314"><code>dd/js/constrain.js:314</code></a>

8267

8268

</p>

8269

8270

8271

8272

8273

8274

</div>

8275

8276

8277

<p>Get the active region: viewport, node, custom region</p>

8278

</div>

8279

8280

8281

8282

<h4>Parameters:</h4>

8283

8284

8285

8286

8287

8288

8289

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

8290

8291

8292

8293

8294

8295

<p>Include the node's height and width</p>

8296

</div>

8297

8298

8299

</li>

8300

8301

</ul>

8302

</div>

8303

8304

8305

8306

8307

<h4>Returns:</h4>

8308

8309

8310

8311

8312

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:

8313

8314

The active region.

8315

8316

</div>

8317

</div>

8318

8319

8320

8321

</div>

8322

8323

8324

8325

<h3 class="name"><code>getTargets</code></h3>

8326

8327

8328

8329

8330

8331

8332

8333

8334

</span>

8335

8336

8337

8338

8339

8340

8341

8342

8343

8344

8345

8346

8347

8348

8349

8350

<p>Inherited from

8351

<a href="../classes/EventTarget.html#method_getTargets">EventTarget</a>:

8352

8353

8354

8355

<a href="../files/event-custom_js_event-facade.js.html#l400"><code>event-custom/js/event-facade.js:400</code></a>

8356

8357

</p>

8358

8359

8360

8361

8362

8363

</div>

8364

8365

8366

<p>Returns an array of bubble targets for this object.</p>

8367

</div>

8368

8369

8370

8371

8372

8373

<h4>Returns:</h4>

8374

8375

8376

8377

8378

EventTarget[]

8379

8380

</div>

8381

</div>

8382

8383

8384

8385

</div>

8386

8387

8388

8389

8390

8391

8392

8393

8394

8395

8396

8397

<code>config</code>

8398

8399

</li>

8400

8401

</ul><span class="paren">)</span>

8402

</div>

8403

8404

8405

8406

8407

8408

</span>

8409

8410

8411

8412

8413

8414

8415

8416

8417

8418

8419

8420

<span class="flag chainable">chainable</span>

8421

8422

8423

8424

8425

<p>Inherited from

8426

8427

BaseCore

8428

</a>

8429

8430

but overwritten in

8431

8432

8433

8434

8435

8436

</p>

8437

8438

8439

8440

8441

8442

</div>

8443

8444

8445

<p>Init lifecycle method, invoked during construction.

8446

Fires the init event prior to setting up attributes and

8447

invoking initializers for the class hierarchy.</p>

8448

</div>

8449

8450

8451

8452

<h4>Parameters:</h4>

8453

8454

8455

8456

8457

8458

<code class="param-name">config</code>

8459

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

8460

8461

8462

8463

8464

8465

<p>Object with configuration property name/value pairs</p>

8466

</div>

8467

8468

8469

</li>

8470

8471

</ul>

8472

</div>

8473

8474

8475

8476

8477

<h4>Returns:</h4>

8478

8479

8480

8481

8482

<span class="type"><a href="../classes/Base.html" class="crosslink">Base</a></span>:

8483

8484

A reference to this object

8485

8486

</div>

8487

</div>

8488

8489

8490

8491

</div>

8492

8493

8494

8495

<h3 class="name"><code>inRegion</code></h3>

8496

8497

8498

8499

8500

8501

8502

8503

8504

8505

</li>

8506

8507

</ul><span class="paren">)</span>

8508

</div>

8509

8510

8511

8512

8513

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

8514

</span>

8515

8516

8517

8518

8519

8520

8521

8522

8523

8524

8525

8526

8527

8528

8529

8530

8531

<p>

8532

8533

Defined in

8534

8535

8536

8537

8538

<a href="../files/dd_js_constrain.js.html#l364"><code>dd/js/constrain.js:364</code></a>

8539

8540

</p>

8541

8542

8543

8544

8545

8546

</div>

8547

8548

8549

<p>Checks if the XY passed or the dragNode is inside the active region.</p>

8550

</div>

8551

8552

8553

8554

<h4>Parameters:</h4>

8555

8556

8557

8558

8559

8560

8561

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>

8562

8563

8564

8565

8566

8567

<p>Optional XY to check, if not supplied this.get('dragNode').getXY() is used.</p>

8568

</div>

8569

8570

8571

</li>

8572

8573

</ul>

8574

</div>

8575

8576

8577

8578

8579

<h4>Returns:</h4>

8580

8581

8582

8583

8584

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:

8585

8586

True if the XY is inside the region, false otherwise.

8587

8588

</div>

8589

</div>

8590

8591

8592

8593

</div>

8594

8595

8596

8597

<h3 class="name"><code>modifyAttr</code></h3>

8598

8599

8600

8601

8602

8603

8604

8605

8606

8607

</li>

8608

8609

8610

8611

<code>config</code>

8612

8613

</li>

8614

8615

</ul><span class="paren">)</span>

8616

</div>

8617

8618

8619

8620

8621

8622

8623

8624

8625

8626

8627

8628

8629

8630

8631

8632

8633

8634

<p>Inherited from

8635

<a href="../classes/AttributeExtras.html#method_modifyAttr">AttributeExtras</a>:

8636

8637

8638

8639

<a href="../files/attribute_js_AttributeExtras.js.html#l39"><code>attribute/js/AttributeExtras.js:39</code></a>

8640

8641

</p>

8642

8643

8644

8645

8646

8647

</div>

8648

8649

8650

<p>Updates the configuration of an attribute which has already been added.</p>

8651

8652

<p>

8653

The properties which can be modified through this interface are limited

8654

to the following subset of attributes, which can be safely modified

8655

after a value has already been set on the attribute: readOnly, writeOnce,

8656

broadcast and getter.

8657

</p>

8658

</div>

8659

8660

8661

8662

<h4>Parameters:</h4>

8663

8664

8665

8666

8667

8668

8669

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

8670

8671

8672

8673

8674

8675

<p>The name of the attribute whose configuration is to be updated.</p>

8676

</div>

8677

8678

8679

</li>

8680

8681

8682

8683

<code class="param-name">config</code>

8684

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

8685

8686

8687

8688

8689

8690

<p>An object with configuration property/value pairs, specifying the configuration properties to modify.</p>

8691

</div>

8692

8693

8694

</li>

8695

8696

</ul>

8697

</div>

8698

8699

8700

8701

8702

8703

</div>

8704

8705

8706

8707

8708

8709

8710

8711

8712

8713

8714

8715

8716

8717

</li>

8718

8719

8720

8721

8722

8723

</li>

8724

8725

8726

8727

<code class="optional">[context]</code>

8728

8729

</li>

8730

8731

8732

8733

8734

8735

</li>

8736

8737

</ul><span class="paren">)</span>

8738

</div>

8739

8740

8741

8742

8743

<span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>

8744

</span>

8745

8746

8747

8748

8749

8750

8751

8752

8753

8754

8755

8756

8757

8758

8759

8760

<p>Inherited from

8761

<a href="../classes/EventTarget.html#method_on">EventTarget</a>:

8762

8763

8764

8765

<a href="../files/event-custom_js_event-target.js.html#l192"><code>event-custom/js/event-target.js:192</code></a>

8766

8767

</p>

8768

8769

8770

8771

8772

8773

</div>

8774

8775

8776

<p>Subscribe a callback function to a custom event fired by this object or

8777

from an object that bubbles its events to this object.</p>

8778

8779

<p>Callback functions for events published with <code>emitFacade = true</code> will

8780

receive an <code>EventFacade</code> as the first argument (typically named "e").

8781

These callbacks can then call <code>e.preventDefault()</code> to disable the

8782

behavior published to that event's <code>defaultFn</code>. See the <code>EventFacade</code>

8783

API for all available properties and methods. Subscribers to

8784

non-<code>emitFacade</code> events will receive the arguments passed to <code>fire()</code>

8785

after the event name.</p>

8786

8787

<p>To subscribe to multiple events at once, pass an object as the first

8788

argument, where the key:value pairs correspond to the eventName:callback,

8789

or pass an array of event names as the first argument to subscribe to

8790

all listed events with the same callback.</p>

8791

8792

<p>Returning <code>false</code> from a callback is supported as an alternative to

8793

calling <code>e.preventDefault(); e.stopPropagation();</code>. However, it is

8794

recommended to use the event methods whenever possible.</p>

8795

</div>

8796

8797

8798

8799

<h4>Parameters:</h4>

8800

8801

8802

8803

8804

8805

8806

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

8807

8808

8809

8810

8811

8812

<p>The name of the event</p>

8813

</div>

8814

8815

8816

</li>

8817

8818

8819

8820

8821

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>

8822

8823

8824

8825

8826

8827

<p>The callback to execute in response to the event</p>

8828

</div>

8829

8830

8831

</li>

8832

8833

8834

8835

<code class="param-name optional">[context]</code>

8836

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

8837

<span class="flag optional" title="This parameter is optional.">optional</span>

8838

8839

8840

8841

8842

8843

<p>Override <code>this</code> object in callback</p>

8844

</div>

8845

8846

8847

</li>

8848

8849

8850

8851

8852

8853

<span class="flag optional" title="This parameter is optional.">optional</span>

8854

8855

8856

8857

8858

8859

<p>0..n additional arguments to supply to the subscriber</p>

8860

</div>

8861

8862

8863

</li>

8864

8865

</ul>

8866

</div>

8867

8868

8869

8870

8871

<h4>Returns:</h4>

8872

8873

8874

8875

8876

<span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>:

8877

8878

A subscription handle capable of detaching that

8879

subscription

8880

8881

</div>

8882

</div>

8883

8884

8885

8886

</div>

8887

8888

8889

8890

8891

8892

8893

8894

8895

8896

8897

8898

8899

8900

</li>

8901

8902

8903

8904

8905

8906

</li>

8907

8908

8909

8910

<code class="optional">[context]</code>

8911

8912

</li>

8913

8914

8915

8916

8917

8918

</li>

8919

8920

</ul><span class="paren">)</span>

8921

</div>

8922

8923

8924

8925

8926

<span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>

8927

</span>

8928

8929

8930

8931

8932

8933

8934

8935

8936

8937

8938

8939

8940

8941

8942

8943

<p>Inherited from

8944

<a href="../classes/EventTarget.html#method_once">EventTarget</a>:

8945

8946

8947

8948

<a href="../files/event-custom_js_event-target.js.html#l128"><code>event-custom/js/event-target.js:128</code></a>

8949

8950

</p>

8951

8952

8953

8954

8955

8956

</div>

8957

8958

8959

<p>Listen to a custom event hosted by this object one time.

8960

This is the equivalent to <code>on</code> except the

8961

listener is immediatelly detached when it is executed.</p>

8962

</div>

8963

8964

8965

8966

<h4>Parameters:</h4>

8967

8968

8969

8970

8971

8972

8973

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

8974

8975

8976

8977

8978

8979

<p>The name of the event</p>

8980

</div>

8981

8982

8983

</li>

8984

8985

8986

8987

8988

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>

8989

8990

8991

8992

8993

8994

<p>The callback to execute in response to the event</p>

8995

</div>

8996

8997

8998

</li>

8999

9000

9001

9002

<code class="param-name optional">[context]</code>

9003

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

9004

<span class="flag optional" title="This parameter is optional.">optional</span>

9005

9006

9007

9008

9009

9010

<p>Override <code>this</code> object in callback</p>

9011

</div>

9012

9013

9014

</li>

9015

9016

9017

9018

9019

9020

<span class="flag optional" title="This parameter is optional.">optional</span>

9021

9022

9023

9024

9025

9026

<p>0..n additional arguments to supply to the subscriber</p>

9027

</div>

9028

9029

9030

</li>

9031

9032

</ul>

9033

</div>

9034

9035

9036

9037

9038

<h4>Returns:</h4>

9039

9040

9041

9042

9043

<span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>:

9044

9045

A subscription handle capable of detaching the

9046

subscription

9047

9048

</div>

9049

</div>

9050

9051

9052

9053

</div>

9054

9055

9056

9057

<h3 class="name"><code>onceAfter</code></h3>

9058

9059

9060

9061

9062

9063

9064

9065

9066

9067

</li>

9068

9069

9070

9071

9072

9073

</li>

9074

9075

9076

9077

<code class="optional">[context]</code>

9078

9079

</li>

9080

9081

9082

9083

9084

9085

</li>

9086

9087

</ul><span class="paren">)</span>

9088

</div>

9089

9090

9091

9092

9093

<span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>

9094

</span>

9095

9096

9097

9098

9099

9100

9101

9102

9103

9104

9105

9106

9107

9108

9109

9110

<p>Inherited from

9111

<a href="../classes/EventTarget.html#method_onceAfter">EventTarget</a>:

9112

9113

9114

9115

<a href="../files/event-custom_js_event-target.js.html#l150"><code>event-custom/js/event-target.js:150</code></a>

9116

9117

</p>

9118

9119

9120

9121

9122

9123

</div>

9124

9125

9126

<p>Listen to a custom event hosted by this object one time.

9127

This is the equivalent to <code>after</code> except the

9128

listener is immediatelly detached when it is executed.</p>

9129

</div>

9130

9131

9132

9133

<h4>Parameters:</h4>

9134

9135

9136

9137

9138

9139

9140

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

9141

9142

9143

9144

9145

9146

<p>The name of the event</p>

9147

</div>

9148

9149

9150

</li>

9151

9152

9153

9154

9155

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>

9156

9157

9158

9159

9160

9161

<p>The callback to execute in response to the event</p>

9162

</div>

9163

9164

9165

</li>

9166

9167

9168

9169

<code class="param-name optional">[context]</code>

9170

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

9171

<span class="flag optional" title="This parameter is optional.">optional</span>

9172

9173

9174

9175

9176

9177

<p>Override <code>this</code> object in callback</p>

9178

</div>

9179

9180

9181

</li>

9182

9183

9184

9185

9186

9187

<span class="flag optional" title="This parameter is optional.">optional</span>

9188

9189

9190

9191

9192

9193

<p>0..n additional arguments to supply to the subscriber</p>

9194

</div>

9195

9196

9197

</li>

9198

9199

</ul>

9200

</div>

9201

9202

9203

9204

9205

<h4>Returns:</h4>

9206

9207

9208

9209

9210

<span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>:

9211

9212

A subscription handle capable of detaching that

9213

subscription

9214

9215

</div>

9216

</div>

9217

9218

9219

9220

</div>

9221

9222

9223

9224

<h3 class="name"><code>parseType</code></h3>

9225

9226

9227

9228

9229

9230

9231

9232

9233

9234

</li>

9235

9236

9237

9238

<code class="optional">[pre=this._yuievt.config.prefix]</code>

9239

9240

</li>

9241

9242

</ul><span class="paren">)</span>

9243

</div>

9244

9245

9246

9247

9248

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>

9249

</span>

9250

9251

9252

9253

9254

9255

9256

9257

9258

9259

9260

9261

9262

9263

9264

9265

<p>Inherited from

9266

<a href="../classes/EventTarget.html#method_parseType">EventTarget</a>:

9267

9268

9269

9270

<a href="../files/event-custom_js_event-target.js.html#l172"><code>event-custom/js/event-target.js:172</code></a>

9271

9272

</p>

9273

9274

9275

9276

9277

9278

<p>Available since 3.3.0</p>

9279

9280

</div>

9281

9282

9283

<p>Takes the type parameter passed to 'on' and parses out the

9284

various pieces that could be included in the type. If the

9285

event type is passed without a prefix, it will be expanded

9286

to include the prefix one is supplied or the event target

9287

is configured with a default prefix.</p>

9288

</div>

9289

9290

9291

9292

<h4>Parameters:</h4>

9293

9294

9295

9296

9297

9298

9299

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

9300

9301

9302

9303

9304

9305

9306

</div>

9307

9308

9309

</li>

9310

9311

9312

9313

<code class="param-name optional">[pre=this._yuievt.config.prefix]</code>

9314

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

9315

<span class="flag optional" title="This parameter is optional.">optional</span>

9316

9317

9318

9319

9320

9321

<p>the prefix</p>

9322

</div>

9323

9324

9325

</li>

9326

9327

</ul>

9328

</div>

9329

9330

9331

9332

9333

<h4>Returns:</h4>

9334

9335

9336

9337

9338

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>:

9339

9340

an array containing:

9341

* the detach category, if supplied,

9342

* the prefixed event type,

9343

* whether or not this is an after listener,

9344

* the supplied event type

9345

9346

</div>

9347

</div>

9348

9349

9350

9351

</div>

9352

9353

9354

9355

<h3 class="name"><code>publish</code></h3>

9356

9357

9358

9359

9360

9361

9362

9363

9364

9365

</li>

9366

9367

9368

9369

9370

9371

</li>

9372

9373

</ul><span class="paren">)</span>

9374

</div>

9375

9376

9377

9378

9379

<span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>

9380

</span>

9381

9382

9383

9384

9385

9386

9387

9388

9389

9390

9391

9392

9393

9394

9395

9396

<p>Inherited from

9397

<a href="../classes/EventTarget.html#method_publish">EventTarget</a>:

9398

9399

9400

9401

<a href="../files/event-custom_js_event-target.js.html#l489"><code>event-custom/js/event-target.js:489</code></a>

9402

9403

</p>

9404

9405

9406

9407

9408

9409

</div>

9410

9411

9412

<p>Creates a new custom event of the specified type. If a custom event

9413

by that name already exists, it will not be re-created. In either

9414

case the custom event is returned.</p>

9415

</div>

9416

9417

9418

9419

<h4>Parameters:</h4>

9420

9421

9422

9423

9424

9425

9426

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

9427

9428

9429

9430

9431

9432

<p>the type, or name of the event</p>

9433

</div>

9434

9435

9436

</li>

9437

9438

9439

9440

9441

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

9442

9443

9444

9445

9446

9447

<p>optional config params. Valid properties are:</p>

9448

9449

<p><ul>

9450

<li>

9451

'broadcast': whether or not the YUI instance and YUI global are notified when the event is fired (false)

9452

</li>

9453

<li>

9454

'bubbles': whether or not this event bubbles (true)

9455

Events can only bubble if emitFacade is true.

9456

</li>

9457

<li>

9458

'context': the default execution context for the listeners (this)

9459

</li>

9460

<li>

9461

'defaultFn': the default function to execute when this event fires if preventDefault was not called

9462

</li>

9463

<li>

9464

'emitFacade': whether or not this event emits a facade (false)

9465

</li>

9466

<li>

9467

'prefix': the prefix for this targets events, e.g., 'menu' in 'menu:click'

9468

</li>

9469

<li>

9470

'fireOnce': if an event is configured to fire once, new subscribers after

9471

the fire will be notified immediately.

9472

</li>

9473

<li>

9474

'async': fireOnce event listeners will fire synchronously if the event has already

9475

fired unless async is true.

9476

</li>

9477

<li>

9478

'preventable': whether or not preventDefault() has an effect (true)

9479

</li>

9480

<li>

9481

'preventedFn': a function that is executed when preventDefault is called

9482

</li>

9483

<li>

9484

'queuable': whether or not this event can be queued during bubbling (false)

9485

</li>

9486

<li>

9487

'silent': if silent is true, debug messages are not provided for this event.

9488

</li>

9489

<li>

9490

'stoppedFn': a function that is executed when stopPropagation is called

9491

</li></p>

9492

9493

<p><li>

9494

'monitored': specifies whether or not this event should send notifications about

9495

when the event has been attached, detached, or published.

9496

</li>

9497

<li>

9498

'type': the event type (valid option if not provided as the first parameter to publish)

9499

</li>

9500

</ul></p>

9501

</div>

9502

9503

9504

</li>

9505

9506

</ul>

9507

</div>

9508

9509

9510

9511

9512

<h4>Returns:</h4>

9513

9514

9515

9516

9517

<span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>:

9518

9519

the custom event

9520

9521

</div>

9522

</div>

9523

9524

9525

9526

</div>

9527

9528

9529

9530

<h3 class="name"><code>removeAttr</code></h3>

9531

9532

9533

9534

9535

9536

9537

9538

9539

9540

</li>

9541

9542

</ul><span class="paren">)</span>

9543

</div>

9544

9545

9546

9547

9548

9549

9550

9551

9552

9553

9554

9555

9556

9557

9558

9559

9560

9561

<p>Inherited from

9562

<a href="../classes/AttributeExtras.html#method_removeAttr">AttributeExtras</a>:

9563

9564

9565

9566

<a href="../files/attribute_js_AttributeExtras.js.html#l77"><code>attribute/js/AttributeExtras.js:77</code></a>

9567

9568

</p>

9569

9570

9571

9572

9573

9574

</div>

9575

9576

9577

<p>Removes an attribute from the host object</p>

9578

</div>

9579

9580

9581

9582

<h4>Parameters:</h4>

9583

9584

9585

9586

9587

9588

9589

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

9590

9591

9592

9593

9594

9595

<p>The name of the attribute to be removed.</p>

9596

</div>

9597

9598

9599

</li>

9600

9601

</ul>

9602

</div>

9603

9604

9605

9606

9607

9608

</div>

9609

9610

9611

9612

<h3 class="name"><code>removeTarget</code></h3>

9613

9614

9615

9616

9617

9618

9619

9620

9621

9622

</li>

9623

9624

</ul><span class="paren">)</span>

9625

</div>

9626

9627

9628

9629

9630

9631

9632

9633

9634

9635

9636

9637

9638

9639

9640

9641

9642

9643

<p>Inherited from

9644

<a href="../classes/EventTarget.html#method_removeTarget">EventTarget</a>:

9645

9646

9647

9648

<a href="../files/event-custom_js_event-facade.js.html#l409"><code>event-custom/js/event-facade.js:409</code></a>

9649

9650

</p>

9651

9652

9653

9654

9655

9656

</div>

9657

9658

9659

<p>Removes a bubble target</p>

9660

</div>

9661

9662

9663

9664

<h4>Parameters:</h4>

9665

9666

9667

9668

9669

9670

9671

<span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span>

9672

9673

9674

9675

9676

9677

<p>the target to remove</p>

9678

</div>

9679

9680

9681

</li>

9682

9683

</ul>

9684

</div>

9685

9686

9687

9688

9689

9690

</div>

9691

9692

9693

9694

<h3 class="name"><code>reset</code></h3>

9695

9696

9697

9698

9699

9700

9701

9702

9703

9704

</li>

9705

9706

</ul><span class="paren">)</span>

9707

</div>

9708

9709

9710

9711

9712

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

9713

</span>

9714

9715

9716

9717

9718

9719

9720

9721

9722

9723

9724

9725

<span class="flag chainable">chainable</span>

9726

9727

9728

9729

9730

9731

<p>Inherited from

9732

<a href="../classes/AttributeExtras.html#method_reset">AttributeExtras</a>:

9733

9734

9735

9736

<a href="../files/attribute_js_AttributeExtras.js.html#l87"><code>attribute/js/AttributeExtras.js:87</code></a>

9737

9738

</p>

9739

9740

9741

9742

9743

9744

</div>

9745

9746

9747

<p>Resets the attribute (or all attributes) to its initial value, as long as

9748

the attribute is not readOnly, or writeOnce.</p>

9749

</div>

9750

9751

9752

9753

<h4>Parameters:</h4>

9754

9755

9756

9757

9758

9759

9760

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

9761

9762

9763

9764

9765

9766

<p>Optional. The name of the attribute to reset. If omitted, all attributes are reset.</p>

9767

</div>

9768

9769

9770

</li>

9771

9772

</ul>

9773

</div>

9774

9775

9776

9777

9778

<h4>Returns:</h4>

9779

9780

9781

9782

9783

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:

9784

9785

A reference to the host object.

9786

9787

</div>

9788

</div>

9789

9790

9791

9792

</div>

9793

9794

9795

9796

<h3 class="name"><code>resetCache</code></h3>

9797

9798

9799

9800

9801

9802

9803

9804

9805

9806

9807

9808

9809

9810

9811

9812

9813

9814

9815

9816

9817

9818

<p>

9819

9820

Defined in

9821

9822

9823

9824

9825

<a href="../files/dd_js_constrain.js.html#l266"><code>dd/js/constrain.js:266</code></a>

9826

9827

</p>

9828

9829

9830

9831

9832

9833

</div>

9834

9835

9836

<p>Reset the internal region cache.</p>

9837

</div>

9838

9839

9840

9841

9842

9843

9844

</div>

9845

9846

9847

9848

9849

9850

9851

9852

9853

9854

9855

9856

9857

9858

</li>

9859

9860

9861

9862

<code>value</code>

9863

9864

</li>

9865

9866

</ul><span class="paren">)</span>

9867

</div>

9868

9869

9870

9871

9872

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

9873

</span>

9874

9875

9876

9877

9878

9879

9880

9881

9882

9883

9884

9885

<span class="flag chainable">chainable</span>

9886

9887

9888

9889

9890

<p>Inherited from

9891

9892

AttributeEvents

9893

</a>

9894

9895

but overwritten in

9896

9897

9898

9899

<a href="../files/attribute_js_AttributeCore.js.html#l328"><code>attribute/js/AttributeCore.js:328</code></a>

9900

9901

</p>

9902

9903

9904

9905

9906

9907

</div>

9908

9909

9910

<p>Sets the value of an attribute.</p>

9911

</div>

9912

9913

9914

9915

<h4>Parameters:</h4>

9916

9917

9918

9919

9920

9921

9922

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

9923

9924

9925

9926

9927

9928

<p>The name of the attribute. If the

9929

current value of the attribute is an Object, dot notation can be used

9930

to set the value of a property within the object (e.g. <code>set("x.y.z", 5)</code>).</p>

9931

</div>

9932

9933

9934

</li>

9935

9936

9937

9938

<code class="param-name">value</code>

9939

9940

9941

9942

9943

9944

9945

<p>The value to set the attribute to.</p>

9946

</div>

9947

9948

9949

</li>

9950

9951

</ul>

9952

</div>

9953

9954

9955

9956

9957

<h4>Returns:</h4>

9958

9959

9960

9961

9962

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:

9963

9964

A reference to the host object.

9965

9966

</div>

9967

</div>

9968

9969

9970

9971

</div>

9972

9973

9974

9975

<h3 class="name"><code>setAttrs</code></h3>

9976

9977

9978

9979

9980

9981

9982

9983

<code>attrs</code>

9984

9985

</li>

9986

9987

</ul><span class="paren">)</span>

9988

</div>

9989

9990

9991

9992

9993

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

9994

</span>

9995

9996

9997

9998

9999

10000

10001

10002

10003

10004

10005

10006

<span class="flag chainable">chainable</span>

10007

10008

10009

10010

10011

<p>Inherited from

10012

10013

AttributeEvents

10014

</a>

10015

10016

but overwritten in

10017

10018

10019

10020

<a href="../files/attribute_js_AttributeCore.js.html#l635"><code>attribute/js/AttributeCore.js:635</code></a>

10021

10022

</p>

10023

10024

10025

10026

10027

10028

</div>

10029

10030

10031

<p>Sets multiple attribute values.</p>

10032

</div>

10033

10034

10035

10036

<h4>Parameters:</h4>

10037

10038

10039

10040

10041

10042

<code class="param-name">attrs</code>

10043

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

10044

10045

10046

10047

10048

10049

<p>An object with attributes name/value pairs.</p>

10050

</div>

10051

10052

10053

</li>

10054

10055

</ul>

10056

</div>

10057

10058

10059

10060

10061

<h4>Returns:</h4>

10062

10063

10064

10065

10066

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:

10067

10068

A reference to the host object.

10069

10070

</div>

10071

</div>

10072

10073

10074

10075

</div>

10076

10077

10078

10079

<h3 class="name"><code>subscribe</code></h3>

10080

10081

10082

10083

10084

10085

10086

10087

10088

<span class="flag deprecated" title="use on">deprecated</span>

10089

10090

10091

10092

10093

10094

10095

10096

10097

10098

10099

10100

10101

10102

<p>Inherited from

10103

<a href="../classes/EventTarget.html#method_subscribe">EventTarget</a>:

10104

10105

10106

10107

<a href="../files/event-custom_js_event-target.js.html#l335"><code>event-custom/js/event-target.js:335</code></a>

10108

10109

</p>

10110

10111

10112

10113

<p>Deprecated: use on</p>

10114

10115

10116

10117

</div>

10118

10119

10120

<p>subscribe to an event</p>

10121

</div>

10122

10123

10124

10125

10126

10127

10128

</div>

10129

10130

10131

10132

<h3 class="name"><code>toString</code></h3>

10133

10134

10135

10136

10137

10138

10139

10140

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10141

</span>

10142

10143

10144

10145

10146

10147

10148

10149

10150

10151

10152

10153

10154

10155

10156

10157

<p>Inherited from

10158

<a href="../classes/BaseCore.html#method_toString">BaseCore</a>:

10159

10160

10161

10162

<a href="../files/base_js_BaseCore.js.html#l592"><code>base/js/BaseCore.js:592</code></a>

10163

10164

</p>

10165

10166

10167

10168

10169

10170

</div>

10171

10172

10173

<p>Default toString implementation. Provides the constructor NAME

10174

and the instance guid, if set.</p>

10175

</div>

10176

10177

10178

10179

10180

10181

<h4>Returns:</h4>

10182

10183

10184

10185

10186

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:

10187

10188

String representation for this object

10189

10190

</div>

10191

</div>

10192

10193

10194

10195

</div>

10196

10197

10198

10199

<h3 class="name"><code>unsubscribe</code></h3>

10200

10201

10202

10203

10204

10205

10206

10207

10208

<span class="flag deprecated" title="use detach">deprecated</span>

10209

10210

10211

10212

10213

10214

10215

10216

10217

10218

10219

10220

10221

10222

<p>Inherited from

10223

<a href="../classes/EventTarget.html#method_unsubscribe">EventTarget</a>:

10224

10225

10226

10227

<a href="../files/event-custom_js_event-target.js.html#l455"><code>event-custom/js/event-target.js:455</code></a>

10228

10229

</p>

10230

10231

10232

10233

<p>Deprecated: use detach</p>

10234

10235

10236

10237

</div>

10238

10239

10240

<p>detach a listener</p>

10241

</div>

10242

10243

10244

10245

10246

10247

10248

</div>

10249

10250

10251

10252

<h3 class="name"><code>unsubscribeAll</code></h3>

10253

10254

10255

10256

10257

10258

10259

10260

10261

10262

</li>

10263

10264

</ul><span class="paren">)</span>

10265

</div>

10266

10267

10268

10269

10270

10271

<span class="flag deprecated" title="use detachAll">deprecated</span>

10272

10273

10274

10275

10276

10277

10278

10279

10280

10281

10282

10283

10284

10285

<p>Inherited from

10286

<a href="../classes/EventTarget.html#method_unsubscribeAll">EventTarget</a>:

10287

10288

10289

10290

<a href="../files/event-custom_js_event-target.js.html#l476"><code>event-custom/js/event-target.js:476</code></a>

10291

10292

</p>

10293

10294

10295

10296

<p>Deprecated: use detachAll</p>

10297

10298

10299

10300

</div>

10301

10302

10303

<p>Removes all listeners from the specified event. If the event type

10304

is not specified, all listeners from all hosted custom events will

10305

be removed.</p>

10306

</div>

10307

10308

10309

10310

<h4>Parameters:</h4>

10311

10312

10313

10314

10315

10316

10317

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10318

10319

10320

10321

10322

10323

<p>The type, or name of the event</p>

10324

</div>

10325

10326

10327

</li>

10328

10329

</ul>

10330

</div>

10331

10332

10333

10334

10335

10336

</div>

10337

10338

10339

</div>

10340

10341

10342

10343

10344

<h2 class="off-left">Properties</h2>

10345

10346

10347

10348

<h3 class="name"><code>_allowAdHocAttrs</code></h3>

10349

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

10350

10351

10352

10353

10354

<span class="flag protected">protected</span>

10355

10356

10357

10358

10359

10360

10361

10362

10363

10364

<p>Inherited from

10365

<a href="../classes/BaseCore.html#property__allowAdHocAttrs">BaseCore</a>:

10366

10367

10368

10369

<a href="../files/base_js_BaseCore.js.html#l100"><code>base/js/BaseCore.js:100</code></a>

10370

10371

</p>

10372

10373

10374

10375

10376

</div>

10377

10378

10379

<p>This property controls whether or not instances of this class should

10380

allow users to add ad-hoc attributes through the constructor configuration

10381

hash.</p>

10382

10383

<p>AdHoc attributes are attributes which are not defined by the class, and are

10384

not handled by the MyClass.<em>NON</em>ATTRS_CFG</p>

10385

</div>

10386

10387

10388

<p><strong>Default:</strong> undefined (false)</p>

10389

10390

10391

10392

10393

10394

</div>

10395

10396

10397

10398

<h3 class="name"><code>_cacheHandle</code></h3>

10399

<span class="type"><a href="../classes/Event.html" class="crosslink">Event</a></span>

10400

10401

10402

10403

10404

<span class="flag private">private</span>

10405

10406

10407

10408

10409

10410

10411

10412

10413

10414

10415

<p>

10416

10417

Defined in

10418

10419

10420

10421

10422

<a href="../files/dd_js_constrain.js.html#l251"><code>dd/js/constrain.js:251</code></a>

10423

10424

</p>

10425

10426

10427

10428

10429

</div>

10430

10431

10432

<p>Event handle for window resize event.</p>

10433

</div>

10434

10435

10436

10437

10438

10439

10440

</div>

10441

10442

10443

10444

<h3 class="name"><code>_regionCache</code></h3>

10445

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

10446

10447

10448

10449

10450

<span class="flag private">private</span>

10451

10452

10453

10454

10455

10456

10457

10458

10459

10460

10461

<p>

10462

10463

Defined in

10464

10465

10466

10467

10468

<a href="../files/dd_js_constrain.js.html#l244"><code>dd/js/constrain.js:244</code></a>

10469

10470

</p>

10471

10472

10473

10474

10475

</div>

10476

10477

10478

<p>Store a cache of the region that we are constraining to</p>

10479

</div>

10480

10481

10482

10483

10484

10485

10486

</div>

10487

10488

10489

10490

10491

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10492

10493

10494

<span class="flag deprecated" title="Use this.constructor.NAME">deprecated</span>

10495

10496

10497

10498

10499

10500

10501

10502

10503

10504

10505

10506

<p>Inherited from

10507

<a href="../classes/BaseCore.html#property_name">BaseCore</a>:

10508

10509

10510

10511

<a href="../files/base_js_BaseCore.js.html#l196"><code>base/js/BaseCore.js:196</code></a>

10512

10513

</p>

10514

10515

10516

<p>Deprecated: Use this.constructor.NAME</p>

10517

10518

10519

10520

</div>

10521

10522

10523

<p>The string used to identify the class of this object.</p>

10524

</div>

10525

10526

10527

10528

10529

10530

10531

</div>

10532

10533

10534

10535

10536

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10537

10538

10539

10540

10541

<span class="flag protected">protected</span>

10542

10543

10544

10545

10546

10547

<span class="flag static">static</span>

10548

10549

10550

10551

10552

10553

10554

<p>

10555

10556

Defined in

10557

10558

10559

10560

10561

<a href="../files/dd_js_constrain.js.html#l52"><code>dd/js/constrain.js:52</code></a>

10562

10563

</p>

10564

10565

10566

10567

10568

</div>

10569

10570

10571

<p>The Constrained instance will be placed on the Drag instance under the con namespace.</p>

10572

</div>

10573

10574

10575

<p><strong>Default:</strong> con</p>

10576

10577

10578

10579

10580

10581

</div>

10582

10583

10584

</div>

10585

10586

10587

10588

10589

<h2 class="off-left">Attributes</h2>

10590

10591

10592

10593

10594

<h3 class="name"><code>cacheRegion</code></h3>

10595

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

10596

10597

10598

10599

10600

10601

10602

10603

10604

10605

10606

10607

10608

10609

<p>

10610

10611

Defined in

10612

10613

10614

10615

10616

<a href="../files/dd_js_constrain.js.html#l176"><code>dd/js/constrain.js:176</code></a>

10617

10618

</p>

10619

10620

10621

10622

10623

</div>

10624

10625

10626

<p>Should the region be cached for performace. Default: true</p>

10627

</div>

10628

10629

10630

10631

10632

10633

<h4>Fires event <code>cacheRegionChange</code></h4>

10634

10635

<p>

10636

Fires when the value for the configuration attribute <code>cacheRegion</code> is

10637

changed. You can listen for the event using the <code>on</code> method if you

10638

wish to be notified before the attribute's value has changed, or

10639

using the <code>after</code> method if you wish to be notified after the

10640

attribute's value has changed.

10641

</p>

10642

10643

10644

<h4>Parameters:</h4>

10645

10646

10647

10648

10649

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

10650

10651

10652

An Event Facade object with the following

10653

attribute-specific properties added:

10654

</div>

10655

10656

10657

10658

<code class="param-name">prevVal</code>

10659

10660

<div class="param-description">The value of the attribute, prior to it being set.</div>

10661

</li>

10662

10663

<code class="param-name">newVal</code>

10664

10665

<div class="param-description">The value the attribute is to be set to.</div>

10666

</li>

10667

10668

<code class="param-name">attrName</code>

10669

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10670

<div class="param-description">The name of the attribute being set.</div>

10671

</li>

10672

10673

<code class="param-name">subAttrName</code>

10674

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10675

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

10676

</li>

10677

</ul>

10678

</li>

10679

</ul>

10680

</div>

10681

</div>

10682

10683

10684

10685

</div>

10686

10687

10688

10689

10690

<h3 class="name"><code>constrain</code></h3>

10691

<span class="type">String/Object/Node</span>

10692

10693

10694

10695

10696

10697

10698

10699

10700

10701

10702

10703

10704

10705

<p>

10706

10707

Defined in

10708

10709

10710

10711

10712

<a href="../files/dd_js_constrain.js.html#l125"><code>dd/js/constrain.js:125</code></a>

10713

10714

</p>

10715

10716

10717

10718

10719

</div>

10720

10721

10722

<p>Will attempt to constrain the drag node to the boundaries. Arguments:

10723

'view': Contrain to Viewport

10724

'#selector_string': Constrain to this node

10725

'{Region Object}': An Object Literal containing a valid region (top, right, bottom, left) of page positions</p>

10726

</div>

10727

10728

10729

10730

10731

10732

<h4>Fires event <code>constrainChange</code></h4>

10733

10734

<p>

10735

Fires when the value for the configuration attribute <code>constrain</code> is

10736

changed. You can listen for the event using the <code>on</code> method if you

10737

wish to be notified before the attribute's value has changed, or

10738

using the <code>after</code> method if you wish to be notified after the

10739

attribute's value has changed.

10740

</p>

10741

10742

10743

<h4>Parameters:</h4>

10744

10745

10746

10747

10748

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

10749

10750

10751

An Event Facade object with the following

10752

attribute-specific properties added:

10753

</div>

10754

10755

10756

10757

<code class="param-name">prevVal</code>

10758

10759

<div class="param-description">The value of the attribute, prior to it being set.</div>

10760

</li>

10761

10762

<code class="param-name">newVal</code>

10763

10764

<div class="param-description">The value the attribute is to be set to.</div>

10765

</li>

10766

10767

<code class="param-name">attrName</code>

10768

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10769

<div class="param-description">The name of the attribute being set.</div>

10770

</li>

10771

10772

<code class="param-name">subAttrName</code>

10773

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10774

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

10775

</li>

10776

</ul>

10777

</li>

10778

</ul>

10779

</div>

10780

</div>

10781

10782

10783

10784

</div>

10785

10786

10787

10788

10789

<h3 class="name"><code>constrain2node</code></h3>

10790

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

10791

10792

10793

<span class="flag deprecated">deprecated</span>

10794

10795

10796

10797

10798

10799

10800

10801

10802

10803

10804

10805

10806

<p>

10807

10808

Defined in

10809

10810

10811

10812

10813

<a href="../files/dd_js_constrain.js.html#l154"><code>dd/js/constrain.js:154</code></a>

10814

10815

</p>

10816

10817

10818

10819

10820

</div>

10821

10822

10823

<p>Will attempt to constrain the drag node to the boundaries of this node.</p>

10824

</div>

10825

10826

10827

10828

10829

10830

<h4>Fires event <code>constrain2nodeChange</code></h4>

10831

10832

<p>

10833

Fires when the value for the configuration attribute <code>constrain2node</code> is

10834

changed. You can listen for the event using the <code>on</code> method if you

10835

wish to be notified before the attribute's value has changed, or

10836

using the <code>after</code> method if you wish to be notified after the

10837

attribute's value has changed.

10838

</p>

10839

10840

10841

<h4>Parameters:</h4>

10842

10843

10844

10845

10846

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

10847

10848

10849

An Event Facade object with the following

10850

attribute-specific properties added:

10851

</div>

10852

10853

10854

10855

<code class="param-name">prevVal</code>

10856

10857

<div class="param-description">The value of the attribute, prior to it being set.</div>

10858

</li>

10859

10860

<code class="param-name">newVal</code>

10861

10862

<div class="param-description">The value the attribute is to be set to.</div>

10863

</li>

10864

10865

<code class="param-name">attrName</code>

10866

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10867

<div class="param-description">The name of the attribute being set.</div>

10868

</li>

10869

10870

<code class="param-name">subAttrName</code>

10871

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10872

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

10873

</li>

10874

</ul>

10875

</li>

10876

</ul>

10877

</div>

10878

</div>

10879

10880

10881

10882

</div>

10883

10884

10885

10886

10887

<h3 class="name"><code>constrain2region</code></h3>

10888

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

10889

10890

10891

<span class="flag deprecated">deprecated</span>

10892

10893

10894

10895

10896

10897

10898

10899

10900

10901

10902

10903

10904

<p>

10905

10906

Defined in

10907

10908

10909

10910

10911

<a href="../files/dd_js_constrain.js.html#l143"><code>dd/js/constrain.js:143</code></a>

10912

10913

</p>

10914

10915

10916

10917

10918

</div>

10919

10920

10921

<p>An Object Literal containing a valid region (top, right, bottom, left) of page positions to constrain the drag node to.</p>

10922

</div>

10923

10924

10925

10926

10927

10928

<h4>Fires event <code>constrain2regionChange</code></h4>

10929

10930

<p>

10931

Fires when the value for the configuration attribute <code>constrain2region</code> is

10932

changed. You can listen for the event using the <code>on</code> method if you

10933

wish to be notified before the attribute's value has changed, or

10934

using the <code>after</code> method if you wish to be notified after the

10935

attribute's value has changed.

10936

</p>

10937

10938

10939

<h4>Parameters:</h4>

10940

10941

10942

10943

10944

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

10945

10946

10947

An Event Facade object with the following

10948

attribute-specific properties added:

10949

</div>

10950

10951

10952

10953

<code class="param-name">prevVal</code>

10954

10955

<div class="param-description">The value of the attribute, prior to it being set.</div>

10956

</li>

10957

10958

<code class="param-name">newVal</code>

10959

10960

<div class="param-description">The value the attribute is to be set to.</div>

10961

</li>

10962

10963

<code class="param-name">attrName</code>

10964

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10965

<div class="param-description">The name of the attribute being set.</div>

10966

</li>

10967

10968

<code class="param-name">subAttrName</code>

10969

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10970

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

10971

</li>

10972

</ul>

10973

</li>

10974

</ul>

10975

</div>

10976

</div>

10977

10978

10979

10980

</div>

10981

10982

10983

10984

10985

<h3 class="name"><code>constrain2view</code></h3>

10986

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

10987

10988

10989

<span class="flag deprecated">deprecated</span>

10990

10991

10992

10993

10994

10995

10996

10997

10998

10999

11000

11001

11002

<p>

11003

11004

Defined in

11005

11006

11007

11008

11009

<a href="../files/dd_js_constrain.js.html#l165"><code>dd/js/constrain.js:165</code></a>

11010

11011

</p>

11012

11013

11014

11015

11016

</div>

11017

11018

11019

<p>Will attempt to constrain the drag node to the boundaries of the viewport region.</p>

11020

</div>

11021

11022

11023

11024

11025

11026

<h4>Fires event <code>constrain2viewChange</code></h4>

11027

11028

<p>

11029

Fires when the value for the configuration attribute <code>constrain2view</code> is

11030

changed. You can listen for the event using the <code>on</code> method if you

11031

wish to be notified before the attribute's value has changed, or

11032

using the <code>after</code> method if you wish to be notified after the

11033

attribute's value has changed.

11034

</p>

11035

11036

11037

<h4>Parameters:</h4>

11038

11039

11040

11041

11042

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

11043

11044

11045

An Event Facade object with the following

11046

attribute-specific properties added:

11047

</div>

11048

11049

11050

11051

<code class="param-name">prevVal</code>

11052

11053

<div class="param-description">The value of the attribute, prior to it being set.</div>

11054

</li>

11055

11056

<code class="param-name">newVal</code>

11057

11058

<div class="param-description">The value the attribute is to be set to.</div>

11059

</li>

11060

11061

<code class="param-name">attrName</code>

11062

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11063

<div class="param-description">The name of the attribute being set.</div>

11064

</li>

11065

11066

<code class="param-name">subAttrName</code>

11067

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11068

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

11069

</li>

11070

</ul>

11071

</li>

11072

</ul>

11073

</div>

11074

</div>

11075

11076

11077

11078

</div>

11079

11080

11081

11082

11083

<h3 class="name"><code>destroyed</code></h3>

11084

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

11085

11086

11087

11088

11089

11090

11091

11092

11093

11094

11095

11096

11097

<p>Inherited from

11098

<a href="../classes/BaseCore.html#attr_destroyed">BaseCore</a>:

11099

11100

11101

11102

<a href="../files/base_js_BaseCore.js.html#l157"><code>base/js/BaseCore.js:157</code></a>

11103

11104

</p>

11105

11106

11107

11108

11109

</div>

11110

11111

11112

<p>Flag indicating whether or not this object

11113

has been through the destroy lifecycle phase.</p>

11114

</div>

11115

11116

11117

<p><strong>Default:</strong> false</p>

11118

11119

11120

11121

11122

<h4>Fires event <code>destroyedChange</code></h4>

11123

11124

<p>

11125

Fires when the value for the configuration attribute <code>destroyed</code> is

11126

changed. You can listen for the event using the <code>on</code> method if you

11127

wish to be notified before the attribute's value has changed, or

11128

using the <code>after</code> method if you wish to be notified after the

11129

attribute's value has changed.

11130

</p>

11131

11132

11133

<h4>Parameters:</h4>

11134

11135

11136

11137

11138

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

11139

11140

11141

An Event Facade object with the following

11142

attribute-specific properties added:

11143

</div>

11144

11145

11146

11147

<code class="param-name">prevVal</code>

11148

11149

<div class="param-description">The value of the attribute, prior to it being set.</div>

11150

</li>

11151

11152

<code class="param-name">newVal</code>

11153

11154

<div class="param-description">The value the attribute is to be set to.</div>

11155

</li>

11156

11157

<code class="param-name">attrName</code>

11158

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11159

<div class="param-description">The name of the attribute being set.</div>

11160

</li>

11161

11162

<code class="param-name">subAttrName</code>

11163

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11164

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

11165

</li>

11166

</ul>

11167

</li>

11168

</ul>

11169

</div>

11170

</div>

11171

11172

11173

11174

</div>

11175

11176

11177

11178

11179

<h3 class="name"><code>gutter</code></h3>

11180

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11181

11182

11183

11184

11185

11186

11187

11188

11189

11190

11191

11192

11193

11194

<p>

11195

11196

Defined in

11197

11198

11199

11200

11201

<a href="../files/dd_js_constrain.js.html#l114"><code>dd/js/constrain.js:114</code></a>

11202

11203

</p>

11204

11205

11206

11207

11208

</div>

11209

11210

11211

<p>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)</p>

11212

</div>

11213

11214

11215

11216

11217

11218

<h4>Fires event <code>gutterChange</code></h4>

11219

11220

<p>

11221

Fires when the value for the configuration attribute <code>gutter</code> is

11222

changed. You can listen for the event using the <code>on</code> method if you

11223

wish to be notified before the attribute's value has changed, or

11224

using the <code>after</code> method if you wish to be notified after the

11225

attribute's value has changed.

11226

</p>

11227

11228

11229

<h4>Parameters:</h4>

11230

11231

11232

11233

11234

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

11235

11236

11237

An Event Facade object with the following

11238

attribute-specific properties added:

11239

</div>

11240

11241

11242

11243

<code class="param-name">prevVal</code>

11244

11245

<div class="param-description">The value of the attribute, prior to it being set.</div>

11246

</li>

11247

11248

<code class="param-name">newVal</code>

11249

11250

<div class="param-description">The value the attribute is to be set to.</div>

11251

</li>

11252

11253

<code class="param-name">attrName</code>

11254

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11255

<div class="param-description">The name of the attribute being set.</div>

11256

</li>

11257

11258

<code class="param-name">subAttrName</code>

11259

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11260

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

11261

</li>

11262

</ul>

11263

</li>

11264

</ul>

11265

</div>

11266

</div>

11267

11268

11269

11270

</div>

11271

11272

11273

11274

11275

<h3 class="name"><code>initialized</code></h3>

11276

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

11277

11278

11279

11280

11281

11282

11283

11284

11285

11286

11287

11288

11289

<p>Inherited from

11290

<a href="../classes/BaseCore.html#attr_initialized">BaseCore</a>:

11291

11292

11293

11294

<a href="../files/base_js_BaseCore.js.html#l143"><code>base/js/BaseCore.js:143</code></a>

11295

11296

</p>

11297

11298

11299

11300

11301

</div>

11302

11303

11304

<p>Flag indicating whether or not this object

11305

has been through the init lifecycle phase.</p>

11306

</div>

11307

11308

11309

<p><strong>Default:</strong> false</p>

11310

11311

11312

11313

11314

<h4>Fires event <code>initializedChange</code></h4>

11315

11316

<p>

11317

Fires when the value for the configuration attribute <code>initialized</code> is

11318

changed. You can listen for the event using the <code>on</code> method if you

11319

wish to be notified before the attribute's value has changed, or

11320

using the <code>after</code> method if you wish to be notified after the

11321

attribute's value has changed.

11322

</p>

11323

11324

11325

<h4>Parameters:</h4>

11326

11327

11328

11329

11330

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

11331

11332

11333

An Event Facade object with the following

11334

attribute-specific properties added:

11335

</div>

11336

11337

11338

11339

<code class="param-name">prevVal</code>

11340

11341

<div class="param-description">The value of the attribute, prior to it being set.</div>

11342

</li>

11343

11344

<code class="param-name">newVal</code>

11345

11346

<div class="param-description">The value the attribute is to be set to.</div>

11347

</li>

11348

11349

<code class="param-name">attrName</code>

11350

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11351

<div class="param-description">The name of the attribute being set.</div>

11352

</li>

11353

11354

<code class="param-name">subAttrName</code>

11355

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11356

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

11357

</li>

11358

</ul>

11359

</li>

11360

</ul>

11361

</div>

11362

</div>

11363

11364

11365

11366

</div>

11367

11368

11369

11370

11371

<h3 class="name"><code>stickX</code></h3>

11372

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

11373

11374

11375

11376

11377

11378

11379

11380

11381

11382

11383

11384

11385

11386

<p>

11387

11388

Defined in

11389

11390

11391

11392

11393

<a href="../files/dd_js_constrain.js.html#l66"><code>dd/js/constrain.js:66</code></a>

11394

11395

</p>

11396

11397

11398

11399

11400

</div>

11401

11402

11403

<p>Stick the drag movement to the X-Axis. Default: false</p>

11404

</div>

11405

11406

11407

11408

11409

11410

<h4>Fires event <code>stickXChange</code></h4>

11411

11412

<p>

11413

Fires when the value for the configuration attribute <code>stickX</code> is

11414

changed. You can listen for the event using the <code>on</code> method if you

11415

wish to be notified before the attribute's value has changed, or

11416

using the <code>after</code> method if you wish to be notified after the

11417

attribute's value has changed.

11418

</p>

11419

11420

11421

<h4>Parameters:</h4>

11422

11423

11424

11425

11426

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

11427

11428

11429

An Event Facade object with the following

11430

attribute-specific properties added:

11431

</div>

11432

11433

11434

11435

<code class="param-name">prevVal</code>

11436

11437

<div class="param-description">The value of the attribute, prior to it being set.</div>

11438

</li>

11439

11440

<code class="param-name">newVal</code>

11441

11442

<div class="param-description">The value the attribute is to be set to.</div>

11443

</li>

11444

11445

<code class="param-name">attrName</code>

11446

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11447

<div class="param-description">The name of the attribute being set.</div>

11448

</li>

11449

11450

<code class="param-name">subAttrName</code>

11451

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11452

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

11453

</li>

11454

</ul>

11455

</li>

11456

</ul>

11457

</div>

11458

</div>

11459

11460

11461

11462

</div>

11463

11464

11465

11466

11467

<h3 class="name"><code>stickY</code></h3>

11468

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

11469

11470

11471

11472

11473

11474

11475

11476

11477

11478

11479

11480

11481

11482

<p>

11483

11484

Defined in

11485

11486

11487

11488

11489

<a href="../files/dd_js_constrain.js.html#l74"><code>dd/js/constrain.js:74</code></a>

11490

11491

</p>

11492

11493

11494

11495

11496

</div>

11497

11498

11499

<p>Stick the drag movement to the Y-Axis</p>

11500

</div>

11501

11502

11503

11504

11505

11506

<h4>Fires event <code>stickYChange</code></h4>

11507

11508

<p>

11509

Fires when the value for the configuration attribute <code>stickY</code> is

11510

changed. You can listen for the event using the <code>on</code> method if you

11511

wish to be notified before the attribute's value has changed, or

11512

using the <code>after</code> method if you wish to be notified after the

11513

attribute's value has changed.

11514

</p>

11515

11516

11517

<h4>Parameters:</h4>

11518

11519

11520

11521

11522

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

11523

11524

11525

An Event Facade object with the following

11526

attribute-specific properties added:

11527

</div>

11528

11529

11530

11531

<code class="param-name">prevVal</code>

11532

11533

<div class="param-description">The value of the attribute, prior to it being set.</div>

11534

</li>

11535

11536

<code class="param-name">newVal</code>

11537

11538

<div class="param-description">The value the attribute is to be set to.</div>

11539

</li>

11540

11541

<code class="param-name">attrName</code>

11542

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11543

<div class="param-description">The name of the attribute being set.</div>

11544

</li>

11545

11546

<code class="param-name">subAttrName</code>

11547

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11548

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

11549

</li>

11550

</ul>

11551

</li>

11552

</ul>

11553

</div>

11554

</div>

11555

11556

11557

11558

</div>

11559

11560

11561

11562

11563

<h3 class="name"><code>tickX</code></h3>

11564

<span class="type">Number/false</span>

11565

11566

11567

11568

11569

11570

11571

11572

11573

11574

11575

11576

11577

11578

<p>

11579

11580

Defined in

11581

11582

11583

11584

11585

<a href="../files/dd_js_constrain.js.html#l82"><code>dd/js/constrain.js:82</code></a>

11586

11587

</p>

11588

11589

11590

11591

11592

</div>

11593

11594

11595

<p>The X tick offset the drag node should snap to on each drag move. False for no ticks. Default: false</p>

11596

</div>

11597

11598

11599

11600

11601

11602

<h4>Fires event <code>tickXChange</code></h4>

11603

11604

<p>

11605

Fires when the value for the configuration attribute <code>tickX</code> is

11606

changed. You can listen for the event using the <code>on</code> method if you

11607

wish to be notified before the attribute's value has changed, or

11608

using the <code>after</code> method if you wish to be notified after the

11609

attribute's value has changed.

11610

</p>

11611

11612

11613

<h4>Parameters:</h4>

11614

11615

11616

11617

11618

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

11619

11620

11621

An Event Facade object with the following

11622

attribute-specific properties added:

11623

</div>

11624

11625

11626

11627

<code class="param-name">prevVal</code>

11628

11629

<div class="param-description">The value of the attribute, prior to it being set.</div>

11630

</li>

11631

11632

<code class="param-name">newVal</code>

11633

11634

<div class="param-description">The value the attribute is to be set to.</div>

11635

</li>

11636

11637

<code class="param-name">attrName</code>

11638

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11639

<div class="param-description">The name of the attribute being set.</div>

11640

</li>

11641

11642

<code class="param-name">subAttrName</code>

11643

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11644

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

11645

</li>

11646

</ul>

11647

</li>

11648

</ul>

11649

</div>

11650

</div>

11651

11652

11653

11654

</div>

11655

11656

11657

11658

11659

<h3 class="name"><code>tickXArray</code></h3>

11660

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>

11661

11662

11663

11664

11665

11666

11667

11668

11669

11670

11671

11672

11673

11674

<p>

11675

11676

Defined in

11677

11678

11679

11680

11681

<a href="../files/dd_js_constrain.js.html#l98"><code>dd/js/constrain.js:98</code></a>

11682

11683

</p>

11684

11685

11686

11687

11688

</div>

11689

11690

11691

<p>An array of page coordinates to use as X ticks for drag movement.</p>

11692

</div>

11693

11694

11695

11696

11697

11698

<h4>Fires event <code>tickXArrayChange</code></h4>

11699

11700

<p>

11701

Fires when the value for the configuration attribute <code>tickXArray</code> is

11702

changed. You can listen for the event using the <code>on</code> method if you

11703

wish to be notified before the attribute's value has changed, or

11704

using the <code>after</code> method if you wish to be notified after the

11705

attribute's value has changed.

11706

</p>

11707

11708

11709

<h4>Parameters:</h4>

11710

11711

11712

11713

11714

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

11715

11716

11717

An Event Facade object with the following

11718

attribute-specific properties added:

11719

</div>

11720

11721

11722

11723

<code class="param-name">prevVal</code>

11724

11725

<div class="param-description">The value of the attribute, prior to it being set.</div>

11726

</li>

11727

11728

<code class="param-name">newVal</code>

11729

11730

<div class="param-description">The value the attribute is to be set to.</div>

11731

</li>

11732

11733

<code class="param-name">attrName</code>

11734

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11735

<div class="param-description">The name of the attribute being set.</div>

11736

</li>

11737

11738

<code class="param-name">subAttrName</code>

11739

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11740

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

11741

</li>

11742

</ul>

11743

</li>

11744

</ul>

11745

</div>

11746

</div>

11747

11748

11749

11750

</div>

11751

11752

11753

11754

11755

<h3 class="name"><code>tickY</code></h3>

11756

<span class="type">Number/false</span>

11757

11758

11759

11760

11761

11762

11763

11764

11765

11766

11767

11768

11769

11770

<p>

11771

11772

Defined in

11773

11774

11775

11776

11777

<a href="../files/dd_js_constrain.js.html#l90"><code>dd/js/constrain.js:90</code></a>

11778

11779

</p>

11780

11781

11782

11783

11784

</div>

11785

11786

11787

<p>The Y tick offset the drag node should snap to on each drag move. False for no ticks. Default: false</p>

11788

</div>

11789

11790

11791

11792

11793

11794

<h4>Fires event <code>tickYChange</code></h4>

11795

11796

<p>

11797

Fires when the value for the configuration attribute <code>tickY</code> is

11798

changed. You can listen for the event using the <code>on</code> method if you

11799

wish to be notified before the attribute's value has changed, or

11800

using the <code>after</code> method if you wish to be notified after the

11801

attribute's value has changed.

11802

</p>

11803

11804

11805

<h4>Parameters:</h4>

11806

11807

11808

11809

11810

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

11811

11812

11813

An Event Facade object with the following

11814

attribute-specific properties added:

11815

</div>

11816

11817

11818

11819

<code class="param-name">prevVal</code>

11820

11821

<div class="param-description">The value of the attribute, prior to it being set.</div>

11822

</li>

11823

11824

<code class="param-name">newVal</code>

11825

11826

<div class="param-description">The value the attribute is to be set to.</div>

11827

</li>

11828

11829

<code class="param-name">attrName</code>

11830

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11831

<div class="param-description">The name of the attribute being set.</div>

11832

</li>

11833

11834

<code class="param-name">subAttrName</code>

11835

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11836

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

11837

</li>

11838

</ul>

11839

</li>

11840

</ul>

11841

</div>

11842

</div>

11843

11844

11845

11846

</div>

11847

11848

11849

11850

11851

<h3 class="name"><code>tickYArray</code></h3>

11852

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>

11853

11854

11855

11856

11857

11858

11859

11860

11861

11862

11863

11864

11865

11866

<p>

11867

11868

Defined in

11869

11870

11871

11872

11873

<a href="../files/dd_js_constrain.js.html#l106"><code>dd/js/constrain.js:106</code></a>

11874

11875

</p>

11876

11877

11878

11879

11880

</div>

11881

11882

11883

<p>An array of page coordinates to use as Y ticks for drag movement.</p>

11884

</div>

11885

11886

11887

11888

11889

11890

<h4>Fires event <code>tickYArrayChange</code></h4>

11891

11892

<p>

11893

Fires when the value for the configuration attribute <code>tickYArray</code> is

11894

changed. You can listen for the event using the <code>on</code> method if you

11895

wish to be notified before the attribute's value has changed, or

11896

using the <code>after</code> method if you wish to be notified after the

11897

attribute's value has changed.

11898

</p>

11899

11900

11901

<h4>Parameters:</h4>

11902

11903

11904

11905

11906

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

11907

11908

11909

An Event Facade object with the following

11910

attribute-specific properties added:

11911

</div>

11912

11913

11914

11915

<code class="param-name">prevVal</code>

11916

11917

<div class="param-description">The value of the attribute, prior to it being set.</div>

11918

</li>

11919

11920

<code class="param-name">newVal</code>

11921

11922

<div class="param-description">The value the attribute is to be set to.</div>

11923

</li>

11924

11925

<code class="param-name">attrName</code>

11926

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11927

<div class="param-description">The name of the attribute being set.</div>

11928

</li>

11929

11930

<code class="param-name">subAttrName</code>

11931

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11932

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

11933

</li>

11934

</ul>

11935

</li>

11936

</ul>

11937

</div>

11938

</div>

11939

11940

11941

11942

</div>

11943

11944

11945

</div>

11946

11947

11948

11949

11950

<h2 class="off-left">Events</h2>

11951

11952

11953

11954

<h3 class="name"><code>destroy</code></h3>

11955

11956

11957

11958

11959

11960

11961

11962

11963

11964

11965

11966

11967

11968

<p>Inherited from

11969

<a href="../classes/Base.html#event_destroy">Base</a>:

11970

11971

11972

11973

11974

11975

</p>

11976

11977

11978

11979

11980

</div>

11981

11982

11983

<p>

11984

Lifecycle event for the destroy phase,

11985

fired prior to destruction. Invoking the preventDefault

11986

method on the event object provided to subscribers will

11987

prevent destruction from proceeding.

11988

</p>

11989

11990

<p>

11991

Subscribers to the "after" moment of this event, will be notified

11992

after destruction is complete (and as a result cannot prevent

11993

destruction).

11994

</p>

11995

</div>

11996

11997

11998

11999

<h4>Event Payload:</h4>

12000

12001

12002

12003

12004

12005

12006

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

12007

12008

12009

12010

12011

12012

<p>Event object</p>

12013

</div>

12014

12015

12016

</li>

12017

12018

</ul>

12019

</div>

12020

12021

12022

12023

12024

</div>

12025

12026

12027

12028

<h3 class="name"><code>drag:tickAlignX</code></h3>

12029

<span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>

12030

12031

12032

12033

12034

12035

12036

12037

12038

12039

12040

12041

12042

12043

<p>

12044

12045

Defined in

12046

12047

12048

12049

12050

<a href="../files/dd_js_constrain.js.html#l30"><code>dd/js/constrain.js:30</code></a>

12051

12052

</p>

12053

12054

12055

12056

12057

</div>

12058

12059

12060

<p>Fires when this node is aligned with the tickX value.</p>

12061

</div>

12062

12063

12064

12065

<h4>Event Payload:</h4>

12066

12067

12068

12069

12070

12071

<code class="param-name">event</code>

12072

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

12073

12074

12075

12076

12077

12078

<p>An Event Facade object</p>

12079

</div>

12080

12081

12082

</li>

12083

12084

</ul>

12085

</div>

12086

12087

12088

12089

12090

</div>

12091

12092

12093

12094

<h3 class="name"><code>drag:tickAlignY</code></h3>

12095

<span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>

12096

12097

12098

12099

12100

12101

12102

12103

12104

12105

12106

12107

12108

12109

<p>

12110

12111

Defined in

12112

12113

12114

12115

12116

<a href="../files/dd_js_constrain.js.html#l38"><code>dd/js/constrain.js:38</code></a>

12117

12118

</p>

12119

12120

12121

12122

12123

</div>

12124

12125

12126

<p>Fires when this node is aligned with the tickY value.</p>

12127

</div>

12128

12129

12130

12131

<h4>Event Payload:</h4>

12132

12133

12134

12135

12136

12137

<code class="param-name">event</code>

12138

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

12139

12140

12141

12142

12143

12144

<p>An Event Facade object</p>

12145

</div>

12146

12147

12148

</li>

12149

12150

</ul>

12151

</div>

12152

12153

12154

12155

12156

</div>

12157

12158

12159

12160

12161

12162

12163

12164

12165

12166

12167

12168

12169

12170

12171

12172

12173

12174

<p>Inherited from

12175

<a href="../classes/Base.html#event_init">Base</a>:

12176

12177

12178

12179

12180

12181

</p>

12182

12183

12184

12185

12186

</div>

12187

12188

12189

<p>

12190

Lifecycle event for the init phase, fired prior to initialization.

12191

Invoking the preventDefault() method on the event object provided

12192

to subscribers will prevent initialization from occuring.

12193

</p>

12194

12195

<p>

12196

Subscribers to the "after" momemt of this event, will be notified

12197

after initialization of the object is complete (and therefore

12198

cannot prevent initialization).

12199

</p>

12200

</div>

12201

12202

12203

12204

<h4>Event Payload:</h4>

12205

12206

12207

12208

12209

12210

12211

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

12212

12213

12214

12215

12216

12217

<p>Event object, with a cfg property which

12218

refers to the configuration object passed to the constructor.</p>

12219

</div>

12220

12221

12222

</li>

12223

12224

</ul>

12225

</div>

12226

12227

12228

12229

12230

</div>

12231

12232

12233

</div>

12234

12235

</div>

12236

</div>

12237

12238

</div>

12239

</div>

12240

</div>

12241

</div>

12242

</div>

12243

</div>

12244

12245

12246

12247

12248

12249

12250

12251

12252

</body>

12253

</html>

Older »