Theia API Documentation v1.66.0
    Preparing search index...

    Interface SearchInWorkspaceResultLineNode

    A selectable tree node.

    interface SearchInWorkspaceResultLineNode {
        busy?: number;
        character: number;
        checkboxInfo?: TreeViewItemCheckboxInfo;
        description?: string;
        fileUri: string;
        focus?: boolean;
        icon?: string;
        id: string;
        length: number;
        line: number;
        lineText: string | LinePreview;
        matches: SearchMatch[];
        name?: string;
        nextSibling?: TreeNode;
        parent: SearchInWorkspaceFileNode;
        previousSibling?: TreeNode;
        root: string;
        selected: boolean;
        visible?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    busy? character checkboxInfo? description? fileUri focus? icon? id length line lineText matches name? nextSibling? parent previousSibling? root selected visible?

    Properties

    busy?: number

    Whether this node is busy. Greater than 0 then busy; otherwise not.

    character: number

    The (1-based) character number in the result line. For UTF-8 files, one multi-byte character counts as one character.

    checkboxInfo?: TreeViewItemCheckboxInfo

    Whether this node is checked.

    description?: string

    A human-readable description of this tree node.

    use LabelProvider.getLongName instead or move this property to your tree node type

    fileUri: string

    The string uri to the file containing the result.

    focus?: boolean

    1.27.0. Use TreeFocusService to track the focused node.

    true if the tree node has the focus. Otherwise, false. Defaults to false.

    icon?: string

    A css string for this tree node icon.

    use LabelProvider.getIcon instead or move this property to your tree node type

    id: string

    An unique id of this node.

    length: number

    The length of the match, in characters. For UTF-8 files, one multi-byte character counts as one character.

    line: number

    The (1-based) line number of the result.

    lineText: string | LinePreview

    The text of the line containing the result.

    matches: SearchMatch[]

    matches found in the file

    name?: string

    A human-readable name of this tree node.

    use LabelProvider.getName instead or move this property to your tree node type

    nextSibling?: TreeNode

    A next sibling of this tree node.

    parent: SearchInWorkspaceFileNode

    A parent node of this tree node. Undefined if this node is root.

    previousSibling?: TreeNode

    A previous sibling of this tree node.

    root: string

    The string uri to the root folder that the search was performed.

    selected: boolean

    true if the tree node is selected. Otherwise, false.

    visible?: boolean

    Test whether this node should be rendered. If undefined then node will be rendered.

    Settings

    Member Visibility

    On This Page

    Properties