Class Template

Hierarchy

TagoIOModule<GenericModuleParams>
- Template

Index

Constructors

Methods

generateTemplate getTemplate installTemplate

Constructors

constructor

new Template(params: GenericModuleParams): Template
Parameters
- params: GenericModuleParams
Returns Template
Inherited from TagoIOModule<GenericModuleParams>.constructor
- Defined in common/TagoIOModule.ts:75

Methods

generateTemplate

generateTemplate(
template: TemplateObjDashboard | TemplateObjAnalysis,
): Promise<string>
Parameters
- template: TemplateObjDashboard | TemplateObjAnalysis
Returns Promise<string>
Description
Creates a new template from a dashboard or analysis configuration.

See
https://help.tago.io/portal/en/kb/articles/518-distributing-dashboards Distributing Dashboards
Example
```
const resources = new Resources({ token: "YOUR-PROFILE-TOKEN" });
const result = await resources.template.generateTemplate({
  name: "My Dashboard Template",
  dashboard: "dashboard-id-123"
});
console.log(result);
```
- Defined in modules/Resources/Template.ts:31

getTemplate

getTemplate(templateID: string): Promise<TemplateObj>
Parameters
- templateID: string
Returns Promise<TemplateObj>
Description
Retrieves detailed information about a specific template.

See
https://help.tago.io/portal/en/kb/articles/518-distributing-dashboards Distributing Dashboards
Example
```
const resources = new Resources({ token: "YOUR-PROFILE-TOKEN" });
const template = await resources.template.getTemplate("template-id-123");
console.log(template); // { type: 'dashboard', name: 'My Dashboard Template', ... }
```
- Defined in modules/Resources/Template.ts:78

installTemplate

installTemplate(
templateID: string,
installParams?: TemplateInstallParams,
): Promise<TemplateInstallReturn>
Parameters
- templateID: string
- OptionalinstallParams: TemplateInstallParams
Returns Promise<TemplateInstallReturn>
Description
Installs a template into the account, creating either a dashboard or analysis from the template configuration.

See
https://help.tago.io/portal/en/kb/articles/518-distributing-dashboards Distributing Dashboards
Example
```
const resources = new Resources({ token: "YOUR-PROFILE-TOKEN" });
const result = await resources.template.installTemplate("template-id-123");
console.log(result); // { dashboard: 'dashboard-id-123' }
```
- Defined in modules/Resources/Template.ts:53