QrConfig (hutool 5.8.33 API)

java.lang.Object
- cn.hutool.extra.qrcode.QrConfig

```
public class QrConfig
extends Object
```
二维码设置

Since:

4.1.2

Author:

looly

Field Summary

Fields
Modifier and Type	Field and Description
`protected Integer`	`backColor` 背景色，默认白色，null表示透明
`protected Charset`	`charset` 编码
`protected com.google.zxing.qrcode.decoder.ErrorCorrectionLevel`	`errorCorrection` 纠错级别
`protected Integer`	`foreColor` 前景色（二维码颜色）
`protected int`	`height` 高度（单位：像素或▄）当二维码类型为一般图片或者SVG时，单位是像素当二维码类型Ascii Art字符画时，单位是字符▄或▀的大小
`protected Image`	`img` 二维码中的Logo
`protected Integer`	`margin` 边距1~4
`protected Integer`	`qrVersion` 设置二维码中的信息量，可设置0-40的整数
`protected int`	`ratio` 二维码中的Logo缩放的比例系数，如5表示长宽最小值的1/5
`protected double`	`round` 二维码中的Logo圆角弧度
`protected com.google.zxing.datamatrix.encoder.SymbolShapeHint`	`shapeHint` DATA_MATRIX的符号形状
`protected int`	`width` 宽度（单位：像素或▄）当二维码类型为一般图片或者SVG时，单位是像素当二维码类型Ascii Art字符画时，单位是字符▄或▀的大小

Constructor Summary

Constructors
Constructor and Description

QrConfig()
构造，默认长宽为300

QrConfig(int width, int height)
构造

Constructors
Constructor and Description
`QrConfig()` 构造，默认长宽为300
`QrConfig(int width, int height)` 构造

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static QrConfig`	`create()` 创建QrConfig
`int`	`getBackColor()` 获取背景色
`Charset`	`getCharset()` 获取编码
`com.google.zxing.qrcode.decoder.ErrorCorrectionLevel`	`getErrorCorrection()` 获取纠错级别
`int`	`getForeColor()` 获取前景色
`int`	`getHeight()` 获取高度
`Image`	`getImg()` 获取二维码中的Logo
`Integer`	`getMargin()` 获取边距
`Integer`	`getQrVersion()` 设置二维码中的信息量，可设置0-40的整数，二维码图片也会根据qrVersion而变化，0表示根据传入信息自动变化
`int`	`getRatio()` 获取二维码中的Logo缩放的比例系数，如5表示长宽最小值的1/5
`double`	`getRound()` 获取二维码中的Logo圆角弧度
`int`	`getWidth()` 获取宽度
`QrConfig`	`setBackColor(Color backColor)` 设置背景色，例如：Color.BLUE
`QrConfig`	`setBackColor(int backColor)` Deprecated. 请使用 `setBackColor(Color)`
`QrConfig`	`setCharset(Charset charset)` 设置编码
`QrConfig`	`setErrorCorrection(com.google.zxing.qrcode.decoder.ErrorCorrectionLevel errorCorrection)` 设置纠错级别
`QrConfig`	`setForeColor(Color foreColor)` 设置前景色，例如：Color.BLUE.getRGB()
`QrConfig`	`setForeColor(int foreColor)` Deprecated. 请使用 `setForeColor(Color)`
`QrConfig`	`setHeight(int height)` 设置高度
`QrConfig`	`setImg(File imgFile)` 设置二维码中的Logo文件
`QrConfig`	`setImg(Image img)` 设置二维码中的Logo
`QrConfig`	`setImg(String imgPath)` 设置二维码中的Logo文件
`QrConfig`	`setMargin(Integer margin)` 设置边距
`QrConfig`	`setQrVersion(Integer qrVersion)` 设置二维码中的信息量，可设置0-40的整数，二维码图片也会根据qrVersion而变化，0表示根据传入信息自动变化
`QrConfig`	`setRatio(int ratio)` 设置二维码中的Logo缩放的比例系数，如5表示长宽最小值的1/5
`QrConfig`	`setRound(double round)` 设置二维码中的Logo圆角弧度
`QrConfig`	`setShapeHint(com.google.zxing.datamatrix.encoder.SymbolShapeHint shapeHint)` 设置DATA_MATRIX的符号形状
`QrConfig`	`setWidth(int width)` 设置宽度
`HashMap<com.google.zxing.EncodeHintType,Object>`	`toHints()` 转换为Zxing的二维码配置
`HashMap<com.google.zxing.EncodeHintType,Object>`	`toHints(com.google.zxing.BarcodeFormat format)` 转换为Zxing的二维码配置

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - width
```
protected int width
```
    宽度（单位：像素或▄）
    当二维码类型为一般图片或者SVG时，单位是像素
    
    当二维码类型Ascii Art字符画时，单位是字符▄或▀的大小
  - height
```
protected int height
```
    高度（单位：像素或▄）
    当二维码类型为一般图片或者SVG时，单位是像素
    
    当二维码类型Ascii Art字符画时，单位是字符▄或▀的大小
  - foreColor
```
protected Integer foreColor
```
    前景色（二维码颜色）
  - backColor
```
protected Integer backColor
```
    背景色，默认白色，null表示透明
  - margin
```
protected Integer margin
```
    边距1~4
  - qrVersion
```
protected Integer qrVersion
```
    设置二维码中的信息量，可设置0-40的整数
  - errorCorrection
```
protected com.google.zxing.qrcode.decoder.ErrorCorrectionLevel errorCorrection
```
    纠错级别
  - charset
```
protected Charset charset
```
    编码
  - img
```
protected Image img
```
    二维码中的Logo
  - round
```
protected double round
```
    二维码中的Logo圆角弧度
  - ratio
```
protected int ratio
```
    二维码中的Logo缩放的比例系数，如5表示长宽最小值的1/5
  - shapeHint
```
protected com.google.zxing.datamatrix.encoder.SymbolShapeHint shapeHint
```
    DATA_MATRIX的符号形状
- Constructor Detail
  - QrConfig
```
public QrConfig()
```
    构造，默认长宽为300
  - QrConfig
```
public QrConfig(int width,
                int height)
```
    构造
    
    Parameters:
    
    width - 宽
    
    height - 长
- Method Detail
  - create
```
public static QrConfig create()
```
    创建QrConfig
    
    Returns:
    
    QrConfig
    
    Since:
    
    4.1.14
  - getWidth
```
public int getWidth()
```
    获取宽度
    
    Returns:
    
    宽度
  - setWidth
```
public QrConfig setWidth(int width)
```
    设置宽度
    
    Parameters:
    
    width - 宽度
    
    Returns:
    
    this
  - getHeight
```
public int getHeight()
```
    获取高度
    
    Returns:
    
    高度
  - setHeight
```
public QrConfig setHeight(int height)
```
    设置高度
    
    Parameters:
    
    height - 高度
    
    Returns:
    
    this;
  - getForeColor
```
public int getForeColor()
```
    获取前景色
    
    Returns:
    
    前景色
  - setForeColor
```
@Deprecated
public QrConfig setForeColor(int foreColor)
```
    Deprecated. 请使用 setForeColor(Color)
    
    设置前景色，例如：Color.BLUE.getRGB()
    
    Parameters:
    
    foreColor - 前景色
    
    Returns:
    
    this
  - setForeColor
```
public QrConfig setForeColor(Color foreColor)
```
    设置前景色，例如：Color.BLUE.getRGB()
    
    Parameters:
    
    foreColor - 前景色
    
    Returns:
    
    this
    
    Since:
    
    5.1.1
  - getBackColor
```
public int getBackColor()
```
    获取背景色
    
    Returns:
    
    背景色
  - setBackColor
```
@Deprecated
public QrConfig setBackColor(int backColor)
```
    Deprecated. 请使用 setBackColor(Color)
    
    设置背景色，例如：Color.BLUE.getRGB()
    
    Parameters:
    
    backColor - 背景色
    
    Returns:
    
    this
  - setBackColor
```
public QrConfig setBackColor(Color backColor)
```
    设置背景色，例如：Color.BLUE
    
    Parameters:
    
    backColor - 背景色,null表示透明背景
    
    Returns:
    
    this
    
    Since:
    
    5.1.1
  - getMargin
```
public Integer getMargin()
```
    获取边距
    
    Returns:
    
    边距
  - setMargin
```
public QrConfig setMargin(Integer margin)
```
    设置边距
    
    Parameters:
    
    margin - 边距
    
    Returns:
    
    this
  - getQrVersion
```
public Integer getQrVersion()
```
    设置二维码中的信息量，可设置0-40的整数，二维码图片也会根据qrVersion而变化，0表示根据传入信息自动变化
    
    Returns:
    
    二维码中的信息量
  - setQrVersion
```
public QrConfig setQrVersion(Integer qrVersion)
```
    设置二维码中的信息量，可设置0-40的整数，二维码图片也会根据qrVersion而变化，0表示根据传入信息自动变化
    
    Parameters:
    
    qrVersion - 二维码中的信息量
    
    Returns:
    
    this
  - getErrorCorrection
```
public com.google.zxing.qrcode.decoder.ErrorCorrectionLevel getErrorCorrection()
```
    获取纠错级别
    
    Returns:
    
    纠错级别
  - setErrorCorrection
```
public QrConfig setErrorCorrection(com.google.zxing.qrcode.decoder.ErrorCorrectionLevel errorCorrection)
```
    设置纠错级别
    
    Parameters:
    
    errorCorrection - 纠错级别
    
    Returns:
    
    this
  - getCharset
```
public Charset getCharset()
```
    获取编码
    
    Returns:
    
    编码
  - setCharset
```
public QrConfig setCharset(Charset charset)
```
    设置编码
    
    Parameters:
    
    charset - 编码
    
    Returns:
    
    this
  - getImg
```
public Image getImg()
```
    获取二维码中的Logo
    
    Returns:
    
    Logo图片
  - setImg
```
public QrConfig setImg(String imgPath)
```
    设置二维码中的Logo文件
    
    Parameters:
    
    imgPath - 二维码中的Logo路径
    
    Returns:
    
    this;
  - setImg
```
public QrConfig setImg(File imgFile)
```
    设置二维码中的Logo文件
    
    Parameters:
    
    imgFile - 二维码中的Logo
    
    Returns:
    
    this;
  - setImg
```
public QrConfig setImg(Image img)
```
    设置二维码中的Logo
    
    Parameters:
    
    img - 二维码中的Logo
    
    Returns:
    
    this;
  - getRatio
```
public int getRatio()
```
    获取二维码中的Logo缩放的比例系数，如5表示长宽最小值的1/5
    
    Returns:
    
    二维码中的Logo缩放的比例系数，如5表示长宽最小值的1/5
  - setRatio
```
public QrConfig setRatio(int ratio)
```
    设置二维码中的Logo缩放的比例系数，如5表示长宽最小值的1/5
    
    Parameters:
    
    ratio - 二维码中的Logo缩放的比例系数，如5表示长宽最小值的1/5
    
    Returns:
    
    this;
  - getRound
```
public double getRound()
```
    获取二维码中的Logo圆角弧度
    
    Returns:
    
    二维码中的Logo圆角弧度
  - setRound
```
public QrConfig setRound(double round)
```
    设置二维码中的Logo圆角弧度
    
    Parameters:
    
    round - 二维码中的Logo圆角弧度
    
    Returns:
    
    this;
  - setShapeHint
```
public QrConfig setShapeHint(com.google.zxing.datamatrix.encoder.SymbolShapeHint shapeHint)
```
    设置DATA_MATRIX的符号形状
    
    Parameters:
    
    shapeHint - DATA_MATRIX的符号形状
    
    Returns:
    
    this;
  - toHints
```
public HashMap<com.google.zxing.EncodeHintType,Object> toHints()
```
    转换为Zxing的二维码配置
    
    Returns:
    
    配置
  - toHints
```
public HashMap<com.google.zxing.EncodeHintType,Object> toHints(com.google.zxing.BarcodeFormat format)
```
    转换为Zxing的二维码配置
    
    Parameters:
    
    format - 格式，根据格式不同，errorCorrection的值类型有所不同
    
    Returns:
    
    配置

Class QrConfig

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

width

height

foreColor

backColor

margin

qrVersion

errorCorrection

charset

img

round

ratio

shapeHint

Constructor Detail

QrConfig

QrConfig

Method Detail

create

getWidth

setWidth

getHeight

setHeight

getForeColor

setForeColor

setForeColor

getBackColor

setBackColor

setBackColor

getMargin

setMargin

getQrVersion

setQrVersion

getErrorCorrection

setErrorCorrection

getCharset

setCharset

getImg

setImg

setImg

setImg

getRatio

setRatio

getRound

setRound

setShapeHint

toHints

toHints