IAttributeFilterHandlerOptionsBase

IAttributeFilterHandlerOptionsBase.displayAsLabelproperty

If specified, the attribute filter will display the elements in specified label form.

displayAsLabel?: ObjRef;

IAttributeFilterHandlerOptionsBase.hiddenElementsproperty

If specified, these will be excluded from the elements available for selection and will also be removed from the resulting filter. This effectively behaves as if those elements were not part of the underlying display form.

hiddenElements?: string[];

Remarks

The meaning of the items is determined by the way the filter is specified: if the filter uses URIs, then these are also interpreted as URIs, analogously with values.

If using hiddenElements, make sure your input filter excludes the hidden elements, otherwise it could lead to non-intuitive behavior. So, for positive filters, make sure their elements do NOT contain any of the hiddenElements. Inversely for negative filters, make sure their elements do contain all of the hiddenElements.

Example

This is how to correctly create a filter that has some items hidden but is set to All:

const hiddenUris: ["uri1", "uri2"];
// make sure to use the uris both in the filter...
const filter = newNegativeAttributeFilter("displayForm", { uris: hiddenUris });
// ...and also in the config
const handler = newAttributeFilterHandler(backend, workspace, filter, { hiddenElements: hiddenUris });

IAttributeFilterHandlerOptionsBase.staticElementsproperty

If specified, these elements will replace the elements that would be loaded from the server. Note that if using this, limiting measures and/or filters will not work: it is your responsibility to filter the static elements yourself.

staticElements?: IAttributeElement[];

IAttributeFilterHandlerOptionsBase.withoutApplyproperty

if true, the attribute filter will not display the apply button Several other behaviours are also affected by this option like dependent filters

withoutApply?: boolean;