API Docs for: TWaver HTML5 5.7.5
Show:

twaver.AlarmSeverity Class

告警级别对象

这个类定义了电信拓扑中所有的告警级别。在TWaver中,当发生一个告警时,需要附带着告警的级别。告警级别的等级预示着告警的严重性。TWaver在这个类中预定义了六种告警级别,用户可以直接使用,也可以添加自己的告警级别。

每一种告警级别都有一个昵称,通常昵称是用一个简短的字母来表示,用于显示在告警冒泡中。每种告警级别还定义了告警颜色,用户可以更改默认告警级别的颜色。一旦告警级别的颜色发生改变时,所有显示这种告警的视图都会随之更改

Constructor

twaver.AlarmSeverity

(
  • value
  • name
  • nickName
  • color
  • [displayName]
)
twaver.AlarmSeverity

Parameters:

  • value String

    告警级别的值,值越大,告警级别越高

  • name String

    告警级别的名称

  • nickName String

    告警级别的昵称,用于显示在告警冒泡中

  • color String

    告警级别的颜色

  • [displayName] String optional

    告警级别显示的名称

Returns:

twaver.AlarmSeverity:

告警级别对象本身

Methods

twaver.AlarmSeverity.add

(
  • value
  • name
  • nickName
  • color
  • [displayName]
)
twaver.AlarmSeverity static

添加一个告警级别

Parameters:

  • value Number

    告警级别的值,值越大,告警级别越高

  • name String

    告警级别的名称

  • nickName String

    告警级别的昵称,用于显示在告警冒泡中

  • color String

    告警级别的颜色

  • [displayName] String optional

    告警级别显示的名称

Returns:

twaver.AlarmSeverity:

告警级别对象本身

twaver.AlarmSeverity.clear

() static

清除所有的告警级别

twaver.AlarmSeverity.compare

(
  • severity1
  • severity2
)
Number static

比较两种指定的告警级别的值:如果告警级别1大于告警级别2,返回1;如果告警级别1小于告警级别2,返回-1;如果相等,返回0

Parameters:

Returns:

Number:

如果告警级别1大于告警级别2,返回1;如果告警级别1小于告警级别2,返回-1;如果相等,返回0

twaver.AlarmSeverity.forEach

(
  • callbackFunction
  • [scope]
)
static

覆盖所有的告警级别

Parameters:

  • callbackFunction Function

    回调函数

  • [scope] Object optional

    回调函数的作用域,为空时指的是window

twaver.AlarmSeverity.getByName

(
  • name
)
twaver.AlarmSeverity static

通过告警级别的名称获取告警级别

Parameters:

  • name String

    告警级别的名称

Returns:

twaver.AlarmSeverity:

告警级别对象

twaver.AlarmSeverity.getByValue

(
  • value
)
twaver.AlarmSeverity static

通过告警级别的值获取告警级别。 告警级别的值越大,告警级别越高。告警级别的值是不可以重复的

Parameters:

  • value Number

    告警级别的值

Returns:

twaver.AlarmSeverity:

告警级别对象

twaver.AlarmSeverity.getClassName

() String

获取类名

Returns:

String:

类名

twaver.AlarmSeverity.getSortFunction

() Function static

获取排序的函数。默认是按照告警级别的值来排序的

Returns:

Function:

告警级别排序的函数

twaver.AlarmSeverity.isClearedAlarmSeverity

(
  • severity
)
Boolean static

判断是否是清除告警

Parameters:

Returns:

Boolean:

true为清除告警,否则为false

twaver.AlarmSeverity.remove

(
  • name
)
twaver.AlarmSeverity static

删除一个告警级别

Parameters:

  • name String

    告警级别的名称

Returns:

twaver.AlarmSeverity:

删除了的告警级别对象

twaver.AlarmSeverity.setSortFunction

(
  • sortFunction
)
static

设置排序的函数。默认是按照告警级别的值来排序的

Parameters:

  • sortFunction Function

    告警级别排序的函数

Properties

CLEARED

twaver.AlarmSeverity static

清除告警:告警级别中的一种,告警级别的值为0,默认是最低的告警级别

CRITICAL

twaver.AlarmSeverity static

严重告警。告警级别中的一种,告警级别的值为500,默认是最高的告警级别

INDETERMINATE

twaver.AlarmSeverity static

不确定告警。告警级别的值为100

MAJOR

twaver.AlarmSeverity static

主要告警。告警级别的值为400

MINOR

twaver.AlarmSeverity static

次要告警。告警级别的值为300

severities

twaver.List static

所有的告警级别

WARNING

twaver.AlarmSeverity static

警告告警。告警级别的值为200