imiger-fork/documents/backend2frontend.json @ 9bb7d6ed

Návrh JSONu
{
	"attributeTypes": [
		{
			"dataType": <string>,	//datový typ atributu (number, string, enum, ...)
			"name": <string>,		//název atributu
			"text": <string>		//může sloužit jako popisek atributu, nemusí být použit
		},
		...
	],

	"edgeArchetypes": [ 		//možné archetypy hran
		{
			"name": <string>, 	//název archetypu
			"text": <string> 	//může sloužit jako popisek archetypu, nemusí být použit
		},
		...
	],

	"vertexArchetypes": [		//možné archetypy vrcholů
		{
			"icon": <string>,  	// svg s ikonou
			"name": <string>,	//název archetypu
			"text": <string>	//může sloužit jako popisek archetypu, nemusí být použit

			// svg musí být pro správnou vizualizaci definován tak, aby obsahoval objekty, které leží uvnitř obdélníka [0; 0] až [12; 15]
			// dát pozor u svg na escapování uvozovek
		},
		...
	],

	"vertices": [							//vrcholy
		{
			"archetype": <int>,				//typ vrcholu (index v poli vertexArchetypes)
			"attributes": [
				[
					<string-key>
					<string-value>
				],
				...
			],
			"id": <int>,					//identifikátor vrcholu, který byl použit před zpracováním(filtrací) v backendu
			"text": <string>,				//text pro případné dodatečné info mimo atributy - nemusí být použito, může sloužit jako popisek vrcholu, např. když si uživatel zobrazí jeho detaily, nejdříve se zobrazí tento popisek a až pak hodnoty atributů, může sloužit i jen jako nosič informace, která nebude uživateli přístupná
			"title": <string>,				//jméno vrcholu
			"position": {								//obsahuje relativní pozici uzlu v grafu
				"x": <float>,
				"y": <float>
			}
		},
		...
	],

	"edges": [ 								//hrany
		{
			"subedgeInfo": [
				{
					"id": <int>,			//identifikátor hrany, který byl použit před zpracováním(filtrací) v backendu
					"archetype": <int>,		//typ hrany (index v poli edgeArchetypes)
					"attributes": [			//struktura atributu je vzdy klic - hodnota
						[
							<string-key>
							<string-value>
						],
						...
					]
				},
				...
			],
			"from": <int>,					//orignal id počátečního vrcholu
			"id": <int>,					//identifikátor hrany
			"text": <string>,				//podobně jako text u vertices
			"to": <int>,					//original id koncového vrcholu
		},
		...
	],

	"possibleEnumValues": {
		<attribute idx>: [
			<string>,
			<string>,
			...
		],
		...
	},

	"groups": [											//obsahuje jednotlivé skupiny uzlů
		{
			"id": <int>,								//identifikátor skupiny
			"name": <string>,							//název skupiny
			"verticesId": [<int>, <int>, ...],			//original id uzlu, které jsou ve skupině
			"verticesEdgeFromId": [<int>, <int>, ...],	//identifikátory uzlů, jejichž odchozí hrany jsou viditelné v grafu
			"verticesEdgeToId": [<int>, <int>, ...]		//identifikátory uzlů, jejichž příchozí hrany jsou viditelné v grafu
			"position": {								//obsahuje relativní pozici skupiny v grafu
				"x": <float>,
				"y": <float>
			}
		},
		...
	],

	"sideBar": [									//obsahuje seznam uzlů a skupin, které jsou umístěné v postraním panelu
		{
			"id": vertex-<int>/group-<int>,			//identifikátor uzlu nebo skupiny
			"isIconsDisplayed": <bool>					//identifikuje, zda budou u sousedů zobrazeny ikony
		},
		...
	],

	"highlightedVertex": vertex-<int>/group-<int>,		//identifikátor uzlu nebo skupiny, který je zvýrazněn
	"highlightedEdge": <int>							//identifikátor hrany, která je zvýrazněna
}