Bitbybit Docs
    Preparing search index...

    Interface DesignParameter (Models.OCCT)

    A parameter with its kind and limits. type is number (the default, value a number or an expression), boolean, choice (value one of options) or text (value taken as it is). A choice or text value may be { "expr": "..." }, computed from other parameters. min, max and options are enforced on every value a build uses; unit, step, label, description and group are for the people and tools that edit it. A number parameter's unit is the document's length unit, deg, or none for a count or a ratio.

    interface DesignParameter {
        extras?: unknown;
        extensions?: Record<string, unknown>;
        value: boolean | DesignExpression | DesignNumber;
        type?: "number" | "boolean" | "choice" | "text";
        unit?: "mm" | "cm" | "m" | "in" | "deg" | "none";
        min?: number;
        max?: number;
        step?: number;
        options?: DesignChoiceOption[];
        label?: DesignLabel;
        description?: DesignLabel;
        group?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    extras?: unknown
    extensions?: Record<string, unknown>
    value: boolean | DesignExpression | DesignNumber
    type?: "number" | "boolean" | "choice" | "text"
    unit?: "mm" | "cm" | "m" | "in" | "deg" | "none"
    min?: number
    max?: number
    step?: number
    options?: DesignChoiceOption[]
    label?: DesignLabel
    description?: DesignLabel
    group?: string