UNPKG

com.phloxui

Version:

PhloxUI Ng2+ Framework

692 lines 47.8 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>IHasData | com.phloxui</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">com.phloxui</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/_component_ihasdata_.html">&quot;component/IHasData&quot;</a> </li> <li> <a href="_component_ihasdata_.ihasdata.html">IHasData</a> </li> </ul> <h1>Interface IHasData</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 style="text-indent: 2em;"> An interface class of a component which has <code>data</code> or can bind <code>data</code> with. All classes implementing this interface must provide the <code>data mechanism</code> to the user. A single <code>data parent</code> may have one or more <code>data children</code>. When parent&#39;s data is changed, the parent will propogate the data change to all of its children. The method <a href="_component_ihasdata_.ihasdata.html#isdatadirty">isDataDirty</a> provides you the way to check that the data has been edited from its original state or not. This mechanism is very useful when you&#39;re developing an application which allows the user to edit data before save. When the user is leaving the page with unsaved data, the application may notify a warning message asking the user to save the data before leaving. Imagine that if your page contains a numerous of input components, by using the <code>data mechanism</code> provided by this interface, you can easily register those input components as page&#39;s <code>data children</code>. And, when you want to check that the user can leave this page or not, you just use the method <a href="_component_ihasdata_.ihasdata.html#isdatadirty">isDataDirty</a> on page component, it will automatically check the data dirty state on all of its <code>data children</code>. </p> </div> <dl class="tsd-comment-tags"> <dt>author</dt> <dd><p>shiorin, tee4cute</p> </dd> <dt>see</dt> <dd><p><a href="../classes/_component_abstracthasdata_.abstracthasdata.html">AbstractHasData</a></p> </dd> </dl> </div> </section> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">IHasData</span> <ul class="tsd-hierarchy"> <li> <a href="_component_dataview_idataview_.idataview.html" class="tsd-signature-type">IDataView</a> </li> <li> <a href="_component_editor_icalendarentrypopovercontent_.icalendarentrypopovercontent.html" class="tsd-signature-type">ICalendarEntryPopoverContent</a> </li> </ul> </li> </ul> </section> <section class="tsd-panel"> <h3>Implemented by</h3> <ul class="tsd-hierarchy"> <li><a href="../classes/_component_dataview_input_abstracfileselector_.abstracfileselector.html" class="tsd-signature-type">AbstracFileSelector</a></li> <li><a href="../classes/_component_dataview_abstractaccordion_.abstractaccordion.html" class="tsd-signature-type">AbstractAccordion</a></li> <li><a href="../classes/_component_dataview_abstractcomponentdatalangselector_.abstractcomponentdatalangselector.html" class="tsd-signature-type">AbstractComponentDataLangSelector</a></li> <li><a href="../classes/_component_editor_abstractdataeditorview_.abstractdataeditorview.html" class="tsd-signature-type">AbstractDataEditorView</a></li> <li><a href="../classes/_component_dataview_abstractdatalangselector_.abstractdatalangselector.html" class="tsd-signature-type">AbstractDataLangSelector</a></li> <li><a href="../classes/_component_dataview_abstractdataview_.abstractdataview.html" class="tsd-signature-type">AbstractDataView</a></li> <li><a href="../classes/_component_dataview_input_abstractdatetimepicker_.abstractdatetimepicker.html" class="tsd-signature-type">AbstractDateTimePicker</a></li> <li><a href="../classes/_component_abstractdialogcontroller_.abstractdialogcontroller.html" class="tsd-signature-type">AbstractDialogController</a></li> <li><a href="../classes/_component_dataview_abstractfloatingheaderpanel_.abstractfloatingheaderpanel.html" class="tsd-signature-type">AbstractFloatingHeaderPanel</a></li> <li><a href="../classes/_component_abstracthasdata_.abstracthasdata.html" class="tsd-signature-type">AbstractHasData</a></li> <li><a href="../classes/_component_abstracthasdatahelp_.abstracthasdatahelp.html" class="tsd-signature-type">AbstractHasDataHelp</a></li> <li><a href="../classes/_component_dataview_abstracthasformatterdataview_.abstracthasformatterdataview.html" class="tsd-signature-type">AbstractHasFormatterDataView</a></li> <li><a href="../classes/_component_dataview_input_abstracthasformatterinputdataview_.abstracthasformatterinputdataview.html" class="tsd-signature-type">AbstractHasFormatterInputDataView</a></li> <li><a href="../classes/_component_dataview_input_abstractinputdataview_.abstractinputdataview.html" class="tsd-signature-type">AbstractInputDataView</a></li> <li><a href="../classes/_component_dataview_input_abstractmultidropdown_.abstractmultidropdown.html" class="tsd-signature-type">AbstractMultiDropdown</a></li> <li><a href="../classes/_component_dataview_input_abstractselectitems_.abstractselectitems.html" class="tsd-signature-type">AbstractSelectItems</a></li> <li><a href="../classes/_component_dataview_input_abstractselectoneitem_.abstractselectoneitem.html" class="tsd-signature-type">AbstractSelectOneItem</a></li> <li><a href="../classes/_component_dataview_input_abstractsimpledropdown_.abstractsimpledropdown.html" class="tsd-signature-type">AbstractSimpleDropdown</a></li> <li><a href="../classes/_component_table_abstracttablecomponent_.abstracttablecomponent.html" class="tsd-signature-type">AbstractTableComponent</a></li> <li><a href="../classes/_component_dataview_input_abstracttoggle_.abstracttoggle.html" class="tsd-signature-type">AbstractToggle</a></li> <li><a href="../classes/_component_dataview_abstractwizardpane_.abstractwizardpane.html" class="tsd-signature-type">AbstractWizardPane</a></li> <li><a href="../classes/_component_editor_editor_internal_calendar_internal_calendarentrypopover_component_.calendarentrypopover.html" class="tsd-signature-type">CalendarEntryPopover</a></li> <li><a href="../classes/_component_editor_calendarentrywrapper_.calendarentrywrapper.html" class="tsd-signature-type">CalendarEntryWrapper</a></li> <li><a href="../classes/_component_editor_editor_internal_calendarview_component_.calendarview.html" class="tsd-signature-type">CalendarView</a></li> <li><a href="../classes/_component_dataview_input_checkbox_component_.checkbox.html" class="tsd-signature-type">CheckBox</a></li> <li><a href="../classes/_component_dataview_input_colordropdownlist_component_.colordropdownlist.html" class="tsd-signature-type">ColorDropdownList</a></li> <li><a href="../classes/_component_dataview_input_colorswatch_component_.colorswatch.html" class="tsd-signature-type">ColorSwatch</a></li> <li><a href="../classes/_component_editor_editor_internal_record_internal_columndisplay_component_.columndisplay.html" class="tsd-signature-type">ColumnDisplay</a></li> <li><a href="../classes/_component_editor_editor_internal_record_internal_columnsorting_component_.columnsorting.html" class="tsd-signature-type">ColumnSorting</a></li> <li><a href="../classes/_component_dataview_componentaccordion_component_.componentaccordion.html" class="tsd-signature-type">ComponentAccordion</a></li> <li><a href="../classes/_component_dataview_componentdatalangselector_component_.componentdatalangselector.html" class="tsd-signature-type">ComponentDataLangSelector</a></li> <li><a href="../classes/_component_dialog_internal_componentdialog_component_.componentdialog.html" class="tsd-signature-type">ComponentDialog</a></li> <li><a href="../classes/_component_dataview_input_componentdropdownlist_component_.componentdropdownlist.html" class="tsd-signature-type">ComponentDropdownList</a></li> <li><a href="../classes/_component_dataview_componentfloatingheaderpanel_component_.componentfloatingheaderpanel.html" class="tsd-signature-type">ComponentFloatingHeaderPanel</a></li> <li><a href="../classes/_component_componentpopover_component_.componentpopover.html" class="tsd-signature-type">ComponentPopover</a></li> <li><a href="../classes/_component_dataview_input_componentradiobuttons_component_.componentradiobuttons.html" class="tsd-signature-type">ComponentRadioButtons</a></li> <li><a href="../classes/_component_dataview_componentslidepane_component_.componentslidepane.html" class="tsd-signature-type">ComponentSlidePane</a></li> <li><a href="../classes/_component_componentwrapper_component_.componentwrapper.html" class="tsd-signature-type">ComponentWrapper</a></li> <li><a href="../classes/_component_dialog_internal_confirmdialog_component_.confirmdialog.html" class="tsd-signature-type">ConfirmDialog</a></li> <li><a href="../classes/_component_contextmenubutton_component_.contextmenubutton.html" class="tsd-signature-type">ContextMenuButton</a></li> <li><a href="../classes/_component_dataview_input_datepicker_component_.datepicker.html" class="tsd-signature-type">DatePicker</a></li> <li><a href="../classes/_component_editor_defaultcalendarentrylistpopover_component_.defaultcalendarentrylistpopover.html" class="tsd-signature-type">DefaultCalendarEntryListPopover</a></li> <li><a href="../classes/_component_editor_defaultcalendarentrypopover_component_.defaultcalendarentrypopover.html" class="tsd-signature-type">DefaultCalendarEntryPopover</a></li> <li><a href="../classes/_component_editor_defaultcomponentcalendarentry_component_.defaultcomponentcalendarentry.html" class="tsd-signature-type">DefaultComponentCalendarEntry</a></li> <li><a href="../classes/_component_editor_defaultentryeditorpopover_component_.defaultentryeditorpopover.html" class="tsd-signature-type">DefaultEntryEditorPopover</a></li> <li><a href="../classes/_component_table_defaultexpandtablebody_component_.defaultexpandtablebody.html" class="tsd-signature-type">DefaultExpandTableBody</a></li> <li><a href="../classes/_component_table_defaulttablebody_component_.defaulttablebody.html" class="tsd-signature-type">DefaultTableBody</a></li> <li><a href="../classes/_component_table_defaulttableheader_component_.defaulttableheader.html" class="tsd-signature-type">DefaultTableHeader</a></li> <li><a href="../classes/_component_table_defaulttablerow_component_.defaulttablerow.html" class="tsd-signature-type">DefaultTableRow</a></li> <li><a href="../classes/_component_ellipsisbutton_component_.ellipsisbutton.html" class="tsd-signature-type">EllipsisButton</a></li> <li><a href="../classes/_component_table_expandabletableheader_component_.expandabletableheader.html" class="tsd-signature-type">ExpandableTableHeader</a></li> <li><a href="../classes/_component_table_expandabletablerow_component_.expandabletablerow.html" class="tsd-signature-type">ExpandableTableRow</a></li> <li><a href="../classes/_component_dataview_input_fileselector_component_.fileselector.html" class="tsd-signature-type">FileSelector</a></li> <li><a href="../classes/_component_editor_editor_internal_formview_component_.formview.html" class="tsd-signature-type">FormView</a></li> <li><a href="../classes/_component_dataview_functiondataview_component_.functiondataview.html" class="tsd-signature-type">FunctionDataView</a></li> <li><a href="../classes/_component_dataview_input_linksimpledropdownlist_component_.linksimpledropdownlist.html" class="tsd-signature-type">LinkSimpleDropdownList</a></li> <li><a href="../classes/_theme_material_component_dataview_input_materialautocomplete_component_.materialautocomplete.html" class="tsd-signature-type">MaterialAutocomplete</a></li> <li><a href="../classes/_theme_material_component_dataview_input_materialbutton_component_.materialbutton.html" class="tsd-signature-type">MaterialButton</a></li> <li><a href="../classes/_theme_material_component_dataview_input_materialcheckbox_component_.materialcheckbox.html" class="tsd-signature-type">MaterialCheckBox</a></li> <li><a href="../classes/_theme_material_component_dataview_materialcomponentdatalangselector_component_.materialcomponentdatalangselector.html" class="tsd-signature-type">MaterialComponentDataLangSelector</a></li> <li><a href="../classes/_theme_material_component_dataview_input_materialcomponentdropdownlist_component_.materialcomponentdropdownlist.html" class="tsd-signature-type">MaterialComponentDropdownList</a></li> <li><a href="../classes/_theme_material_component_dataview_input_materialcomponentmultidropdownlist_component_.materialcomponentmultidropdownlist.html" class="tsd-signature-type">MaterialComponentMultiDropdownList</a></li> <li><a href="../classes/_theme_material_component_dataview_input_materialdatepicker_component_.materialdatepicker.html" class="tsd-signature-type">MaterialDatePicker</a></li> <li><a href="../classes/_theme_material_component_dataview_input_materialfileselector_component_.materialfileselector.html" class="tsd-signature-type">MaterialFileSelector</a></li> <li><a href="../classes/_theme_material_component_dataview_input_materialimageselector_component_.materialimageselector.html" class="tsd-signature-type">MaterialImageSelector</a></li> <li><a href="../classes/_theme_material_component_dataview_input_materialradiobuttons_component_.materialradiobuttons.html" class="tsd-signature-type">MaterialRadioButtons</a></li> <li><a href="../classes/_theme_material_component_dataview_input_materialsearchmultidropdownlist_component_.materialsearchmultidropdownlist.html" class="tsd-signature-type">MaterialSearchMultiDropdownList</a></li> <li><a href="../classes/_theme_material_component_dataview_input_materialsimpledropdownlist_component_.materialsimpledropdownlist.html" class="tsd-signature-type">MaterialSimpleDropdownList</a></li> <li><a href="../classes/_theme_material_component_dataview_input_materialsimplemultidropdownlist_component_.materialsimplemultidropdownlist.html" class="tsd-signature-type">MaterialSimpleMultiDropdownList</a></li> <li><a href="../classes/_theme_material_component_dataview_input_materialslider_component_.materialslider.html" class="tsd-signature-type">MaterialSlider</a></li> <li><a href="../classes/_theme_material_component_dataview_input_materialtelnotextbox_component_.materialtelnotextbox.html" class="tsd-signature-type">MaterialTelNoTextBox</a></li> <li><a href="../classes/_theme_material_component_dataview_input_materialtextarea_component_.materialtextarea.html" class="tsd-signature-type">MaterialTextArea</a></li> <li><a href="../classes/_theme_material_component_dataview_input_materialtextbox_component_.materialtextbox.html" class="tsd-signature-type">MaterialTextBox</a></li> <li><a href="../classes/_theme_material_component_dataview_input_materialtimepicker_component_.materialtimepicker.html" class="tsd-signature-type">MaterialTimePicker</a></li> <li><a href="../classes/_theme_material_component_dataview_input_materialtoggleselectitems_component_.materialtoggleselectitems.html" class="tsd-signature-type">MaterialToggleSelectItems</a></li> <li><a href="../classes/_theme_material_component_dataview_input_materialtoggleselectitems_component_.materialtoggleselectitems.html" class="tsd-signature-type">MaterialToggleSelectItems</a></li> <li><a href="../classes/_theme_material_component_dataview_input_materialtoggleswitch_component_.materialtoggleswitch.html" class="tsd-signature-type">MaterialToggleSwitch</a></li> <li><a href="../classes/_component_dialog_internal_messagedialog_component_.messagedialog.html" class="tsd-signature-type">MessageDialog</a></li> <li><a href="../classes/_component_dataview_input_multiplestatecheckbox_component_.multiplestatecheckbox.html" class="tsd-signature-type">MultipleStateCheckBox</a></li> <li><a href="../classes/_component_dataview_paginationwizardpane_component_.paginationwizardpane.html" class="tsd-signature-type">PaginationWizardPane</a></li> <li><a href="../classes/_component_dataview_phloxchart_component_.phloxchart.html" class="tsd-signature-type">PhloxChart</a></li> <li><a href="../classes/_component_table_phloxtable_component_.phloxtable.html" class="tsd-signature-type">PhloxTable</a></li> <li><a href="../classes/_component_editor_editor_internal_recordview_component_.recordview.html" class="tsd-signature-type">RecordView</a></li> <li><a href="../classes/_component_dataview_scrollpaginationwizardpane_component_.scrollpaginationwizardpane.html" class="tsd-signature-type">ScrollPaginationWizardPane</a></li> <li><a href="../classes/_component_dataview_scrollwizardpane_component_.scrollwizardpane.html" class="tsd-signature-type">ScrollWizardPane</a></li> <li><a href="../classes/_component_dataview_input_searchmultidropdownlist_component_.searchmultidropdownlist.html" class="tsd-signature-type">SearchMultiDropdownList</a></li> <li><a href="../classes/_component_dataview_input_simpledropdownlist_component_.simpledropdownlist.html" class="tsd-signature-type">SimpleDropdownList</a></li> <li><a href="../classes/_component_simplelistpane_component_.simplelistpane.html" class="tsd-signature-type">SimpleListPane</a></li> <li><a href="../classes/_component_simplelistpane_component_.simplelistpane.html" class="tsd-signature-type">SimpleListPane</a></li> <li><a href="../classes/_component_dataview_input_simplemultidropdownlist_component_.simplemultidropdownlist.html" class="tsd-signature-type">SimpleMultiDropdownList</a></li> <li><a href="../classes/_component_dataview_input_simpleradiobuttons_component_.simpleradiobuttons.html" class="tsd-signature-type">SimpleRadioButtons</a></li> <li><a href="../classes/_component_dataview_stringdataview_component_.stringdataview.html" class="tsd-signature-type">StringDataView</a></li> <li><a href="../classes/_component_dataview_tab_internal_tab_component_.tab.html" class="tsd-signature-type">Tab</a></li> <li><a href="../classes/_component_dataview_tabpane_component_.tabpane.html" class="tsd-signature-type">TabPane</a></li> <li><a href="../classes/_component_dataview_input_textarea_component_.textarea.html" class="tsd-signature-type">TextArea</a></li> <li><a href="../classes/_component_dataview_input_textbox_component_.textbox.html" class="tsd-signature-type">TextBox</a></li> <li><a href="../classes/_component_dataview_input_themecolorswatch_component_.themecolorswatch.html" class="tsd-signature-type">ThemeColorSwatch</a></li> <li><a href="../classes/_component_dataview_input_timepicker_component_.timepicker.html" class="tsd-signature-type">TimePicker</a></li> <li><a href="../classes/_component_toastnotification_component_.toastnotification.html" class="tsd-signature-type">ToastNotification</a></li> <li><a href="../classes/_component_dataview_input_toggleswitch_component_.toggleswitch.html" class="tsd-signature-type">ToggleSwitch</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>Methods</h3> <ul class="tsd-index-list"> <li class="tsd-kind-method tsd-parent-kind-interface"><a href="_component_ihasdata_.ihasdata.html#adddatachild" class="tsd-kind-icon">add<wbr>Data<wbr>Child</a></li> <li class="tsd-kind-method tsd-parent-kind-interface"><a href="_component_ihasdata_.ihasdata.html#getdata" class="tsd-kind-icon">get<wbr>Data</a></li> <li class="tsd-kind-method tsd-parent-kind-interface"><a href="_component_ihasdata_.ihasdata.html#getdatachildren" class="tsd-kind-icon">get<wbr>Data<wbr>Children</a></li> <li class="tsd-kind-method tsd-parent-kind-interface"><a href="_component_ihasdata_.ihasdata.html#getdataparent" class="tsd-kind-icon">get<wbr>Data<wbr>Parent</a></li> <li class="tsd-kind-method tsd-parent-kind-interface"><a href="_component_ihasdata_.ihasdata.html#isdatadirty" class="tsd-kind-icon">is<wbr>Data<wbr>Dirty</a></li> <li class="tsd-kind-method tsd-parent-kind-interface"><a href="_component_ihasdata_.ihasdata.html#isignoreparentdata" class="tsd-kind-icon">is<wbr>Ignore<wbr>Parent<wbr>Data</a></li> <li class="tsd-kind-method tsd-parent-kind-interface"><a href="_component_ihasdata_.ihasdata.html#removedatachild" class="tsd-kind-icon">remove<wbr>Data<wbr>Child</a></li> <li class="tsd-kind-method tsd-parent-kind-interface"><a href="_component_ihasdata_.ihasdata.html#resetdata" class="tsd-kind-icon">reset<wbr>Data</a></li> <li class="tsd-kind-method tsd-parent-kind-interface"><a href="_component_ihasdata_.ihasdata.html#savedata" class="tsd-kind-icon">save<wbr>Data</a></li> <li class="tsd-kind-method tsd-parent-kind-interface"><a href="_component_ihasdata_.ihasdata.html#setdata" class="tsd-kind-icon">set<wbr>Data</a></li> <li class="tsd-kind-method tsd-parent-kind-interface"><a href="_component_ihasdata_.ihasdata.html#setdataparent" class="tsd-kind-icon">set<wbr>Data<wbr>Parent</a></li> <li class="tsd-kind-method tsd-parent-kind-interface"><a href="_component_ihasdata_.ihasdata.html#setignoreparentdata" class="tsd-kind-icon">set<wbr>Ignore<wbr>Parent<wbr>Data</a></li> </ul> </section> </div> </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-interface"> <a name="adddatachild" class="tsd-anchor"></a> <h3>add<wbr>Data<wbr>Child</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"> <li class="tsd-signature tsd-kind-icon">add<wbr>Data<wbr>Child<span class="tsd-signature-symbol">(</span>child<span class="tsd-signature-symbol">: </span><a href="_component_ihasdata_.ihasdata.html" class="tsd-signature-type">IHasData</a><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 component/IHasData.ts:35</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Add a <code>data <b>child</b></code> into <code>this</code> component.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>child: <a href="_component_ihasdata_.ihasdata.html" class="tsd-signature-type">IHasData</a></h5> <div class="tsd-comment tsd-typography"> <p>A <code>data child</code> component to be added.</p> </div> </li> </ul> <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-interface"> <a name="getdata" class="tsd-anchor"></a> <h3>get<wbr>Data</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"> <li class="tsd-signature tsd-kind-icon">get<wbr>Data<span class="tsd-signature-symbol">(</span><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 component/IHasData.ts:21</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Get the <code>data</code> object bound to <code>this</code> component.</p> </div> </div> <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-interface"> <a name="getdatachildren" class="tsd-anchor"></a> <h3>get<wbr>Data<wbr>Children</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"> <li class="tsd-signature tsd-kind-icon">get<wbr>Data<wbr>Children<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_component_ihasdata_.ihasdata.html" class="tsd-signature-type">IHasData</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 component/IHasData.ts:61</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Get the array of <code>data children</code> of <code>this</code> component. This method will return <code>empty array</code> if there is no any <code>data child</code> of <code>this</code> component.</p> </div> </div> <h4 class="tsd-returns-title">Returns <a href="_component_ihasdata_.ihasdata.html" class="tsd-signature-type">IHasData</a><span class="tsd-signature-symbol">[]</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"> <a name="getdataparent" class="tsd-anchor"></a> <h3>get<wbr>Data<wbr>Parent</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"> <li class="tsd-signature tsd-kind-icon">get<wbr>Data<wbr>Parent<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_component_ihasdata_.ihasdata.html" class="tsd-signature-type">IHasData</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in component/IHasData.ts:55</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Get the <code>data parent</code> of <code>this</code> component. This method can return <code>null</code> if <code>this</code> component has no <code>data parent</code>.</p> </div> </div> <h4 class="tsd-returns-title">Returns <a href="_component_ihasdata_.ihasdata.html" class="tsd-signature-type">IHasData</a></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"> <a name="isdatadirty" class="tsd-anchor"></a> <h3>is<wbr>Data<wbr>Dirty</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"> <li class="tsd-signature tsd-kind-icon">is<wbr>Data<wbr>Dirty<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 component/IHasData.ts:67</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>To check that the <code>data</code> bound to <code>this</code> component is dirty or not. The <code>data</code> will be marked as dirty if it is changed from its original state.</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-method tsd-parent-kind-interface"> <a name="isignoreparentdata" class="tsd-anchor"></a> <h3>is<wbr>Ignore<wbr>Parent<wbr>Data</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"> <li class="tsd-signature tsd-kind-icon">is<wbr>Ignore<wbr>Parent<wbr>Data<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 component/IHasData.ts:72</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>To check that <code>this</code> component will ignore data propagated from <code>data parent</code> or not.</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-method tsd-parent-kind-interface"> <a name="removedatachild" class="tsd-anchor"></a> <h3>remove<wbr>Data<wbr>Child</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"> <li class="tsd-signature tsd-kind-icon">remove<wbr>Data<wbr>Child<span class="tsd-signature-symbol">(</span>child<span class="tsd-signature-symbol">: </span><a href="_component_ihasdata_.ihasdata.html" class="tsd-signature-type">IHasData</a><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 component/IHasData.ts:42</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Remove the given <code>data <b>child</b></code> from <code>this</code> component.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>child: <a href="_component_ihasdata_.ihasdata.html" class="tsd-signature-type">IHasData</a></h5> <div class="tsd-comment tsd-typography"> <p>A <code>data child</code> component to be removed.</p> </div> </li> </ul> <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-interface"> <a name="resetdata" class="tsd-anchor"></a> <h3>reset<wbr>Data</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"> <li class="tsd-signature tsd-kind-icon">reset<wbr>Data<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 component/IHasData.ts:89</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>To reset <code>data</code> that bound to <code>this</code> component.</p> </div> </div> <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-interface"> <a name="savedata" class="tsd-anchor"></a> <h3>save<wbr>Data</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"> <li class="tsd-signature tsd-kind-icon">save<wbr>Data<span class="tsd-signature-symbol">(</span>data<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">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in component/IHasData.ts:84</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>To save <code>data</code> that bound to <code>this</code> component.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> data: <span class="tsd-signature-type">any</span></h5> </li> </ul> <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-interface"> <a name="setdata" class="tsd-anchor"></a> <h3>set<wbr>Data</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"> <li class="tsd-signature tsd-kind-icon">set<wbr>Data<span class="tsd-signature-symbol">(</span>data<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">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in component/IHasData.ts:28</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Set and bind <code><b>data</b></code> into <code>this</code> component.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>data: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"> <p>The data object to set.</p> </div> </li> </ul> <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-interface"> <a name="setdataparent" class="tsd-anchor"></a> <h3>set<wbr>Data<wbr>Parent</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"> <li class="tsd-signature tsd-kind-icon">set<wbr>Data<wbr>Parent<span class="tsd-signature-symbol">(</span>parent<span class="tsd-signature-symbol">: </span><a href="_component_ihasdata_.ihasdata.html" class="tsd-signature-type">IHasData</a><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 component/IHasData.ts:49</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Set a <code>data parent</code> into <code>this</code> component.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>parent: <a href="_component_ihasdata_.ihasdata.html" class="tsd-signature-type">IHasData</a></h5> <div class="tsd-comment tsd-typography"> <p>A <code>data parent</code> component to be set.</p> </div> </li> </ul> <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-interface"> <a name="setignoreparentdata" class="tsd-anchor"></a> <h3>set<wbr>Ignore<wbr>Parent<wbr>Data</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"> <li class="tsd-signature tsd-kind-icon">set<wbr>Ignore<wbr>Parent<wbr>Data<span class="tsd-signature-symbol">(</span>ignore<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</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 component/IHasData.ts:79</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Set a flag indicating that <code>this</code> component will ignore data propagated from <code>data parent</code> or not.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>ignore: <span class="tsd-signature-type">boolean</span></h5> <div class="tsd-comment tsd-typography"> <p>A flag indicating that <code>this</code> component will ignore data propagated from <code>data parent</code> or not.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></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/_component_ihasdata_.html">"component/IHas<wbr>Data"</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> </ul> <ul class="current"> <li class="current tsd-kind-interface tsd-parent-kind-external-module"> <a href="_component_ihasdata_.ihasdata.html" class="tsd-kind-icon">IHas<wbr>Data</a> <ul> <li class=" tsd-kind-method tsd-parent-kind-interface"> <a href="_component_ihasdata_.ihasdata.html#adddatachild" class="tsd-kind-icon">add<wbr>Data<wbr>Child</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface"> <a href="_component_ihasdata_.ihasdata.html#getdata" class="tsd-kind-icon">get<wbr>Data</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface"> <a href="_component_ihasdata_.ihasdata.html#getdatachildren" class="tsd-kind-icon">get<wbr>Data<wbr>Children</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface"> <a href="_component_ihasdata_.ihasdata.html#getdataparent" class="tsd-kind-icon">get<wbr>Data<wbr>Parent</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface"> <a href="_component_ihasdata_.ihasdata.html#isdatadirty" class="tsd-kind-icon">is<wbr>Data<wbr>Dirty</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface"> <a href="_component_ihasdata_.ihasdata.html#isignoreparentdata" class="tsd-kind-icon">is<wbr>Ignore<wbr>Parent<wbr>Data</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface"> <a href="_component_ihasdata_.ihasdata.html#removedatachild" class="tsd-kind-icon">remove<wbr>Data<wbr>Child</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface"> <a href="_component_ihasdata_.ihasdata.html#resetdata" class="tsd-kind-icon">reset<wbr>Data</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface"> <a href="_component_ihasdata_.ihasdata.html#savedata" class="tsd-kind-icon">save<wbr>Data</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface"> <a href="_component_ihasdata_.ihasdata.html#setdata" class="tsd-kind-icon">set<wbr>Data</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface"> <a href="_component_ihasdata_.ihasdata.html#setdataparent" class="tsd-kind-icon">set<wbr>Data<wbr>Parent</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface"> <a href="_component_ihasdata_.ihasdata.html#setignoreparentdata" class="tsd-kind-icon">set<wbr>Ignore<wbr>Parent<wbr>Data</a> </li> </ul> </li> </ul> <ul class="after-current"> </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>