IRankingFilterDropdownProps
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
export interface IRankingFilterDropdownProps
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
HTMLElement | string | (BETA) (Optional) | ||
(BETA) | |||
(BETA) (Optional) Current “out of” attributes (titled), seeded by the host (filter’s own, or insight defaults). | |||
(BETA) (Optional) Catalog “out of” attributes (used when not lazily loaded via loadCatalogAttributes). | |||
(BETA) (Optional) | |||
boolean | (BETA) (Optional) | ||
boolean | (BETA) (Optional) | ||
(BETA) | |||
(BETA) (Optional) Insight default “out of” attributes (for the reset action). | |||
boolean | (BETA) (Optional) | ||
(attributes: ObjRefInScope[]) => Promise<IDimensionalityItem[]> | (BETA) (Optional) Lazily loads catalog “out of” attributes valid for the current selection (on picker open). | ||
string | (BETA) (Optional) | ||
(BETA) | |||
(filter: IRankingFilter) => void | (BETA) | ||
() => void | (BETA) (Optional) | ||
() => void | (BETA) (Optional) | ||
(ref: ObjRefInScope) => void | (BETA) (Optional) | ||
(BETA) (Optional) Optional custom renderer for the measure dropdown body, replacing the built-in flat measure list with a custom body (e.g. a grouped, searchable catalog picker). |
Property details
IRankingFilterDropdownProps.anchorElpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
anchorEl?: HTMLElement | string;
IRankingFilterDropdownProps.attributeItemspropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
attributeItems: IAttributeDropdownItem[];
IRankingFilterDropdownProps.attributespropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Current “out of” attributes (titled), seeded by the host (filter’s own, or insight defaults).
attributes?: IDimensionalityItem[];
IRankingFilterDropdownProps.catalogAttributespropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Catalog “out of” attributes (used when not lazily loaded via loadCatalogAttributes).
catalogAttributes?: IDimensionalityItem[];
IRankingFilterDropdownProps.customGranularitySelectionpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
customGranularitySelection?: ICustomGranularitySelection;
IRankingFilterDropdownProps.enableRankingStrictLimitpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
enableRankingStrictLimit?: boolean;
IRankingFilterDropdownProps.enableRankingWithMvfpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
enableRankingWithMvf?: boolean;
IRankingFilterDropdownProps.filterpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
filter: IRankingFilter;
IRankingFilterDropdownProps.insightAttributespropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Insight default “out of” attributes (for the reset action).
insightAttributes?: IDimensionalityItem[];
IRankingFilterDropdownProps.isAttributesSectionEnabledpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
isAttributesSectionEnabled?: boolean;
IRankingFilterDropdownProps.loadCatalogAttributespropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Lazily loads catalog “out of” attributes valid for the current selection (on picker open).
loadCatalogAttributes?: (attributes: ObjRefInScope[]) => Promise<IDimensionalityItem[]>;
IRankingFilterDropdownProps.localepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
locale?: string;
IRankingFilterDropdownProps.measureItemspropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
measureItems: IMeasureDropdownItem[];
IRankingFilterDropdownProps.onApplypropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
onApply: (filter: IRankingFilter) => void;
IRankingFilterDropdownProps.onCancelpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
onCancel?: () => void;
IRankingFilterDropdownProps.onDropDownItemMouseOutpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
onDropDownItemMouseOut?: () => void;
IRankingFilterDropdownProps.onDropDownItemMouseOverpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
onDropDownItemMouseOver?: (ref: ObjRefInScope) => void;
IRankingFilterDropdownProps.renderMeasureDropdownBodypropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Optional custom renderer for the measure dropdown body, replacing the built-in flat measure list with a custom body (e.g. a grouped, searchable catalog picker).
renderMeasureDropdownBody?: RenderMeasureDropdownBody;