<< Click here to display Table of Contents >>

Enum

Contents

The following is the built-in enums in categories:

▪Message

▪Color

▪Alert

▪Line

▪Alignment

▪Note

▪Layout

▪Device Group

Message

Message Level	Description
MessageLevel.Information	Information level.
MessageLevel.Warning	Warning level.
MessageLevel.Error	Error level.
MessageLevel.System	System notification message, generated by the system.
MessageLevel.PythonError	System error message, generated by the system.

Alert

Alert Level	Description
AlertLevel.Warning	Warning level.
AlertLevel.Error	Error level.

Color

▪Color.RGB(red, green, blue) — used to set the color. It returns the int value of a specified RGB color.

▪Color.Random — used to generate a random color. It returns -1.

The correspondence of a color and its RGB value is as follows:

Color	RGB Value
Color.Black	RGB(0, 0, 0)
Color.Red	RGB(255, 0, 0)
Color.Orange	RGB(255, 128, 0)
Color.Green	RGB(0, 255, 0)
Color.Yellow	RGB(255, 255, 0)
Color.Blue	RGB(0, 0, 255)
Color.Pink	RGB(255, 0, 255)
Color.Cyan	RGB(0, 255, 255)
Color.White	RGB(255, 255, 255)

Line

Line Style	Description
LineStyle.Solid
LineStyle.Dash
LineStyle.Dot
LineStyle.DashDot
LineStyle.DashDotDot

Alignment

Align	Description
Align.Left	Aligned to the left
Align.Center	Aligned to the center
Align.Right	Aligned to the right

Note

Type	Description
NoteType.Append	When a note with the same title already exists, append new note text to the end of the existing note text and update the timestamp.
NoteType.Overwrite	When a note with the same title already exists, replace the text of the existing note with new note text and update the timestamp.
NoteType.RecordHistory	When a note with the same title already exists: ▪If the text of the existing note does not exist or there is one piece of text, add new note text and timestamp to the top of the existing note. ▪If the existing note has two pieces of texts and the new note text context is not the same as the existing text content, add new note text and timestamp to the top of the existing note. If the new text content is same as the existing text content, the note only retains the latest text and oldest text.

Type

Description

NoteType.Append

When a note with the same title already exists, append new note text to the end of the existing note text and update the timestamp.

NoteType.Overwrite

When a note with the same title already exists, replace the text of the existing note with new note text and update the timestamp.

NoteType.RecordHistory

When a note with the same title already exists:

▪If the text of the existing note does not exist or there is one piece of text, add new note text and timestamp to the top of the existing note.

▪If the existing note has two pieces of texts and the new note text context is not the same as the existing text content, add new note text and timestamp to the top of the existing note. If the new text content is same as the existing text content, the note only retains the latest text and oldest text.

Layout

Layout Style	Description
LayoutStyle.Symmetric	Symmetric layout style
LayoutStyle.Circular	Circular layout style
LayoutStyle.Hierarchical	Hierarchical layout style
LayoutStyle.Orthogonal	Orthogonal layout style
LayoutStyle.Tree	Tree layout style

To view map layout styles in detail, refer to Layout Style.

Device Group

Device Group Type	Description
DeviceGroupType.Public	A shared device group in your domain.
DeviceGroupType.My	A private device group in your domain.

See Device Group for more details.