Skip to content

Widget Property Types

Will Rogers edited this page Jan 21, 2020 · 2 revisions

Each type of widget has a number of properties. Each property is one of a set of types.

Types are useful for:

  • parsing display files of different formats
  • checking objects to be rendered and reporting problems
  • providing an editor

For these reasons, we need more than TypeScript types available so that we can have access to these types at runtime. PropTypes is the way for checking types in React without TypeScript, but the combination of PropTypes and TypeScript can be a bit clunky.

Types in existing applications

Display Builder Opibuilder Required? Notes
Boolean Boolean
Integer Integer TypeScript integer?
Double Double
Long TypeScript integer?
String String
Enum Combo We need one enum type
StringList
Color Color
Font Font
Actions Actions
Rules Rules
Macros Macros
Scripts Scripts
PVName PVName
Filename FilePath
Points PointList
ColorMap
Insets Offset inside container
PVValue Unclear
UnchangeableString Unclear
Matrix
Complex
FilePathWithFilter
StringTable
UnsaveableList
Version
Clone this wiki locally