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 KaTex fonts
  • 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

  • API Reference
  • Default Widget Bookmarks
  • Plugins
  • Settings

Advanced

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

Default Widget Bookmarks

In addition to the use of settings, a widget's configuration can be modified to control how it looks and behaves within your application.

The default bookmarks which define the initial configuration for each widget are shown below. 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 bookmark, 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 widgets 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

Retrieving the default configuration

The SDK now exports these configurations as part of the exported container plugins. You can therefore gain a reference to these configurations by importing the desired plugin in your project as such:

import {pluginContainerPivotTable} from '@activeviam/activeui-sdk';

const pivotTableDefaultConfiguration =
  pluginContainerPivotTable.staticProperties.initialValue;

This is useful when building your own pivot tables using the Container API.

Note: these being statically exported, will always be set to the default configuration as written in the SDK. They will not reflect any further customization made.

Overriding a widget's default configuration

You can use the widgets.${containerKey}.initialValue settings to override each container's default configuration by supplying a partial override. For example, let's say you would like every Pivot Table to display line numbers which has been disabled by default in the SDK:

createActiveUI({
  defaultSettings: {
    'widgets.pivot-table.initialValue': {
      body: {
        configuration: {
          tabular: {
            lineNumbers: true,
          },
        },
      },
    },
  },
});

Note: this will affect widgets created via the widget chooser and the widget builder api. When using a Container it is your responsibility to provide a working configuration suiting your needs.

List of Default Widget's bookmarks

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
      },
      "hideAddButton": true,
      "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
      },
      "hideAddButton": true,
      "lineNumbers": false,
      "rowActions": [
        "select-message"
      ],
      "rowStyle": [
        "inbox"
      ],
      "selectionHandler": "empty"
    }
  }
}

activemonitor-single-alert

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

bookmark-tree

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

chart

{
  "body": {
    "configuration": {}
  },
  "containerKey": "chart",
  "showTitleBar": true,
  "style": {}
}

content-editor

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

context-values

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

dashboard

{
  "body": {
    "pages": [
      {
        "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": {
        "hideAddButton": true,
        "lineNumbers": true,
        "statisticsShown": true
      }
    }
  },
  "containerKey": "drillthrough",
  "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": {}
}

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": [],
          "hideAddButton": true,
          "lineNumbers": false,
          "rowActions": [
            "create-from-parameter",
            "delete-parameter"
          ],
          "rowStyle": [
            "pending-parameter",
            "modified-parameter"
          ]
        }
      }
    }
  },
  "containerKey": "parameter-list",
  "showTitleBar": true,
  "style": {}
}

pivot-table

{
  "body": {
    "configuration": {
      "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": {},
              "key": "treeCells"
            },
            "selector": "member"
          }
        ],
        "cellRenderers": [
          "tree-layout"
        ],
        "defaultOptions": {},
        "hideAddButton": true,
        "pinnedHeaderSelector": "member",
        "sortingMode": "non-breaking",
        "statisticsShown": true,
        "expansion": {
          "automaticExpansion": 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": true,
  "style": {}
}

rich-text-editor

{
  "body": {
    "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": {}
}

state-editor

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

static-tabular-view

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

style-editor

{
  "containerKey": "style-editor",
  "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": {},
        "hideAddButton": true,
        "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": {}
}

widget-chooser

{
  "containerKey": "widget-chooser",
  "showTitleBar": true,
  "style": {}
}
← API ReferencePlugins →
  • Retrieving the default configuration
  • Overriding a widget's default configuration
  • List of Default Widget's bookmarks
    • activemonitor-alert-list
    • activemonitor-messages
    • activemonitor-single-alert
    • bookmark-tree
    • chart
    • content-editor
    • context-values
    • dashboard
    • discovery-tree
    • drillthrough
    • featured-values
    • filters
    • http
    • mdx-editor
    • activemonitor-monitor-list
    • activemonitor-monitor-view
    • parameter-list
    • pivot-table
    • quick-filter
    • rich-text-editor
    • rules-editor
    • state-editor
    • static-tabular-view
    • style-editor
    • tabular-view
    • widget-chooser
Copyright © 2023 ActiveViam