Class TextInput
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
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.');
מסמכים מפורטים
setAllowOverride(allowOverride)
מאפשרת לשנות את הערך של רשומת התצורה הזו. אם הערך מוגדר כ-true, ליוצרים של מקורות הנתונים תהיה אפשרות להפעיל את האפשרות הזו לעורכי הדוחות
פרמטרים
| שם | סוג | תיאור |
allowOverride | Boolean | אם אפשר לשנות את ערך הערך הזה בתצורה בדוחות. |
חזרה
TextInput – ה-builder הזה, לשרשור.
setHelpText(helpText)
הגדרת טקסט העזרה של רשומת התצורה הזו.
פרמטרים
| שם | סוג | תיאור |
helpText | String | טקסט העזרה להגדרה. |
חזרה
TextInput – ה-builder הזה, לשרשור.
setId(id)
הגדרת המזהה הייחודי של רשומת התצורה הזו.
פרמטרים
| שם | סוג | תיאור |
id | String | המזהה שרוצים להגדיר. |
חזרה
TextInput – ה-builder הזה, לשרשור.
setIsDynamic(isDynamic)
הגדרת הסטטוס הדינמי של רשומת התצורה הזו.
אם משנים רשומה של הגדרה דינמית, רשומות ההגדרה הבאות נמחקות.
פרמטרים
| שם | סוג | תיאור |
isDynamic | Boolean | הסטטוס הדינמי שרוצים להגדיר. |
חזרה
TextInput – ה-builder הזה, לשרשור.
setName(name)
הגדרת השם המוצג של רשומת התצורה הזו.
פרמטרים
| שם | סוג | תיאור |
name | String | השם להגדרה. |
חזרה
TextInput – ה-builder הזה, לשרשור.
setPlaceholder(placeholder)
הגדרת הטקסט החלופי של רשומת התצורה הזו.
פרמטרים
| שם | סוג | תיאור |
placeholder | String | הטקסט של ה-placeholder שרוצים להגדיר. |
חזרה
TextInput – ה-builder הזה, לשרשור.
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2025-07-26 (שעון UTC).
[null,null,["עדכון אחרון: 2025-07-26 (שעון UTC)."],[[["\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."]]
