gm GraphicsMagick for node

Documentation

getters

All getters have the same signature:
```
gm("image.png").size(function(err, value){
  // note : value may be undefined
})
```
- size - returns the size (WxH) of the image
- format - returns the image format (gif, jpeg, png, etc)
- depth - returns the image color depth
- color - returns the number of colors
- res - returns the image resolution
- filesize - returns image filesize
- identify - returns all image data available
manipulation
- antialias
  By default all imgs are anti-aliased by GrahpicsMagick. To disable it pass false.
```
gm("img.png").antialias(false)
```
- bitdepth
  Specifies the number of bits of color to preserve in the image. See the docs for more detail.
```
gm("img.png").bitdepth(bits)
```
- blur
  Accepts a radius and optional sigma (standard deviation).
```
gm("img.png").blur(radius [, sigma])
```
- charcoal
  Simulates a charcoal drawing. Accepts a factor.
```
gm("img.png").charcoal(factor)
```
- chop
  Removes pixels from the interior of an image.
```
gm("img.png").chop(width, height, x, y)
```
- colors
  Sets the preferred number of colors for the image (color reduction).
```
gm("img.png").colors(int)
```
- colorize
  Colorize the image with optionally separate red, green, and blue values.
```
gm("img.png").colorize(red [, green [, blue]])
```
- colorspace
  Specifies the type of colorspace. See the GraphicsMagick docs for val details.
```
gm("img.png").colorspace(val)
```
- comment
  Annotates an image. See the docs for more info.
```
gm("img.png").comment(text|format)
```
- contrast
  Increases or reduces the image contrast. Accepts a multiplier.
```
gm("img.png").contrast([+-]multiplier)
```
- crop
  Crops the image to the given width and height at the given x and y position.
```
gm("img.png").crop(width, height, x, y)
```
- cycle
  Displace the image colormap by amount. amount is the number of positions each colormap entry is shifted.
```
gm("img.png").cycle(amount)
```
- despeckle
  Reduces the speckles within the image.
```
gm("img.png").despeckle()
```
- dither
  Applies Floyd/Steinberg error diffusion to the image. Pass false to disable dithering.
  Note: either .colors() or .monochrome() must be used for this to take effect.
```
gm("img.png").dither([bool])
```
- edge
  Emphasizes edges in an image. Takes an optional radius of the emphasis to apply.
```
gm("img.png").edge([radius])
```
- emboss
  Embosses the image. Takes an optional radius.
```
gm("img.png").emboss([radius])
```
- enhance
  Enhances the image.
```
gm("img.png").enhance()
```
- equalize
  Performs histogram equalization to the image.
```
gm("img.png").equalize()
```
- flip
  Creates a mirror image (vertically).
```
gm("img.png").flip()
```
- flop
  Creates a mirror image (horizontally).
```
gm("img.png").flop()
```
- gamma
  Adjusts the level of gamma correction.
```
gm("img.png").gamma(r, g, b)
```
- implode
  Implodes the image pixels around the center. Takes an optional factor.
```
gm("img.png").implode([factor])
```
- label
  Assigns a label to an image.
```
gm("img.png").label(name)
```
- limit
  Sets resource limits.
  
  type
  
  disk|file|map|memory|pixels|threads
  
  val
  
  follows the same rules as specified in the GraphicsMagick docs
```
gm("img.png").limit(type, val)
```
- lower
  Creates a pseudo 3D lowering effect of the images edges.
```
gm("img.png").lower(width, height)
```
- magnify
  Magnifies the image factor times.
```
gm("img.png").magnify(factor)
```
- median
  Applies a median filter to the image. The optional param radius adjusts the weight of the effect.
```
gm("img.png").median([radius])
```
- minify
  Minifies the image factor times.
```
gm("img.png").minify(factor)
```
- modulate
  Varies the brightness, saturation, and hue of the image.
```
gm("img.png").modulate(b [, s [, h]])
```
- monochrome
  Transforms the image to black and white.
```
gm("img.png").monochrome()
```
- morph
  Morphs two images together.
  
  otherImg
  
  the path to another img
  
  outName
  
  the path where the image will be saved
  
  callback
  
  A function to be executed when morphing is complete. callback will be passed the standard args that .write() receives.
```
gm("img.png").morph(otherImg, outName, callback)
```
- negative
  Replaces every pixel with its complementary color.
```
gm("img.png").negative()
```
- noise
  Add or reduce noise in the image.
  radius|type
  To add noise pass one of the following:
  - uniform
  - gaussian
  - multiplicative
  - impulse
  - laplacian
  - poisson
  Otherwise the argument will be interpreted as a radius which adjusts the weight of the effect.
```
gm("img.png").noise(radius|type)
```
- noProfile
  Removes EXIF, ICM, etc profile data.
```
gm("img.png").noProfile()
```
- paint
  Simulates an oil painting.
```
gm("img.png").paint(radius)
```
- quality
  Adjusts the jpeg|miff|png|tiff compression level. val ranges from 0 to 100 (best).
```
gm("img.png").quality(val)
```
- raise
  Creates a pseudo 3D raising effect of the images edges.
```
gm("img.png").raise(width, height)
```
- region
  Specifies that all following methods only apply to the area specified by width, height, x, y.
```
gm("img.png").region(width, height, x, y).sepia()
```
  In this case, the sepia effect would only be applied within the area specified by width, height, x, y.
- resample
  Resamples the image to specified horizontal and vertical resolution.
```
gm("img.png").resample(horizontal, vertical)
```
- resize
  Resize the image.
```
gm("img.png").resize(width, height)
```
- roll
  Rolls an image vertically or horizontally.
```
gm("img.png").roll(horizontalInt, verticalInt)
```
- rotate
  Rotates the image by degrees and fills the background with color.
```
gm("img.png").rotate(color, degrees)
```
- scale
  Scales the image.
```
gm("img.png").scale(width, height)
```
- sepia
  A convenience method to apply a sepia effect to the image.
```
gm("img.png").sepia()
```
- sharpen
  Sharpens the image.
```
gm("img.png").sharpen(radius [, sigma])
```
- solarize
  Negates all pixels above threshold percent.
```
gm("img.png").solarize(threshold)
```
- spread
  Desplaces pixels by a random amount.
```
gm("img.png").spread(amount)
```
- swirl
  Swirls pixels arount the center of the image. degrees specifies the tightness of the swirl.
```
gm("img.png").swirl(degrees)
```
- thumb
  Creates a thumbnail based on minimum sizes.
  
  width
  
  the minimum width of the thumbnail
  
  height
  
  the minimum height of the thumbnail
  
  outName
  
  the path where the image will be saved
  
  callback
  
  called after the thumbnail is written. receives the same args that .write(err, stdout, stderr, command) receives.
```
gm("img.png").thumb(width, height, outName, callback)
```

gm GraphicsMagick for node

Documentation

getters

manipulation