Class Widget

  • Widget is a base class for all widgets.

  • Widgets can be added to a Card .

Widget

Base class for all widgets that can be added to a Card .

Widgets include:

Methods

Method Return type Brief description
Widget Adds the event action that can be performed on the widget.
Widget Sets the unique ID assigned that's used to identify the widget to be mutated.
Widget Sets the visibility of the widget.

Detailed documentation

add Event Action(eventAction)

Adds the event action that can be performed on the widget.

Parameters

Name Type Description
event Action
Event Action The Event Action to be added.

Return

Widget — The Object, for chaining.


set Id(id)

Sets the unique ID assigned that's used to identify the widget to be mutated. Widget mutation is only supported in Add-Ons.

Parameters

Name Type Description
id
String The id of the widget, with a limit of 64 characters and in format of `[a-zA-Z0-9-]+`.

Return

Widget — This object, for chaining.


set Visibility(visibility)

Sets the visibility of the widget. The default value is `VISIBLE`.

Parameters

Name Type Description
visibility
Visibility The Visibility of the widget.

Return

Widget — The Object, for chaining.

Design a Mobile Site
View Site in Mobile | Classic
Share by: