Embedded Viewer API מכיל מחלקה אחת: DefaultViewer. מבוא לשימוש ב-API זמין במדריך למפתחים.
סיכום של ה-constructor
google.books.DefaultViewer(div, opt_options)
- נגן מוטמע של כרך בחיפוש ב-Google Books.
סיכום של השיטה
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()
- הקטנת התצוגה של העינית.
פרטי ה-Constructor
google.books.DefaultViewer
google.books.DefaultViewer(div, opt_options)
-
נגן מוטמע של כרך בחיפוש Google בספרים.
-
פרמטרים:
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()
-
מקטינים את התצוגה.