Skip to main content

Interface: MonitorUIConfig

Defined in: electron/services/monitoring/monitorUiConfig.d.ts:11

Extended UI configuration used by the renderer when displaying monitors.

Remarks​

Augments the shared monitor type configuration with additional metadata that is only meaningful to the desktop renderer layer.

Hierarchy​

View Summary

Extends​

Properties​

chartFormatters?​

optional chartFormatters?: {
  advanced?: boolean;
  responseTime?: boolean;
  uptime?: boolean;
};

Defined in: electron/services/monitoring/monitorUiConfig.d.ts:13

Chart data formatters

advanced?​

optional advanced?: boolean;

responseTime?​

optional responseTime?: boolean;

uptime?​

optional uptime?: boolean;

detailFormats?​

optional detailFormats?: {
  analyticsLabel?: string;
} & {
  historyDetail?: (details: string) => string;
};

Defined in: electron/services/monitoring/monitorUiConfig.d.ts:19

Detail formats with optional history formatter

Type Declaration​

analyticsLabel?​
optional analyticsLabel?: string;

Format for analytics display

Type Declaration​

historyDetail?​
optional historyDetail?: (details: string) => string;
Parameters​
details​

string

Returns​

string

Overrides​

SharedMonitorUiConfig.detailFormats;

detailLabelFormatter?​

optional detailLabelFormatter?: string;

Defined in: electron/services/monitoring/monitorUiConfig.d.ts:23

Detail label formatter function name

display?​

optional display?: {
  showAdvancedMetrics?: boolean;
  showUrl?: boolean;
} & {
  showPort?: boolean;
};

Defined in: electron/services/monitoring/monitorUiConfig.d.ts:25

Display preferences including optional port display

Type Declaration​

showAdvancedMetrics?​
optional showAdvancedMetrics?: boolean;
showUrl?​
optional showUrl?: boolean;

Type Declaration​

showPort?​
optional showPort?: boolean;

Overrides​

SharedMonitorUiConfig.display;

formatDetail?​

optional formatDetail?: (details: string) => string;

Defined in: electron/services/monitoring/monitorUiConfig.d.ts:29

Function to format detail display in history

Parameters​

details​

string

Returns​

string

formatTitleSuffix?​

optional formatTitleSuffix?: (monitor: Monitor) => string;

Defined in: electron/services/monitoring/monitorUiConfig.d.ts:31

Function to format title suffix for history charts

Parameters​

monitor​

Monitor

Returns​

string

helpTexts?​

optional helpTexts?: {
  primary?: string;
  secondary?: string;
};

Defined in: shared/types/monitorTypes.ts:54

Help text for form fields

primary?​

optional primary?: string;

secondary?​

optional secondary?: string;

Inherited from​

SharedMonitorUiConfig.helpTexts;

supportsAdvancedAnalytics?​

optional supportsAdvancedAnalytics?: boolean;

Defined in: shared/types/monitorTypes.ts:59

Whether this monitor type supports advanced analytics

Inherited from​

SharedMonitorUiConfig.supportsAdvancedAnalytics;

supportsResponseTime?​

optional supportsResponseTime?: boolean;

Defined in: shared/types/monitorTypes.ts:61

Whether this monitor type supports response time analytics

Inherited from​

SharedMonitorUiConfig.supportsResponseTime;