תיאור
כדי לנהל את הגדרות הגופנים של Chrome, צריך להשתמש ב-API chrome.fontSettings
.
הרשאות
fontSettings
כדי להשתמש ב-Font Settings API, צריך להצהיר על ההרשאה "fontSettings"
בתוסף
מניפסט. לדוגמה:
{
"name": "My Font Settings Extension",
"description": "Customize your fonts",
"version": "0.2",
"permissions": [
"fontSettings"
],
...
}
מושגים ושימוש
חלק מהגדרות הגופנים ב-Chrome תלויות במשפחות ובשפות כלליות מסוימות של גופנים סקריפטים. לדוגמה, הגופן המשמש עבור Sans Serif בסינית פשוטה עשוי להיות שונה מהגופן משמש ליפנית מסוג Serif.
משפחות הגופנים הגנריות שנתמכות ב-Chrome מבוססות על משפחות גופנים כלליות בשירות CSS
שרשומים בקטע GenericReference
. כשדף אינטרנט מציין משפחת גופנים כללית, Chrome בוחר
הגופן בהתאם להגדרה המתאימה. אם לא צוינה משפחת גופנים כללית, Chrome משתמש במשתנה
עבור ההגדרה 'רגיל' משפחת גופנים כללית.
כשמציין שפה בדף אינטרנט, Chrome בוחר את הגופן לפי ההגדרה של סקריפט השפה המתאים. אם לא נבחרה שפה, Chrome ישתמש בהגדרות ברירת המחדל, או סקריפט גלובלי.
קובצי הסקריפט של השפה הנתמכים מצוינים בקוד סקריפט ISO 15924, וגם
ScriptCode
מבחינה טכנית, ההגדרות של Chrome אינן רק לפי סקריפט אלא גם תלויות
בשפת היעד. לדוגמה, Chrome בוחר את הגופן קירילי (קוד סקריפט ISO 15924 "Cyrl") כאשר
מציין את השפה הרוסית, והוא משתמש בגופן הזה לא רק עבור כתב קירילי, אלא
את כל מה שהגופן מכיל, למשל לטינית.
דוגמאות
הקוד הבא מקבל את הגופן הרגיל בערבית.
chrome.fontSettings.getFont(
{ genericFamily: 'standard', script: 'Arab' },
function(details) { console.log(details.fontId); }
);
קטע הקוד הבא מגדיר את הגופן Sans Serif ביפנית.
chrome.fontSettings.setFont(
{ genericFamily: 'sansserif', script: 'Jpan', fontId: 'MS PGothic' }
);
כדי לנסות את ה-API הזה, צריך להתקין את הדוגמה של fontSettings API מתוך chrome-extension-samples. של מאגר הנתונים.
סוגים
FontName
מייצג שם של גופן.
מאפיינים
-
displayName
מחרוזת
שם התצוגה של הגופן.
-
fontId
מחרוזת
מזהה הגופן.
GenericFamily
משפחת גופנים כללית של CSS.
Enum
"רגילה"
"sansserif"
"serif"
"קבוע"
"cursive"
"פנטזיה"
"מתמטיקה"
LevelOfControl
אחד מ-
not\_controllable
: לא ניתן לשלוט באמצעות אף תוסף
controlled\_by\_other\_extensions
: נשלט על ידי תוספים עם קדימות גבוהה יותר
controllable\_by\_this\_extension
: ניתן לשלוט באמצעות התוסף הזה
controlled\_by\_this\_extension
: בשליטת התוסף הזה
Enum
"not_controllable"
"controlled_by_other_extensions"
"controllable_by_this_extension"
"controlled_by_this_extension"
ScriptCode
קוד סקריפט ISO 15924. סקריפט ברירת המחדל, או הסקריפט הגלובלי, מיוצג על ידי קוד הסקריפט "Zyyy".
Enum
"Afak"
"ערבית"
"ארמי"
'נשק'
"Avst"
"באלי"
"במו"
"בס"
"Batk"
"Beng"
"Blis"
"בופו"
"Brah"
"Brai"
"Bugi"
"Buhd"
"ק"מ"
"קופסאות"
"Cari"
"צ'אם"
"צ'ר"
"Cirt"
"בחירה"
"Cprt"
"Cyrl"
"Cyrs"
"Deva"
"Dsrt"
"Dupl"
"Egyd"
"Egyh"
"Egyp"
"אלבה"
"Ethi"
"Geor"
"Geok"
"Glag"
"Goth"
"Gran"
"יוונית"
"גוג'ר"
"גורו"
"Hang"
"האני"
"האנו"
"האן"
"Hant"
"Hebr"
"Hluw"
"Hmng"
"Hung"
"Inds"
"Ital"
"Java"
"Jpan"
"Jurc"
"Kali"
"Khar"
"Khmr"
"Khoj"
'Knda'
"Kpel"
"Kthi"
"לאנה"
"לאו"
"Latf"
"קו רוחב"
"Latn"
"Lepc"
"Limb"
"Lina"
"Linb"
"Lisu"
"לומה"
"Lyci"
"Lydi"
"מנד"
"מני"
"מאיה"
"תיקון"
"Merc"
"Mero"
"Mlym"
"ירח"
"Mong"
"Mroo"
"Mtei"
"Mymr"
"Narb"
"Nbat"
"Nkgb"
"נקו"
"Nshu"
"Ogam"
"Olck"
"אורח"
"אוריה"
"Osma"
"דקל"
"Perm"
"Phag"
"Phli"
"Phlp"
"Phlv"
"Phnx"
"Plrd"
"Prti"
"Rjng"
"Roro"
"Runr"
"Samr"
"שרה"
"סרב"
"Saur"
"Sgnw"
"Shaw"
"Shrd"
"Sind"
"Sinh"
"Sora"
"ראשון"
"Sylo"
"Syrc"
"Syre"
"סירג'"
"Syrn"
"Tagb"
"Takr"
"טל"
"Talu"
"Taml"
"Tang"
"Tavt"
"Telu"
"Teng"
"Tfng"
"Tglg"
"ת'א"
"תאית"
"Tibt"
"Tirh"
"אוגאר"
"Vaii"
"Visp"
"מלחמה"
"Wole"
"Xpeo"
"Xsux"
"Yiii"
"Zmth"
"Zsym"
"Zyyy"
שיטות
clearDefaultFixedFontSize()
chrome.fontSettings.clearDefaultFixedFontSize(
details?: object,
callback?: function,
)
ניקוי ברירת המחדל של גודל הגופן הקבוע, אם התוסף הזה מוגדר כברירת מחדל.
פרמטרים
-
פרטים
אובייקט אופציונלי
הפרמטר הזה לא בשימוש כרגע.
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:() => void
החזרות
-
הבטחה<Empty>
Chrome מגרסה 96 ואילךהבטחות נתמכות במניפסט מגרסה V3 ואילך, אבל ניתנות קריאות חוזרות (callback) בשביל תאימות לאחור. לא ניתן להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה הזו מצליחה לפתור את הבעיה באותו סוג שמועבר לקריאה החוזרת.
clearDefaultFontSize()
chrome.fontSettings.clearDefaultFontSize(
details?: object,
callback?: function,
)
מנקה את גודל הגופן המוגדר כברירת מחדל על ידי התוסף הזה, אם יש כזה.
פרמטרים
-
פרטים
אובייקט אופציונלי
הפרמטר הזה לא בשימוש כרגע.
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:() => void
החזרות
-
הבטחה<Empty>
Chrome מגרסה 96 ואילךהבטחות נתמכות במניפסט מגרסה V3 ואילך, אבל ניתנות קריאות חוזרות (callback) בשביל תאימות לאחור. לא ניתן להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה הזו מצליחה לפתור את הבעיה באותו סוג שמועבר לקריאה החוזרת.
clearFont()
chrome.fontSettings.clearFont(
details: object,
callback?: function,
)
ניקוי הגופן שהוגדר על ידי התוסף, אם יש כזה.
פרמטרים
-
פרטים
אובייקט
-
genericFamily
משפחת הגופנים הגנרית שממנה צריך לנקות את הגופן.
-
סקריפט
ScriptCode אופציונלי
הסקריפט שעבורו צריך לנקות את הגופן. אם לא צוין מספר, ההגדרה של גופן הסקריפט הגלובלי תימחק.
-
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:() => void
החזרות
-
הבטחה<Empty>
Chrome מגרסה 96 ואילךהבטחות נתמכות במניפסט מגרסה V3 ואילך, אבל ניתנות קריאות חוזרות (callback) בשביל תאימות לאחור. לא ניתן להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה הזו מצליחה לפתור את הבעיה באותו סוג שמועבר לקריאה החוזרת.
clearMinimumFontSize()
chrome.fontSettings.clearMinimumFontSize(
details?: object,
callback?: function,
)
ניקוי גודל הגופן המינימלי שהוגדר על ידי התוסף, אם יש כזה.
פרמטרים
-
פרטים
אובייקט אופציונלי
הפרמטר הזה לא בשימוש כרגע.
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:() => void
החזרות
-
הבטחה<Empty>
Chrome מגרסה 96 ואילךהבטחות נתמכות במניפסט מגרסה V3 ואילך, אבל ניתנות קריאות חוזרות (callback) בשביל תאימות לאחור. לא ניתן להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה הזו מצליחה לפתור את הבעיה באותו סוג שמועבר לקריאה החוזרת.
getDefaultFixedFontSize()
chrome.fontSettings.getDefaultFixedFontSize(
details?: object,
callback?: function,
)
מקבלת את גודל ברירת המחדל של גופנים ברוחב קבוע.
פרמטרים
-
פרטים
אובייקט אופציונלי
הפרמטר הזה לא בשימוש כרגע.
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:(details: object) => void
-
פרטים
אובייקט
-
levelOfControl
רמת השליטה שיש לתוסף הזה על ההגדרה.
-
pixelSize
number
גודל הגופן בפיקסלים.
-
-
החזרות
-
Promise<object>
Chrome מגרסה 96 ואילךהבטחות נתמכות במניפסט מגרסה V3 ואילך, אבל ניתנות קריאות חוזרות (callback) בשביל תאימות לאחור. לא ניתן להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה הזו מצליחה לפתור את הבעיה באותו סוג שמועבר לקריאה החוזרת.
getDefaultFontSize()
chrome.fontSettings.getDefaultFontSize(
details?: object,
callback?: function,
)
הפונקציה מקבלת את גודל הגופן שמוגדר כברירת מחדל.
פרמטרים
-
פרטים
אובייקט אופציונלי
הפרמטר הזה לא בשימוש כרגע.
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:(details: object) => void
-
פרטים
אובייקט
-
levelOfControl
רמת השליטה שיש לתוסף הזה על ההגדרה.
-
pixelSize
number
גודל הגופן בפיקסלים.
-
-
החזרות
-
Promise<object>
Chrome מגרסה 96 ואילךהבטחות נתמכות במניפסט מגרסה V3 ואילך, אבל ניתנות קריאות חוזרות (callback) בשביל תאימות לאחור. לא ניתן להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה הזו מצליחה לפתור את הבעיה באותו סוג שמועבר לקריאה החוזרת.
getFont()
chrome.fontSettings.getFont(
details: object,
callback?: function,
)
הפונקציה מקבלת את הגופן של סקריפט מסוים ומשפחת גופנים כללית.
פרמטרים
-
פרטים
אובייקט
-
genericFamily
משפחת הגופנים הגנרית שאליה צריך לאחזר את הגופן.
-
סקריפט
ScriptCode אופציונלי
הסקריפט שעבורו יש לאחזר את הגופן. אם לא צוין, הגדרת הגופן של הסקריפט הגלובלי (קוד הסקריפט "Zyyy") מאוחזרת.
-
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:(details: object) => void
-
פרטים
אובייקט
-
fontId
מחרוזת
מזהה הגופן. במקום ערך ההעדפה המילולי של מזהה הגופן, זה יכול להיות מזהה הגופן שהמערכת מתאימה את ערך ההעדפה אליו. לכן,
fontId
יכול להיות שונה מהגופן שהועבר ל-setFont
, אם למשל, הגופן לא זמין במערכת. המחרוזת הריקה מציינת חלופה להגדרת הגופן הגלובלית של הסקריפט. -
levelOfControl
רמת השליטה שיש לתוסף הזה על ההגדרה.
-
-
החזרות
-
Promise<object>
Chrome מגרסה 96 ואילךהבטחות נתמכות במניפסט מגרסה V3 ואילך, אבל ניתנות קריאות חוזרות (callback) בשביל תאימות לאחור. לא ניתן להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה הזו מצליחה לפתור את הבעיה באותו סוג שמועבר לקריאה החוזרת.
getFontList()
chrome.fontSettings.getFontList(
callback?: function,
)
קבלת רשימה של גופנים במערכת.
פרמטרים
החזרות
-
Promise<FontName[]>
Chrome מגרסה 96 ואילךהבטחות נתמכות במניפסט מגרסה V3 ואילך, אבל ניתנות קריאות חוזרות (callback) בשביל תאימות לאחור. לא ניתן להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה הזו מצליחה לפתור את הבעיה באותו סוג שמועבר לקריאה החוזרת.
getMinimumFontSize()
chrome.fontSettings.getMinimumFontSize(
details?: object,
callback?: function,
)
הפונקציה מקבלת את גודל הגופן המינימלי.
פרמטרים
-
פרטים
אובייקט אופציונלי
הפרמטר הזה לא בשימוש כרגע.
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:(details: object) => void
-
פרטים
אובייקט
-
levelOfControl
רמת השליטה שיש לתוסף הזה על ההגדרה.
-
pixelSize
number
גודל הגופן בפיקסלים.
-
-
החזרות
-
Promise<object>
Chrome מגרסה 96 ואילךהבטחות נתמכות במניפסט מגרסה V3 ואילך, אבל ניתנות קריאות חוזרות (callback) בשביל תאימות לאחור. לא ניתן להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה הזו מצליחה לפתור את הבעיה באותו סוג שמועבר לקריאה החוזרת.
setDefaultFixedFontSize()
chrome.fontSettings.setDefaultFixedFontSize(
details: object,
callback?: function,
)
מגדיר את גודל ברירת המחדל של גופנים ברוחב קבוע.
פרמטרים
-
פרטים
אובייקט
-
pixelSize
number
גודל הגופן בפיקסלים.
-
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:() => void
החזרות
-
הבטחה<Empty>
Chrome מגרסה 96 ואילךהבטחות נתמכות במניפסט מגרסה V3 ואילך, אבל ניתנות קריאות חוזרות (callback) בשביל תאימות לאחור. לא ניתן להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה הזו מצליחה לפתור את הבעיה באותו סוג שמועבר לקריאה החוזרת.
setDefaultFontSize()
chrome.fontSettings.setDefaultFontSize(
details: object,
callback?: function,
)
מגדיר את ברירת המחדל של גודל הגופן.
פרמטרים
-
פרטים
אובייקט
-
pixelSize
number
גודל הגופן בפיקסלים.
-
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:() => void
החזרות
-
הבטחה<Empty>
Chrome מגרסה 96 ואילךהבטחות נתמכות במניפסט מגרסה V3 ואילך, אבל ניתנות קריאות חוזרות (callback) בשביל תאימות לאחור. לא ניתן להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה הזו מצליחה לפתור את הבעיה באותו סוג שמועבר לקריאה החוזרת.
setFont()
chrome.fontSettings.setFont(
details: object,
callback?: function,
)
מגדיר את הגופן לסקריפט מסוים ולמשפחת גופנים כללית.
פרמטרים
-
פרטים
אובייקט
-
fontId
מחרוזת
מזהה הגופן. המשמעות של המחרוזת הריקה היא להשתמש בהגדרת הגופן הגלובלית של הסקריפט.
-
genericFamily
משפחת הגופנים הכללית שעבורה צריך להגדיר את הגופן.
-
סקריפט
ScriptCode אופציונלי
קוד הסקריפט שעבורו יש להגדיר את הגופן. אם לא מציינים את הפרמטר הזה, הגדרת הגופן של הסקריפט הגלובלי (קוד הסקריפט "Zyyy") מוגדרת.
-
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:() => void
החזרות
-
הבטחה<Empty>
Chrome מגרסה 96 ואילךהבטחות נתמכות במניפסט מגרסה V3 ואילך, אבל ניתנות קריאות חוזרות (callback) בשביל תאימות לאחור. לא ניתן להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה הזו מצליחה לפתור את הבעיה באותו סוג שמועבר לקריאה החוזרת.
setMinimumFontSize()
chrome.fontSettings.setMinimumFontSize(
details: object,
callback?: function,
)
מגדיר את גודל הגופן המינימלי.
פרמטרים
-
פרטים
אובייקט
-
pixelSize
number
גודל הגופן בפיקסלים.
-
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:() => void
החזרות
-
הבטחה<Empty>
Chrome מגרסה 96 ואילךהבטחות נתמכות במניפסט מגרסה V3 ואילך, אבל ניתנות קריאות חוזרות (callback) בשביל תאימות לאחור. לא ניתן להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה הזו מצליחה לפתור את הבעיה באותו סוג שמועבר לקריאה החוזרת.
אירועים
onDefaultFixedFontSizeChanged
chrome.fontSettings.onDefaultFixedFontSizeChanged.addListener(
callback: function,
)
מופעל כשהגדרת ברירת המחדל של גודל הגופן הקבוע משתנה.
פרמטרים
-
קריאה חוזרת (callback)
פונקציה
הפרמטר
callback
נראה כך:(details: object) => void
-
פרטים
אובייקט
-
levelOfControl
רמת השליטה שיש לתוסף הזה על ההגדרה.
-
pixelSize
number
גודל הגופן בפיקסלים.
-
-
onDefaultFontSizeChanged
chrome.fontSettings.onDefaultFontSizeChanged.addListener(
callback: function,
)
מופעל כשהגדרת ברירת המחדל של גודל הגופן משתנה.
פרמטרים
-
קריאה חוזרת (callback)
פונקציה
הפרמטר
callback
נראה כך:(details: object) => void
-
פרטים
אובייקט
-
levelOfControl
רמת השליטה שיש לתוסף הזה על ההגדרה.
-
pixelSize
number
גודל הגופן בפיקסלים.
-
-
onFontChanged
chrome.fontSettings.onFontChanged.addListener(
callback: function,
)
מופעל כשהגדרת גופן משתנה.
פרמטרים
-
קריאה חוזרת (callback)
פונקציה
הפרמטר
callback
נראה כך:(details: object) => void
-
פרטים
אובייקט
-
fontId
מחרוזת
מזהה הגופן. אפשר לעיין בתיאור ב
getFont
. -
genericFamily
משפחת הגופנים הכללית שלגביה שינית את הגדרת הגופן.
-
levelOfControl
רמת השליטה שיש לתוסף הזה על ההגדרה.
-
סקריפט
ScriptCode אופציונלי
קוד הסקריפט שעבורו הגדרת הגופן השתנתה.
-
-
onMinimumFontSizeChanged
chrome.fontSettings.onMinimumFontSizeChanged.addListener(
callback: function,
)
מופעל כשגודל הגופן המינימלי משתנה.
פרמטרים
-
קריאה חוזרת (callback)
פונקציה
הפרמטר
callback
נראה כך:(details: object) => void
-
פרטים
אובייקט
-
levelOfControl
רמת השליטה שיש לתוסף הזה על ההגדרה.
-
pixelSize
number
גודל הגופן בפיקסלים.
-
-