i2 Notebook SDK
Search results for

    Show/hide table of contents

    Home > @i2analyze/notebook-sdk > chart > IChart > ensurePropertiesFetched

    chart.IChart.ensurePropertiesFetched() method

    Fetches property values from the server of the specified types for the specified records, if they have not previously been fetched.

    Signature:

    ensurePropertiesFetched(records: app.RecordSpecifier | Iterable<app.RecordSpecifier>, propertyTypes: schema.PropertyTypeSpecifier | Iterable<schema.PropertyTypeSpecifier>, signal?: AbortSignal): Promise<void>;
    

    Introduced: version 1.1

    Parameters

    Parameter Type Description
    records app.RecordSpecifier | Iterable<app.RecordSpecifier> The records to update with fetched property values.
    propertyTypes schema.PropertyTypeSpecifier | Iterable<schema.PropertyTypeSpecifier> The types of the properties whose values are to be fetched if necessary.
    signal AbortSignal (Optional) A signal that the application uses to abort the operation.

    Returns:

    Promise<void>

    A promise that is fulfilled if the work completes successfully, or rejected if there is a problem performing it.

    Remarks

    Some property values might not be fetched immediately from the server, due to size or other factors. The property values that this method fetches become "unfetched" on subsequent record updates by the server. See also the hasUnfetchedProperties, isValueUnfetched(), and getUnfetchedPropertyTypes() members of records.IChartRecordBase.

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