UNPKG

cv-dialog-sdk

Version:

Catavolt Dialog Javascript API

670 lines 40.8 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>PropertyFormatter | cv-dialog-sdk</title> <meta name="description" content=""> <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.js" 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">cv-dialog-sdk</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/_models_propertyformatter_.html">&quot;models/PropertyFormatter&quot;</a> </li> <li> <a href="_models_propertyformatter_.propertyformatter.html">PropertyFormatter</a> </li> </ul> <h1>Class PropertyFormatter</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">PropertyFormatter</span> </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 tsd-is-private tsd-is-private-protected"> <h3>Constructors</h3> <ul class="tsd-index-list"> <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-private"><a href="_models_propertyformatter_.propertyformatter.html#constructor" class="tsd-kind-icon">constructor</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Properties</h3> <ul class="tsd-index-list"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_models_propertyformatter_.propertyformatter.html#_catavoltapi" class="tsd-kind-icon">_catavolt<wbr>Api</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="_models_propertyformatter_.propertyformatter.html#decimalformat" class="tsd-kind-icon">decimal<wbr>Format</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="_models_propertyformatter_.propertyformatter.html#decimalformatgeneric" class="tsd-kind-icon">decimal<wbr>Format<wbr>Generic</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="_models_propertyformatter_.propertyformatter.html#moneyformat" class="tsd-kind-icon">money<wbr>Format</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="_models_propertyformatter_.propertyformatter.html#moneyformatgeneric" class="tsd-kind-icon">money<wbr>Format<wbr>Generic</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="_models_propertyformatter_.propertyformatter.html#percentformat" class="tsd-kind-icon">percent<wbr>Format</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="_models_propertyformatter_.propertyformatter.html#percentformatgeneric" class="tsd-kind-icon">percent<wbr>Format<wbr>Generic</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="_models_propertyformatter_.propertyformatter.html#wholeformat" class="tsd-kind-icon">whole<wbr>Format</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static"><a href="_models_propertyformatter_.propertyformatter.html#_singleton" class="tsd-kind-icon">_singleton</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Methods</h3> <ul class="tsd-index-list"> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_models_propertyformatter_.propertyformatter.html#formatforread" class="tsd-kind-icon">format<wbr>For<wbr>Read</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_models_propertyformatter_.propertyformatter.html#formatforwrite" class="tsd-kind-icon">format<wbr>For<wbr>Write</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_models_propertyformatter_.propertyformatter.html#formatvalueforread" class="tsd-kind-icon">format<wbr>Value<wbr>For<wbr>Read</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="_models_propertyformatter_.propertyformatter.html#getsupportedlocale" class="tsd-kind-icon">get<wbr>Supported<wbr>Locale</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_models_propertyformatter_.propertyformatter.html#parse" class="tsd-kind-icon">parse</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_models_propertyformatter_.propertyformatter.html#resetformats" class="tsd-kind-icon">reset<wbr>Formats</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_models_propertyformatter_.propertyformatter.html#tostring" class="tsd-kind-icon">to<wbr>String</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_models_propertyformatter_.propertyformatter.html#tostringread" class="tsd-kind-icon">to<wbr>String<wbr>Read</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_models_propertyformatter_.propertyformatter.html#tostringwrite" class="tsd-kind-icon">to<wbr>String<wbr>Write</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_models_propertyformatter_.propertyformatter.html#singleton" class="tsd-kind-icon">singleton</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group tsd-is-private tsd-is-private-protected"> <h2>Constructors</h2> <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-private"> <a name="constructor" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> constructor</h3> <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-private"> <li class="tsd-signature tsd-kind-icon">new <wbr>Property<wbr>Formatter<span class="tsd-signature-symbol">(</span>_catavoltApi<span class="tsd-signature-symbol">: </span><a href="../interfaces/_dialog_catavoltapi_.catavoltapi.html" class="tsd-signature-type">CatavoltApi</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_models_propertyformatter_.propertyformatter.html" class="tsd-signature-type">PropertyFormatter</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/PropertyFormatter.ts#L101">models/PropertyFormatter.ts:101</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>_catavoltApi: <a href="../interfaces/_dialog_catavoltapi_.catavoltapi.html" class="tsd-signature-type">CatavoltApi</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="_models_propertyformatter_.propertyformatter.html" class="tsd-signature-type">PropertyFormatter</a></h4> </li> </ul> </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 tsd-is-private"> <a name="_catavoltapi" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> _catavolt<wbr>Api</h3> <div class="tsd-signature tsd-kind-icon">_catavolt<wbr>Api<span class="tsd-signature-symbol">:</span> <a href="../interfaces/_dialog_catavoltapi_.catavoltapi.html" class="tsd-signature-type">CatavoltApi</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/PropertyFormatter.ts#L103">models/PropertyFormatter.ts:103</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="decimalformat" class="tsd-anchor"></a> <h3>decimal<wbr>Format</h3> <div class="tsd-signature tsd-kind-icon">decimal<wbr>Format<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/PropertyFormatter.ts#L88">models/PropertyFormatter.ts:88</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="decimalformatgeneric" class="tsd-anchor"></a> <h3>decimal<wbr>Format<wbr>Generic</h3> <div class="tsd-signature tsd-kind-icon">decimal<wbr>Format<wbr>Generic<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/PropertyFormatter.ts#L89">models/PropertyFormatter.ts:89</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="moneyformat" class="tsd-anchor"></a> <h3>money<wbr>Format</h3> <div class="tsd-signature tsd-kind-icon">money<wbr>Format<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/PropertyFormatter.ts#L90">models/PropertyFormatter.ts:90</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="moneyformatgeneric" class="tsd-anchor"></a> <h3>money<wbr>Format<wbr>Generic</h3> <div class="tsd-signature tsd-kind-icon">money<wbr>Format<wbr>Generic<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/PropertyFormatter.ts#L91">models/PropertyFormatter.ts:91</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="percentformat" class="tsd-anchor"></a> <h3>percent<wbr>Format</h3> <div class="tsd-signature tsd-kind-icon">percent<wbr>Format<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/PropertyFormatter.ts#L92">models/PropertyFormatter.ts:92</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="percentformatgeneric" class="tsd-anchor"></a> <h3>percent<wbr>Format<wbr>Generic</h3> <div class="tsd-signature tsd-kind-icon">percent<wbr>Format<wbr>Generic<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/PropertyFormatter.ts#L93">models/PropertyFormatter.ts:93</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="wholeformat" class="tsd-anchor"></a> <h3>whole<wbr>Format</h3> <div class="tsd-signature tsd-kind-icon">whole<wbr>Format<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/PropertyFormatter.ts#L94">models/PropertyFormatter.ts:94</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static"> <a name="_singleton" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagPrivate">Private</span> _singleton</h3> <div class="tsd-signature tsd-kind-icon">_singleton<span class="tsd-signature-symbol">:</span> <a href="_models_propertyformatter_.propertyformatter.html" class="tsd-signature-type">PropertyFormatter</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/PropertyFormatter.ts#L85">models/PropertyFormatter.ts:85</a></li> </ul> </aside> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Methods</h2> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="formatforread" class="tsd-anchor"></a> <h3>format<wbr>For<wbr>Read</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">format<wbr>For<wbr>Read<span class="tsd-signature-symbol">(</span>prop<span class="tsd-signature-symbol">: </span><a href="_models_property_.property.html" class="tsd-signature-type">Property</a>, propDef<span class="tsd-signature-symbol">: </span><a href="_models_propertydef_.propertydef.html" class="tsd-signature-type">PropertyDef</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/PropertyFormatter.ts#L116">models/PropertyFormatter.ts:116</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Get a string representation of this property suitable for &#39;reading&#39;</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>prop: <a href="_models_property_.property.html" class="tsd-signature-type">Property</a></h5> </li> <li> <h5>propDef: <a href="_models_propertydef_.propertydef.html" class="tsd-signature-type">PropertyDef</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="formatforwrite" class="tsd-anchor"></a> <h3>format<wbr>For<wbr>Write</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">format<wbr>For<wbr>Write<span class="tsd-signature-symbol">(</span>prop<span class="tsd-signature-symbol">: </span><a href="_models_property_.property.html" class="tsd-signature-type">Property</a>, propDef<span class="tsd-signature-symbol">: </span><a href="_models_propertydef_.propertydef.html" class="tsd-signature-type">PropertyDef</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/PropertyFormatter.ts#L166">models/PropertyFormatter.ts:166</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Get a string representation of this property suitable for &#39;writing&#39;</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>prop: <a href="_models_property_.property.html" class="tsd-signature-type">Property</a></h5> </li> <li> <h5>propDef: <a href="_models_propertydef_.propertydef.html" class="tsd-signature-type">PropertyDef</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="formatvalueforread" class="tsd-anchor"></a> <h3>format<wbr>Value<wbr>For<wbr>Read</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">format<wbr>Value<wbr>For<wbr>Read<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, propDef<span class="tsd-signature-symbol">: </span><a href="_models_propertydef_.propertydef.html" class="tsd-signature-type">PropertyDef</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/PropertyFormatter.ts#L124">models/PropertyFormatter.ts:124</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>value: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>propDef: <a href="_models_propertydef_.propertydef.html" class="tsd-signature-type">PropertyDef</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"> <a name="getsupportedlocale" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> get<wbr>Supported<wbr>Locale</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"> <li class="tsd-signature tsd-kind-icon">get<wbr>Supported<wbr>Locale<span class="tsd-signature-symbol">(</span>locale<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/PropertyFormatter.ts#L343">models/PropertyFormatter.ts:343</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>locale: <span class="tsd-signature-type">any</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="parse" class="tsd-anchor"></a> <h3>parse</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">parse<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, propDef<span class="tsd-signature-symbol">: </span><a href="_models_propertydef_.propertydef.html" class="tsd-signature-type">PropertyDef</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/PropertyFormatter.ts#L185">models/PropertyFormatter.ts:185</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Attempt to construct (or preserve) the appropriate data type given primitive (or already constructed) value. Note this must be done here and not at &#39;write&#39; time because it requires the knowledge of the PropDef</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>value: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>propDef: <a href="_models_propertydef_.propertydef.html" class="tsd-signature-type">PropertyDef</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="resetformats" class="tsd-anchor"></a> <h3>reset<wbr>Formats</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">reset<wbr>Formats<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/PropertyFormatter.ts#L239">models/PropertyFormatter.ts:239</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="tostring" class="tsd-anchor"></a> <h3>to<wbr>String</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">to<wbr>String<span class="tsd-signature-symbol">(</span>o<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, propDef<span class="tsd-signature-symbol">: </span><a href="_models_propertydef_.propertydef.html" class="tsd-signature-type">PropertyDef</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/PropertyFormatter.ts#L249">models/PropertyFormatter.ts:249</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>o: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>propDef: <a href="_models_propertydef_.propertydef.html" class="tsd-signature-type">PropertyDef</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="tostringread" class="tsd-anchor"></a> <h3>to<wbr>String<wbr>Read</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">to<wbr>String<wbr>Read<span class="tsd-signature-symbol">(</span>o<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, propDef<span class="tsd-signature-symbol">: </span><a href="_models_propertydef_.propertydef.html" class="tsd-signature-type">PropertyDef</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/PropertyFormatter.ts#L260">models/PropertyFormatter.ts:260</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Render this value as a string</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>o: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>propDef: <a href="_models_propertydef_.propertydef.html" class="tsd-signature-type">PropertyDef</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="tostringwrite" class="tsd-anchor"></a> <h3>to<wbr>String<wbr>Write</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">to<wbr>String<wbr>Write<span class="tsd-signature-symbol">(</span>o<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, propDef<span class="tsd-signature-symbol">: </span><a href="_models_propertydef_.propertydef.html" class="tsd-signature-type">PropertyDef</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/PropertyFormatter.ts#L329">models/PropertyFormatter.ts:329</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>o: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>propDef: <a href="_models_propertydef_.propertydef.html" class="tsd-signature-type">PropertyDef</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a name="singleton" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> singleton</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"> <li class="tsd-signature tsd-kind-icon">singleton<span class="tsd-signature-symbol">(</span>catavoltApi<span class="tsd-signature-symbol">: </span><a href="../interfaces/_dialog_catavoltapi_.catavoltapi.html" class="tsd-signature-type">CatavoltApi</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_models_propertyformatter_.propertyformatter.html" class="tsd-signature-type">PropertyFormatter</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/PropertyFormatter.ts#L96">models/PropertyFormatter.ts:96</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>catavoltApi: <a href="../interfaces/_dialog_catavoltapi_.catavoltapi.html" class="tsd-signature-type">CatavoltApi</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="_models_propertyformatter_.propertyformatter.html" class="tsd-signature-type">PropertyFormatter</a></h4> </li> </ul> </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-external-module"> <a href="../modules/_models_propertyformatter_.html">"models/<wbr>Property<wbr>Formatter"</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> <li class=" tsd-kind-class tsd-parent-kind-external-module tsd-is-not-exported"> <a href="_models_propertyformatter_.privatepropformats.html" class="tsd-kind-icon">Private<wbr>Prop<wbr>Formats</a> </li> </ul> <ul class="current"> <li class="current tsd-kind-class tsd-parent-kind-external-module"> <a href="_models_propertyformatter_.propertyformatter.html" class="tsd-kind-icon">Property<wbr>Formatter</a> <ul> <li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-private"> <a href="_models_propertyformatter_.propertyformatter.html#constructor" class="tsd-kind-icon">constructor</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a href="_models_propertyformatter_.propertyformatter.html#_catavoltapi" class="tsd-kind-icon">_catavolt<wbr>Api</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="_models_propertyformatter_.propertyformatter.html#decimalformat" class="tsd-kind-icon">decimal<wbr>Format</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="_models_propertyformatter_.propertyformatter.html#decimalformatgeneric" class="tsd-kind-icon">decimal<wbr>Format<wbr>Generic</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="_models_propertyformatter_.propertyformatter.html#moneyformat" class="tsd-kind-icon">money<wbr>Format</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="_models_propertyformatter_.propertyformatter.html#moneyformatgeneric" class="tsd-kind-icon">money<wbr>Format<wbr>Generic</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="_models_propertyformatter_.propertyformatter.html#percentformat" class="tsd-kind-icon">percent<wbr>Format</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="_models_propertyformatter_.propertyformatter.html#percentformatgeneric" class="tsd-kind-icon">percent<wbr>Format<wbr>Generic</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="_models_propertyformatter_.propertyformatter.html#wholeformat" class="tsd-kind-icon">whole<wbr>Format</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static"> <a href="_models_propertyformatter_.propertyformatter.html#_singleton" class="tsd-kind-icon">_singleton</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_models_propertyformatter_.propertyformatter.html#formatforread" class="tsd-kind-icon">format<wbr>For<wbr>Read</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_models_propertyformatter_.propertyformatter.html#formatforwrite" class="tsd-kind-icon">format<wbr>For<wbr>Write</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_models_propertyformatter_.propertyformatter.html#formatvalueforread" class="tsd-kind-icon">format<wbr>Value<wbr>For<wbr>Read</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private"> <a href="_models_propertyformatter_.propertyformatter.html#getsupportedlocale" class="tsd-kind-icon">get<wbr>Supported<wbr>Locale</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_models_propertyformatter_.propertyformatter.html#parse" class="tsd-kind-icon">parse</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_models_propertyformatter_.propertyformatter.html#resetformats" class="tsd-kind-icon">reset<wbr>Formats</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_models_propertyformatter_.propertyformatter.html#tostring" class="tsd-kind-icon">to<wbr>String</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_models_propertyformatter_.propertyformatter.html#tostringread" class="tsd-kind-icon">to<wbr>String<wbr>Read</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_models_propertyformatter_.propertyformatter.html#tostringwrite" class="tsd-kind-icon">to<wbr>String<wbr>Write</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a href="_models_propertyformatter_.propertyformatter.html#singleton" class="tsd-kind-icon">singleton</a> </li> </ul> </li> </ul> <ul class="after-current"> <li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported"> <a href="../modules/_models_propertyformatter_.html#supportedlocales" class="tsd-kind-icon">supported<wbr>Locales</a> </li> </ul> </nav> </div> </div> </div> <footer class="with-border-bottom"> <div class="container"> <h2>Legend</h2> <div class="tsd-legend-group"> <ul class="tsd-legend"> <li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li> <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li> <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li> <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li> <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li> <li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li> <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li> <li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li> <li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li> <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li> <li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li> <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> <li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li> <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li> <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li> <li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li> <li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li> </ul> </div> </div> </footer> <div class="container tsd-generator"> <p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p> </div> <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>