When set to true, the TreeNode._index attribute will be non-enumerable.
As a consequence, {@link JSON.stringify} will not serialize the index.
It is however still possible to recompute the index, by calling indexTree.
When set to true, illegally encoded data will raise an exception.
This can occur when dealing with ANSEL encoded data.
The default behavior is the insertion of a unicode replacement character.
When set, disables the automatic charset detection mechanism and forces the parser to decode the file using the specified charset. This is an escape hatch and its usage is not recommended; if you encounter issues with the detection mechanism please open a ticket instead.
When set to true the backwards references of the root node will not be stored (namely spouse and sibling relationships).
This option only has an effect when noIndex is not set, and as for that option it will not affect correctness of other components.
It will incur a slowdown when querying backward references.
When set to true completely disabled the indexing in the tree.
This option can be safely set without affecting the correctness of the other components that may use the tree.
However, it will incur a slowdown when querying the tree.
When set to true the Tag.Concatenation and Tag.Continuation special tags will not get interpreted and will be preserved in the resulting tree.
This option might affect the behavior of other components.
Otherwise the tags will get inlined according to their respective semantics, and thus will never appear in the output.
An optional callback used to track the progress. Can also be used to implement preemptive multitasking (unblock the rendering thread).
The current phase
The progress of the phase, indicated by a number between 0 and 1, or null if the progress cannot be determined
Generated using TypeDoc
When set to
trueall the TreeNode in the tree will be frozen and modifications will be forbidden by the runtime. Otherwise the objects will remain normal. This option is not enabled by default for performance reasons.