Class PositionedImage

PositionedImage

Imagen de posición fija anclada a un Paragraph. A diferencia de un InlineImage, un PositionedImage no es un Element. No tiene un Element superior ni secundario. En su lugar, se ancla a un Paragraph o ListItem y se coloca mediante compensaciones a partir de ese ancla. Un PositionedImage tiene un ID que se puede usar para hacer referencia a él.

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

Métodos

MétodoTipo de datos que se muestraDescripción breve
getAs(contentType)BlobMuestra los datos dentro de este objeto como un blob convertido al tipo de contenido especificado.
getBlob()BlobDevuelve los datos dentro de este objeto como un blob.
getHeight()IntegerRecupera la altura de la imagen, en píxeles.
getId()StringObtiene el ID de la imagen.
getLayout()PositionedLayoutObtiene un valor de enumeración que representa cómo se organiza la imagen.
getLeftOffset()NumberObtiene el desplazamiento de la imagen, en puntos, desde la izquierda del párrafo.
getParagraph()ParagraphObtiene el Paragraph al que está anclada la imagen.
getTopOffset()NumberObtiene el desplazamiento de la imagen, en puntos, desde la parte superior del párrafo.
getWidth()IntegerRecupera el ancho de la imagen, en píxeles.
setHeight(height)PositionedImageEstablece la altura de la imagen en píxeles.
setLayout(layout)PositionedImageEstablece la definición de cómo se organiza la imagen.
setLeftOffset(offset)PositionedImageEstablece el desplazamiento de la imagen, en puntos, desde la izquierda del párrafo.
setTopOffset(offset)PositionedImageEstablece el desplazamiento de la imagen, en puntos, desde la parte superior del párrafo.
setWidth(width)PositionedImageEstablece el ancho de la imagen en píxeles.

Documentación detallada

getAs(contentType)

Muestra los datos dentro de este objeto como un blob convertido al tipo de contenido especificado. Este método agrega la extensión adecuada al nombre del archivo, por ejemplo, "miarchivo.pdf". Sin embargo, se da por sentado que la parte del nombre de archivo que sigue al último punto (si corresponde) es una extensión existente que se debe reemplazar. Por lo tanto, "ShoppingList.12.25.2014" se convierte en "ShoppingList.12.25.pdf".

Para ver las cuotas diarias de conversiones, consulta Cuotas de los servicios de Google. Es posible que los dominios de Google Workspace recién creados estén sujetos temporalmente a cuotas más estrictas.

Parámetros

NombreTipoDescripción
contentTypeStringEs el tipo de MIME al que se debe realizar la conversión. Para la mayoría de los blobs, 'application/pdf' es la única opción válida. Para las imágenes en formato BMP, GIF, JPEG o PNG, también son válidos 'image/bmp', 'image/gif', 'image/jpeg' o 'image/png'. Para un documento de Documentos de Google, 'text/markdown' también es válido.

Volver

Blob: Los datos como un BLOB.


getBlob()

Devuelve los datos dentro de este objeto como un blob.

Volver

Blob: Los datos como un BLOB.


getHeight()

Recupera la altura de la imagen, en píxeles.

Volver

Integer: Es la altura de la imagen, en píxeles.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

getId()

Obtiene el ID de la imagen.

Volver

String: Es el ID de la imagen.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

getLayout()

Obtiene un valor de enumeración que representa cómo se organiza la imagen.

Volver

PositionedLayout: Es el diseño de la imagen.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

getLeftOffset()

Obtiene el desplazamiento de la imagen, en puntos, desde la izquierda del párrafo.

Volver

Number: Es el desplazamiento de la imagen desde la izquierda del párrafo izquierdo.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

getParagraph()

Obtiene el Paragraph al que está anclada la imagen.

Volver

Paragraph: Es el párrafo superior.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

getTopOffset()

Obtiene el desplazamiento de la imagen, en puntos, desde la parte superior del párrafo.

Volver

Number: Es el desplazamiento de la imagen desde la parte superior del párrafo izquierdo.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

getWidth()

Recupera el ancho de la imagen, en píxeles.

Volver

Integer: Es el ancho de la imagen, en píxeles.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

setHeight(height)

Establece la altura de la imagen en píxeles.

Parámetros

NombreTipoDescripción
heightIntegerla altura de la imagen, en píxeles

Volver

PositionedImage: Es el objeto actual.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

setLayout(layout)

Establece la definición de cómo se organiza la imagen.

Parámetros

NombreTipoDescripción
layoutPositionedLayoutUna enumeración que representa el modo de diseño

Volver

PositionedImage: Este objeto para encadenar

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

setLeftOffset(offset)

Establece el desplazamiento de la imagen, en puntos, desde la izquierda del párrafo.

Parámetros

NombreTipoDescripción
offsetNumberdesplazamiento desde la izquierda del párrafo

Volver

PositionedImage: Este objeto para encadenar

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

setTopOffset(offset)

Establece el desplazamiento de la imagen, en puntos, desde la parte superior del párrafo.

Parámetros

NombreTipoDescripción
offsetNumberse desplaza desde la parte superior del párrafo.

Volver

PositionedImage: Este objeto para encadenar

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

setWidth(width)

Establece el ancho de la imagen en píxeles.

Parámetros

NombreTipoDescripción
widthIntegerEl ancho de la imagen, en píxeles

Volver

PositionedImage: Es el objeto actual.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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