You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
87 lines
7.1 KiB
87 lines
7.1 KiB
{% extends 'base.html.twig' %}
|
|
|
|
{% block title %}
|
|
Dokumentace
|
|
{% endblock %}
|
|
|
|
{% block body %}
|
|
{{ parent() }}
|
|
<main>
|
|
<div id="indexDiv">
|
|
<h1>Dokumentace aplikace</h1>
|
|
<p>V této dokumentaci se nacházejí ukázky grafů, které je možné pomocí této aplikace vyrobit. Lze je exportovat ve statické formě, nebo je vkládat na webové stránky pomocí:</p>
|
|
<p>
|
|
<strong>< iframe src="example.com/charts/6645cec13703bac5a30e6a41"> </iframe >
|
|
</strong>
|
|
</p>
|
|
<section>
|
|
<iframe src={{ path('charts_display', {'id': "6645cec13703bac5a30e6a41"} ) }}></iframe>
|
|
<p>
|
|
Bodové grafy jsou základním nástrojem pro vizualizaci datových bodů na rovině. Každý bod v grafu reprezentuje jednu konkrétní hodnotu nebo pozorování. Tyto datové body mohou být v závislosti na datech rovnoměrně nebo nerovnoměrně rozloženy napříč vodorovnou osou. Tento typ grafu je ideální pro zobrazování vztahů mezi dvěma proměnnými a umožňuje identifikovat vzory, korelace a odlehlé hodnoty. Někdy se jim proto říká korelační diagramy. V bodových grafech jsou jednotlivé body umístěny na kartézské soustavě souřadnic. Mohou být v některých případech i trojrozměrné a každý bod tedy popisují tři souřadnice, ale v praxi se tato verze příliš nepoužívá kvůli špatné přehlednosti. Bodové grafy jsou často využívány k analýze dat ve vědeckém výzkumu, ekonomii, sociologii a dalších disciplínách, kde je potřeba vizualizovat vztahy mezi proměnnými.
|
|
</p>
|
|
</section>
|
|
|
|
<section>
|
|
<iframe src={{ path('charts_display', {'id': "664657fdf6b92077ce0bd5a3"} ) }}></iframe>
|
|
<p>
|
|
Spojnicové grafy se používají k vizualizaci vztahů mezi body v čase nebo v závislosti na jiné proměnné. Tento typ grafu je vhodný pro zobrazování trendů, vývoje a dynamiky dat. Ve spojnicových grafech jsou body spojeny čarami, které zobrazují vztah mezi nimi. Tyto čáry obvykle představují vývoj dat v čase nebo vztah mezi dvěma proměnnými. Na rozdíl od bodového grafu jsou data téměř vždy rovnoměrně rozprostřena po celé délce vodorovné osy. Spojnicové grafy jsou často využívány k vizualizaci dat jako je vývoj cen, teplot nebo akcií.
|
|
</p>
|
|
</section>
|
|
|
|
<section>
|
|
<iframe src={{ path('charts_display', {'id': "664659bc3703bac5a30e6a42"} ) }}></iframe>
|
|
</section>
|
|
|
|
<section>
|
|
<iframe src={{ path('charts_display', {'id': "66465ab0f6b92077ce0bd5a4"} ) }}></iframe>
|
|
<p>
|
|
Plošné grafy vizualizují data jako plné oblasti, kde každá oblast reprezentuje jednu datovou kategorii. Tyto grafy jsou ideální pro srovnávání hodnot mezi různými kategoriemi a pro zjištění jejich relativního podílu. Jednou z hlavních výhod plošných grafů jednoduchost interpretace, protože plné plochy poskytují přehledný obraz o datech a umožňují snadno vizuálně porovnávat velikosti jednotlivých kategorií. Plošné grafy mohou nést i některé nevýhody. Mezi ně patří možná ztráta podrobností, pokud je potřeba zobrazit detailnější informace nebo individuální hodnoty. Mohou být často viděny v oblastech jako marketing, ekonomie nebo třeba ve zdravotnictví, pro srovnání prevalence různých onemocnění.
|
|
</p>
|
|
</section>
|
|
|
|
<section>
|
|
<iframe src={{ path('charts_display', {'id': "66465b9ff6b92077ce0bd5a5"} ) }}></iframe>
|
|
<p>
|
|
Koláčové grafy jsou kruhové diagramy, které vizualizují data jako procentuální části celku. Každý segment v grafu odpovídá určitému procentu celkového množství. Koláčové grafy jsou často využívány pro prezentaci procentuálního rozložení různých položek, jako jsou například náklady, zisky nebo populace. Jsou také vhodné pro zobrazení struktury portfolia, podílu tržního segmentu a demografických trendů. Mohou však být méně efektivní při zobrazení velkého počtu kategorií a mohou být matoucí, pokud jsou některé segmenty příliš malé na to, aby byly přehledné.
|
|
</p>
|
|
</section>
|
|
|
|
<section>
|
|
<iframe src={{ path('charts_display', {'id': "66465be2f6b92077ce0bd5a6"} ) }}></iframe>
|
|
</section>
|
|
|
|
<section>
|
|
<iframe src={{ path('charts_display', {'id': "66465c073703bac5a30e6a43"} ) }}></iframe>
|
|
<p>
|
|
Sloupcové grafy jsou vynikajícím nástrojem pro vizualizaci dat, které mají jasně definované kategorie a hodnoty. Data reprezentují pomocí svislých sloupců, kde výška sloupce odpovídá hodnotě datového bodu. Jsou ideální pro srovnávání hodnot mezi různými kategoriemi a rychlé pochopení relativních hodnot. Tento typ grafu je často využíván v různých oblastech, jako jsou ekonomie, marketing, nebo vědecký výzkum, kde je potřeba srovnávat hodnoty mezi různými skupinami nebo kategoriemi dat. Díky své jednoduché interpretaci a přehlednému zobrazení je sloupcový graf oblíbeným nástrojem nejen pro analyzování dat, ale i pro prezentaci výsledků a komunikaci významných trendů nebo rozdílů.
|
|
</p>
|
|
</section>
|
|
|
|
<section>
|
|
<iframe src={{ path('charts_display', {'id': "66465c4c3703bac5a30e6a44"} ) }}></iframe>
|
|
<p>
|
|
Skládané grafy představují pokročilejší formu sloupcových grafů, kde každý sloupec zobrazuje kumulativní hodnoty všech kategorií namísto jednotlivých hodnot. Skládané grafy jsou užitečné pro porovnání celkové velikosti a struktury různých skupin dat a používají se proto při vizualizaci trendů, jako jsou například příjmy, náklady nebo produkční výstupy.
|
|
</p>
|
|
</section>
|
|
|
|
<h2>API</h2>
|
|
<section>
|
|
<p>API pro správu grafů poskytuje několik koncových bodů pro získání seznamu grafů, zobrazení detailů konkrétního grafu, vkládání nových grafů, aktualizaci stávajících grafů a mazání grafů.</p>
|
|
|
|
<ul>
|
|
<li><strong>GET /api/charts</strong>: Vrací seznam ID grafů, jež patří přihlášenému uživateli. Odpověď obsahuje seznam ID grafů a HTTP kód 200 OK.</li>
|
|
|
|
<li><strong>GET /api/charts/{id}</strong>: Endpoint vrací detailní informace o grafu na základě jeho ID. Odpověď obsahuje detailní informace o grafu a kód 200.</li>
|
|
|
|
<li><strong>POST /api/charts/insert</strong>: Umožňuje uživateli vytvořit nový graf. Data grafu se posílají v těle zprávy ve formátu JSON. Backend následně vytvoří novou entitu a přiřadí jí unikátní ID. Odpověď obsahuje název vytvořeného grafu s HTTP kódem 200. Uživatel musí být přihlášen, jinak se vrátí chyba přístupu s HTTP kódem 403.</li>
|
|
|
|
<li><strong>POST /api/charts/{id}/update</strong>: Umožňuje uživateli aktualizovat jeho grafy. Data se posílají v těle zprávy jako JSON. Obsahem odpovědi je název aktualizovaného grafu s HTTP kódem 200. Pokud graf patří jinému uživateli, vrátí se chyba přístupu s HTTP kódem 403.</li>
|
|
|
|
<li><strong>DELETE /api/charts/{id}/remove</strong>: Umožňuje smazat existující graf. Odpověď obsahuje název smazaného grafu s HTTP kódem 200. Uživatel může mazat pouze své vlastní grafy, jinak se vrátí chyba přístupu s kódem 403</li>
|
|
|
|
</ul>
|
|
</section>
|
|
</div>
|
|
</main>
|
|
{% endblock %}
|