AppStudio Built-in properties

Members

(constant) List of built-in properties

Built-in properties represent the components' reserved internal keywords, which are integral to their built-in functionality. To avoid conflicts, users should not override them and must avoid these names in custom properties.

Properties
NameTypeDescription
onCreatedstring | function

A callback function that is executed when the TComponent instance is created. This callback is executed only once and applicable to all "TComponent" instances.

onMountedstring | function

A callback function that is executed when the TComponent is mounted to the DOM and rendered. This callback is executed only once after the component is first rendered, applicable to all TComponent instances.

onClickstring | function

A callback function that is executed when the component is clicked. This applies only to components created from TComponents.Button, TComponents.DigitalLed, and TComponents.Image.

onChangestring | function

A callback function that is executed when the component value is changed. This applies only to components created from TComponents.DigitalLed, TComponents.Hamburger, TComponents.Input, TComponents.Menu_A, TComponents.MultiView, TComponents.Select, TComponents.Switch, TComponents.Tab, and TComponents.VarIncrDecr_A.

onPointerReleasestring | function

A callback function that is executed when the pointer is released on the component. This applies only to components created from TComponents.Button.

onPointerDownstring | function

A callback function that is executed when the pointer is pressed on the component. This applies only to components created from TComponents.Button.

positionstring

The web CSS position property of the component (e.g., 'static', 'absolute'). The default value is absolute. This applies to all components.

widthnumber

The width property of the component. This applies to all components.

heightnumber

The height property of the component. This applies to all components.

topnumber

The top offset property of the component. This applies to all components.

leftnumber

The left offset property of the component. This applies to all components.

borderRadiusnumber

The border radius property of the component. This applies to all components.

rotationnumber

The rotation angle property of the component. This applies to all components. This property takes effect from version 1.2.0..

zIndexnumber

The layout canvas index property of the component. This determines component's stacking order. This applies to all components.

tipsstring

The tool tips that are displayed when the button is disabled and hovered. This applies only to components created from TComponents.Button.

iconstring

The icon that is displayed on the components. If no icon is defined, "null" will be displayed. The icon comes from the form provided by AppStudio (see link: xxxx). This applies only to components created from TComponents.Button, TComponents.Hamburger, and TComponents.Tab.

textstring

The text that is displayed on the component. This applies only to components created from TComponents.Button, TComponents.Text, TComponents.Select, TComponents.Input, TComponents.DigitalLed, and TComponents.VarIncrDecr_A.

colorstring

Text and icon color of the component.

fontObject

Font configuration for the component text.

backgroundColorstring

Background color of the component.

borderstring

Border style for the component (e.g., '1px solid transparent').

functionalityObject

Functionality configuration for the component.

styleTemplatestring

Style template for the component.

inputVarObject

Configuration object for an input variable. It defines the type, function, and value of the input variable, which can be customized for different use cases. inputVar.type: Component_A.INPUTVAR_TYPE.BOOL inputVar.func: Component_A.INPUTVAR_FUNC.CUSTOM inputVar.value: '0' (string)

This applies to input variables in TComponents where specific configurations are needed.

useTitleboolean

Indicates whether to display a title for the component.

readOnlyboolean

Indicates whether the component is read-only.

titlestring

Component title. Default value is an empty string.

alwaysVisibleboolean

Indicates whether the component is always visible. Default value is "true".

activeViewIndexnumber

Current active view index. Default value is "0".

useViewIconboolean

Indicates whether to use an icon for the views. Default value is "true".

viewsArray

List of the views associated with the container component. Default value is an empty array.

contentobject

Layout configuration for the TComponents.LayoutInfobox component. Defines the layout configurations and container settings for the component, including the settings for the child containers that are created from TComponents.Container_A, the layout direction, size and style. This applies only to the TComponents.LayoutInfobox component.

imgSrcstring

The source URL of the image. This applies only to components created from TComponents.Image.

imgStyleobject

The CSS style applied to the image. It is set to {objectFit: 'fill'} by default. This applies only to components created from TComponents.Image.

useBorderboolean

Whether to display a border around the input field. It is set to true by default. This applies only to components created from TComponents.Input and TComponents.VarIncrDecr_A.

regexobject

A regular expression object used for validating the input value. This applies only to components created from TComponents.Input and TComponents.VarIncrDecr_A.

keyboardHelperDescstring

Guidance information for the input field, which will help users understand the kind of the input expected. This applies only to components created from TComponents.Input and TComponents.VarIncrDecr_A.

stepstring

The increment step value of the input field. Default value is '1'. This applies only to components created from TComponents.VarIncrDecr_A.

numRangeobject

The range object defining the minimum and maximum values of the input. This applies only to components created from TComponents.VarIncrDecr_A.

valuestring

The actual value of the selected item in the dropdown list. This value corresponds to the value part of the selected item in optionItems.

selectedIndexnumber

The index of the current selected dropdown item. Indexing starts from 0 for the first item.

optionItemsstring

A string representation of the dropdown items. Each item is formatted as key|value (e.g., text1|value1) and separated by a semicolon ;. New lines (\n) are allowed for readability, but will be treated as separators.