SamsaFont

Class representing a variable font.

Constructor

`SamsaFont( init : Object , config : Object )`

Parameters:

init : Object

 init: {
   url: String,
   fontFamily: String,
   callback: Function,

   arrayBuffer: ArrayBuffer,
   inFile: String, 
   outFile: String,
   filesize: String,
   date: String
 }

config : Object - (optional)

Any properties defined in the config parameter override properties defined in the global CONFIG object.

 defaultConfig = {
   isNode: false,
   outFileDefault: "samsa-out.ttf",
   instantiation: {
     method: "default",
     skipTables: ["gvar","fvar","cvar","avar","STAT","MVAR","HVAR","VVAR","DSIG"],
     ignoreIUP: false
   },
   defaultGlyph: ["A", "a", "Alpha", "alpha", "afii10017", "A-cy", "afii10065", "a-cy", "zero"],
   sfnt: {
     maxNumTables: 100,
     maxSize: 10000000
   },
   glyf: {
     overlapSimple: true,
     bufferSize: 500000,
     compression: true
   },
   name: {
     maxSize: 50000
   },
   deltas: {
     round: true
   },
   postscriptNames: [".notdef",".null","nonmarkingreturn","space","exclam","quotedbl","numbersign","dollar","percent","ampersand","quotesingle","parenleft","parenright","asterisk","plus","comma","hyphen","period","slash","zero","one","two","three","four","five","six","seven","eight","nine","colon","semicolon","less","equal","greater","question","at","A","B","C","D","E","F","G","H","I","J","K","L","M","N","O","P","Q","R","S","T","U","V","W","X","Y","Z","bracketleft","backslash","bracketright","asciicircum","underscore","grave","a","b","c","d","e","f","g","h","i","j","k","l","m","n","o","p","q","r","s","t","u","v","w","x","y","z","braceleft","bar","braceright","asciitilde","Adieresis","Aring","Ccedilla","Eacute","Ntilde","Odieresis","Udieresis","aacute","agrave","acircumflex","adieresis","atilde","aring","ccedilla","eacute","egrave","ecircumflex","edieresis","iacute","igrave","icircumflex","idieresis","ntilde","oacute","ograve","ocircumflex","odieresis","otilde","uacute","ugrave","ucircumflex","udieresis","dagger","degree","cent","sterling","section","bullet","paragraph","germandbls","registered","copyright","trademark","acute","dieresis","notequal","AE","Oslash","infinity","plusminus","lessequal","greaterequal","yen","mu","partialdiff","summation","product","pi","integral","ordfeminine","ordmasculine","Omega","ae","oslash","questiondown","exclamdown","logicalnot","radical","florin","approxequal","Delta","guillemotleft","guillemotright","ellipsis","nonbreakingspace","Agrave","Atilde","Otilde","OE","oe","endash","emdash","quotedblleft","quotedblright","quoteleft","quoteright","divide","lozenge","ydieresis","Ydieresis","fraction","currency","guilsinglleft","guilsinglright","fi","fl","daggerdbl","periodcentered","quotesinglbase","quotedblbase","perthousand","Acircumflex","Ecircumflex","Aacute","Edieresis","Egrave","Iacute","Icircumflex","Idieresis","Igrave","Oacute","Ocircumflex","apple","Ograve","Uacute","Ucircumflex","Ugrave","dotlessi","circumflex","tilde","macron","breve","dotaccent","ring","cedilla","hungarumlaut","ogonek","caron","Lslash","lslash","Scaron","scaron","Zcaron","zcaron","brokenbar","Eth","eth","Yacute","yacute","Thorn","thorn","minus","multiply","onesuperior","twosuperior","threesuperior","onehalf","onequarter","threequarters","franc","Gbreve","gbreve","Idotaccent","Scedilla","scedilla","Cacute","cacute","Ccaron","ccaron","dcroat"]
 }

Returns:

SamsaFont

Example:

let vf = new SamsaFont({
  fontFamily: "FontNameShouldGoHere",
  url: "fonts/Sans_Variable.ttf",
  callback: function(font) {}
});
let vf = new SamsaFont({
  arrayBuffer: e.target.result,
  inFile: file.name,
  filesize: file.size,  //Optional
  date: file.lastModified,  //Optional
  callback: function(font) {}
});

Properties

`.fontFamily`

Font Family name

Type: String

`.unitsPerEm`

It specifies the number of coordinate units on the “em square”, an abstract square whose height is the intended distance between lines of type in the same type size. This is the size of the design grid on which glyphs are laid out. Example value: 1000

Type: Number

`.numGlyphs`

Total number of glyphs

Type: Number

`.italicAngle`

Angle of the italic style

Type: Number

`.instances`

Array of instances in this SamsaFont object. Initially, these instances are the Default followed by all the Named Instances defined in the fvar table of the input VF, but instances can be added, modified and deleted so the instances array may no longer correspond with the input VF.

Type: Array of Object

Example:

[{
  id: 0,
  glyphs: [],
  tuple: [
    0,
    0,
    0
  ],
  fvs: {
    fmsk: 0,
    hdrs: 0,
    hscl: 0
  },
  static: null,
  name: 'Default',
  type: 'default'
}]

`.axes`

Array of the VF’s axes.

Type: Array of Object

Example:

[{
  id: 0,
  tag: 'fmsk',
  min: 0,
  default: 0,
  max: 100,
  flags: 0,
  axisNameID: 256,
  name: 'WearFaceMask'
}]

`.axisCount`

Total number of axes.

Type: Number

`.axisTagToId`

Map of axis tag to axis id.

Type: Object

Example:

axisTagToId: {
  wght: 0,
  wdth: 1,
  ital: 2
}

`.errors`

Type: Array of String

`.glyphs`

Return all of this font’ glyphs as Array of SamsaGlyph objects The array indices correspond exactly with glyph ids in the original font file.

Type: Array of SamsaGlyph objects.

`.widths`

Array of each glyph’s width

Type: Array of Number

Example:

`.glyphNames`

Array of each glyph’s name, such as “A”

Type: Array of String

Example:

[
  ".notdef",
  "NULL",
  "nonmarkingreturn",
  "space",
  "A",
  "B",
  "C",
  "D",
  "E",
  "F",
  "G",
]

`.glyphOffsets`

Type: Array of Number

`.glyphSizes`

Type: Array of Number

`.tupleOffsets`

Type: Array of Number

`.tupleSizes`

Type: Array of Number

`.avar`

Type: Array

`.url`

Font url

Type: String

`.path`

Font url or font file

Type: String

Example:

"https://res.cloudinary.com/dr6lvwubh/raw/upload/v1596755490/Variable%20Fonts/KairosSans_Variable.ttf",

`.arrayBuffer`

Type: ArrayBuffer

`.filename`

Font file name. Example value: KairosSans_Variable.ttf

Type: String

`.filesize`

Font file size. Example value: 68404

Type: Number

`.flavor`

Font file flavor. Example value: truetype

Type: String

`.numTables`

Total number of font data tables. Example value: 16

Type: Number

`.tableDirectory`

Array of font data tables.

Type: Array of Object

Example:

[{
  id: 0,
  tag: 'HVAR',
  checkSum: 1677429614,
  offset: 15684,
  length: 1393
}]

`.tables`

Font data tables as object

Type: Object

Example:

{
  ...
  fvar: {
    id: 5,
    tag: 'fvar',
    checkSum: 270942577,
    offset: 17528,
    length: 844,
    data: {
      majorVersion: 1,
      minorVersion: 0,
      offsetToAxesArray: 16,
      countSizePairs: 2,
      axisCount: 3,
      axisSize: 20,
      instanceCount: 48,
      instanceSize: 16
    }
  }
}

`.names`

Font information: designer names, axis names, instance names, version, legal information, etc.

Type: Array

`.config`

The config that got passed in from constructor or the default config if not passed in.

Type: Object

Methods

`.getNamedInstances ()`

Return all named instances from font.instances as an array of instances.

Returns:

Array of Object

Source:

samsa/src/samsa-core.js:2337

`.addInstance ( fvs , options )`

Add an new instance to font.instances, then return the added instance.

Parameters:

fvs : Object
options : Object

Returns:

Object

Source:

samsa/src/samsa-core.js:2349

`.makeInstance ( instance )`

Source:

samsa/src/samsa-core.js:2388

`.fvsToTuple ( fvs )`

Convert fvs to tuple.

Returns:

Array

Source:

samsa/src/samsa-core.js:2404

`.tupleToFvs ( tuple )`

Convert tuple to fvs.

Returns:

Object

Source:

samsa/src/samsa-core.js:2419

`.axisIndices ( tag )`

Returns an array containing the axis indices for this axis tag

Parameters:

tag : String

Returns:

Array

Source:

samsa/src/samsa-core.js:2462

`.axisNormalize ( axis , t , avarIgnore )`

Source:

samsa/src/samsa-core.js:2548

`.exportInstance ( instance )`

Creates a new static font file, based on the axis settings of instance. The font file is created either on disk (this.config.isNode == true) or in memory (this.config.isNode == false).

Returns:

If this.config.isNode == false, returns a Uint8Array, being the font binary in memory.

Source:

samsa/src/samsa-core.js:1713

`.parse ()`

Source:

samsa/src/samsa-core.js:697

`.parseGlyph ( glyph )`

Source:

samsa/src/samsa-core.js:1269

`.parseSmallTable ( tag )`

Source:

samsa/src/samsa-core.js:806

`.parseTvts ( glyph )`

Source:

samsa/src/samsa-core.js:1466

Source

samsa/src/samsa-core.js