i2 Notebook SDK
Search results for

    Show/hide table of contents

    Home > @i2analyze/notebook-sdk > records > IChartLinkRecord

    records.IChartLinkRecord interface

    A link record.

    Signature:

    interface IChartLinkRecord extends IChartRecordBase 
    

    Extends: IChartRecordBase

    Introduced: version 1.0

    Properties

    Property Modifiers Type Description
    element readonly visual.IElement

    Gets the chart element to which the record belongs.

    (Inherited from IChartRecordBase)

    firstUploaded readonly data.IUserAndDateAndTime | undefined

    Gets information about when and by whom the record was first uploaded.

    (Inherited from IChartRecordBase)

    fromEnd readonly IChartEntityRecord Gets the record at the 'from' end of the link.
    hasUnfetchedProperties readonly boolean

    Indicates whether there are properties on the record whose values have not been fetched from the server.

    (Inherited from IChartRecordBase)

    id readonly AnalyzeRecordId

    Gets the identifier of the record.

    (Inherited from IChartRecordBase)

    image? readonly data.IImage

    (Optional) Gets an image that represents the record.

    (Inherited from IChartRecordBase)

    isInfoStore readonly boolean

    Indicates whether the record existed in the Information Store at the time of its addition to the chart.

    (Inherited from IChartRecordBase)

    itemType readonly schema.IChartLinkType Gets the type of the link 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>'.

    (Inherited from IChartRecordBase)

    lastUploaded readonly data.IUserAndDateAndTime | undefined

    Gets information about when and by whom the record was last uploaded.

    (Inherited from IChartRecordBase)

    linkDirection readonly data.LinkDirection Gets the direction of the link.
    notes readonly data.IKeyedReadOnlyCollection<NoteId, INote>

    Gets the notes of the record.

    (Inherited from IChartRecordBase)

    security readonly data.IKeyedReadOnlyCollection<schema.SecurityDimensionId, ISecuritySetting>

    Gets the security settings of the record.

    (Inherited from IChartRecordBase)

    sourceIdentifiers readonly data.IReadOnlyCollection<ISourceIdentifier>

    Gets the source identifiers of the record.

    (Inherited from IChartRecordBase)

    sourceReferences readonly data.IKeyedReadOnlyCollection<SourceReferenceId, ISourceReference>

    Gets the source references of the record.

    (Inherited from IChartRecordBase)

    toEnd readonly IChartEntityRecord Gets the record at the 'to' end of the link.

    Methods

    Method Description
    get360ViewUrl()

    Gets a URL for displaying the record in a 360 view, if the record and the server support it.

    (Inherited from IChartRecordBase)

    getLabelDetails()

    Gets the label for the record, together with information about whether the label has a genuine value.

    (Inherited from IChartRecordBase)

    getProperty(propertyType)

    Gets the property value for the specified property type.

    (Inherited from IChartRecordBase)

    getUnfetchedPropertyTypes()

    Gets the property types of the properties on the record whose values have not been fetched.

    (Inherited from IChartRecordBase)

    isEntity()

    Tests whether the record is an entity record; functions as a TypeScript typeguard.

    (Inherited from IChartRecordBase)

    isLink()

    Tests whether the record is a link record; functions as a TypeScript typeguard.

    (Inherited from IChartRecordBase)

    isValueUnfetched(property)

    Indicates whether the specified property value has been fetched from the server.

    (Inherited from IChartRecordBase)

    In this article
    Back to top © N. Harris Computer Corporation