Class Drawing

שרטוט

מייצג שרטוט של גיליון בגיליון אלקטרוני.

שיטות

שיטהסוג הערך שמוחזרתיאור קצר
getContainerInfo()ContainerInfoקבלת מידע על מיקום השרטוט בגיליון.
getHeight()Integerמחזירה את הגובה בפועל של השרטוט בפיקסלים.
getOnAction()Stringמחזירה את השם של רכיב המאקרו שמצורף לשרטוט הזה.
getSheet()Sheetמחזירה את הגיליון שבו מופיע השרטוט הזה.
getWidth()Integerמחזירה את הרוחב בפועל של השרטוט הזה בפיקסלים.
getZIndex()Numberמחזירה את מדד ה-z של שרטוט זה.
remove()voidמחיקת השרטוט הזה מהגיליון האלקטרוני.
setHeight(height)Drawingמגדיר את הגובה בפועל של השרטוט בפיקסלים.
setOnAction(macroName)Drawingמקצה פונקציית מאקרו לשרטוט הזה.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)Drawingהמדיניות הזו מגדירה את המיקום שבו יופיע השרטוט בגיליון.
setWidth(width)Drawingמגדיר את הרוחב בפועל של השרטוט בפיקסלים.
setZIndex(zIndex)Drawingמגדיר את z-index של השרטוט הזה.

תיעוד מפורט

getContainerInfo()

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

החזרות

ContainerInfo - אובייקט שמכיל את מיקום הקונטיינר בשרטוט.

הרשאות

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

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

getHeight()

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

// Logs the height of all drawings in a sheet
var drawings = SpreadsheetApp.getActiveSheet().getDrawings();
for (var i = 0; i < drawings.length; i++) {
  Logger.log(drawings[i].getHeight());
}

החזרות

Integer - גובה השרטוט בפיקסלים.

הרשאות

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

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

getOnAction()

מחזירה את השם של רכיב המאקרו שמצורף לשרטוט הזה.

// Logs the macro name of all drawings on the active sheet.
var drawings = SpreadsheetApp.getActiveSheet().getDrawings();
for (var i = 0; i < drawings.length; i++) {
  Logger.log(drawings[i].getOnAction());
}

החזרות

String - שם המאקרו שמצורף לשרטוט הזה.

הרשאות

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

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

getSheet()

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

// Logs the parent sheet of all drawings on the active sheet.
var drawings = SpreadsheetApp.getActiveSheet().getDrawings();
for (var i = 0; i < drawings.length; i++) {
  Logger.log(drawings[i].getSheet());
}

החזרות

Sheet – הגיליון שבו מופיע השרטוט.

הרשאות

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

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

getWidth()

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

// Logs the width of all drawings in a sheet
var drawings = SpreadsheetApp.getActiveSheet().getDrawings();
for (var i = 0; i < drawings.length; i++) {
  Logger.log(drawings[i].getWidth());
}

החזרות

Integer – רוחב השרטוט בפיקסלים.

הרשאות

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

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

getZIndex()

מחזירה את מדד ה-z של שרטוט זה.

// Logs the z-index of all drawings on the active sheet.
var drawings = SpreadsheetApp.getActiveSheet().getDrawings();
for (var i = 0; i < drawings.length; i++) {
  Logger.log(drawings[i].getZIndex());
}

החזרות

Number - אינדקס Z של שרטוט זה.

הרשאות

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

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

remove()

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

// Deletes all drawings from the active sheet.
var drawings = SpreadsheetApp.getActiveSheet().getDrawings();
for (var i = 0; i < drawings.length; i++) {
  drawings[i].remove();
}

הרשאות

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

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

setHeight(height)

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

פרמטרים

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

החזרות

Drawing – השרטוט הזה, לשרשור.

הרשאות

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

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

setOnAction(macroName)

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

פרמטרים

שםתיאורהתיאור
macroNameStringהשם של פונקציית המאקרו.

החזרות

Drawing – השרטוט הזה, לשרשור.


setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)

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

פרמטרים

שםתיאורהתיאור
anchorRowPosIntegerהצד העליון של השרטוט מעוגן בשורה הזו.
anchorColPosIntegerהצד העליון של השרטוט מעוגן בעמודה הזו.
offsetXIntegerההיסט האופקי מפינת התא בפיקסלים.
offsetYIntegerההיסט האנכי מפינת התא בפיקסלים.

החזרות

Drawing – השרטוט הזה, לשרשור.

הרשאות

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

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

setWidth(width)

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

פרמטרים

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

החזרות

Drawing – השרטוט הזה, לשרשור.

הרשאות

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

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

setZIndex(zIndex)

מגדיר את z-index של השרטוט הזה.

פרמטרים

שםתיאורהתיאור
zIndexNumberZ-אינדקס של שרטוט זה.

החזרות

Drawing – השרטוט הזה, לשרשור.