TreeElementLabelFunction

TreeElementLabelFunction

is an option for Tree and related functions that specifies a function to use to generate subtree element labels.

Details

  • TreeElementLabelFunction allows specifying the function to generate the label of the root node of a tree, as well as that of any subtrees at positions matching a pattern.
  • The following option settings can be used:
  • Automaticuse the subtree data as the label
    Noneuse no label
    funca general subtree element label function
    {pos1func1,pos2func2,}use subtree element label function funci at position posi
    {patt1func1,patt2func2,}use funci at positions matching patti
  • Subtree element label specifications are effectively applied in the order TreeElementLabel, TreeElementLabelStyle and TreeElementLabelFunction, with later specifications overriding earlier ones.
  • TreeElementLabelFunctionfunc specifies that the label of the root node should be provided by func[data], where data is the data in the root.
  • In TreeElementLabelFunction, Allfunc uses func for all subtrees.
  • In TreeElementLabelFunction, TreeCases[pattern]func uses func for all subtrees with data matching pattern.

Examples

open allclose all

Basic Examples  (4)

Label an individual subtree element:

Label all subtree elements:

Use no labels:

Specify positions using position patterns:

Specify positions using data patterns:

Properties & Relations  (5)

Subtree elements are automatically labeled with the data of that subtree:

Labels for subtree elements can be specified by position:

Labels specified by a subtree take precedence over labels specified by its ancestors:

A position {i,j,} in a subtree refers to its subtree at relative position {i,j,}:

A relative position {2} at position {1} refers to the global position {1,2}:

In general, a pattern patt applies to subtrees at global positions {i,j,} that match patt:

A list of patterns {patt1,patt2,} applies to relative positions {i,j,} that match the patti:

Wolfram Research (2022), TreeElementLabelFunction, Wolfram Language function, https://reference.wolfram.com/language/ref/TreeElementLabelFunction.html.

Text

Wolfram Research (2022), TreeElementLabelFunction, Wolfram Language function, https://reference.wolfram.com/language/ref/TreeElementLabelFunction.html.

CMS

Wolfram Language. 2022. "TreeElementLabelFunction." Wolfram Language & System Documentation Center. Wolfram Research. https://reference.wolfram.com/language/ref/TreeElementLabelFunction.html.

APA

Wolfram Language. (2022). TreeElementLabelFunction. Wolfram Language & System Documentation Center. Retrieved from https://reference.wolfram.com/language/ref/TreeElementLabelFunction.html

BibTeX

@misc{reference.wolfram_2023_treeelementlabelfunction, author="Wolfram Research", title="{TreeElementLabelFunction}", year="2022", howpublished="\url{https://reference.wolfram.com/language/ref/TreeElementLabelFunction.html}", note=[Accessed: 29-March-2024 ]}

BibLaTeX

@online{reference.wolfram_2023_treeelementlabelfunction, organization={Wolfram Research}, title={TreeElementLabelFunction}, year={2022}, url={https://reference.wolfram.com/language/ref/TreeElementLabelFunction.html}, note=[Accessed: 29-March-2024 ]}