Class PositionedImage

تصویر موقعیت‌یابی‌شده

تصویر با موقعیت ثابت که به یک Paragraph متصل شده است. برخلاف یک InlineImage ، یک PositionedImage یک Element نیست. این Element والد یا خواهر و برادر ندارد. در عوض، به یک Paragraph یا ListItem متصل شده است و از طریق offsets از آن anchor قرار می‌گیرد. یک PositionedImage دارای یک ID است که می‌تواند برای ارجاع به آن استفاده شود.

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);

روش‌ها

روش نوع بازگشتی شرح مختصر
get As(contentType) Blob داده‌های درون این شیء را به صورت یک blob تبدیل‌شده به نوع محتوای مشخص‌شده، برمی‌گرداند.
get Blob() Blob داده‌های درون این شیء را به صورت یک blob برمی‌گرداند.
get Height() Integer ارتفاع تصویر را بر حسب پیکسل بازیابی می‌کند.
get Id() String شناسه تصویر را دریافت می‌کند.
get Layout() Positioned Layout یک مقدار شمارشی (enum) دریافت می‌کند که نشان دهنده نحوه چیدمان تصویر است.
get Left Offset() Number میزان انحراف تصویر از سمت چپ پاراگراف را بر حسب نقطه برمی‌گرداند.
get Paragraph() Paragraph Paragraph را که تصویر به آن متصل شده است، دریافت می‌کند.
get Top Offset() Number میزان انحراف تصویر از بالای پاراگراف را بر حسب نقطه برمی‌گرداند.
get Width() Integer عرض تصویر را بر حسب پیکسل بازیابی می‌کند.
set Height(height) Positioned Image ارتفاع تصویر را بر حسب پیکسل تنظیم می‌کند.
set Layout(layout) Positioned Image تعریف نحوه چیدمان تصویر را تعیین می‌کند.
set Left Offset(offset) Positioned Image میزان انحراف تصویر از سمت چپ پاراگراف را بر حسب نقطه تنظیم می‌کند.
set Top Offset(offset) Positioned Image میزان انحراف تصویر از بالای پاراگراف را بر حسب نقطه تنظیم می‌کند.
set Width(width) Positioned Image عرض تصویر را بر حسب پیکسل تنظیم می‌کند.

مستندات دقیق

getAs(contentType)

داده‌های درون این شیء را به صورت یک blob تبدیل‌شده به نوع محتوای مشخص‌شده برمی‌گرداند. این متد پسوند مناسب را به نام فایل اضافه می‌کند - برای مثال، "myfile.pdf". با این حال، فرض می‌کند که بخشی از نام فایل که پس از آخرین نقطه (در صورت وجود) می‌آید، یک پسوند موجود است که باید جایگزین شود. در نتیجه، "ShoppingList.12.25.2014" به "ShoppingList.12.25.pdf" تبدیل می‌شود.

برای مشاهده سهمیه‌های روزانه برای تبدیل‌ها، به سهمیه‌های سرویس‌های گوگل مراجعه کنید. دامنه‌های جدید Google Workspace ممکن است موقتاً مشمول سهمیه‌های سختگیرانه‌تری باشند.

پارامترها

نام نوع توضیحات
content Type String نوع MIME برای تبدیل. برای اکثر blobها، 'application/pdf' تنها گزینه معتبر است. برای تصاویر با فرمت BMP، GIF، JPEG یا PNG، هر یک از 'image/bmp' ، 'image/gif' ، 'image/jpeg' یا 'image/png' نیز معتبر هستند. برای یک سند Google Docs، 'text/markdown' نیز معتبر است.

بازگشت

Blob - داده‌ها به عنوان یک حباب.

getBlob()

داده‌های درون این شیء را به صورت یک 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)

ارتفاع تصویر را بر حسب پیکسل تنظیم می‌کند.

پارامترها

نام نوع توضیحات
height Integer ارتفاع تصویر، بر حسب پیکسل

بازگشت

PositionedImage - شیء فعلی

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

setLayout(layout)

تعریف نحوه چیدمان تصویر را تعیین می‌کند.

پارامترها

نام نوع توضیحات
layout Positioned Layout یک enum که حالت طرح‌بندی را نشان می‌دهد

بازگشت

PositionedImage - این شیء برای زنجیره‌سازی

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

setLeftOffset(offset)

میزان انحراف تصویر از سمت چپ پاراگراف را بر حسب نقطه تنظیم می‌کند.

پارامترها

نام نوع توضیحات
offset Number انحراف از سمت چپ پاراگراف

بازگشت

PositionedImage - این شیء برای زنجیره‌سازی

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

setTopOffset(offset)

میزان انحراف تصویر از بالای پاراگراف را بر حسب نقطه تنظیم می‌کند.

پارامترها

نام نوع توضیحات
offset Number فاصله از بالای پاراگراف

بازگشت

PositionedImage - این شیء برای زنجیره‌سازی

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

setWidth(width)

عرض تصویر را بر حسب پیکسل تنظیم می‌کند.

پارامترها

نام نوع توضیحات
width Integer عرض تصویر، بر حسب پیکسل

بازگشت

PositionedImage - شیء فعلی

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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