JsonTree.js - Documentation - Binding Options

Below is the JSON format and properties that can be used for the binding options.

Download Now

v2.1.0 - 19th Jul 2024
JSON Properties

Standard Options:

Type: Name: Description:
Object data States the data that should be used for the tree (defaults to null).
boolean showCounts States if the property/length counts should be shown for Objects/Arrays (defaults to true).
boolean useZeroIndexingForArrays States if the indexes should for arrays should start from zero (defaults to true).
string dateTimeFormat States the display format that should be used for date values (defaults to "{dd}{o} {mmmm} {yyyy} {hh}:{MM}:{ss}", refer to "Date Formats" documentation for formatting).
boolean showArrowToggles States if the toggle arrows should be shown (defaults to true).
boolean showStringQuotes States if quotes should be shown around string values (defaults to true).
boolean showAllAsClosed States if all the nodes should be closed when first rendered (defaults to false).
boolean sortPropertyNames States if the property names for an object should be sorted (defaults to true).
boolean sortPropertyNamesInAlphabeticalOrder States if the sorted property names for an object should be in alphabetical order (defaults to true).
boolean showCommas States if commas should be shown at the end of each line (defaults to false).
boolean reverseArrayValues States if the values from an array should be shown in reverse order (defaults to false).
boolean addArrayIndexPadding States if the indexes shown for an array should be padded (defaults to false).
boolean showValueColors States if the colors for the values should be shown (defaults to true).
number maximumDecimalPlaces States how many decimal places should be used for decimal values (defaults to 2).
number maximumStringLength States the maximum length a string can be in the display (defaults to 0, which will use the full length).
boolean showStringHexColors States if string HEX colors should show the actual color for the text display (defaults to false).
boolean showArrayItemsAsSeparateObjects States if base data array items should be shown on separate pages (defaults to false).
boolean copyOnlyCurrentPage States if the current page of JSON should be copied, instead of everything (when "showArrayItemsAsSeparateObjects" is true). (defaults to false).

Title Options:

Category: Type: Name: Description:
title string text The text that should be displayed for the "JsonTree.js" title bar label.
title boolean show States if the title should be shown (defaults to true).
title boolean showTreeControls States if the tree control button should be shown in the title bar (defaults to true).
title boolean showCopyButton States if the copy all button should be shown in the title bar (defaults to true).

Ignore Options:

Category: Type: Name: Description:
ignore boolean nullValues States if NULL values should be ignored and not rendered (defaults to false).
ignore boolean functionValues States if FUNCTION values should be ignored and not rendered (defaults to false).
ignore boolean unknownValues States if UNKNOWN values should be ignored and not rendered (defaults to false).
ignore boolean booleanValues States if BOOLEAN values should be ignored and not rendered (defaults to false).
ignore boolean decimalValues States if DECIMAL values should be ignored and not rendered (defaults to false).
ignore boolean numberValues States if NUMBER values should be ignored and not rendered (defaults to false).
ignore boolean stringValues States if STRING values should be ignored and not rendered (defaults to false).
ignore boolean dateValues States if DATE values should be ignored and not rendered (defaults to false).
ignore boolean objectValues States if OBJECT values should be ignored and not rendered (defaults to false).
ignore boolean arrayValues States if ARRAY values should be ignored and not rendered (defaults to false).