Class Checkbox
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
תיבת סימון
מכיל את פרטי התיבות הסימון של ההגדרה. המאפיינים שלו קובעים איך תיבת הסימון תוצג ב-Data Studio.
const config = DataStudioApp.createCommunityConnector().getConfig();
const checkbox = config.newCheckbox()
.setId('use_https')
.setName('Use Https?')
.setHelpText('Whether or not https should be used.')
.setAllowOverride(true);
מסמכים מפורטים
setAllowOverride(allowOverride)
מאפשרת לשנות את הערך של רשומת התצורה הזו. אם הערך מוגדר כ-true, ליוצרים של מקורות הנתונים תהיה אפשרות להפעיל את האפשרות הזו לעורכי הדוחות.
פרמטרים
| שם | סוג | תיאור |
allowOverride | Boolean | אם אפשר לשנות את ערך הערך הזה בתצורה בדוחות. |
חזרה
Checkbox – ה-builder הזה, לשרשור.
setHelpText(helpText)
הגדרת טקסט העזרה של רשומת התצורה הזו.
פרמטרים
| שם | סוג | תיאור |
helpText | String | טקסט העזרה להגדרה. |
חזרה
Checkbox – ה-builder הזה, לשרשור.
setId(id)
הגדרת המזהה הייחודי של רשומת התצורה הזו.
פרמטרים
| שם | סוג | תיאור |
id | String | המזהה שרוצים להגדיר. |
חזרה
Checkbox – ה-builder הזה, לשרשור.
setIsDynamic(isDynamic)
הגדרת הסטטוס הדינמי של רשומת התצורה הזו.
אם משנים רשומה של הגדרה דינמית, רשומות ההגדרה הבאות נמחקות.
פרמטרים
| שם | סוג | תיאור |
isDynamic | Boolean | הסטטוס הדינמי שרוצים להגדיר. |
חזרה
Checkbox – ה-builder הזה, לשרשור.
setName(name)
הגדרת השם המוצג של רשומת התצורה הזו.
פרמטרים
| שם | סוג | תיאור |
name | String | השם להגדרה. |
חזרה
Checkbox – ה-builder הזה, לשרשור.
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2025-07-26 (שעון UTC).
[null,null,["עדכון אחרון: 2025-07-26 (שעון UTC)."],[[["\u003cp\u003eThe \u003ccode\u003eCheckbox\u003c/code\u003e object configures checkbox properties for display in Data Studio.\u003c/p\u003e\n"],["\u003cp\u003eKey properties include ID, name, help text, and override settings, all set using designated methods.\u003c/p\u003e\n"],["\u003cp\u003eMethods like \u003ccode\u003esetAllowOverride\u003c/code\u003e, \u003ccode\u003esetHelpText\u003c/code\u003e, \u003ccode\u003esetId\u003c/code\u003e, \u003ccode\u003esetIsDynamic\u003c/code\u003e, and \u003ccode\u003esetName\u003c/code\u003e allow customization of the checkbox's functionality and appearance.\u003c/p\u003e\n"],["\u003cp\u003eEach method takes specific parameters, like \u003ccode\u003eallowOverride\u003c/code\u003e (boolean), \u003ccode\u003ehelpText\u003c/code\u003e (string), and \u003ccode\u003eid\u003c/code\u003e (string), to define the checkbox's behavior and presentation.\u003c/p\u003e\n"],["\u003cp\u003eAll Checkbox methods return the Checkbox object itself, enabling chained method calls for efficient configuration.\u003c/p\u003e\n"]]],[],null,["# Class Checkbox\n\nCheckbox\n\nContains checkbox information for the config. Its properties determine how the checkbox is\ndisplayed in Data Studio.\n\n```javascript\nconst config = DataStudioApp.createCommunityConnector().getConfig();\nconst checkbox = config.newCheckbox()\n .setId('use_https')\n .setName('Use Https?')\n .setHelpText('Whether or not https should be used.')\n .setAllowOverride(true);\n``` \n\n### Methods\n\n| Method | Return type | Brief description |\n|---------------------------------------------------------------|---------------|-------------------------------------------------------|\n| [setAllowOverride(allowOverride)](#setAllowOverride(Boolean)) | [Checkbox](#) | Enables overriding for this config entry. |\n| [setHelpText(helpText)](#setHelpText(String)) | [Checkbox](#) | Sets the help text for this configuration entry. |\n| [setId(id)](#setId(String)) | [Checkbox](#) | Sets the unique ID for this configuration entry. |\n| [setIsDynamic(isDynamic)](#setIsDynamic(Boolean)) | [Checkbox](#) | Sets the dynamic status for this configuration entry. |\n| [setName(name)](#setName(String)) | [Checkbox](#) | Sets the display name 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[Checkbox](#) --- 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[Checkbox](#) --- 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[Checkbox](#) --- 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[Checkbox](#) --- 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[Checkbox](#) --- This builder, for chaining."]]
