In this example, we use APEX Script to create a graph with node and port tags:

1. In an APEX Script SOP, add the following code in the Snippet parameter:

   # Initialize a graph
   graph = ApexGraphHandle()
   
   # Create tags
   tags1: StringArray = ['abc', 'both']
   tags2: StringArray = ['t:abc', 'r:xyz', 'both']
   
   # Add TransformObject nodes to the new graph
   graph.addNode('test1', 'TransformObject', tags=tags1)
   graph.addNode('test2', 'TransformObject', tags=tags2)
   
   # Write out the graph as geometry
   geo = graph.writeToGeo()
   BindOutput(geo)
   

2. To see the graph representation of the APEX Script snippet in the APEX network view, set Show to Component Script in the Visualizer section (node layout and colors have been modified for clarity):

   

3. To see the new graph created by the APEX Script snippet:

   • Set Bind Output Geometry to <output_node>:<output_port>, in our case, output:geo.

   • In the Visualizer section, set Show to Output 1.

   

4. To view the tags in the geometry spreadsheet:

   • The new graph is available on the 1st output of the APEX Script SOP:

     

   • Select the new_graph node.

   • In the geometry spreadsheet, select Points on the top toolbar:

     

In this example, we find nodes and ports with specific tags using the APEX path pattern tag function in graph::FindNodes and graph::FindPorts.

1. We take the graph created from the previous example and input it into a second APEX Script SOP:

   

2. In the find_tags APEX Script SOP, use the predefined headers to automatically add the APEX Script commands that take in and modify an input graph:

   • Turn on the Header parameter.

   • In the Header section, set Template to Graph, which adds the following code to the beginning and end of your APEX Script snippet:

     Header

     geo: Geometry = BindInput()
     graph = geo.loadFromGeo()
     

     Footer

     geo = graph.writeToGeo()
     BindOutput(geo)
     

3. Specify the input to the find_tags node - in the Invocation section, under Input1 Bindings, turn on Bind To Geometry Parameter, and set the parameter to geo. geo is the graph geometry that is input to the APEX Script SOP, specified in the header from the previous step.

4. To find the tags in the input graph, add the following code in the Snippet parameter:

   # Find the nodes and ports with the specified tags
   abc_node_tag = graph.FindNodes('%tag(abc)')
   both_node_tag = graph.FindNodes('%tag(both)')
   xyz_port_tag = graph.FindPorts('%tag(xyz)')
   
   # Add found node and port names to an array for outputting
   both_nodes = StringArray()
   for n in both_node_tag:
       n_name = n.data()
       both_nodes.append(n_name)
   
   abc_nodes = StringArray()
   for n in abc_node_tag:
       n_name = n.data()
       abc_nodes.append(n_name)
   
   xyz_ports = StringArray()
   for p in xyz_port_tag:
       p_name = p.data()
       xyz_ports.append(p_name)
   
   # Output node and port arrays
   BindOutput(abc_nodes, both_nodes, xyz_ports)
   

   Note

   Even though the port tag is stored on the graph node as r:xyz, only specify the tag name, and not the port name, in the tag function when using graph.FindPorts(). For example, use graph.FindPorts('%tag(xyz)'), not graph.FindPorts('%tag(r:xyz)').

5. By default, the first entry of Output Dictionary Bindings in the APEX Script SOP Invocation section is filled out with the following:

   • Apex Outputs Group is the set to output. This is the name of the output node in the graph.

   • Output Attrib is set to parms. This is the name of the output dictionary to store the node and port arrays.

6. To view the found nodes and ports in the geometry spreadsheet:

   • Select the find_tags node.

   • In the geometry spreadsheet, select Detail on the top toolbar.

   • click on the entry in the Detail column of the parms attribute and select Inspect:

     "abc_nodes":["test1"]
     
     "both_nodes":["test1","test2"]
     
     "xyz_ports":["test2"]
     

In this example, we update the tags in a graph using graph::UpdateNode and graph::UpdateNodeTags:

1. We take the graph created from the previous example and input it into a second APEX Script SOP:

   

2. In the update_tags APEX Script SOP, use the predefined headers to automatically add the APEX Script commands that take in and modify an input graph:

   • Turn on the Header parameter.

   • In the Header section, set Template to Graph.

3. Specify the input to the update_tags node - in the Invocation section, under Input1 Bindings, turn on Bind To Geometry Parameter, and set the parameter to geo.

4. To output the updated graph, set Bind Output Geometry to output:geo.

5. The update_tags node now takes in the input graph and outputs it unchanged. To see the graph output, set Show to Output 1 in the Visualizer section.

6. To update the tags on the input graph nodes, add the following code in the Snippet parameter:

   new_tags1 = ['new_tag']
   new_tags2 = ['def', 'xform:xyz']
   
   node1 = graph.test1
   node2 = graph.test2
   
   # Adds to existing tags
   graph.UpdateNodeTags(nodeid=node1, tags=new_tags1)
   
   # Replaces existing tags
   graph.UpdateNode(nodeid=node2, tags=new_tags2)
   

7. See the graph representation of the APEX Script snippet in the APEX network view - in the Visualizer section, set Show to Component Script (node layout and colors have been modified for clarity):

   

8. To see the new graph created by the APEX Script snippet, set Show to Output 1 in the Visualizer section: