DashboardPluginDescriptor

Home > @gooddata/sdk-ui-dashboard > DashboardPluginDescriptor

DashboardPluginDescriptor interface

Basic set of information about a Dashboard plugin.

Signature:

export interface DashboardPluginDescriptor 

Properties

Property	Modifiers	Type	Description
author	readonly	string	Author of the plugin.
compatibility?	readonly	string	(Optional) Specify compatibility of the plugin and Dashboard component version.
debugName?	readonly	string	(Optional) Developer-assigned name of the plugin that will be used.
displayName	readonly	string	Specify human-readable name of the plugin.
longDescription?	readonly	string	(Optional) Human-readable long description of the plugin.
maxEngineVersion?	readonly	string	(Optional) Greatest version of the dashboard engine that this plugin supports.
minEngineVersion	readonly	string	Minimum version of dashboard engine that this plugin supports.
shortDescription?	readonly	string	(Optional) Specify human-readable short description of the plugin.
version	readonly	string	Version of the plugin.