QrConfig (polaris-toolkit 3.2.53 API)

java.lang.Object
- io.polaris.image.qrcode.QrConfig

```
public class QrConfig
extends Object
```
从以下版本开始:

1.8

作者:

Qt

字段概要

字段
限定符和类型	字段和说明
`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 com.google.zxing.datamatrix.encoder.SymbolShapeHint`	`shapeHint` DATA_MATRIX的符号形状
`protected int`	`width` 宽度（单位：像素或▄）当二维码类型为一般图片或者SVG时，单位是像素当二维码类型Ascii Art字符画时，单位是字符▄或▀的大小

构造器概要

构造器
构造器和说明

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

QrConfig(int width, int height)
构造

构造器
构造器和说明
`QrConfig()` 构造，默认长宽为300
`QrConfig(int width, int height)` 构造

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`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
`int`	`getWidth()` 获取宽度
`QrConfig`	`setBackColor(Color backColor)` 设置背景色，例如：Color.BLUE
`QrConfig`	`setBackColor(int backColor)` 设置背景色，例如：Color.BLUE.getRGB()
`QrConfig`	`setCharset(Charset charset)` 设置编码
`QrConfig`	`setErrorCorrection(com.google.zxing.qrcode.decoder.ErrorCorrectionLevel errorCorrection)` 设置纠错级别
`QrConfig`	`setForeColor(Color foreColor)` 设置前景色，例如：Color.BLUE.getRGB()
`QrConfig`	`setForeColor(int foreColor)` 设置前景色，例如：Color.BLUE.getRGB()
`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`	`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的二维码配置

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - 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
  - ratio
```
protected int ratio
```
    二维码中的Logo缩放的比例系数，如5表示长宽最小值的1/5
  - shapeHint
```
protected com.google.zxing.datamatrix.encoder.SymbolShapeHint shapeHint
```
    DATA_MATRIX的符号形状
- 构造器详细资料
  - QrConfig
```
public QrConfig()
```
    构造，默认长宽为300
  - QrConfig
```
public QrConfig(int width,
                int height)
```
    构造
    
    参数:
    
    width - 宽
    
    height - 长
- 方法详细资料
  - create
```
public static QrConfig create()
```
    创建QrConfig
    
    返回:
    
    QrConfig
    
    从以下版本开始:
    
    4.1.14
  - getWidth
```
public int getWidth()
```
    获取宽度
    
    返回:
    
    宽度
  - setWidth
```
public QrConfig setWidth(int width)
```
    设置宽度
    
    参数:
    
    width - 宽度
    
    返回:
    
    this
  - getHeight
```
public int getHeight()
```
    获取高度
    
    返回:
    
    高度
  - setHeight
```
public QrConfig setHeight(int height)
```
    设置高度
    
    参数:
    
    height - 高度
    
    返回:
    
    this;
  - getForeColor
```
public int getForeColor()
```
    获取前景色
    
    返回:
    
    前景色
  - setForeColor
```
public QrConfig setForeColor(int foreColor)
```
    设置前景色，例如：Color.BLUE.getRGB()
    
    参数:
    
    foreColor - 前景色
    
    返回:
    
    this
  - setForeColor
```
public QrConfig setForeColor(Color foreColor)
```
    设置前景色，例如：Color.BLUE.getRGB()
    
    参数:
    
    foreColor - 前景色
    
    返回:
    
    this
    
    从以下版本开始:
    
    5.1.1
  - getBackColor
```
public int getBackColor()
```
    获取背景色
    
    返回:
    
    背景色
  - setBackColor
```
public QrConfig setBackColor(int backColor)
```
    设置背景色，例如：Color.BLUE.getRGB()
    
    参数:
    
    backColor - 背景色
    
    返回:
    
    this
  - setBackColor
```
public QrConfig setBackColor(Color backColor)
```
    设置背景色，例如：Color.BLUE
    
    参数:
    
    backColor - 背景色,null表示透明背景
    
    返回:
    
    this
    
    从以下版本开始:
    
    5.1.1
  - getMargin
```
public Integer getMargin()
```
    获取边距
    
    返回:
    
    边距
  - setMargin
```
public QrConfig setMargin(Integer margin)
```
    设置边距
    
    参数:
    
    margin - 边距
    
    返回:
    
    this
  - getQrVersion
```
public Integer getQrVersion()
```
    设置二维码中的信息量，可设置0-40的整数，二维码图片也会根据qrVersion而变化，0表示根据传入信息自动变化
    
    返回:
    
    二维码中的信息量
  - setQrVersion
```
public QrConfig setQrVersion(Integer qrVersion)
```
    设置二维码中的信息量，可设置0-40的整数，二维码图片也会根据qrVersion而变化，0表示根据传入信息自动变化
    
    参数:
    
    qrVersion - 二维码中的信息量
    
    返回:
    
    this
  - getErrorCorrection
```
public com.google.zxing.qrcode.decoder.ErrorCorrectionLevel getErrorCorrection()
```
    获取纠错级别
    
    返回:
    
    纠错级别
  - setErrorCorrection
```
public QrConfig setErrorCorrection(com.google.zxing.qrcode.decoder.ErrorCorrectionLevel errorCorrection)
```
    设置纠错级别
    
    参数:
    
    errorCorrection - 纠错级别
    
    返回:
    
    this
  - getCharset
```
public Charset getCharset()
```
    获取编码
    
    返回:
    
    编码
  - setCharset
```
public QrConfig setCharset(Charset charset)
```
    设置编码
    
    参数:
    
    charset - 编码
    
    返回:
    
    this
  - getImg
```
public Image getImg()
```
    获取二维码中的Logo
    
    返回:
    
    Logo图片
  - setImg
```
public QrConfig setImg(String imgPath)
                throws IOException
```
    设置二维码中的Logo文件
    
    参数:
    
    imgPath - 二维码中的Logo路径
    
    返回:
    
    this;
    
    抛出:
    
    IOException
  - setImg
```
public QrConfig setImg(File imgFile)
                throws IOException
```
    设置二维码中的Logo文件
    
    参数:
    
    imgFile - 二维码中的Logo
    
    返回:
    
    this;
    
    抛出:
    
    IOException
  - setImg
```
public QrConfig setImg(Image img)
```
    设置二维码中的Logo
    
    参数:
    
    img - 二维码中的Logo
    
    返回:
    
    this;
  - getRatio
```
public int getRatio()
```
    获取二维码中的Logo缩放的比例系数，如5表示长宽最小值的1/5
    
    返回:
    
    二维码中的Logo缩放的比例系数，如5表示长宽最小值的1/5
  - setRatio
```
public QrConfig setRatio(int ratio)
```
    设置二维码中的Logo缩放的比例系数，如5表示长宽最小值的1/5
    
    参数:
    
    ratio - 二维码中的Logo缩放的比例系数，如5表示长宽最小值的1/5
    
    返回:
    
    this;
  - setShapeHint
```
public QrConfig setShapeHint(com.google.zxing.datamatrix.encoder.SymbolShapeHint shapeHint)
```
    设置DATA_MATRIX的符号形状
    
    参数:
    
    shapeHint - DATA_MATRIX的符号形状
    
    返回:
    
    this;
  - toHints
```
public HashMap<com.google.zxing.EncodeHintType,Object> toHints()
```
    转换为Zxing的二维码配置
    
    返回:
    
    配置
  - toHints
```
public HashMap<com.google.zxing.EncodeHintType,Object> toHints(com.google.zxing.BarcodeFormat format)
```
    转换为Zxing的二维码配置
    
    参数:
    
    format - 格式，根据格式不同，errorCorrection的值类型有所不同
    
    返回:
    
    配置

类 QrConfig

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

width

height

foreColor

backColor

margin

qrVersion

errorCorrection

charset

img

ratio

shapeHint

构造器详细资料

QrConfig

QrConfig

方法详细资料

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

setShapeHint

toHints

toHints