Announcement: All noncommercial projects registered to use Earth Engine before
April 15, 2025 must
verify noncommercial eligibility to maintain Earth Engine access.
ui.Checkbox.setValue
Stay organized with collections
Save and categorize content based on your preferences.
Sets whether the checkbox is checked.
Returns this checkbox.
Usage | Returns | Checkbox.setValue(value, trigger) | ui.Checkbox |
Argument | Type | Details | this: ui.checkbox | ui.Checkbox | The ui.Checkbox instance. |
value | Boolean | Whether the checkbox is checked. A null value indicates the checkbox is in an indeterminate state. |
trigger | Boolean, optional | Whether to trigger onChange callbacks when the checked property changes. Defaults to true. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2023-10-06 UTC.
[null,null,["Last updated 2023-10-06 UTC."],[[["\u003cp\u003eThe \u003ccode\u003esetValue\u003c/code\u003e method allows you to set the checked state of a checkbox, including an indeterminate state using a null value.\u003c/p\u003e\n"],["\u003cp\u003eThis method also provides an optional \u003ccode\u003etrigger\u003c/code\u003e parameter to control the execution of onChange callbacks, defaulting to true for automatic triggering.\u003c/p\u003e\n"],["\u003cp\u003eUsing \u003ccode\u003esetValue\u003c/code\u003e, you receive the ui.Checkbox instance in return, allowing for method chaining.\u003c/p\u003e\n"]]],["The `Checkbox.setValue` method sets the checked state of a checkbox. It accepts a boolean `value` to indicate if the checkbox is checked or `null` for an indeterminate state. An optional boolean `trigger` determines whether to execute `onChange` callbacks when the checked state changes, defaulting to `true`. The method returns the `ui.Checkbox` instance, allowing for method chaining.\n"],null,["# ui.Checkbox.setValue\n\n\u003cbr /\u003e\n\nSets whether the checkbox is checked.\n\n\u003cbr /\u003e\n\nReturns this checkbox.\n\n| Usage | Returns |\n|-----------------------------------------|-------------|\n| Checkbox.setValue`(value, `*trigger*`)` | ui.Checkbox |\n\n| Argument | Type | Details |\n|---------------------|-------------------|----------------------------------------------------------------------------------------------------|\n| this: `ui.checkbox` | ui.Checkbox | The ui.Checkbox instance. |\n| `value` | Boolean | Whether the checkbox is checked. A null value indicates the checkbox is in an indeterminate state. |\n| `trigger` | Boolean, optional | Whether to trigger onChange callbacks when the checked property changes. Defaults to true. |"]]