Viewer
    Preparing search index...

    Interface IDrawingParameterApi

    interface IDrawingParameterApi {
        hidden: boolean;
        id: string;
        interactionType: InteractionParameterSettingsType;
        name: string;
        sessionValue: string;
        settings: IDrawingParameterSettings;
        type: PARAMETER_TYPE;
        value: string;
        isValid(value: unknown, throwError?: boolean): boolean;
        resetToDefaultValue(): void;
        resetToSessionValue(): void;
        stringify(value?: unknown): string;
        choices?: string[];
        decimalplaces?: number;
        defval?: string;
        displayname?: string;
        expression?: string;
        format?: string[];
        group?: CommonsGroup;
        hint?: string;
        interval?: number;
        max?: number;
        min?: number;
        order?: number;
        structure?: ResStructureType;
        tooltip?: string;
        umax?: number;
        umin?: number;
        visualization?: PARAMETER_VISUALIZATION;
        vmax?: number;
        vmin?: number;
    }

    Hierarchy

    • IInteractionParameterApi
      • IDrawingParameterApi
    Index

    Properties

    hidden id interactionType name sessionValue settings type value choices? decimalplaces? defval? displayname? expression? format? group? hint? interval? max? min? order? structure? tooltip? umax? umin? visualization? vmax? vmin?

    Methods

    isValid resetToDefaultValue resetToSessionValue stringify

    Properties

    hidden: boolean
    id: string
    interactionType: InteractionParameterSettingsType
    name: string
    sessionValue: string

    The value that corresponds to the latest successful call to ISessionApi.customize. This property will be updated immediately before ISessionApi.customize returns.

    settings: IDrawingParameterSettings
    type: PARAMETER_TYPE
    value: string

    The current value.

    Validation happens immediately when setting this property. An error will be thrown in case validation fails. Use isValid to test whether a value passes validation.

    In case ISessionApi.automaticSceneUpdate is true, setting the value will immediately trigger a customization (see ISessionApi.customize).

    choices?: string[]
    decimalplaces?: number
    defval?: string
    displayname?: string
    expression?: string
    format?: string[]
    group?: CommonsGroup
    hint?: string
    interval?: number
    max?: number
    min?: number
    order?: number
    structure?: ResStructureType
    tooltip?: string
    umax?: number
    umin?: number
    visualization?: PARAMETER_VISUALIZATION
    vmax?: number
    vmin?: number

    Methods

    • Evaluates if a given value is valid for this parameter.

      Parameters

      • value: unknown

        the value to evaluate

      • OptionalthrowError: boolean

        if true, an error is thrown if validation does not pass (default: false)

      Returns boolean

    • Resets the value to the default value.

      Returns void

    • Resets the value to sessionValue.

      Returns void

    • Returns the current value as a string, or attempts to stringify a given value if provided.

      Parameters

      • Optionalvalue: unknown

        the value to stringify

      Returns string

    Settings

    Member Visibility

    On This Page

    Properties
    Methods