Package com.onec.annotations

Annotation Interface DashboardWidget

@Deprecated(since="next", forRemoval=true) @Retention(RUNTIME) @Target(TYPE) @Repeatable(DashboardWidgets.class) public @interface DashboardWidget
Deprecated, for removal: This API element is subject to removal in a future version.
Declare dashboard widgets in a Page bean instead, e.g. 
  class DashboardPage implements Page {
      public String route() { return "/"; }
      public void compose(PageBuilder page) {
          page.widget("Recent invoices")
              .type("list").order(0).width("1/2")
              .document(Invoice.class)
              .maxItems(8);
      }
  }
As of the page/layout migration the dashboard is built from authored pages (surfaced through the DivKit home surface, e.g. /api/divkit/home); this annotation is no longer consulted when the configurer declares any widgets, and will be removed in the next release. (Note: there is no /api/ui/metadata/* REST endpoint — see the README/AGENTS.md for the real /api/... surface.)
Dashboard widget bound to a catalog, document, or register.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    title
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    String
    type
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    dateField
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    String[]
    extraConfig
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    String
    hint
    Deprecated, for removal: This API element is subject to removal in a future version.
    Optional help text, surfaced as a hoverable ? icon next to the widget title.
    int
    maxItems
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    int
    order
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    String
    titleField
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    String
    width
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Element Details

    • title

      String title
      Deprecated, for removal: This API element is subject to removal in a future version.

    • type

      String type
      Deprecated, for removal: This API element is subject to removal in a future version.

    • order

      int order
      Deprecated, for removal: This API element is subject to removal in a future version.
      Default:
      0

    • width

      String width
      Deprecated, for removal: This API element is subject to removal in a future version.
      Default:
      "1/3"

    • maxItems

      int maxItems
      Deprecated, for removal: This API element is subject to removal in a future version.
      Default:
      10

    • dateField

      String dateField
      Deprecated, for removal: This API element is subject to removal in a future version.
      Default:
      ""

    • titleField

      String titleField
      Deprecated, for removal: This API element is subject to removal in a future version.
      Default:
      ""

    • extraConfig

      String[] extraConfig
      Deprecated, for removal: This API element is subject to removal in a future version.
      Default:
      {}

    • hint

      String hint
      Deprecated, for removal: This API element is subject to removal in a future version.
      Optional help text, surfaced as a hoverable ? icon next to the widget title.
      Default:
      ""