目录

如何对指定区域进行截图

问题现象

页面中有一张图片需要进行截图保存,那么,如何实现对页面中的指定区域进行截图?

背景知识

解决方案

实现对指定区域进行截图有以下方法:

示例代码如下:

import { image } from '@kit.ImageKit';
import { screenshot } from '@kit.ArkUI';

@Entry
@Component
struct Index {
  @State img_1: image.PixelMap | undefined = undefined;
  @State img_2: image.PixelMap | undefined = undefined;

  build() {
    Row() {
      Row() {
        Column({ space: 10 }) {
          Text('方法一:使用组件截图')
            .fontSize(20)
            .fontWeight(FontWeight.Bold);

          Text('以下是截图显示区域')
            .fontSize(10);

          Image(this.img_1)
            .borderWidth(2)
            .width('20%')
            .height('20%')
            .backgroundColor(Color.Grey);

          Text('以下是原始图片区域')
            .fontSize(10);

          Image($r('app.media.startIcon'))
            .borderWidth(2)
            .width('30%')
            .height('30%')
            .objectFit(ImageFit.Cover)
            .id('imageForSolution');

          Button('generate UI snapshot for solution')
            .onClick(() => {
              this.getUIContext()
                .getComponentSnapshot()
                .get('imageForSolution', (error: Error, pixmap: image.PixelMap) => {
                  if (error) {
                    return;
                  }
                  this.img_1 = pixmap;
                });
            }).margin(10);
        };
      };

      Row() {
        Column({ space: 10 }) {
          Text('方法二:使用屏幕区域截图')
            .fontSize(20)
            .fontWeight(FontWeight.Bold);

          Text('以下是截图显示区域')
            .fontSize(10);

          Image(this.img_2)
            .borderWidth(2)
            .width('20%')
            .height('20%')
            .backgroundColor(Color.Grey);

          Text('以下是原始图片区域')
            .fontSize(10);

          Image($r('app.media.startIcon'))
            .borderWidth(2)
            .width('30%')
            .height('30%')
            .objectFit(ImageFit.Cover);

          Button('generate display snapshot for solution')
            .onClick(async () => {
              try {
                let promise = screenshot.pick();
                promise.then((pickInfo: screenshot.PickInfo) => {
                  console.info('pick Pixel bytes number: ' + pickInfo.pixelMap.getPixelBytesNumber());
                  console.info('pick Rect: ' + pickInfo.pickRect);
                  this.img_2 = pickInfo.pixelMap;

                }).catch((err: BusinessError) => {
                  console.error(`Failed to pick. Code: ' + Code: ${err.code}, message: ${err.message}`);
                });
              } catch (exception) {
                console.error(`Failed to pick Code: ' + Code: ${exception.code}, message: ${exception.message}`);
              }
              ;
            });
        };
      };

    }
    .justifyContent(FlexAlign.SpaceAround)
    .height('100%')
    .width('100%');
  }
}

常见FAQ

Q:如何查看组件截图支持的最大宽高限制?

A:可以用hdc shell hidumper -s 10 -a 'vktextureLimit'命令查看打印出来的宽高就是组件截图支持的最大宽高。

Q:如何实现截取图片中某些区域形成一个新图片?

A:对图片区域进行处理可参考实现图片裁剪的功能。

Q:如何将组件截图结果保存为图片文件?

A:通过componentSnapshot.get获取PixelMap后,可使用image.createImagePacker创建ImagePacker实例,调用packToData方法将PixelMap编码为JPG或PNG格式,再通过文件IO写入文件。示例代码如下:

import { image } from '@kit.ImageKit';
import { fileIo as fs } from '@kit.CoreFileKit';

@Entry
@Component
struct Index {
  async saveSnapshotToFile() {
    let pixelMap: image.PixelMap | undefined = undefined;
    let packingApi: image.ImagePacker | undefined = undefined;
    let file: fs.File | undefined = undefined;
    try {
      pixelMap = await this.getUIContext().getComponentSnapshot().get('targetArea');
      packingApi = image.createImagePacker();
      let packOpts: image.PackingOption = { format: 'image/jpeg', quality: 90 };
      let data = await packingApi.packToData(pixelMap, packOpts);
      let cacheDir = this.getUIContext().getHostContext()?.cacheDir;
      if (!cacheDir) {
        return;
      }
      let path = cacheDir + '/snapshot.jpg';
      file = fs.openSync(path, fs.OpenMode.CREATE | fs.OpenMode.TRUNC | fs.OpenMode.WRITE_ONLY);
      fs.writeSync(file.fd, data);
    } catch (err) {
      console.error(`Failed to save snapshot. Code: ${err.code}, message: ${err.message}`);
    } finally {
      if (file) {
        fs.closeSync(file.fd);
      }
      if (packingApi) {
        packingApi.release();
      }
      if (pixelMap) {
        pixelMap.release();
      }
    }
  }

  build() {
    Column() {
      Image($r('app.media.startIcon'))
        .width('30%')
        .height('30%')
        .id('targetArea');

      Button('保存截图为文件')
        .onClick(() => {
          this.saveSnapshotToFile();
        });
    }
    .width('100%')
    .height('100%');
  }
}