createV1Plugin()

createV1Plugin(name: string, manifest: object): object

Parameters

• name: string

• manifest

• manifest.author?: string= undefined

Author of the plugin

• manifest.author_email?: string= undefined

Author email of the plugin

• manifest.capabilities?: ("query:read" | "query:write" | "header:read" | "header:write" | "environment:read" | "environment:write")[]= undefined

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

• manifest.description: string= undefined

Description of the plugin

• manifest.display_name: string= undefined

Display name of the plugin

• manifest.manifest_version: 1 | 2= undefined

Version of manifest. Should be 1 or 2.

• manifest.name: string= undefined

Name of the plugin

• manifest.plugin_class?: string= undefined

This specifies the class name of the plugin, for discovery

• manifest.scripts: string[]= undefined

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

• manifest.styles?: string[]= undefined

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

• manifest.type?: "header" | "sidebar" | "action_button"= undefined

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.

• manifest.version: string= undefined

Version of the plugin

Returns

object

capabilities

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

display_name

display_name: string

manifest

manifest: object

manifest.author?

optional author: string

Author of the plugin

manifest.author_email?

optional author_email: string

Author email of the plugin

manifest.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

manifest.description

description: string

Description of the plugin

manifest.display_name

display_name: string

Display name of the plugin

manifest.manifest_version

manifest_version: 1 | 2

Version of manifest. Should be 1 or 2.

manifest.name

name: string

Name of the plugin

manifest.plugin_class?

optional plugin_class: string

This specifies the class name of the plugin, for discovery

manifest.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.

manifest.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.

manifest.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.

manifest.version

version: string

Version of the plugin

name

name: string

plugin_class?

optional plugin_class: string

type?

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