Class: UI

Methods

(static) alert(message, windowTitleopt)

Show a notification dialog

Parameters:

Name	Type	Attributes	Description
`message`	string
`windowTitle`	string	<optional>

(static) choose(objects, message, windowTitleopt, stringFunctionopt) → {any|undefined}

Let the user choose an object from a list

Parameters:

Name	Type	Attributes	Description
`objects`	Array.<any>
`message`	string
`windowTitle`	string	<optional>
`stringFunction`	function	<optional>	Function that returns a string that should be displayed for an element

Returns:

The selected element or undefined if no UI is available or the dialog was canceled

Type:: any | undefined

(static) chooseExpanded(elements, messageopt) → {Array.<$k.SemanticElement>|undefined}

Let the user choose some semantic elements from a list. Shows details of the objects.

Parameters:

Name	Type	Attributes	Description
`elements`	Array.<$k.SemanticElement>
`message`	string	<optional>

Returns:

Returns undefined if no UI is available or the dialog was canceled

Type:: Array.<$k.SemanticElement> | undefined

(static) chooseMultiple(objects, message, windowTitleopt, stringFunctionopt) → {Array.<any>|undefined}

Let the user choose some objects from a list.

Parameters:

Name	Type	Attributes	Description
`objects`	Array.<any>
`message`	string
`windowTitle`	string	<optional>
`stringFunction`	function	<optional>	Function that returns a string that should be displayed for an element

Returns:

Returns undefined if no UI is available or the dialog was canceled

Type:: Array.<any> | undefined

(static) confirm(message, windowTitleopt) → {boolean|undefined}

Show a confirmation dialog

Parameters:

Name	Type	Attributes	Description
`message`	string
`windowTitle`	string	<optional>

Returns:

True if confirmed, false if not. Returns undefined if no UI is available.

Type:: boolean | undefined

(static) hasUI() → {boolean}

True if UI interaction is possible

Since: 5.2.1

Returns:

Type:: boolean

(static) notificationDialog(notificationFunction, parametersopt, windowTitleopt)

Open a notification dialog that stays open while the notification function is evaluated

Parameters:

Name Type Attributes Description

notificationFunction

function

Notification function

parameters

object

Properties

Name	Type	Attributes	Default	Description
`autoExpand`	boolean	<optional>	false
`canCancel`	boolean	<optional>	true	Set to false to disallow cancelling the dialog
`stayOpen`	boolean	<optional>	false	Keep the dialog open after the function finishes. If set to true, the dialog must be manually closed.

windowTitle string <optional>

Since: 4.1.0
See: $k.UI#raiseNotification

(static) openEditor(element, contextopt, optionsopt)

Opens an editor on the element

Parameters:

Name Type Attributes Description

element $k.SemanticElement

context

$k.SemanticElement | $k.ViewConfiguration

Context that should be used to detect the view configuration, or a view configuration

options

object

Properties

Name	Type	Description
`isNew`	boolean

(static) openGraph(elements, graphConfigopt)

Opens a graph on the elements

Parameters:

Name	Type	Attributes	Description
`elements`	Array.<$k.SemanticElement> \| Array.<$k.Hit>		Graph elements or hits
`graphConfig`	$k.GraphConfiguration	<optional>	Graph configuration

Since: 5.3.2

(static) openTable(elements, domainopt, contextopt)

Opens a table on the elements

Parameters:

Name	Type	Attributes	Description
`elements`	Array.<$k.SemanticElement> \| Array.<$k.Hit>		Table elements or hits
`domain`	$k.Domain \| string	<optional>	Domain or internal name of a type of the table
`context`	$k.SemanticElement \| $k.TableConfiguration	<optional>	Context that should be used to detect the table configuration, or a table configuration

Since: 4.2.1

(static) openURL(url)

Opens the URL with the associated application

Parameters:

Name	Type	Description
`url`	string

Since: 5.2.2

(static) raiseNotification(string)

Raise message notification (to use in function $k.UI#notificationDialog)

Parameters:

Name	Type	Description
`string`	string

Since: 4.1.0
See: $k.UI#notificationDialog

(static) requestString(message, windowTitleopt, initialAnsweropt) → {string|undefined}

Let the user enter a string in a single-line input field

Parameters:

Name	Type	Attributes
`message`	string
`windowTitle`	string	<optional>
`initialAnswer`	string	<optional>

Returns:

Returns undefined if no UI is available or the dialog was canceled

Type:: string | undefined

(static) saveFile(blobOrNetEntity, windowTitleopt)

Requests a filename and writes the given blob or net entity to the file.

Parameters:

Name	Type	Attributes	Description
`blobOrNetEntity`	$k.Blob \| $k.NetEntity
`windowTitle`	string	<optional>

Version: Experimental feature, might be removed at any time
Since: 5.3.2

alert(message, windowTitleopt)

Show a notification dialog

Parameters:

Name	Type	Attributes	Description
`message`	string
`windowTitle`	string	<optional>

choose(objects, message, windowTitleopt, stringFunctionopt) → {any|undefined}

Let the user choose an object from a list

Parameters:

Name	Type	Attributes	Description
`objects`	Array.<any>
`message`	string
`windowTitle`	string	<optional>
`stringFunction`	function	<optional>	Function that returns a string that should be displayed for an element

Returns:

The selected element or undefined if no UI is available or the dialog was canceled

Type:: any | undefined

chooseExpanded(elements, messageopt) → {Array.<$k.SemanticElement>|undefined}

Let the user choose some semantic elements from a list. Shows details of the objects.

Parameters:

Name	Type	Attributes	Description
`elements`	Array.<$k.SemanticElement>
`message`	string	<optional>

Returns:

Returns undefined if no UI is available or the dialog was canceled

Type:: Array.<$k.SemanticElement> | undefined

chooseMultiple(objects, message, windowTitleopt, stringFunctionopt) → {Array.<any>|undefined}

Let the user choose some objects from a list.

Parameters:

Name	Type	Attributes	Description
`objects`	Array.<any>
`message`	string
`windowTitle`	string	<optional>
`stringFunction`	function	<optional>	Function that returns a string that should be displayed for an element

Returns:

Returns undefined if no UI is available or the dialog was canceled

Type:: Array.<any> | undefined

confirm(message, windowTitleopt) → {boolean|undefined}

Show a confirmation dialog

Parameters:

Name	Type	Attributes	Description
`message`	string
`windowTitle`	string	<optional>

Returns:

True if confirmed, false if not. Returns undefined if no UI is available.

Type:: boolean | undefined

hasUI() → {boolean}

True if UI interaction is possible

Since: 5.2.1

Returns:

Type:: boolean

notificationDialog(notificationFunction, parametersopt, windowTitleopt)

Open a notification dialog that stays open while the notification function is evaluated

Parameters:

Name Type Attributes Description

notificationFunction

function

Notification function

parameters

object

Properties

Name	Type	Attributes	Default	Description
`autoExpand`	boolean	<optional>	false
`canCancel`	boolean	<optional>	true	Set to false to disallow cancelling the dialog
`stayOpen`	boolean	<optional>	false	Keep the dialog open after the function finishes. If set to true, the dialog must be manually closed.

windowTitle string <optional>

Since: 4.1.0
See: $k.UI#raiseNotification

openEditor(element, contextopt, optionsopt)

Opens an editor on the element

Parameters:

Name Type Attributes Description

element $k.SemanticElement

context

$k.SemanticElement | $k.ViewConfiguration

Context that should be used to detect the view configuration, or a view configuration

options

object

Properties

Name	Type	Description
`isNew`	boolean

openGraph(elements, graphConfigopt)

Opens a graph on the elements

Parameters:

Name	Type	Attributes	Description
`elements`	Array.<$k.SemanticElement> \| Array.<$k.Hit>		Graph elements or hits
`graphConfig`	$k.GraphConfiguration	<optional>	Graph configuration

Since: 5.3.2

openTable(elements, domainopt, contextopt)

Opens a table on the elements

Parameters:

Name	Type	Attributes	Description
`elements`	Array.<$k.SemanticElement> \| Array.<$k.Hit>		Table elements or hits
`domain`	$k.Domain \| string	<optional>	Domain or internal name of a type of the table
`context`	$k.SemanticElement \| $k.TableConfiguration	<optional>	Context that should be used to detect the table configuration, or a table configuration

Since: 4.2.1

openURL(url)

Opens the URL with the associated application

Parameters:

Name	Type	Description
`url`	string

Since: 5.2.2

raiseNotification(string)

Raise message notification (to use in function $k.UI#notificationDialog)

Parameters:

Name	Type	Description
`string`	string

Since: 4.1.0
See: $k.UI#notificationDialog

requestString(message, windowTitleopt, initialAnsweropt) → {string|undefined}

Let the user enter a string in a single-line input field

Parameters:

Name	Type	Attributes
`message`	string
`windowTitle`	string	<optional>
`initialAnswer`	string	<optional>

Returns:

Returns undefined if no UI is available or the dialog was canceled

Type:: string | undefined

saveFile(blobOrNetEntity, windowTitleopt)

Requests a filename and writes the given blob or net entity to the file.

Parameters:

Name	Type	Attributes	Description
`blobOrNetEntity`	$k.Blob \| $k.NetEntity
`windowTitle`	string	<optional>

Version: Experimental feature, might be removed at any time
Since: 5.3.2