Class TextInput
تنظيم صفحاتك في مجموعات
يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.
TextInput
يحتوي على معلومات إدخال نصية للإعداد. وتحدّد خصائصه كيفية عرض الإدخال النصي
في "مركز البيانات".
const cc = DataStudioApp.createCommunityConnector();
const config = cc.getConfig();
const info1 = config.newTextInput()
.setId('info1')
.setName('Search')
.setHelpText('for example, Coldplay')
.setAllowOverride(true)
.setPlaceholder('Search for an artist for all songs.');
مستندات تفصيلية
setAllowOverride(allowOverride)
يتيح هذا الخيار إلغاء إدخال الإعدادات هذا. في حال ضبط القيمة على true، يكون لصنّاع مصادر البيانات
خيار تفعيل هذه الميزة لمحرّري التقارير.
المعلمات
| الاسم | النوع | الوصف |
allowOverride | Boolean | ما إذا كان يمكن إلغاء إدخال الإعدادات هذا في التقارير أم لا |
الإرجاع
TextInput: هذا المُنشئ، لتسلسل العناصر.
setHelpText(helpText)
تُستخدَم لضبط نص المساعدة الخاص بإدخال الإعدادات هذا.
المعلمات
| الاسم | النوع | الوصف |
helpText | String | نص المساعدة المطلوب ضبطه. |
الإرجاع
TextInput: هذا المُنشئ، لتسلسل العناصر.
setId(id)
لضبط المعرّف الفريد لإدخال الإعدادات هذا.
المعلمات
| الاسم | النوع | الوصف |
id | String | رقم التعريف المطلوب ضبطه. |
الإرجاع
TextInput: هذا المُنشئ، لتسلسل العناصر.
setIsDynamic(isDynamic)
لضبط الحالة الديناميكية لإدخال الإعداد هذا.
في حال تعديل إدخال الإعدادات الديناميكي، يتم محو إدخالات الإعدادات اللاحقة.
المعلمات
| الاسم | النوع | الوصف |
isDynamic | Boolean | الحالة الديناميكية المطلوب ضبطها |
الإرجاع
TextInput: هذا المُنشئ، لتسلسل العناصر.
setName(name)
لضبط الاسم المعروض لإدخال الإعدادات هذا.
المعلمات
| الاسم | النوع | الوصف |
name | String | الاسم المطلوب ضبطه. |
الإرجاع
TextInput: هذا المُنشئ، لتسلسل العناصر.
setPlaceholder(placeholder)
تُستخدَم لضبط نص العنصر النائب لإدخال الإعدادات هذا.
المعلمات
| الاسم | النوع | الوصف |
placeholder | String | نص العنصر النائب المطلوب ضبطه |
الإرجاع
TextInput: هذا المُنشئ، لتسلسل العناصر.
إنّ محتوى هذه الصفحة مرخّص بموجب ترخيص Creative Commons Attribution 4.0 ما لم يُنصّ على خلاف ذلك، ونماذج الرموز مرخّصة بموجب ترخيص Apache 2.0. للاطّلاع على التفاصيل، يُرجى مراجعة سياسات موقع Google Developers. إنّ Java هي علامة تجارية مسجَّلة لشركة Oracle و/أو شركائها التابعين.
تاريخ التعديل الأخير: 2025-07-26 (حسب التوقيت العالمي المتفَّق عليه)
[null,null,["تاريخ التعديل الأخير: 2025-07-26 (حسب التوقيت العالمي المتفَّق عليه)"],[[["\u003cp\u003e\u003ccode\u003eTextInput\u003c/code\u003e objects are used to collect text input within a Data Studio configuration.\u003c/p\u003e\n"],["\u003cp\u003eThese objects allow you to define the input's label (\u003ccode\u003esetName\u003c/code\u003e), placeholder text (\u003ccode\u003esetPlaceholder\u003c/code\u003e), help text (\u003ccode\u003esetHelpText\u003c/code\u003e), and more.\u003c/p\u003e\n"],["\u003cp\u003eYou can control whether users can override the input's value (\u003ccode\u003esetAllowOverride\u003c/code\u003e) and whether it dynamically affects other configuration options (\u003ccode\u003esetIsDynamic\u003c/code\u003e).\u003c/p\u003e\n"],["\u003cp\u003eEvery \u003ccode\u003eTextInput\u003c/code\u003e needs a unique identifier set using the \u003ccode\u003esetId\u003c/code\u003e method.\u003c/p\u003e\n"]]],[],null,["# Class TextInput\n\nTextInput\n\nContains text input information for the config. Its properties determine how the text input is\ndisplayed in Data Studio.\n\n```javascript\nconst cc = DataStudioApp.createCommunityConnector();\nconst config = cc.getConfig();\n\nconst info1 = config.newTextInput()\n .setId('info1')\n .setName('Search')\n .setHelpText('for example, Coldplay')\n .setAllowOverride(true)\n .setPlaceholder('Search for an artist for all songs.');\n``` \n\n### Methods\n\n| Method | Return type | Brief description |\n|---------------------------------------------------------------|----------------|---------------------------------------------------------|\n| [setAllowOverride(allowOverride)](#setAllowOverride(Boolean)) | [TextInput](#) | Enables overriding for this config entry. |\n| [setHelpText(helpText)](#setHelpText(String)) | [TextInput](#) | Sets the help text for this configuration entry. |\n| [setId(id)](#setId(String)) | [TextInput](#) | Sets the unique ID for this configuration entry. |\n| [setIsDynamic(isDynamic)](#setIsDynamic(Boolean)) | [TextInput](#) | Sets the dynamic status for this configuration entry. |\n| [setName(name)](#setName(String)) | [TextInput](#) | Sets the display name for this configuration entry. |\n| [setPlaceholder(placeholder)](#setPlaceholder(String)) | [TextInput](#) | Sets the placeholder text for this configuration entry. |\n\nDetailed documentation\n----------------------\n\n### `set``Allow``Override(allowOverride)`\n\nEnables overriding for this config entry. If set to `true`, data source creators have the\noption to enable this for report editors\n\n#### Parameters\n\n| Name | Type | Description |\n|-------------------|-----------|----------------------------------------------------------------|\n| `allow``Override` | `Boolean` | Whether or not this config entry can be overridden in reports. |\n\n#### Return\n\n\n[TextInput](#) --- This builder, for chaining.\n\n*** ** * ** ***\n\n### `set``Help``Text(helpText)`\n\nSets the help text for this configuration entry.\n\n#### Parameters\n\n| Name | Type | Description |\n|--------------|----------|----------------------|\n| `help``Text` | `String` | The helpText to set. |\n\n#### Return\n\n\n[TextInput](#) --- This builder, for chaining.\n\n*** ** * ** ***\n\n### `set``Id(id)`\n\nSets the unique ID for this configuration entry.\n\n#### Parameters\n\n| Name | Type | Description |\n|------|----------|----------------|\n| `id` | `String` | The ID to set. |\n\n#### Return\n\n\n[TextInput](#) --- This builder, for chaining.\n\n*** ** * ** ***\n\n### `set``Is``Dynamic(isDynamic)`\n\nSets the dynamic status for this configuration entry.\n\nIf a dynamic configuration entry is modified, subsequent configuration entries are cleared.\n\n#### Parameters\n\n| Name | Type | Description |\n|---------------|-----------|----------------------------|\n| `is``Dynamic` | `Boolean` | The dynamic status to set. |\n\n#### Return\n\n\n[TextInput](#) --- This builder, for chaining.\n\n*** ** * ** ***\n\n### `set``Name(name)`\n\nSets the display name for this configuration entry.\n\n#### Parameters\n\n| Name | Type | Description |\n|--------|----------|------------------|\n| `name` | `String` | The name to set. |\n\n#### Return\n\n\n[TextInput](#) --- This builder, for chaining.\n\n*** ** * ** ***\n\n### `set``Placeholder(placeholder)`\n\nSets the placeholder text for this configuration entry.\n\n#### Parameters\n\n| Name | Type | Description |\n|---------------|----------|------------------------------|\n| `placeholder` | `String` | The placeholder text to set. |\n\n#### Return\n\n\n[TextInput](#) --- This builder, for chaining."]]
