Menu

This page lists all Scripting methods that are available in the Lumira Designer Scripting Environment. All getter/setters return, unless otherwise noted, the value that would be entered in the GPS, and behave the same as documented on our wiki.

Hierarchy

  • ScriptingApi

Index

axes Methods

chart specific Methods

data Methods

event Methods

labels Methods

axes Methods

addWidthPerColumnJsonStringElement

  • addWidthPerColumnJsonStringElement(widthPerColumnElement: string): void

  • Parameters

    • widthPerColumnElement: string

    Returns void

getAlternateRowStyling

  • getAlternateRowStyling(): boolean

  • Returns boolean

getColumnMargin

  • getColumnMargin(): string

  • Returns string

getColumnWidth

  • getColumnWidth(): string

  • Returns string

getCrossTabRowHeader

  • getCrossTabRowHeader(): boolean

  • Returns boolean

getHeaderRowDividerColor

  • getHeaderRowDividerColor(): string

getHeaderRowDividerThickness

  • getHeaderRowDividerThickness(): string

  • Returns string

getHeaderRowDividers

  • getHeaderRowDividers(): boolean

  • Returns boolean

getInitialRowExpandLevel

  • getInitialRowExpandLevel(): number

  • Returns number

getRowDividerColor

  • getRowDividerColor(): string

getRowDividerThickness

  • getRowDividerThickness(): string

  • Returns string

getRowDividers

  • getRowDividers(): boolean

  • Returns boolean

getSuppressRepeatingColumnHeader

  • getSuppressRepeatingColumnHeader(): boolean

  • Returns boolean

getSuppressRepeatingRowHeader

  • getSuppressRepeatingRowHeader(): boolean

  • Returns boolean

getWidthPerColumnJsonString

  • getWidthPerColumnJsonString(): string

  • Returns string

removeWidthPerColumnJsonStringElement

  • removeWidthPerColumnJsonStringElement(index: number): void

  • Parameters

    • index: number

      the index of the element that should be removed

    Returns void

replaceWidthPerColumnJsonStringElement

  • replaceWidthPerColumnJsonStringElement(widthPerColumnElement: string, index: number): void

  • Parameters

    • widthPerColumnElement: string
    • index: number

    Returns void

setAlternateRowStyling

  • setAlternateRowStyling(newValue: boolean): void

  • Parameters

    • newValue: boolean

    Returns void

setColumnMargin

  • setColumnMargin(newValue: string): void

  • Parameters

    • newValue: string

    Returns void

setColumnWidth

  • setColumnWidth(newValue: string): void

  • Parameters

    • newValue: string

    Returns void

setCrossTabRowHeader

  • setCrossTabRowHeader(newValue: boolean): void

  • Parameters

    • newValue: boolean

    Returns void

setHeaderRowDividerColor

  • setHeaderRowDividerColor(newValue: string): void

  • Parameters

    Returns void

setHeaderRowDividerThickness

  • setHeaderRowDividerThickness(newValue: string): void

  • Parameters

    • newValue: string

    Returns void

setHeaderRowDividers

  • setHeaderRowDividers(newValue: boolean): void

  • Parameters

    • newValue: boolean

    Returns void

setInitialRowExpandLevel

  • setInitialRowExpandLevel(newValue: number): void

  • Parameters

    • newValue: number

    Returns void

setRowDividerColor

  • setRowDividerColor(newValue: string): void

  • Parameters

    Returns void

setRowDividerThickness

  • setRowDividerThickness(newValue: string): void

  • Parameters

    • newValue: string

    Returns void

setRowDividers

  • setRowDividers(newValue: boolean): void

  • Parameters

    • newValue: boolean

    Returns void

setSuppressRepeatingColumnHeader

  • setSuppressRepeatingColumnHeader(newValue: boolean): void

  • Parameters

    • newValue: boolean

    Returns void

setSuppressRepeatingRowHeader

  • setSuppressRepeatingRowHeader(newValue: boolean): void

  • Parameters

    • newValue: boolean

    Returns void

setWidthPerColumnJsonString

  • setWidthPerColumnJsonString(newValue: string): void

  • Parameters

    • newValue: string

      an json string that represents an array numbers

    Returns void

chart specific Methods

addBackgroundBarChartAssignmentJsonStringElement

  • addBackgroundBarChartAssignmentJsonStringElement(backgroundBarChartAssignmentElement: string): void

  • Parameters

    • backgroundBarChartAssignmentElement: string

      an json string that represents a single object of the Type BackgroundBarSelection

    Returns void

addBarChartAssignmentJsonStringElement

  • addBarChartAssignmentJsonStringElement(barChartAssignmentElement: string): void

  • Parameters

    • barChartAssignmentElement: string

      an json string that represents a single object of the Type BarChartSelection

    Returns void

addPinChartAssignmentJsonStringElement

  • addPinChartAssignmentJsonStringElement(pinChartAssignmentElement: string): void

  • Parameters

    • pinChartAssignmentElement: string

      an json string that represents a single object of the Type PinChartSelection

    Returns void

getBackgroundBarBadColor

  • getBackgroundBarBadColor(): string

getBackgroundBarChartAssignmentJsonString

  • getBackgroundBarChartAssignmentJsonString(): string

getBackgroundBarGoodColor

  • getBackgroundBarGoodColor(): string

getBackgroundBarNegativeRtl

  • getBackgroundBarNegativeRtl(): boolean

  • Returns boolean

getBadColor

  • getBadColor(): string

getBarChartAssignmentJsonString

  • getBarChartAssignmentJsonString(): string

  • Returns string

    an json string that represents an array of objects of the Type BarChartSelection

getGoodColor

  • getGoodColor(): string

getOutlierStyle

  • getOutlierStyle(): string

  • Returns string

getPinChartAssignmentJsonString

  • getPinChartAssignmentJsonString(): string

  • Returns string

    an json string that represents an array of objects of the Type PinChartSelection

removeBackgroundBarChartAssignmentJsonStringElement

  • removeBackgroundBarChartAssignmentJsonStringElement(index: number): void

  • Parameters

    • index: number

      the index of the element that should be removed

    Returns void

removeBarChartAssignmentJsonStringElement

  • removeBarChartAssignmentJsonStringElement(index: number): void

  • Parameters

    • index: number

      the index of the element that should be removed

    Returns void

removePinChartAssignmentJsonStringElement

  • removePinChartAssignmentJsonStringElement(index: number): void

  • Parameters

    • index: number

      the index of the element that should be removed

    Returns void

replaceBackgroundBarChartAssignmentJsonStringElement

  • replaceBackgroundBarChartAssignmentJsonStringElement(backgroundBarChartAssignmentElement: string, index: number): void

  • Parameters

    • backgroundBarChartAssignmentElement: string

      an json string that represents a single object of the Type BackgroundBarSelection

    • index: number

      the index, at which the element should be inserted

    Returns void

replaceBarChartAssignmentJsonStringElement

  • replaceBarChartAssignmentJsonStringElement(barChartAssignmentElement: string, index: number): void

  • Parameters

    • barChartAssignmentElement: string

      an json string that represents a single object of the Type BarChartSelection

    • index: number

      the index, at which the element should be inserted

    Returns void

replacePinChartAssignmentJsonStringElement

  • replacePinChartAssignmentJsonStringElement(pinChartAssignmentElement: string, index: number): void

  • Parameters

    • pinChartAssignmentElement: string

      an json string that represents a single object of the Type PinChartSelection

    • index: number

      the index, at which the element should be inserted

    Returns void

setBackgroundBarBadColor

  • setBackgroundBarBadColor(newValue: string): void

  • Parameters

    Returns void

setBackgroundBarChartAssignmentJsonString

  • setBackgroundBarChartAssignmentJsonString(newValue: string): void

  • Parameters

    Returns void

setBackgroundBarGoodColor

  • setBackgroundBarGoodColor(newValue: string): void

  • Parameters

    Returns void

setBackgroundBarNegativeRtl

  • setBackgroundBarNegativeRtl(newValue: boolean): void

  • Parameters

    • newValue: boolean

    Returns void

setBadColor

  • setBadColor(newValue: string): void

  • Parameters

    Returns void

setBarChartAssignmentJsonString

  • setBarChartAssignmentJsonString(newValue: string): void

  • Parameters

    • newValue: string

      an json string that represents an array of objects of the Type BarChartSelection

    Returns void

setGoodColor

  • setGoodColor(newValue: string): void

  • Parameters

    Returns void

setOutlierStyle

setPinChartAssignmentJsonString

  • setPinChartAssignmentJsonString(newValue: string): void

  • Parameters

    • newValue: string

      an json string that represents an array of objects of the Type PinChartSelection

    Returns void

data Methods

addDeviationConfigsJsonStringElement

  • addDeviationConfigsJsonStringElement(deviationConfigsElement: string): void

  • Parameters

    • deviationConfigsElement: string

      an json string that represents a single object of the Type DeviationConfig

    Returns void

addScenarioAssignmentJsonStringElement

  • addScenarioAssignmentJsonStringElement(scenarioAssignmentElement: string): void

  • Parameters

    • scenarioAssignmentElement: string

      an json string that represents a single object of the Type ScenarioSelection

    Returns void

addSortByMemberJsonStringElement

  • addSortByMemberJsonStringElement(sortByMemberElement: string): void

  • Parameters

    • sortByMemberElement: string

      an json string that represents a single object of the Type SortByMemberConfig

    Returns void

getAggregationNodeName

  • getAggregationNodeName(): string

  • Returns string

getAggregationType

getDeviationConfigsJsonString

  • getDeviationConfigsJsonString(): string

  • Returns string

    an json string that represents an array of objects of the Type DeviationConfig

getFollowingSums

  • getFollowingSums(): boolean

  • Returns boolean

getGlobalDataTypesJsonString

  • getGlobalDataTypesJsonString(): string

  • Returns string

getScenarioAssignmentJsonString

  • getScenarioAssignmentJsonString(): string

  • Returns string

    an json string that represents an array of objects of the Type ScenarioSelection

getShowScenariosInColumnHeaders

  • getShowScenariosInColumnHeaders(): boolean

  • Returns boolean

getSortByMemberJsonString

  • getSortByMemberJsonString(): string

  • Returns string

    an json string that represents an array of objects of the Type SortByMemberConfig

removeDeviationConfigsJsonStringElement

  • removeDeviationConfigsJsonStringElement(index: number): void

  • Parameters

    • index: number

      the index of the element that should be removed

    Returns void

removeScenarioAssignmentJsonStringElement

  • removeScenarioAssignmentJsonStringElement(index: number): void

  • Parameters

    • index: number

      the index of the element that should be removed

    Returns void

removeSortByMemberJsonStringElement

  • removeSortByMemberJsonStringElement(index: number): void

  • Parameters

    • index: number

      the index of the element that should be removed

    Returns void

replaceDeviationConfigsJsonStringElement

  • replaceDeviationConfigsJsonStringElement(deviationConfigsElement: string, index: number): void

  • Parameters

    • deviationConfigsElement: string

      an json string that represents a single object of the Type DeviationConfig

    • index: number

      the index, at which the element should be inserted

    Returns void

replaceScenarioAssignmentJsonStringElement

  • replaceScenarioAssignmentJsonStringElement(scenarioAssignmentElement: string, index: number): void

  • Parameters

    • scenarioAssignmentElement: string

      an json string that represents a single object of the Type ScenarioSelection

    • index: number

      the index, at which the element should be inserted

    Returns void

replaceSortByMemberJsonStringElement

  • replaceSortByMemberJsonStringElement(sortByMemberElement: string, index: number): void

  • Parameters

    • sortByMemberElement: string

      an json string that represents a single object of the Type SortByMemberConfig

    • index: number

      the index, at which the element should be inserted

    Returns void

setAggregationNodeName

  • setAggregationNodeName(newValue: string): void

  • Parameters

    • newValue: string

    Returns void

setAggregationType

setDeviationConfigsJsonString

  • setDeviationConfigsJsonString(newValue: string): void

  • Parameters

    • newValue: string

      an json string that represents an array of objects of the Type DeviationConfig

    Returns void

setFollowingSums

  • setFollowingSums(newValue: boolean): void

  • Parameters

    • newValue: boolean

    Returns void

setGlobalDataTypesJsonString

  • setGlobalDataTypesJsonString(newValue: string): void

  • Parameters

    • newValue: string

    Returns void

setScenarioAssignmentJsonString

  • setScenarioAssignmentJsonString(newValue: string): void

  • Parameters

    • newValue: string

      an json string that represents an array of objects of the Type ScenarioSelection

    Returns void

setShowScenariosInColumnHeaders

  • setShowScenariosInColumnHeaders(newValue: boolean): void

  • Parameters

    • newValue: boolean

    Returns void

setSortByMemberJsonString

  • setSortByMemberJsonString(newValue: string): void

  • Parameters

    • newValue: string

      an json string that represents an array of objects of the Type SortByMemberConfig

    Returns void

event Methods

getSelectedData

  • Returns DataSelection[]

    When the onDataSelect event was thrown, this method returns an array of Data Selections describing each selected cell

getSelectedMember

  • getSelectedMember(dimension: string): BialMember

  • Parameters

    • dimension: string

      The key of the Dimension for which the selected member should be returned

    Returns BialMember

    Returns the member of a given dimension for the selected cell. This method is only usable with the "SINGLE" SelectionMode.

labels Methods

addCflRulesJsonStringElement

  • addCflRulesJsonStringElement(cflRulesElement: string): any

  • Parameters

    • cflRulesElement: string

    Returns any

addValueFormatAssignmentJsonStringElement

  • addValueFormatAssignmentJsonStringElement(formatValueAssignmentElement: string): void

  • Parameters

    • formatValueAssignmentElement: string

      an json string that represents a single object of the Type NumberFormatSelection

    Returns void

getBackgroundColor

  • getBackgroundColor(): string

getCflRulesJsonString

  • getCflRulesJsonString(): string

  • Returns string

getDataTextAlign

  • getDataTextAlign(): string

  • Returns string

    "left", "center" or "right"

getFollowingHierarchyNodeRowDividers

  • getFollowingHierarchyNodeRowDividers(): boolean

  • Returns boolean

getFontColor

  • getFontColor(): string

getFontFamily

  • getFontFamily(): string

  • Returns string

getFontSize

  • getFontSize(): string

  • Returns string

getFooterFontSize

  • getFooterFontSize(): string

  • Returns string

getFooterText

  • getFooterText(): string

  • Returns string

getHeaderElipsis

  • getHeaderElipsis(): boolean

  • Returns boolean

getHierarchyNodeBold

  • getHierarchyNodeBold(): boolean

  • Returns boolean

getHierarchyNodeCollapsible

  • getHierarchyNodeCollapsible(): boolean

  • Returns boolean

getHierarchyNodeColor

  • getHierarchyNodeColor(): string

getHierarchyNodeIndentation

  • getHierarchyNodeIndentation(): string

  • Returns string

getHierarchyNodeItalic

  • getHierarchyNodeItalic(): boolean

  • Returns boolean

getHierarchyNodeRowDividerColor

  • getHierarchyNodeRowDividerColor(): string

getHierarchyNodeRowDividerThickness

  • getHierarchyNodeRowDividerThickness(): string

  • Returns string

getHierarchyNodeRowDividers

  • getHierarchyNodeRowDividers(): boolean

  • Returns boolean

getPadding

  • getPadding(): string

  • Returns string

getShowFooter

  • getShowFooter(): boolean

  • Returns boolean

getShowTitle

  • getShowTitle(): boolean

  • Returns boolean

getTitleFontSize

  • getTitleFontSize(): string

  • Returns string

getTitleText

  • getTitleText(): string

  • Returns string

getValueFormatAssignmentJsonString

  • getValueFormatAssignmentJsonString(): string

removeCflRulesJsonStringElement

  • removeCflRulesJsonStringElement(index: number): any

  • Parameters

    • index: number

    Returns any

removeValueFormatAssignmentJsonStringElement

  • removeValueFormatAssignmentJsonStringElement(index: number): void

  • Parameters

    • index: number

      the index of the element that should be removed

    Returns void

replaceCflRulesJsonStringElement

  • replaceCflRulesJsonStringElement(cflRulesElement: string, index: number): any

  • Parameters

    • cflRulesElement: string
    • index: number

    Returns any

replaceValueFormatAssignmentJsonStringElement

  • replaceValueFormatAssignmentJsonStringElement(formatValueAssignmentElement: string, index: number): void

  • Parameters

    • formatValueAssignmentElement: string

      an json string that represents a single object of the Type NumberFormatSelection

    • index: number

      the index, at which the element should be inserted

    Returns void

setBackgroundColor

  • setBackgroundColor(newValue: string): void

  • Parameters

    Returns void

setCflRulesJsonString

  • setCflRulesJsonString(newValue: string): void

  • Parameters

    • newValue: string

    Returns void

setCflVariable

  • setCflVariable(variableKey: string, variableValue: string): any

  • Parameters

    • variableKey: string

      The key of the cfl variable that should be set

    • variableValue: string

      The value to which the variable should be set as json value. eg. 5 for a number or "Hello" for a string

    Returns any

setDataTextAlign

  • setDataTextAlign(newValue: string): void

  • Parameters

    • newValue: string

      Valid values: "left", "center", "right"

    Returns void

setFollowingHierarchyNodeRowDividers

  • setFollowingHierarchyNodeRowDividers(newValue: boolean): void

  • Parameters

    • newValue: boolean

    Returns void

setFontColor

  • setFontColor(newValue: string): void

  • Parameters

    Returns void

setFontFamily

  • setFontFamily(newValue: string): void

  • Parameters

    • newValue: string

    Returns void

setFontSize

  • setFontSize(newValue: string): void

  • Parameters

    • newValue: string

    Returns void

setFooterFontSize

  • setFooterFontSize(newValue: string): void

  • Parameters

    • newValue: string

    Returns void

setFooterText

  • setFooterText(newValue: string): void

  • Parameters

    • newValue: string

    Returns void

setHeaderElipsis

  • setHeaderElipsis(newValue: boolean): void

  • Parameters

    • newValue: boolean

    Returns void

setHierarchyNodeBold

  • setHierarchyNodeBold(newValue: boolean): void

  • Parameters

    • newValue: boolean

    Returns void

setHierarchyNodeCollapsible

  • setHierarchyNodeCollapsible(newValue: boolean): void

  • Parameters

    • newValue: boolean

    Returns void

setHierarchyNodeColor

  • setHierarchyNodeColor(newValue: string): void

  • Parameters

    Returns void

setHierarchyNodeIndentation

  • setHierarchyNodeIndentation(newValue: string): void

  • Parameters

    • newValue: string

    Returns void

setHierarchyNodeItalic

  • setHierarchyNodeItalic(newValue: boolean): void

  • Parameters

    • newValue: boolean

    Returns void

setHierarchyNodeRowDividerColor

  • setHierarchyNodeRowDividerColor(newValue: string): void

  • Parameters

    Returns void

setHierarchyNodeRowDividerThickness

  • setHierarchyNodeRowDividerThickness(newValue: string): void

  • Parameters

    • newValue: string

    Returns void

setHierarchyNodeRowDividers

  • setHierarchyNodeRowDividers(newValue: boolean): void

  • Parameters

    • newValue: boolean

    Returns void

setPadding

  • setPadding(newValue: string): void

  • Parameters

    • newValue: string

    Returns void

setShowFooter

  • setShowFooter(newValue: boolean): void

  • Parameters

    • newValue: boolean

    Returns void

setShowTitle

  • setShowTitle(newValue: boolean): void

  • Parameters

    • newValue: boolean

    Returns void

setTitleFontSize

  • setTitleFontSize(newValue: string): void

  • Parameters

    • newValue: string

    Returns void

setTitleText

  • setTitleText(newValue: string): void

  • Parameters

    • newValue: string

    Returns void

setValueFormatAssignmentJsonString

  • setValueFormatAssignmentJsonString(newValue: string): void

  • Parameters

    Returns void