InspectorSerializationDelegate class

A delegate that configures how a hierarchy of DiagnosticsNodes are serialized by the Flutter Inspector.

Implemented types
Annotations

Constructors

InspectorSerializationDelegate({String? groupName, bool summaryTree = false, int maxDescendantsTruncatableNode = -1, bool expandPropertyValues = true, int subtreeDepth = 1, bool includeProperties = false, required WidgetInspectorService service, Map<String, Object>? addAdditionalPropertiesCallback(DiagnosticsNode, InspectorSerializationDelegate)?, bool inDisableWidgetInspectorScope = false})
Creates an InspectorSerializationDelegate that serialize DiagnosticsNode for Flutter Inspector service.

Properties

addAdditionalPropertiesCallback → Map<String, Object>? Function(DiagnosticsNode, InspectorSerializationDelegate)?
Callback to add additional experimental serialization properties.
final
expandPropertyValues → bool
Whether properties that have a Diagnosticable as value should be expanded.
final
groupName → String?
Optional groupName parameter which indicates that the json should contain live object ids.
final
hashCode → int
The hash code for this object.
no setterinherited
includeProperties → bool
Whether to include the properties of a DiagnosticsNode in the serialization.
final
inDisableWidgetInspectorScope → bool
If true, tree nodes will not be reported in responses until an EnableWidgetInspectorScope is encountered.
final
maxDescendantsTruncatableNode → int
Maximum descendants of DiagnosticsNode before truncating.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
service → WidgetInspectorService
Service used by GUI tools to interact with the WidgetInspector.
final
subtreeDepth → int
Controls how many levels of children will be included in the serialized hierarchy of DiagnosticsNodes.
final
summaryTree → bool
Whether the tree should only include nodes created by the local project.
final

Methods

additionalNodeProperties(DiagnosticsNode node, {bool fullDetails = true}) → Map<String, Object?>
Returns a serializable map of additional information that will be included in the serialization of the given DiagnosticsNode.
override
copyWith({int? subtreeDepth, bool? includeProperties, bool? expandPropertyValues, bool? inDisableWidgetInspectorScope}) → InspectorSerializationDelegate
Creates a copy of this DiagnosticsSerializationDelegate with the provided values.
override
delegateForNode(DiagnosticsNode node) → DiagnosticsSerializationDelegate
Returns the DiagnosticsSerializationDelegate to be used for adding the provided DiagnosticsNode to the serialization.
override
filterChildren(List<DiagnosticsNode> nodes, DiagnosticsNode owner) → List<DiagnosticsNode>
Filters the list of DiagnosticsNodes that will be included as children for the given owner node.
override
filterProperties(List<DiagnosticsNode> nodes, DiagnosticsNode owner) → List<DiagnosticsNode>
Filters the list of DiagnosticsNodes that will be included as properties for the given owner node.
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited
truncateNodesList(List<DiagnosticsNode> nodes, DiagnosticsNode? owner) → List<DiagnosticsNode>
Truncates the given list of DiagnosticsNode that will be added to the serialization as children or properties of the owner node.
override

Operators

operator ==(Object other) → bool
The equality operator.
inherited