chrome.fontSettings

תיאור

אפשר להשתמש ב-chrome.fontSettings API כדי לנהל את הגדרות הגופן של Chrome.

הרשאות

fontSettings

כדי להשתמש ב-Font Settings API, צריך להצהיר על ההרשאה "fontSettings" במניפסט של התוסף. לדוגמה:

{
  "name": "My Font Settings Extension",
  "description": "Customize your fonts",
  "version": "0.2",
  "permissions": [
    "fontSettings"
  ],
  ...
}

מושגים ושימוש

ב-Chrome, חלק מההגדרות של הגופן תלויות בסקריפטים של שפות ובמשפחות גופנים גנריות מסוימות. לדוגמה, הגופן שמשמש לסינית פשוטה ללא 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

"standard"

"sansserif"

"serif"

"fixed"

"cursive"

"fantasy"

"math"

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"

"ערבית"

"Armi"

"Armn"

"Avst"

"Bali"

"Bamu"

'Bass'

"Batk"

"Beng"

"Blis"

"Bopo"

"Brah"

"Brai"

"Bugi"

"Buhd"

"Cakm"

'פחיות'

"Cari"

"Cham"

"Cher"

"Cirt"

"Copt"

"Cprt"

"Cyrl"

"Cyrs"

"Deva"

"Dsrt"

"Dupl"

"Egyd"

"Egyh"

'Egyp'

"Elba"

"Ethi"

'Geor'

'Geok'

"Glag"

'Goth'

"Gran"

"Grek"

"Gujr"

"Guru"

'Hang'

"Hani"

"Hano"

"Hans"

'Hant'

"Hebr"

"Hluw"

"Hmng"

'Hung'

"Inds"

"Ital"

'Java'

"Jpan"

"Jurc"

"Kali"

"Khar"

"Khmr"

'Khoj'

"Knda"

"Kpel"

"Kthi"

"Lana"

"Laoo"

"Latf"

"Latg"

"Latn"

"Lepc"

'Limb'

"Lina"

"Linb"

"Lisu"

"Loma"

"Lyci"

"Lydi"

"Mand"

"Mani"

"Maya"

'תיקון'

"Merc"

"Mero"

"Mlym"

'Moon'

"Mong"

"Mroo"

"Mtei"

"Mymr"

"Narb"

"Nbat"

"Nkgb"

"Nkoo"

"Nshu"

'Ogam'

"Olck"

"Orkh"

"Orya"

"Osma"

"Palm"

"Perm"

"Phag"

"Phli"

"Phlp"

"Phlv"

"Phnx"

"Plrd"

"Prti"

"Rjng"

"Roro"

"Runr"

"Samr"

"Sara"

"Sarb"

"Saur"

"Sgnw"

"Shaw"

"Shrd"

"Sind"

'Sinh'

"Sora"

"Sund"

"Sylo"

"Syrc"

"Syre"

"Syrj"

"Syrn"

"Tagb"

"Takr"

'Tale'

"Talu"

"Taml"

"Tang"

"Tavt"

"Telu"

"Teng"

"Tfng"

"Tglg"

"Thaa"

'תאי'

"Tibt"

"Tirh"

"Ugar"

"Vaii"

"Visp"

"Wara"

"Wole"

"Xpeo"

"Xsux"

"Yiii"

"Zmth"

"Zsym"

"Zyyy"

Methods

clearDefaultFixedFontSize()

Promise

chrome.fontSettings.clearDefaultFixedFontSize(
  details?: object,
  callback?: function,
)

מחיקת גודל הגופן הקבוע שמוגדר כברירת מחדל על ידי התוסף הזה, אם יש כזה.

פרמטרים

• פרטים

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

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

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

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

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

  () => void

החזרות

• Promise<void>

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

  יש תמיכה ב-Promises ב-Manifest V3 ואילך, אבל פונקציות קריאה חוזרת (callbacks) ניתנות לצורך תאימות לאחור. אי אפשר להשתמש בשניהם באותה קריאה לפונקציה. הפתרון של ההבטחה יהיה באותו סוג שהוענק ל-callback.

clearDefaultFontSize()

Promise

chrome.fontSettings.clearDefaultFontSize(
  details?: object,
  callback?: function,
)

מחיקת גודל הגופן שמוגדר כברירת מחדל על ידי התוסף הזה, אם יש כזה.

פרמטרים

• פרטים

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

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

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

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

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

  () => void

החזרות

• Promise<void>

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

  יש תמיכה ב-Promises ב-Manifest V3 ואילך, אבל פונקציות קריאה חוזרת (callbacks) ניתנות לצורך תאימות לאחור. אי אפשר להשתמש בשניהם באותה קריאה לפונקציה. הפתרון של ההבטחה יהיה באותו סוג שהוענק ל-callback.

clearFont()

Promise

chrome.fontSettings.clearFont(
  details: object,
  callback?: function,
)

מוחקים את הגופן שהוגדר על ידי התוסף הזה, אם יש כזה.

פרמטרים

• פרטים

  אובייקט

  • genericFamily

    GenericFamily

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

  • סקריפט

    ScriptCode אופציונלי

    הסקריפט שבו צריך לנקות את הגופן. אם השדה הזה לא יצוין, ההגדרה הגלובלית של גופן הסקריפט תבוטל.

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

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

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

  () => void

החזרות

• Promise<void>

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

  יש תמיכה ב-Promises ב-Manifest V3 ואילך, אבל פונקציות קריאה חוזרת (callbacks) ניתנות לצורך תאימות לאחור. אי אפשר להשתמש בשניהם באותה קריאה לפונקציה. הפתרון של ההבטחה יהיה באותו סוג שהוענק ל-callback.

clearMinimumFontSize()

Promise

chrome.fontSettings.clearMinimumFontSize(
  details?: object,
  callback?: function,
)

מחיקת גודל הגופן המינימלי שהוגדר על ידי התוסף הזה, אם יש כזה.

פרמטרים

• פרטים

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

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

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

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

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

  () => void

החזרות

• Promise<void>

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

  יש תמיכה ב-Promises ב-Manifest V3 ואילך, אבל פונקציות קריאה חוזרת (callbacks) ניתנות לצורך תאימות לאחור. אי אפשר להשתמש בשניהם באותה קריאה לפונקציה. הפתרון של ההבטחה יהיה באותו סוג שהוענק ל-callback.

getDefaultFixedFontSize()

Promise

chrome.fontSettings.getDefaultFixedFontSize(
  details?: object,
  callback?: function,
)

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

פרמטרים

• פרטים

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

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

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

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

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

  (details: object) => void

  • פרטים

    אובייקט

    • levelOfControl

      LevelOfControl

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

    • pixelSize

      number

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

החזרות

• Promise<object>

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

  יש תמיכה ב-Promises ב-Manifest V3 ואילך, אבל פונקציות קריאה חוזרת (callbacks) ניתנות לצורך תאימות לאחור. אי אפשר להשתמש בשניהם באותה קריאה לפונקציה. הפתרון של ההבטחה יהיה באותו סוג שהוענק ל-callback.

getDefaultFontSize()

Promise

chrome.fontSettings.getDefaultFontSize(
  details?: object,
  callback?: function,
)

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

פרמטרים

• פרטים

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

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

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

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

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

  (details: object) => void

  • פרטים

    אובייקט

    • levelOfControl

      LevelOfControl

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

    • pixelSize

      number

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

החזרות

• Promise<object>

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

  יש תמיכה ב-Promises ב-Manifest V3 ואילך, אבל פונקציות קריאה חוזרת (callbacks) ניתנות לצורך תאימות לאחור. אי אפשר להשתמש בשניהם באותה קריאה לפונקציה. הפתרון של ההבטחה יהיה באותו סוג שהוענק ל-callback.

getFont()

Promise

chrome.fontSettings.getFont(
  details: object,
  callback?: function,
)

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

פרמטרים

• פרטים

  אובייקט

  • genericFamily

    GenericFamily

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

  • סקריפט

    ScriptCode אופציונלי

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

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

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

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

  (details: object) => void

  • פרטים

    אובייקט

    • fontId

      מחרוזת

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

    • levelOfControl

      LevelOfControl

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

החזרות

• Promise<object>

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

  יש תמיכה ב-Promises ב-Manifest V3 ואילך, אבל פונקציות קריאה חוזרת (callbacks) ניתנות לצורך תאימות לאחור. אי אפשר להשתמש בשניהם באותה קריאה לפונקציה. הפתרון של ההבטחה יהיה באותו סוג שהוענק ל-callback.

getFontList()

Promise

chrome.fontSettings.getFontList(
  callback?: function,
)

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

פרמטרים

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

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

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

  (results: FontName[]) => void

  • תוצאות

    FontName[]

החזרות

• Promise<FontName[]>

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

  יש תמיכה ב-Promises ב-Manifest V3 ואילך, אבל פונקציות קריאה חוזרת (callbacks) ניתנות לצורך תאימות לאחור. אי אפשר להשתמש בשניהם באותה קריאה לפונקציה. הפתרון של ההבטחה יהיה באותו סוג שהוענק ל-callback.

getMinimumFontSize()

Promise

chrome.fontSettings.getMinimumFontSize(
  details?: object,
  callback?: function,
)

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

פרמטרים

• פרטים

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

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

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

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

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

  (details: object) => void

  • פרטים

    אובייקט

    • levelOfControl

      LevelOfControl

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

    • pixelSize

      number

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

החזרות

• Promise<object>

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

  יש תמיכה ב-Promises ב-Manifest V3 ואילך, אבל פונקציות קריאה חוזרת (callbacks) ניתנות לצורך תאימות לאחור. אי אפשר להשתמש בשניהם באותה קריאה לפונקציה. הפתרון של ההבטחה יהיה באותו סוג שהוענק ל-callback.

setDefaultFixedFontSize()

Promise

chrome.fontSettings.setDefaultFixedFontSize(
  details: object,
  callback?: function,
)

הגדרת גודל ברירת המחדל לגופנים ברוחב קבוע.

פרמטרים

• פרטים

  אובייקט

  • pixelSize

    number

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

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

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

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

  () => void

החזרות

• Promise<void>

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

  יש תמיכה ב-Promises ב-Manifest V3 ואילך, אבל פונקציות קריאה חוזרת (callbacks) ניתנות לצורך תאימות לאחור. אי אפשר להשתמש בשניהם באותה קריאה לפונקציה. הפתרון של ההבטחה יהיה באותו סוג שהוענק ל-callback.

setDefaultFontSize()

Promise

chrome.fontSettings.setDefaultFontSize(
  details: object,
  callback?: function,
)

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

פרמטרים

• פרטים

  אובייקט

  • pixelSize

    number

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

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

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

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

  () => void

החזרות

• Promise<void>

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

  יש תמיכה ב-Promises ב-Manifest V3 ואילך, אבל פונקציות קריאה חוזרת (callbacks) ניתנות לצורך תאימות לאחור. אי אפשר להשתמש בשניהם באותה קריאה לפונקציה. הפתרון של ההבטחה יהיה באותו סוג שהוענק ל-callback.

setFont()

Promise

chrome.fontSettings.setFont(
  details: object,
  callback?: function,
)

הגדרת הגופן לסקריפט נתון ולמשפחת גופנים גנרית.

פרמטרים

• פרטים

  אובייקט

  • fontId

    מחרוזת

    מזהה הגופן. המחרוזת הריקה מציינת חזרה להגדרת הגופן הגלובלית של הסקריפט.

  • genericFamily

    GenericFamily

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

  • סקריפט

    ScriptCode אופציונלי

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

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

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

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

  () => void

החזרות

• Promise<void>

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

  יש תמיכה ב-Promises ב-Manifest V3 ואילך, אבל פונקציות קריאה חוזרת (callbacks) ניתנות לצורך תאימות לאחור. אי אפשר להשתמש בשניהם באותה קריאה לפונקציה. הפתרון של ההבטחה יהיה באותו סוג שהוענק ל-callback.

setMinimumFontSize()

Promise

chrome.fontSettings.setMinimumFontSize(
  details: object,
  callback?: function,
)

הגדרת גודל הגופן המינימלי.

פרמטרים

• פרטים

  אובייקט

  • pixelSize

    number

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

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

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

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

  () => void

החזרות

• Promise<void>

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

  יש תמיכה ב-Promises ב-Manifest V3 ואילך, אבל פונקציות קריאה חוזרת (callbacks) ניתנות לצורך תאימות לאחור. אי אפשר להשתמש בשניהם באותה קריאה לפונקציה. הפתרון של ההבטחה יהיה באותו סוג שהוענק ל-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

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