1.README.md修改 RequestOption删除接口。
2.CHANGLOG.md 新增RequestOption删除addRetryListener接口原因及说明 Signed-off-by: zhoulisheng <635547767@qq.com>
This commit is contained in:
zhoulisheng
parent
4a41793915
commit
20eaa1e98b
|
|
@ -170,6 +170,8 @@
|
|||
|
||||
- 新增SVG图片解析能力。
|
||||
|
||||
- RequestOption删除addRetryListener接口,重试图层监听请使用retryholder接口。
|
||||
|
||||
## 1.0.3
|
||||
|
||||
- 适配OpenHarmony API9 Stage模型。
|
||||
|
|
|
|||
81
README.md
81
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 | {<br/> // 返回一周期动画gif消耗的时间<br/> loopFinish?: (loopTime?) => void<br/> // gif播放速率相关<br/> speedFactory?: number<br/> // 直接展示gif第几帧数据<br/> seekTo?: number<br/> } | GIF播放控制能力（可选） |
|
||||
| transformation | BaseTransform<PixelMap> | 单个变换（可选） |
|
||||
| transformations | Array<BaseTransform<PixelMap>> | 多个变换,目前仅支持单个变换（可选） |
|
||||
| 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 | {<br/> // 返回一周期动画gif消耗的时间<br/> loopFinish?: (loopTime?) => void<br/> // gif播放速率相关<br/> speedFactory?: number<br/> // 直接展示gif第几帧数据<br/> seekTo?: number<br/> } | GIF播放控制能力（可选） |
|
||||
| transformation | BaseTransform<PixelMap> | 单个变换（可选） |
|
||||
| transformations | Array<BaseTransform<PixelMap>> | 多个变换,目前仅支持单个变换（可选） |
|
||||
| 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<PixelMap>) | src: PixelMap \ | Resource, func?: AsyncSuccess<PixelMap> | 配置占位图，其中func为数据回调函数 |
|
||||
| errorholder(src: PixelMap \ | Resource, func?: AsyncSuccess<PixelMap>) | src: PixelMap \ | Resource, func?: AsyncSuccess<PixelMap> | 配置加载失败占位图，其中func为数据回调函数 |
|
||||
| retryholder(src: PixelMap \ | Resource, func?: AsyncSuccess<PixelMap>) | src: PixelMap \ | Resource, func?: AsyncSuccess<PixelMap> | 配置重试占位图，如果配置则加载失败后优先展示重试占位图 |
|
||||
| addListener(func: AsyncCallback<PixelMap>) | func: AsyncCallback<PixelMap> | 配置整个监听回调，数据正常加载返回，加载失败返回错误信息 |
|
||||
| thumbnail(sizeMultiplier:number, func?: AsyncSuccess<ImageKnifeData>) | sizeMultiplier:number, func?: AsyncSuccess<ImageKnifeData> | 设置缩略图比例，缩略图返回后，加载并展示缩略图 |
|
||||
| addProgressListener(func?: AsyncSuccess<string>) | func?: AsyncSuccess<string> | 设置网络下载百分比监听，返回数据加载百分比数值 |
|
||||
| addRetryListener(func?: AsyncSuccess<any>) | func?: AsyncSuccess<any> | 设置重试监听 |
|
||||
| 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<ImageKnifeData>) | src: PixelMap\|Resource, func?: AsyncSuccess<ImageKnifeData> | 占位图，占位图回调数据ImageKnifeData |
|
||||
| errorholder(src: PixelMap\|Resource, func?: AsyncSuccess<ImageKnifeData>) | src: PixelMap\|Resource, func?: AsyncSuccess<ImageKnifeData> | 错误占位图，错误占位图回调数据ImageKnifeData |
|
||||
| retryholder(src: PixelMap\|Resource, func?: AsyncSuccess<ImageKnifeData>) | src: PixelMap\|Resource, func?: AsyncSuccess<ImageKnifeData> | 重试占位图，重试占位图回调数据ImageKnifeData |
|
||||
| addListener(func: AsyncCallback<ImageKnifeData>) | func: AsyncCallback<ImageKnifeData> | 配置整个监听回调，数据正常加载返回，加载失败返回错误信息 |
|
||||
| thumbnail(sizeMultiplier:number, func?: AsyncSuccess<ImageKnifeData>) | sizeMultiplier:number, func?: AsyncSuccess<ImageKnifeData> | 设置缩略图比例，缩略图返回后，加载并展示缩略图 |
|
||||
| addProgressListener(func?: AsyncSuccess<number>) | func?: AsyncSuccess<number> | 设置网络下载百分比监听，返回数据加载百分比数值 |
|
||||
| addAllCacheInfoCallback(func: IAllCacheInfoCallback) | func: IAllCacheInfoCallback | 设置获取所有缓存信息监听 |
|
||||
| skipMemoryCache(skip: boolean) | skip: boolean | 配置是否跳过内存缓存 |
|
||||
| retrieveDataFromCache(flag: boolean) | flag: boolean | 配置仅从缓存中加载数据 |
|
||||
| signature | ObjectKey | 自定义key |
|
||||
|
||||
同时支持[图片变换相关](#图片变换相关)接口。
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue