NetworkMapLink
Class represents Network Map link
Instance attributes
- connectorName1: String
-
Connection link name 1.
- connectorName2: String
-
Connection link name 2.
- color: String
-
Link color in css format.
- colorScriptName: String
-
Color script name.
- colorObjects: Array
-
Array with NetObj objects used for link color calculation.
- colorSource: int
-
Color source option one of color source.
- dataSource: Array
-
Array of LinkDataSource with all datasources displayed on link.
- name: String
-
Link name.
- objectId1: int
-
First connected object id.
- objectId2: int
-
Second connected object id.
- routing: int
-
Link routing type routing algorithm.
- style: int
-
Link style link style.
- type: int
-
Link type
- useActiveThresholds: bool
-
If active thresholds should be used for link color.
- useInterfaceUtilization: bool
-
If interface utilization should be used for link color. Only applicable when colorSource is set to object status mode.
- width: int
-
Link width.
Instance methods
- clearDataSource(): void
-
Remove all data sources form the list
- removeDataSource(index): void
-
Remove data source by index
Table 1. Parameters index
Integer
Index of data source to be removed
- setColorConfig(mode, data, includeThresholds, includeLinkUtilization): void
-
Set color source mode and additional parameters
Table 2. Parameters mode
Integer
One of color sources: color source. All further parameters depend on color source mode.
date
Object
Depending on color source mode one of: array of objects or object’s id for "object status" mode / script name for "script" mode / color definition for "custom color" mode
includeThresholds
Boolen
(optional) indicates if thresholds should be included into calculation for "object status" mode, default false
includeLinkUtilization
Boolean
(optional) indicates if link utilization should be included into calculation for "object status" mode, default false
- setConnectorName1(name): void
-
Set connection 1 name
Table 3. Parameters name
String
Connection 1 name
- setConnectorName2(name): void
-
Set connection 2 name
Table 4. Parameters name
String
Connection 2 name
- setInterface1(interface): void
-
Set first interface
Table 5. Parameters interface
Interface to set
- setInterface2(interface): void
-
Set second interface
Table 6. Parameters interface
Interface to set
- setName(name): void
-
Set name
Table 7. Parameters name
String
Link name
- setRoutingAlgorithm(algorithm): void
-
Set routing algorithm
Table 8. Parameters algorithm
Integer
One of algorithms: routing algorithm
- setStyle(style): void
-
Set link stle
Table 9. Parameters style
Integer
Link style: link style.
- setWidth(width): void
-
Set link width
Table 10. Parameters width
Integer
Link width
- updateDataSource(dci, format): void
-
Add or update link data source
Table 11. Parameters dci
<class-dci>
DCI to add or update to data source list
format
String
Optional. DCI data display format