chrome.fontSettings

תיאור

כדי לנהל את הגדרות הגופנים של 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 שמפורטת בהפניית ה-API בהמשך. כשדף אינטרנט מציין משפחת גופנים כללית, Chrome בוחר הגופן בהתאם להגדרה המתאימה. אם לא צוינה משפחת גופנים כללית, Chrome משתמש במשתנה עבור ההגדרה 'רגיל' משפחת גופנים כללית.

כשמציין שפה בדף אינטרנט, Chrome בוחר את הגופן לפי ההגדרה של סקריפט השפה המתאים. אם לא נבחרה שפה, Chrome ישתמש בהגדרות ברירת המחדל, או סקריפט גלובלי.

הסקריפטים הנתמכים של השפות נקבעים על ידי קוד סקריפט ISO 15924 ומופיעים ב-API בהמשך. מבחינה טכנית, ההגדרות של 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

      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

        LevelOfControl

        רמת השליטה שיש לתוסף הזה על ההגדרה.

      • pixelSize

        number

        גודל הגופן בפיקסלים.

החזרות

  • Promise&lt;object&gt;

    Chrome מגרסה 96 ואילך

    הבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).

getDefaultFontSize()

הבטחה 
chrome.fontSettings.getDefaultFontSize(
  details?: object,
  callback?: function,
)

הפונקציה מקבלת את גודל הגופן שמוגדר כברירת מחדל.

פרמטרים

  • פרטים

    אובייקט אופציונלי

    הפרמטר הזה לא בשימוש כרגע.

  • קריאה חוזרת (callback)

    פונקציה אופציונלית

    הפרמטר callback נראה כך: 

    (details: object) => void

    • פרטים

      אובייקט

      • levelOfControl

        LevelOfControl

        רמת השליטה שיש לתוסף הזה על ההגדרה.

      • pixelSize

        number

        גודל הגופן בפיקסלים.

החזרות

  • Promise&lt;object&gt;

    Chrome מגרסה 96 ואילך

    הבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).

getFont()

הבטחה 
chrome.fontSettings.getFont(
  details: object,
  callback?: function,
)

הפונקציה מקבלת את הגופן של סקריפט מסוים ומשפחת גופנים כללית.

פרמטרים

  • פרטים

    אובייקט

    • genericFamily

      GenericFamily

      משפחת הגופנים הגנרית שאליה צריך לאחזר את הגופן.

    • סקריפט

      ScriptCode אופציונלי

      הסקריפט שעבורו יש לאחזר את הגופן. אם לא צוין, הגדרת הגופן של הסקריפט הגלובלי (קוד הסקריפט "Zyyy") מאוחזרת.

  • קריאה חוזרת (callback)

    פונקציה אופציונלית

    הפרמטר callback נראה כך: 

    (details: object) => void

    • פרטים

      אובייקט

      • fontId

        מחרוזת

        מזהה הגופן. במקום ערך ההעדפה המילולי של מזהה הגופן, זה יכול להיות מזהה הגופן שהמערכת מתאימה את ערך ההעדפה אליו. לכן, fontId יכול להיות שונה מהגופן שהועבר ל-setFont, אם למשל, הגופן לא זמין במערכת. המחרוזת הריקה מציינת חלופה להגדרת הגופן הגלובלית של הסקריפט.

      • levelOfControl

        LevelOfControl

        רמת השליטה שיש לתוסף הזה על ההגדרה.

החזרות

  • Promise&lt;object&gt;

    Chrome מגרסה 96 ואילך

    הבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).

getFontList()

הבטחה 
chrome.fontSettings.getFontList(
  callback?: function,
)

קבלת רשימה של גופנים במערכת.

פרמטרים

  • קריאה חוזרת (callback)

    פונקציה אופציונלית

    הפרמטר callback נראה כך: 

    (results: FontName[]) => void

החזרות

  • Promise&lt;FontName[]&gt;

    Chrome מגרסה 96 ואילך

    הבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).

getMinimumFontSize()

הבטחה 
chrome.fontSettings.getMinimumFontSize(
  details?: object,
  callback?: function,
)

הפונקציה מקבלת את גודל הגופן המינימלי.

פרמטרים

  • פרטים

    אובייקט אופציונלי

    הפרמטר הזה לא בשימוש כרגע.

  • קריאה חוזרת (callback)

    פונקציה אופציונלית

    הפרמטר callback נראה כך: 

    (details: object) => void

    • פרטים

      אובייקט

      • levelOfControl

        LevelOfControl

        רמת השליטה שיש לתוסף הזה על ההגדרה.

      • pixelSize

        number

        גודל הגופן בפיקסלים.

החזרות

  • Promise&lt;object&gt;

    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

      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

        LevelOfControl

        רמת השליטה שיש לתוסף הזה על ההגדרה.

      • pixelSize

        number

        גודל הגופן בפיקסלים.

onDefaultFontSizeChanged

chrome.fontSettings.onDefaultFontSizeChanged.addListener(
  callback: function,
)

מופעל כשהגדרת ברירת המחדל של גודל הגופן משתנה.

פרמטרים

  • קריאה חוזרת (callback)

    פונקציה

    הפרמטר callback נראה כך: 

    (details: object) => void

    • פרטים

      אובייקט

      • levelOfControl

        LevelOfControl

        רמת השליטה שיש לתוסף הזה על ההגדרה.

      • pixelSize

        number

        גודל הגופן בפיקסלים.

onFontChanged

chrome.fontSettings.onFontChanged.addListener(
  callback: function,
)

מופעל כשהגדרת גופן משתנה.

פרמטרים

  • קריאה חוזרת (callback)

    פונקציה

    הפרמטר callback נראה כך: 

    (details: object) => void

    • פרטים

      אובייקט

      • fontId

        מחרוזת

        מזהה הגופן. אפשר לעיין בתיאור בgetFont.

      • genericFamily

        GenericFamily

        משפחת הגופנים הכללית שלגביה שינית את הגדרת הגופן.

      • levelOfControl

        LevelOfControl

        רמת השליטה שיש לתוסף הזה על ההגדרה.

      • סקריפט

        ScriptCode אופציונלי

        קוד הסקריפט שעבורו הגדרת הגופן השתנתה.

onMinimumFontSizeChanged

chrome.fontSettings.onMinimumFontSizeChanged.addListener(
  callback: function,
)

מופעל כשגודל הגופן המינימלי משתנה.

פרמטרים

  • קריאה חוזרת (callback)

    פונקציה

    הפרמטר callback נראה כך: 

    (details: object) => void

    • פרטים

      אובייקט

      • levelOfControl

        LevelOfControl

        רמת השליטה שיש לתוסף הזה על ההגדרה.

      • pixelSize

        number

        גודל הגופן בפיקסלים.