Interface RelativizeOptions

Relativization options.

interface RelativizeOptions {
    getExcludedTags?: (namespace?: HNamespace) => string[];
    namespace?: HNamespace;
    useDisplayName?: boolean;
    useKind?: boolean;
}

Properties

getExcludedTags?: (namespace?: HNamespace) => string[]

Optional function to determine the list of tags that should be excluded from the relative filter.

namespace?: HNamespace

The namespace to use for determining excluded tags.

useDisplayName?: boolean

True (or undefined) if the display name should be used in the relative filter.

useKind?: boolean

True (or undefined) if a point's kind should be used in the relative filter.