UNPKG

cv-dialog-sdk

Version:

Catavolt Dialog Javascript API

670 lines (669 loc) 165 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>EditorDialog | 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_editordialog_.html">&quot;models/EditorDialog&quot;</a> </li> <li> <a href="_models_editordialog_.editordialog.html">EditorDialog</a> </li> </ul> <h1>Class EditorDialog</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel tsd-comment"> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>PanContext Subtype that represents an &#39;Editor Dialog&#39;. An &#39;Editor&#39; represents and is backed by a single Record and Record definition. See <a href="../interfaces/_models_record_.record.html">Record</a> and <a href="_models_recorddef_.recorddef.html">RecordDef</a>.</p> </div> </div> </section> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <a href="_models_dialog_.dialog.html" class="tsd-signature-type">Dialog</a> <ul class="tsd-hierarchy"> <li> <span class="target">EditorDialog</span> <ul class="tsd-hierarchy"> <li> <a href="_models_formdialog_.formdialog.html" class="tsd-signature-type">FormDialog</a> </li> <li> <a href="_models_searchdialog_.searchdialog.html" class="tsd-signature-type">SearchDialog</a> </li> </ul> </li> </ul> </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 tsd-is-private"><a href="_models_editordialog_.editordialog.html#_buffer" class="tsd-kind-icon">_buffer</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_models_editordialog_.editordialog.html#availableviews" class="tsd-kind-icon">available<wbr>Views</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_models_editordialog_.editordialog.html#children" class="tsd-kind-icon">children</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_models_editordialog_.editordialog.html#description" class="tsd-kind-icon">description</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_models_editordialog_.editordialog.html#dialogclassname" class="tsd-kind-icon">dialog<wbr>Class<wbr>Name</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_models_editordialog_.editordialog.html#dialogmode" class="tsd-kind-icon">dialog<wbr>Mode</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_models_editordialog_.editordialog.html#domainclassname" class="tsd-kind-icon">domain<wbr>Class<wbr>Name</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_models_editordialog_.editordialog.html#header" class="tsd-kind-icon">header</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_models_editordialog_.editordialog.html#id" class="tsd-kind-icon">id</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_models_editordialog_.editordialog.html#recorddef" class="tsd-kind-icon">record<wbr>Def</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="_models_editordialog_.editordialog.html#recordid" class="tsd-kind-icon">record<wbr>Id</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_models_editordialog_.editordialog.html#referringobject" class="tsd-kind-icon">referring<wbr>Object</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_models_editordialog_.editordialog.html#selectedviewid" class="tsd-kind-icon">selected<wbr>View<wbr>Id</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_models_editordialog_.editordialog.html#sessionid" class="tsd-kind-icon">session<wbr>Id</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_models_editordialog_.editordialog.html#tenantid" class="tsd-kind-icon">tenant<wbr>Id</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_models_editordialog_.editordialog.html#type" class="tsd-kind-icon">type</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_models_editordialog_.editordialog.html#view" class="tsd-kind-icon">view</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_models_editordialog_.editordialog.html#viewmode" class="tsd-kind-icon">view<wbr>Mode</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static"><a href="_models_editordialog_.editordialog.html#binary_chunk_size" class="tsd-kind-icon">BINARY_<wbr>CHUNK_<wbr>SIZE</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static"><a href="_models_editordialog_.editordialog.html#search_dialog_class" class="tsd-kind-icon">SEARCH_<wbr>DIALOG_<wbr>CLASS</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Accessors</h3> <ul class="tsd-index-list"> <li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="_models_editordialog_.editordialog.html#anychildneedsrefresh" class="tsd-kind-icon">any<wbr>Child<wbr>Needs<wbr>Refresh</a></li> <li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_models_editordialog_.editordialog.html#attributecells" class="tsd-kind-icon">attribute<wbr>Cells</a></li> <li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-private"><a href="_models_editordialog_.editordialog.html#buffer" class="tsd-kind-icon">buffer</a></li> <li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="_models_editordialog_.editordialog.html#catavolt" class="tsd-kind-icon">catavolt</a></li> <li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_models_editordialog_.editordialog.html#constants" class="tsd-kind-icon">constants</a></li> <li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="_models_editordialog_.editordialog.html#error" class="tsd-kind-icon">error</a></li> <li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="_models_editordialog_.editordialog.html#haserror" class="tsd-kind-icon">has<wbr>Error</a></li> <li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="_models_editordialog_.editordialog.html#isdestroyed" class="tsd-kind-icon">is<wbr>Destroyed</a></li> <li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_models_editordialog_.editordialog.html#isreadmode" class="tsd-kind-icon">is<wbr>Read<wbr>Mode</a></li> <li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="_models_editordialog_.editordialog.html#isreadviewmode" class="tsd-kind-icon">is<wbr>Read<wbr>View<wbr>Mode</a></li> <li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="_models_editordialog_.editordialog.html#isrefreshneeded" class="tsd-kind-icon">is<wbr>Refresh<wbr>Needed</a></li> <li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_models_editordialog_.editordialog.html#iswritemode" class="tsd-kind-icon">is<wbr>Write<wbr>Mode</a></li> <li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_models_editordialog_.editordialog.html#labelsbypropname" class="tsd-kind-icon">labels<wbr>ByProp<wbr>Name</a></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="_models_editordialog_.editordialog.html#lastrefreshtime" class="tsd-kind-icon">last<wbr>Refresh<wbr>Time</a></li> <li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="_models_editordialog_.editordialog.html#menu" class="tsd-kind-icon">menu</a></li> <li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="_models_editordialog_.editordialog.html#panetitle" class="tsd-kind-icon">pane<wbr>Title</a></li> <li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_models_editordialog_.editordialog.html#propertydefs" class="tsd-kind-icon">property<wbr>Defs</a></li> <li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_models_editordialog_.editordialog.html#props" class="tsd-kind-icon">props</a></li> <li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_models_editordialog_.editordialog.html#record" class="tsd-kind-icon">record</a></li> <li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_models_editordialog_.editordialog.html#recordnow" class="tsd-kind-icon">record<wbr>Now</a></li> <li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="_models_editordialog_.editordialog.html#viewdescs" class="tsd-kind-icon">view<wbr>Descs</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_editordialog_.editordialog.html#changeviewmode" class="tsd-kind-icon">change<wbr>View<wbr>Mode</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_models_editordialog_.editordialog.html#destroy" class="tsd-kind-icon">destroy</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_models_editordialog_.editordialog.html#findmenuat" class="tsd-kind-icon">find<wbr>Menu<wbr>At</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_models_editordialog_.editordialog.html#formatforread" class="tsd-kind-icon">format<wbr>For<wbr>Read</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_models_editordialog_.editordialog.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_editordialog_.editordialog.html#getavailablevalues" class="tsd-kind-icon">get<wbr>Available<wbr>Values</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected"><a href="_models_editordialog_.editordialog.html#getproperty" class="tsd-kind-icon">get<wbr>Property</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="_models_editordialog_.editordialog.html#getwriteablerecord" class="tsd-kind-icon">get<wbr>Writeable<wbr>Record</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="_models_editordialog_.editordialog.html#initbuffer" class="tsd-kind-icon">init<wbr>Buffer</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_models_editordialog_.editordialog.html#initialize" class="tsd-kind-icon">initialize</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="_models_editordialog_.editordialog.html#invokemenuaction" class="tsd-kind-icon">invoke<wbr>Menu<wbr>Action</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="_models_editordialog_.editordialog.html#invokemenuactionwithid" class="tsd-kind-icon">invoke<wbr>Menu<wbr>Action<wbr>With<wbr>Id</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_models_editordialog_.editordialog.html#isbinary" class="tsd-kind-icon">is<wbr>Binary</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_models_editordialog_.editordialog.html#isreadmodefor" class="tsd-kind-icon">is<wbr>Read<wbr>Mode<wbr>For</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_models_editordialog_.editordialog.html#issignature" class="tsd-kind-icon">is<wbr>Signature</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_models_editordialog_.editordialog.html#newlargepropertywithdataurl" class="tsd-kind-icon">new<wbr>Large<wbr>Property<wbr>With<wbr>Data<wbr>Url</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_models_editordialog_.editordialog.html#newlargepropertywithencodeddata" class="tsd-kind-icon">new<wbr>Large<wbr>Property<wbr>With<wbr>Encoded<wbr>Data</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_models_editordialog_.editordialog.html#newproperty" class="tsd-kind-icon">new<wbr>Property</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_models_editordialog_.editordialog.html#openview" class="tsd-kind-icon">open<wbr>View</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_models_editordialog_.editordialog.html#openviewwithid" class="tsd-kind-icon">open<wbr>View<wbr>With<wbr>Id</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_models_editordialog_.editordialog.html#parsevalue" class="tsd-kind-icon">parse<wbr>Value</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_models_editordialog_.editordialog.html#performmenuaction" class="tsd-kind-icon">perform<wbr>Menu<wbr>Action</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_models_editordialog_.editordialog.html#performmenuactionwithid" class="tsd-kind-icon">perform<wbr>Menu<wbr>Action<wbr>With<wbr>Id</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_models_editordialog_.editordialog.html#processsideeffects" class="tsd-kind-icon">process<wbr>Side<wbr>Effects</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_models_editordialog_.editordialog.html#propdefatname" class="tsd-kind-icon">prop<wbr>Def<wbr>AtName</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_models_editordialog_.editordialog.html#read" class="tsd-kind-icon">read</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_models_editordialog_.editordialog.html#readlargeproperties" class="tsd-kind-icon">read<wbr>Large<wbr>Properties</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_models_editordialog_.editordialog.html#readlargeproperty" class="tsd-kind-icon">read<wbr>Large<wbr>Property</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_models_editordialog_.editordialog.html#setlargepropertywithdataurl" class="tsd-kind-icon">set<wbr>Large<wbr>Property<wbr>With<wbr>Data<wbr>Url</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_models_editordialog_.editordialog.html#setlargepropertywithencodeddata" class="tsd-kind-icon">set<wbr>Large<wbr>Property<wbr>With<wbr>Encoded<wbr>Data</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_models_editordialog_.editordialog.html#setpropertyvalue" class="tsd-kind-icon">set<wbr>Property<wbr>Value</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_models_editordialog_.editordialog.html#streamlargeproperty" class="tsd-kind-icon">stream<wbr>Large<wbr>Property</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="_models_editordialog_.editordialog.html#updatesettingswithnewdialogproperties" class="tsd-kind-icon">update<wbr>Settings<wbr>With<wbr>New<wbr>Dialog<wbr>Properties</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_models_editordialog_.editordialog.html#write" class="tsd-kind-icon">write</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="_models_editordialog_.editordialog.html#writeattachment" class="tsd-kind-icon">write<wbr>Attachment</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="_models_editordialog_.editordialog.html#writeattachments" class="tsd-kind-icon">write<wbr>Attachments</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="_models_editordialog_.editordialog.html#writelargeproperties" class="tsd-kind-icon">write<wbr>Large<wbr>Properties</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="_models_editordialog_.editordialog.html#writelargeproperty" class="tsd-kind-icon">write<wbr>Large<wbr>Property</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_models_editordialog_.editordialog.html#getsubtype" class="tsd-kind-icon">get<wbr>Sub<wbr>Type</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static"><a href="_models_editordialog_.editordialog.html#issearchdialog" class="tsd-kind-icon">is<wbr>Search<wbr>Dialog</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static"><a href="_models_editordialog_.editordialog.html#loadlargeproperty" class="tsd-kind-icon">load<wbr>Large<wbr>Property</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 tsd-is-private"> <a name="_buffer" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> _buffer</h3> <div class="tsd-signature tsd-kind-icon">_buffer<span class="tsd-signature-symbol">:</span> <a href="_models_recordbuffer_.recordbuffer.html" class="tsd-signature-type">RecordBuffer</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/EditorDialog.ts#L31">models/EditorDialog.ts:31</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"> <a name="availableviews" class="tsd-anchor"></a> <h3>available<wbr>Views</h3> <div class="tsd-signature tsd-kind-icon">available<wbr>Views<span class="tsd-signature-symbol">:</span> <a href="_models_viewdescriptor_.viewdescriptor.html" class="tsd-signature-type">ViewDescriptor</a><span class="tsd-signature-symbol">[]</span></div> <aside class="tsd-sources"> <p>Inherited from <a href="_models_dialog_.dialog.html">Dialog</a>.<a href="_models_dialog_.dialog.html#availableviews">availableViews</a></p> <ul> <li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/Dialog.ts#L35">models/Dialog.ts:35</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"> <a name="children" class="tsd-anchor"></a> <h3>children</h3> <div class="tsd-signature tsd-kind-icon">children<span class="tsd-signature-symbol">:</span> <a href="_models_dialog_.dialog.html" class="tsd-signature-type">Dialog</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> =&nbsp;[]</span></div> <aside class="tsd-sources"> <p>Inherited from <a href="_models_dialog_.dialog.html">Dialog</a>.<a href="_models_dialog_.dialog.html#children">children</a></p> <ul> <li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/Dialog.ts#L37">models/Dialog.ts:37</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"> <a name="description" class="tsd-anchor"></a> <h3>description</h3> <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <p>Inherited from <a href="_models_dialog_.dialog.html">Dialog</a>.<a href="_models_dialog_.dialog.html#description">description</a></p> <ul> <li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/Dialog.ts#L38">models/Dialog.ts:38</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"> <a name="dialogclassname" class="tsd-anchor"></a> <h3>dialog<wbr>Class<wbr>Name</h3> <div class="tsd-signature tsd-kind-icon">dialog<wbr>Class<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <p>Inherited from <a href="_models_dialog_.dialog.html">Dialog</a>.<a href="_models_dialog_.dialog.html#dialogclassname">dialogClassName</a></p> <ul> <li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/Dialog.ts#L39">models/Dialog.ts:39</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"> <a name="dialogmode" class="tsd-anchor"></a> <h3>dialog<wbr>Mode</h3> <div class="tsd-signature tsd-kind-icon">dialog<wbr>Mode<span class="tsd-signature-symbol">:</span> <a href="../modules/_models_types_.html#dialogmode" class="tsd-signature-type">DialogMode</a></div> <aside class="tsd-sources"> <p>Inherited from <a href="_models_dialog_.dialog.html">Dialog</a>.<a href="_models_dialog_.dialog.html#dialogmode">dialogMode</a></p> <ul> <li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/Dialog.ts#L40">models/Dialog.ts:40</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"> <a name="domainclassname" class="tsd-anchor"></a> <h3>domain<wbr>Class<wbr>Name</h3> <div class="tsd-signature tsd-kind-icon">domain<wbr>Class<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <p>Inherited from <a href="_models_dialog_.dialog.html">Dialog</a>.<a href="_models_dialog_.dialog.html#domainclassname">domainClassName</a></p> <ul> <li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/Dialog.ts#L36">models/Dialog.ts:36</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"> <a name="header" class="tsd-anchor"></a> <h3>header</h3> <div class="tsd-signature tsd-kind-icon">header<span class="tsd-signature-symbol">:</span> <a href="_models_view_.view.html" class="tsd-signature-type">View</a></div> <aside class="tsd-sources"> <p>Inherited from <a href="_models_dialog_.dialog.html">Dialog</a>.<a href="_models_dialog_.dialog.html#header">header</a></p> <ul> <li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/Dialog.ts#L41">models/Dialog.ts:41</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"> <a name="id" class="tsd-anchor"></a> <h3>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"> <p>Inherited from <a href="_models_dialog_.dialog.html">Dialog</a>.<a href="_models_dialog_.dialog.html#id">id</a></p> <ul> <li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/Dialog.ts#L42">models/Dialog.ts:42</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"> <a name="recorddef" class="tsd-anchor"></a> <h3>record<wbr>Def</h3> <div class="tsd-signature tsd-kind-icon">record<wbr>Def<span class="tsd-signature-symbol">:</span> <a href="_models_recorddef_.recorddef.html" class="tsd-signature-type">RecordDef</a></div> <aside class="tsd-sources"> <p>Inherited from <a href="_models_dialog_.dialog.html">Dialog</a>.<a href="_models_dialog_.dialog.html#recorddef">recordDef</a></p> <ul> <li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/Dialog.ts#L43">models/Dialog.ts:43</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="recordid" class="tsd-anchor"></a> <h3>record<wbr>Id</h3> <div class="tsd-signature tsd-kind-icon">record<wbr>Id<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/EditorDialog.ts#L29">models/EditorDialog.ts:29</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"> <a name="referringobject" class="tsd-anchor"></a> <h3>referring<wbr>Object</h3> <div class="tsd-signature tsd-kind-icon">referring<wbr>Object<span class="tsd-signature-symbol">:</span> <a href="_models_referringobject_.referringobject.html" class="tsd-signature-type">ReferringObject</a></div> <aside class="tsd-sources"> <p>Inherited from <a href="_models_dialog_.dialog.html">Dialog</a>.<a href="_models_dialog_.dialog.html#referringobject">referringObject</a></p> <ul> <li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/Dialog.ts#L44">models/Dialog.ts:44</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"> <a name="selectedviewid" class="tsd-anchor"></a> <h3>selected<wbr>View<wbr>Id</h3> <div class="tsd-signature tsd-kind-icon">selected<wbr>View<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <p>Inherited from <a href="_models_dialog_.dialog.html">Dialog</a>.<a href="_models_dialog_.dialog.html#selectedviewid">selectedViewId</a></p> <ul> <li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/Dialog.ts#L45">models/Dialog.ts:45</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"> <a name="sessionid" class="tsd-anchor"></a> <h3>session<wbr>Id</h3> <div class="tsd-signature tsd-kind-icon">session<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <p>Inherited from <a href="_models_dialog_.dialog.html">Dialog</a>.<a href="_models_dialog_.dialog.html#sessionid">sessionId</a></p> <ul> <li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/Dialog.ts#L46">models/Dialog.ts:46</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"> <a name="tenantid" class="tsd-anchor"></a> <h3>tenant<wbr>Id</h3> <div class="tsd-signature tsd-kind-icon">tenant<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <p>Inherited from <a href="_models_dialog_.dialog.html">Dialog</a>.<a href="_models_dialog_.dialog.html#tenantid">tenantId</a></p> <ul> <li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/Dialog.ts#L47">models/Dialog.ts:47</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"> <a name="type" class="tsd-anchor"></a> <h3>type</h3> <div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../modules/_models_types_.html#dialogtype" class="tsd-signature-type">DialogType</a></div> <aside class="tsd-sources"> <p>Inherited from <a href="_models_dialog_.dialog.html">Dialog</a>.<a href="_models_dialog_.dialog.html#type">type</a></p> <ul> <li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/Dialog.ts#L48">models/Dialog.ts:48</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"> <a name="view" class="tsd-anchor"></a> <h3>view</h3> <div class="tsd-signature tsd-kind-icon">view<span class="tsd-signature-symbol">:</span> <a href="_models_view_.view.html" class="tsd-signature-type">View</a></div> <aside class="tsd-sources"> <p>Inherited from <a href="_models_dialog_.dialog.html">Dialog</a>.<a href="_models_dialog_.dialog.html#view">view</a></p> <ul> <li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/Dialog.ts#L49">models/Dialog.ts:49</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"> <a name="viewmode" class="tsd-anchor"></a> <h3>view<wbr>Mode</h3> <div class="tsd-signature tsd-kind-icon">view<wbr>Mode<span class="tsd-signature-symbol">:</span> <a href="../modules/_models_types_.html#viewmode" class="tsd-signature-type">ViewMode</a></div> <aside class="tsd-sources"> <p>Inherited from <a href="_models_dialog_.dialog.html">Dialog</a>.<a href="_models_dialog_.dialog.html#viewmode">viewMode</a></p> <ul> <li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/Dialog.ts#L50">models/Dialog.ts:50</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static"> <a name="binary_chunk_size" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> BINARY_<wbr>CHUNK_<wbr>SIZE</h3> <div class="tsd-signature tsd-kind-icon">BINARY_<wbr>CHUNK_<wbr>SIZE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> =&nbsp;128 * 1024</span></div> <aside class="tsd-sources"> <p>Inherited from <a href="_models_dialog_.dialog.html">Dialog</a>.<a href="_models_dialog_.dialog.html#binary_chunk_size">BINARY_CHUNK_SIZE</a></p> <ul> <li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/Dialog.ts#L32">models/Dialog.ts:32</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static"> <a name="search_dialog_class" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> SEARCH_<wbr>DIALOG_<wbr>CLASS</h3> <div class="tsd-signature tsd-kind-icon">SEARCH_<wbr>DIALOG_<wbr>CLASS<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> =&nbsp;&quot;SearchQueryModel&quot;</span></div> <aside class="tsd-sources"> <p>Inherited from <a href="_models_dialog_.dialog.html">Dialog</a>.<a href="_models_dialog_.dialog.html#search_dialog_class">SEARCH_DIALOG_CLASS</a></p> <ul> <li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/Dialog.ts#L31">models/Dialog.ts:31</a></li> </ul> </aside> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Accessors</h2> <section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"> <a name="anychildneedsrefresh" class="tsd-anchor"></a> <h3>any<wbr>Child<wbr>Needs<wbr>Refresh</h3> <ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> anyChildNeedsRefresh<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from <a href="_models_dialog_.dialog.html">Dialog</a>.<a href="_models_dialog_.dialog.html#anychildneedsrefresh">anyChildNeedsRefresh</a></p> <ul> <li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/Dialog.ts#L67">models/Dialog.ts:67</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"> <a name="attributecells" class="tsd-anchor"></a> <h3>attribute<wbr>Cells</h3> <ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> attributeCells<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_models_attributecellvalue_.attributecellvalue.html" class="tsd-signature-type">AttributeCellValue</a><span class="tsd-signature-symbol">[]</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/EditorDialog.ts#L83">models/EditorDialog.ts:83</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <a href="_models_attributecellvalue_.attributecellvalue.html" class="tsd-signature-type">AttributeCellValue</a><span class="tsd-signature-symbol">[]</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-private"> <a name="buffer" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> buffer</h3> <ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-private"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> buffer<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_models_recordbuffer_.recordbuffer.html" class="tsd-signature-type">RecordBuffer</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/EditorDialog.ts#L369">models/EditorDialog.ts:369</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Get the current buffered record</p> </div> </div> <h4 class="tsd-returns-title">Returns <a href="_models_recordbuffer_.recordbuffer.html" class="tsd-signature-type">RecordBuffer</a></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"> <a name="catavolt" class="tsd-anchor"></a> <h3>catavolt</h3> <ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> catavolt<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_dialog_catavoltapi_.catavoltapi.html" class="tsd-signature-type">CatavoltApi</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from <a href="_models_dialog_.dialog.html">Dialog</a>.<a href="_models_dialog_.dialog.html#catavolt">catavolt</a></p> <ul> <li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/Dialog.ts#L63">models/Dialog.ts:63</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <a href="../interfaces/_dialog_catavoltapi_.catavoltapi.html" class="tsd-signature-type">CatavoltApi</a></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"> <a name="constants" class="tsd-anchor"></a> <h3>constants</h3> <ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> constants<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</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/EditorDialog.ts#L76">models/EditorDialog.ts:76</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"> <a name="error" class="tsd-anchor"></a> <h3>error</h3> <ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> error<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_models_dialogexception_.dialogexception.html" class="tsd-signature-type">DialogException</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from <a href="_models_dialog_.dialog.html">Dialog</a>.<a href="_models_dialog_.dialog.html#error">error</a></p> <ul> <li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/Dialog.ts#L87">models/Dialog.ts:87</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Return the error associated with this dialog, if any</p> </div> </div> <h4 class="tsd-returns-title">Returns <a href="_models_dialogexception_.dialogexception.html" class="tsd-signature-type">DialogException</a></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"> <a name="haserror" class="tsd-anchor"></a> <h3>has<wbr>Error</h3> <ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> hasError<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from <a href="_models_dialog_.dialog.html">Dialog</a>.<a href="_models_dialog_.dialog.html#haserror">hasError</a></p> <ul> <li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/Dialog.ts#L131">models/Dialog.ts:131</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Returns whether or not this dialog loaded properly</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"> <a name="isdestroyed" class="tsd-anchor"></a> <h3>is<wbr>Destroyed</h3> <ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> isDestroyed<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from <a href="_models_dialog_.dialog.html">Dialog</a>.<a href="_models_dialog_.dialog.html#isdestroyed">isDestroyed</a></p> <ul> <li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/Dialog.ts#L139">models/Dialog.ts:139</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Returns whether or not this Form is destroyed</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"> <a name="isreadmode" class="tsd-anchor"></a> <h3>is<wbr>Read<wbr>Mode</h3> <ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> isReadMode<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</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/EditorDialog.ts#L137">models/EditorDialog.ts:137</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Returns whether or not this Editor is in &#39;read&#39; mode</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"> <a name="isreadviewmode" class="tsd-anchor"></a> <h3>is<wbr>Read<wbr>View<wbr>Mode</h3> <ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> isReadViewMode<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from <a href="_models_dialog_.dialog.html">Dialog</a>.<a href="_models_dialog_.dialog.html#isreadviewmode">isReadViewMode</a></p> <ul> <li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/Dialog.ts#L151">models/Dialog.ts:151</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"> <a name="isrefreshneeded" class="tsd-anchor"></a> <h3>is<wbr>Refresh<wbr>Needed</h3> <ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> isRefreshNeeded<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from <a href="_models_dialog_.dialog.html">Dialog</a>.<a href="_models_dialog_.dialog.html#isrefreshneeded">isRefreshNeeded</a></p> <ul> <li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/Dialog.ts#L147">models/Dialog.ts:147</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Returns whether or not the data in this dialog is out of date</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"> <a name="iswritemode" class="tsd-anchor"></a> <h3>is<wbr>Write<wbr>Mode</h3> <ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> isWriteMode<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</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/EditorDialog.ts#L168">models/EditorDialog.ts:168</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Returns whether or not this property is &#39;writable&#39;</p> </div>