Main Content

uitreenode

Create tree node component

Description

node = uitreenode creates a tree node UI component inside a tree within a new figure window and returns the TreeNode object. MATLAB® calls the uifigure function to create the figure.

node = uitreenode(parent) creates a tree node in the specified parent container. The parent container can be a Tree or TreeNode object.

node = uitreenode(parent,sibling) creates a tree node in the specified parent container, after the specified sibling node.

node = uitreenode(parent,sibling,location) creates a tree node, and places it after or before the sibling node. Specify location as 'after' or 'before'.

example

node = uitreenode(___,Name,Value) specifies TreeNode property values using one or more Name,Value pair arguments. Specify Name,Value as the last set of arguments when you use any of the previous syntaxes.

Examples

collapse all

Create a tree that contains one node called Sample Data.

t = uitree('Position',[20 20 150 150]);
node = uitreenode(t,'Text','Sample Data');

Create a program file called mytreeapp.m that contains the following commands to create a tree, a set of nested tree nodes, and a callback function for the tree. The SelectionChangedFcn property specifies the function to execute when the user clicks a node in the tree.

function mytreeapp
    fig = uifigure;
    t = uitree(fig,'Position',[20 20 150 150]);

    % Assign Tree callback in response to node selection
    t.SelectionChangedFcn = @nodechange;

    % First level nodes
    category1 = uitreenode(t,'Text','Runners','NodeData',[]);
    category2 = uitreenode(t,'Text','Cyclists','NodeData',[]);

    % Second level nodes.
    % Node data is age (y), height (m), weight (kg)
    p1 = uitreenode(category1,'Text','Joe','NodeData',[40 1.67 58] );
    p2 = uitreenode(category1,'Text','Linda','NodeData',[49 1.83 90]);
    p3 = uitreenode(category2,'Text','Rajeev','NodeData',[25 1.47 53]);
    p4 = uitreenode(category2,'Text','Anne','NodeData',[88 1.92 100]);

    % Expand the tree
    expand(t);
    
    function nodechange(src,event)
        node = event.SelectedNodes;
        display(node.NodeData);
    end
end

When the user runs mytreeapp and clicks a node in the tree, MATLAB displays the NodeData for that node.

Create a context menu with actions appropriate to a tree component. Assign the context menu to the top-level tree nodes in a tree.

In a UI figure, create a tree with four top-level nodes and a set of nested nodes.

fig = uifigure;

tree = uitree(fig,'Position',[20 200 175 100]);

category1 = uitreenode(tree,'Text','Runners');
r1 = uitreenode(category1,'Text','Joe');
r2 = uitreenode(category1,'Text','Linda');

category2 = uitreenode(tree,'Text','Cyclists');
c1 = uitreenode(category2,'Text','Rajeev');

category3 = uitreenode(tree,'Text','Hikers');
h1 = uitreenode(category3,'Text','Jack');

category4 = uitreenode(tree,'Text','Swimmers');
s1 = uitreenode(category4,'Text','Logan');

Create a context menu with three menu items. For the last menu item, create four submenus.

cm = uicontextmenu(fig);
m1 = uimenu(cm,'Text','Expand All');
m2 = uimenu(cm,'Text','Collapse All');
m3 = uimenu(cm,'Text','Scroll To...');

sbm1 = uimenu(m3,'Text','Runners');
sbm2 = uimenu(m3,'Text','Cyclists');
sbm3 = uimenu(m3,'Text','Hikers');
sbm4 = uimenu(m3,'Text','Swimmers');

Then, assign the context menu to the top-level tree nodes by setting the ContextMenu property of each node to the ContextMenu object.

category1.ContextMenu = cm;
category2.ContextMenu = cm;
category3.ContextMenu = cm;
category4.ContextMenu = cm;

Right-click any of the top-level tree nodes to view the context menu.

At this point, the code is still unfinished. The context menu appears when you right-click, but selecting menu items does not have any effect. To finish implementing the behavior of the menu items, create a MenuSelectedFcn callback function.

Input Arguments

collapse all

Parent object, specified as a Tree or TreeNode object.

Sibling node, specified as a TreeNode object.

Location of the node relative to its sibling, specified as a 'after' or 'before'.

Name-Value Pair Arguments

Example: node = uitreenode(t,'Text','Measurements') creates a tree node with the label, 'Measurements'.

Specify optional comma-separated pairs of Name,Value arguments. Name is the argument name and Value is the corresponding value. Name must appear inside single quotes (' '). You can specify several name and value pair arguments as Name1,Value1,...,NameN,ValueN.

The properties listed here are a subset. For a full list, see TreeNode Properties.

Node text, specified as a character vector or string scalar.

Icon source or file, specified as a character vector, a string scalar, or an m-by-n-by-3 truecolor image array. If you specify a file name, it can be an image file name on the MATLAB path or a full path to an image file. If you plan to share an app with others, put the image file on the MATLAB path to facilitate app packaging.

Supported image formats include JPEG, PNG, GIF, SVG, or m-by-n-by-3 truecolor image array. For more information about truecolor image arrays, see Image Types.

Example: 'icon.png' specifies an icon file on the MATLAB path.

Example: 'C:\Documents\icon.png' specifies a full path to an image file.

Node data, specified as an array of any type. Specify NodeData to share node-relevant data within your app code.

Introduced in R2017b