# ImageViewZoom

**Repository Path**: zhangjun93/ImageViewZoom

## Basic Information

- **Project Name**: ImageViewZoom
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 35
- **Created**: 2022-04-28
- **Last Updated**: 2022-07-05

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# ImageViewZoom

## 简介
> ImageViewZoom支持加载Resource或PixelMap图片，支持设置图像显示类型，支持缩放功能，支持平移功能。

## 效果展示
![avatar](screenshot/效果展示.gif)

## 下载安装
```shell
npm install @ohos/imageviewzoom --save
```
OpenHarmony npm环境配置等更多内容，请参考 [如何安装OpenHarmony npm包](https://gitee.com/openharmony-tpc/docs/blob/master/OpenHarmony_npm_usage.md) 。

## 使用说明

##### ets代码依赖

```
import {ImageViewTouch, DisplayType} from "@ohos/imageviewzoom"
import {PixelMapUtils} from "./PixelMapUtils"
...
//创建model对象
@State private model: ImageViewTouch.Model = new ImageViewTouch.Model();
...
//使用ImageViewTouch组件
ImageViewTouch({ model: this.model });
...
```

## 接口说明
1. 设置图片资源
   `public setImageSrc(src ?: Resource | PixelMap, matrix ?: object, minZoom ?: number, maxZoom ?: number): void`
   
2. 设置默认图像显示类型
   
   `public setDisplayType(type: DisplayType)`
   
   DisplayType.NONE：图像默认不缩放。
   DisplayType.FIT_TO_SCREEN：图像将始终使用此视图的边界呈现。
   DisplayType.FIT_IF_BIGGER：仅当大于此视图的边界时才会缩放图像。
   DisplayType.FIT_HEIGHT：图像将被缩放以适合设备的高度。
   DisplayType.FIT_WIDTH：图像将被缩放以适合设备的宽度。
   
3. 清除当前显示的图片
   `public dispose(): void`

4. 设置是否能够双击
   `public setDoubleTapEnabled(value: boolean): void`

5. 设置是否能够缩放
   `public setScaleEnabled(value: boolean): void`

6. 设置是否能够滚动
   `public setScrollEnabled(value: boolean): void`

7. 设置图片资源变化监听事件
   `public setOnDrawableChangedListener(listener: OnDrawableChangeListener): void`

8. 设置图片大小变化监听事件
   `public setOnLayoutChangeListener(listener: OnLayoutChangeListener): void`

## 兼容性
支持 OpenHarmony API version 8 及以上版本。

## 目录结构
````
|---- ImageViewZoom  
|     |---- entry  # 示例代码文件夹
|     |---- ImageViewZoom  # ImageViewZoom库文件夹
|           |---- common
|                 |---- utils  # 工具库
|                       |---- IDisposable.ets  # 提供清除图片接口
|                 |---- ImageViewTouch.ets  # 自定义控件
|           |---- index.ets  # 对外接口
|     |---- README.MD  # 安装使用方法                    
````

## 贡献代码
使用过程中发现任何问题都可以提 [Issue](https://gitee.com/openharmony-sig/ImageViewZoom/issues) 给我们，当然，我们也非常欢迎你给我们发 [PR](https://gitee.com/openharmony-sig/ImageViewZoom/pulls) 。

## 开源协议
本项目基于 [Apache License 2.0](https://gitee.com/openharmony-sig/ImageViewZoom/blob/master/LICENSE) ，请自由地享受和参与开源。