UNPKG

jsdk-offical

Version:

JSDK is the most comprehensive TypeScript framework, like JDK.

449 lines 22.8 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>WidgetConfig | JSDK 2.7.0 API</title> <meta name="description" content="Documentation for JSDK 2.7.0 API"> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="../assets/css/main.css"> </head> <body> <header> <div class="tsd-page-toolbar"> <div class="container"> <div class="table-wrap"> <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base=".."> <div class="field"> <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> <input id="tsd-search-field" type="text" /> </div> <ul class="results"> <li class="state loading">Preparing search index...</li> <li class="state failure">The search index is not available</li> </ul> <a href="../index.html" class="title">JSDK 2.7.0 API</a> </div> <div class="table-cell" id="tsd-widgets"> <div id="tsd-filter"> <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a> <div class="tsd-filter-group"> <div class="tsd-select" id="tsd-filter-visibility"> <span class="tsd-select-label">All</span> <ul class="tsd-select-list"> <li data-value="public">Public</li> <li data-value="protected">Public/Protected</li> <li data-value="private" class="selected">All</li> </ul> </div> <input type="checkbox" id="tsd-filter-inherited" checked /> <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label> <input type="checkbox" id="tsd-filter-externals" checked /> <label class="tsd-widget" for="tsd-filter-externals">Externals</label> <input type="checkbox" id="tsd-filter-only-exported" /> <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label> </div> </div> <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a> </div> </div> </div> </div> <div class="tsd-page-title"> <div class="container"> <ul class="tsd-breadcrumb"> <li> <a href="../globals.html">Globals</a> </li> <li> <a href="../modules/js.html">JS</a> </li> <li> <a href="../modules/js.fx.html">fx</a> </li> <li> <a href="js.fx.widgetconfig.html">WidgetConfig</a> </li> </ul> <h1>Class WidgetConfig&lt;W&gt;</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel tsd-type-parameters"> <h3>Type parameters</h3> <ul class="tsd-type-parameters"> <li> <h4>W</h4> </li> </ul> </section> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">WidgetConfig</span> <ul class="tsd-hierarchy"> <li> <a href="js.fx.formwidgetconfig.html" class="tsd-signature-type">FormWidgetConfig</a> </li> <li> <a href="js.fx.buttonconfig.html" class="tsd-signature-type">ButtonConfig</a> </li> <li> <a href="js.fx.carouselconfig.html" class="tsd-signature-type">CarouselConfig</a> </li> <li> <a href="js.fx.dialogconfig.html" class="tsd-signature-type">DialogConfig</a> </li> <li> <a href="js.fx.gridconfig.html" class="tsd-signature-type">GridConfig</a> </li> <li> <a href="js.fx.popupconfig.html" class="tsd-signature-type">PopupConfig</a> </li> <li> <a href="js.fx.siderconfig.html" class="tsd-signature-type">SiderConfig</a> </li> <li> <a href="js.fx.tabconfig.html" class="tsd-signature-type">TabConfig</a> </li> </ul> </li> </ul> </section> <section class="tsd-panel"> <h3>Implements</h3> <ul class="tsd-hierarchy"> <li><a href="../interfaces/js.ui.iwidgetconfig.html" class="tsd-signature-type">IWidgetConfig</a></li> </ul> </section> <section class="tsd-panel-group tsd-index-group"> <h2>Index</h2> <section class="tsd-panel tsd-index-panel"> <div class="tsd-index-content"> <section class="tsd-index-section "> <h3>Properties</h3> <ul class="tsd-index-list"> <li class="tsd-kind-property tsd-parent-kind-class"><a href="js.fx.widgetconfig.html#appendto" class="tsd-kind-icon">append<wbr>To</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="js.fx.widgetconfig.html#cls" class="tsd-kind-icon">cls</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="js.fx.widgetconfig.html#colormode" class="tsd-kind-icon">color<wbr>Mode</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="js.fx.widgetconfig.html#facemode" class="tsd-kind-icon">face<wbr>Mode</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="js.fx.widgetconfig.html#height" class="tsd-kind-icon">height</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="js.fx.widgetconfig.html#hidden" class="tsd-kind-icon">hidden</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="js.fx.widgetconfig.html#i18n" class="tsd-kind-icon">i18n</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="js.fx.widgetconfig.html#id" class="tsd-kind-icon">id</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="js.fx.widgetconfig.html#listeners" class="tsd-kind-icon">listeners</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="js.fx.widgetconfig.html#locale" class="tsd-kind-icon">locale</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="js.fx.widgetconfig.html#name" class="tsd-kind-icon">name</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="js.fx.widgetconfig.html#renderto" class="tsd-kind-icon">render<wbr>To</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="js.fx.widgetconfig.html#sizemode" class="tsd-kind-icon">size<wbr>Mode</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="js.fx.widgetconfig.html#style" class="tsd-kind-icon">style</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="js.fx.widgetconfig.html#tip" class="tsd-kind-icon">tip</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="js.fx.widgetconfig.html#width" class="tsd-kind-icon">width</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Properties</h2> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="appendto" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> append<wbr>To</h3> <div class="tsd-signature tsd-kind-icon">append<wbr>To<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Element</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">JQuery</span><span class="tsd-signature-symbol"> = &quot;body&quot;</span></div> <aside class="tsd-sources"> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="cls" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> cls</h3> <div class="tsd-signature tsd-kind-icon">cls<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;&quot;</span></div> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The CSS class to add to this widget&#39;s element</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="colormode" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> color<wbr>Mode</h3> <div class="tsd-signature tsd-kind-icon">color<wbr>Mode<span class="tsd-signature-symbol">:</span> <a href="../enums/js.fx.colormode.html" class="tsd-signature-type">ColorMode</a></div> <aside class="tsd-sources"> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="facemode" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> face<wbr>Mode</h3> <div class="tsd-signature tsd-kind-icon">face<wbr>Mode<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/array.html" class="tsd-signature-type">Array</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = null</span></div> <aside class="tsd-sources"> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="height" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> height</h3> <div class="tsd-signature tsd-kind-icon">height<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div> <aside class="tsd-sources"> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="hidden" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> hidden</h3> <div class="tsd-signature tsd-kind-icon">hidden<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div> <aside class="tsd-sources"> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="i18n" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> i18n</h3> <div class="tsd-signature tsd-kind-icon">i18n<span class="tsd-signature-symbol">:</span> <a href="../modules/js.util.html#i18nresource" class="tsd-signature-type">I18NResource</a><span class="tsd-signature-symbol"> | </span><a href="../modules/js.net.html#urlstring" class="tsd-signature-type">URLString</a><span class="tsd-signature-symbol"> = null</span></div> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>I18N resource.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="id" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> id</h3> <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="listeners" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> listeners</h3> <div class="tsd-signature tsd-kind-icon">listeners<span class="tsd-signature-symbol">:</span> <a href="../interfaces/js.fx.widgetlisteners.html" class="tsd-signature-type">WidgetListeners</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">W</span><span class="tsd-signature-symbol">&gt;</span></div> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>事件监听</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="locale" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> locale</h3> <div class="tsd-signature tsd-kind-icon">locale<span class="tsd-signature-symbol">:</span> <a href="../modules/js.util.html#locale" class="tsd-signature-type">Locale</a><span class="tsd-signature-symbol"> = &quot;en&quot;</span></div> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>A locale string, like &#39;en&#39;, &#39;en-us&#39;, &#39;zh&#39;.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="name" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> name</h3> <div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;&quot;</span></div> <aside class="tsd-sources"> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="renderto" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> render<wbr>To</h3> <div class="tsd-signature tsd-kind-icon">render<wbr>To<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Element</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">JQuery</span><span class="tsd-signature-symbol"> = null</span></div> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Render to DOM element.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="sizemode" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> size<wbr>Mode</h3> <div class="tsd-signature tsd-kind-icon">size<wbr>Mode<span class="tsd-signature-symbol">:</span> <a href="../enums/js.fx.sizemode.html" class="tsd-signature-type">SizeMode</a><span class="tsd-signature-symbol"> = SizeMode.md</span></div> <aside class="tsd-sources"> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="style" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> style</h3> <div class="tsd-signature tsd-kind-icon">style<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;&quot;</span></div> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Additional CSS styles that will be rendered into an inline style attribute when the widget is rendered.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="tip" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> tip</h3> <div class="tsd-signature tsd-kind-icon">tip<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;&quot;</span></div> <aside class="tsd-sources"> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="width" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> width</h3> <div class="tsd-signature tsd-kind-icon">width<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div> <aside class="tsd-sources"> </aside> </section> </section> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <nav class="tsd-navigation primary"> <ul> <li class="globals "> <a href="../globals.html"><em>Globals</em></a> </li> <li class="current tsd-kind-namespace"> <a href="../modules/js.html">JS</a> <ul> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.an.html">an</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.app.html">app</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.core.html">core</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.d2.html">d2</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.ds.html">ds</a> </li> <li class="current tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.fx.html">fx</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.input.html">input</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.ioc.html">ioc</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.lang.html">lang</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.math.html">math</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.media.html">media</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.model.html">model</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.net.html">net</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.store.html">store</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.sugar.html">sugar</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.ui.html">ui</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.unit.html">unit</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.util.html">util</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.view.html">view</a> </li> </ul> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> </ul> <ul class="current"> <li class="current tsd-kind-class tsd-parent-kind-namespace tsd-has-type-parameter"> <a href="js.fx.widgetconfig.html" class="tsd-kind-icon">Widget<wbr>Config</a> <ul> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="js.fx.widgetconfig.html#appendto" class="tsd-kind-icon">append<wbr>To</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="js.fx.widgetconfig.html#cls" class="tsd-kind-icon">cls</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="js.fx.widgetconfig.html#colormode" class="tsd-kind-icon">color<wbr>Mode</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="js.fx.widgetconfig.html#facemode" class="tsd-kind-icon">face<wbr>Mode</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="js.fx.widgetconfig.html#height" class="tsd-kind-icon">height</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="js.fx.widgetconfig.html#hidden" class="tsd-kind-icon">hidden</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="js.fx.widgetconfig.html#i18n" class="tsd-kind-icon">i18n</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="js.fx.widgetconfig.html#id" class="tsd-kind-icon">id</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="js.fx.widgetconfig.html#listeners" class="tsd-kind-icon">listeners</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="js.fx.widgetconfig.html#locale" class="tsd-kind-icon">locale</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="js.fx.widgetconfig.html#name" class="tsd-kind-icon">name</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="js.fx.widgetconfig.html#renderto" class="tsd-kind-icon">render<wbr>To</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="js.fx.widgetconfig.html#sizemode" class="tsd-kind-icon">size<wbr>Mode</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="js.fx.widgetconfig.html#style" class="tsd-kind-icon">style</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="js.fx.widgetconfig.html#tip" class="tsd-kind-icon">tip</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="js.fx.widgetconfig.html#width" class="tsd-kind-icon">width</a> </li> </ul> </li> </ul> <ul class="after-current"> </ul> </nav> </div> </div> </div> <footer> <div class="container"> <h2>Legend</h2> <div class="tsd-legend-group"> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li> </ul> </div> </div> </footer> <div class="overlay"></div> <script src="../assets/js/main.js"></script> <script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script> </body> </html>