Interface DriveWorksLiveClientConfig

Represents the configuration of the DriveWorksLiveClient.

Hierarchy

  • DriveWorksLiveClientConfig

Properties

downloadStyle? formLoadingOverlay? formLoadingOverlayDetailsContainer? formPaddingBottom? formPaddingRight? measurementTextBoxUpdateIntervalSeconds? numericTextBoxUpdateIntervalSeconds? responseErrorDelegate? responseSuccessDelegate? textBoxUpdateIntervalSeconds?

Properties

Optional downloadStyle

downloadStyle?: "cookie" | "header" | "query-string"

The method in which downloads should be authenticated.

Optional formLoadingOverlay

formLoadingOverlay?: HTMLDivElement

A custom overlay that will be displayed during form loading.

Optional formLoadingOverlayDetailsContainer

formLoadingOverlayDetailsContainer?: HTMLDivElement

The container where loading progress information will be displayed in.

Optional formPaddingBottom

formPaddingBottom?: number

The bottom padding to apply to specification forms.

Optional formPaddingRight

formPaddingRight?: number

The right padding to apply to specification forms.

Optional measurementTextBoxUpdateIntervalSeconds

measurementTextBoxUpdateIntervalSeconds?: number

The interval between inputting data into a measurement text box and it being sent to the server.

Optional numericTextBoxUpdateIntervalSeconds

numericTextBoxUpdateIntervalSeconds?: number

The interval between inputting data into a numeric text box and it being sent to the server.

Optional responseErrorDelegate

responseErrorDelegate?: ((response) => boolean)

Type declaration

    • (response): boolean

    • A function to call when an error response is received from the server.

      Return True to skip the default response handling.

      Parameters

      Returns boolean

Optional responseSuccessDelegate

responseSuccessDelegate?: ((response) => void)

Type declaration

    • (response): void

    • A function to call when a successful response is received from the server.

      Parameters

      Returns void

Optional textBoxUpdateIntervalSeconds

textBoxUpdateIntervalSeconds?: number

The interval between inputting data into a text box and it being sent to the server.