org.visallo.admin

Add admin tools to admin pane

Renders a new link to an admin form in the admin list (opened from menubar icon.)

The component is placed in a pane next to the admin list and automatically will scroll if the height is larger than window.

One of Component, componentPath, or url is required.

Registration

registry.registerExtension("org.visallo.admin", config)

Source:
Tutorials:
See:
Configuration Properties:
Name Type Attributes Description
Component Component <optional>
componentPath string <optional>

Path to org.visallo.admin~Component

url string <optional>

Open a url in a new window instead of rendering a form

section string

The section to place new admin link. Either existing or new group

name string

The title of the admin link

subtitle string

The subtitle of the admin link displayed below name

requiredPrivilege string | requiredPrivilege <optional>

Only show link if user has the given privilege

options object <optional>
Properties
Name Type Attributes Description
sortHint number <optional>

A number indicating the admin tool's position within the section. If not included, admin items will be sorted within a section by name.

Validation Function

Extensions registered must pass this validation check to be used.

function extensionValidator(e) {
    return (e.Component || e.componentPath || e.url) && e.section && e.name && e.subtitle;
}

Type Definitions

Component

Source:

FlightJS or React component displaying the admin interface.

Properties:
Name Type Description
data object

Admin-tool specific data passed from router

requiredPrivilege(userPrivileges) → {boolean}

Source:
Parameters:
Name Type Description
userPrivileges Array.<object>

The current users privileges

Returns:

If the admin tool should be shown to user

Type
boolean