Interface DataFrameAccessValidationResult

A linting result for a single linting rule match.

interface DataFrameAccessValidationResult {
    access: string;
    accessed: string | number;
    certainty: LintingCertainty;
    operand?: string;
    quickFix?: LintQuickFix[];
    range: SourceRange;
    type: "column" | "row";
}

Hierarchy (View Summary)

Hierarchy-Diagram

UML class diagram of DataFrameAccessValidationResult

Properties

access accessed certainty operand? quickFix? range type

Properties

access

access: string

The name of the function/operation used for the access (e.g. $, [, [[, but also filter, select, ...)

accessed

accessed: string | number

The name or index of the column or row being accessed in the data frame

Readonlycertainty

certainty: LintingCertainty

Optionaloperand

operand?: string

The variable/symbol name of the accessed data frame operand (undefined if operand is no symbol)

Optional ReadonlyquickFix

quickFix?: LintQuickFix[]

If available, what to do to fix the linting result.

range

range: SourceRange

The source range in the code where the access occurs

type

type: "column" | "row"

The type of the data frame access ("column" or "row")

Settings

Member Visibility

On This Page

Properties