Home > @i2analyze/notebook-sdk > records > ISourceReference
records.ISourceReference interface
A source reference for a record.
Signature:
interface ISourceReference
Introduced: version 1.0
Remarks
A source reference contains information about a source from which data in the record was derived.
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| description? | readonly |
string | (Optional) Gets the description of the source that the source reference describes. |
| id | readonly |
SourceReferenceId | Gets the identifier of the source reference. |
| imageUrl? | readonly |
string | (Optional) Gets the URL of an image of the source that the source reference describes. |
| isReadOnly | readonly |
boolean | Indicates whether the source reference is read-only. |
| location? | readonly |
string | (Optional) Gets the location of the source that the source reference describes. |
| locationIsUrl | readonly |
boolean | Indicates whether it makes sense to show location as a hyperlink. |
| name | readonly |
string | Gets the name of the source that the source reference describes. |
| type? | readonly |
string | (Optional) Gets the type of the source that the source reference describes. |