ImageServices

Services available for Images. See document examples.

• ImageServices
  • String.asImage() : org.obeonetwork.m2doc.element.MImage
    • Parameter
    • Example
  • String.asImage(String) : org.obeonetwork.m2doc.element.MImage
    • Parameter
    • Example
  • org.obeonetwork.m2doc.element.MImage.fit(Integer, Integer) : org.obeonetwork.m2doc.element.MImage
    • Parameter
    • Example
  • org.obeonetwork.m2doc.element.MImage.getHeight() : Integer
    • Parameter
    • Example
  • org.obeonetwork.m2doc.element.MImage.getWidth() : Integer
    • Parameter
    • Example
  • org.obeonetwork.m2doc.element.MImage.resize(Double) : org.obeonetwork.m2doc.element.MImage
    • Parameter
    • Example
  • org.obeonetwork.m2doc.element.MImage.rotate(Integer) : org.obeonetwork.m2doc.element.MImage
    • Parameter
    • Example
  • org.obeonetwork.m2doc.element.MImage.setConserveRatio(Boolean) : org.obeonetwork.m2doc.element.MImage
    • Parameter
    • Example
  • org.obeonetwork.m2doc.element.MImage.setHeight(Integer) : org.obeonetwork.m2doc.element.MImage
    • Parameter
    • Example
  • org.obeonetwork.m2doc.element.MImage.setWidth(Integer) : org.obeonetwork.m2doc.element.MImage
    • Parameter
    • Example

String.asImage() : org.obeonetwork.m2doc.element.MImage

Convert a String representing an URI to an Image.

Parameter

• uri: The Image uri, it can be relative to the template

Example

• ‘image.png’.asImage()
  • insert the image ‘image.png’

String.asImage(String) : org.obeonetwork.m2doc.element.MImage

Convert a String representing an URI to an Image and serialize it in the given format.

Parameter

• uri: The Image uri, it can be relative to the template

Example

• ‘image.png’.asImage(‘jpg’)
  • insert the image ‘image.jpg’

org.obeonetwork.m2doc.element.MImage.fit(Integer, Integer) : org.obeonetwork.m2doc.element.MImage

Fits the Image in the given rectangle width and height.

Parameter

• image: The Image
• width: The width to fit
• height: The height to fit

Example

• myImage.fit(200, 300)
  • will fit the image in a rectangle (width=200, height=300)

org.obeonetwork.m2doc.element.MImage.getHeight() : Integer

Gets the height of the image.

Parameter

• image: The Image

Example

• myImage.getHeight()
  • 300

org.obeonetwork.m2doc.element.MImage.getWidth() : Integer

Gets the width of the image.

Parameter

• image: The Image

Example

• myImage.getWidth()
  • 300

org.obeonetwork.m2doc.element.MImage.resize(Double) : org.obeonetwork.m2doc.element.MImage

Resizes the Image by the given factor.

Parameter

• image: The Image
• factor: The resize factor

Example

• myImage.resize(0.5)
  • will resize the image by a factor 0.5

org.obeonetwork.m2doc.element.MImage.rotate(Integer) : org.obeonetwork.m2doc.element.MImage

Rotates the Image by the given angle in degres.

Parameter

• image: The Image
• angle: The angle in degres

Example

• myImage.rotate(90)
  • will rotate the image by an angle of 90 degres

org.obeonetwork.m2doc.element.MImage.setConserveRatio(Boolean) : org.obeonetwork.m2doc.element.MImage

Sets the conserve ratio of the image.

Parameter

• image: The Image
• conserve: A Boolean

Example

• myImage.setConserveRatio(false)
  • set the conserve ratio to false

org.obeonetwork.m2doc.element.MImage.setHeight(Integer) : org.obeonetwork.m2doc.element.MImage

Sets the height of the image.

Parameter

• image: The Image
• height: The height

Example

• myImage.setHeight(300)
  • set the height to 300

org.obeonetwork.m2doc.element.MImage.setWidth(Integer) : org.obeonetwork.m2doc.element.MImage

Sets the width of the image.

Parameter

• image: The Image
• width: The width

Example

• myImage.setWidth(300)
  • set the witdh to 300