The DataImport widget allows the user to import data records into the app backend. The import file can be dragged and dropped into the widget.


  • UI Type:

Extends: BaseWidget

Properties

Name Desciption
Button TextThe text for the button that opens the DataImport Popup.
DisabledThe widget cannot be used.
HiddenHides the widget from the user.
ModelThe model that is used for the imported data.
Popup Header TextDisplay a Header Text on DataImport Popup.
Popup Subheader TextDisplay a Sub-Header Text on DataImport Popup.
Save ImportIf true, saves a record of the imported data.
Tab IndexThe Tab Index is an integer that tells the order of the widget when using the tab-key to move from one widget to another.

Style

Name Desciption
Accent color for DialogThe accent color used as background color for the title area in the dialog.
Background-colorChange background color of the widget.
ColorColor of the text inside the widgets. May not apply to all text inside all widgets.
Font SizeSet the font size in pixels for text.
Text color on dialog stripThe text color in the title area of the dialog box.
Text-alignmentSet left, centered or right. Applies both to icon and text.

Events

Name Description Event Attribute
Blur Event when a widget goes out of focus.
event The event that gets triggered when the user "leaves" an element.
Click Event that triggers based on touch or click.
event The event that triggered the handler.
DblClick Event that triggers based on double click.
event The event that triggered the handler.
Focus Event when indicating/ highlighting widget using the cursor.
event Focus is the event that gets triggered when a user makes an element come into focus, by clicking on it.
ImportReady Triggered when objects of records for the import is in ready state.
event Object containing the records (event.records) from the import.
UpdateExcelRow Triggered when objects of records for the import is updated.
row Object containing the row values from the import.

Function

setModel ( modelName: String , relationMappings: Object )

Sets the model used by the DataImport

Parameters
Name Type Description
modelName String The name of the new model.
relationMappings Object An object containing relation mappings to use.

blur ( )

Triggers the blur event.

focus ( )

Triggers the focus event.

get ( name: String ) { Object }

Gets the value of the specified property.

Parameters
Name Type Description
name String The name of the property.
Returns

The property's value.

getId ( ) { ID }

Returns the ID of the widget.

Returns

The ID of the widget

getValue ( ) { Object }

Returns the widget's value.

Returns

The widget's value.

hide ( )

Hides the widget.

isEnabled ( ) { Boolean }

Returns true if the widget is enabled.

Returns

True if enabled, otherwise false.

isHidden ( ) { Boolean }

Returns true if the widget is hidden.

Returns

True if hidden, otherwise false.

set ( name: String , value: Object )

Sets the value of the specified property.

Parameters
Name Type Description
name String The name of the property.
value Object The new value.

setEnabled ( Enabled: Boolean )

Enables/disables the widget.

Parameters
Name Type Description
Enabled Boolean True to enable the widget, false to disable.

setStyle ( Object: Object )

Set the widget-style

Parameters
Name Type Description
Object Object properties

setValue ( value: Object )

Sets the widget's value.

Parameters
Name Type Description
value Object The new value.

show ( )

Shows the widget.