Skip to content

RemotePluginListItem ​

Properties ​

author ​

author: null | string


created_at ​

created_at: number


description ​

description: string


homepage ​

homepage: null | string


manifest ​

manifest: object

author? ​

optional author: string

Author of the plugin

author_email? ​

optional author_email: string

Author email of the plugin

capabilities? ​

optional capabilities: ("query:read" | "query:write" | "header:read" | "header:write" | "environment:read" | "environment:write")[]

Specifies the capabilities (functionalities) available to the plugin. In the future, this would be used to request the necessary permissions from the user

description ​

description: string

Description of the plugin

display_name ​

display_name: string

Display name of the plugin

manifest_version ​

manifest_version: 1 | 2

Version of manifest. Should be 1 or 2.

name ​

name: string

Name of the plugin

plugin_class? ​

optional plugin_class: string

This specifies the class name of the plugin, for discovery

scripts ​

scripts: string[]

An array containing the list of scripts (relative to the plugin root directory) that need to be loaded for the plugin to function.

styles? ​

optional styles: string[]

An array containing the list of styles (relative to the plugin root directory) that need to be loaded for the plugin to function.

type? ​

optional type: "header" | "sidebar" | "action_button"

This specifies the type of plugin. This determines how the plugin would interact with Altair. For now there is just the typical plugin type (registered plugin class). In the future, this would include other plugins like themes.

version ​

version: string

Version of the plugin


name ​

name: string


summary ​

summary: null | string


updated_at ​

updated_at: number


version ​

version: string