Class Drawing

ציור

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

Methods

שיטהסוג הערך שמוחזרתיאור קצר
getContainerInfo()ContainerInfoקבלת מידע על המיקום של הציור בגיליון.
getHeight()Integerהפונקציה מחזירה את הגובה בפועל של השרטוט הזה בפיקסלים.
getOnAction()String|nullהפונקציה מחזירה את השם של המאקרו שמצורף לציור הזה.
getSheet()Sheetמחזירה את הגיליון שבו הציור מופיע.
getWidth()Integerהפונקציה מחזירה את הרוחב בפועל של השרטוט הזה בפיקסלים.
getZIndex()Numberמחזירה את הערך של z-index של הציור הזה.
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|null – שם המאקרו שצורף לשרטוט הזה.

אישור

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

  • 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-index של הציור הזה. 

// 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-Index של השרטוט הזה.

אישור

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

  • 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 — השרטוט הזה, לשרשור.