ה-API של בעל הרשאת הצפייה המוטמעת מכיל מחלקה אחת: DefaultViewer. אם אתם צריכים מבוא לשימוש ב-API, עיינו במדריך למפתחים.
סיכום מבנה
google.books.DefaultViewer(div, opt_options)
- מציג מוטמע של כרך ב-Google Book Search.
סיכום השיטה
string getPageNumber()
- מחזירה את מספר הדף שמוצג כרגע באזור התצוגה.
string getPageId()
- מחזיר מזהה ייחודי לדף שמוצג כרגע באזור התצוגה.
boolean goToPage(pageNumber)
- מחזירה את הערך True אם הדף כבר קיים והופנה אליו.
boolean goToPageId(pageId)
- מחזירה את הערך True אם הדף כבר קיים והופנה אליו.
boolean isLoaded()
- מציין אם הצופה הופעל בהצלחה עם הספר הנתון.
highlight(opt_string)
- מדגיש מונח באזור התצוגה.
load(identifiers, opt_notFoundCallback, opt_successCallback)
- טוען ספר באזור התצוגה.
nextPage()
- מעבר אל הדף הבא בספר.
previousPage()
- מעבר לדף הקודם בספר.
resize()
- הגודל של הצופה משתנה בהתאם לגודל המאגר שלו.
zoomIn()
- התקרבות למציג.
zoomOut()
- מקטין את התצוגה.
פרטי הבונה
google.books.DefaultViewer
google.books.DefaultViewer(div, opt_options)
-
מציג מוטמע של כרך ב-Google Book Search.
-
פרמטרים:
Element div
– מכוונים את אזור התצוגה כדי למשוך את העכבר.
Object opt_options
– מפה של ערכי מפתח שאפשר להעביר לצופה.
פרטי השיטה
getPageNumber
string getPageNumber()
-
מחזירה את מספר הדף שמוצג כרגע באזור התצוגה.
-
החזרות:
string
getPageId
string getPageId()
-
מחזיר מזהה ייחודי לדף שמוצג כרגע
באזור התצוגה.
-
החזרות:
string
GoToPage
boolean goToPage(pageNumber)
-
פונקציה זו מחזירה את הערך true אם הדף קיים והופנה אליו.
-
פרמטרים:
string, number pageNumber
– מספר הדף שאליו יש להפנות את הדף.
-
החזרות:
boolean
מזהה הדף
boolean goToPageId(pageId)
-
פונקציה זו מחזירה את הערך true אם הדף קיים והופנה אליו.
-
פרמטרים:
string pageId
– המזהה הייחודי של הדף שאליו יש לפנות.
-
החזרות:
boolean
טעון
boolean isLoaded()
-
מחזירה true אם הצופה אותחל בהצלחה עם הספר הנתון באמצעות
load
.
-
החזרות:
boolean
בפוקוס
highlight(opt_string)
-
מדגיש מונח באזור התצוגה.
-
פרמטרים:
string opt_string
– מחרוזת להדגשה. המערכת משביתה את ההדגשה אם
null
או undefined
.
משקל
load(identifiers, opt_notFoundCallback, opt_successCallback)
-
מתבצעת טעינה של ספר באזור התצוגה.
-
פרמטרים:
string, Array of strings identifiers
– כתובת URL של תצוגה מקדימה או מזהה של ספר, כמו ISBN, OCLC וכו'. אפשר לעיין בפורמט הבקשה לקישורים דינמיים. כדי לציין מספר מזהים חלופיים עבור הספר (למשל, מספרי ה-ISBN של כריכה קשה וכריכה רכה), יש להעביר Array
מהמחרוזות האלה. הצופה יטען את הספר הראשון שניתן להטמעה במערך.
Function opt_notFoundCallback
– אם הערך identifier
הוא מזהה ספר, הקריאה החוזרת הזו תיקרא אם הספר לא נמצא. אם הפרמטר null
עבר את התהליך או שהפרמטר
לא מושמט, המערכת לא תקרא לפונקציית הכשל.
Function opt_successCallback
– הקריאה החוזרת הזו תופעל
אם וכאשר המשתמש ייווצר בהצלחה עם ספר מסוים, והוא יהיה מוכן לקבלת קריאות לפונקציה כמו nextPage
.
NextPage
nextPage()
-
מעבר לדף הבא בספר.
הקודםPage
previousPage()
-
מעבר אל הדף הקודם בספר.
שינוי גודל
resize()
-
משנה את גודל הצופה כך שיתאים לגודל המאגר שלו div.
zoomIn
zoomIn()
-
הגדלת התצוגה.
Zoomout
zoomOut()
-
מקטין את התצוגה.