Class PositionedImage

PositionedImage

Posición fija de la imagen anclada a un Paragraph A diferencia de InlineImage, PositionedImage no es Element. No tiene un Element superior ni del mismo nivel. En cambio, se ancla a un Paragraph o ListItem, y se coloca a través de desplazamientos desde ese anclaje. Un elemento PositionedImage tiene un ID que se puede usar para hacer referencia a él.

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

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()BlobMuestra 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 enum que representa el diseño de la imagen.
getLeftOffset()NumberObtiene el desplazamiento de la imagen, en puntos, desde la izquierda del párrafo.
getParagraph()ParagraphObtiene el Paragraph al que se ancla 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 diseñará 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 de archivo, por ejemplo, “myfile.pdf”. Sin embargo, se supone que la parte del nombre de archivo que sigue al último punto (si existe) es una extensión existente que se debe reemplazar. En consecuencia, “ShoppingList.12.25.2014” se convierte en “ShoppingList.12.25.pdf”.

Para ver las cuotas diarias de las conversiones, consulta Cuotas de los servicios de Google. Los dominios de Google Workspace creados recientemente pueden estar sujetos a cuotas más estrictas de forma temporal.

Parámetros

NombreTipoDescripción
contentTypeStringEl tipo de MIME al que se realizará la conversión. Para la mayoría de los BLOB, 'application/pdf' es la única opción válida. En el caso de las imágenes en formato BMP, GIF, JPEG o PNG, también es válido cualquiera de los valores 'image/bmp', 'image/gif', 'image/jpeg' o 'image/png'.

Devolvedor

Blob: Son los datos como un BLOB.


getBlob()

Muestra los datos dentro de este objeto como un BLOB.

Devolvedor

Blob: Son los datos como un BLOB.


getHeight()

Recupera la altura de la imagen en píxeles.

Devolvedor

Integer: 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 alcances:

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

getId()

Obtiene el ID de la imagen.

Devolvedor

String: 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 alcances:

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

getLayout()

Obtiene un valor enum que representa el diseño de la imagen.

Devolvedor

PositionedLayout: 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 alcances:

  • 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.

Devolvedor

Number: El desplazamiento de la imagen desde la izquierda del párrafo de la izquierda

Autorización

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

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

getParagraph()

Obtiene el Paragraph al que se ancla la imagen.

Devolvedor

Paragraph: Es el párrafo principal.

Autorización

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

  • 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.

Devolvedor

Number: 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 alcances:

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

getWidth()

Recupera el ancho de la imagen en píxeles.

Devolvedor

Integer: 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 alcances:

  • 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

Devolvedor

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 alcances:

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

setLayout(layout)

Establece la definición de cómo se diseñará la imagen.

Parámetros

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

Devolvedor

PositionedImage: Este objeto para el encadenamiento

Autorización

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

  • 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

Devolvedor

PositionedImage: Este objeto para el encadenamiento

Autorización

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

  • 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
offsetNumberdesplazamiento desde la parte superior

Devolvedor

PositionedImage: Este objeto para el encadenamiento

Autorización

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

  • 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

Devolvedor

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 alcances:

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