Global

Members

addonLoader

Source:

Methods

AddonInstaller(location, type)

Description:

  • AddonIstaller
    Handle addon installation

Source:
Parameters:
Name Type Description
location
type

FormIOConverter()

Description:

  • Converts FormIO schema into JSONForm format

Source:

LowLevelUpdate()

Description:

  • Copy 7zip to temp folder

Source:

appendCommentString(script) → {Array.<Object>}

Description:

  • Append comment string to the begining of the script

Source:
Parameters:
Name Type Description
script String
Returns:
  • Array of the appended comment object
Type
Array.<Object>

insertArrayAt(array, index, arrayToInsert) → {Array}

Description:

  • Insert an array into another array at some index

Source:
Parameters:
Name Type Description
array Array

Source array
index Number

Index to insert at
arrayToInsert Array

Array to insert
Returns:
  • Merged array
Type
Array

Type Definitions

CellRange

Description:

  • HOT's CellRange object

Source:
Properties:
Name Type Description
CellRange.from Object

The starting cell
CellRange.to Object

The latest selected cell
CellRange.highlight Object

The highlighted cell

HOT's CellRange object

Type:
  • Object
Example
{
  "highlight": {
    "row": 8,
    "col": 2
  },
  "from": {
    "row": 8,
    "col": 2
  },
  "to": {
    "row": 10,
    "col": 2
  }
}

SearchResult

Source:
Properties:
Name Type Description
keyword String

The keyword used
count Number

Total numbers of the result
isRegExp Boolean

Whether the keyword is regular expression or not
executionTime Number

Execution time in ms
files Object

list of the search result by file id

Properties
Name Type Description
fullString String

Full string of the result
row Number

Row id
col Number

Column id
type cell | context | comment

type of the search result
lineIndex Number

The line index

TransData

Description:

  • Object representing translation data.

Source:
Properties:
Name Type Description
data Array.<Array.<string>>

An array of arrays of strings representing translation data.
context Array.<Array.<string>>

An array of arrays of strings representing context data.
tags Array.<Array.<string>>

An array of arrays of strings representing tags data.
parameters Array.<Object>

An array of objects representing parameters data.
indexIds Object

An object representing index IDs.

Object representing translation data.

Type:
  • Object

TranslationData

Description:

  • Translation Data object generated by trans.getTranslationData

Source:
Properties:
Name Type Description
TranslationData.info Object

Information header of the translation pairs
TranslationData.translationData Object

Translation data
TranslationData.translationData[file Object

list of translation pairs grouped by the file id
TranslationData.translationData[file].info Object

Information of the current file
TranslationData.translationData[file].translationPair Object

Key value pair of original text and translation

Translation Data object generated by trans.getTranslationData

Type:
  • Object
Example
{
  "info": {
    "filterTag": [],
    "filterTagMode": ""
  },
  "translationData": {
    "data/Actors.json": {
      "info": {},
      "translationPair": {
		  "key text": "translation",
		  "key text2": "translation2",
	  }
    },
    "data/Animations.json": {
      "info": {},
      "translationPair": {
		  "key text": "translation",
		  "key text2": "translation2",
	  }
    }
  }
}

TranslationResult

Source:
Properties:
Name Type Description
source Array.<String>

Source texts
translation Array.<String>

Translation results
sourceText String

Translation result in plain text format
translationText String

Translation result in plain text format
Type:
  • Object

TranslationStats

Source:
Properties:
Name Type Description
translated number

How many rows are translated
length number

The number rows in total
percent number

How many rows are translated
Type:
  • Object