Class AzureDashboardRenderer

Renders Azure Portal dashboard templates from YAML pane definitions into JSON

Reads pane templates from a configurable template directory
Compiles templates using Lodash template interpolation with {{}} delimiters
Validates required variables and properties before rendering
Assembles multiple panes into a single dashboard JSON structure

Implements

DashboardRenderer

Index

Constructors

Properties

outputDir paneTemplatePath

Methods

getMissingProperties getMissingVariables getPaneId render renderToFile

Constructors

constructor

new AzureDashboardRenderer(
basePath?: string,
outputDir?: string,
): AzureDashboardRenderer
Parameters
- OptionalbasePath: string
  optional base path for pane templates; defaults to '/template/dashboard'
- OptionaloutputDir: string
  optional output directory for rendered files; defaults to '/.artifacts'
Returns AzureDashboardRenderer
- Defined in packages/azure/src/services/portal/renderer.ts:30

Properties

`Readonly`outputDir

outputDir: string

Absolute path to the directory where rendered dashboard files are written

`Readonly`paneTemplatePath

paneTemplatePath: string

Absolute path to the directory containing pane YAML templates

Methods

getMissingProperties

getMissingProperties(
template: PaneTemplate,
properties?: Record<string, any> | undefined,
): MissingKeys
Parameters
- template: PaneTemplate
  the pane template defining required properties
- properties: Record<string, any> | undefined = []
  the provided properties to check against the template
Returns MissingKeys
an object indicating which required property keys are missing
- Defined in packages/azure/src/services/portal/renderer.ts:53

getMissingVariables

getMissingVariables(
template: PaneTemplate,
variables: Record<string, any>,
): MissingKeys
Parameters
- template: PaneTemplate
  the pane template defining required variables
- variables: Record<string, any>
  the provided variables to check against the template
Returns MissingKeys
an object indicating which required variable keys are missing
- Defined in packages/azure/src/services/portal/renderer.ts:67

`Protected`getPaneId

getPaneId(id: string): PaneTemplate
Parameters
- id: string
  the pane template identifier (corresponds to a YAML filename without extension)
Returns PaneTemplate
the parsed pane template including dimensions, properties, variables, and template content
- Defined in packages/azure/src/services/portal/renderer.ts:40

render

render(params: RenderParams): string
Parameters
- params: RenderParams
  render parameters including panes, variables, properties, and optional filter settings
Returns string
the rendered dashboard JSON string

Throws
TemplateError if required variables or properties are missing
Implementation of DashboardRenderer.render
- Defined in packages/azure/src/services/portal/renderer.ts:81

renderToFile

renderToFile(filename: string, params: RenderParams): string
Parameters
- filename: string
  the output filename (used as '.tftpl')
- params: RenderParams
  render parameters including panes, variables, properties, and optional filter settings
Returns string
the absolute path to the rendered output file
Implementation of DashboardRenderer.renderToFile
- Defined in packages/azure/src/services/portal/renderer.ts:216