Home > @i2analyze/notebook-sdk > schema > IChartEntityType
schema.IChartEntityType interface
An entity type.
Signature:
interface IChartEntityType extends IChartItemTypeBase
Extends: IChartItemTypeBase
Introduced: version 1.0
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| analyzeId? | readonly |
AnalyzeItemTypeId | (Optional) Gets the identifier of the item type in the i2 Analyze schema, if it has one. (Inherited from IChartItemTypeBase) |
| description | readonly |
string | Gets the description of the item type. (Inherited from IChartItemTypeBase) |
| displayName | readonly |
string | Gets the display name of the item type. (Inherited from IChartItemTypeBase) |
| id | readonly |
ChartItemTypeId | Gets the identifier of the item type. (Inherited from IChartItemTypeBase) |
| image | readonly |
data.IImage | Gets the image that represents records that have the entity type. |
| isCustom | readonly |
boolean | Indicates whether the item type is a custom type. (Inherited from IChartItemTypeBase) |
| isInfoStore | readonly |
boolean | Indicates whether the item type is defined in the Information Store schema. (Inherited from IChartItemTypeBase) |
| isOrphaned | readonly |
boolean | Indicates whether the item type is orphaned - that is, it does not have a counterpart in the i2 Analyze schema. (Inherited from IChartItemTypeBase) |
| labelDefinition | readonly |
data.IReadOnlyCollection<ILabelPart> | Gets the label definition for the item type, which describes how record labels are formed. (Inherited from IChartItemTypeBase) |
| origin | readonly |
ISchemaInfo | Gets information about the schema where the type definition is located. (Inherited from IChartItemTypeBase) |
| propertyTypes | readonly |
data.IKeyedReadOnlyCollection<ChartPropertyTypeId, IChartPropertyType> | Gets all the property types of the item type. (Inherited from IChartItemTypeBase) |
| semanticTypeId | readonly |
string | Gets the identifier of the semantic type of the item type. (Inherited from IChartItemTypeBase) |
| sourceReferenceSchema | readonly |
ISourceReferenceSchema | Gets the source reference schema for the item type. (Inherited from IChartItemTypeBase) |
Methods
| Method | Description |
|---|---|
| getPropertyType(analyzePropertyTypeId) | Gets the property type that has the specified i2 Analyze type identifier. (Inherited from IChartItemTypeBase) |
| isEntityType() | Tests whether the item type is an entity item type; functions as a TypeScript typeguard. (Inherited from IChartItemTypeBase) |
| isLinkType() | Tests whether the item type is a link item type; functions as a TypeScript typeguard. (Inherited from IChartItemTypeBase) |