Skip to content

Filter Object

The filter object enables your app to apply filters to the bitmaps contained in Image widgets. This section discusses the filter object for the following item:

Methods

The filter object contains the following methods.

applyFilter Method

This method applies a filter to an Image object.

Syntax


filter.applyFilter(  
    dictionary)

Input Parameters

Parameter Description
dictionary A dictionary of attributes that contains the name of the filter and the filter's supporting data.

Example


//By using the below function, you can add a cartoon filter over your image.
  createFilterForiOS: function(){

  var imgBright =  voltmx.image.createImage(this.imageBytes);
  var filterobj =  voltmx.filter.createFilter();
  var filterData = {
    "filterName": voltmx.filter.COMIC_EFFECT,
    "inputImage": imgBright,
  };
  filterobj.applyFilter(filterData);
  var imageObj = filterobj.getOutputImage();
  this.view.imgBrite.rawBytes = imageObj.getImageAsRawBytes();
  this.view.forceLayout();
  }

Return Values

None.

Remarks

For information about the available filters and their required supporting data, please see the constants in the voltmx.filter namespace.

The following filters change the dimensions of the Image object.

  • GaussianBlur
  • BoxBlur
  • DiskBlur
  • MotionBlur
  • ZoomBlur
  • BumpDistortion
  • CircularWrap
  • AffineTransform

Platform Availability

Available on all platforms.

clearFilterData Method

Clears all of the data stored in a filter.

Syntax


filter.clearFilterData()

Example


var filterObj = voltmx.filter.createFilter();
filterObj.clearFilterData();

Input Parameters

None.

Return Values

None.

Platform Availability

Available on all platforms.

getOutputImage Method

Gets the image that results from applying the filter.

Syntax


filter.getOutputImage()

Example


var imgBright =  voltmx.image.createImage(this.imageBytes);
  var filterobj =  voltmx.filter.createFilter();
  var filterData = {
    "filterName": voltmx.filter.COMIC_EFFECT,
    "inputImage": imgBright,
  };
  filterobj.applyFilter(filterData);
  var imageObj = filterobj.getOutputImage();//displays

Input Parameters

None.

Return Values

The image that results from applying the filter.

Remarks

IF the output image is not yet available, this method throws an exception.

Platform Availability

Available on all platforms.