Class PositionedImage

PositionedImage

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

var body = DocumentApp.getActiveDocument().getBody();

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

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

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

שיטות

שיטהסוג הערך שמוחזרתיאור קצר
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'.

החזרות

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