Adds a TreeView component into your app.
A tree view is best use in file system navigation.
Properties
These are the setter and getter properties for the addTreeView Component.
Example - Items
var items = {
"Group 1": {
"Item 1": "",
"Item 2": "",
"Item 3": ""
},
"Group 2": {
"Item 1": "",
"Item 2": "",
"Item 3": ""
},
"Applications": {
"Editor": "",
"Productivity": "",
"Social Media": {
"TikTok": "",
"YouTube": "",
"Meta": {
"Facebook": "",
"Instagram": "",
"Whatsapp": "",
"Messenger": ""
}
}
}
}
items = {
"Group 1": {
"Item 1": "",
"Item 2": "",
"Item 3": ""
},
"Group 2": {
"Item 1": "",
"Item 2": "",
"Item 3": ""
},
"Applications": {
"Editor": "",
"Productivity": "",
"Social Media": {
"TikTok": "",
"YouTube": "",
"Meta": {
"Facebook": "",
"Instagram": "",
"Whatsapp": "",
"Messenger": ""
}
}
}
}
Example - Items with icons
var items = {
"Folders": {
"Music": "music_note",
"Photos": "photo",
"Favorites": "favorite"
}
}
items = {
"Folders": {
"Music": "music_note",
"Photos": "photo",
"Favorites": "favorite"
}
}
Example - Basic TreeView
class Main extends App
{
onStart()
{
this.main = ui.addLayout("main", "Linear", "Center,ScrollY,FillXY")
var items = {
"Group 1": {
"Item 1": "",
"Item 2": "",
"Item 3": ""
},
"Group 2": {
"Item 1": "",
"Item 2": "",
"Item 3": ""
},
"Applications": {
"Editor": "",
"Productivity": "",
"Social Media": {
"TikTok": "",
"YouTube": "",
"Meta": {
"Facebook": "",
"Instagram": "",
"Whatsapp": "",
"Messenger": ""
}
}
}
}
this.trv = ui.addTreeView(this.main, items, "Primary")
this.trv.setMargins(0, 5, 0, 0, "rem")
this.trv.setOnTouch( this.onTouch )
}
onTouch(value, path)
{
ui.showPopup("Value: "+value + " Path: "+path)
}
}
from hybrid import ui
def OnStart():
main = ui.addLayout("main", "Linear", "Center,ScrollY,FillXY")
items = {
"Group 1": {
"Item 1": "",
"Item 2": "",
"Item 3": ""
},
"Group 2": {
"Item 1": "",
"Item 2": "",
"Item 3": ""
},
"Applications": {
"Editor": "",
"Productivity": "",
"Social Media": {
"TikTok": "",
"YouTube": "",
"Meta": {
"Facebook": "",
"Instagram": "",
"Whatsapp": "",
"Messenger": ""
}
}
}
}
trv = ui.addTreeView(main, items, "Primary")
trv.setMargins(0, 5, 0, 0, "rem")
trv.setOnTouch(onTouch)
def onTouch(value, path):
ui.showPopup("Value: " + value + " Path: " + path)
Methods
The following methods are available on the TreeView object:
Boolean: Sets or returns the disabled state of the control.
Boolean: Returns whether the control is visible or not.
Number: Fraction of the screen width.
Number: Fraction of the screen height.
Number: The time in milliseconds.
Number: The z-index. A negative value behaves like `sendBackward` method.
Number: The z-index. A positve value behaves like `bringForward` method.
Number: Border-left thickness in pixels.
Number: Top-Left border radius in pixels.
Number: Top-Right border radius in pixels.
Number: Bottom-Left border radius in pixels.
Number: Bottom-Right border radius in pixels.
Number: Fraction of the parent width.
Number: Fraction of the parent height.
Number: Fraction of the component width.
Number: Fraction of the component height. [0-1]
Number: Fraction of the component width. [0-1]
Number: Fraction of the parent width. [0-1]
Number: Fraction of the screen height. [0-1]
Number: The x-scale of the component.Values less than `0` is smaller than the normal. While values greater than `1` is greater than the normal.
Number: The y-scale of the component. Values less than `1` is smaller than the normal. While vaues greater than `1` is greater than the normal.
Number: Fraction of the parent height. [0-1]
Number: Returns the absolute height of the control in pixels.
Number: Returns the absolute distance of the control from the left in pixels.
Number: Returns the absolute distance of the control from the top in pixels.
Number: Returns the absolute width of the control in pixels.
Number: Sets or returns the border thickness in pixels.
Number: Sets or returns the corner radius in pixels.
Number: Sets or returns the height of the control as a fraction of the parent control.
Number: Returns the distance of the control from the left.
Number: Sets or returns the opacity of the control.
Number: Sets or returns the angle of rotation in degrees.
Number: Sets or returns the size of the text within the control.
Number: Returns the distance of the control from the top.
Number: Sets or returns the width of the control as a fraction of the parent control.
String: “A comma separated TreeView options.”
String: “The label text for the new item.”
String: “The type of animation. Here are the available values
`bounce` `flash` `pulse` `rubberBand` `shakeX` `shakeY` `headShake` `swing` `tada` `wobble` `jello` `heartBeat`
`Back Entrances `backInDown` `backInLeft` `backInRight` `backInUp`
`Back Exits `backOutDown` `backOutLeft` `backOutRight` `backOutUp`
`Bouncing Entrances `bounceIn` `bounceInDown` `bounceInLeft` `bounceInRight` `bounceInUp`
`Bouncing exits `bounceOut` `bounceOutDown` `bounceOutLeft` `bounceOutRight` `bounceOutUp`
`Fading entrances `fadeIn` `fadeInDown` `fadeInDownBig` `fadeInLeft` `fadeInLeftBig` `fadeInRight` `fadeInRightBig` `fadeInUp` `fadeInUpBig` `fadeInTopLeft` `fadeInTopRight` `fadeInBottomLeft` `fadeInBottomRight`
`Fading exits `fadeOut` `fadeOutDown` `fadeOutDownBig` `fadeOutLeft` `fadeOutLeftBig` `fadeOutRight` `fadeOutRightBig` `fadeOutUp` `fadeOutUpBig` `fadeOutTopLeft` `fadeOutTopRight` `fadeOutBottomRight` `fadeOutBottomLeft`
`Flippers `flip` `flipInX` `flipInY` `flipOutX` `flipOutY`
`Lightspeed `lightSpeedInRight` `lightSpeedInLeft` `lightSpeedOutRight` `lightSpeedOutLeft`
`Rotating Entrances `rotateIn` `rotateInDownLeft` `rotateInDownRight` `rotateInUpLeft` `rotateInUpRight`
`Rotating Exits `rotateOut` `rotateOutDownLeft` `rotateOutDownRight` `rotateOutUpLeft` `rotateOutUpRight`
`Specials `hinge` `jackInTheBox` `rollIn` `rollOut`
`Zooming Entrances `zoomIn` `zoomInDown` `zoomInLeft` `zoomInRight` `zoomInUp`
`Zooming Exits `zoomOut` `zoomOutDown` `zoomOutLeft` `zoomOutRight` `zoomOutUp`
`Sliding Entrances `slideInDown` `slideInLeft` `slideInRight` `slideInUp`
`Sliding Exits `slideOutDown` `slideOutLeft` `slideOutRight` `slideOutUp`.”
String: “The parent name of the tree items.”
String: “The mode of the measurements. Values can be `px` or `%`”
String: “Border color in hexadecimal form `#rrggbb`”
String: “Border-styles. Values can be `dotted` `dashed` `solid` `double` `groove` `ridge` `inset` and `outset`. Default is `solid`”
String: “Unit. Values are `px` `rem` or `%`.”
String: “`px` or `%`”
String: “The size thickness mode. Can be `px`”
String: “Unit of measurement. Can be `px` or `%` or any css unit of measurement.”
String: A hexadecimal color of the form #rrggbb
String: The path to your image file.
String: Sets or returns the border color. Color is in hexadecimal form #rrggbb
String: Sets or returns the border style. Values can be dotted, dashed, solid, double, groove, ridge, inset and outset. Default is solid.
String: Sets or returns the relative path to the font-family use.
String: Sets or returns the options of the control.
String: Sets or returns the color of the text.
String: Returns the type of the control.
String: Returns the selected item of the TreeView.
String: Sets or returns the visibility of the control.
Object: The parent layout where to add the TreeView component.
Object: An object of the treeview items. See example below.
Object: See list object for more info.
Object: The list object of the treeview items. See example above.
Object: The pointer event object.
Object: Sets or returns the list object.
Object: Returns the parent layout control.
Object: Returns the position of the control. The returned object has left top right and bottom props.
List: Sets or returns the margin of the control. Works on controls with Linear parent only. You can also pass a number to set equal margins for all sides.
List: Sets or returns the padding of the control. You can also pass a number to set equal padding for all sides.
trv.addItem
Add a tree items to the tree view
trv.animate
Animate the component
trv.bringForward
Bring this component forward by a given z-index
trv.destroy
Destroy the component
trv.getItem
Returns the list items object of a given parent tree item name
trv.getPosition
Returns the position of the component. The return object is of the form `{ left, top, right, bottom
trv.gone
Destroy the component
trv.hide
Hide the component
trv.sendBackward
Bring this component backward by a given z-index
trv.setBorder
Sets the border line for the component container
trv.setCornerRadius
Sets the corner radius of the component
trv.setList
Updates the list items of the TreeView component
trv.setMargins
Sets the margin of the component
trv.setOnContextMenu
Adds a callback function on right click
trv.setOnTouch
Add a on touch handler to the TreeView item when click
trv.setPadding
Sets the padding component container
trv.setPosition
Sets the position of the component relative to its parent dimensions
trv.setScale
Sets the x and y scaling of the component
trv.setSize
Sets the size of the component
trv.show
Show the component