Class TextInput
با مجموعه‌ها، منظم بمانید
ذخیره و طبقه‌بندی محتوا براساس اولویت‌های شما.
ورودی متن حاوی اطلاعات ورودی متن برای پیکربندی است. ویژگی های آن تعیین می کند که چگونه ورودی متن در Data Studio نمایش داده شود.
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.'); مستندات دقیق
set Allow Override(allowOverride)
نادیده گرفتن این ورودی پیکربندی را فعال می کند. اگر روی true تنظیم شود، سازندگان منبع داده این گزینه را دارند که این را برای ویرایشگرهای گزارش فعال کنند
پارامترها
| نام | تایپ کنید | توضیحات |
|---|
allow Override | Boolean | اینکه آیا این ورودی پیکربندی را می‌توان در گزارش‌ها لغو کرد یا خیر. |
بازگشت
Text Input - این سازنده، برای زنجیر کردن.
set Help Text(helpText)
متن راهنما را برای این ورودی پیکربندی تنظیم می کند.
پارامترها
| نام | تایپ کنید | توضیحات |
|---|
help Text | String | helpText برای تنظیم. |
بازگشت
Text Input - این سازنده، برای زنجیر کردن.
set Id(id)
شناسه منحصر به فرد را برای این ورودی پیکربندی تنظیم می کند.
پارامترها
| نام | تایپ کنید | توضیحات |
|---|
id | String | شناسه برای تنظیم. |
بازگشت
Text Input - این سازنده، برای زنجیر کردن.
set Is Dynamic(isDynamic)
وضعیت پویا را برای این ورودی پیکربندی تنظیم می کند.
اگر یک ورودی پیکربندی پویا اصلاح شود، ورودی‌های پیکربندی بعدی پاک می‌شوند.
پارامترها
| نام | تایپ کنید | توضیحات |
|---|
is Dynamic | Boolean | وضعیت پویا برای تنظیم. |
بازگشت
Text Input - این سازنده، برای زنجیر کردن.
set Name(name)
نام نمایشی را برای این ورودی پیکربندی تنظیم می کند.
پارامترها
| نام | تایپ کنید | توضیحات |
|---|
name | String | نام برای تنظیم. |
بازگشت
Text Input - این سازنده، برای زنجیر کردن.
set Placeholder(placeholder)
متن مکان‌دار را برای این ورودی پیکربندی تنظیم می‌کند.
پارامترها
| نام | تایپ کنید | توضیحات |
|---|
placeholder | String | متن نگهدارنده برای تنظیم. |
بازگشت
Text Input - این سازنده، برای زنجیر کردن.
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2025-07-24 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2025-07-24 بهوقت ساعت هماهنگ جهانی."],[[["\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."]]
