@oriolrius/grafana-business-text/src/types/panel.ts

Data-driven text with Markdown and Handlebars support for Grafana

import { DataFrame, PanelData } from '@grafana/data';

import { DataSourcePanelOptions } from './dataSource';
import { EditorOptions } from './editor';
import { PartialItemConfig, Resource } from './resource';

/**
 * Editor Types
 */
export enum EditorType {
  AFTER_RENDER = 'afterRender',
  DEFAULT = 'default',
  HELPERS = 'helpers',
  STYLES = 'styles',
}

/**
 * Render Mode
 */
export enum RenderMode {
  EVERY_ROW = 'everyRow',
  ALL_ROWS = 'allRows',
  DATA = 'data',
}

/**
 * Panel Options
 */
export interface PanelOptions {
  /**
   * Content
   *
   * @type {string}
   */
  content: string;

  /**
   * Default Content
   *
   * @type {string}
   */
  defaultContent: string;

  /**
   * Render Mode
   *
   * @type {RenderMode}
   */
  renderMode: RenderMode;

  /**
   * Editors to Display
   *
   * @type {EditorType[]}
   */
  editors: EditorType[];

  /**
   * Editor
   *
   * @type {EditorOptions}
   */
  editor: EditorOptions;

  /**
   * Helpers
   *
   * @type {string}
   */
  helpers: string;

  /**
   * Helpers Remote URL
   *
   * @type {string}
   */
  helpersRemoteUrl: string;

  /**
   * After Render Remote URL
   *
   * @type {string}
   */
  afterRenderRemoteUrl: string;

  /**
   * Styles
   *
   * @type {string}
   */
  styles: string;

  /**
   * Styles Remote URL
   *
   * @type {string}
   */
  stylesRemoteUrl: string;

  /** Status
   *
   * @type {string};
   */
  status: string;

  /**
   * External Styles
   *
   * @type {Resource[]}
   */
  externalStyles: Resource[];

  /**
   * Wrap
   *
   * @type {boolean}
   */
  wrap: boolean;

  /**
   * After Render Function
   *
   * @type {string}
   */
  afterRender: string;

  /**
   * Content Partials
   *
   * @type {PartialItemConfig[]}
   */
  contentPartials: PartialItemConfig[];

  /**
   * Data Source Options
   *
   * @type {DataSourcePanelOptions}
   */
  dataSource: DataSourcePanelOptions;
}

/**
 * Row Item
 */
export interface RowItem {
  /**
   * HTML
   *
   * @type {string}
   */
  html: string;

  /**
   * Data
   *
   * @type {object | Array<object>}
   */
  data: object | object[];

  /**
   * Panel Data
   *
   * @type {PanelData}
   */
  panelData: PanelData;

  /**
   * Selected Data Frame
   *
   * @type {DataFrame}
   */
  dataFrame?: DataFrame;
}