Global

Members

(constant) BorderStyle :string

Border style enum. Use in a border object..

Type:

string

Properties

Name	Type	Description
`None`	string	No border.
`Line`	string	Solid line.
`Dashed`	string	Dashed border.
`Metal`	string	Metallic style.
`EtchedRaised`	string	Etched raised border.
`EtchedLowered`	string	Etched lowered border.
`BevelRaised`	string	Bevel raised border.
`BevelLowered`	string	Bevel lowered border.
`SoftRaised`	string	Soft raised border.
`SoftLowered`	string	Soft lowered border.

See: UIComponent#border

Example

<h2>Setting a new border:</h2>
let border = {style: BorderStyle.Dashed, size: 2, color: "#002288"}
panel.border(border);

(constant) Cursor :number

Enum for available mouse cursors.

Type:

number

Properties

Name	Type	Description
`Default`	number	Default cursor.
`Crosshair`	number	Crosshair.
`Text`	number	Text input cursor.
`Wait`	number	Wait/busy cursor.
`ResizeSW`	number	Resize south-west.
`ResizeSE`	number	Resize south-east.
`ResizeNW`	number	Resize north-west.
`ResizeNE`	number	Resize north-east.
`ResizeN`	number	Resize north.
`ResizeS`	number	Resize south.
`ResizeW`	number	Resize west.
`ResizeE`	number	Resize east.
`Hand`	number	Pointing hand.
`Move`	number	Move cursor.

See: UIComponent#cursor

Example

<h2>Sets "Wait" cursor to Panel component:</h2>
panel.cursor(Cursor.Wait);

(constant) DataType :string

Enum for data types used with drag and drop. Used with dragDataType(), dropDataType(), and to check if certain data type was dragged onto component.

Type:

string

Properties

Name	Type	Description
`None`	string	No data.
`All`	string	Accept any type. Used only for dropDataType().
`Text`	string	Plain text.
`HTML`	string	HTML content.
`Image`	string	Image data.
`FileList`	string	Files from system clipboard or drag.
`URIList`	string	List of URIs.
`URL`	string	A single URL string.
`JSON`	string	JSON-encoded data.
`Components`	string	UI components (`component/*`).

Examples

<h2>Sets the type of data list items represent when dragged:</h2>
list.dragDataType(DataType.FileList);

<h2>Sets the type of data Table component accepts:</h2>
table.dropDataType([DataType.FileList, DataType.URIList, DataType.URL]);

<h2>Check if expected data type was dragged onto Label:</h2>
label.dropAction(DragDropAction.CopyOrMove).dropDataType(DataType.FileList).onDropEvents(e => {
 if(e.type === "drop" && Array.isArray(e.data[DataType.FileList]))
 {
     // set first file as label's icon image
     e.target.icon(e.data[DataType.FileList][0]);
 }
});

(constant) DragDropAction :string

Enum for drag and drop actions. Used with dragAction() and dropAction().

Type:

string

Properties

Name	Type	Description
`None`	string	No action.
`Copy`	string	Copy action.
`Move`	string	Move action.
`CopyOrMove`	string	Copy or move action.
`Link`	string	Link action.

See: UIComponent#dragAction
UIComponent#dropAction

Example

list.dragAction(DragDropAction.CopyOrMove);
list.dropAction(DragDropAction.CopyOrMove);

(constant) DropMode :string

Used with dropMode() in Table, List, and Tree

Type:

string

Properties

Name	Type	Description
`On`	string	Drop on items.
`Insert`	string	Insert between items
`OnOrInsert`	string	Drop on items and between items

See: List.dropMode()
Table.dropMode()
Tree.dropMode()

Example

table.dropMode(DropMode.OnOrInsert);

(constant) FontFamily :string

An enum for generic font family names to use instead of a font name that may not be installed on target operating systems. Use with component.font(), Text() shape, font property of a List item, Tree item, ComboBox item, Table column, and everywhere else where font can be set.

Type:

string

Properties

Name	Type	Description
`Serif`	string	Proportional font with small decorative strokes at the ends of letters (e.g., Times New Roman, Georgia, Garamond, Cambria.).
`SansSerif`	string	Proportional font without decorative strokes; clean and modern (e.g., Arial, Helvetica, Verdana, Calibri, Open Sans).
`Monospaced`	string	Fixed-width font where every character has the same width (e.g., Courier New, Consolas, Lucida Console, Menlo).
`Cursive`	string	Flowing, handwritten-style font (e.g., Brush Script, Comic Sans MS, Pacifico, Lobster).
`System`	string	The system UI font provided by the operating system. (e.g., Segoe UI (Windows), San Francisco (macOS/iOS), Roboto (Android/Linux)).
`Fantasy`	string	Decorative or themed font (e.g., Impact, Papyrus, Jokerman, Copperplate).

See: UIComponent#font
Text

Examples

<h2>Setting component font:</h2>
textarea.font({name: FontFamily.SansSerif});

<h2>Setting Text shape font:</h2>
let text = new Text("Hello World", {name: FontFamily.Fantasy, size: 30});

(constant) KeyAction :number

Keyboard key actions. Used with ui.keyboardAction(action, value) to perform key actions.

Type:

number

Properties

Name	Type	Description
`Press`	number	Key press.
`Release`	number	Key release.
`Type`	number	Key typed (typed character input).

See: SwingUI#keyboardAction

Example

<h2>Performing a key type action:</h2>
ui.keyboardAction(KeyAction.Type, "A");

(constant) LineWrap :number

Enum for word wrapping styles. Used with lineWrap() method in TextArea and DocumentEditor to control how text is wrapped.

Type:

number

Properties

Name	Type	Description
`None`	number	Disable line wrapping.
`Word`	number	Wrap line when a full word doesn't fit.
`Character`	number	Wrap line when a character doesn't fit.

See: TextArea#lineWrapping
DocumentEditor#lineWrapping

Example

<h2>Setting line wrapping style:</h2>
textarea.lineWrapping(LineWrap.Word);

(constant) MessageIcon :number

Enum for standard message dialog icons. Used in alert(), dialog() and TrayIcon.showNotification().

Type:

number

Properties

Name	Type	Description
`Error`	number	Error icon.
`Info`	number	Information icon.
`Warning`	number	Warning icon.
`Question`	number	Question icon.

See: alert
dialog
TrayIcon#showNotification

Example

alert("This file doesn't exist!", "File Absent", MessageIcon.Warning);

(constant) MouseAction :number

Enum for mouse actions. Used with ui.mouseAction(action, button).

Type:

number

Properties

Name	Type	Description
`Press`	number	Mouse button press.
`Release`	number	Mouse button release.
`Click`	number	Single click.
`DoubleClick`	number	Double click.
`VerticalScroll`	number	Vertical wheel scroll.
`HorizontalScroll`	number	Horizontal wheel scroll.

See: SwingUI#mouseAction

Example

<h2>Performing a mouse click:</h2>
ui.mouseAction(MouseAction.Click, MouseButton.Left);

(constant) MouseButton :number

Enum for mouse buttons. Compare to mouseEvent.button on mouse events or use with ui.mouseAction(action, button).

Type:

number

Properties

Name	Type	Description
`Left`	number	Left mouse button.
`Right`	number	Right mouse button.
`Middle`	number	Middle mouse button.

See: SwingUI#mouseAction
UIComponent#onMouseEvents

Examples

<h2>Checking if right mouse button was clicked:</h2>
if(mouseEvent.button === MouseButton.Right)
{
    console.log("Right click);
}

<h2>Performing a mouse click:</h2>
ui.mouseAction(MouseAction.Click, MouseButton.Left);

(constant) Orientation :number

Enum for component orientation, such as Slider or Toolbar.

Type:

number

Properties

Name	Type	Description
`Horizontal`	number	Horizontal orientation.
`Vertical`	number	Vertical orientation.

Example

<h2>Setting orientation to a component:</h2>
toolbar.orientation(Orientation.Vertical);

(constant) SelectionMode :number

Enum for selection modes in UI components like Table, List, Tree. Used with selectionMode() to set of get a selection mode of a list of items or rows.

Type:

number

Properties

Name	Type	Description
`Single`	number	Single item selection.
`Range`	number	Range selection (shift-click).
`Multiple`	number	Multiple selection (ctrl/cmd-click).

See: Table#selectionMode
List#selectionMode
Tree#selectionMode

Example

table.selectionMode(SelectionMode.Single);

(constant) TextAction :number

Enum for actions on text components (TextField, TextArea, etc.). To be used in text() method.

Type:

number

Properties

Name	Type	Description
`Set`	number	Replace all text.
`Prepend`	number	Add text at the beginning.
`Append`	number	Add text at the end.
`Insert`	number	Insert at current caret position.
`ReplaceSelection`	number	Replace selected text.

See: UIComponent#text

Example

<h2>Appending text to TextArea component:</h2>
let textarea = new TextArea("Hello").text(" World!", TextAction.Append);
// text area will contain text "Hello World!"

(readonly) ui :SwingUI

This is a global instance of the main SwingUI class. Use this variable to call functions of SwingUI class.

Type:

SwingUI

See: SwingUI

Example

let _screens = ui.screens; // enumerates screens in Array
const data = ui.clipboard(); // retrieves data copied to clipboard

Methods

alert(message, titleopt, iconopt, ownerWindowopt) → {void}

Displays a dialog window with a specified error message and an error icon.

Parameters:

Name	Type	Attributes	Default	Description
`message`	string			A message to be displayed in the dialog window
`title`	string	<optional>	"Message"	Dialog window title bar text
`icon`	MessageIcon	<optional>	MessageIcon.Info	Icon to show in the dialog window. Valid value are: MessageIcon.Error MessageIcon.Info MessageIcon.Warning MessageIcon.Question
`ownerWindow`	Window	<optional>	null	If set, the message dialog window will attempts to be centered at specified window

Returns:

Does not return a value

Type:: void

Examples

<h2>Simple usage with only one parameter:</h2>
alert("File name is invalid. Please try again");

<h2>Usage example when passing all parameters:</h2>
alert("File name is invalid. Please try again","Invalid File", MessageIcon.Warning, this);

confirm(message, windowopt) → {boolean}

Displays a confirmation dialog to user and returns user's response as boolean.

Parameters:

Name	Type	Attributes	Default	Description
`message`	string			Message to display to user
`window`	Window	<optional>	null	Window which dialog window will overlay.

Returns:

Returns true if user confirms the message, or false otherwise.

Type:: boolean

Example

if(confirm("Delete this file?", this))
{
    // delete code
}

dialog(message, titleopt, buttonsopt, iconopt, windowopt) → {string|undefined}

Shows a custom dialog window that allows the user to respond by clicking one of provided buttons.

Parameters:

Name	Type	Attributes	Default	Description
`message`	string			String message to user. It can be plain text or HTML.
`title`	string	<optional>	""	Dialog window title shown in the title bar of the window
`buttons`	string	<optional>	"OK\|Cancel"	A string of button names separated by "\|" character. Indicate which button should be selected by default by surrounding the button with square brackets like so: "OK\|[Cancel]"
`icon`	MessageIcon \| string	<optional>	null	One of MessageIcon icons, or an absolute path to an image from a file system.
`window`	Window	<optional>	null	Owner window that will be overlaid by this dialog window.

Returns:

Returns a string of the clicked button, or undefined if user close the window without clicking on one of provided buttons.

Type:: string | undefined

Example

let response = dialog("Are you ready?", "Confirm readiness", "Yes|No|[Maybe]", MessageIcon.Question, this);
if(response !== "Yes") return; // do not continue

let response = dialog("Is this you?", "Question #5", "Yes|[No]", "C://User/John/profile_icon.jpg", this);

error(message, show_stack_traceopt) → {void}

Displays a dialog windows with error message and error icon.

Parameters:

Name	Type	Attributes	Default	Description
`message`	string			Error message to display.
`show_stack_trace`	boolean	<optional>	true	Whether to show stack trace to be able to trace the error.

Returns:

Does not return a value

Type:: void

Examples

<h2>Showing an error message only:</h2>
error("Invalid parameters passed.", false);

<h2>Showing an error message with a stack trace:</h2>
error("Invalid parameters passed.");

isAbsolutePath(path) → {boolean}

Checks if the provided path is absolute (mainly for the purpose to know if a directory should be prepended to the path to make it absolute). Note that it returns true for empty string.

Parameters:

Name	Type	Description
`path`	string	File path (supports local files, network drive paths, Windows paths with drive letter, unix root /)

Throws:

Throws error if provided path is not a string type.
Type Error

Returns:

Returns true if the path is absolute or an empty string.

Type:: boolean

prompt(message, default_valueopt, ownerWindowopt) → {string|undefined}

Requests user for text input in a dialog window. Returns a string as user's input or undefined when user declined to input.

Parameters:

Name	Type	Attributes	Default	Description
`message`	string			Message to user about this text input.
`default_value`	string	<optional>	""	Default string that will be already present in the dialog window.
`ownerWindow`	Window	<optional>	null	Window that will be overlaid by the dialog window.

Returns:

Returns user provided string, or undefined if user canceled input.

Type:: string | undefined

Example

let response = prompt("Please enter your name:", "John Doe", this);
console.log("You entered: " + response);

Type Definitions

ActionEvent

Action event received by the onAction() handler callback.

Type:

Object

Properties

Name	Type	Attributes	Description
`target`	object		The component that triggered the event.
`command`	string		The command string, usually the button text or a custom value set with `.command("")`.
`modifiers`	number	<optional>	Keyboard modifiers (bitmask or flags).
`alt`	boolean	<optional>	Indicates if ALT key was pressed.
`shift`	boolean	<optional>	Indicates if SHIFT key was pressed.
`ctrl`	boolean	<optional>	Indicates if CTRL key was pressed.
`type`	string		One of `action` or `index_change`. Present when applicable.
`x`	number	<optional>	Mouse X position relative to the component.
`y`	number	<optional>	Mouse Y position relative to the component.
`screenX`	number	<optional>	Mouse X position relative to the screen.
`screenY`	number	<optional>	Mouse Y position relative to the screen.
`interactive`	boolean	<optional>	Indicates if the action was triggered by user interaction (not programmatically).
`selected`	boolean	<optional>	Indicates selection state when applicable.

See: onAction()

AncestorEvent

Ancestor event received by the onAncestorEvents() handler callback.

Type:

Object

Properties

Name	Type	Description
`target`	object	The component that triggered the event.
`type`	string	One of `add`, `remove`, `move`.
`ancestor`	object	The ancestor component related to this event.

See: onAncestorEvents()

AudioDevice

Represents an audio input or output device, such as a microphone, audio card, etc.

Type:

Object

Properties

Name	Type	Attributes	Description
`name`	string		Name of the audio device (required when setting an audio input device).
`id`	string	<optional>	ID of the audio device.
`formats`	Array.<AudioFormat>	<optional>	List of available audio formats provided when retrieving a list of installed audio devices.
`format`	AudioFormat	<optional>	Specifies the chosen audio format to use when setting audio input device.

See: MediaPlayer#audioInputDevices
MediaPlayer#audioOutputDevice
AudioFormat

AudioFormat

Represents an audio format for an audio device.

Type:

Object

Properties

Name	Type	Attributes	Description
`channels`	number		Number of audio channels. (1-Mono, 2-Stereo, etc.)
`bits`	number		Bits per audio sample.
`rate`	number	<optional>	Sample rate in Hz (only available for audio input devices).
`encoding`	string	<optional>	Audio encoding (e.g., "PCM_UNSIGNED", "PCM_SIGNED"); (only available for audio output device formats).

See: AudioDevice

AudioStream

Describes an audio stream in the media.

Type:

Object

Properties

Name	Type	Description
`sampleRate`	number	Sample rate of the audio stream in Hz.
`channels`	number	Number of audio channels (1 - mono, 2 - stereo, etc.)
`bitDepth`	number	Bit depth of the audio samples.
`codec`	string	Codec used to encode the audio stream (e.g., `"aac"`).
`default`	boolean	Indicates if this is the default audio stream.

See: MediaPlayer#onPlayerEvents
Media

CaretEvent

Caret event received by the onCaretEvents() handler callback.

Type:

Object

Properties

Name	Type	Attributes	Description
`target`	object		The component that triggered the event.
`type`	string		Always `change`.
`position`	number		The new caret position.
`selectionStart`	number		Start position of selected text.
`selectionEnd`	number		End position of selected text.
`line`	number	<optional>	Line number where the caret is located. Present in components like `DocumentEditor`.
`column`	number	<optional>	Column number (offset from line start) of the caret. Present in multi-line components like `DocumentEditor`.
`styles`	object	<optional>	Text formatting information at the caret’s position. Present only for `DocumentEditor` when HTML is enabled.
`path`	Array.<string>	<optional>	HTML tag hierarchy at the caret’s position. Present only for `DocumentEditor` when HTML is enabled.

See: onCaretEvents()

ChangeEvent

Change event received by the onChange() handler callback.

Type:

Object

Properties

Name	Type	Attributes	Description
`target`	object		The component that triggered the event.
`type`	string		One of `change`, `changing`. `change` - when value has changed and is no longer being modified by the user. `changing` - when the value is still being modified, e.g. while moving a Slider knob.
`action`	string	<optional>	One of `inserted`, `removed`. Present for some text editing components, indicates the action performed.
`position`	number	<optional>	The position at which text was inserted. Present when `action` is present.
`length`	number	<optional>	The number of characters inserted or removed. Present when `action` is present.

See: onChange()

ComponentEvent

Component event received by the onComponentEvents() handler callback.

Type:

Object

Properties

Name	Type	Attributes	Description
`target`	object		The component that triggered the event.
`type`	string		One of `resize`, `move`, `show`, `hide`.
`interactive`	boolean	<optional>	Indicates if the event was triggered by user interaction (not programmatically). Present for `move` and `resize` for component like Window, InternalWindow.
`x`	number	<optional>	New X position of the component.
`y`	number	<optional>	New Y position of the component.
`width`	number	<optional>	New width of the component. Present when type is `resize`.
`height`	number	<optional>	New height of the component. Present when type is `resize`.
`innerWidth`	number	<optional>	New width of the content area. Present for `resize` when component is `Window` or `InternalWindow`.
`innerHeight`	number	<optional>	New height of the content area. Present for `resize` when component is `Window` or `InternalWindow`.

See: onComponentEvents()

ContainerEvent

Container event received by the onContainerEvents() handler callback.

Type:

Object

Properties

Name	Type	Description
`target`	object	The container component that triggered the event.
`type`	string	One of `add`, `remove`.
`child`	object	The child component that was added or removed.

See: onContainerEvents()

DisposeEvent

A dispose event object received by the onDispose() handler callback when a component gets disposed.

Type:

Object

Properties

Name	Type	Description
`target`	object	The component that triggered the event.

See: onDispose()

DragEvent

Drag event received by the onDragEvents() handler callback.

Type:

Object

Properties

Name	Type	Attributes	Description
`target`	object		The component that triggered the event.
`type`	string		One of `dragstart`, `dragend`, `cancel`.
`action`	string	<optional>	One of the values of enum DragDropAction. Present when applicable.
`x`	number	<optional>	X position of the pointer relative to this component. Present when type is `dragstart` or `dragend`.
`y`	number	<optional>	Y position of the pointer relative to this component. Present when type is `dragstart` or `dragend`.
`screenX`	number	<optional>	X position of the pointer relative to the screen. Present when type is `dragstart` or `dragend`.
`screenY`	number	<optional>	Y position of the pointer relative to the screen. Present when type is `dragstart` or `dragend`.
`button`	number	<optional>	Indicates a pointing device button involved in dragging. Value of `MouseButton` enum.
`modifiers`	number	<optional>	Keyboard modifiers (bitmask or flags). Present when type is `dragstart`.
`modifiersText`	string	<optional>	Human-readable keyboard modifiers. Present when type is `dragstart`.
`alt`	boolean	<optional>	Indicates if ALT key was pressed. Present when type is `dragstart`.
`shift`	boolean	<optional>	Indicates if SHIFT key was pressed. Present when type is `dragstart`.
`ctrl`	boolean	<optional>	Indicates if CTRL key was pressed. Present when type is `dragstart`.
`selected`	Array.<number>	<optional>	Selected indexes of a `List` component whose items are being dragged. Present only when dragging List items.

See: onDragEvents()

DropEvent

Drop event received by the onDropEvents() handler callback.

Type:

Object

Properties

Name	Type	Attributes	Description
`target`	object		The component that triggered the event.
`type`	string		One of `dragenter`, `dragover`, `dragleave`, `drop`.
`action`	string	<optional>	One of the values of enum DragDropAction. Present when applicable.
`data`	object	<optional>	Contains the data being dropped. Present only when type is `drop` or `dragenter`.
`source`	object	<optional>	The component being dragged onto this component. Present only for component-to-component drag and when `DataType.Component` is allowed.
`x`	number	<optional>	X position of the pointer relative to this component. Present when type is `dragstart` or `drop`.
`y`	number	<optional>	Y position of the pointer relative to this component. Present when type is `dragstart` or `drop`.
`screenX`	number	<optional>	X position of the pointer relative to the screen. Present when type is `dragstart` or `drop`.
`screenY`	number	<optional>	Y position of the pointer relative to the screen. Present when type is `dragstart` or `drop`.
`selected`	Array.<number>	<optional>	Selected indexes of a `List` component whose items are being dragged. Present only when dragging List items.

See: onDropEvents()

ErrorEvent

An error event object received by the onError() handler callback when error occurs.

Type:

Object

Properties

Name	Type	Description
`target`	object	The component that triggered the event.
`messsage`	string	An error message.

See: onError()

FocusEvent

Focus event received by the onFocusEvents() handler callback.

Type:

Object

Properties

Name	Type	Description
`target`	object	The component that triggered the event.
`type`	string	One of `focus`, `blur`.
`cause`	string	One of `UNKNOWN`, `ACTIVATION`, `TRAVERSAL_FORWARD`, `TRAVERSAL_BACKWARD`.
`temporary`	boolean	Identifies if the focus change is temporary or permanent.

See: onFocusEvents()

Font

Font object used in most UI components, ListItem, TableColumn, Text shape and other text-rendering components.

Type:

Object

Properties

Name	Type	Attributes	Description
`name`	string \| FontFamily	<optional>	Font family name (e.g., `"sans-serif"`).
`size`	number	<optional>	Font size in pixels.
`bold`	boolean	<optional>	Whether the text is bold.
`italic`	boolean	<optional>	Whether the text is italic.
`underlined`	boolean	<optional>	Whether the text is underlined.
`strikethrough`	boolean	<optional>	Whether the text has a strikethrough.
`direction`	string	<optional>	Text direction: `"ltr"` or `"rtl"`.
`kerning`	boolean	<optional>	Enable or disable kerning.
`ligatures`	boolean	<optional>	Enable or disable font ligatures.
`tracking`	number	<optional>	Letter spacing adjustment: -1, 0 (default), or 1.

See: FontFamily
UIComponent#font
ListItem
TableColumn
Text

KeyEvent

Key event received by the onKey() handler callback.

Type:

Object

Properties

Name	Type	Attributes	Description
`target`	object		The component that triggered the event.
`type`	string		One of `up`, `down`, `type`.
`keyCode`	number		Numeric code associated with the key.
`extendedKeyCode`	number		Unique id assigned to a key depending on the current keyboard layout.
`keyChar`	string		The character produced by the key.
`modifiers`	number	<optional>	Keyboard modifiers (bitmask or flags).
`modifiersText`	string	<optional>	Human-readable representation of modifiers.
`alt`	boolean	<optional>	Indicates if ALT key was pressed.
`shift`	boolean	<optional>	Indicates if SHIFT key was pressed.
`ctrl`	boolean	<optional>	Indicates if CTRL key was pressed.
`keyLocation`	string	<optional>	One of `standard`, `numpad`, `left`, `right`. Present for `up` and `down` events.

See: onKey()

LinkEvent

Event object passed to hyperlink event handlers in DocumentEditor#onLinkEvents.

Type:

Object

Properties

Name	Type	Description
`target`	DocumentEditor	The component that triggered the event.
`type`	string	The event type: `click`, `mouseenter`, or `mouseleave`.
`url`	string	The `href` attribute of the `<a>` tag.
`text`	string	The text content of the hyperlink.
`shift`	boolean	Whether the Shift key was pressed.
`ctrl`	boolean	Whether the Ctrl key was pressed.
`alt`	boolean	Whether the Alt key was pressed.
`modifiers`	string	Keyboard modifiers mask.
`modifiersText`	string	String representation of the keyboard modifiers.

See: DocumentEditor#onLinkEvents

ListItem

Item object used in ComboBox, List, and Tree components.

Type:

Object

Properties

Name	Type	Attributes	Description
`text`	string	<optional>	Item text. (Required for a new list item).
`id`	string \| number	<optional>	Value that can be used by software logic to identify this item.
`value`	string \| number	<optional>	Additional value to be stored in the item for later use.
`icon`	string \| null	<optional>	Absolute/relative path to icon image, base64 encoded image string, or `null` to remove icon.
`color`	string	<optional>	Item text color as a 6-character hex string (e.g. `#665500`).
`background`	string	<optional>	Item background color as a 6-character hex string (e.g. `#665500`).
`tooltip`	string	<optional>	Tooltip text shown when hovering the item (only in List and Tree components).
`font`	Font	<optional>	Font formatted object.

See: List
ComboBox
Tree
Font

Media

Describes metadata and streams of the media.

Type:

Object

Properties

Name	Type	Attributes	Description
`duration`	number	<optional>	Duration of the media in seconds. Not present for live streams.
`videoStreams`	Array.<VideoStream>		Array of video streams available in the media.
`audioStreams`	Array.<AudioStream>		Array of audio streams available in the media.
`subtitleStreams`	Array.<SubtitleStream>		Array of subtitle streams available in the media.

See: MediaPlayer#onPlayerEvents
VideoStream
AudioStream
SubtitleStream

MouseEvent

Mouse event received by the onMouseEvents() handler callback.

Type:

Object

Properties

Name	Type	Attributes	Description
`target`	object		The component that triggered the event.
`type`	string		One of `click`, `down`, `up`, `enter`, `leave`.
`button`	number		Button number. One of `MouseButton` enum values.
`clicks`	number	<optional>	Number of times the button was clicked. Present when applicable.
`modifiers`	number	<optional>	Keyboard modifiers (bitmask or flags).
`alt`	boolean	<optional>	Indicates if ALT key was pressed.
`shift`	boolean	<optional>	Indicates if SHIFT key was pressed.
`ctrl`	boolean	<optional>	Indicates if CTRL key was pressed.
`x`	number	<optional>	Mouse X position relative to the component. Present when applicable.
`y`	number	<optional>	Mouse Y position relative to the component. Present when applicable.
`screenX`	number	<optional>	Mouse X position relative to the screen. Present when applicable.
`screenY`	number	<optional>	Mouse Y position relative to the screen. Present when applicable.

See: onMouseEvents()

MouseMotionEvent

Mouse motion event received by the onMouseMotion() handler callback.

Type:

Object

Properties

Name	Type	Attributes	Description
`target`	object		The component that triggered the event.
`type`	string		One of `move`, `drag`.
`button`	number	<optional>	Button number. One of `MouseButton` enum values. Present when applicable.
`modifiers`	number	<optional>	Keyboard modifiers (bitmask or flags).
`x`	number		Mouse X position relative to the component.
`y`	number		Mouse Y position relative to the component.
`screenX`	number		Mouse X position relative to the screen.
`screenY`	number		Mouse Y position relative to the screen.

See: onMouseMotion()

MouseWheelEvent

Mouse wheel event received by the onMouseWheel() handler callback.

Type:

Object

Properties

Name	Type	Attributes	Description
`target`	object		The component that triggered the event.
`type`	string		Always `wheel`.
`button`	number	<optional>	Button number. One of `MouseButton` enum values. Present when applicable.
`scrollAmount`	number		Number of units to scroll per wheel click.
`rotation`	number		Number of wheel "clicks" rotated. Can be zero until a full click is accumulated on high-resolution wheels.
`modifiers`	number	<optional>	Keyboard modifiers (bitmask or flags).
`alt`	boolean	<optional>	Indicates if ALT key was pressed.
`shift`	boolean	<optional>	Indicates if SHIFT key was pressed.
`ctrl`	boolean	<optional>	Indicates if CTRL key was pressed.
`x`	number		Mouse X position relative to the component.
`y`	number		Mouse Y position relative to the component.
`screenX`	number		Mouse X position relative to the screen.
`screenY`	number		Mouse Y position relative to the screen.

See: onMouseWheel()

PlayerEvent

Event object passed to MediaPlayer event handlers.

Type:

Object

Properties

Name	Type	Attributes	Description
`type`	string		Indicates the type of event triggered by the player. One of: `loadstart`, `loadedmetadata`, `seeking`, `timeupdate`, `play`, `stop`.
`mediaType`	string	<optional>	Type of media loaded in the player. One of: `File`, `InputDevice`, `URL`.
`media`	Media	<optional>	A Media object containing details about the loaded media.
`currentTime`	number	<optional>	Current playback time in seconds.
`duration`	number	<optional>	Total duration of the media in seconds. Present when `type` is `timeupdate`.
`reason`	string	<optional>	Reason for stopping playback. One of: `Control`, `EndOfMediaFile`, `EndOfAudioStream`, `EndOfVideoStream`, `EndOfErrorStream`, `Error`.

See: MediaPlayer#onPlayerEvents
Media
VideoStream
AudioStream
SubtitleStream

Point

Represents a point in 2D space with X and Y coordinates. Used when setting or getting position of UI component, Shape position, or Shape's anchor.

Type:

Object

Properties

Name	Type	Description
`x`	number	The x-coordinate.
`y`	number	The y-coordinate.

See: UIComponent#position
Shape#position
Shape#anchor

Example

<h2>Example of a Point object:</h2>
const point = {x: 300, y: 200};

PopupEvent

Popup list event received by the onPopupEvents() handler callback in ComboBox, Menu and ContextMenu components.

Type:

Object

Properties

Name	Type	Attributes	Description
`target`	object		The component that triggered the event.
`type`	string		One of `show`, `hide`, `cancel`.
`x`	number	<optional>	Component's X position relative to invoker. For `Menu` component it's only present when invoker is not `null`.
`y`	number	<optional>	Component's Y position relative to invoker. For `Menu` component it's only present when invoker is not `null`.
`interactive`	boolean		Indicates if the popup was triggered by user's interaction (not programmatically).
`screenX`	number	<optional>	X position of a `Menu` component relative to default screen.
`screenY`	number	<optional>	Y position of a `Menu` component relative to default screen.
`invoker`	object	<optional>	UI Component that invoked the popup, or `null` if it was invoked programmatically.

See: ComboBox.onPopupEvents()
Menu.onPopupEvents()
ContextMenu.onPopupEvents()

PropertyChangeEvent

Property change event received by the onPropertyChange() handler callback.

Type:

Object

Properties

Name	Type	Description
`target`	object	The component that triggered the event.
`type`	string	Always `change`.
`property`	string	The property that was changed.
`oldValue`	any	Previous value of the changed property.
`newValue`	any	New value of the changed property.

See: onPropertyChange()

ScrollEvent

Scroll event received by the onScroll() handler callback.

Type:

Object

Properties

Name	Type	Description
`target`	object	The component that triggered the event.
`type`	string	One of `horizontal`, `vertical`.
`x`	number	The new horizontal scroll position.
`y`	number	The new vertical scroll position.
`maxX`	number	The maximum horizontal scroll position.
`maxY`	number	The maximum vertical scroll position.

See: onScroll()

Size

Represents the size of a 2D object. Used when setting or getting the size of UI component, Shape size, and more.

Type:

Object

Properties

Name	Type	Description
`width`	number	The width dimension.
`height`	number	The height dimension.

See: UIComponent#size
UIComponent#minSize
UIComponent#maxSize
Window#innerSize
InternalWindow#innerSize
Shape#size
Rectangle#size
Ellipse#size

Example

<h2>Example of a Size object:</h2>
const size = {width: 300, height: 200};

SubtitleStream

Describes a subtitle stream in the media.

Type:

Object

Properties

Name	Type	Description
`language`	string	Language of the subtitle stream (e.g., `"en"`).
`codec`	string	Codec used for the subtitle stream (e.g., `"srt"`).
`default`	boolean	Indicates if this is the default subtitle stream.

See: MediaPlayer#onPlayerEvents
Media

TableColumn

Table column configuration object used in Table components.

Type:

Object

Properties

Name	Type	Attributes	Default	Description
`text`	string			The text to be displayed in the column header. (Required when creating a new column)
`type`	string	<optional>	"text"	Type of component to display/edit cell data. Possible values: `"text"` - Plain text or HTML. `"password"` - Masked password text field. `"textarea"` - Multi-line text field. `"icon"` - Image loaded from cell value source. Use table.onAction(callback) for click events. `"button"` - String of button names separated by `"\|"`. Use table.onAction(callback) for click events. `"checkbox"` - Boolean check mark selection component. `"combobox"` - Drop-down list of values, can be editable. `"progress"` - Progress bar showing integer value 0–100.
`sorting`	Table.Sorting	<optional>	Table.Sorting.Natural	Sorting mode. `Table.Sorting.None` disables sorting.
`icon_size`	number	<optional>		For `"icon"` type, fixed width/height of the icon (largest dimension).
`cache_capacity`	number	<optional>	10	For `"icon"` type, number of images cached in RAM.
`resizable`	boolean	<optional>	true	Indicates if the column can be resized by the user.
`auto_resize`	boolean	<optional>	true	Indicates if column auto-resizes with table (ignored if table auto resize is `Table.AutoResize.None`).
`width`	number	<optional>		Initial desired width of the column.
`min_width`	number	<optional>		Minimum width column can be resized to.
`max_width`	number	<optional>		Maximum width column can be resized to.
`hidden`	boolean	<optional>	false	Whether the column is hidden (width 0).
`character`	string	<optional>		Mask character for `"password"` type.
`editable`	boolean	<optional>	false	Whether text fields are editable.
`clicksToEdit`	boolean	<optional>		Number of clicks required to make cell editable (only if editable).
`options`	Array.<string>	<optional>		List of values for `"combobox"` type.

See: Table
Table#columns
Table#addColumn

Example

<h2>Creating a simple column object:</h2>
let column = {
    text: "New Column",
    header_align: "center"
};

VideoDevice

Represents a video input device, such as WebCam, video capture device, etc. Used when getting input devices with videoInputDevices getter and when setting input device with setInputDevice() method.

Type:

Object

Properties

Name	Type	Attributes	Description
`name`	string	<optional>	Name of the video input device (only present when retrieving a list of video input devices).
`id`	string		ID of the video input device.
`formats`	Array.<VideoFormat>	<optional>	List of available video formats (only present when retrieving a list of video input devices).
`format`	VideoFormat	<optional>	Chosen video format to use (required when setting a video input device).

See: MediaPlayer#videoInputDevices
MediaPlayer#setInputDevice
VideoFormat

Example

<h2>Setting a video input device:</h2>
const devices = player.videoInputDevices;
console.log(devices[0].formats[0]); // prints first format of a first device
const first_format = devices[0].formats[0];

// create new VideoDevice formatted object
const video_device = {
    id: devices[0].id,
    format: {
        size: first_format.size,
        fps: first_format.max_fps,
        pixel_format: first_format.pixel_format, // set pixel_format in case when it is used instead of vcodec
        vcodec: first_format.vcodec              // set vcodec in case when it is used instead of pixel format
    }
}

// set the video device and start playing
player.setInputDevice(video_device).play();

VideoFormat

Represents a video format for a VideoDevice. When using this VideoFormat for video input device, make sure that either "pixel_format" or "vcodec" is specified as it was set when you retrieved the supported formats.

Type:

Object

Properties

Name	Type	Attributes	Description
`size`	string		Video frame size in pixels (e.g., "1920x1080").
`min_fps`	number	<optional>	Minimum available frame rate (e.g., 7.5). (provided when retrieving video input devices)
`max_fps`	number	<optional>	Maximum available frame rate (e.g., 30). (provided when retrieving video input devices)
`fps`	number	<optional>	Frame rate in frames per second (required when setting a video input device).
`pixel_format`	string	<optional>	Frame image pixel format coming out of the device (e.g., "yuyv422"). If this is present, then `vcodec` is absent.
`vcodec`	string	<optional>	Encoded video format that the video device supports (e.g., "mjpeg", "h264"). If this is present, then `pixel_format` is absent.

See: VideoDevice

Examples

<h2>Example of a VideoFormat object when retrieved with input devices:</h2>
const devices = player.videoInputDevices;
const first_format = devices[0].formats[0];
console.log(first_format); // prints first format of a first device

// outputs something like:
{
    size: "1920x1080",
    min_fps: 5,
    max_fps: 30,
    pixel_format: "yuyv422"
}

<h2>Setting a video input device:</h2>
const devices = player.videoInputDevices;
console.log(devices[0].formats[0]); // prints first format of a first device
const first_format = devices[0].formats[0];

// create new VideoDevice formatted object
const video_device = {
    id: devices[0].id,
    format: {
        size: first_format.size,
        fps: first_format.max_fps,
        pixel_format: first_format.pixel_format, // set pixel_format in case when it is used instead of vcodec
        vcodec: first_format.vcodec              // set vcodec in case when it is used instead of pixel format
    }
}

// set the video device and start playing
player.setInputDevice(video_device).play();

VideoStream

Describes a video stream in the media.

Type:

Object

Properties

Name	Type	Description
`sampleWidth`	number	Original width of the video frame in pixels.
`sampleHeight`	number	Original height of the video frame in pixels.
`width`	number	Display width of the video.
`height`	number	Display height of the video.
`pixelAspectRatio`	string	Pixel aspect ratio (e.g., `"1:1"`).
`displayAspectRatio`	string	Display aspect ratio (e.g., `"16:9"`).
`frameRate`	number	Frame rate of the video stream.
`codec`	string	Codec used to encode the video stream (e.g., `"h264"`).
`pixelFormat`	string	Pixel format of the video stream (e.g., `"yuv420p"`).
`progressive`	boolean	Whether the video stream is progressive or interlaced.
`default`	boolean	Indicates if this is the default video stream.

See: MediaPlayer#onPlayerEvents
Media