Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • name* (string) – Name of the button (unique within a partition).

  • labelTranslations (Map) – Text on the action button, provided potentially in several languages. For example { "" : "Create Watcher" }.

  • page* (string) – Page on which the button should be displayed. It is a constant’s value from AppPages. For example dataAnalyzerPage or dashboardPage.

  • order (integer) – If there are multiple buttons on the same page, this can be used to provide specific order. When not specified, ordering is done by labelTranslations.

  • conditionToShow (string) – Condition expression which decides if the button should be shown. Written in JavaScript, expected to return a Boolean value. The properties are in the placeholder {}, and will be replaced in the frontend code during runtime. Examples:

    • Code Block
      ["PAQUERY", "MATRIX"].includes({resultType}) || {result.generatedSavedChart.series.length} > 0
    • Code Block
      {typedId} != null
    • Code Block
      ["DATATABLE"].includes({chartDefinition.chartType}) && {chartDefinition.series.length > 0}
  • contextLinking* (Map) – All basic context linking parameters, such as targetPage, targetPageEntityType, targetPageInputs, targetPageFields, etc. For details see Context Linking Parameters. The variables placeholders will be provided from the frontend.

...