Knowledge Base - API
Breadcrumbs

StateGraphCategoryBase

StateGraphCategoryBase represents information about a given specified Category in the configuration.

Properties

Data Type

Property

Description

string

Id

Returns the configurator engine ID for the configuration represented by the state graph. Configuration Engine IDs are runtime values and will vary from session to session.

string

ClientId

Returns the ID associated with the rendered UI.

string

Desc

Returns the description of the Category.

int

SeqNo

Returns the sequence number of the Category.

string

RuntimeType

Returns the runtime type (e.g. LNK, REQ, SLK, SUG, USR, URM) of the Category, if applicable.

StateGraphPropBase[]

Props

Returns an array of objects, each containing information about a specific Property in the Category.

StateGraphPropDefnBase[]

PropDefns

Returns an array of objects, each containing information about a specific Property in the Category.

StateGraphSelectionBase[]

Selection

Returns an array of objects, each containing information about a selected Option in the Category.

StateGraphOptionBase[]

Options

Returns an array of objects, each containing information about an Option available in the Category.