RasterFrame_PushFilter_JSN¶

Edit a raster frame by applying a filter.

RasterFrame_PushFilter_JSN(imgDocRef;frameIdx;filterName;filterParamsJSON) ➔ success

→	`imgDocRef`	Text	The raster document reference.
→	`frameIdx`	Longint	The raster frame index.
→	`filterName`	Text	The filter name.
→	`filterParamsJSON`	Text	The filter parameters in JSON format.
↩︎	`success`	Longint	Completion status: `1` on success, `0` otherwise.

Edit the raster frame specified by imgDocRef and frameIdx by pushing a filter and its associated parameters into the frame’s edit stack.

Parameter imgDocRef is the raster document reference. If imgDocRef refers to a PDF document, this method does nothing.

Parameter frameIdx is the index of the image frame.

The filter is specified by the filterName and filterParamsJSON parameters. filterParamsJSON is a 4D object serialized in JSON format containing the filter parameters.

For a description on how filters are used for editing raster frames, see Raster Image Filters in the programming guide.

Supported filters and their associated parameters are listed in the Raster Filter Reference section.

Note

The RasterFrame_PushFilter in the Q2PixLib component is a wrapper to this plug-in method that accepts the filter parameters directly as a 4D object instead of a JSON serialization.