~bcsaller/juju-gui/update-reductions

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

1568

1569

1570

1571

1572

1573

<p>Maximum number</p>

1574

</div>

1575

1576

1577

</li>

1578

1579

1580

1581

1582

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

1583

1584

1585

1586

1587

1588

<p>Minimum number</p>

1589

</div>

1590

1591

1592

</li>

1593

1594

1595

1596

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

1597

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

1598

1599

1600

1601

1602

1603

<p>Number of units on the axis</p>

1604

</div>

1605

1606

1607

</li>

1608

1609

</ul>

1610

</div>

1611

1612

1613

1614

1615

<h4>Returns:</h4>

1616

1617

1618

1619

1620

Number

1621

1622

</div>

1623

</div>

1624

1625

1626

1627

</div>

1628

1629

1630

1631

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

1632

1633

1634

1635

1636

1637

1638

1639

<code>roundingUnit</code>

1640

1641

</li>

1642

1643

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

1644

</div>

1645

1646

1647

1648

1649

1650

</span>

1651

1652

1653

1654

1655

1656

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

1657

1658

1659

1660

1661

1662

1663

1664

1665

1666

1667

1668

1669

<p>

1670

1671

Defined in

1672

1673

1674

1675

1676

<a href="../files/charts_js_NumericAxis.js.html#l138"><code>charts/js/NumericAxis.js:138</code></a>

1677

1678

</p>

1679

1680

1681

1682

1683

1684

</div>

1685

1686

1687

<p>Calculates a nice rounding unit based on the range.</p>

1688

</div>

1689

1690

1691

1692

<h4>Parameters:</h4>

1693

1694

1695

1696

1697

1698

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

1699

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

1700

1701

1702

1703

1704

1705

<p>The calculated rounding unit.</p>

1706

</div>

1707

1708

1709

</li>

1710

1711

</ul>

1712

</div>

1713

1714

1715

1716

1717

<h4>Returns:</h4>

1718

1719

1720

1721

1722

Number

1723

1724

</div>

1725

</div>

1726

1727

1728

1729

</div>

1730

1731

1732

1733

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

1734

1735

1736

1737

1738

1739

1740

1741

1742

</span>

1743

1744

1745

1746

1747

1748

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

1749

1750

1751

1752

1753

1754

1755

1756

1757

1758

1759

1760

1761

<p>

1762

1763

Defined in

1764

1765

1766

1767

1768

<a href="../files/charts_js_NumericAxis.js.html#l653"><code>charts/js/NumericAxis.js:653</code></a>

1769

1770

</p>

1771

1772

1773

1774

1775

1776

</div>

1777

1778

1779

<p>Checks to see if data extends beyond the range of the axis. If so,

1780

that data will need to be hidden. This method is internal, temporary and subject

1781

to removal in the future.</p>

1782

</div>

1783

1784

1785

1786

1787

1788

<h4>Returns:</h4>

1789

1790

1791

1792

1793

Boolean

1794

1795

</div>

1796

</div>

1797

1798

1799

1800

</div>

1801

1802

1803

1804

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

1805

1806

1807

1808

1809

1810

1811

1812

<code>number</code>

1813

1814

</li>

1815

1816

1817

1818

<code>nearest</code>

1819

1820

</li>

1821

1822

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

1823

</div>

1824

1825

1826

1827

1828

1829

</span>

1830

1831

1832

1833

1834

1835

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

1836

1837

1838

1839

1840

1841

1842

1843

1844

1845

1846

1847

1848

<p>

1849

1850

Defined in

1851

1852

1853

1854

1855

<a href="../files/charts_js_NumericAxis.js.html#l616"><code>charts/js/NumericAxis.js:616</code></a>

1856

1857

</p>

1858

1859

1860

1861

1862

1863

</div>

1864

1865

1866

<p>Rounds a Number down to the nearest multiple of an input. For example, by rounding

1867

16 down to the nearest 10, you will receive 10. Similar to the built-in function Math.floor().</p>

1868

</div>

1869

1870

1871

1872

<h4>Parameters:</h4>

1873

1874

1875

1876

1877

1878

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

1879

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

1880

1881

1882

1883

1884

1885

<p>Number to round</p>

1886

</div>

1887

1888

1889

</li>

1890

1891

1892

1893

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

1894

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

1895

1896

1897

1898

1899

1900

<p>Multiple to round towards.</p>

1901

</div>

1902

1903

1904

</li>

1905

1906

</ul>

1907

</div>

1908

1909

1910

1911

1912

<h4>Returns:</h4>

1913

1914

1915

1916

1917

Number

1918

1919

</div>

1920

</div>

1921

1922

1923

1924

</div>

1925

1926

1927

1928

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

1929

1930

1931

1932

1933

1934

1935

1936

1937

1938

</li>

1939

1940

1941

1942

1943

1944

</li>

1945

1946

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

1947

</div>

1948

1949

1950

1951

1952

1953

1954

1955

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

1956

1957

1958

1959

1960

1961

1962

1963

1964

1965

1966

1967

1968

<p>

1969

1970

Defined in

1971

1972

1973

1974

1975

<a href="../files/charts_js_NumericAxis.js.html#l248"><code>charts/js/NumericAxis.js:248</code></a>

1976

1977

</p>

1978

1979

1980

1981

1982

1983

</div>

1984

1985

1986

<p>Rounds the mimimum and maximum values based on the <code>roundingUnit</code> attribute.</p>

1987

</div>

1988

1989

1990

1991

<h4>Parameters:</h4>

1992

1993

1994

1995

1996

1997

1998

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

1999

2000

2001

2002

2003

2004

<p>Minimum value</p>

2005

</div>

2006

2007

2008

</li>

2009

2010

2011

2012

2013

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

2014

2015

2016

2017

2018

2019

<p>Maximum value</p>

2020

</div>

2021

2022

2023

</li>

2024

2025

</ul>

2026

</div>

2027

2028

2029

2030

2031

2032

</div>

2033

2034

2035

2036

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

2037

2038

2039

2040

2041

2042

2043

2044

<code>number</code>

2045

2046

</li>

2047

2048

2049

2050

<code>nearest</code>

2051

2052

</li>

2053

2054

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

2055

</div>

2056

2057

2058

2059

2060

2061

</span>

2062

2063

2064

2065

2066

2067

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

2068

2069

2070

2071

2072

2073

2074

2075

2076

2077

2078

2079

2080

<p>

2081

2082

Defined in

2083

2084

2085

2086

2087

<a href="../files/charts_js_NumericAxis.js.html#l575"><code>charts/js/NumericAxis.js:575</code></a>

2088

2089

</p>

2090

2091

2092

2093

2094

2095

</div>

2096

2097

2098

<p>Rounds a Number to the nearest multiple of an input. For example, by rounding

2099

16 to the nearest 10, you will receive 20. Similar to the built-in function Math.round().</p>

2100

</div>

2101

2102

2103

2104

<h4>Parameters:</h4>

2105

2106

2107

2108

2109

2110

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

2111

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

2112

2113

2114

2115

2116

2117

<p>Number to round</p>

2118

</div>

2119

2120

2121

</li>

2122

2123

2124

2125

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

2126

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

2127

2128

2129

2130

2131

2132

<p>Multiple to round towards.</p>

2133

</div>

2134

2135

2136

</li>

2137

2138

</ul>

2139

</div>

2140

2141

2142

2143

2144

<h4>Returns:</h4>

2145

2146

2147

2148

2149

Number

2150

2151

</div>

2152

</div>

2153

2154

2155

2156

</div>

2157

2158

2159

2160

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

2161

2162

2163

2164

2165

2166

2167

2168

<code>number</code>

2169

2170

</li>

2171

2172

2173

2174

<code>precision</code>

2175

2176

</li>

2177

2178

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

2179

</div>

2180

2181

2182

2183

2184

2185

</span>

2186

2187

2188

2189

2190

2191

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

2192

2193

2194

2195

2196

2197

2198

2199

2200

2201

2202

2203

2204

<p>

2205

2206

Defined in

2207

2208

2209

2210

2211

<a href="../files/charts_js_NumericAxis.js.html#l636"><code>charts/js/NumericAxis.js:636</code></a>

2212

2213

</p>

2214

2215

2216

2217

2218

2219

</div>

2220

2221

2222

<p>Rounds a number to a certain level of precision. Useful for limiting the number of

2223

decimal places on a fractional number.</p>

2224

</div>

2225

2226

2227

2228

<h4>Parameters:</h4>

2229

2230

2231

2232

2233

2234

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

2235

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

2236

2237

2238

2239

2240

2241

<p>Number to round</p>

2242

</div>

2243

2244

2245

</li>

2246

2247

2248

2249

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

2250

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

2251

2252

2253

2254

2255

2256

<p>Multiple to round towards.</p>

2257

</div>

2258

2259

2260

</li>

2261

2262

</ul>

2263

</div>

2264

2265

2266

2267

2268

<h4>Returns:</h4>

2269

2270

2271

2272

2273

Number

2274

2275

</div>

2276

</div>

2277

2278

2279

2280

</div>

2281

2282

2283

2284

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

2285

2286

2287

2288

2289

2290

2291

2292

<code>number</code>

2293

2294

</li>

2295

2296

2297

2298

<code>nearest</code>

2299

2300

</li>

2301

2302

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

2303

</div>

2304

2305

2306

2307

2308

2309

</span>

2310

2311

2312

2313

2314

2315

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

2316

2317

2318

2319

2320

2321

2322

2323

2324

2325

2326

2327

2328

<p>

2329

2330

Defined in

2331

2332

2333

2334

2335

<a href="../files/charts_js_NumericAxis.js.html#l596"><code>charts/js/NumericAxis.js:596</code></a>

2336

2337

</p>

2338

2339

2340

2341

2342

2343

</div>

2344

2345

2346

<p>Rounds a Number up to the nearest multiple of an input. For example, by rounding

2347

16 up to the nearest 10, you will receive 20. Similar to the built-in function Math.ceil().</p>

2348

</div>

2349

2350

2351

2352

<h4>Parameters:</h4>

2353

2354

2355

2356

2357

2358

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

2359

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

2360

2361

2362

2363

2364

2365

<p>Number to round</p>

2366

</div>

2367

2368

2369

</li>

2370

2371

2372

2373

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

2374

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

2375

2376

2377

2378

2379

2380

<p>Multiple to round towards.</p>

2381

</div>

2382

2383

2384

</li>

2385

2386

</ul>

2387

</div>

2388

2389

2390

2391

2392

<h4>Returns:</h4>

2393

2394

2395

2396

2397

Number

2398

2399

</div>

2400

</div>

2401

2402

2403

2404

</div>

2405

2406

2407

2408

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

2409

2410

2411

2412

2413

2414

2415

2416

2417

2418

2419

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

2420

2421

2422

2423

2424

2425

2426

2427

2428

2429

2430

2431

2432

<p>

2433

2434

Defined in

2435

2436

2437

2438

2439

<a href="../files/charts_js_NumericAxis.js.html#l170"><code>charts/js/NumericAxis.js:170</code></a>

2440

2441

</p>

2442

2443

2444

2445

2446

2447

</div>

2448

2449

2450

<p>Calculates the maximum and minimum values for the <code>Axis</code>.</p>

2451

</div>

2452

2453

2454

2455

2456

2457

2458

</div>

2459

2460

2461

2462

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

2463

2464

2465

2466

2467

2468

2469

2470

<code>value</code>

2471

2472

</li>

2473

2474

2475

2476

<code>format</code>

2477

2478

</li>

2479

2480

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

2481

</div>

2482

2483

2484

2485

2486

2487

</span>

2488

2489

2490

2491

2492

2493

2494

2495

2496

2497

2498

2499

2500

2501

2502

2503

2504

<p>

2505

2506

Defined in

2507

2508

2509

2510

2511

<a href="../files/charts_js_NumericAxis.js.html#l72"><code>charts/js/NumericAxis.js:72</code></a>

2512

2513

</p>

2514

2515

2516

2517

2518

2519

</div>

2520

2521

2522

<p>Formats a label based on the axis type and optionally specified format.</p>

2523

</div>

2524

2525

2526

2527

<h4>Parameters:</h4>

2528

2529

2530

2531

2532

2533

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

2534

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

2535

2536

2537

2538

2539

2540

2541

</div>

2542

2543

2544

</li>

2545

2546

2547

2548

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

2549

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

2550

2551

2552

2553

2554

2555

<p>Pattern used to format the value.</p>

2556

</div>

2557

2558

2559

</li>

2560

2561

</ul>

2562

</div>

2563

2564

2565

2566

2567

<h4>Returns:</h4>

2568

2569

2570

2571

2572

String

2573

2574

</div>

2575

</div>

2576

2577

2578

2579

</div>

2580

2581

2582

2583

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

2584

2585

2586

2587

2588

2589

2590

2591

2592

2593

</li>

2594

2595

2596

2597

2598

2599

</li>

2600

2601

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

2602

</div>

2603

2604

2605

2606

2607

2608

</span>

2609

2610

2611

2612

2613

2614

2615

2616

2617

2618

2619

2620

2621

2622

2623

2624

2625

<p>

2626

2627

Defined in

2628

2629

2630

2631

2632

<a href="../files/charts_js_NumericAxis.js.html#l537"><code>charts/js/NumericAxis.js:537</code></a>

2633

2634

</p>

2635

2636

2637

2638

2639

2640

</div>

2641

2642

2643

<p>Calculates and returns a value based on the number of labels and the index of

2644

the current label.</p>

2645

</div>

2646

2647

2648

2649

<h4>Parameters:</h4>

2650

2651

2652

2653

2654

2655

2656

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

2657

2658

2659

2660

2661

2662

<p>Index of the label.</p>

2663

</div>

2664

2665

2666

</li>

2667

2668

2669

2670

2671

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

2672

2673

2674

2675

2676

2677

<p>Total number of labels.</p>

2678

</div>

2679

2680

2681

</li>

2682

2683

</ul>

2684

</div>

2685

2686

2687

2688

2689

<h4>Returns:</h4>

2690

2691

2692

2693

2694

String

2695

2696

</div>

2697

</div>

2698

2699

2700

2701

</div>

2702

2703

2704

2705

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

2706

2707

2708

2709

2710

2711

2712

2713

2714

2715

</li>

2716

2717

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

2718

</div>

2719

2720

2721

2722

2723

2724

</span>

2725

2726

2727

2728

2729

2730

2731

2732

2733

2734

2735

2736

2737

2738

2739

2740

2741

<p>

2742

2743

Defined in

2744

2745

2746

2747

2748

<a href="../files/charts_js_NumericAxis.js.html#l89"><code>charts/js/NumericAxis.js:89</code></a>

2749

2750

</p>

2751

2752

2753

2754

2755

2756

</div>

2757

2758

2759

<p>Returns the sum of all values per key.</p>

2760

</div>

2761

2762

2763

2764

<h4>Parameters:</h4>

2765

2766

2767

2768

2769

2770

2771

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

2772

2773

2774

2775

2776

2777

<p>The identifier for the array whose values will be calculated.</p>

2778

</div>

2779

2780

2781

</li>

2782

2783

</ul>

2784

</div>

2785

2786

2787

2788

2789

<h4>Returns:</h4>

2790

2791

2792

2793

2794

Number

2795

2796

</div>

2797

</div>

2798

2799

2800

2801

</div>

2802

2803

2804

</div>

2805

2806

2807

2808

2809

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

2810

2811

2812

2813

2814

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

2815

2816

2817

2818

2819

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

2820

2821

2822

2823

2824

2825

2826

2827

2828

2829

2830

<p>

2831

2832

Defined in

2833

2834

2835

2836

2837

<a href="../files/charts_js_NumericAxis.js.html#l114"><code>charts/js/NumericAxis.js:114</code></a>

2838

2839

</p>

2840

2841

2842

2843

2844

</div>

2845

2846

2847

2848

</div>

2849

2850

2851

2852

2853

2854

2855

</div>

2856

2857

2858

</div>

2859

2860

2861

2862

2863

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

2864

2865

2866

2867

2868

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

2869

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

2870

2871

2872

2873

2874

2875

2876

2877

2878

2879

2880

2881

2882

2883

<p>

2884

2885

Defined in

2886

2887

2888

2889

2890

<a href="../files/charts_js_NumericAxis.js.html#l18"><code>charts/js/NumericAxis.js:18</code></a>

2891

2892

</p>

2893

2894

2895

2896

2897

</div>

2898

2899

2900

<p>Indicates whether 0 should always be displayed.</p>

2901

</div>

2902

2903

2904

2905

2906

2907

<h4>Fires event <code>alwaysShowZeroChange</code></h4>

2908

2909

<p>

2910

Fires when the value for the configuration attribute <code>alwaysShowZero</code> is

2911

changed. You can listen for the event using the <code>on</code> method if you

2912

wish to be notified before the attribute's value has changed, or

2913

using the <code>after</code> method if you wish to be notified after the

2914

attribute's value has changed.

2915

</p>

2916

2917

2918

<h4>Parameters:</h4>

2919

2920

2921

2922

2923

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

2924

2925

2926

An Event Facade object with the following

2927

attribute-specific properties added:

2928

</div>

2929

2930

2931

2932

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

2933

2934

<div class="param-description">The value of the attribute, prior to it being set.</div>

2935

</li>

2936

2937

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

2938

2939

<div class="param-description">The value the attribute is to be set to.</div>

2940

</li>

2941

2942

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

2943

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

2944

<div class="param-description">The name of the attribute being set.</div>

2945

</li>

2946

2947

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

2948

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

2949

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

2950

</li>

2951

</ul>

2952

</li>

2953

</ul>

2954

</div>

2955

</div>

2956

2957

2958

2959

</div>

2960

2961

2962

2963

2964

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

2965

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

2966

2967

2968

2969

2970

2971

2972

2973

2974

2975

2976

2977

2978

2979

<p>

2980

2981

Defined in

2982

2983

2984

2985

2986

<a href="../files/charts_js_NumericAxis.js.html#l52"><code>charts/js/NumericAxis.js:52</code></a>

2987

2988

</p>

2989

2990

2991

2992

2993

</div>

2994

2995

2996

<p>Object containing properties used by the <code>labelFunction</code> to format a

2997

label.</p>

2998

</div>

2999

3000

3001

3002

3003

3004

<h4>Fires event <code>labelFormatChange</code></h4>

3005

3006

<p>

3007

Fires when the value for the configuration attribute <code>labelFormat</code> is

3008

changed. You can listen for the event using the <code>on</code> method if you

3009

wish to be notified before the attribute's value has changed, or

3010

using the <code>after</code> method if you wish to be notified after the

3011

attribute's value has changed.

3012

</p>

3013

3014

3015

<h4>Parameters:</h4>

3016

3017

3018

3019

3020

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

3021

3022

3023

An Event Facade object with the following

3024

attribute-specific properties added:

3025

</div>

3026

3027

3028

3029

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

3030

3031

<div class="param-description">The value of the attribute, prior to it being set.</div>

3032

</li>

3033

3034

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

3035

3036

<div class="param-description">The value the attribute is to be set to.</div>

3037

</li>

3038

3039

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

3040

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

3041

<div class="param-description">The name of the attribute being set.</div>

3042

</li>

3043

3044

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

3045

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

3046

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

3047

</li>

3048

</ul>

3049

</li>

3050

</ul>

3051

</div>

3052

</div>

3053

3054

3055

3056

</div>

3057

3058

3059

3060

3061

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

3062

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

3063

3064

3065

3066

3067

3068

3069

3070

3071

3072

3073

3074

3075

3076

<p>

3077

3078

Defined in

3079

3080

3081

3082

3083

<a href="../files/charts_js_NumericAxis.js.html#l28"><code>charts/js/NumericAxis.js:28</code></a>

3084

3085

</p>

3086

3087

3088

3089

3090

</div>

3091

3092

3093

<p>Method used for formatting a label. This attribute allows for the default label formatting method to overridden. The method use would need

3094

to implement the arguments below and return a <code>String</code> or an <code>HTMLElement</code>. The default implementation of the method returns a <code>String</code>. The output of this method

3095

will be rendered to the DOM using <code>appendChild</code>. If you override the <code>labelFunction</code> method and return an html string, you will also need to override the Axis'

3096

<code>appendLabelFunction</code> to accept html as a <code>String</code>.</p>

3097

3098

<dl>

3099

<dt>val</dt><dd>Label to be formatted. (<code>String</code>)</dd>

3100

<dt>format</dt><dd>Object containing properties used to format the label. (optional)</dd>

3101

</dl>

3102

</div>

3103

3104

3105

3106

3107

3108

<h4>Fires event <code>labelFunctionChange</code></h4>

3109

3110

<p>

3111

Fires when the value for the configuration attribute <code>labelFunction</code> is

3112

changed. You can listen for the event using the <code>on</code> method if you

3113

wish to be notified before the attribute's value has changed, or

3114

using the <code>after</code> method if you wish to be notified after the

3115

attribute's value has changed.

3116

</p>

3117

3118

3119

<h4>Parameters:</h4>

3120

3121

3122

3123

3124

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

3125

3126

3127

An Event Facade object with the following

3128

attribute-specific properties added:

3129

</div>

3130

3131

3132

3133

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

3134

3135

<div class="param-description">The value of the attribute, prior to it being set.</div>

3136

</li>

3137

3138

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

3139

3140

<div class="param-description">The value the attribute is to be set to.</div>

3141

</li>

3142

3143

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

3144

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

3145

<div class="param-description">The name of the attribute being set.</div>

3146

</li>

3147

3148

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

3149

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

3150

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

3151

</li>

3152

</ul>

3153

</li>

3154

</ul>

3155

</div>

3156

</div>

3157

3158

3159

3160

</div>

3161

3162

3163

</div>

3164

3165

3166

3167

</div>

3168

</div>

3169

3170

</div>

3171

</div>

3172

</div>

3173

</div>

3174

</div>

3175

</div>

3176

3177

3178

3179

3180

3181

3182

3183

3184

</body>

3185

</html>

Older »