TextTreeConfiguration class
Configuration specifying how a particular DiagnosticsTreeStyle should be rendered as text art.
In release mode, these configurations may be ignored, as diagnostics are compacted or truncated to save on binary size.
See also:
- sparseTextConfiguration, which is a typical style.
- transitionTextConfiguration, which is an example of a complex tree style.
- DiagnosticsNode.toStringDeep, for code using TextTreeConfiguration to render text art for arbitrary trees of DiagnosticsNode objects.
Constructors
- TextTreeConfiguration({required String prefixLineOne, required String prefixOtherLines, required String prefixLastChildLineOne, required String prefixOtherLinesRootNode, required String linkCharacter, required String propertyPrefixIfChildren, required String propertyPrefixNoChildren, String lineBreak = '\n', bool lineBreakProperties = true, String afterName = ':', String afterDescriptionIfBody = '', String afterDescription = '', String beforeProperties = '', String afterProperties = '', String mandatoryAfterProperties = '', String propertySeparator = '', String bodyIndent = '', bool showChildren = true, bool addBlankLineIfNoChildren = true, bool isNameOnOwnLine = false, bool isBlankLineBetweenPropertiesAndChildren = true, String beforeName = '', String suffixLineOne = '', })
- Create a configuration object describing how to render a tree as text.
Properties
- addBlankLineIfNoChildren → bool
-
Whether to add a blank line at the end of the output for a node if it has
no children.
final
- afterDescription → String
-
Text to add immediately after the description line of a node with
properties and/or children.
final
- afterDescriptionIfBody → String
-
Text to add immediately after the description line of a node with
properties and/or children if the node has a body.
final
- afterName → String
-
Text added immediately after the name of the node.
final
- afterProperties → String
-
Optional string to add after the properties of a node.
final
- beforeName → String
-
Text added immediately before the name of the node.
final
- beforeProperties → String
-
Optional string to add before the properties of a node.
final
- bodyIndent → String
-
Prefix to add to all lines of the body of the tree node.
final
- childLinkSpace → String
-
Whitespace to draw instead of the childLink character if this node is the
last child of its parent so no link line is required.
final
-
Footer to add as its own line at the end of a non-root node.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- isBlankLineBetweenPropertiesAndChildren → bool
-
Add a blank line between properties and children if both are present.
final
- isNameOnOwnLine → bool
-
Whether the name should be displayed on the same line as the description.
final
- lineBreak → String
-
Character(s) to use to separate lines.
final
- lineBreakProperties → bool
-
Whether to place line breaks between properties or to leave all
properties on one line.
final
- linkCharacter → String
-
Character to use to draw line linking parent to child.
final
- mandatoryAfterProperties → String
-
Mandatory string to add after the properties of a node regardless of
whether the node has any properties.
final
-
Footer to add even for root nodes.
final
- prefixLastChildLineOne → String
-
Prefix to add to the first line to display the last child of a node with
this style.
final
- prefixLineOne → String
-
Prefix to add to the first line to display a child with this style.
final
- prefixOtherLines → String
-
Prefix to add to other lines to display a child with this style.
final
- prefixOtherLinesRootNode → String
-
Additional prefix to add to other lines of a node if this is the root node
of the tree.
final
- propertyPrefixIfChildren → String
-
Prefix to add before each property if the node as children.
final
- propertyPrefixNoChildren → String
-
Prefix to add before each property if the node does not have children.
final
- propertySeparator → String
-
Property separator to add between properties.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- showChildren → bool
-
Whether the children of a node should be shown.
final
- suffixLineOne → String
-
Suffix to add to end of the first line to make its length match the footer.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited