Class Drawing

Drawing

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

Methods

שיטהסוג הערך המוחזרתיאור קצר
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
const drawings = SpreadsheetApp.getActiveSheet().getDrawings();
for (let 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.
const drawings = SpreadsheetApp.getActiveSheet().getDrawings();
for (let 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.
const drawings = SpreadsheetApp.getActiveSheet().getDrawings();
for (let 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
const drawings = SpreadsheetApp.getActiveSheet().getDrawings();
for (let 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.
const drawings = SpreadsheetApp.getActiveSheet().getDrawings();
for (let 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.
const drawings = SpreadsheetApp.getActiveSheet().getDrawings();
for (let 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 של השרטוט הזה.

פרמטרים

שםסוגתיאור
zIndexNumberאינדקס Z של השרטוט הזה.

חזרה

Drawing — השרטוט הזה, לצורך קישור.