Class PositionedImage

PositionedImage

Imagen de posición fija anclada a un Paragraph. A diferencia de InlineImage, un PositionedImage no es un Element. No tiene un elemento principal ni uno secundario Element. En cambio, se ancla en un Paragraph o ListItem, y se coloca mediante desplazamientos desde ese ancla. Un 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 de enumeración que representa cómo se distribuye la imagen.
getLeftOffset()NumberObtiene la compensación de la imagen, en puntos, del párrafo a la izquierda.
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 la disposición de la imagen.
setLeftOffset(offset)PositionedImageEstablece el desplazamiento de la imagen, en puntos, a partir del párrafo anterior.
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, &myt.myfile.pdf". Sin embargo, se supone que la parte del nombre de archivo que sigue al último período (si existe) es una extensión existente que se debe reemplazar. En consecuencia, "ShoppingList.15.15.2014" pasa a ser "ShoppingList.12.25.pdf".

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

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. Para imágenes en formato BMP, GIF, JPEG o PNG, también son válidos 'image/bmp', 'image/gif', 'image/jpeg' o 'image/png'.

Volver

Blob: los datos como un BLOB


getBlob()

Muestra 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: 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.

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

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

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

getLeftOffset()

Obtiene la compensación de la imagen, en puntos, del párrafo a la izquierda.

Volver

Number: el desplazamiento de la imagen del párrafo izquierdo 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.

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

Volver

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.

Volver

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

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

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

setLayout(layout)

Establece la definición de la disposición de 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 alcances:

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

setLeftOffset(offset)

Establece el desplazamiento de la imagen, en puntos, a partir del párrafo anterior.

Parámetros

NombreTipoDescripción
offsetNumbercompensación del párrafo a la izquierda

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 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
offsetNumbercompensación 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 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

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

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