Skip to content

Latest commit

 

History

History
149 lines (119 loc) · 13.6 KB

README_HU.md

File metadata and controls

149 lines (119 loc) · 13.6 KB

VirtualDataGrid

Ez a magyar nyelvű README fájl, visszatérni az angol nyelvűre ide kattintva tudsz

Tartalomjegyzék

Összefoglaló

Mi is az a VirtualDataGrid?

Ez a project azért jött létre, hogy egy gyors és könnyen kezelhető alternatívát nyújtson a jelenleg a piacon fellelhető táblakezelő rendszereknek. Támogatott böngészők:

  • Google Chrome
  • Mozilla Firefox
  • Microsoft Edge
  • Microsoft Internet Explorer (11-es verzió)

Funkcionalitások

A jelenlegi funkcionalitás kulcsszavakban:

  • Több soros fejléc kezelése
  • Fejléc esetén cellák összevonása
  • Fix oszlopok kezelése
  • Sorbarendezés oszloponkként (típus szerint, vagy akár saját összehasonlító függvénnyel is!)
  • Keresés oszloponkként (típus szerint, vagy akár saját szűrő függvénnyel is!)
  • Szerkesztés, típusonkként különböző megvalósítással
  • Soronkénti vagy kötegelt mentés
  • Validáció, akár saját szabályok megadásával is

Jövőbeli célok, funkciók kulcsszavakban:

  • Oszlopok átrendezhetősége
  • Adat csoportok létrehozása
  • Összegzések oszloponkként, csoportonkként
  • Egyedi cellaformázás
  • Egyedi adatmegjelenítés
  • Párhuzamos szerkesztés kezelése, jelzése
  • Data-binding szerverrel websocketen vagy ajaxon keresztül
  • Sorok kijelölése, csoportos műveletek (szerkesztés, törlés, egyedi felhasználás eventek segítségével)
  • Objektum alapú fejléc generálás (komplex entitások esetén intelligens módon megadható elemek, amik automatikusan generálják a változó számú oszlopokat)
  • Állapot panel, irányító gombokkal (mentés, validációs hibák jelzése, lépkedés a szerkesztett cellák közt, stb)
  • Dinamikusan módosítható beállítások és adatszerkezet bevezetése publikus függvényekkel
  • Az adatok aszinkron betöltési lehetőségei (soronként, szegmensenként vagy az egészet háttérben)

Beállítások

A létrehozás során megadandó beállítás objektum attribútumai

Kulcs Típus Alapértelmezett érték Rövid leírás
selectors Objektum {} A selectorokat tartalmazó objektum
selectors.mainContainer Szöveg '.data-container' A táblázatot tartalmazó fő elem selectora
selectors.fixedContainer Szöveg 'fixed-container' A rögzített tárolójának az osztálya
selectors.fixedHeaderContainer Szöveg 'fixed-header-container' A rögzített fejléc tárolójának az osztálya
selectors.dataContainer Szöveg 'data-container' Az adatokat tartalmazó tárolójának az osztálya
selectors.dataHeaderContainer Szöveg 'data-header-container' Az adatok fejécét tárolójának az osztálya
selectors.saveButton Szöveg null A mentést végző gomb selectora.
Ha nincs beállítva akkor az event nem fog foglalkozni vele mentésnél.
dimensions Objektum {} A táblázat méretezési beállításait tartalmazó objketum
dimensions.cellWidth Szám 150 A cellák szélességét adja meg pixelben
dimensions.cellHeight Szám 50 A cellák magasságát adja meg pixelben
dimensions.cellPaddingVertical Szám 4 A cellák vertikális paddingja pixelben
dimensions.cellPaddingHorizontal Szám 8 A cellák horizontális paddingja pixelben
dimensions.cellBorderWidth Szám 1 A cellák borderjének szélességét adja meg
edit Objektum {} A szerkesztéshez tartozó beállításokat tartalmazó objektum
edit.enabled Boolean false 'true' érték esetén szerkeszthetőek csak a cellák globálisan
filter Objektum {} A szűréshez tartozó beállításokat tartalmazó objektum
filter.enabled Boolean false 'true' érték esetén globálisan engedélyezve lesz minden oszlopra a szűrés.
Minden oszlopnak az adattípusa alapján fog a szűrő mező megjelenni
filter.customFilter Függvény null Ha megvan adva egy függvény ennek a mezőnek, akkor globálisan lehet egyénileg
kezelni a szűrést. Ehhez szükség van arra, hogy a szűrés típusának 'custom'-ot
adjunk meg a cél oszlopban
sort Objektum {} A sorbarendezéshez tartozó beállításokat tartalmazó objektum
sort.enabled Boolean false 'true' érték esetén globálisan engedélyezve lesz minden oszlopra a sorbarendezés
sort.default Szöveg Az első oszlop kulcsa Az alapértelmezett szűrés oszlopát adhatjuk meg ezzel a beállítással.
sort.customSort Függvény null Ha megadjuk ezt a függvényt, akkor globálisan lehet egyénileg kezelni a sorbarendezést
A megadott függvény határozza meg a sorbarendezés során, hogy miylen sorrendbe lesznek
megjelenítve a cellák
eventHandlers Objektum {} Az eseménykezelő függvényeket lehet megadni ebben az objektumban
eventHandlers.onBeforeEdit Függvény null Szerkesztés előtt lefutó függvény. Lehetőség van megszakítani is a szerkesztést a saját
függvényünkön belül
eventHandlers.onValidation Függvény null Validációkor lefutó egyéni függvény. Saját ellenőrzés után akár meg is szakítható
a mentés folyamata!
eventHandlers.onAfterEdit Függvény null Szerkesztés után lefutó függvény. Utólagos számolásokhoz használható
eventHandlers.onBeforeSave Függvény null Mentés előtt lefutó függvény. Lehetőség van megszakítani a mentés folyamatát ezen belül
eventHandlers.onAfterSave Függvény null A mentést követően lefutó függvény. A mentés utáni igazításokhoz használható
locale Objektum {} A regionális beállításokat tartalmazó objektum
locale.name Szöveg 'en' A szövegek hely alapú kezelése érdekében megadható országkód. Pl sorbarendezéskor az
összehasonlítás esetén
dataSource Tömb [] A tábla elemeit tartalmazó tömb. Soronként egy objektum elemet tartalmaz
headers Tömb [ [] ] A fejlécek beállításait tartalmazó tömb. A tömb elemei soronkénti leíró tömbök. Minden
sor egy-egy tömb, aminek az elemei az oszlopot leíró objektumok.
fixedHeaders Tömb [ [] ] A rögzített fejlécek beállításait tartalmazó tömb. A tömb elemei soronkénti leíró tömbök.
Minden sor egy-egy tömb, aminek az elemei az oszlopot leíró objektumok.
uniqueId Szám 0 A táblázat egyedi azonosító száma. 1 től növekvően kerülnek kiosztásra az azonosítók

A header és a fixedHeader tömbökben lévő, az adott oszlopra vonatkozó beállításokat tartalmazó objektumok attribútumai.

Kulcs Típus Alapértelmezett érték Rövid leírás
key Szöveg null Az adott oszlopot beazonosító kulcs. Az utolsó sort leíró objektumokban kötelező mező!
text Szöveg key Az adott fejlécben megjelenő szöveg. Ha ninccs megadva, akkor a kulcs kerül megjelenítésre
dataType Szöveg 'string' Az adott oszlopban lévő elemek típusa. Ez határozza meg a szűrést, sorbarendezést és szerkesztést is!
filterType Szöveg 'equals' A szűrő által használt összehasonlítási eljárás neve.
filterDisabled Boolean false Az adott oszlop szűrési lehetőségének kikapcsolására szolgáló beállítás
sortDisabled Boolean false Az adott oszlop sorbarendezési lehetőségének kikapcsolására szolgáló beállítás
validatorObject Objektum {} Az adott cellához tartozó alap validátorokat leíró objektum. Bővebben lásd a validáció részen
customValidator Függvény null Az adott oszlophoz megadható egyedi validátor függvény. Az alap, beépített validátorokon felül ez is lefut minden cella szerkesztésénél. Üresen hagyva nem validál semmit

Funkcionális leírások

Tábla generálás

Sorbarendezés

Szűrés

Szerkesztés

Publikus függvények

Korlátok

Az alábbiak a későbbiekben még bekerülhetnek az alkalmazásba, azonban jelenleg ez nincs tervben:

  • Soronkénti vagy oszloponkkénti különböző méretezés (a számítási igény megnövekedése miatt)
  • Méretezhető mezők

Licensz

GNU GENERAL PUBLIC LICENSE - GPL 3.0

Hivatkozás a licensz teljes tartalmára.