Class Checkbox
تنظيم صفحاتك في مجموعات
يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.
مربّع اختيار
يحتوي على معلومات مربّعات الاختيار للإعداد. تحدّد خصائصه كيفية
عرض مربّع الاختيار في "مركز البيانات".
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: هذا المُنشئ، لتسلسل العناصر.
setHelpText(helpText)
تُستخدَم لضبط نص المساعدة الخاص بإدخال الإعدادات هذا.
المعلمات
| الاسم | النوع | الوصف |
helpText | String | نص المساعدة المطلوب ضبطه. |
الإرجاع
Checkbox: هذا المُنشئ، لتسلسل العناصر.
setId(id)
لضبط المعرّف الفريد لإدخال الإعدادات هذا.
المعلمات
| الاسم | النوع | الوصف |
id | String | رقم التعريف المطلوب ضبطه. |
الإرجاع
Checkbox: هذا المُنشئ، لتسلسل العناصر.
setIsDynamic(isDynamic)
لضبط الحالة الديناميكية لإدخال الإعداد هذا.
في حال تعديل إدخال الإعدادات الديناميكي، يتم محو إدخالات الإعدادات اللاحقة.
المعلمات
| الاسم | النوع | الوصف |
isDynamic | Boolean | الحالة الديناميكية المطلوب ضبطها |
الإرجاع
Checkbox: هذا المُنشئ، لتسلسل العناصر.
setName(name)
لضبط الاسم المعروض لإدخال الإعدادات هذا.
المعلمات
| الاسم | النوع | الوصف |
name | String | الاسم المطلوب ضبطه. |
الإرجاع
Checkbox: هذا المُنشئ، لتسلسل العناصر.
إنّ محتوى هذه الصفحة مرخّص بموجب ترخيص Creative Commons Attribution 4.0 ما لم يُنصّ على خلاف ذلك، ونماذج الرموز مرخّصة بموجب ترخيص Apache 2.0. للاطّلاع على التفاصيل، يُرجى مراجعة سياسات موقع Google Developers. إنّ Java هي علامة تجارية مسجَّلة لشركة Oracle و/أو شركائها التابعين.
تاريخ التعديل الأخير: 2025-07-26 (حسب التوقيت العالمي المتفَّق عليه)
[null,null,["تاريخ التعديل الأخير: 2025-07-26 (حسب التوقيت العالمي المتفَّق عليه)"],[[["\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."]]
