Interface RelativizeOptions

Relativization options.

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

Hierarchy (View Summary)

Properties

getExcludedTags? namespace? prefixPath? useDisplayName? useKind? useMarkers? useRelativizeOn?

Properties

OptionalgetExcludedTags

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

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

Optionalnamespace

namespace?: HNamespace

The namespace to use for determining excluded tags.

OptionalprefixPath

prefixPath?: string[]

Optional prefix path.

OptionaluseDisplayName

useDisplayName?: boolean

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

OptionaluseKind

useKind?: boolean

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

OptionaluseMarkers

useMarkers?: boolean

True (or undefined) if the relative filter should use markers.

OptionaluseRelativizeOn

useRelativizeOn?: boolean

True (or undefined) if the relativization should be looked up on the record.

A record can define a relativizeOn tag that is a list of tags that should be used for relativization. This is used to provide a hint on how relativation for a certain record is defined.

The {dis} id can be used to add the first known display name tag on the record.

The {kind} id can be used to add the kind tag when the record is a point.

The {markers} id can be used to expand all marker tags on the record.

Settings

Member Visibility

On This Page

Properties