Home > @i2analyze/notebook-sdk > records > IChartRecordBase
records.IChartRecordBase interface
A set of information and functionality that is common to all records in i2 Notebook.
Signature:
interface IChartRecordBase
Introduced: version 1.0
Properties
Property | Modifiers | Type | Description |
---|---|---|---|
element | readonly |
visual.IElement | Gets the chart element to which the record belongs. |
firstUploaded | readonly |
data.IUserAndDateAndTime | undefined | Gets information about when and by whom the record was first uploaded. |
hasUnfetchedProperties | readonly |
boolean | Indicates whether there are properties on the record whose values have not been fetched from the server. |
id | readonly |
AnalyzeRecordId | Gets the identifier of the record. |
image? | readonly |
data.IImage | (Optional) Gets an image that represents the record. |
isInfoStore | readonly |
boolean | Indicates whether the record existed in the Information Store at the time of its addition to the chart. |
itemType | readonly |
schema.IChartItemType | Gets the item type of the record. |
labelOrFallback | readonly |
string | Gets the label of the record or, if there is no label, an application-standard fallback string such as '<No label>'. |
lastUploaded | readonly |
data.IUserAndDateAndTime | undefined | Gets information about when and by whom the record was last uploaded. |
notes | readonly |
data.IKeyedReadOnlyCollection<NoteId, INote> | Gets the notes of the record. |
security | readonly |
data.IKeyedReadOnlyCollection<schema.SecurityDimensionId, ISecuritySetting> | Gets the security settings of the record. |
sourceIdentifiers | readonly |
data.IReadOnlyCollection<ISourceIdentifier> | Gets the source identifiers of the record. |
sourceReferences | readonly |
data.IKeyedReadOnlyCollection<SourceReferenceId, ISourceReference> | Gets the source references of the record. |
Methods
Method | Description |
---|---|
get360ViewUrl() | Gets a URL for displaying the record in a 360 view, if the record and the server support it. |
getLabelDetails() | Gets the label for the record, together with information about whether the label has a genuine value. |
getProperty(propertyType) | Gets the property value for the specified property type. |
getUnfetchedPropertyTypes() | Gets the property types of the properties on the record whose values have not been fetched. |
isEntity() | Tests whether the record is an entity record; functions as a TypeScript typeguard. |
isLink() | Tests whether the record is a link record; functions as a TypeScript typeguard. |
isValueUnfetched(property) | Indicates whether the specified property value has been fetched from the server. |