Class PositionedImage

PositionedImage

תמונה במיקום קבוע שמקובעת ל-Paragraph. בניגוד ל-InlineImage, PositionedImage הוא לא Element. אין לה הורה או אח/ה Element. במקום זאת, הוא עוגן ל-Paragraph או ל-ListItem וממוקם באמצעות סטיות מהעוגן הזה. ל-PositionedImage יש מזהה שאפשר להשתמש בו כדי להפנות אליו. 

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Append a new paragraph.
const paragraph = body.appendParagraph('New paragraph to anchor the image to.');

// Get an image in Drive from its ID.
const image = DriveApp.getFileById('ENTER_IMAGE_FILE_ID_HERE').getBlob();

// Add the PositionedImage with offsets (in points).
const posImage =
    paragraph.addPositionedImage(image).setTopOffset(60).setLeftOffset(40);

Methods

שיטהסוג הערך המוחזרתיאור קצר
getAs(contentType)Blobהחזרת הנתונים שבתוך האובייקט הזה כ-blob שהומר לסוג התוכן שצוין.
getBlob()Blobהחזרת הנתונים שבתוך האובייקט הזה כ-blob.
getHeight()Integerאחזור הגובה של התמונה, בפיקסלים.
getId()Stringהפונקציה מקבלת את מזהה התמונה.
getLayout()PositionedLayoutהפונקציה מקבלת ערך enum שמייצג את אופן הפריסה של התמונה.
getLeftOffset()Numberהפונקציה מקבלת את ההיסט של התמונה, בנקודות, מצד ימין של הפסקה.
getParagraph()Paragraphהפונקציה מקבלת את ה-Paragraph שאליו התמונה מעוגנת.
getTopOffset()Numberהפונקציה מקבלת את ההיסט של התמונה, בנקודות, מהחלק העליון של הפסקה.
getWidth()Integerאחזור רוחב התמונה, בפיקסלים.
setHeight(height)PositionedImageהגדרת הגובה של התמונה, בפיקסלים.
setLayout(layout)PositionedImageהגדרת הגדרת הפריסה של התמונה.
setLeftOffset(offset)PositionedImageהגדרת ההזזה של התמונה, בנקודות, מצד ימין של הפסקה.
setTopOffset(offset)PositionedImageהגדרת ההזזה של התמונה, בנקודות, מהחלק העליון של הפסקה.
setWidth(width)PositionedImageהגדרת רוחב התמונה, בפיקסלים.

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

getAs(contentType)

החזרת הנתונים שבתוך האובייקט הזה כ-blob שהומר לסוג התוכן שצוין. השיטה הזו מוסיפה את הסיומת המתאימה לשם הקובץ – לדוגמה, 'myfile.pdf'. עם זאת, ההנחה היא שחלק משם הקובץ שמופיע אחרי הנקודה האחרונה (אם יש כזו) הוא סיומת קיימת שצריך להחליף. כתוצאה מכך, הקובץ ShoppingList.12.25.2014 הופך לקובץ ShoppingList.12.25.pdf.

כדי לראות את המכסות היומיות להמרות, אפשר לעיין במאמר מכסות לשירותי Google. יכול להיות שדומיינים חדשים של Google Workspace יהיו כפופים באופן זמני למכסות מחמירות יותר.

פרמטרים

שםסוגתיאור
contentTypeStringסוג ה-MIME שאליו רוצים להמיר. ברוב ה-blobs, 'application/pdf' היא האפשרות היחידה התקפה. בתמונות בפורמט BMP,‏ GIF,‏ JPEG או PNG, אפשר להשתמש גם ב-'image/bmp',‏ 'image/gif',‏ 'image/jpeg' או 'image/png'. במסמך ב-Google Docs, הערך 'text/markdown' תקף גם כן.

חזרה

Blob – הנתונים כ-blob.

getBlob()

החזרת הנתונים שבתוך האובייקט הזה כ-blob.

חזרה

Blob – הנתונים כ-blob.

getHeight()

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

חזרה

Integer – הגובה של התמונה, בפיקסלים

אישור

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

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

getId()

הפונקציה מקבלת את מזהה התמונה.

חזרה

String – מזהה התמונה

אישור

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

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

getLayout()

הפונקציה מקבלת ערך enum שמייצג את אופן הפריסה של התמונה.

חזרה

PositionedLayout – פריסת התמונה

אישור

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

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

getLeftOffset()

הפונקציה מקבלת את ההיסט של התמונה, בנקודות, מצד ימין של הפסקה.

חזרה

Number — ההזזה של התמונה מצד ימין של הפסקה השמאלית

אישור

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

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

getParagraph()

הפונקציה מקבלת את ה-Paragraph שאליו התמונה מעוגנת.

חזרה

Paragraph – הפיסקה ההורה

אישור

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

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

getTopOffset()

הפונקציה מקבלת את ההיסט של התמונה, בנקודות, מהחלק העליון של הפסקה.

חזרה

Number – ההזזה של התמונה מלמעלה של הפסקה השמאלית

אישור

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

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

getWidth()

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

חזרה

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

אישור

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

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

setHeight(height)

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

פרמטרים

שםסוגתיאור
heightIntegerהגובה של התמונה, בפיקסלים

חזרה

PositionedImage – האובייקט הנוכחי

אישור

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

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

setLayout(layout)

הגדרת הגדרת הפריסה של התמונה.

פרמטרים

שםסוגתיאור
layoutPositionedLayoutenum שמייצג את מצב הפריסה

חזרה

PositionedImage – האובייקט הזה לשרשור

אישור

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

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

setLeftOffset(offset)

הגדרת ההזזה של התמונה, בנקודות, מצד ימין של הפסקה.

פרמטרים

שםסוגתיאור
offsetNumberסטייה מימין לפסקה

חזרה

PositionedImage – האובייקט הזה לשרשור

אישור

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

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

setTopOffset(offset)

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

פרמטרים

שםסוגתיאור
offsetNumberסטייה מחלק העליון של הפסקה

חזרה

PositionedImage – האובייקט הזה לשרשור

אישור

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

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

setWidth(width)

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

פרמטרים

שםסוגתיאור
widthIntegerרוחב התמונה, בפיקסלים

חזרה

PositionedImage – האובייקט הנוכחי

אישור

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

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