ה-Embedded Viewer API מכיל מחלקה אחת: DefaultViewer. מבוא לשימוש ב-API זמין במדריך למפתחים.
סיכום הבונה
google.books.DefaultViewer(div, opt_options)
- מציג מוטמע של כרך ב-Google Books 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()
- שינוי גודל הצופה בהתאם לגודל של ה-div שלו בקונטיינר.
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
goToPageId
boolean goToPageId(pageId)
-
הפונקציה מחזירה את הערך True אם הדף קיים והופנה אליו.
-
פרמטרים:
string pageId
- המזהה הייחודי של הדף שאליו רוצים להפנות.
-
החזרות:
boolean
isLoaded
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
הוא מזהה
של ספר, תתבצע קריאה חוזרת (callback) הזה אם הספר לא נמצא. אם מעבירים את null
או
שהפרמטר הזה מושמט, לא תתבצע קריאה לאף פונקציה במקרה של כשל.
Function opt_successCallback
– הקריאה החוזרת (callback) הזו תתבצע
אם וכאשר הצופה נוצר בהצלחה עם ספר מסוים, והוא מוכן
לקבל קריאות של פונקציות כמו nextPage
.
nextPage
nextPage()
-
מעבר לדף הבא בספר.
previousPage
previousPage()
-
מעבר לדף הקודם בספר.
resize
resize()
-
משנה את גודל הצופה בהתאם לגודל ה-div של הקונטיינר שלו.
zoomIn
zoomIn()
-
הגדלת התצוגה במכשיר.
zoomOut
zoomOut()
-
מקטין את התצוגה.