Pageflip5 documentation

Pageflip5 API

Pageflip ist eine Erweiterung der bekannten jQuery-Bibliothek, derzeit nicht unterstützt wird die jQuery Ausführungswarteschlange.

Es gibt zwei Methoden in der jQuery-Bibliothek, die duch die Auswahl des Pageflip div-Container (div # pageflip) aufgerufen werden:

  • pageflipInit()
  • pageflip()

pageflipInit()

Es initialisiert die Pageflip engine, und zeigt das Buch. Es hat 2 Parameter, das Konfigurations-Objekt und eine optionale alphanumerische ID, die verwendet werden, um ein eindeutige URL für das Buch zu schaffen ist, und fügte eine Klasse zu den pageflip DOM Teilen hinzu.

pageflip()

Es gibt den pageflip Context zurück, ein Objekt mit Funktionen, um das Buch zu steuern, dies ist die pageflip API. Hier ist die komplette Liste der Funktionen:

gotoPage( ipn, skip )
Geht zur internen Seitennummer ipn, die mit 0 beginnt, und basieren auf links Richtung geschrieben. Springen ist standardmäßig aktiviert, was bedeutet, die Zielseite mit einem einzigen Aufschlagen erreicht ist, anstelle von Blättern durch viele Seiten.
gotoPageNumber( pn, skip )
Geht zur Seite pn bezogen auf die sichtbare Seite.
gotoPageName( name, skip )
Geht zur Seite mit dem Namen name, gesetzt mit der data-page-name Option (Groß-und Kleinschreibung).
gotoPageLabel( label, skip )
Geht zur erstenmit dem Label label, gesetzt mit der data-page-label Option (Groß-und Kleinschreibung).
gotoFirstPage( isButton )
Geht zur ersten Seite. Falls isButton true ist, ignoriert es RightToLeft Option.
gotoLastPage( isButton )
Geht zur letzten Seite.
gotoPrevPage( isButton )
Blättert zur vorherigen Seite.
gotoNextPage( isButton )
Blättert zur nächsten Seite.
getID()
Gibt die Buch ID zurück, wenn vorhanden.
getPN()
Liefert den aktuellen internen Seitenzahl (IPN)
getPageNumber()
Liefert die aktuelle sichtbare Seitenzahl.
data( ipn, [mydata] )
Gibt die Seite IPN-Daten (zuvor eingestellten mit data-data Page Option) falls mydata nicht gesetzt ist. Wenn mydata vorgesetzt ist, wird IPN mit diesem Wert überschrieben.
mouseControl( isEnabled )
Aktivieren / Deaktivieren der Maus und Touch-Steuerung des Buches.
hotKeys( isEnabled )
Aktivieren / Deaktivieren der Tastatur-Steuerung des Buches.
startAutoFlip( [isInstant] )
Startet die automatische Blättern. Wenn isInstant true ist, beginnt das Blättern sofort, oder es wird durch die AutoFlipInterval Config Option verzögert.
stopAutoFlip()
Hör auf damit..
toggleAutoFlip()
Schalten AutoFlip um.
setPFEventCallBack( Object )
Aktiviert unsere benutzerdefinierten Event-Handler Object. Dieses Objekt enthält Funktionen, die durch pageflip aufgerufen werden, basierend auf welches Ereignis auftritt. Siehe später.
showThumbnails()
Zeigt die Miniaturen (wenn AutoHide aktiviert ist)
hideThumbnails()
Miniaturansichten ausblenden
zoomIn()
Vergrößern, wenn möglich.
zoomOut()
Verkleinern.
toggleZoom()
Zoom umschalten.
enterFullScreen()
Schaltet den Vollbildmodus, wenn möglich.
exitFullScreen()
Beenden Vollbildmodus.
closePageflip()
Schließt pageflip.

Fast alle Funktionen sind sehr einfach und leicht zu verstehen, eine von ihnen braucht mehr Erklärung, das ist, wie die setPFEventCallBack Funktion arbeitet.

setPFEventCallBack( EventCallBackObject )

Sie können Ihre eigenes Ereignis-Callback-Objekt an diese Funktion übergeben, damit pageflip Ihre benutzerdefinierten Event-Handler-Funktion aufrufen. SO sieht ein Ereignis-Callback-Objekt aus:

Sie können Ihr eigenes Skript für jedes der Ereignis-Typen schreiben, nachdem welche der Buchseiten tatsächlich gerade sichtbar sind oder blättern, usw. Also haben gerade ein Ereignis-Callback-Objekt definiert, jetzt wollen wir es unseren pageflip zuweisen: ( Das Beispiel zeigt es bei der Initialisierung von pageflip)

Der Grund, warum es vor dem Start pageflip definiert ist, ist dass wir sonst das erste Ereigniss verpassen.

onFlip

Wenn ein Blätternn beginnt, beide Seiten erhalten dieses Ereignis. Die Variable PN ist die interne Seitennummer.

onFlipEnd

Wenn eine Seite fertig geblättern wurde.

onTop

Wenn kein Blättern im Gange ist, die sichtbaren Seiten erhalten dieses Ereignis. Dies ist der richtige Zeitpunkt um Animationen auf Ihrer Seite zu starten oder etwas auf der Seite sichtbar zu machen.

onTopEnd

Wenn die Top-Status endet.

onLoad

Wenn die Seite zum DOM hinzugefügt wird. Hier können Sie wenn nötig die Seite initialisieren , wenn sie sichtbar wird, ist es bereit.

onUnload

Wenn die Seite aus dem DOM entfernt wird. Dies ist die letzte Chance zum per Skrift auf den Seiteninhalt zugreifen.

onHide

Kann eine Seite kann nicht entladen werden (with data-unload="false" Page Option), statt des Entfernens der Seite, wird sie einfach versteckt, und ist immer noch der Teil des DOM.

onShow

Wenn eine verborgene Seite wieder sichtbar wird.

onZoomIn

Wenn die Seite vergrößert wird. Bitte beachten Sie, dass die Seitenzahl diesem Event-Handler übergeben wird, aber das ganze Buch vergrößert wird. Sie können Sie auf eine andere Seite blättern, ohne dieses Ereignis erneut zu starten.

onZoomOut

Wenn die Seite verkleinert.