Class OverGridImage

OverGridImage

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

Methods

שיטהסוג הערך המוחזרתיאור קצר
assignScript(functionName)OverGridImageהקצאת הפונקציה עם שם הפונקציה שצוין לאימג' הזה.
getAltTextDescription()Stringהפונקציה מחזירה את תיאור הטקסט החלופי של התמונה הזו.
getAltTextTitle()Stringהפונקציה מחזירה את כותרת הטקסט החלופי של התמונה הזו.
getAnchorCell()Rangeהפונקציה מחזירה את התא שאליו תמונה מוצמדת.
getAnchorCellXOffset()Integerהפונקציה מחזירה את ההיסט האופקית בפיקסלים מתא העוגן.
getAnchorCellYOffset()Integerהפונקציה מחזירה את ההיסט האנכי בפיקסלים מתא העוגן.
getHeight()Integerהפונקציה מחזירה את הגובה בפועל של התמונה הזו בפיקסלים.
getInherentHeight()Integerהפונקציה מחזירה את הגובה המובנה של התמונה הזו בפיקסלים.
getInherentWidth()Integerהפונקציה מחזירה את הגובה המובנה של התמונה הזו בפיקסלים.
getScript()Stringהפונקציה מחזירה את השם של הפונקציה שהוקצתה לאימג' הזה.
getSheet()Sheetהפונקציה מחזירה את הגיליון שבו מופיעה התמונה.
getUrl()Stringהפונקציה מקבלת את כתובת ה-URL של מקור התמונה. אם כתובת ה-URL לא זמינה, הפונקציה מחזירה את הערך null.
getWidth()Integerהפונקציה מחזירה את הרוחב בפועל של התמונה הזו בפיקסלים.
remove()voidמחיקת התמונה הזו מהגיליון האלקטרוני.
replace(blob)OverGridImageהחלפת התמונה הזו בתמונה שצוינה ב-BlobSource שסופק.
replace(url)OverGridImageהתמונה הזו מוחלפת בתמונה מכתובת ה-URL שצוינה.
resetSize()OverGridImageאיפוס התמונה למימדים המקוריים שלה.
setAltTextDescription(description)OverGridImageהגדרת התיאור של הטקסט החלופי לתמונה הזו.
setAltTextTitle(title)OverGridImageהגדרת הכותרת של הטקסט החלופי לתמונה הזו.
setAnchorCell(cell)OverGridImageהגדרת התא שאליו תמונה מקובעת.
setAnchorCellXOffset(offset)OverGridImageהגדרת ההיסט האופקית בפיקסלים מהתא העוגן.
setAnchorCellYOffset(offset)OverGridImageהגדרת ההיסט האנכי בפיקסלים מתא העוגן.
setHeight(height)OverGridImageהגדרת הגובה בפועל של התמונה הזו בפיקסלים.
setWidth(width)OverGridImageהגדרת רוחב התמונה בפועל בפיקסלים.

מסמכים מפורטים

assignScript(functionName)

הקצאת הפונקציה עם שם הפונקציה שצוין לאימג' הזה.

פרמטרים

שםסוגתיאור
functionNameStringשם הפונקציה שצוינה. זו חייבת להיות פונקציה ציבורית ברמה עליונה, ולא פונקציה שמסתיימת בקו תחתון, כמו privateFunction_.

חזרה

OverGridImage — התמונה הזו, לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getAltTextDescription()

הפונקציה מחזירה את תיאור הטקסט החלופי של התמונה הזו.

חזרה

String — תיאור הטקסט החלופי.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getAltTextTitle()

הפונקציה מחזירה את כותרת הטקסט החלופי של התמונה הזו.

חזרה

String — הכותרת של הטקסט החלופי.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getAnchorCell()

הפונקציה מחזירה את התא שאליו תמונה מוצמדת.

חזרה

Range – תא העוגן.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getAnchorCellXOffset()

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

חזרה

Integer – ההיסט האופקי בפיקסלים.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getAnchorCellYOffset()

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

חזרה

Integer – ההיסט האנכי בפיקסלים.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getHeight()

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

// Logs the height of all images in a spreadsheet
var images = SpreadsheetApp.getActiveSpreadsheet().getImages();
for (var i = 0; i < images.length; i++) {
  Logger.log(images[i].getHeight());
}

חזרה

Integer — גובה התמונה בפיקסלים.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getInherentHeight()

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

חזרה

Integer – הגובה המובנה בפיקסלים.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getInherentWidth()

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

חזרה

Integer – הרוחב המובנה בפיקסלים.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getScript()

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

חזרה

String – שם הפונקציה.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getSheet()

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

// Logs the parent sheet of all images in a spreadsheet
var images = SpreadsheetApp.getActiveSpreadsheet().getImages();
for (var i = 0; i < images.length; i++) {
  Logger.log(images[i].getSheet());
}

חזרה

Sheet — הגיליון שבו מופיעה התמונה.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getUrl()

הפונקציה מקבלת את כתובת ה-URL של מקור התמונה. אם כתובת ה-URL לא זמינה, הפונקציה מחזירה את הערך null. אם התמונה הוכנסה באמצעות כתובת URL באמצעות API, השיטה הזו מחזירה את כתובת ה-URL שצוינה במהלך הוספת התמונה.

חזרה

String – כתובת ה-URL של התמונה, אם היא זמינה. הפונקציה מחזירה את הערך null אם התמונה לא זמינה או שאין לה כתובת URL של מקור.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getWidth()

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

// Logs the width of all images in a spreadsheet
var images = SpreadsheetApp.getActiveSpreadsheet().getImages();
for (var i = 0; i < images.length; i++) {
  Logger.log(images[i].getWidth());
}

חזרה

Integer – רוחב התמונה בפיקסלים.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

remove()

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

// Deletes all images in a spreadsheet
var images = SpreadsheetApp.getActiveSpreadsheet().getImages();
for (var i = 0; i < images.length; i++) {
  images[i].remove();
}

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

replace(blob)

החלפת התמונה הזו בתמונה שצוינה ב-BlobSource שסופק. גודל ה-blob המקסימלי שנתמך הוא 2MB.

פרמטרים

שםסוגתיאור
blobBlobSourceהתמונה החדשה כ-Blob.

חזרה

OverGridImage — התמונה הזו, לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

replace(url)

התמונה הזו מוחלפת בתמונה מכתובת ה-URL שצוינה.

פרמטרים

שםסוגתיאור
urlStringכתובת ה-URL של התמונה החדשה.

חזרה

OverGridImage — התמונה הזו, לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

resetSize()

איפוס התמונה למימדים המקוריים שלה.

חזרה

OverGridImage — התמונה הזו, לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setAltTextDescription(description)

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

פרמטרים

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

חזרה

OverGridImage — התמונה הזו, לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setAltTextTitle(title)

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

פרמטרים

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

חזרה

OverGridImage — התמונה הזו, לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setAnchorCell(cell)

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

פרמטרים

שםסוגתיאור
cellRangeתא העוגן החדש.

חזרה

OverGridImage — התמונה הזו, לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setAnchorCellXOffset(offset)

הגדרת ההיסט האופקית בפיקסלים מהתא העוגן.

פרמטרים

שםסוגתיאור
offsetIntegerההיסט החדש של הפיקסלים בכיוון אופקי.

חזרה

OverGridImage — התמונה הזו, לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setAnchorCellYOffset(offset)

הגדרת ההיסט האנכי בפיקסלים מתא העוגן.

פרמטרים

שםסוגתיאור
offsetIntegerההיסט החדש של הפיקסלים האנכיים.

חזרה

OverGridImage — התמונה הזו, לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setHeight(height)

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

פרמטרים

שםסוגתיאור
heightIntegerהגובה הרצוי בפיקסלים.

חזרה

OverGridImage – התמונה לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setWidth(width)

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

פרמטרים

שםסוגתיאור
widthIntegerהרוחב הרצוי בפיקסלים.

חזרה

OverGridImage – התמונה לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets