Components All New MacOS Windows Linux iOS
Examples Mac & Win Server Client Guides Statistic FMM Blog Deprecated Old


Extends image size.

Component Version macOS Windows Linux Server iOS SDK
GraphicsMagick 9.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes ✅ Yes
MBS( "GMImage.Extent"; ImageRef; geometry { ; Color; GravityType } )   More


Parameter Description Example Flags
ImageRef The image reference number. 1
geometry The rectangle to use. Geometry is specified as a width and height "100x200". With an optional offset "100x200+10+20". For percent values, add a percent on the end, for % values add a %: "100x200%!" "100x200"
Color The background color value.
This can be a string in the following format "HSL h s l a", "YUV y u v a", "RGB r g b a", "MONO m a", "GRAY g a" or "COLOR R G B a". Alpha value a is optional. Range of values is 0 to 1.0 except if you use COLOR where RGB values are 0 to 65535.
Starting with version 5.4 of our plugin, you can use hex notation. # followed by 2 digits for red, green, blue and optional alpha, e.g. #FF0000 for full red.
"RGB 1 0 0" Optional
GravityType The Gravity Type.
Can be number of text value.
Can be ForgetGravity=0, NorthWestGravity=1, NorthGravity=2, NorthEastGravity=3, WestGravity=4, CenterGravity=5, EastGravity=6, SouthWestGravity=7, SouthGravity=8, SouthEastGravity=9, StaticGravity=10.
0 Optional


Returns OK or error.


Extends image size.
Create an image canvas using background color sized according to geometry and composite existing image on it, with image placement controlled by gravity.
Parameters are obtained from existing image properties if they are not specified via a method parameter. Parameters which are supported by image properties (gravity and backgroundColor) update those image properties as a side-effect.


Extent image with red space around:

Set Variable [ $BigImageRef ; Value: MBS("GMImage.NewFromContainer"; Test::BigImage) ]
Set Variable [ $Result ; Value: MBS("GMImage.Extent"; $BigImageRef; "1000x1000"; "red"; "center") ]
Set Field [ Test::Result ; MBS( "GMImage.WriteToPNGContainer"; $BigImageRef; "test.png" ) ]
Set Variable [ $Error ; Value: MBS("GMImage.Release";$BigImageRef) ]

See also

Release notes

Blog Entries

This function checks for a license.

Created 28th December 2018, last changed 11st November 2019

GMImage.ExifThumbnail - GMImage.FillPattern