From fd1aeadc042a64388b4a857d7438e3dd8e6bece3 Mon Sep 17 00:00:00 2001 From: JimmyDaddy Date: Wed, 29 Nov 2023 14:13:02 +0800 Subject: [PATCH] chore: update docs (#166) --- docs/latest/classes/Marker.html | 6 ++--- docs/latest/enums/ImageFormat.html | 8 +++--- docs/latest/enums/Position.html | 16 ++++++------ docs/latest/enums/TextBackgroundType.html | 8 +++--- docs/latest/index.html | 3 ++- docs/latest/interfaces/CornerRadius.html | 12 ++++----- docs/latest/interfaces/ImageMarkOptions.html | 18 ++++++------- docs/latest/interfaces/ImageOptions.html | 10 +++---- docs/latest/interfaces/PositionOptions.html | 8 +++--- docs/latest/interfaces/RadiusValue.html | 6 ++--- docs/latest/interfaces/ShadowLayerStyle.html | 10 +++---- .../interfaces/TextBackgroundStyle.html | 26 +++++++++---------- docs/latest/interfaces/TextMarkOptions.html | 14 +++++----- docs/latest/interfaces/TextOptions.html | 8 +++--- docs/latest/interfaces/TextStyle.html | 26 +++++++++---------- .../interfaces/WatermarkImageOptions.html | 12 ++++----- 16 files changed, 96 insertions(+), 95 deletions(-) diff --git a/docs/latest/classes/Marker.html b/docs/latest/classes/Marker.html index 49c618bf..6ab3c5d3 100644 --- a/docs/latest/classes/Marker.html +++ b/docs/latest/classes/Marker.html @@ -20,7 +20,7 @@

Hierarchy

+
  • Defined in index.ts:825
    • @@ -53,7 +53,7 @@

    Example

    const
    +
  • Defined in index.ts:978

    • Static markText

      @@ -74,7 +74,7 @@

      Example

      const
    +
  • Defined in index.ts:910
    • diff --git a/docs/latest/enums/ImageFormat.html b/docs/latest/enums/ImageFormat.html index 68a2910b..364c145e 100644 --- a/docs/latest/enums/ImageFormat.html +++ b/docs/latest/enums/ImageFormat.html @@ -20,7 +20,7 @@

    Enumeration ImageFormat

    Description

    ImageFormat enum for save image format

    +
  • Defined in index.ts:38
    • @@ -38,17 +38,17 @@

    Enumeration Members

    base64

    base64: "base64"
    +
  • Defined in index.ts:42

    • jpg

    jpg: "jpg"
    +
  • Defined in index.ts:40

    • png

    png: "png"
    +
  • Defined in index.ts:39
    • diff --git a/docs/latest/enums/Position.html b/docs/latest/enums/Position.html index 187315de..168308bf 100644 --- a/docs/latest/enums/Position.html +++ b/docs/latest/enums/Position.html @@ -20,7 +20,7 @@

    Enumeration Position

    Description

    Position enum for text watermark and image watermark

    +
  • Defined in index.ts:14
    • @@ -42,37 +42,37 @@

    Enumeration Members

    bottomCenter

    bottomCenter: "bottomCenter"
    +
  • Defined in index.ts:19

    • bottomLeft

    bottomLeft: "bottomLeft"
    +
  • Defined in index.ts:18

    • bottomRight

    bottomRight: "bottomRight"
    +
  • Defined in index.ts:20

    • center

    center: "center"
    +
  • Defined in index.ts:21

    • topCenter

    topCenter: "topCenter"
    +
  • Defined in index.ts:16

    • topLeft

    topLeft: "topLeft"
    +
  • Defined in index.ts:15

    • topRight

    topRight: "topRight"
    +
  • Defined in index.ts:17
    • diff --git a/docs/latest/enums/TextBackgroundType.html b/docs/latest/enums/TextBackgroundType.html index ec1fac66..a36e8119 100644 --- a/docs/latest/enums/TextBackgroundType.html +++ b/docs/latest/enums/TextBackgroundType.html @@ -20,7 +20,7 @@

    Enumeration TextBackgroundType

    Description

    TextBackgroundType enum for text watermark

    +
  • Defined in index.ts:28
    • @@ -38,17 +38,17 @@

    Enumeration Members

    none

    none: "fit"
    +
  • Defined in index.ts:31

    • stretchX

    stretchX: "stretchX"
    +
  • Defined in index.ts:29

    • stretchY

    stretchY: "stretchY"
    +
  • Defined in index.ts:30
    • diff --git a/docs/latest/index.html b/docs/latest/index.html index 4689d967..297b30e9 100644 --- a/docs/latest/index.html +++ b/docs/latest/index.html @@ -22,7 +22,8 @@
    Add text or icon watermarks to images

    npm version npm stars forksgithub PRs Welcome license - platform-iOS platform-Android + platform-iOS platform-Android Native Build and Test +
    If this library is useful to you, pls give me a ⭐️. 🤩

    diff --git a/docs/latest/interfaces/CornerRadius.html b/docs/latest/interfaces/CornerRadius.html index 4fb1400e..50ffa5b8 100644 --- a/docs/latest/interfaces/CornerRadius.html +++ b/docs/latest/interfaces/CornerRadius.html @@ -20,7 +20,7 @@

    Hierarchy

    • CornerRadius
    +
  • Defined in index.ts:333
    • @@ -40,27 +40,27 @@

    Properties

    Optional all

    all?: RadiusValue
    +
  • Defined in index.ts:338

    • Optional bottomLeft

    bottomLeft?: RadiusValue
    +
  • Defined in index.ts:336

    • Optional bottomRight

    bottomRight?: RadiusValue
    +
  • Defined in index.ts:337

    • Optional topLeft

    topLeft?: RadiusValue
    +
  • Defined in index.ts:334

    • Optional topRight

    topRight?: RadiusValue
    +
  • Defined in index.ts:335
    • diff --git a/docs/latest/interfaces/ImageMarkOptions.html b/docs/latest/interfaces/ImageMarkOptions.html index 0c621647..567e3935 100644 --- a/docs/latest/interfaces/ImageMarkOptions.html +++ b/docs/latest/interfaces/ImageMarkOptions.html @@ -27,7 +27,7 @@

    Hierarchy

    • ImageMarkOptions
    +
  • Defined in index.ts:725
    • @@ -58,7 +58,7 @@

    Example

    backgroundIma
    +
  • Defined in index.ts:737

    • Optional filename

    filename?: string
    @@ -69,7 +69,7 @@

    Example

    filename
    +
  • Defined in index.ts:777

    • Optional maxSize

    maxSize?: number
    @@ -84,7 +84,7 @@

    Example

    maxSize
    +
  • Defined in index.ts:793

    • Optional quality

    quality?: number
    @@ -97,7 +97,7 @@

    Example

    quality
    +
  • Defined in index.ts:771

    • Optional saveFormat

    saveFormat?: ImageFormat
    @@ -110,7 +110,7 @@

    Example

    saveFormat
    +
  • Defined in index.ts:784

    • Optional watermarkImage

    watermarkImage?: ImageOptions
    @@ -125,7 +125,7 @@

    Example

    watermarkImag
    +
  • Defined in index.ts:750

    • watermarkImages

    watermarkImages: WatermarkImageOptions[]
    @@ -136,7 +136,7 @@

    Example

    watermarkImag
    +
  • Defined in index.ts:811

    • Optional watermarkPositions

    watermarkPositions?: PositionOptions
    @@ -153,7 +153,7 @@

    Example

    watermarkPosi
 
    Note
    use watermarkImages instead
    +
  • Defined in index.ts:764
    • diff --git a/docs/latest/interfaces/ImageOptions.html b/docs/latest/interfaces/ImageOptions.html index 4fe55cb7..95255069 100644 --- a/docs/latest/interfaces/ImageOptions.html +++ b/docs/latest/interfaces/ImageOptions.html @@ -29,7 +29,7 @@

    Hierarchy

    +
  • Defined in index.ts:640
    • @@ -56,7 +56,7 @@

    Example

    alpha<
    +
  • Defined in index.ts:667

    • Optional rotate

    rotate?: number
    @@ -69,7 +69,7 @@

    Example

    rotate
    +
  • Defined in index.ts:660

    • Optional scale

    scale?: number
    @@ -82,7 +82,7 @@

    Example

    scale<
    +
  • Defined in index.ts:653

    • src

    src: any
    @@ -93,7 +93,7 @@

    Example

    src
    +
  • Defined in index.ts:646
    • diff --git a/docs/latest/interfaces/PositionOptions.html b/docs/latest/interfaces/PositionOptions.html index 69f2734d..00f3555a 100644 --- a/docs/latest/interfaces/PositionOptions.html +++ b/docs/latest/interfaces/PositionOptions.html @@ -27,7 +27,7 @@

    Hierarchy

    • PositionOptions
    +
  • Defined in index.ts:166
    • @@ -45,17 +45,17 @@

    Properties

    Optional X

    X?: string | number
    +
  • Defined in index.ts:167

    • Optional Y

    Y?: string | number
    +
  • Defined in index.ts:168

    • Optional position

    position?: Position
    +
  • Defined in index.ts:169
    • diff --git a/docs/latest/interfaces/RadiusValue.html b/docs/latest/interfaces/RadiusValue.html index b562ec18..1a708d2c 100644 --- a/docs/latest/interfaces/RadiusValue.html +++ b/docs/latest/interfaces/RadiusValue.html @@ -20,7 +20,7 @@

    Hierarchy

    • RadiusValue
    +
  • Defined in index.ts:328
    • @@ -37,12 +37,12 @@

    Properties

    x

    x: string | number
    +
  • Defined in index.ts:329

    • y

    y: string | number
    +
  • Defined in index.ts:330
    • diff --git a/docs/latest/interfaces/ShadowLayerStyle.html b/docs/latest/interfaces/ShadowLayerStyle.html index 2f7a8bae..91ce018b 100644 --- a/docs/latest/interfaces/ShadowLayerStyle.html +++ b/docs/latest/interfaces/ShadowLayerStyle.html @@ -27,7 +27,7 @@

    Hierarchy

    • ShadowLayerStyle
    +
  • Defined in index.ts:301
    • @@ -52,7 +52,7 @@

    Example

    color<
    +
  • Defined in index.ts:325

    • dx

    dx: number
    @@ -63,7 +63,7 @@

    Example

    dx
    +
  • Defined in index.ts:307

    • dy

    dy: number
    @@ -74,7 +74,7 @@

    Example

    dy
    +
  • Defined in index.ts:313

    • radius

    radius: number
    @@ -85,7 +85,7 @@

    Example

    radius
    +
  • Defined in index.ts:319
    • diff --git a/docs/latest/interfaces/TextBackgroundStyle.html b/docs/latest/interfaces/TextBackgroundStyle.html index a4840d32..457bac16 100644 --- a/docs/latest/interfaces/TextBackgroundStyle.html +++ b/docs/latest/interfaces/TextBackgroundStyle.html @@ -32,7 +32,7 @@

    Hierarchy

    • TextBackgroundStyle
    +
  • Defined in index.ts:372
    • @@ -65,7 +65,7 @@

    Example

    color<
    +
  • Defined in index.ts:385

    • Optional cornerRadius

    cornerRadius?: CornerRadius
    @@ -76,7 +76,7 @@

    Example

    cornerRadius<
    +
  • Defined in index.ts:409

    • Optional padding

    padding?: string | number
    @@ -88,7 +88,7 @@

    Example

    padding
    +
  • Defined in index.ts:78

    • Optional paddingBottom

    paddingBottom?: string | number
    @@ -100,7 +100,7 @@

    Example

    paddingBottom
    +
  • Defined in index.ts:110

    • Optional paddingHorizontal

    paddingHorizontal?: string | number
    @@ -114,7 +114,7 @@

    Since

    2.0.0

    +
  • Defined in index.ts:119

    • Optional paddingLeft

    paddingLeft?: string | number
    @@ -126,7 +126,7 @@

    Example

    paddingLeft
    +
  • Defined in index.ts:86

    • Optional paddingRight

    paddingRight?: string | number
    @@ -138,7 +138,7 @@

    Example

    paddingTop
    +
  • Defined in index.ts:94

    • Optional paddingTop

    paddingTop?: string | number
    @@ -150,7 +150,7 @@

    Example

    paddingRight<
    +
  • Defined in index.ts:102

    • Optional paddingVertical

    paddingVertical?: string | number
    @@ -164,7 +164,7 @@

    Since

    2.0.0

    +
  • Defined in index.ts:128

    • Optional paddingX

    paddingX?: string | number
    @@ -176,7 +176,7 @@

    Example

    paddingX
    +
  • Defined in index.ts:137

    • Optional paddingY

    paddingY?: string | number
    @@ -188,7 +188,7 @@

    Example

    paddingY
    +
  • Defined in index.ts:146

    • type

    type: null | TextBackgroundType
    @@ -201,7 +201,7 @@

    Example

    type
    +
  • Defined in index.ts:379
    • diff --git a/docs/latest/interfaces/TextMarkOptions.html b/docs/latest/interfaces/TextMarkOptions.html index 5780976c..7b7f8ba1 100644 --- a/docs/latest/interfaces/TextMarkOptions.html +++ b/docs/latest/interfaces/TextMarkOptions.html @@ -27,7 +27,7 @@

    Hierarchy

    • TextMarkOptions
    +
  • Defined in index.ts:546
    • @@ -56,7 +56,7 @@

    Example

    backgroundIma
    +
  • Defined in index.ts:558

    • Optional filename

    filename?: string
    @@ -67,7 +67,7 @@

    Example

    filename
    +
  • Defined in index.ts:611

    • Optional maxSize

    maxSize?: number
    @@ -82,7 +82,7 @@

    Example

    maxSize
    +
  • Defined in index.ts:627

    • Optional quality

    quality?: number
    @@ -95,7 +95,7 @@

    Example

    quality
    +
  • Defined in index.ts:605

    • Optional saveFormat

    saveFormat?: ImageFormat
    @@ -108,7 +108,7 @@

    Example

    saveFormat
    +
  • Defined in index.ts:618

    • watermarkTexts

    watermarkTexts: TextOptions[]
    @@ -119,7 +119,7 @@

    Example

    watermarkText
    +
  • Defined in index.ts:598
    • diff --git a/docs/latest/interfaces/TextOptions.html b/docs/latest/interfaces/TextOptions.html index fd2a9441..2f51149f 100644 --- a/docs/latest/interfaces/TextOptions.html +++ b/docs/latest/interfaces/TextOptions.html @@ -27,7 +27,7 @@

    Hierarchy

    • TextOptions
    +
  • Defined in index.ts:447
    • @@ -51,7 +51,7 @@

    Example

    positionOptio
    +
  • Defined in index.ts:464

    • Optional style

    style?: TextStyle
    @@ -62,7 +62,7 @@

    Example

    style<
    +
  • Defined in index.ts:494

    • text

    text: string
    @@ -73,7 +73,7 @@

    Example

    text
    +
  • Defined in index.ts:453
    • diff --git a/docs/latest/interfaces/TextStyle.html b/docs/latest/interfaces/TextStyle.html index 59f6c851..6643a524 100644 --- a/docs/latest/interfaces/TextStyle.html +++ b/docs/latest/interfaces/TextStyle.html @@ -27,7 +27,7 @@

    Hierarchy

    • TextStyle
    +
  • Defined in index.ts:200
    • @@ -62,7 +62,7 @@

    Example

    bold
    +
  • Defined in index.ts:281

    • Optional color

    color?: string
    @@ -73,7 +73,7 @@

    Example

    color<
    +
  • Defined in index.ts:206

    • Optional fontName

    fontName?: string
    @@ -84,7 +84,7 @@

    Example

    fontName
    +
  • Defined in index.ts:212

    • Optional fontSize

    fontSize?: number
    @@ -95,7 +95,7 @@

    Example

    fontSize
    +
  • Defined in index.ts:218

    • Optional italic

    italic?: boolean
    @@ -108,7 +108,7 @@

    Example

    italic
    +
  • Defined in index.ts:274

    • Optional rotate

    rotate?: number
    @@ -121,7 +121,7 @@

    Example

    rotate
    +
  • Defined in index.ts:288

    • Optional shadowStyle

    shadowStyle?: null | ShadowLayerStyle
    @@ -132,7 +132,7 @@

    Example

    shadowStyle
    +
  • Defined in index.ts:229

    • Optional skewX

    skewX?: number
    @@ -143,7 +143,7 @@

    Example

    skewX<
    +
  • Defined in index.ts:253

    • Optional strikeThrough

    strikeThrough?: boolean
    @@ -156,7 +156,7 @@

    Example

    strikeThrough
    +
  • Defined in index.ts:260

    • Optional textAlign

    textAlign?: "left" | "center" | "right"
    @@ -169,7 +169,7 @@

    Example

    textAlign
    +
  • Defined in index.ts:267

    • Optional textBackgroundStyle

    textBackgroundStyle?: null | TextBackgroundStyle
    @@ -180,7 +180,7 @@

    Example

    textBackgroun
    +
  • Defined in index.ts:240

    • Optional underline

    underline?: boolean
    @@ -193,7 +193,7 @@

    Example

    underline
    +
  • Defined in index.ts:247
    • diff --git a/docs/latest/interfaces/WatermarkImageOptions.html b/docs/latest/interfaces/WatermarkImageOptions.html index e0f5eae9..ffd2d7d4 100644 --- a/docs/latest/interfaces/WatermarkImageOptions.html +++ b/docs/latest/interfaces/WatermarkImageOptions.html @@ -29,7 +29,7 @@

    Hierarchy

    • WatermarkImageOptions
    +
  • Defined in index.ts:684
    • @@ -58,12 +58,12 @@

    Example

    alpha<
    +
  • Defined in index.ts:667

    • Optional position

    position?: PositionOptions
    +
  • Defined in index.ts:685

    • Optional rotate

    rotate?: number
    @@ -77,7 +77,7 @@

    Example

    rotate
    +
  • Defined in index.ts:660

    • Optional scale

    scale?: number
    @@ -91,7 +91,7 @@

    Example

    scale<
    +
  • Defined in index.ts:653

    • src

    src: any
    @@ -103,7 +103,7 @@

    Example

    src
    +
  • Defined in index.ts:646