Interface ImageMarkOptions

Description

Text options for image watermark

Example

backgroundImage: {
   src: require('./images/bg.png'),
   scale: 0.5,
   rotate: 45,
   alpha: 0.5
 },
 watermarkImages: [
   {
     src: require('./images/logo.png'),
     scale: 0.5,
     rotate: 45,
     alpha: 0.5,
     position: {
       X: 10,
       Y: 10,
     },
   },
   {
     src: require('./images/logo1.png'),
     scale: 0.5,
     rotate: 45,
     alpha: 0.5,
     position: {
       position: Position.center,
    },
   },
 ],
 quality: 1,
 filename: 'test',
 saveFormat: ImageFormat.jpg,

Hierarchy

  • ImageMarkOptions

Properties

backgroundImage filename? maxSize? quality? saveFormat? watermarkImage? watermarkImages watermarkPositions?

Properties

backgroundImage

backgroundImage: ImageOptions

FIXME: ImageSourcePropType type define bug

Description

background image options

Example

backgroundImage: {
   src: require('./images/bg.png'),
   scale: 0.5,
   rotate: 45,
   alpha: 0.5
 }

Optional filename

filename?: string

Description

save image name

Example

filename: 'test'

Optional maxSize

maxSize?: number

Deprecated

since 1.2.0

Description

max image size see #49 #42 android only need RN version >= 0.60.0, fresco MaxBitmapSize ImagePipelineConfig.Builder.experiment().setMaxBitmapSize(), see #49

Default Value

2048

Example

maxSize: 2048

Optional quality

quality?: number

Description

image quality 0-1

Default Value

1

Example

quality: 1

Optional saveFormat

saveFormat?: ImageFormat

Description

save image format

Default Value

jpg

Example

saveFormat: ImageFormat.jpg

Optional watermarkImage

watermarkImage?: ImageOptions

Since

1.1.0

Deprecated

use watermarkImages instead

Description

watermark image options

Example

watermarkImage: {
   src: require('./images/logo.png'),
   scale: 0.5,
   rotate: 45,
   alpha: 0.5
 }

watermarkImages

watermarkImages: WatermarkImageOptions[]

Description

watermark images

Example

watermarkImages: [
{
 src: require('./images/logo.png'),
 scale: 0.5,
 rotate: 45,
 alpha: 0.5,
 position: {
   X: 10,
   Y: 10,
   // or
   position: Position.center
 }
}]

Optional watermarkPositions

watermarkPositions?: PositionOptions

Since

1.1.0

Deprecated

use watermarkImages instead

Description

watermark position options

Example

watermarkPositions: {
 X: 10,
 Y: 10,
 // or
 position: Position.center
}

Note

use watermarkImages instead

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc