6bc369629d
* trying out api-extractor. * works with our setup of build. * wip. * changed the packages so it works better with the api-extractor. * Changes to make the api-extractor to work. * cleaned up the api-extractor config files. * added some more documentation. * added tsdoc-metadata to gitignore. * removed the generated docs (will do that in another PR). * added execute permission to script for generating dosc. * added so we will push generated docs to branch. * will clean packages_api on abort. * Fixed failing tests. * fixed formatting issue with typedoc comment. * temporarily disabled tslint rules about namespace until https://github.com/microsoft/rushstack/issues/1029 is resolved * temporary enabled bable namespaces. * updated build script. * updated script. * updated script with some colors. * changed to camelCase. * removed spacing. * Starting to add documentation guidelines. * added examples headline. * added menu options. * added parameters and return values. * Fixed merge error. * Added first version of auto-generated docs. * changed so we use the eslint ignore syntax. * changed to correct eslint ingnore comment. * fixed some spelling errors reported by codespell. * added script to generate docs in current folder. * updated api docs. * lerna bootstrap. * added eror to the ingore words list. * removed file that should be ignored. * updated locKFILE. * referenced the code comments guidelines. * updated packages. * updated deps. * updated the autogenerated dosc. * adding missing new line.
4.2 KiB
+++
-----------------------------------------------------------------------
Do not edit this file. It is automatically generated by API Documenter.
-----------------------------------------------------------------------
title = "JsonExplorer" keywords = ["grafana","documentation","sdk","@grafana/ui"] type = "docs" draft = true +++
JsonExplorer class
JsonExplorer
JsonExplorer allows you to render JSON objects in HTML with a **collapsible** navigation.
Signature
export declare class JsonExplorer
Import
import { JsonExplorer } from '@grafana/ui';
Constructors
| Constructor | Modifiers | Description |
|---|---|---|
| constructor(json, open, config, key) | Constructs a new instance of the JsonExplorer class |
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| json | any |
Methods
| Method | Modifiers | Description |
|---|---|---|
| appendChildren(animated) | Appends all the children to children element Animated option is used when user triggers this via a click | |
| isNumberArray() | ||
| openAtDepth(depth) | Open all children up to a certain depth. Allows actions such as expand all/collapse all | |
| removeChildren(animated) | Removes all the children from children element Animated option is used when user triggers this via a click | |
| render(skipRoot) | Renders an HTML element and installs event listeners | |
| renderArray() | ||
| toggleOpen() | Toggles isOpen state |
constructor(json, open, config, key)
Constructs a new instance of the JsonExplorer class
Signature
constructor(json: any, open?: number, config?: JsonExplorerConfig, key?: string | undefined);
Parameters
| Parameter | Type | Description |
|---|---|---|
| json | any |
|
| open | number |
|
| config | JsonExplorerConfig |
|
| key | string | undefined |
json property
Signature
json: any;
appendChildren method
Appends all the children to children element Animated option is used when user triggers this via a click
Signature
appendChildren(animated?: boolean): void;
Parameters
| Parameter | Type | Description |
|---|---|---|
| animated | boolean |
Returns:
void
isNumberArray method
Signature
isNumberArray(): boolean;
Returns:
boolean
openAtDepth method
Open all children up to a certain depth. Allows actions such as expand all/collapse all
Signature
openAtDepth(depth?: number): void;
Parameters
| Parameter | Type | Description |
|---|---|---|
| depth | number |
Returns:
void
removeChildren method
Removes all the children from children element Animated option is used when user triggers this via a click
Signature
removeChildren(animated?: boolean): void;
Parameters
| Parameter | Type | Description |
|---|---|---|
| animated | boolean |
Returns:
void
render method
Renders an HTML element and installs event listeners
Signature
render(skipRoot?: boolean): HTMLDivElement;
Parameters
| Parameter | Type | Description |
|---|---|---|
| skipRoot | boolean |
Returns:
HTMLDivElement
{HTMLDivElement}
renderArray method
Signature
renderArray(): Element;
Returns:
Element
toggleOpen method
Toggles isOpen state
Signature
toggleOpen(): void;
Returns:
void