trueChart Core API

Action parameters

Index

Type aliases

Type aliases

TApplyBookmarkParameter

TApplyBookmarkParameter: object

Type declaration

  • bookmarkId: string

    Id of the bookmark to be applied

TClearAllFieldsParameter

TClearAllFieldsParameter: Pick<TFieldParameter, "softLock" | "alternateState">

TCustomParameter

TCustomParameter: object

Action parameter of the Custom action

Type declaration

  • functionBody: string

    Function body to execute

TFieldParameter

TFieldParameter: object

Action parameter of "select" actions

Type declaration

  • Optional alternateState?: undefined | string

    State of the field (only in Qlik Sense available)

  • fieldName: string

    Name of the field

  • Optional softLock?: undefined | false | true

    If true, locked fields will be treated as if they were not locked (only in Qlik Sense available)

TGoToAppOptionalParameter

TGoToAppOptionalParameter: object | object

Optional parameter of the GoToApp action

TGoToAppParameter

TGoToAppParameter: TShareAppParameter & object

Action parameter of the GoToApp action

TGoToSheetParameter

TGoToSheetParameter: object

Action parameter of the GoToSheet action

Type declaration

  • sheetId: string

    Id of the target sheet

TGoToStoryParameter

TGoToStoryParameter: object

Action parameter of the GoToStory action

Type declaration

  • storyId: string

    Id of the target story

TGoToURLParameter

TGoToURLParameter: object

Action parameter of the GoToURL action

Type declaration

  • Optional download?: undefined | false | true

    If true, the given URL must be downloaded instead of opened

  • Optional inMashupOnly?: undefined | false | true

    If true, action must be performed only in Mashup

  • Optional target?: TUrlTarget | string

    Target window (name)

  • url: string

    Target url

TLockAllFieldsParameter

TLockAllFieldsParameter: Pick<TFieldParameter, "alternateState">

TReloadDataParameter

TReloadDataParameter: object

Type declaration

  • Optional mode?: undefined | string

    Mode of the data reload

  • Optional partial?: undefined | false | true

    If true, only a partial data reload will be performed

TSelectMatchParameter

TSelectMatchParameter: TFieldParameter & object

TSelectValuesParameter

TSelectValuesParameter: TFieldParameter & object

TSetCellValueParameter

TSetCellValueParameter: object

Action parameter of the SetCellValue action

Type declaration

  • address: string

    cell address

  • sheetId: string

    Id of the target sheet

  • value: string

    new value to be set

TSetVariableParameter

TSetVariableParameter: object

Type declaration

  • Optional keepValue?: undefined | false | true

    If true, variable value will be set only if variable has no current value

  • name: string

    Name of the variable

  • Optional value?: undefined | string

    Variable value to be set

TShareAppParameter

TShareAppParameter: object

Type declaration

  • Optional emailAddress?: undefined | string

    Email address in combination with email target

  • Optional emailBody?: undefined | string

    Email body in combination with email target

  • Optional emailSubject?: undefined | string

    Email subject in combination with email target

  • Optional linkPlaceholder?: undefined | string

    Placeholder of the generated link in combination with email target

  • Optional target?: TShareAppTarget

    Target of the ShareApp action

TShareAppTarget

TShareAppTarget: "email" | "clipboard"

Target of the ShareApp action

TToggleFullScreenParameter

TToggleFullScreenParameter: object

Type declaration

  • Optional condition?: undefined | string

    Condition of the ToggleFullScreen action (true -> enable fullscreen, false -> disable fullscreen, 'empty | undefined' -> toggle fullscreen

TUrlTarget

TUrlTarget: "_blank" | "_self"

Target of the GoToURL action