@itwin/presentation-common/lib/cjs/presentation-common/rules/Variables.d.ts

Common pieces for iModel.js presentation packages

/** @packageDocumentation
 * @module PresentationRules
 */
/**
 * Presentation rules support variables that allow having additional customization of the hierarchy
 * and content based on variables whose values can change during application session.
 *
 * There are [special ECExpression symbols]($docs/presentation/advanced/ECExpressions.md#ruleset-variables-user-settings)
 * that can be used to access variables by their ID, so rule conditions can check for a value and change
 * the behavior. It allows showing / hiding some nodes in the hierarchy, change the grouping, etc.
 *
 * @public
 */
export interface VariablesGroup {
    /**
     * Group label to display in the UI.
     * May be [localized]($docs/presentation/advanced/Localization.md).
     */
    label: string;
    /** Grouped variables */
    vars: Variable[];
    /** Nested variable groups. */
    nestedGroups?: VariablesGroup[];
}
/**
 * Available value types of user-controllable variables
 * @public
 */
export declare enum VariableValueType {
    /** Bool value, that uses Yes / No strings in the UI */
    YesNo = "YesNo",
    /** Bool value, that uses Show / Hide strings in the UI */
    ShowHide = "ShowHide",
    /** Any string value */
    String = "StringValue",
    /** Any integer value */
    Int = "IntValue"
}
/**
 * Definition for single user-controllable variable
 * @public
 */
export interface Variable {
    /** Id of the variable */
    id: string;
    /**
     * Label of the variable that is shown in the UI.
     * May be [localized]($docs/presentation/advanced/Localization.md).
     */
    label: string;
    /**
     * Defines value type. Defaults to [[VariableValueType.YesNo]].
     * @see VariableValueType
     */
    type?: `${VariableValueType}`;
    /** Default value. */
    defaultValue?: string;
}
//# sourceMappingURL=Variables.d.ts.map