Skip to content

Api dokumentáció

RebekaNagy edited this page May 9, 2021 · 7 revisions

Components

FullImageScreen

Konstansok

  • dispatch - aszinkron függvényhívásokhoz szükséges konstans
  • navigation - navigációhoz szükséges konstans
  • route - adott oldalhoz tartozó paraméterekt tartalmazó konstans
  • windowWidth - adott hardver képernyőjének szélessége
  • windowHeight - adott hardver képernyőjének magassága
  • actLabels - minden olyan címke azonosítóját tartalmazó lista, amely az adott megnyitott képhez van rendelve
  • otherLabels - minden olyan címke azonosítóját tartalmazó lista, amely nincs hozzárendelve az adott képhez
  • photoDate - az adott kép létrehozásának dátuma, vagy ennek hiányában a "No date information" szöveg
  • photoCountry - értéke, hogy az adott kép melyik országban készült, vagy ennek az információnak hiányában "No country information" szöveg
  • photoCity - értéke, hogy az adott kép melyik városban készült, vagy ennek az információnak hiányában "No city information" szöveg

Állapotok

  • photoState - referencia a store-ban tárolt képekre
  • labelState - referencia a store-ban tárolt címkékre
  • photoObject - aktuálisan megjelenített képet tartalmazó állapot
  • open - az odalon lévő FAB gomb nyitott-zárt állapota
  • visibleInfo - az adott kép információs felugró ablakának látható-nem látható állapota
  • visibleDelete - az adott kép törlésének jóváhagyás felugró ablakának látható-nem látható állapota
  • visibleLabel - az adott képhez tartozó címkék megtekintés és módosítás felugró ablakának látható-nem látható állapota

Funkciók

  • onLabelEditing(propLabel) - a propLabel változóban megkapott címke azonosítót paraméterül átadva átnavigál a címke szerkesztő oldalra
  • onStateChange() - megváltoztatja a FAB gombhoz tartozó állapot értékét
  • showInfo(), hideInfo() - az információs ablakhoz tartozó állapot értékét változtatják
  • showDelete(), hideDelete() - a törlés jóváhagyás ablakhoz tartozó állapot értékét változtatják
  • showLabel(), hideLabel() - a címkék ablakhoz tartozó állapot értékét változtatják
  • onDelete() - törli az adott képet a store-ból és visszalép az előző oldalra

GalleryScreen

Konstansok

  • dispatch - aszinkron függvényhívásokhoz szükséges konstans
  • filteredPhotoState - tartalmazza a szűrési feltételek alapján leszűkített képek listáját

Állapotok

  • photoState - referencia a store-ban tárolt képekre
  • labelState - referencia a store-ban tárolt címkékre
  • filterState - referencia a store-ban tárolt szűrési feltételekre
  • tempFilterState - állapot, amelyben tároljuk a szűrési feltételeken végzett módosításokat a jóváhagyás előtt
  • citiesCheckedState - bepipált városok állapota
  • state - az odalon lévő FAB gomb nyitott-zárt állapota
  • visibleFilter - szűrési feltételeket módosító felugró ablak látható-nem látható állapota
  • visibleSort - rendezés felugró ablakának látható-nem látható állapota
  • visibleFrom - kezdeti dátum módosításának felugró ablakának látható-nem látható állapota
  • visibleTo - vég dátum módosításának felugró ablakának látható-nem látható állapota
  • visibleCheck - városok kiválasztásának felugró ablakának látható-nem látható állapota
  • sortingValue - rendezés értékének állapota
  • sortingOrder - rendezés sorrendjének állapota
  • fromDate - dátumkiválasztó állapota
  • toDate - dátumkiválasztó állapota

Funkciók

  • copyFilterState(filterState) - lemásolja a paraméterben kapott filterState-et
  • checkChanged(cityName, countryName) - checkBox-ok tartozó állapot megváltoztatására használt függvény
  • showFilter(), hideFilter() - a szűrés ablakhoz tartozó állapot értékét változtatják
  • showSort(), hideSort() - a rendezés ablakhoz tartozó állapot értékét változtatják
  • showFrom(), hideFrom() - a kezdeti dátum ablakhoz tartozó állapot értékét változtatják
  • showTo(), hideTo() - a vég dátum ablakhoz tartozó állapot értékét változtatják
  • showCheck(), hideCheck() - a városok ablakhoz tartozó állapot értékét változtatják
  • onLocationPress() - a városok kiválasztása után frissíti a tempFilterState állapotot
  • onLabelPress() - a címkék módosítása esetén frissíti a tempFilterState állapotot
  • onFromDatePress() - a kezdeti dátum kiválasztása után frissíti a tempFilterState állapotot
  • onToDatePress() - a vég dátum kiválasztása után frissíti a tempFilterState állapotot
  • onMapSelectionPress() - törli a térképről érkező szűrési feltételeket
  • onConfirmPress() - frissíti a store-ban tárolt adatokat a tempFilterState állapotban lévőkkel, majd bezárja az ablakot
  • onDeletePress() - kitörli a tempFilterState állapotban tárolt adatokat
  • onCancelPress() - visszaállítja a tempFilterState állapotot a store-ban megegyezőre, és bezárja az ablakot
  • addPhotoByCamera() - új kép hozzáadása a galériába a kamera segítségével
  • addPhotoByGallery() - új kép hozzáadása a galériába a hardver galériájából

ImageList

Konstansok

  • navigation - navigációhoz szükséges konstans
  • imageSize - adott kép méretét tartalmazó konstans

Funkciók

  • onFullImage(propPhoto) - átnavigál a kinagyított képet tartalmazó oldalra
  • ImageListByLocation - hely szerinti listázást ad vissza a képeken
  • ImageListByDate - dátum szerinti listázást ad vissza a képeken
  • ImageList - listázást ad vissza a képeken

LabelEditingScreen

Konstansok

  • dispatch - aszinkron függvényhívásokhoz szükséges konstans
  • navigation - navigációhoz szükséges konstans
  • route - adott oldalhoz tartozó paraméterekt tartalmazó konstans
  • windowHeight - adott hardver képernyőjének magassága
  • id - paraméterként megkapott címke azonosító
  • initLabel - a paraméterben megkapott azonosító szerinti címke, azonosító hiányában új alapértelmezett címke

Állapotok

  • labelObject - oldalon módosítandó címke állapota
  • visibleDelete - törlés jóváhagyásának felugró ablakának látható-nem látható állapota
  • visibleCancel - mégse jóváhagyásának felugró ablakának látható-nem látható állapota

Funkciók

  • onTextChange() - címke szövegének változása esetén frissíti az adott címkét
  • onColorChange() - címke színének változása esetén frissíti az adott címkét
  • onConfirming() - attól függően hogy már létezett-e az adott címke a store-ban, vagy frissíti vagy létrehozza azt, majd visszanavigál az előző oldalra
  • onCanceling() - változtatás nélkül visszanavigál az előző oldalra
  • onDeleting() - törli az adott címkét a store-ból, majd visszanavigál az előző oldalra
  • showDelete(), hideDelete() - törlés ablakhoz tartozó állapotot változtatják
  • showCancel(), hideCancel() - mégse ablakhoz tartozó állapotot változtatják
  • handleBackButtonClick() - visszagomb esetén visszanavigál az előző oldalra

MapScreen

Konstansok

  • dispatch - aszinkron függvényhívásokhoz szükséges konstans
  • navigation - navigációhoz szükséges konstans
  • photos - szűrt képeket tartalmazó lista
  • mapStyles - térkép típusokat tartalamzó lista
  • clusterStyles - klaszter típusokat tartalmazó lista
  • weightedLatLngs -

Állapotok

  • photoState - referencia a store-ban tárolt képekre
  • searchTermState- referencia a store-ban tárolt szűrési feltételekre
  • style - térkép stílust tartalmazó állapot
  • clusterType - klaszter stílust tartalmazó állapot
  • region - aktuális régió
  • fabProps - FAB gombokhoz tartozó tulajdonságok
  • drawingMode - rajzolási módot tartalmazó állapot
  • circle - megjelenített kör
  • rectangle - megjelenített négyszög
  • visibleMapOption - térkép stílus választó felugró ablakának látható-nem látható állapota

Funkciók

  • showMapOption(), hideMapOption() - térkép stílus ablakhoz tartozó állapotot változtatják
  • onMapReady() - engedélyezteti a lokáció hozzáférést
  • onRegionChangeComplete(newRegion) - beállítja az új régiót
  • onMarkerPress(markerId) - átnavigál a FullImageScreen-re
  • onClusterPress(_cluster, markers) - átnavigál a GalleryScreen-re és leszűri a képeket
  • onPanDrag(event) - rajzoláskor módosítja a kör/négyszög alakzatot
  • onMapTouchEnd() - átnavigál a GalleryScreen-re, és módosítja a szűrési feltételeket
  • onCircleDrawing)() - beállítja a rajzolás módját
  • onRectangleDrawing() - beállítja a rajzolás módját
  • onFabStateChange(stateOpen) - megnyitja a rajzolási funkciókat
  • onFabPress() - eltűnteti a rajzolt kört/négyzetet, és módosítja a szűrési feltételeket

Enums

clusterType

cluster, heatmap

drawingMode

None, Circle, Rectangle

mapStyle

standard, hybrid, terrain, night

screen

GalleryScreen, MapScreen, GeoGallery, EditingLabel, FullImage

stateEnum

labels, photos

Helpers

drawing

Funkciók

  • distanceByLatLng(latLng1, latLng2) - visszaadja a két paraméterben megkapott pont közötti távolságot
  • getDistance(lat1, lon1, lat2, lon2) - visszaadja a paraméterben megkapott pontok közötti távolságot

exifDataReader

Funkciók

  • getLatLongFromExif(exif) - kinyeri az exif adatból a hosszúsági és szélességi adatokat
  • getDateTimeFromExif(exif) - kinyeri az exif adatból a dátum adatot

functions

Funkciók

  • findIndexById(array, id) - azonosító alapján visszaadja az elem indexét a tömbben
  • getNewId() - létrehoz egy új azonosítót
  • devConsoleLog(log) - fejlesztői módban konzolra írja a paraméterül kapott változót
  • onlyUnique(value, index, self) - eltávolítja a duplikátumokat
  • groupBy(xs, key) - a tömb elemeit csoportosítja a kapott kulcs alapján
  • imageToPhoto(image, type, latLng) - a behúzott képet alakítja át megfelelő formátumra, kinyerve belőle a lokációs, és dátum adatokat

searchFilter

Funkciók

  • galleryFilter(photoState, searchTermState) - leszűri a fotókat a galéria számára, az adott szűrési feltételek szerint
  • mapFilter(photoState, searchTermState) -leszűri a fotókat a térkép számára, az adott szűrési feltételek szerint
  • getCountriesAndCities(photoState) - visszaadja a városokat a megfelelő országgal együtt
  • getCountriesAndCitiesWithPhotosAscending(photoState) - országok és városok szerint rendezve növekvően visszaadja a képeket
  • getCountriesAndCitiesWithPhotosDescending(photoState) - országok és városok szerint rendezve csökkenően visszaadja a képeket
  • getOrderByDateTimeAscending(photoState) - dátum szerint rendezve növekvően visszaadja a képeket
  • getOrderByDateTimeDescending(photoState) - dátum szerint rendezve csökkenően visszaadja a képeket

Interfaces

label

id: string, text: string, color: string, photos: string[]

photo

id: string, imageUri: string, type: ImageType, labels: string[], width: number, height: number, longitude?: number, latitude?: number, createDate?: Date, address?: string, country?: string, city?: string

searchTerm

countries: string[], cities: string[], dateTo?: Date, dateFrom?: Date, labels: string[], circle?: MapCircleProps, polygon?: LatLng[], photoIdsByClusterFilter?: string[]

Storage - actions

comonAction

Funkciók

  • initState() - konstruktor
  • commonDeletePhoto(photo) - kitörli a képet, valamint a címkékre való hivatkozásait
  • commonDeleteLabel(labelId) - kitörli a címkét, valamint a képekre való hivatkozásait
  • commonAddLabelToPhoto(photoId, labelId) - hozzáadja a képhez az adott címkét
  • commonRemoveLabelFromPhoto(photoId, labelId) - eltávolítja a képtől az adott címkét

labelAction

Funkciók

  • createLabel(newLabel) - létrehoz egy címkét
  • updateLabel(label) - módosít egy címkét

photoAction

Funkciók

  • addPhoto(photoForAdd) - létrehoz egy fotót, és eltárolja a hardver fájlrendszerében
  • addMultiplePhoto(photoForAdds) - létrehoz több fotót, és eltárolja őket a hardver fájlrendszerében

searchTermAction

Funkciók

  • updateSearchTerm(searchTerm) - módosítja a szűrési feltételeket

App

Konstansok

  • dispatch - aszinkron függvényhívásokhoz szükséges konstans