小工具指的是錶面上除了時間之外顯示的任何功能。譬如電池指示就是小工具。Complications API 適用於錶面和資料來源應用程式。
本文件其他部分會再說明資料來源、錶面以及小工具類型。
小工具資料來源
提供資料 (例如電池電量、天氣或步數) 到錶面供小工具使用的應用程式稱為「小工具資料來源」。這些資料來源會提供原始資料,且無法控制錶面轉譯資料的方式。如果想瞭解如何編寫可提供資料給錶面的應用程式,請參閱「向小工具提供資料」。
下圖顯示,Wear OS by Google 可以做為來源到錶面之間資料流的中介。
錶面小工具
錶面會從小工具資料來源接收資料,以便錶面在不需要編寫程式碼取得基礎資料的情況下納入小工具。錶面可以保留資料轉譯方式的控制權,以便配合設計以不突兀的方式整合資料。詳情請見「小工具」的設計指南。
如果想瞭解如何為錶面新增小工具,請見「在錶面新增小工具」。
小工具類型
小工具類型可以定義小工具內可顯示或資料來源可提供的資料類型。舉例來說,當有主要由短字串組成的資料時,可用 SHORT_TEXT
類型。ComplicationData
物件一律只有一種小工具類型,用來定義必填及選填欄位。必填欄位代表資料的主要內容,大多數的類型都會從必填欄位取得名稱。
資料來源使用的小工具類型與錶面不同:
- 資料來源會選擇要提供的小工具資料類型 (包括這些類型要提供的選填欄位) 以及可以支援的類型種類。舉例來說,步數來源可能會支援
RANGED_VALUE
和SHORT_TEXT
類型,而下次會議來源可能會支援SHORT_TEXT
和LONG_TEXT
類型。 - 您可以決定錶面可以顯示的小工具數量以及支援的小工具類型。舉例來說,錶面上的撥號小工具可能支援
SHORT_TEXT
、ICON
和RANGED_VALUE
類型。錶面上的計量表可能僅支援RANGED_VALUE
類型。
如果想進一步瞭解各種小工具類型以及各類型支援的欄位,請參閱「小工具類型」。