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 שאליו רוצים להמיר. ברוב ה-blob, ‏ '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)

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

פרמטרים

שםסוגתיאור
layoutPositionedLayoutערך enum שמייצג את מצב הפריסה

חזרה

‫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