i2 Notebook SDK
Search results for

    Show/hide table of contents

    Home > @i2analyze/notebook-sdk > visual > IBrushSet > getBrushIndex

    visual.IBrushSet.getBrushIndex() method

    Gets the brush index for a record, or undefined if the record is not in the brush set.

    Signature:

    getBrushIndex(recordId: records.AnalyzeRecordId): BrushIndex | undefined;
    

    Introduced: version 1.9

    Parameters

    Parameter Type Description
    recordId records.AnalyzeRecordId The identifier of the record.

    Returns:

    BrushIndex | undefined

    The brush index, or undefined if the record is not brushed.

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