Interface ReportFacetsConfig

Contains the configurations required to filter on a specific portion of the reports data.

interface ReportFacetsConfig {
    attributes?: string[];
    callback?: ((data) => void);
    defaultFilters?: FacetFilter[];
    defaultPageSize?: number;
    facetChangedCallback?: ((facet) => void);
    facetFiltersChangedCallback?: ((data) => void);
    factSheetIds?: string[];
    fixedFactSheetType?: string;
    fullTextSearchTerm?: string;
    key: string;
    label?: string;
    sortings?: Sorting[];
}

Properties

attributes? callback? defaultFilters? defaultPageSize? facetChangedCallback? facetFiltersChangedCallback? factSheetIds? fixedFactSheetType? fullTextSearchTerm? key label? sortings?

Properties

Optional attributes

attributes?: string[]

The Fact Sheet attributes that should be queried from the backend. Example: attributes: ['type', 'displayName']

Complex attributes need a subquery: `attributes: ['tags { }']

Optional callback

callback?: ((data) => void)

Type declaration

    • (data): void

    • Parameters

      • data: any[]

      Returns void

Optional defaultFilters

defaultFilters?: FacetFilter[]

If defined these filters will be applied as initial default when the user enters the report.

Optional defaultPageSize

defaultPageSize?: number

Deprecated

this parameter has no effect on the page size anymore.

Optional facetChangedCallback

facetChangedCallback?: ((facet) => void)

Type declaration

    • (facet): void

    • Called whenever a facet has changed

      Parameters

      Returns void

      Deprecated

      use facetFiltersChangedCallback() instead which is triggered on every facet change.

Optional facetFiltersChangedCallback

facetFiltersChangedCallback?: ((data) => void)

Type declaration

Optional factSheetIds

factSheetIds?: string[]

If defined these direct hits will be applied in initial report loading

Optional fixedFactSheetType

fixedFactSheetType?: string

If defined the facet will have a fixed filter on the fact sheet type with this value. Important to mention is that updating this value won't work. Therefore, we recommend creating a new facet if you want to change the fixed fact sheet type. Another recommendation is to always reflect the fact sheet type in the key value of the facet.

Optional fullTextSearchTerm

fullTextSearchTerm?: string

If defined this full text search term is applied in initial report loading

key

key: string

Optional label

label?: string

Optional sortings

sortings?: Sorting[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc