KeyboardEngine API: описание документа

Использование в Web

<script src="src/js/keyboard-engine.js"></script>
<script>
    var engine = new KeyboardEngine();
    var layout = engine.update(0, 0, "粤B12345", 0) 
    console.log(layout);
</script>

Объекты, экспортируемые KeyboardEngine:

{
    update: function(keyboardType: Int, showIndex: Int, presetNumber: String, numType: Int),
    $newKey: function(),
    config: JSON,
}

KeyboardEngine.VERSION — тип номера транспортного средства:

V2.0/v2017.11S01/iRain(SZ)

KeyboardEngine.NUM_TYPES — типы номеров транспортных средств:

— 0 — автоматическое обнаружение; — 1 — номерной знак для гражданских транспортных средств; — 2 — номерной знак военной полиции; — 3 — номерной знак местной полиции; — 4 — военный номерной знак; — 5 — номерной знак транспортного средства на новых источниках энергии; — 6 — дипломатический номерной знак посольства; — 7 — новый дипломатический номерной знак.

KeyboardEngine.KEY_TYPES — коды типов клавиш:

— 0 — обычная клавиша; — 1 — функциональная клавиша: удаление; — 2 — функциональная клавиша: подтверждение.

KeyboardEngine.KEYBOARD_TYPES — типы клавиатур, доступны три способа:

— 0 — полная клавиатура, отображаются все клавиши. Обычно используется в приложениях для планшетов; — 1 — только для гражданского номерного знака; — 2 — гражданский номерной знак + специальная клавиатура.

Функция update

Прототип: function(keyboardType: Int, showIndex: Int, presetNumber: String, numberType: Int): JSONObject.

Ввод функции:

• keyboardType — указывает тип клавиатуры, которую нужно обновить;
• showIndex — указывает положение номерного знака, которое нужно обновить, например, если текущий ввод — это первый символ, то индекс равен 0;
• presetNumber — текущий предварительно установленный номерной знак, может быть полным номерным знаком или его частью;
• numberType — определяет тип номерного знака. Например, можно принудительно указать тип номерного знака транспортного средства на новом источнике энергии, по умолчанию — 0 (автоматическое обнаружение).

Вывод функции JSON:

    {
        index: Int,
        presetNumber: String,
        keyboardType: KEYBOARD_TYPE,
        numberType: NUM_TYPES,
        presetNumberType: NUM_TYPES,
        detectedNumberType: NUM_TYPES,
        numberLength: Int,
        numberLimitLength: Int,
        row0: Array,
        row1: Array,
        row2: Array,
        row3: Array,
        row4: Array
    }

— index — текущая позиция клавиатуры; — presetNumber — текущий предустановленный номерной знак; — keyboardType — текущая позиция клавиатуры; — numberType — текущий тип предустановленного номерного знака (устаревший параметр); — presetNumberType — аналогично numberType; — detectedNumberType — обнаруженный тип текущего номерного знака; — numberLength — длина текущего предустановленного номерного знака; — numberLimitLength — максимальная длина номерного знака; — row0 - row4 — массив клавиш для каждой строки клавиатуры.

Формат и содержание KeyEntity в формате JSON:

{
    text: String,
    keyCode: Int,
    enabled: Boolean,
    isFunKey: Boolean
}

— text — текст, отображаемый на текущей клавише; — keyCode — код типа клавиши; — enabled — включена ли текущая клавиша в раскладку клавиатуры; — isFunKey — является ли текущая клавиша функциональной. ``` false }, { "text": "赣", "keyCode": 0, "enabled": true, "isFunKey": false }, { "text": "鲁", "keyCode": 0, "enabled": true, "isFunKey": false }, { "text": "豫", "keyCode": 0, "enabled": true, "isFunKey": false }, { "text": "鄂", "keyCode": 0, "enabled": true, "isFunKey": false }, { "text": "湘", "keyCode": 0, "enabled": true, "isFunKey": false } ], "row2": [ { "text": "粤", "keyCode": 0, "enabled": true, "isFunKey": false }, { "text": "桂", "keyCode": 0, "enabled": true, "isFunKey": false }, { "text": "琼", "keyCode": 0, "enabled": true, "isFunKey": false }, { "text": "渝", "keyCode": 0, "enabled": true, "isFunKey": false }, { "text": "川", "keyCode": 0, "enabled": true, "isFunKey": false }, { "text": "贵", "keyCode": 0, "enabled": true, "isFunKey": false }, { "text": "云", "keyCode": 0, "enabled": true, "isFunKey": false }, { "text": "藏", "keyCode": 0, "enabled": true, "isFunKey": false } ], "row3": [ { "text": "陕", "keyCode": 0, "enabled": true, "isFunKey": false }, { "text": "甘", "keyCode": 0, "enabled": true, "isFunKey": false }, { "text": "青", "keyCode": 0, "enabled": true, "isFunKey": false }, { "text": "宁", "keyCode": 0, "enabled": true, "isFunKey": false }, { "text": "新", "keyCode": 0, "enabled": true, "isFunKey": false }, { "text": "W", "keyCode": 0, "enabled": true, "isFunKey": false }, { "text": "←", "keyCode": 1, "enabled": false, "isFunKey": true }, { "text": "确定", "keyCode": 2, "enabled": false, "isFunKey": true } ], "row4": []