From 20eaa1e98b20001574430a5c1218643d69a8499f Mon Sep 17 00:00:00 2001
From: zhoulisheng <635547767@qq.com>
Date: Mon, 25 Dec 2023 15:56:44 +0800
Subject: [PATCH] =?UTF-8?q?1.README.md=E4=BF=AE=E6=94=B9=20RequestOption?=
=?UTF-8?q?=E5=88=A0=E9=99=A4=E6=8E=A5=E5=8F=A3=E3=80=82=202.CHANGLOG.md?=
=?UTF-8?q?=20=E6=96=B0=E5=A2=9ERequestOption=E5=88=A0=E9=99=A4addRetryLis?=
=?UTF-8?q?tener=E6=8E=A5=E5=8F=A3=E5=8E=9F=E5=9B=A0=E5=8F=8A=E8=AF=B4?=
=?UTF-8?q?=E6=98=8E?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Signed-off-by: zhoulisheng <635547767@qq.com>
---
CHANGELOG.md | 2 ++
README.md | 81 ++++++++++++++++++++++++++--------------------------
2 files changed, 42 insertions(+), 41 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index a64b25f..983d499 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -170,6 +170,8 @@
- 新增SVG图片解析能力。
+- RequestOption删除addRetryListener接口,重试图层监听请使用retryholder接口。
+
## 1.0.3
- 适配OpenHarmony API9 Stage模型。
diff --git a/README.md b/README.md
index e4601a6..950b11d 100644
--- a/README.md
+++ b/README.md
@@ -108,31 +108,31 @@ imageKnifeOption = {
### ImageKnifeOption参数列表
-| 参数名称 | 入参内容 | 功能简介 |
-|------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------|
-| loadSrc | string \ | PixelMap \ | Resource | 设置主图资源（必选） |
-| mainScaleType | ScaleType | 设置主图展示样式（可选） |
-| strategy | DiskStrategy | 设置磁盘缓存策略（可选） |
-| dontAnimateFlag | boolean | gif加载展示一帧（可选） |
-| placeholderSrc | PixelMap \ | Resource | 设置占位图（可选） |
-| placeholderScaleType | ScaleType | 设置占位图展示样式（可选） |
-| errorholderSrc | PixelMap \ | Resource | 设置加载失败占位图（可选） |
-| errorholderSrcScaleType | ScaleType | 设置失败占位图展示样式（可选） |
-| retryholderSrc | PixelMap \ | Resource | 设置加载失败重试占位图（可选） |
-| retryholderScaleType | ScaleType | 设置重试占位图展示样式（可选） |
-| thumbSizeMultiplier | number 范围(0,1] | 设置缩略图占比（可选） |
-| thumbSizeDelay | number | 设置缩略图展示时间（可选） |
-| thumbSizeMultiplierScaleType | ScaleType | 设置缩略图展示样式（可选） |
-| displayProgress | boolean | 设置是否展示下载进度条（可选） |
-| canRetryClick | boolean | 设置重试图层是否点击重试（可选） |
-| onlyRetrieveFromCache | boolean | 仅使用缓存加载数据（可选） |
-| isCacheable | boolean | 是否开启一级内存缓存（可选） |
-| gif | {
// 返回一周期动画gif消耗的时间
loopFinish?: (loopTime?) => void
// gif播放速率相关
speedFactory?: number
// 直接展示gif第几帧数据
seekTo?: number
} | GIF播放控制能力（可选） |
-| transformation | BaseTransform | 单个变换（可选） |
-| transformations | Array> | 多个变换,目前仅支持单个变换（可选） |
-| allCacheInfoCallback | IAllCacheInfoCallback | 输出缓存相关内容和信息（可选） |
-| signature | ObjectKey | 自定key（可选） |
-| **drawLifeCycle** | **IDrawLifeCycle** | **用户自定义实现绘制方案（可选）** |
+| 参数名称 | 入参内容 | 功能简介 |
+| ---------------------------- | ------------------------------------------------------------ | ----------------------------------- |
+| loadSrc | string\|PixelMap\|Resource | 图片数据源 |
+| mainScaleType | ScaleType | 设置主图展示样式（可选） |
+| strategy | DiskStrategy | 设置磁盘缓存策略（可选） |
+| dontAnimateFlag | boolean | gif加载展示一帧（可选） |
+| placeholderSrc | PixelMap\|Resource | 占位图数据源 |
+| placeholderScaleType | ScaleType | 设置占位图展示样式（可选） |
+| errorholderSrc | PixelMap\|Resource | 错误占位图数据源 |
+| errorholderSrcScaleType | ScaleType | 设置失败占位图展示样式（可选） |
+| retryholderSrc | PixelMap\|Resource | 重试占位图数据源 |
+| retryholderScaleType | ScaleType | 设置重试占位图展示样式（可选） |
+| thumbSizeMultiplier | number 范围(0,1] | 设置缩略图占比（可选） |
+| thumbSizeDelay | number | 设置缩略图展示时间（可选） |
+| thumbSizeMultiplierScaleType | ScaleType | 设置缩略图展示样式（可选） |
+| displayProgress | boolean | 设置是否展示下载进度条（可选） |
+| canRetryClick | boolean | 设置重试图层是否点击重试（可选） |
+| onlyRetrieveFromCache | boolean | 仅使用缓存加载数据（可选） |
+| isCacheable | boolean | 是否开启一级内存缓存（可选） |
+| gif | {
// 返回一周期动画gif消耗的时间
loopFinish?: (loopTime?) => void
// gif播放速率相关
speedFactory?: number
// 直接展示gif第几帧数据
seekTo?: number
} | GIF播放控制能力（可选） |
+| transformation | BaseTransform | 单个变换（可选） |
+| transformations | Array> | 多个变换,目前仅支持单个变换（可选） |
+| allCacheInfoCallback | IAllCacheInfoCallback | 输出缓存相关内容和信息（可选） |
+| signature | ObjectKey | 自定key（可选） |
+| **drawLifeCycle** | **IDrawLifeCycle** | **用户自定义实现绘制方案（可选）** |
其他参数只需要在ImageKnifeOption对象上按需添加即可。
@@ -306,22 +306,21 @@ request.skipMemoryCache(true)
### RequestOption用户配置参数
-| 方法名 | 入参 | 接口描述 |
-|-----------------------------------------------------------------------|------------------------------------------------------------|----------------------------------------------|
-| load(src: string \ | PixelMap \ | Resource) | string \| PixelMap \| Resource | 待加载图片的资源 |
-| setImageViewSize(imageSize: { width: number, height: number }) | { width: number, height: number } | 传入显示图片组件的大小，变换的时候需要作为参考 |
-| diskCacheStrategy(strategy: DiskStrategy) | DiskStrategy | 配置磁盘缓存策略 NONE SOURCE RESULT ALL AUTOMATIC |
-| placeholder(src: PixelMap \ | Resource, func?: AsyncSuccess) | src: PixelMap \ | Resource, func?: AsyncSuccess | 配置占位图，其中func为数据回调函数 |
-| errorholder(src: PixelMap \ | Resource, func?: AsyncSuccess) | src: PixelMap \ | Resource, func?: AsyncSuccess | 配置加载失败占位图，其中func为数据回调函数 |
-| retryholder(src: PixelMap \ | Resource, func?: AsyncSuccess) | src: PixelMap \ | Resource, func?: AsyncSuccess | 配置重试占位图，如果配置则加载失败后优先展示重试占位图 |
-| addListener(func: AsyncCallback) | func: AsyncCallback | 配置整个监听回调，数据正常加载返回，加载失败返回错误信息 |
-| thumbnail(sizeMultiplier:number, func?: AsyncSuccess) | sizeMultiplier:number, func?: AsyncSuccess | 设置缩略图比例，缩略图返回后，加载并展示缩略图 |
-| addProgressListener(func?: AsyncSuccess) | func?: AsyncSuccess | 设置网络下载百分比监听，返回数据加载百分比数值 |
-| addRetryListener(func?: AsyncSuccess) | func?: AsyncSuccess | 设置重试监听 |
-| addAllCacheInfoCallback(func: IAllCacheInfoCallback) | func: IAllCacheInfoCallback | 设置获取所有缓存信息监听 |
-| skipMemoryCache(skip: boolean) | skip: boolean | 配置是否跳过内存缓存 |
-| retrieveDataFromCache(flag: boolean) | flag: boolean | 配置仅从缓存中加载数据 |
-| signature | ObjectKey | 自定义key |
+| 方法名 | 入参 | 接口描述 |
+| ------------------------------------------------------------ | ------------------------------------------------------------ | -------------------------------------------------------- |
+| load(src: string \| PixelMap \|Resource) | src:string\|PixelMap\|Resource | 用户加载图片源 |
+| setImageViewSize(imageSize: { width: number, height: number }) | imageSize:{width: number, height: number } | 传入显示图片组件的大小，变换的时候需要作为参考 |
+| diskCacheStrategy(strategy: DiskStrategy) | strategy:DiskStrategy | 配置磁盘缓存策略 NONE SOURCE RESULT ALL AUTOMATIC |
+| placeholder(src: PixelMap\|Resource, func?: AsyncSuccess) | src: PixelMap\|Resource, func?: AsyncSuccess | 占位图，占位图回调数据ImageKnifeData |
+| errorholder(src: PixelMap\|Resource, func?: AsyncSuccess) | src: PixelMap\|Resource, func?: AsyncSuccess | 错误占位图，错误占位图回调数据ImageKnifeData |
+| retryholder(src: PixelMap\|Resource, func?: AsyncSuccess) | src: PixelMap\|Resource, func?: AsyncSuccess | 重试占位图，重试占位图回调数据ImageKnifeData |
+| addListener(func: AsyncCallback) | func: AsyncCallback | 配置整个监听回调，数据正常加载返回，加载失败返回错误信息 |
+| thumbnail(sizeMultiplier:number, func?: AsyncSuccess) | sizeMultiplier:number, func?: AsyncSuccess | 设置缩略图比例，缩略图返回后，加载并展示缩略图 |
+| addProgressListener(func?: AsyncSuccess) | func?: AsyncSuccess | 设置网络下载百分比监听，返回数据加载百分比数值 |
+| addAllCacheInfoCallback(func: IAllCacheInfoCallback) | func: IAllCacheInfoCallback | 设置获取所有缓存信息监听 |
+| skipMemoryCache(skip: boolean) | skip: boolean | 配置是否跳过内存缓存 |
+| retrieveDataFromCache(flag: boolean) | flag: boolean | 配置仅从缓存中加载数据 |
+| signature | ObjectKey | 自定义key |
同时支持[图片变换相关](#图片变换相关)接口。