font-carrier-ts

# API ## 生成一个字体使用`fontCarrier.create(options)`生成一个空白字体对像 * options是字体对象的构造参数，具体见下面的font对象部分使用`fontCarrier.transfer(path,options)`解析一个已有字体，支持svg,ttf的字体。 * path支持文件地址，也支持文件buffer。 * options是字体对象的构造参数，具体见下面的font对象部分 eg. ``` js //创建空白字体 var font = fontCarrier.create() //从其他字体解析 var transFont = fontCarrier.transfer('./test/test.ttf') //same as //var buffer = fs.readFileSync('./test/test.ttf') //var transFont = fontCarrier.transfer(buffer) ``` ## 导出字体一旦你拿到一个字体对象后，你可以选择导出它，默认会生成svg,ttf,woff,eot四种格式。 `font.output(options)` * options.path 可选。导出的文件路径，不需要后缀 * options.types 可选。导出的字体类型默认是 ['ttf','eot','woff','svg'] 返回一个对象，包含导出的所有字体的buffer eg. ``` js font.output({ path:'./iconfont', types:[ttf] }) ``` ## 相关对象 font-carrier里面有三种对象font,fontface,glyph。每个对象都有自己的构造参数包含一些初始化信息。所有的初始化参数后面都可以使用get(key),set(key,value)来进行简单的操作。 ### font对象一个font对象就表示解析后的字体对象，包含字体所有的信息构造参数包括： * id: 字体的postscript name,默认是1024 * horizAdvX: 字体的水平画布大小,默认是1024 * vertAdvY: 字体的垂直画布大小，默认是1024 #### `font.getFontface()` 获取对应的fontface对象返回一个fontface对象 #### `font.setFontface(options)` 设置对应的fontface对象 * options 可以是一个fontface对象也可以是fontface对象的构造参数 #### `font.getSvg(keys)` 获取指定文字（keys）的svg。 * keys 可以是单个的字，也可以是多个字组成的字符串，也可以是数组。如果是单个字就返回一个svg字符串，否则返回一个hash对象，key是unicode,value是对应的svg #### `font.setSvg()` 用于针对字设置对应的svg图形有两种使用方式： 1. font.setSvg(key,value) 用于设置单个 * key是对应的字，也可以是unicode. * value是对应的svg图形 2. font.setSvg({key,value}) 可用于设置多个 key,value同上，主要可以使用object的方式一次性设置多个 #### `font.getGlyph(keys)` 获取指定文字（keys）的glyph对象。 * keys 可以是单个的字，也可以是多个字组成的字符串，也可以是数组。如果是单个字就返回一个glyph对象，否则返回一个hash对象，key是unicode,value是对应的glyph对象 #### `font.setGlyph()` 用于针对字设置对应的glyph对象有两种使用方式： 1. font.setGlyph(key,value) 用于设置单个 * key是对应的字，也可以是unicode. * value是对应的glyph对象，或者是一个glyph的构造参数对象 2. font.setGlyph({key,value}) 可用于设置多个 key,value同上，主要可以使用object的方式一次性设置多个 #### `font.allGlyph()` 用于返回所有的字体对象集合返回的是一个对象，key是unicode，value是对应的glyph对象 #### `font.toString()` 将当前字体解析成对应svg字体的字符串并返回 #### `font.clean()` 将当前字体的所有字形清空 #### `font.min(input)` 精简当前字体 * input input是一个字符串，支持unicode，会去掉font里面除input用到的字形之外所有的字形返回精简后的字体对象 #### `font.output(options)` 导出字体 * options.path 可选。导出的文件路径，不需要后缀 * options.types 可选。导出的字体类型默认是 ['ttf','eot','woff','svg'] 返回一个对象，包含导出的所有字体的buffer ### fontface对象 fontface对象包含了字体的一些特殊相关信息，参数如下： * fontFamily: 字体的fontfamily * unitsPerEm: 字体的unitsPerEm默认是1024 * ascent: 字体的上偏移量，默认是812 * descent: 字体的下偏移量，默认是-212 ### glyph字形对象 glyph字形对象代表了具体某个字的信息。包括下面这些参数： * unicode: 字体对应的unicode,比如我对应的unicode是我实际使用时直接使用我就行，内部会帮忙转换。 * glyphName: 字体对应的名称,默认是unicode（些许变化） * d: 字体对应的序列，这个是具体的字体形状，不是是做了变化之后的，不建议直接使用这个d，建议使用svg参数替代，内部会帮忙把svg转换成对应的d参数 * horizAdvX: 字体的水平画布大小，默认1024 * vertAdvY: 字体的垂直画布大小，默认1024 > 这边注意的是d这个参数是转化后的path序列，不建议在新建glyph对象的时候使用。建议使用svg替代d,内部会自动帮忙转换成对应的d参数。 #### `glyph.getFont()` 获取当前字形对应的字体对象返回对应的字体对象 #### `glyph.setFont(font)` 设置当前glyph的字体，会按照新的字体做一系列的变换 #### `glyph.toSvg(path,options)` 导出当前字形对象的svg * path 导出的路径，可选 * options.width 导出的svg的宽度 * options.height 导出的svg的高度返回对应的svg字符串