דף זה תורגם על ידי Cloud Translation API.

Class OverGridImage

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

שיטות

שיטה	סוג הערך שמוחזר	תיאור קצר
`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 של התמונה המקורית, ומחזירה את הערך `null` אם כתובת ה-URL לא זמינה.
`getWidth()`	`Integer`	מחזירה את הרוחב בפועל של התמונה בפיקסלים.
`remove()`	`void`	מחיקת התמונה מהגיליון האלקטרוני.
`replace(blob)`	`OverGridImage`	מחליף את התמונה הזו בתמונה שצוינה ב-`BlobSource` שסופק.
`replace(url)`	`OverGridImage`	מחליפה תמונה זו בתמונה מכתובת האתר שצוינה.
`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)`

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

פרמטרים

שם	תיאור	התיאור
`functionName`	`String`	שם הפונקציה שצוינה. זו חייבת להיות פונקציה ציבורית ברמה העליונה, ולא כפונקציה שמסתיימת בקו תחתון כמו `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 של התמונה המקורית, ומחזירה את הערך null אם כתובת ה-URL לא זמינה. אם התמונה נוספה על ידי כתובת 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.

פרמטרים

שם	תיאור	התיאור
`blob`	`BlobSource`	התמונה החדשה כ-blob.

החזרות

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

הרשאות

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

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

`replace(url)`

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

פרמטרים

שם	תיאור	התיאור
`url`	`String`	כתובת ה-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)`

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

פרמטרים

שם	תיאור	התיאור
`description`	`String`	התיאור החדש של הטקסט החלופי לתמונה.

החזרות

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

הרשאות

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

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

`setAltTextTitle(title)`

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

פרמטרים

שם	תיאור	התיאור
`title`	`String`	הכותרת החדשה של הטקסט החלופי לתמונה.

החזרות

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

הרשאות

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

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

`setAnchorCell(cell)`

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

פרמטרים

שם	תיאור	התיאור
`cell`	`Range`	תא העוגן החדש.

החזרות

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

הרשאות

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

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

`setAnchorCellXOffset(offset)`

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

פרמטרים

שם	תיאור	התיאור
`offset`	`Integer`	היסט הפיקסלים האופקי החדש.

החזרות

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

הרשאות

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

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

`setAnchorCellYOffset(offset)`

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

פרמטרים

שם	תיאור	התיאור
`offset`	`Integer`	ההיסט החדש של הפיקסל האנכי.

החזרות

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

הרשאות

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

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

`setHeight(height)`

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

פרמטרים

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

החזרות

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

הרשאות

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

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

`setWidth(width)`

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

פרמטרים

שם	תיאור	התיאור
`width`	`Integer`	הרוחב הרצוי בפיקסלים.

החזרות

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

הרשאות

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

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