cropImage method
- required String sourcePath,
- int? maxWidth,
- int? maxHeight,
- CropAspectRatio? aspectRatio,
- List<
CropAspectRatioPreset> aspectRatioPresets = const [CropAspectRatioPreset.original, CropAspectRatioPreset.square, CropAspectRatioPreset.ratio3x2, CropAspectRatioPreset.ratio4x3, CropAspectRatioPreset.ratio16x9], - CropStyle cropStyle = CropStyle.rectangle,
- ImageCompressFormat compressFormat = ImageCompressFormat.jpg,
- int compressQuality = 90,
- List<
PlatformUiSettings> ? uiSettings,
Launch cropper UI for an image.
parameters:
-
sourcePath: the absolute path of an image file.
-
maxWidth: maximum cropped image width.
-
maxHeight: maximum cropped image height.
-
aspectRatio: controls the aspect ratio of crop bounds. If this values is set, the cropper is locked and user can't change the aspect ratio of crop bounds.
-
aspectRatioPresets: controls the list of aspect ratios in the crop menu view. In Android, you can set the initialized aspect ratio when starting the cropper by setting the value of
AndroidUiSettings.initAspectRatio
. Default is a list of CropAspectRatioPreset.original, CropAspectRatioPreset.square, CropAspectRatioPreset.ratio3x2, CropAspectRatioPreset.ratio4x3 and CropAspectRatioPreset.ratio16x9. -
cropStyle: controls the style of crop bounds, it can be rectangle or circle style (default is CropStyle.rectangle).
-
compressFormat: the format of result image, png or jpg (default is ImageCompressFormat.jpg)
-
compressQuality: the value
0 - 100
to control the quality of image compression -
uiSettings: controls UI customization on specific platform (android, ios, web,...)
return:
A result file of the cropped image.
Implementation
Future<CroppedFile?> cropImage({
required String sourcePath,
int? maxWidth,
int? maxHeight,
CropAspectRatio? aspectRatio,
List<CropAspectRatioPreset> aspectRatioPresets = const [
CropAspectRatioPreset.original,
CropAspectRatioPreset.square,
CropAspectRatioPreset.ratio3x2,
CropAspectRatioPreset.ratio4x3,
CropAspectRatioPreset.ratio16x9
],
CropStyle cropStyle = CropStyle.rectangle,
ImageCompressFormat compressFormat = ImageCompressFormat.jpg,
int compressQuality = 90,
List<PlatformUiSettings>? uiSettings,
}) {
throw UnimplementedError('cropImage() has not been implemented.');
}