Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • CtrlUtils

Index

Properties

Static getButton

getButton: (ctrlName: string) => Button | undefined = ...

Type declaration

    • (ctrlName: string): Button | undefined
    • Parameters

      • ctrlName: string

      Returns Button | undefined

Static getCheckbox

getCheckbox: (ctrlName: string) => Checkbox | undefined = ...

Type declaration

    • (ctrlName: string): Checkbox | undefined
    • Parameters

      • ctrlName: string

      Returns Checkbox | undefined

Static getCombobox

getCombobox: (ctrlName: string) => Combobox | undefined = ...

Type declaration

    • (ctrlName: string): Combobox | undefined
    • Parameters

      • ctrlName: string

      Returns Combobox | undefined

Static getCtrl

getCtrl: (ctrlName: string) => Base | undefined = ...

Type declaration

    • (ctrlName: string): Base | undefined
    • Parameters

      • ctrlName: string

      Returns Base | undefined

Static getDataview

getDataview: (ctrlName: string) => Dataview | undefined = ...

Type declaration

    • (ctrlName: string): Dataview | undefined
    • Parameters

      • ctrlName: string

      Returns Dataview | undefined

Static getExternalContent

getExternalContent: (ctrlName: string) => ExternalContent | undefined = ...

Type declaration

Static getGraphicView

getGraphicView: (ctrlName: string) => GraphicView | undefined = ...

Type declaration

Static getGraphicViewSvgSrc

getGraphicViewSvgSrc: (graphicViewName: string) => string = ...

Type declaration

    • (graphicViewName: string): string
    • Parameters

      • graphicViewName: string

      Returns string

Static getLabel

getLabel: (ctrlName: string) => Label | undefined = ...

Type declaration

    • (ctrlName: string): Label | undefined
    • Parameters

      • ctrlName: string

      Returns Label | undefined

Static getLayer

getLayer: (ctrlName: string) => Layer | undefined = ...

Type declaration

    • (ctrlName: string): Layer | undefined
    • Parameters

      • ctrlName: string

      Returns Layer | undefined

Static getPanel

getPanel: (ctrlName: string) => Panel | undefined = ...

Type declaration

    • (ctrlName: string): Panel | undefined
    • Parameters

      • ctrlName: string

      Returns Panel | undefined

Static getRadiobutton

getRadiobutton: (ctrlName: string) => Radiobutton | undefined = ...

Type declaration

Static getShapeDiver3d

getShapeDiver3d: (ctrlName: string) => ShapeDiver3d | undefined = ...

Type declaration

Static getShapeDiver3dEmbedded

getShapeDiver3dEmbedded: (ctrlName: string) => ShapeDiver3dEmbedded | undefined = ...

Type declaration

Static getShareButton

getShareButton: (ctrlName: string) => ShareButton | undefined = ...

Type declaration

Static getSlider

getSlider: (ctrlName: string) => Slider | undefined = ...

Type declaration

    • (ctrlName: string): Slider | undefined
    • Parameters

      • ctrlName: string

      Returns Slider | undefined

Static getTextbox

getTextbox: (ctrlName: string) => Textbox | undefined = ...

Type declaration

    • (ctrlName: string): Textbox | undefined
    • Parameters

      • ctrlName: string

      Returns Textbox | undefined

Static getViewerCtrl

getViewerCtrl: (ctrlName: string) => Viewer3d | undefined = ...

Type declaration

    • (ctrlName: string): Viewer3d | undefined
    • Parameters

      • ctrlName: string

      Returns Viewer3d | undefined

Static getWizard

getWizard: (ctrlName: string) => Wizard | undefined = ...

Type declaration

    • (ctrlName: string): Wizard | undefined
    • Parameters

      • ctrlName: string

      Returns Wizard | undefined

Static getWizardNavigator

getWizardNavigator: (ctrlName: string) => WizardNavigator | undefined = ...

Type declaration

Static getWizardNavigatorBtn

getWizardNavigatorBtn: (ctrlName: string) => WizardNavigatorBtn | undefined = ...

Type declaration

Static getWizardPage

getWizardPage: (ctrlName: string) => WizardPage | undefined = ...

Type declaration

    • Parameters

      • ctrlName: string

      Returns WizardPage | undefined

Static hideLoadMask

hideLoadMask: (msdId: number) => void = ...

Type declaration

    • (msdId: number): void
    • Removes the message from the load mask queue of the specific control and hides the message if it is currently visible.
      Automatically shows load mask with the next message in the queue again if available.

      Parameters

      • msdId: number

        The Id of the message that should be hidden, which was returned by the associated showLoadMask call

      Returns void

Static onCheckboxValueChanged

onCheckboxValueChanged: (ctrlName: string, callback: (value: boolean, ctrl: Checkbox) => void, onlyOnSelected?: boolean, onlyOnDeselected?: boolean) => void = ...

Type declaration

    • (ctrlName: string, callback: (value: boolean, ctrl: Checkbox) => void, onlyOnSelected?: boolean, onlyOnDeselected?: boolean): void
    • Function for assigning a callback to checkbox value changes

      Parameters

      • ctrlName: string
      • callback: (value: boolean, ctrl: Checkbox) => void
          • (value: boolean, ctrl: Checkbox): void
          • Parameters

            Returns void

      • onlyOnSelected: boolean = false

        true: only execute the callback if the checkbox gets selected

      • onlyOnDeselected: boolean = false

        true: only execute the callback if the checkbox gets deselected
        If onlyOnSelected and onlyOnDeselected are true or false simultaniously, the callback will be executed for both states.

      Returns void

Static onComboboxValueChanged

onComboboxValueChanged: (ctrlName: string, callback: (value: CmpSimpleValue, ctrl: Combobox) => void) => void = ...

Type declaration

Static onCtrlClicked

onCtrlClicked: (ctrlName: string, callback: () => void) => void = ...

Type declaration

    • (ctrlName: string, callback: () => void): void
    • Parameters

      • ctrlName: string
      • callback: () => void
          • (): void
          • Returns void

      Returns void

Static onCtrlRendered

onCtrlRendered: (ctrlName: string, callback: (ctrl: Base) => void) => void = ...

Type declaration

    • (ctrlName: string, callback: (ctrl: Base) => void): void
    • Parameters

      • ctrlName: string
      • callback: (ctrl: Base) => void
          • (ctrl: Base): void
          • Parameters

            Returns void

      Returns void

Static onCtrlVisibilityChanged

onCtrlVisibilityChanged: (ctrlName: string, callback: (ctrl: Base, visibility: string) => void, onlyOnShow?: boolean, onlyOnHide?: boolean) => void = ...

Type declaration

    • (ctrlName: string, callback: (ctrl: Base, visibility: string) => void, onlyOnShow?: boolean, onlyOnHide?: boolean): void
    • Parameters

      • ctrlName: string
      • callback: (ctrl: Base, visibility: string) => void
          • (ctrl: Base, visibility: string): void
          • Parameters

            • ctrl: Base
            • visibility: string

            Returns void

      • Optional onlyOnShow: boolean
      • Optional onlyOnHide: boolean

      Returns void

Static onDataviewEntriesChanged

onDataviewEntriesChanged: (ctrlName: string, callback: (dataview: Dataview) => void) => void = ...

Type declaration

    • (ctrlName: string, callback: (dataview: Dataview) => void): void
    • Parameters

      • ctrlName: string
      • callback: (dataview: Dataview) => void

      Returns void

Static onDataviewValueChanged

onDataviewValueChanged: (ctrlName: string, callback: (value: CmpSimpleValue, ctrl: Dataview) => void) => void = ...

Type declaration

Static onInteractiveVisualClicked

onInteractiveVisualClicked: (ctrlName: string, callback: InteractiveVisualClickedCallback, visualName?: string) => void = ...

Type declaration

Static onRadiobuttonValueChanged

onRadiobuttonValueChanged: (ctrlName: string, callback: (value: string, ctrl: Radiobutton) => void, onlyOnSelected?: boolean, onlyOnDeselected?: boolean) => void = ...

Type declaration

    • (ctrlName: string, callback: (value: string, ctrl: Radiobutton) => void, onlyOnSelected?: boolean, onlyOnDeselected?: boolean): void
    • Function for assigning a callback to radiobutton value changes

      Parameters

      • ctrlName: string
      • callback: (value: string, ctrl: Radiobutton) => void
      • onlyOnSelected: boolean = false

        true: only execute the callback if the radiobutton gets selected

      • onlyOnDeselected: boolean = false

        true: only execute the callback if the radiobutton gets deselected
        If onlyOnSelected and onlyOnDeselected are true or false simultaniously, the callback will be executed for both states.

      Returns void

Static onSliderValueChanged

onSliderValueChanged: (ctrlName: string, callback: (value: number, ctrl: Slider) => void, onSliding?: boolean, throttleMS?: number) => void = ...

Type declaration

    • (ctrlName: string, callback: (value: number, ctrl: Slider) => void, onSliding?: boolean, throttleMS?: number): void
    • Function for assigning a callback to slider value changes.
      It can be configured whether the callback should be executed on each change or just when the final slider position is reached.
      Furthermore a throttling time can be configured, so that the amount of callback executions will be limited.

      Parameters

      • ctrlName: string
      • callback: (value: number, ctrl: Slider) => void
          • (value: number, ctrl: Slider): void
          • Parameters

            Returns void

      • onSliding: boolean = false

        true: execute callback on each change, false: execute callback when slider movement is finished

      • Optional throttleMS: number

        Makes sure that the callback function is not executed multiple times within this time, only takes effect if onSliding is true.
        - 0: no throttling
        - > 0: throttling with the defined time in milliseconds
        - undefined: use default throttling time from slider control

      Returns void

Static onTextboxValueChanged

onTextboxValueChanged: (ctrlName: string, callback: (value: string, ctrl: Textbox) => void, trigger?: TextboxValueChangeTrigger, debounceMS?: number) => void = ...

Type declaration

    • Function for assigning a callback to textbox value changes.
      The function can distinguish between different trigger modes, so that the user can decide if the callback should be executed on each character input, when pressing enter, when leaving the textbox or on a combination of these trigger events.
      Furthermore the function can be debounced to minimize the amount of callback executions.
      If neither the trigger parameter, nor the debounceMS parameter is set, the function behaves exactly as the "Value Changed" signal of the textbox control.

      Parameters

      • ctrlName: string
      • callback: (value: string, ctrl: Textbox) => void
          • (value: string, ctrl: Textbox): void
          • Parameters

            Returns void

      • trigger: TextboxValueChangeTrigger = ...

        Decide on which trigger the value change callback should be executed, see Cbn.CJS.TextboxValueChangeTrigger for detailed information about the options.
        If the trigger input is left undefined, on typing and enter submit triggers will be used.

      • Optional debounceMS: number

        Defers the call until the value changed event hasn't been triggered for this amount of time, only takes effect for Cbn.CJS.TextboxValueChangeTrigger.OnTyping trigger.
        - 0: no debouncing
        - > 0: debouncing with the defined time in milliseconds
        - undefined: use default debouncing time from textbox control

      Returns void

Static onWizardPageActivated

onWizardPageActivated: (ctrlName: string, callback: (page: WizardPage) => void) => void = ...

Type declaration

    • (ctrlName: string, callback: (page: WizardPage) => void): void

Static resetLoadMask

resetLoadMask: (ctrlName?: string) => void = ...

Type declaration

    • (ctrlName?: string): void
    • Can be used to force hiding the load mask completly and clear the load mask queue for a specific control

      Parameters

      • Optional ctrlName: string

        Name of control for which the load mask queue should be cleared. Viewport is used if not given.

      Returns void

Static setLoadMaskQueueMode

setLoadMaskQueueMode: (mode: LoadMaskQueueMode) => void = ...

Type declaration

Static showLoadMask

showLoadMask: (msg?: string, ctrlName?: string, cls?: string, forceShow?: boolean) => number = ...

Type declaration

    • (msg?: string, ctrlName?: string, cls?: string, forceShow?: boolean): number
    • Show load mask on the viewport or the given control.
      Additionally the messages get queued within this function, so if a visible message gets hidden, the next one in the queue gets shown automatically.
      Queues exist for each individual control.
      The behaviour of the queues (FIFO, FILO) can be defined globally by using the setLoadMaskQueueMode function.

      If the load mask should be shown on the viewport and there is already an error dialog visible, the call to showLoadMask will be ignored.
      Also active load masks on the viewport are automatically hidden, when an error dialog is shown.

      Parameters

      • Optional msg: string

        Message to display on the loading mask. 'Loading...' is shown if not given.

      • Optional ctrlName: string

        Name of control on which the load mask should be shown. Viewport is used if not given.

      • Optional cls: string

        Class(es) which should be set for the loadmask, multiple classes can be assigend by seperating them with spaces (eg: class1 class2 class3)

      • Optional forceShow: boolean

        true: shows message immediatly, even if it would have lower priority according to the queue mode

      Returns number

      Id of the message created by this function.
      Can be used to hide this specific message again using hideLoadMask

Generated using TypeDoc