Home > @i2analyze/notebook-sdk > chart > IChart
chart.IChart interface
An i2 Notebook chart.
Signature:
interface IChart
Introduced: version 1.0
Properties
Property | Modifiers | Type | Description |
---|---|---|---|
edges | readonly |
data.IKeyedReadOnlyCollection<visual.ElementId, visual.IEdge> | Gets all the edges in the chart. |
elements | readonly |
data.IKeyedReadOnlyCollection<visual.ElementId, visual.IElement> | Gets all the nodes and edges in the chart. |
entityRecords | readonly |
data.IKeyedReadOnlyCollection<records.AnalyzeRecordId, records.IChartEntityRecord> | Gets all the entity records in the chart. |
entityTypes | readonly |
data.IKeyedReadOnlyCollection<schema.ChartItemTypeId, schema.IChartEntityType> | Gets all the entity types in use on the chart. |
id | readonly |
ChartId | Gets the identifier of the chart. |
itemTypes | readonly |
data.IKeyedReadOnlyCollection<schema.ChartItemTypeId, schema.IChartItemType> | Gets all the entity types and link types in use on the chart. |
linkRecords | readonly |
data.IKeyedReadOnlyCollection<records.AnalyzeRecordId, records.IChartLinkRecord> | Gets all the link records in the chart. |
linkTypes | readonly |
data.IKeyedReadOnlyCollection<schema.ChartItemTypeId, schema.IChartLinkType> | Gets all the link types in use on the chart. |
name | readonly |
string | Gets the name of the chart. |
nodes | readonly |
data.IKeyedReadOnlyCollection<visual.ElementId, visual.INode> | Gets all the nodes in the chart. |
records | readonly |
data.IKeyedReadOnlyCollection<records.AnalyzeRecordId, records.IChartRecord> | Gets all the records in the chart. |
schema | readonly |
schema.IChartSchema | Gets the schema of the chart, which describes the types and properties that records in the chart can have. |
selection | readonly |
ISelection | Gets the current selection on the chart. |
Methods
Method | Description |
---|---|
ensurePropertiesFetched(records, propertyTypes, signal) | Fetches property values from the server of the specified types for the specified records, if they have not previously been fetched. |
getRecordsOfType(itemType) | Gets all the records in the chart that have the specified item type. |