Interface RelativizeForTargetOptions

Relativization options.

interface RelativizeForTargetOptions {
    getExcludedTags?: (namespace?: HNamespace) => string[];
    includeIntermediateRecords?: boolean;
    includeOtherRefs?: boolean;
    includeTargetMacro?: boolean;
    namespace?: HNamespace;
    prefixPath?: string[];
    resolve?: RelativizeResolveFunc;
    resolveCache?: Map<string, Promise<undefined | HDict>>;
    useDisplayName?: boolean;
    useKind?: boolean;
    useMarkers?: boolean;
    useRelativizeOn?: boolean;
}

Hierarchy (View Summary)

Properties

getExcludedTags? includeIntermediateRecords? includeOtherRefs? includeTargetMacro? namespace? prefixPath? resolve? resolveCache? 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.

OptionalincludeIntermediateRecords

includeIntermediateRecords?: boolean

True (or undefined) if intermediate records should be included in the relative filters.

OptionalincludeOtherRefs

includeOtherRefs?: boolean

True (or undefined) if other references on the target record should be included when relativizing.

If this is false, only the containment references will be used to relativize the filter. If this is true, other references on the target record will be used to relativize the filter if they match the record being relativized.

OptionalincludeTargetMacro

includeTargetMacro?: boolean

True (or undefined) if the target record macro reference should be included in the relative filters.

Optionalnamespace

namespace?: HNamespace

The namespace to use for determining excluded tags.

OptionalprefixPath

prefixPath?: string[]

Optional prefix path.

Optionalresolve

resolve?: RelativizeResolveFunc

An optional function used to resolve a dict for a reference.

OptionalresolveCache

resolveCache?: Map<string, Promise<undefined | HDict>>

An optional cache used to cache requests for dicts.

If multiple resolution calls are being made, this cache can be used between calls to avoid duplicate requests for the same reference.

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