เอกสารอ้างอิง Transliterate API

การทับศัพท์อย่างง่าย

วิธีต่อไปนี้ช่วยให้คุณทับศัพท์อย่างง่ายได้โดยไม่ต้องใช้ UI ด้วยการแก้ไข JavaScript

วิธีการ คำอธิบาย

google.language.transliterate(wordsArray, srcLang, destLang, callback)

google.language.transliterate(wordsArray, srcLang, destLang, callback) เป็นวิธีการระดับโลกที่ทับศัพท์ข้อความที่ระบุจากภาษาต้นฉบับเป็นภาษาปลายทาง API จะแสดงผลลัพธ์แบบไม่พร้อมกันไปยังฟังก์ชัน callback ที่ระบุเป็นออบเจ็กต์ result พารามิเตอร์สำหรับเมธอดนี้ ได้แก่

  • wordsArray ระบุข้อความที่จะทับศัพท์เป็นอาร์เรย์
  • srcLang ระบุภาษาต้นฉบับเป็นรหัสภาษา ดูตัวอย่างได้ที่ LanguageCode enum
  • destLang ระบุภาษาปลายทางเป็นรหัสภาษา ดูตัวอย่างได้ที่ LanguageCode enum
  • callback คือฟังก์ชัน Callback ที่รับ result

google.language.transliterate() ไม่มีค่าที่ส่งคืน

วิธีการถอดเสียงที่เรียบง่ายนี้ใช้เนมสเปซ google.language.transliterate (ไม่ใช่ google.elements.transliteration ซึ่งเป็นเนมสเปซสำหรับเมธอดอื่นๆ ทั้งหมดใน Transliterate API)

google.language.transliterate() จะแสดงผลออบเจ็กต์ result

ระบบจะสร้างออบเจ็กต์ผลลัพธ์โดยใช้การเข้ารหัส JSON ของคำขอเซิร์ฟเวอร์ ด้วยเหตุนี้ เราจึงเลือกที่จะไม่ใช้การติดตั้งใช้งานออบเจ็กต์ JavaScript อย่างเป็นทางการ แต่จะสร้างออบเจ็กต์ result แบบไดนามิกจากรูปแบบที่แปลงเป็นอนุกรมแทน

แม้ว่าจะไม่มีการใช้งานออบเจ็กต์อย่างเป็นทางการ แต่ออบเจ็กต์ก็มีอยู่จริง และเราจะบันทึกออบเจ็กต์ราวกับว่ามีการใช้งาน JavaScript ที่รองรับ ผลกระทบจากทั้งหมดนี้จึงมีน้อยมาก ซึ่งหมายความว่าไม่มีตัวสร้างที่มีชื่อ สำหรับผลลัพธ์แต่ละรายการ ระบบจะเรียกใช้ new Object() แล้วตั้งค่าพร็อพเพอร์ตี้อย่างเป็นทางการในออบเจ็กต์นั้น พร็อพเพอร์ตี้เหล่านี้อยู่ด้านล่าง

  • <result>
    • error?
      แสดงหากมีการทับศัพท์ผิด
    • transliterations
      อาร์เรย์ที่มีขนาดเท่ากับขนาดของอินพุต wordsArray
      • transliteratedWords
        อาร์เรย์ที่มีขนาดสูงสุด 5 รายการ พร้อมการทับศัพท์ของคำที่เกี่ยวข้องใน wordsArray

การอ้างอิง JavaScript ของตัวควบคุมการทับศัพท์

ตัวสร้างและเมธอดต่อไปนี้ช่วยให้คุณทับศัพท์ภายใน UI ที่ API จัดเตรียมไว้ให้ได้

Constructor - google.elements.transliteration.TransliterationControl(options)

ผู้ผลิต คำอธิบาย

google.elements.transliteration.
TransliterationControl(options)

.TransliterationControl(options) จะเปิดใช้การทับศัพท์ในชุดองค์ประกอบ DOM ของ HTML ที่แก้ไขได้ และมีเมธอดหลายรายการที่ช่วยให้คุณควบคุมการทับศัพท์ในองค์ประกอบเหล่านั้นได้ อาร์กิวเมนต์ options อาจมีฟิลด์ต่อไปนี้

  • sourceLanguage เป็นสตริงที่ต้องระบุซึ่งระบุภาษาต้นฉบับโดยใช้ LanguageCode enum (ตามที่ระบุใน google.elements.transliteration.ENGLISH) ปัจจุบันภาษาต้นฉบับที่รองรับมีเพียงภาษาอังกฤษ
  • destinationLanguage เป็นอาร์เรย์ที่ต้องระบุซึ่งระบุภาษาปลายทางโดยใช้ LanguageCode enum ตามที่ระบุใน (ตามที่ระบุใน google.elements.transliteration.HINDI )

    ใน UI ภาษาปลายทางที่ใช้ได้จะปรากฏในเมนู โดยระบบจะเลือกภาษาแรกในอาร์เรย์โดยค่าเริ่มต้น โปรดดูรายละเอียดเพิ่มเติมเกี่ยวกับภาษาปลายทางที่ใช้ได้สำหรับภาษาต้นฉบับที่ระบุใน getDestinationLanguages
  • transliterationEnabled เป็นฟิลด์ที่ไม่บังคับซึ่งระบุว่าจะเปิดใช้การทับศัพท์โดยค่าเริ่มต้นหรือไม่ หากต้องการเปิดใช้การทับศัพท์โดยค่าเริ่มต้น ให้ระบุฟิลด์นี้ด้วยค่า true ค่าเริ่มต้นคือ false
  • shortcutKey เป็นฟิลด์สตริงที่ไม่บังคับซึ่งระบุแป้นพิมพ์ลัดเพื่อเปิดหรือปิดการทับศัพท์ หากต้องการระบุแป้นพิมพ์ลัด ให้ระบุสตริงที่มีตัวแก้ไข เช่น "Ctrl", "Alt" หรือ "Shift" พร้อมกับตัวอักษร เช่น "Ctrl+g" และ "Ctrl+Shift+a" เป็นชุดแป้นพิมพ์ลัดที่ถูกต้องทั้งคู่

    หมายเหตุ: คุณใช้ Shift เป็นตัวแก้ไขเพียงอย่างเดียวไม่ได้ แต่ใช้ร่วมกับ Alt หรือ Control ได้

วิธีนี้จะสร้างข้อยกเว้นในกรณีต่อไปนี้

  • sourceLanguage หรือ destinationLanguage ไม่ถูกต้อง
  • ภาษาที่ไม่รองรับในคู่ภาษา sourceLangauge และ destinationLanguage
  • ชุดค่าผสมของแป้นพิมพ์ลัดไม่ถูกต้อง

ข้อมูลโค้ดต่อไปนี้แสดงวิธีสร้างอินสแตนซ์ของตัวควบคุมการทับศัพท์ 

function onLoad() {
  var options = {
    sourceLanguage: 'en',
    destinationLanguage: ['hi'],
    shortcutKey: 'ctrl+g',
    transliterationEnabled: true
  };

  // Create an instance on TransliterationControl with the required
  // options.
  var control = new google.elements.transliteration.TransliterationControl(options);
}

วิธีการควบคุมการทับศัพท์

เมธอดต่อไปนี้จะติดตั้งใช้งานในเนมสเปซ google.elements.transliteration.TransliterationControl

วิธีการ คำอธิบาย

.addEventListener(eventType, listener, opt_listenerScope)

.addEventListener(eventType, listener, opt_listenerScope) เพิ่ม Listener ไปยังตัวควบคุมการทับศัพท์สำหรับประเภทเหตุการณ์ที่ระบุ เมื่อมีการทริกเกอร์ประเภทเหตุการณ์ที่เฉพาะเจาะจง ระบบจะเรียก Listener พร้อมออบเจ็กต์เหตุการณ์ เนื้อหาของออบเจ็กต์เหตุการณ์จะขึ้นอยู่กับประเภทของเหตุการณ์ พารามิเตอร์สำหรับเมธอดนี้ ได้แก่

  • eventType คือเหตุการณ์ที่จะเพิ่ม Listener อาร์กิวเมนต์นี้รับค่าจาก eventType enum (เช่น google.elements.transliteration.TransliterationControl. EventType.STATE_CHANGED)
  • listener มีฟังก์ชัน Listener สำหรับเหตุการณ์
  • opt_listenerScope จะเรียกผู้ฟังโดยตั้งค่า this เป็นออบเจ็กต์ที่ระบุใน opt_listenerScope

.addEventListener() ไม่มีค่าที่ส่งคืน

.disableTransliteration()

.disableTransliteration() จะปิดใช้การทับศัพท์ในการควบคุมการทับศัพท์ เมธอดนี้ไม่มีอาร์กิวเมนต์และไม่มีค่าที่ส่งคืน

.enableTransliteration()

.enableTransliteration() เปิดใช้การทับศัพท์ในการควบคุมการทับศัพท์ เมธอดนี้ไม่มีอาร์กิวเมนต์และไม่มีค่าที่ส่งคืน

.isTransliterationEnabled()

.isTransliterationEnabled() ไม่มีอาร์กิวเมนต์และแสดงผลค่าบูลีนที่ระบุว่ามีการเปิดใช้การทับศัพท์ในตัวควบคุมการทับศัพท์หรือไม่

.makeTransliteratable(elementIds, opt_options)

.makeTransliteratable(elementIds, opt_options) จะเปิดใช้การทับศัพท์ในองค์ประกอบ HTML ที่ระบุ พารามิเตอร์สำหรับเมธอดนี้ ได้แก่

  • elementIds คืออาร์เรย์ที่มีสตริงของรหัสองค์ประกอบที่แก้ไขได้หรือการอ้างอิงองค์ประกอบที่คุณต้องการเปิดใช้การทับศัพท์ องค์ประกอบที่แก้ไขได้อาจเป็น

    • ช่องข้อความ
    • พื้นที่ข้อความ
    • <div> ที่มี contentEditable="true"
    • <iframe> ที่มี designMode="on"
    • Iframe ที่มีcontentEditable="true" body ตรวจสอบว่าโหลด iFrame แล้วก่อนเปิดใช้การทับศัพท์
  • opt_options เป็นอาร์กิวเมนต์ที่ไม่บังคับซึ่งระบุตัวเลือกที่ใช้กับองค์ประกอบเหล่านี้ อาร์กิวเมนต์นี้มีฟิลด์ต่อไปนี้ได้
    • adjustElementStyle เป็นฟิลด์บูลีนที่ไม่บังคับซึ่งควบคุมว่า API จะปรับขนาดองค์ประกอบและแบบอักษรโดยอัตโนมัติเพื่อให้เหมาะกับอักขระของภาษาเป้าหมายอย่างเหมาะสมหรือไม่ ค่าเริ่มต้นคือ true ตัวเลือกนี้จะมีผลกับองค์ประกอบข้อความธรรมดาเท่านั้น
    • adjustElementDirection เป็นฟิลด์บูลีนที่ไม่บังคับซึ่งควบคุมทิศทางขององค์ประกอบที่แก้ไขได้โดยขึ้นอยู่กับทิศทางของ destinationLanguage ค่าเริ่มต้นคือ true

สำหรับระบบการเขียนจากขวาไปซ้าย เช่น ภาษาอารบิก API จะปรับทิศทางขององค์ประกอบอินพุตโดยอัตโนมัติตามทิศทางของสคริปต์ที่เขียนและเนื้อหาขององค์ประกอบอินพุต คุณตั้งค่าทิศทางของข้อความในองค์ประกอบอินพุตได้โดยใช้ HTML และ JavaScript กับ direction ซึ่งมีค่าเป็น 'ltr' (จากซ้ายไปขวา) หรือ 'rtl' (จากขวาไปซ้าย) ได้ การใช้วิธีนี้จะส่งผลต่อเคอร์เซอร์และการจัดแนวข้อความในพื้นที่ป้อนข้อมูล

คุณดูตัวอย่างการรองรับภาษาที่เขียนจากขวาไปซ้ายของ API ได้ในตัวอย่างการทับศัพท์ภาษาอาหรับ

วิธีนี้จะสร้างข้อยกเว้นหาก elementIds ที่ระบุไม่ถูกต้อง

.makeTransliteratable() ไม่มีค่าที่ส่งคืน

.removeEventListener(eventType, listener, opt_listenerScope)

.removeEventListener(eventType, listener, opt_listenerScope) จะนำ Listener เหตุการณ์ออกจากตัวควบคุมการทับศัพท์ โดยที่

  • อาร์กิวเมนต์นี้รับค่าจาก enum eventType (เช่น google.elements.transliteration.TransliterationControl. EventType.STATE_CHANGED)
  • listener คือฟังก์ชันสำหรับเหตุการณ์ที่ต้องนำออก
  • opt_listenerScope คือขอบเขตที่ลงทะเบียนผู้ฟังไว้ในขณะที่เพิ่มผู้ฟัง

.removeEventListener() ไม่มีค่าที่ส่งคืน

.setLanguagePair(sourceLanguage, destinationLanguage)

.setLanguagePair(sourceLanguage, destinationLanguage) ช่วยให้คุณเปลี่ยนคู่ภาษาที่ใช้โดยตัวควบคุมการทับศัพท์แบบไดนามิกได้ โดยมีรายละเอียดดังนี้

  • sourceLanguage ระบุประเภทภาษาที่จะทับศัพท์ อาร์กิวเมนต์นี้รับค่าจาก LanguageCode enum (เช่น google.elements.transliteration.TransliterationControl. LanguageCode.ENGLISH)
  • destinationLanguage ระบุประเภทภาษาสำหรับข้อความที่ทับศัพท์

.setLanguagePair() จะแสดงค่าบูลีนที่ระบุว่าการดำเนินการ setLanguage สำเร็จหรือไม่

.showControl(divElement)

.showControl(divElement) จะแสดงตัวควบคุมการทับศัพท์ใน DIV ที่ระบุ โดย divElement คือรหัสของ DIV วิธีนี้ไม่มีค่าที่ส่งคืน

.toggleTransliteration()

.toggleTransliteration() เปิดหรือปิดการทับศัพท์ในตัวควบคุมการทับศัพท์ เมธอดนี้ไม่มีอาร์กิวเมนต์และไม่มีค่าที่ส่งคืน

เมธอดแบบคงที่

ระบบจะใช้เมธอดแบบคงที่ต่อไปนี้ในเนมสเปซ google.language

เมธอดแบบคงที่ คำอธิบาย

.setOnLoadCallback(callback)

.setOnLoadCallback(callback) เป็นฟังก์ชันแบบคงที่ซึ่งลงทะเบียนฟังก์ชันแฮนเดิลที่ระบุให้เรียกใช้เมื่อหน้าเว็บที่มีการเรียกใช้นี้โหลด โดย callback เป็นฟังก์ชันที่จำเป็นซึ่งจะเรียกใช้เมื่อโหลดเอกสารที่มีอยู่และ API พร้อมใช้งาน (เช่น หลังจาก onLoad) ฟังก์ชันนี้จะติดตั้งใช้งานในเนมสเปซ google (เช่น google.setOnLoadCallback(callback);)

.setOnLoadCallback() ไม่มีค่าที่ส่งคืน

หมายเหตุ: เอกสารประกอบก่อนหน้านี้แนะนำให้คุณใช้แอตทริบิวต์ onload ขององค์ประกอบ body (<body onload="OnLoad()">) แม้ว่าวิธีนี้จะใช้ได้ดีเมื่อคุณควบคุมหน้าเว็บและโค้ดทั้งหมดที่หน้าเว็บโหลดได้อย่างสมบูรณ์ แต่แนวทางนี้อาจทำให้เกิดปัญหากับรันไทม์บางรายการที่ทำลายแฮนเดิล body.onload setOnLoadCallback() ไม่มีปัญหาเหล่านี้ จึงเป็นวิธีที่แนะนำในการลงทะเบียนการเรียกกลับที่จะเรียกใช้โค้ดเมื่อ API โหลดเสร็จสมบูรณ์และพร้อมใช้งาน

ระบบจะใช้เมธอดแบบคงที่ต่อไปนี้ในเนมสเปซ google.elements.transliteration

เมธอดแบบคงที่ คำอธิบาย

.getDestinationLanguages(sourceLanguage)

.getDestinationLanguages(sourceLanguage) เป็นเมธอดส่วนกลางที่แสดงผลแผนที่ของภาษาปลายทางที่รองรับการทับศัพท์สำหรับ sourceLanguage ที่ระบุ แผนที่ที่แสดงผลจะมีภาษาปลายทางที่รองรับ โดยคีย์คือชื่อภาษาและค่าคือรหัสภาษา แผนที่ที่แสดงผลจะคล้ายกับแผนที่ที่อธิบายไว้ใน LanguageCode enum

Enum

enum ของ EventType

การแจงนับ google.elements.transliteration.TransliterationControl.EventType แสดงเหตุการณ์ที่อาจเกิดขึ้นระหว่างการทับศัพท์ คุณสามารถระบุตัวแฮนเดิลที่กำหนดเองสำหรับเหตุการณ์เหล่านี้ในโค้ดได้

var google.elements.transliteration.TransliterationControl.EventType = {
   STATE_CHANGED : 'state_changed',
   LANGUAGE_CHANGED : 'language_changed',
   SERVER_REACHABLE : 'server_reachable',
   SERVER_UNREACHABLE : 'server_unreachable'
};
  • google.elements.transliteration.TransliterationControl.EventType.STATE_CHANGED: ผลลัพธ์เมื่อเปิดหรือปิดใช้การทับศัพท์ในการควบคุมการทับศัพท์ผ่าน
    • แป้นพิมพ์ลัด
    • วิธี enableTransliteration, disableTransliteration หรือ toggleTransliteration
    • การคลิกเมาส์ที่ตัวควบคุมการทับศัพท์ที่วาดโดยshowControl method
    ออบเจ็กต์เหตุการณ์ที่ส่งไปยัง Listener มีฟิลด์ transliterationEnabled ฟิลด์นี้จะเป็นจริงหากการทับศัพท์เป็น "on" มิเช่นนั้นจะเป็นเท็จ
  • google.elements.transliteration.TransliterationControl.EventType.LANGUAGE_CHANGED: ผลลัพธ์เมื่อเปลี่ยนคู่ภาษาการทับศัพท์ในการควบคุมการทับศัพท์ผ่าน
    • setLanguagePair วิธี
    • การควบคุมการทับศัพท์ที่วาดโดยวิธีการ showControl
    ออบเจ็กต์เหตุการณ์ที่ส่งไปยัง Listener มีฟิลด์ sourceLanguage และ destinationLanguage
  • google.elements.transliteration.TransliterationControl.EventType.SERVER_REACHABLE: ผลลัพธ์เมื่อคุณติดต่อเซิร์ฟเวอร์เพื่อทับศัพท์ข้อความได้สำเร็จ
  • google.elements.transliteration.TransliterationControl.EventType.SERVER_UNREACHABLE ผลลัพธ์เมื่อพยายามติดต่อเซิร์ฟเวอร์เพื่อทับศัพท์ข้อความไม่สำเร็จ

LanguageCode enum

google.elements.transliteration.LanguageCode จะแมปค่าคงที่ของชื่อแผนที่กับรหัสภาษาที่คุณใช้ระบุภาษาต้นทางและภาษาปลายทางในวิธีการทับศัพท์ได้

var google.elements.transliteration.LanguageCode = {
    ENGLISH: 'en',
    AMHARIC: 'am',
    ARABIC: 'ar',
    BENGALI: 'bn',
    CHINESE: 'zh',
    GREEK: 'el',
    GUJARATI: 'gu',
    HINDI: 'hi',
    KANNADA: 'kn',
    MALAYALAM: 'ml',
    MARATHI: 'mr',
    NEPALI: 'ne',
    ORIYA: 'or',
    PERSIAN: 'fa',
    PUNJABI: 'pa',
    RUSSIAN: 'ru',
    SANSKRIT: 'sa',
    SINHALESE: 'si',
    SERBIAN: 'sr',
    TAMIL: 'ta',
    TELUGU: 'te',
    TIGRINYA: 'ti',
    URDU: 'ur'
};

enum SupportedDestinationLanguages

google.elements.transliteration.SupportedDestinationLanguagesการแมปการแจงนับจะเชื่อมโยงค่าคงที่ของชื่อกับอาร์เรย์ของรหัสภาษาที่คุณใช้เพื่อระบุกลุ่มภาษาปลายทางในการควบคุมการทับศัพท์ได้

var google.elements.transliteration.SupportedDestinationLanguages = {
    // ALL includes all languages supported in the Transliterate API.
    // As support for more languages becomes available, this enum will be
    // automatically updated to include the new languages transparently.
    ALL: [
        google.elements.transliteration.LanguageCode.AMHARIC,
        google.elements.transliteration.LanguageCode.ARABIC,
        google.elements.transliteration.LanguageCode.BENGALI,
        google.elements.transliteration.LanguageCode.CHINESE,
        google.elements.transliteration.LanguageCode.GREEK,
        google.elements.transliteration.LanguageCode.GUJARATI,
        google.elements.transliteration.LanguageCode.HINDI,
        google.elements.transliteration.LanguageCode.KANNADA,
        google.elements.transliteration.LanguageCode.MALAYALAM,
        google.elements.transliteration.LanguageCode.MARATHI,
        google.elements.transliteration.LanguageCode.NEPALI,
        google.elements.transliteration.LanguageCode.ORIYA,
        google.elements.transliteration.LanguageCode.PERSIAN,
        google.elements.transliteration.LanguageCode.PUNJABI,
        google.elements.transliteration.LanguageCode.RUSSIAN,
        google.elements.transliteration.LanguageCode.SANSKRIT,
        google.elements.transliteration.LanguageCode.SERBIAN,
        google.elements.transliteration.LanguageCode.SINHALESE,
        google.elements.transliteration.LanguageCode.TAMIL,
        google.elements.transliteration.LanguageCode.TELUGU,
        google.elements.transliteration.LanguageCode.TIGRINYA,
        google.elements.transliteration.LanguageCode.URDU],
 
    // INDIC includes all Indic languages supported in the Transliterate API.
    // As support for more Indic languages becomes available, this enum will be
    // automatically updated to include the new languages transparently.
    INDIC: [
        google.elements.transliteration.LanguageCode.BENGALI,
        google.elements.transliteration.LanguageCode.GUJARATI,
        google.elements.transliteration.LanguageCode.HINDI,
        google.elements.transliteration.LanguageCode.KANNADA,
        google.elements.transliteration.LanguageCode.MALAYALAM,
        google.elements.transliteration.LanguageCode.MARATHI,
        google.elements.transliteration.LanguageCode.NEPALI,
        google.elements.transliteration.LanguageCode.ORIYA,
        google.elements.transliteration.LanguageCode.PUNJABI,
        google.elements.transliteration.LanguageCode.SANSKRIT,
        google.elements.transliteration.LanguageCode.SINHALESE,
        google.elements.transliteration.LanguageCode.TAMIL,
        google.elements.transliteration.LanguageCode.TELUGU,
        google.elements.transliteration.LanguageCode.URDU]
};

การแก้ปัญหา

หากพบปัญหา ให้ทำดังนี้

  • มองหาคำที่พิมพ์ผิด โปรดทราบว่า JavaScript เป็นภาษาที่คำนึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่
  • ใช้โปรแกรมแก้ไขข้อบกพร่อง JavaScript Google Chrome มีเครื่องมือสำหรับนักพัฒนาซอฟต์แวร์ครบชุด ใน Firefox คุณใช้คอนโซล JavaScript หรือ Firebug ได้ ใน IE คุณสามารถใช้ Microsoft Script Debugger ได้
  • ค้นหา กลุ่มสนทนา หากไม่พบโพสต์ที่ตอบคำถามของคุณ ให้โพสต์คำถามในกลุ่มพร้อมกับลิงก์ไปยังหน้าเว็บที่แสดงปัญหา