jsontree — u_pbt_jsontree #

← Referência dos componentes · Índice do guia

jsontree mostra um valor JSON como uma árvore recolhível, colorida por tipo: um ecrã de configuração, uma resposta de API, uma depuração de integração. Define o texto JSON em is_json, o componente mostra-o; um clique num nó reporta o seu caminho (ue_node_clicked), um JSON inválido levanta ue_error. Não modifica nada: é um VISUALIZADOR.

▶ Ver ao vivo — Aplicação de demonstração, mosaico JSON tree, com o código e esta página lado a lado.

Em resumo #

Início rápido #

// Show an API response as a tree
uo_json.is_json = inv_rest.of_response_text()

// Fold everything, then let the user open what interests them
uo_json.of_collapse_all()

// ue_node_clicked : the path of the node clicked ("lines/1/sku"), the path of
// n_pbt_json -> of_get_string(as_path) on the same text reads its value

Propriedades #

Métodos #

Eventos #

Exemplo #

Explorar a resposta de uma API #

// Fetch the order : the tree shows the response, or empties on a failure
if inv_rest.of_get(/*url*/ "https://api.example.com/orders/4152") = 200 then
	uo_json.is_json = inv_rest.of_response_text()
	uo_json.of_collapse_all()          // the reader opens what interests them
else
	uo_json.of_clear()
end if

Ler o valor de um nó clicado #

// Instance variable of the window : the response, parsed ONCE by n_pbt_json
n_pbt_json inv_doc

// When the response arrives : the tree shows it, n_pbt_json parses the same text once
uo_json.is_json = inv_rest.of_response_text()
inv_doc.of_load(/*json*/ inv_rest.of_response_text())

// ue_node_clicked of uo_json : the value at the clicked path, nothing parsed again
st_value.text = inv_doc.of_get_string(/*path*/ as_path)

// or, without a second parser : the value of the selected leaf, decoded
st_value.text = uo_json.of_selected_text()

Pesquisar palavras inteiras, com maiúsculas #

// Whole words only, with the same case : "id" is not found inside "user_id"
uo_json.ib_find_match_case = true
uo_json.ib_find_whole_word = true
uo_json.of_search(/*query*/ "id")

Manter as dobras quando a resposta é atualizada #

// Local variables
string ls_layout

// The folds, the selected node and the line at the top, kept before the new text
ls_layout = uo_json.of_get_layout()
uo_json.is_json = inv_rest.of_response_text()

// The same blocks fold again ; a path the new text no longer has is ignored
uo_json.of_set_layout(/*layout_json*/ ls_layout)

Um menu sobre um nó #

// ue_node_rclicked of uo_json : the node is selected, open YOUR menu at that point of the screen
uo_menu.of_show(/*x*/ al_x, /*y*/ al_y)

// ue_item_selected of uo_menu : copy the value, or the path for n_pbt_json
choose case as_keys
	case "copy"
		uo_json.of_copy()
	case "copypath"
		uo_json.of_copy_path()
end choose

Boas práticas #

• É um visualizador, não um editor: mostra o JSON, não o altera. Para ler um valor, passe o caminho de ue_node_clicked a n_pbt_json.of_get_string sobre o mesmo texto, ou leia of_selected_text.
• Um JSON grande continua fluido: só se desenham as linhas no ecrã, uma resposta de várias centenas de KB percorre-se com o teclado sem esperas. of_collapse_all primeiro continua a ser o mais legível.
• Um JSON inválido não parte nada: ue_error di-lo (com a linha e a coluna do erro), a árvore fica vazia. É a resposta a mostrar, não uma falha.
• Toda a chave tem um caminho: um / ou um ~ escreve-se nela ~1 ou ~0 (JSON Pointer), e n_pbt_json lê-a assim — paths/~1users~1{id} para uma especificação OpenAPI. Uma chave VAZIA é um nível vazio (a//b, / para a da raiz). Uma exceção, que of_selected_addressable assinala: o que está sob a segunda de duas chaves idênticas (o caminho designa a primeira).
• Da direita para a esquerda: um documento JSON é um texto da esquerda para a direita, e a árvore continua assim numa aplicação RTL (só a caixa de pesquisa segue o sentido da aplicação).
• O teclado fica com a árvore: Enter dobra um bloco ou «clica» numa folha (ue_node_clicked), nunca o botão predefinido da janela; Esc fecha primeiro a caixa de pesquisa aberta, depois volta à janela; as linhas de fecho (}, ]) não são posições da seleção; Ctrl+C copia a seleção (of_copy), ou o pedaço de texto realçado com o rato; Espaço dobra um bloco e nunca desloca a vista; a tecla Menu (Shift+F10) levanta ue_node_rclicked.
• Documentos muito grandes: acima de 1 500 000 linhas o documento é recusado com ue_error em vez de cortado em silêncio. A impressão (of_print, of_print_to_pdf) produz o que está aberto, até 10 000 linhas: um bloco dobrado imprime-se dobrado (of_expand_all antes, para imprimir tudo).

Herdado da base comum #

Estes membros existem em todos os componentes visuais — não são próprios deste. São detalhados uma só vez, nos capítulos transversais; esta tabela apenas diz onde os ler.

← Referência dos componentes · Índice do guia