ActiveUI

ActiveUI

  • User Guide
  • Developer Documentation

›Reference

About

  • Introduction
  • Changelog

Getting Started

  • Step by Step
  • Development Environment
  • Artifacts
  • ActiveUI Application
  • Usage as an npm Dependency
  • Initialization
  • Project Architecture

Guides

  • Adding Servers
  • Authentication
  • Bookmark favorites
  • Charts
  • Configuring Widget Handlers and Actions
  • Container
  • Custom UI components with Ant Design
  • Data manipulation
  • Debugging
  • Deployment
  • Internationalization
  • MDX Manipulation
  • Plugins
  • Reporting
  • Settings
  • Tabular View and Pivot Tables
  • Testing

Reference

  • SDK API
  • Default Widget Configurations
  • Plugins
  • Settings

Advanced

  • Content Server Setup
  • Experimental Features
  • Maven Integration
  • Offline Installation
  • Script-based Integration

Default Widget Configurations

Together with settings, you can modify a widget's configuration to control how it looks and behaves within your application.

Below are the default configuration which define the initial configuration for each widget. This initial configuration is used when adding a new widget through the widget chooser of the home view, or the "Add Widget" popup. You can use the Bookmark Favorites mechanism to define your own initial configuration, and use it instead of the default one when adding a new widget.

Each configuration below implements the ContainerValue type. The body attribute is specific to each widget type. In particular, MDX-based widget will store query related attributes (such as MDX, context values, lazy loading configuration, update mode...) directly inside body or body.layers for chart: see MdxQueryDescription

activemonitor-alert-list

{
  "containerKey": "activemonitor-alert-list",
  "showTitleBar": true,
  "style": {},
  "body": {
    "tabularView": {
      "columnOrder": {
        "key": "original"
      },
      "columns": [
        {
          "key": "id",
          "width": 55
        },
        {
          "key": "site",
          "width": 325
        },
        {
          "hide": true,
          "key": "content"
        },
        {
          "hide": true,
          "key": "eventId"
        },
        {
          "hide": true,
          "key": "monitorId"
        },
        {
          "key": "start",
          "width": 120
        },
        {
          "hide": true,
          "key": "stop",
          "width": 120
        },
        {
          "key": "title",
          "width": 250
        },
        {
          "hide": true,
          "key": "id"
        },
        {
          "key": "sender",
          "width": 130
        },
        {
          "key": "__rowActions__",
          "pinned": true,
          "width": 33
        }
      ],
      "columnsGroups": [
        {
          "captionProducer": "firstColumn",
          "cellFactory": "relative-time",
          "selector": {
            "args": {
              "pattern": "start|stop",
              "singleCells": true
            },
            "key": "regexp"
          }
        }
      ],
      "defaultOptions": {
        "width": 100
      },
      "lineNumbers": false,
      "selectionHandler": "empty"
    }
  }
}

activemonitor-messages

{
  "containerKey": "activemonitor-messages",
  "showTitleBar": true,
  "style": {},
  "body": {
    "tabularView": {
      "columnOrder": {
        "key": "original"
      },
      "columns": [
        {
          "key": "title",
          "width": 250
        },
        {
          "hide": true,
          "key": "id"
        },
        {
          "key": "sender",
          "width": 130
        },
        {
          "key": "__rowActions__",
          "pinned": true,
          "width": 33
        }
      ],
      "columnsGroups": [
        {
          "captionProducer": {
            "args": {
              "caption": "time"
            },
            "key": "simple"
          },
          "cellFactory": "relative-time",
          "selector": {
            "args": {
              "pattern": "time"
            },
            "key": "regexp"
          }
        }
      ],
      "defaultOptions": {
        "width": 100
      },
      "lineNumbers": false,
      "rowActions": [
        "select-message"
      ],
      "rowStyle": [
        "inbox"
      ],
      "selectionHandler": "empty"
    }
  }
}

activemonitor-single-alert

{
  "containerKey": "activemonitor-single-alert",
  "showTitleBar": true,
  "style": {}
}

bookmark-tree

{
  "body": {
    "configuration": {
      "handlers": {
        "click": [
          "load-bookmark"
        ],
        "contextmenu": [
          "load-bookmark",
          "create-folder",
          "rename-server",
          "delete-server",
          "edit-bookmark",
          "delete-bookmark",
          "add-to-favorites",
          "separator",
          "debug-widget-state"
        ],
        "dblclick": [
          "toggle-tree-node"
        ],
        "mouseenter": [
          "tree-tooltip-show"
        ],
        "mouseleave": [
          "hide-tooltip"
        ]
      }
    }
  },
  "containerKey": "bookmark-tree",
  "showTitleBar": true,
  "style": {}
}

chart

{
  "body": {
    "layers": [
      {
        "configuration": {
          "elementStylers": [
            "selection-highlight"
          ]
        }
      }
    ]
  },
  "containerKey": "chart",
  "showTitleBar": true,
  "style": {}
}

context-values

{
  "containerKey": "context-values",
  "showTitleBar": true,
  "style": {}
}

dashboard

{
  "body": {
    "content": [],
    "layout": {
      "direction": "row"
    }
  },
  "containerKey": "dashboard",
  "showTitleBar": true,
  "style": {
    "head": {
      "all": {
        "borderBottom": null
      }
    }
  }
}

discovery-tree

{
  "body": {},
  "containerKey": "discovery-tree",
  "showTitleBar": true,
  "style": {}
}

drillthrough

{
  "body": {
    "configuration": {
      "drillthrough": {
        "lineNumbers": true,
        "statisticsShown": true
      }
    }
  },
  "containerKey": "drillthrough",
  "showTitleBar": true,
  "style": {}
}

filters

{
  "containerKey": "filters",
  "showTitleBar": true,
  "style": {}
}

http

{
  "containerKey": "http",
  "showTitleBar": true,
  "style": {}
}

mdx-editor

{
  "containerKey": "mdx-editor",
  "showTitleBar": true,
  "style": {}
}

activemonitor-monitor-list

{
  "containerKey": "activemonitor-monitor-list",
  "showTitleBar": true,
  "style": {}
}

activemonitor-monitor-view

{
  "containerKey": "activemonitor-monitor-view",
  "showTitleBar": true,
  "style": {},
  "body": {
    "config": {
      "readOnly": false
    },
    "source": {
      "viewMode": "edit"
    }
  }
}

parameter-list

{
  "body": {
    "configuration": {
      "summary": {
        "tabular": {
          "cellEditors": [
            "parameter-value-editor-in-parameter-list",
            "parameter-timestamp-editor-in-parameter-list"
          ],
          "columnOrder": "original",
          "columns": [
            {
              "hide": true,
              "key": "id",
              "width": 40
            },
            {
              "hide": true,
              "key": "auditId",
              "width": 70
            },
            {
              "hide": true,
              "key": "pending",
              "width": 67
            },
            {
              "hide": true,
              "key": "hasPendingModification",
              "width": 67
            },
            {
              "hide": true,
              "key": "creator"
            },
            {
              "hide": true,
              "key": "createdAt"
            },
            {
              "hide": true,
              "key": "properties"
            },
            {
              "key": "value",
              "width": 70
            },
            {
              "key": "activation",
              "width": 175
            },
            {
              "key": "expiration",
              "width": 175
            }
          ],
          "columnsGroups": [],
          "lineNumbers": false,
          "rowActions": [
            "create-from-parameter",
            "delete-parameter"
          ],
          "rowStyle": [
            "pending-parameter",
            "modified-parameter"
          ]
        }
      }
    }
  },
  "containerKey": "parameter-list",
  "showTitleBar": true,
  "style": {}
}

pivot-table

{
  "body": {
    "configuration": {
      "shouldRenderWizard": true,
      "tabular": {
        "addButtonFilter": "numeric",
        "columnsGroups": [
          {
            "captionProducer": "firstColumn",
            "cellFactory": "kpi-status",
            "selector": "kpi-status"
          },
          {
            "captionProducer": "firstColumn",
            "cellFactory": "lookup",
            "selector": "lookup"
          },
          {
            "captionProducer": "expiry",
            "cellFactory": "expiry",
            "selector": "kpi-expiry"
          },
          {
            "captionProducer": "columnMerge",
            "cellFactory": {
              "args": {
                "automaticExpansion": true
              },
              "key": "treeCells"
            },
            "selector": "member"
          }
        ],
        "defaultOptions": {},
        "hideAddButton": true,
        "lineNumbers": true,
        "pinnedHeaderSelector": "member",
        "sortingMode": "non-breaking",
        "statisticsShown": true
      }
    },
    "ranges": {
      "column": {
        "chunkSize": 50,
        "thresholdPercentage": 0.2
      },
      "row": {
        "chunkSize": 2000,
        "thresholdPercentage": 0.1
      }
    }
  },
  "containerKey": "pivot-table",
  "showTitleBar": true,
  "style": {}
}

quick-filter

{
  "body": {
    "configuration": {
      "displayedAsSelect": true
    },
    "filterKey": "explicit"
  },
  "containerKey": "quick-filter",
  "showTitleBar": false,
  "style": {}
}

rich-text-editor

{
  "body": {
    "content": "## Markdown Text Editor\n\nIt handles:\n- **bold text**\n- *or in italics*\n- `code`\n- and a lot of other things such as tables and images.\n\nSee the entire list of supported features at https://markdown-it.github.io/.\n",
    "editingMode": "edit",
    "renderer": "markdown"
  },
  "containerKey": "rich-text-editor",
  "showTitleBar": true,
  "style": {}
}

rules-editor

{
  "body": {
    "rules-editor-component": {
      "tabular-rules-summary": {
        "columns": [
          {
            "key": "__rowActions__",
            "width": 34
          },
          {
            "key": "c-workflow-tags-workflows",
            "width": 150
          }
        ],
        "defaultOptions": {
          "width": 70
        },
        "lineNumbers": false
      },
      "user-inputs": {}
    }
  },
  "containerKey": "rules-editor",
  "showTitleBar": true,
  "style": {}
}

featured-values

{
  "body": {
    "configuration": {
      "featuredValues": {}
    },
    "ranges": {
      "column": {
        "chunkSize": 20,
        "thresholdPercentage": 0.1
      },
      "row": {
        "chunkSize": 20,
        "thresholdPercentage": 0.1
      }
    }
  },
  "containerKey": "featured-values",
  "showTitleBar": true,
  "style": {}
}

single-value

{
  "actions": [
    "save",
    "save-as",
    "toggle-filters",
    "clear-dock",
    "toggle-dock-title-bar",
    "remove-dock"
  ],
  "body": {
    "configuration": {
      "singleValue": {
        "handlers": {
          "contextmenu": [
            "edit-single-value",
            "conditional-formatting",
            "separator",
            "refresh-query",
            {
              "args": {
                "caption": {
                  "textPath": "tabular.contextMenu.updateMode.change"
                },
                "iconSrcKey": "docks.queryRate",
                "menuItems": [
                  {
                    "args": {
                      "modes": [
                        "realTime"
                      ]
                    },
                    "key": "update-query-mode"
                  },
                  {
                    "args": {
                      "modes": [
                        "refresh-periodically"
                      ],
                      "refreshInterval": 10
                    },
                    "key": "update-query-mode"
                  },
                  {
                    "args": {
                      "modes": [
                        "once"
                      ]
                    },
                    "key": "update-query-mode"
                  }
                ]
              },
              "key": "sub-menu"
            },
            "query-editor",
            "debug-widget-state",
            "copy-table",
            "widget-csv-export"
          ],
          "mouseenter": [
            "single-value-tooltip-show"
          ],
          "mouseleave": [
            "hide-tooltip"
          ]
        }
      }
    }
  },
  "containerKey": "single-value",
  "quickActions": [
    "update-query-mode"
  ],
  "showTitleBar": true,
  "style": {}
}

static-single-value

{
  "actions": [
    "save",
    "save-as",
    "clear-dock",
    "toggle-dock-title-bar",
    "remove-dock"
  ],
  "body": {
    "configuration": {
      "handlers": {
        "contextmenu": [
          "debug-widget-state",
          "copy-table",
          "widget-csv-export"
        ],
        "mouseenter": [
          "featured-values-tooltip-show"
        ],
        "mouseleave": [
          "hide-tooltip"
        ]
      }
    },
    "content": [],
    "headers": []
  },
  "containerKey": "static-single-value",
  "showTitleBar": true,
  "style": {}
}

static-tabular-view

{
  "body": {
    "configuration": {
      "defaultOptions": {},
      "lineNumbers": true,
      "sortingMode": "breaking",
      "statisticsShown": true
    },
    "content": [],
    "headers": []
  },
  "containerKey": "static-tabular-view",
  "showTitleBar": true,
  "style": {}
}

tabular-view

{
  "body": {
    "configuration": {
      "tabular": {
        "columnsGroups": [
          {
            "captionProducer": "firstColumn",
            "cellFactory": "kpi-status",
            "selector": "kpi-status"
          },
          {
            "captionProducer": "firstColumn",
            "cellFactory": "lookup",
            "selector": "lookup"
          },
          {
            "captionProducer": "expiry",
            "cellFactory": "expiry",
            "selector": "kpi-expiry"
          }
        ],
        "defaultOptions": {},
        "lineNumbers": true,
        "sortingMode": "breaking",
        "statisticsShown": true
      }
    },
    "ranges": {
      "column": {
        "chunkSize": 50,
        "thresholdPercentage": 0.2
      },
      "row": {
        "chunkSize": 2000,
        "thresholdPercentage": 0.1
      }
    }
  },
  "containerKey": "tabular-view",
  "showTitleBar": true,
  "style": {}
}

wizard

{
  "containerKey": "wizard",
  "showTitleBar": true,
  "style": {}
}
← SDK APIPlugins →
  • activemonitor-alert-list
  • activemonitor-messages
  • activemonitor-single-alert
  • bookmark-tree
  • chart
  • context-values
  • dashboard
  • discovery-tree
  • drillthrough
  • filters
  • http
  • mdx-editor
  • activemonitor-monitor-list
  • activemonitor-monitor-view
  • parameter-list
  • pivot-table
  • quick-filter
  • rich-text-editor
  • rules-editor
  • featured-values
  • single-value
  • static-single-value
  • static-tabular-view
  • tabular-view
  • wizard
Copyright © 2021 ActiveViam