Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ScriptingApi

This page lists all scripting methods available for the graphomate matrix custom widget in the SAC Application Designer Scripting Environment.

Hierarchy

  • ScriptingApi

Index

Event Properties

General Methods

aggregationConfigs Methods

aggregationNodeName Methods

aggregationType Methods

alternateRowStyling Methods

backgroundBarAssignment Methods

backgroundBarBadColor Methods

backgroundBarGoodColor Methods

backgroundBarNegativeRtl Methods

backgroundBarOpacity Methods

backgroundColor Methods

badColor Methods

barChartAssignment Methods

bindDataPointCommentsToInstance Methods

bindVisualisationCommentToInstance Methods

cflRules Methods

cflVariables Methods

columnHeaderTextAlign Methods

columnMargin Methods

columnWidth Methods

commentingBackendServerUrl Methods

commentingFontFamily Methods

commentingHiddenContexts Methods

commentingInitialText Methods

commentingMoreCommentsExpandable Methods

commentingShowAuthoringInformation Methods

commentingShowContexts Methods

commentingShowMenuEdge Methods

commentingShowMoreComments Methods

crossTabRowHeader Methods

customCalculationConfigs Methods

customCss Methods

dataPointCommentRepresentation Methods

dataTextAlign Methods

datasourceFilter Methods

datasourceVariables Methods

deviationChartLabelSize Methods

deviationConfigs Methods

dynamicContexts Methods

editabilityAssignment Methods

followingHierarchyNodeRowDividers Methods

followingResults Methods

fontColor Methods

fontFamily Methods

fontSize Methods

footerFontSize Methods

footerText Methods

goodColor Methods

headerElipsis Methods

headerRowDividerColor Methods

headerRowDividerThickness Methods

headerRowDividers Methods

hierarchyNodeBold Methods

hierarchyNodeCollapsible Methods

hierarchyNodeCollapsibleOnWholeCell Methods

hierarchyNodeColor Methods

hierarchyNodeColumnIndentation Methods

hierarchyNodeIndentation Methods

hierarchyNodeItalic Methods

hierarchyNodeRowDividerColor Methods

hierarchyNodeRowDividerThickness Methods

hierarchyNodeRowDividers Methods

hierarchyNodeRowPadding Methods

hyperAxisConfigs Methods

hyperTrendAssignment Methods

initialRowExpandLevel Methods

measuresInRows Methods

nRestConfigs Methods

outlierStyle Methods

padding Methods

pinChartAssignment Methods

removeDimensionConfigs Methods

rowDividerColor Methods

rowDividerThickness Methods

rowDividers Methods

scenarioAssignment Methods

selectionType Methods

serverUrl Methods

showFooter Methods

showScenariosInColumnHeaders Methods

showTitle Methods

sortByMember Methods

sparkbarAssignment Methods

sparklineAssignment Methods

staticContexts Methods

suppressRepeatingColumnHeader Methods

suppressRepeatingRowHeader Methods

templateName Methods

titleFontSize Methods

titleText Methods

useRuntimeData Methods

visualisationCommentRepresentation Methods

widthPerColumn Methods

Event Properties

onDataChange

onDataChange: Function

This event is fired, when the user changes the data value of cells by editing editable cells. The changed data can be accessed by using the scripting methods getLatestChangedDataValues() and getLatestChangedDataSelections().

onSelect

onSelect: Function

Fires when a data selection was made on this component.

General Methods

addOrReplaceContexts

  • addOrReplaceContexts(contexts: unknown[]): void

  • Adds or replaces multiple contexts

    Parameters

    • contexts: unknown[]

      The contexts to add or replace

    Returns void

addOrReplaceDataContext

  • addOrReplaceDataContext(key: string, value: string): void

  • Adds or replaces a Data Context

    Parameters

    • key: string

      e.g. Key of the Dimension

    • value: string

      e.g. Member of the Dimension

    Returns void

addOrReplaceDataContextWithText

  • addOrReplaceDataContextWithText(key: string, value: string, keyText: string, valueText: string): void

  • Adds or replaces a Data Context with Text

    Parameters

    • key: string

      e.g. Key of the Dimension

    • value: string

      e.g. Member of the Dimension

    • keyText: string

      e.g. Key Text of the Dimension

    • valueText: string

      e.g. Member Text of the Dimension

    Returns void

addOrReplaceEnvironmentContext

  • addOrReplaceEnvironmentContext(key: string, value: string): void

  • Adds or replaces a Environment Context

    Parameters

    • key: string

      e.g. Key of the Environment Context

    • value: string

      e.g. Member of the Value of the Environment Context

    Returns void

clearSelection

  • clearSelection(): void

  • Clears the selection of this visual

    Returns void

createDataContext

  • createDataContext(key: string, value: string): unknown

  • Creates a Data Context for usage in setDynamicContexts

    Parameters

    • key: string

      e.g. Key of the Dimension

    • value: string

      e.g. Member of the Dimension

    Returns unknown

createDataContextWithText

  • createDataContextWithText(key: string, value: string, keyText: string, valueText: string): unknown

  • Creates a Data Context with Text for usage in setDynamicContexts

    Parameters

    • key: string

      e.g. Key of the Dimension

    • value: string

      e.g. Member of the Dimension

    • keyText: string

      e.g. Key Text of the Dimension

    • valueText: string

      e.g. Member Text of the Dimension

    Returns unknown

createEnvironmentContext

  • createEnvironmentContext(key: string, value: string): unknown

  • Creates an Environment Context for usage in setDynamicContexts

    Parameters

    • key: string

      e.g. Key of the Environment Context

    • value: string

      e.g. Member of the Value of the Environment Context

    Returns unknown

filterDataSourceBySelectedData

  • filterDataSourceBySelectedData(dataSource: unknown, dimensions?: string[]): void

  • Filters a dataSource by the selected data from this widget.

    Parameters

    • dataSource: unknown

      Data Source

    • Optional dimensions: string[]

    Returns void

getDataBinding

  • getDataBinding(): unknown

  • returns the databinding

    Returns unknown

getDataSource

  • getDataSource(): unknown

  • returns the datasource

    Returns unknown

getDeviationBadColor

  • getDeviationBadColor(): string

  • Returns the value of the property 'Bad Color'. This method is an alias for 'getBadColor'.

    Returns string

getDeviationGoodColor

  • getDeviationGoodColor(): string

  • Returns the value of the property 'Good Color'. This method is an alias for 'getGoodColor'.

    Returns string

getLatestChangedDataSelections

  • getLatestChangedDataSelections(): SelectionContext[]

  • Returns the selections of single cells which were lately changed by user interactions like the editing of a numeric cell value. Currently the returned array does only contain zero or one elements.

    Returns SelectionContext[]

getLatestChangedDataValues

  • getLatestChangedDataValues(): number[]

  • Returns the new value of cells which were lately changed by user interactions like the editing of a numeric cell value. Currently the returned array does only contain zero or one elements.

    Returns number[]

getNRestAddressSubsetByDescription

  • getNRestAddressSubsetByDescription(description: string): SelectionContext

  • Accesses the item of the widget's array property 'N + Rest' whose description equals the passed one and returns the value of it's property 'Target Dimension Filter (optional). Specify a target dimension subset on which the top/bottom determination is based on. Use this property for example to only include specific keyfigures in the ranking'. This Method is an alias for 'getNRestConfigsAddressSubsetByDescription'.

    Parameters

    • description: string

      The description of the item whose property 'Target Dimension Filter (optional)' should be returned

    Returns SelectionContext

getNRestAddressSubsetByIndex

  • getNRestAddressSubsetByIndex(index: number): SelectionContext

  • Accesses the item of the widget's array property 'N + Rest' at the passed index and returns the value of it's property 'Target Dimension Filter (optional). Specify a target dimension subset on which the top/bottom determination is based on. Use this property for example to only include specific keyfigures in the ranking'. This Method is an alias for 'getNRestConfigsAddressSubsetByIndex'.

    Parameters

    • index: number

      The index of the item whose property 'Target Dimension Filter (optional)' should be returned

    Returns SelectionContext

getNRestDescriptionByIndex

  • getNRestDescriptionByIndex(index: number): string

  • Accesses the item of the widget's array property 'N + Rest' at the passed index and returns the value of it's property 'Description (optional). Short name that describes this configuration to be recognizable'. This Method is an alias for 'getNRestConfigsDescriptionByIndex'.

    Parameters

    • index: number

      The index of the item whose property 'Description (optional)' should be returned

    Returns string

getNRestEnabledByDescription

  • getNRestEnabledByDescription(description: string): boolean

  • Accesses the item of the widget's array property 'N + Rest' whose description equals the passed one and returns the value of it's property 'Enable. Enables the calculation of n top/bottom + rest members'. This Method is an alias for 'getNRestConfigsEnabledByDescription'.

    Parameters

    • description: string

      The description of the item whose property 'Enable' should be returned

    Returns boolean

getNRestEnabledByIndex

  • getNRestEnabledByIndex(index: number): boolean

  • Accesses the item of the widget's array property 'N + Rest' at the passed index and returns the value of it's property 'Enable. Enables the calculation of n top/bottom + rest members'. This Method is an alias for 'getNRestConfigsEnabledByIndex'.

    Parameters

    • index: number

      The index of the item whose property 'Enable' should be returned

    Returns boolean

getNRestJsonString

  • getNRestJsonString(): string

  • Returns the value of the property 'NRest Configs' as a JSON-String. This Method is an alias for 'getNRestConfigsJsonString'.

    Returns string

getNRestMemberNameByDescription

  • getNRestMemberNameByDescription(description: string): string

  • Accesses the item of the widget's array property 'N + Rest' whose description equals the passed one and returns the value of it's property 'Rest Member Name (optional). Specify a member name for the rest member of the target dimension.'. This Method is an alias for 'getNRestConfigsMemberNameByDescription'.

    Parameters

    • description: string

      The description of the item whose property 'Rest Member Name (optional)' should be returned

    Returns string

getNRestMemberNameByIndex

  • getNRestMemberNameByIndex(index: number): string

  • Accesses the item of the widget's array property 'N + Rest' at the passed index and returns the value of it's property 'Rest Member Name (optional). Specify a member name for the rest member of the target dimension.'. This Method is an alias for 'getNRestConfigsMemberNameByIndex'.

    Parameters

    • index: number

      The index of the item whose property 'Rest Member Name (optional)' should be returned

    Returns string

getNRestModeByDescription

  • getNRestModeByDescription(description: string): string

  • Accesses the item of the widget's array property 'N + Rest' whose description equals the passed one and returns the value of it's property 'Mode. Determine the ranking mode top or bottom'. This Method is an alias for 'getNRestConfigsModeByDescription'.

    Parameters

    • description: string

      The description of the item whose property 'Mode' should be returned

    Returns string

getNRestModeByIndex

  • getNRestModeByIndex(index: number): string

  • Accesses the item of the widget's array property 'N + Rest' at the passed index and returns the value of it's property 'Mode. Determine the ranking mode top or bottom'. This Method is an alias for 'getNRestConfigsModeByIndex'.

    Parameters

    • index: number

      The index of the item whose property 'Mode' should be returned

    Returns string

getNRestNByDescription

  • getNRestNByDescription(description: string): number

  • Accesses the item of the widget's array property 'N + Rest' whose description equals the passed one and returns the value of it's property 'Number n of top/bottom members. Number of top/bottom members (excluding the rest member)'. This Method is an alias for 'getNRestConfigsNByDescription'.

    Parameters

    • description: string

      The description of the item whose property 'Number n of top/bottom members' should be returned

    Returns number

getNRestNByIndex

  • getNRestNByIndex(index: number): number

  • Accesses the item of the widget's array property 'N + Rest' at the passed index and returns the value of it's property 'Number n of top/bottom members. Number of top/bottom members (excluding the rest member)'. This Method is an alias for 'getNRestConfigsNByIndex'.

    Parameters

    • index: number

      The index of the item whose property 'Number n of top/bottom members' should be returned

    Returns number

getNRestTargetDimensionByDescription

  • getNRestTargetDimensionByDescription(description: string): string

  • Accesses the item of the widget's array property 'N + Rest' whose description equals the passed one and returns the value of it's property 'Target Dimension. Dimension on whose members the n + rest transformation is performed'. This Method is an alias for 'getNRestConfigsTargetDimensionByDescription'.

    Parameters

    • description: string

      The description of the item whose property 'Target Dimension' should be returned

    Returns string

getNRestTargetDimensionByIndex

  • getNRestTargetDimensionByIndex(index: number): string

  • Accesses the item of the widget's array property 'N + Rest' at the passed index and returns the value of it's property 'Target Dimension. Dimension on whose members the n + rest transformation is performed'. This Method is an alias for 'getNRestConfigsTargetDimensionByIndex'.

    Parameters

    • index: number

      The index of the item whose property 'Target Dimension' should be returned

    Returns string

getOutlierMode

  • getOutlierMode(): string

  • Returns the value of the property 'Outlier Style'. possible values are 'LONG' or 'SHORT'. This method is an alias for 'getOutlierStyle'

    Returns string

getSelectedData

  • getSelectedData(): SelectionContext[]

  • Returns the current selection state of this component

    Returns SelectionContext[]

getSelectedMember

  • getSelectedMember(dimension: string): null | string

  • Returns the key of a member from a given dimension when data was selected (call this method in the onSelect scripting event). This method is only usable with the "SINGLE" SelectionMode

    Parameters

    • dimension: string

      The key of the dimension, of which the member key should be returned

    Returns null | string

getTitle

  • getTitle(): string

  • Returns the value of the property 'Title Text'. This method is an alias for 'getTitleText'.

    Returns string

getValueFormatAssignmentJsonString

  • getValueFormatAssignmentJsonString(): string

  • Returns the Value Format Assignment as a JSON-String.

    Returns string

getWidgetName

  • getWidgetName(): string

  • Returns the current name of the widget

    Returns string

removeContexts

  • removeContexts(contexts: unknown[]): void

  • Removes multiple contexts

    Parameters

    • contexts: unknown[]

      The contexts to remove

    Returns void

removeDataContext

  • removeDataContext(key: string): void

  • Removes Data Context

    Parameters

    • key: string

      e.g. Key of the Dimension

    Returns void

removeEnvironmentContext

  • removeEnvironmentContext(key: string): void

  • Removes Data Environment

    Parameters

    • key: string

      e.g. Key of the Environment Context

    Returns void

setCflVariable

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

  • Sets the value of a CFL variable.

    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 void

setDeviationBadColor

  • setDeviationBadColor(newBadColor: string): void

  • Sets the value of the property 'Bad Color'. Only hexadecimal color codes are allowed. E.g. '#FF0000'. This method is an alias for 'setBadColor'.

    Parameters

    • newBadColor: string

      Bad Color

    Returns void

setDeviationGoodColor

  • setDeviationGoodColor(newGoodColor: string): void

  • Sets the value of the property 'Good Color'. Only hexadecimal color codes are allowed. E.g. '#FF0000'. This method is an alias for 'setGoodColor'.

    Parameters

    • newGoodColor: string

      Good Color

    Returns void

setNRestAddressSubsetByDescription

  • setNRestAddressSubsetByDescription(newValue: SelectionContext, description: string): void

  • Accesses the item of the widget's array property 'N + Rest' whose description equals the passed one and assigns the passed new value to it's property 'Target Dimension Filter (optional). This Method is an alias for 'setNRestConfigsAddressSubsetByDescription'.'

    Parameters

    • newValue: SelectionContext

      The new value to be assigned to the property 'Target Dimension Filter (optional). Specify a target dimension subset on which the top/bottom determination is based on. Use this property for example to only include specific keyfigures in the ranking'

    • description: string

      The description of the item whose property 'Target Dimension Filter (optional)' should be set

    Returns void

setNRestAddressSubsetByIndex

  • setNRestAddressSubsetByIndex(newValue: SelectionContext, index: number): void

  • Accesses the item of the widget's array property 'N + Rest' at the passed index and assigns the passed new value to it's property 'Target Dimension Filter (optional)'. This Method is an alias for 'setNRestConfigsAddressSubsetByIndex'.

    Parameters

    • newValue: SelectionContext

      The new value to be assigned to the property 'Target Dimension Filter (optional). Specify a target dimension subset on which the top/bottom determination is based on. Use this property for example to only include specific keyfigures in the ranking'

    • index: number

      The index of the item whose property 'Target Dimension Filter (optional)' should be set

    Returns void

setNRestDescriptionByDescription

  • setNRestDescriptionByDescription(newValue: string, description: string): void

  • Accesses the item of the widget's array property 'N + Rest' whose description equals the passed one and assigns the passed new value to it's property 'Description (optional)'. This Method is an alias for 'setNRestConfigsDescriptionByDescription'.

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Description (optional). Short name that describes this configuration to be recognizable'

    • description: string

      The description of the item whose property 'Description (optional)' should be set

    Returns void

setNRestDescriptionByIndex

  • setNRestDescriptionByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'N + Rest' at the passed index and assigns the passed new value to it's property 'Description (optional)'. This Method is an alias for 'setNRestConfigsDescriptionByIndex'.

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Description (optional). Short name that describes this configuration to be recognizable'

    • index: number

      The index of the item whose property 'Description (optional)' should be set

    Returns void

setNRestEnabledByDescription

  • setNRestEnabledByDescription(newValue: boolean, description: string): void

  • Accesses the item of the widget's array property 'N + Rest' whose description equals the passed one and assigns the passed new value to it's property 'Enable'. This Method is an alias for 'setNRestConfigsEnabledByDescription'.

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Enable. Enables the calculation of n top/bottom + rest members'

    • description: string

      The description of the item whose property 'Enable' should be set

    Returns void

setNRestEnabledByIndex

  • setNRestEnabledByIndex(newValue: boolean, index: number): void

  • Accesses the item of the widget's array property 'N + Rest' at the passed index and assigns the passed new value to it's property 'Enable'. This Method is an alias for 'setNRestConfigsEnabledByIndex'.

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Enable. Enables the calculation of n top/bottom + rest members'

    • index: number

      The index of the item whose property 'Enable' should be set

    Returns void

setNRestJsonString

  • setNRestJsonString(newNRestConfigs: string): void

  • Sets the value of the property 'NRest Configs' as a JSON-String. This Method is an alias for 'setNRestConfigsJsonString'.

    Parameters

    • newNRestConfigs: string

      NRest Configs

    Returns void

setNRestMemberNameByDescription

  • setNRestMemberNameByDescription(newValue: string, description: string): void

  • Accesses the item of the widget's array property 'N + Rest' whose description equals the passed one and assigns the passed new value to it's property 'Rest Member Name (optional)'. This Method is an alias for 'setNRestConfigsMemberNameByDescription'.

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Rest Member Name (optional). Specify a member name for the rest member of the target dimension.'

    • description: string

      The description of the item whose property 'Rest Member Name (optional)' should be set

    Returns void

setNRestMemberNameByIndex

  • setNRestMemberNameByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'N + Rest' at the passed index and assigns the passed new value to it's property 'Rest Member Name (optional)'. This Method is an alias for 'setNRestConfigsMemberNameByIndex'.

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Rest Member Name (optional). Specify a member name for the rest member of the target dimension.'

    • index: number

      The index of the item whose property 'Rest Member Name (optional)' should be set

    Returns void

setNRestModeByDescription

  • setNRestModeByDescription(newValue: string, description: string): void

  • Accesses the item of the widget's array property 'N + Rest' whose description equals the passed one and assigns the passed new value to it's property 'Mode'. This Method is an alias for 'setNRestConfigsModeByDescription'.

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Mode. Determine the ranking mode top or bottom'

    • description: string

      The description of the item whose property 'Mode' should be set

    Returns void

setNRestModeByIndex

  • setNRestModeByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'N + Rest' at the passed index and assigns the passed new value to it's property 'Mode'. This Method is an alias for 'setNRestConfigsModeByIndex'.

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Mode. Determine the ranking mode top or bottom'

    • index: number

      The index of the item whose property 'Mode' should be set

    Returns void

setNRestNByDescription

  • setNRestNByDescription(newValue: number, description: string): void

  • Accesses the item of the widget's array property 'N + Rest' whose description equals the passed one and assigns the passed new value to it's property 'Number n of top/bottom members'. This Method is an alias for 'setNRestConfigsNByDescription'.

    Parameters

    • newValue: number

      The new value to be assigned to the property 'Number n of top/bottom members. Number of top/bottom members (excluding the rest member)'

    • description: string

      The description of the item whose property 'Number n of top/bottom members' should be set

    Returns void

setNRestNByIndex

  • setNRestNByIndex(newValue: number, index: number): void

  • Accesses the item of the widget's array property 'N + Rest' at the passed index and assigns the passed new value to it's property 'Number n of top/bottom members'. This Method is an alias for 'setNRestConfigsNByIndex'.

    Parameters

    • newValue: number

      The new value to be assigned to the property 'Number n of top/bottom members. Number of top/bottom members (excluding the rest member)'

    • index: number

      The index of the item whose property 'Number n of top/bottom members' should be set

    Returns void

setNRestTargetDimensionByDescription

  • setNRestTargetDimensionByDescription(newValue: string, description: string): void

  • Accesses the item of the widget's array property 'N + Rest' whose description equals the passed one and assigns the passed new value to it's property 'Target Dimension'. This Method is an alias for 'setNRestConfigsTargetDimensionByDescription'.

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Target Dimension. Dimension on whose members the n + rest transformation is performed'

    • description: string

      The description of the item whose property 'Target Dimension' should be set

    Returns void

setNRestTargetDimensionByIndex

  • setNRestTargetDimensionByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'N + Rest' at the passed index and assigns the passed new value to it's property 'Target Dimension'. This Method is an alias for 'setNRestConfigsTargetDimensionByIndex'.

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Target Dimension. Dimension on whose members the n + rest transformation is performed'

    • index: number

      The index of the item whose property 'Target Dimension' should be set

    Returns void

setOutlierMode

  • setOutlierMode(newOutlierStyle: string): void

  • Sets the value of the property 'Outlier Style'. Accepts case insensitive strings like 'LONG', 'SHORT' or 'long' or 'Short'. This method is an alias for 'setOutlierStyle'

    Parameters

    • newOutlierStyle: string

      Outlier Style

    Returns void

setResultSetFromTable

  • setResultSetFromTable(table: unknown): void

  • Sets the result set of a table as matrix data

    Parameters

    • table: unknown

      Table widget the data of which will be bound to the graphomate matrix

    Returns void

setTitle

  • setTitle(newTitleText: string): void

  • Sets the value of the property 'Title Text'. This method is an alias for 'setTitleText'

    Parameters

    • newTitleText: string

      Title Text

    Returns void

setValueFormatAssignmentJsonString

  • setValueFormatAssignmentJsonString(newValueFormatAssignment: string): void

  • Sets the Value Format Assignment as a JSON-String.

    Parameters

    • newValueFormatAssignment: string

      Value Format Assignment

    Returns void

aggregationConfigs Methods

getAggregationConfigsAddressSubsetByDescription

  • getAggregationConfigsAddressSubsetByDescription(description: string): SelectionContext

  • Accesses the item of the widget's array property 'Calculated Aggregates' whose description equals the passed one and returns the value of it's property 'Filter. Restricts this configuration to only affect data points matching all constraints'

    Parameters

    • description: string

      The description of the item whose property 'Filter' should be returned

    Returns SelectionContext

getAggregationConfigsAddressSubsetByIndex

  • getAggregationConfigsAddressSubsetByIndex(index: number): SelectionContext

  • Accesses the item of the widget's array property 'Calculated Aggregates' at the passed index and returns the value of it's property 'Filter. Restricts this configuration to only affect data points matching all constraints'

    Parameters

    • index: number

      The index of the item whose property 'Filter' should be returned

    Returns SelectionContext

getAggregationConfigsAggregationFunctionByDescription

  • getAggregationConfigsAggregationFunctionByDescription(description: string): string

  • Accesses the item of the widget's array property 'Calculated Aggregates' whose description equals the passed one and returns the value of it's property 'Aggregation Type. The dimension for which the new member should be calculated'

    Parameters

    • description: string

      The description of the item whose property 'Aggregation Type' should be returned

    Returns string

getAggregationConfigsAggregationFunctionByIndex

  • getAggregationConfigsAggregationFunctionByIndex(index: number): string

  • Accesses the item of the widget's array property 'Calculated Aggregates' at the passed index and returns the value of it's property 'Aggregation Type. The dimension for which the new member should be calculated'

    Parameters

    • index: number

      The index of the item whose property 'Aggregation Type' should be returned

    Returns string

getAggregationConfigsAggregationMemberKeyByDescription

  • getAggregationConfigsAggregationMemberKeyByDescription(description: string): string

  • Accesses the item of the widget's array property 'Calculated Aggregates' whose description equals the passed one and returns the value of it's property 'New Member Key. The key of the new calculated member'

    Parameters

    • description: string

      The description of the item whose property 'New Member Key' should be returned

    Returns string

getAggregationConfigsAggregationMemberKeyByIndex

  • getAggregationConfigsAggregationMemberKeyByIndex(index: number): string

  • Accesses the item of the widget's array property 'Calculated Aggregates' at the passed index and returns the value of it's property 'New Member Key. The key of the new calculated member'

    Parameters

    • index: number

      The index of the item whose property 'New Member Key' should be returned

    Returns string

getAggregationConfigsAggregationMemberNameByDescription

  • getAggregationConfigsAggregationMemberNameByDescription(description: string): string

  • Accesses the item of the widget's array property 'Calculated Aggregates' whose description equals the passed one and returns the value of it's property 'New Member Name. The name of the new calculated member'

    Parameters

    • description: string

      The description of the item whose property 'New Member Name' should be returned

    Returns string

getAggregationConfigsAggregationMemberNameByIndex

  • getAggregationConfigsAggregationMemberNameByIndex(index: number): string

  • Accesses the item of the widget's array property 'Calculated Aggregates' at the passed index and returns the value of it's property 'New Member Name. The name of the new calculated member'

    Parameters

    • index: number

      The index of the item whose property 'New Member Name' should be returned

    Returns string

getAggregationConfigsCalculateIfAggregateExistsByDescription

  • getAggregationConfigsCalculateIfAggregateExistsByDescription(description: string): boolean

  • Accesses the item of the widget's array property 'Calculated Aggregates' whose description equals the passed one and returns the value of it's property 'calculateIfAggregateExists. '

    Parameters

    • description: string

      The description of the item whose property 'calculateIfAggregateExists' should be returned

    Returns boolean

getAggregationConfigsCalculateIfAggregateExistsByIndex

  • getAggregationConfigsCalculateIfAggregateExistsByIndex(index: number): boolean

  • Accesses the item of the widget's array property 'Calculated Aggregates' at the passed index and returns the value of it's property 'calculateIfAggregateExists. '

    Parameters

    • index: number

      The index of the item whose property 'calculateIfAggregateExists' should be returned

    Returns boolean

getAggregationConfigsDescriptionByIndex

  • getAggregationConfigsDescriptionByIndex(index: number): string

  • Accesses the item of the widget's array property 'Calculated Aggregates' at the passed index and returns the value of it's property 'Description (optional). Short name that describes this configuration to be recognizable'

    Parameters

    • index: number

      The index of the item whose property 'Description (optional)' should be returned

    Returns string

getAggregationConfigsEnabledByDescription

  • getAggregationConfigsEnabledByDescription(description: string): boolean

  • Accesses the item of the widget's array property 'Calculated Aggregates' whose description equals the passed one and returns the value of it's property 'Enable. If this is deactivated, the config shall have no effect'

    Parameters

    • description: string

      The description of the item whose property 'Enable' should be returned

    Returns boolean

getAggregationConfigsEnabledByIndex

  • getAggregationConfigsEnabledByIndex(index: number): boolean

  • Accesses the item of the widget's array property 'Calculated Aggregates' at the passed index and returns the value of it's property 'Enable. If this is deactivated, the config shall have no effect'

    Parameters

    • index: number

      The index of the item whose property 'Enable' should be returned

    Returns boolean

getAggregationConfigsJsonString

  • getAggregationConfigsJsonString(): string

  • Returns the value of the property 'Aggregation Configs' as a JSON-String.

    Returns string

getAggregationConfigsTargetDimensionByDescription

  • getAggregationConfigsTargetDimensionByDescription(description: string): string

  • Accesses the item of the widget's array property 'Calculated Aggregates' whose description equals the passed one and returns the value of it's property 'Target Dimension. The Dimension on which the aggregation should be calculated'

    Parameters

    • description: string

      The description of the item whose property 'Target Dimension' should be returned

    Returns string

getAggregationConfigsTargetDimensionByIndex

  • getAggregationConfigsTargetDimensionByIndex(index: number): string

  • Accesses the item of the widget's array property 'Calculated Aggregates' at the passed index and returns the value of it's property 'Target Dimension. The Dimension on which the aggregation should be calculated'

    Parameters

    • index: number

      The index of the item whose property 'Target Dimension' should be returned

    Returns string

setAggregationConfigsAddressSubsetByDescription

  • setAggregationConfigsAddressSubsetByDescription(newValue: SelectionContext, description: string): void

  • Accesses the item of the widget's array property 'Calculated Aggregates' whose description equals the passed one and assigns the passed new value to it's property 'Filter'

    Parameters

    • newValue: SelectionContext

      The new value to be assigned to the property 'Filter. Restricts this configuration to only affect data points matching all constraints'

    • description: string

      The description of the item whose property 'Filter' should be set

    Returns void

setAggregationConfigsAddressSubsetByIndex

  • setAggregationConfigsAddressSubsetByIndex(newValue: SelectionContext, index: number): void

  • Accesses the item of the widget's array property 'Calculated Aggregates' at the passed index and assigns the passed new value to it's property 'Filter'

    Parameters

    • newValue: SelectionContext

      The new value to be assigned to the property 'Filter. Restricts this configuration to only affect data points matching all constraints'

    • index: number

      The index of the item whose property 'Filter' should be set

    Returns void

setAggregationConfigsAggregationFunctionByDescription

  • setAggregationConfigsAggregationFunctionByDescription(newValue: string, description: string): void

  • Accesses the item of the widget's array property 'Calculated Aggregates' whose description equals the passed one and assigns the passed new value to it's property 'Aggregation Type'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Aggregation Type. The dimension for which the new member should be calculated'

    • description: string

      The description of the item whose property 'Aggregation Type' should be set

    Returns void

setAggregationConfigsAggregationFunctionByIndex

  • setAggregationConfigsAggregationFunctionByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Calculated Aggregates' at the passed index and assigns the passed new value to it's property 'Aggregation Type'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Aggregation Type. The dimension for which the new member should be calculated'

    • index: number

      The index of the item whose property 'Aggregation Type' should be set

    Returns void

setAggregationConfigsAggregationMemberKeyByDescription

  • setAggregationConfigsAggregationMemberKeyByDescription(newValue: string, description: string): void

  • Accesses the item of the widget's array property 'Calculated Aggregates' whose description equals the passed one and assigns the passed new value to it's property 'New Member Key'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'New Member Key. The key of the new calculated member'

    • description: string

      The description of the item whose property 'New Member Key' should be set

    Returns void

setAggregationConfigsAggregationMemberKeyByIndex

  • setAggregationConfigsAggregationMemberKeyByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Calculated Aggregates' at the passed index and assigns the passed new value to it's property 'New Member Key'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'New Member Key. The key of the new calculated member'

    • index: number

      The index of the item whose property 'New Member Key' should be set

    Returns void

setAggregationConfigsAggregationMemberNameByDescription

  • setAggregationConfigsAggregationMemberNameByDescription(newValue: string, description: string): void

  • Accesses the item of the widget's array property 'Calculated Aggregates' whose description equals the passed one and assigns the passed new value to it's property 'New Member Name'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'New Member Name. The name of the new calculated member'

    • description: string

      The description of the item whose property 'New Member Name' should be set

    Returns void

setAggregationConfigsAggregationMemberNameByIndex

  • setAggregationConfigsAggregationMemberNameByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Calculated Aggregates' at the passed index and assigns the passed new value to it's property 'New Member Name'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'New Member Name. The name of the new calculated member'

    • index: number

      The index of the item whose property 'New Member Name' should be set

    Returns void

setAggregationConfigsCalculateIfAggregateExistsByDescription

  • setAggregationConfigsCalculateIfAggregateExistsByDescription(newValue: boolean, description: string): void

  • Accesses the item of the widget's array property 'Calculated Aggregates' whose description equals the passed one and assigns the passed new value to it's property 'calculateIfAggregateExists'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'calculateIfAggregateExists. '

    • description: string

      The description of the item whose property 'calculateIfAggregateExists' should be set

    Returns void

setAggregationConfigsCalculateIfAggregateExistsByIndex

  • setAggregationConfigsCalculateIfAggregateExistsByIndex(newValue: boolean, index: number): void

  • Accesses the item of the widget's array property 'Calculated Aggregates' at the passed index and assigns the passed new value to it's property 'calculateIfAggregateExists'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'calculateIfAggregateExists. '

    • index: number

      The index of the item whose property 'calculateIfAggregateExists' should be set

    Returns void

setAggregationConfigsDescriptionByDescription

  • setAggregationConfigsDescriptionByDescription(newValue: string, description: string): void

  • Accesses the item of the widget's array property 'Calculated Aggregates' whose description equals the passed one and assigns the passed new value to it's property 'Description (optional)'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Description (optional). Short name that describes this configuration to be recognizable'

    • description: string

      The description of the item whose property 'Description (optional)' should be set

    Returns void

setAggregationConfigsDescriptionByIndex

  • setAggregationConfigsDescriptionByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Calculated Aggregates' at the passed index and assigns the passed new value to it's property 'Description (optional)'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Description (optional). Short name that describes this configuration to be recognizable'

    • index: number

      The index of the item whose property 'Description (optional)' should be set

    Returns void

setAggregationConfigsEnabledByDescription

  • setAggregationConfigsEnabledByDescription(newValue: boolean, description: string): void

  • Accesses the item of the widget's array property 'Calculated Aggregates' whose description equals the passed one and assigns the passed new value to it's property 'Enable'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Enable. If this is deactivated, the config shall have no effect'

    • description: string

      The description of the item whose property 'Enable' should be set

    Returns void

setAggregationConfigsEnabledByIndex

  • setAggregationConfigsEnabledByIndex(newValue: boolean, index: number): void

  • Accesses the item of the widget's array property 'Calculated Aggregates' at the passed index and assigns the passed new value to it's property 'Enable'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Enable. If this is deactivated, the config shall have no effect'

    • index: number

      The index of the item whose property 'Enable' should be set

    Returns void

setAggregationConfigsJsonString

  • setAggregationConfigsJsonString(newAggregationConfigs: string): void

  • Sets the value of the property 'Aggregation Configs' as a JSON-String.

    Parameters

    • newAggregationConfigs: string

      Aggregation Configs

    Returns void

setAggregationConfigsTargetDimensionByDescription

  • setAggregationConfigsTargetDimensionByDescription(newValue: string, description: string): void

  • Accesses the item of the widget's array property 'Calculated Aggregates' whose description equals the passed one and assigns the passed new value to it's property 'Target Dimension'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Target Dimension. The Dimension on which the aggregation should be calculated'

    • description: string

      The description of the item whose property 'Target Dimension' should be set

    Returns void

setAggregationConfigsTargetDimensionByIndex

  • setAggregationConfigsTargetDimensionByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Calculated Aggregates' at the passed index and assigns the passed new value to it's property 'Target Dimension'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Target Dimension. The Dimension on which the aggregation should be calculated'

    • index: number

      The index of the item whose property 'Target Dimension' should be set

    Returns void

aggregationNodeName Methods

getAggregationNodeName

  • getAggregationNodeName(): string

  • Returns the value of the property 'Aggregation Node Name' .

    Returns string

setAggregationNodeName

  • setAggregationNodeName(newAggregationNodeName: string): void

  • Sets the value of the property 'Aggregation Node Name' .

    Parameters

    • newAggregationNodeName: string

      Aggregation Node Name

    Returns void

aggregationType Methods

getAggregationType

  • getAggregationType(): string

  • Returns the value of the property 'Aggregation Type' .

    Returns string

setAggregationType

  • setAggregationType(newAggregationType: string): void

  • Sets the value of the property 'Aggregation Type' .

    Parameters

    • newAggregationType: string

      Aggregation Type

    Returns void

alternateRowStyling Methods

getAlternateRowStyling

  • getAlternateRowStyling(): boolean

  • Returns the value of the property 'Alternate Row Styling' .

    Returns boolean

setAlternateRowStyling

  • setAlternateRowStyling(newAlternateRowStyling: boolean): void

  • Sets the value of the property 'Alternate Row Styling' .

    Parameters

    • newAlternateRowStyling: boolean

      Alternate Row Styling

    Returns void

backgroundBarAssignment Methods

getBackgroundBarAssignmentAddressSubsetByDescription

  • getBackgroundBarAssignmentAddressSubsetByDescription(description: string): SelectionContext

  • Accesses the item of the widget's array property 'Background Bar Assignment' whose description equals the passed one and returns the value of it's property 'Filter. Restricts this configuration to only affect data points matching all constraints'

    Parameters

    • description: string

      The description of the item whose property 'Filter' should be returned

    Returns SelectionContext

getBackgroundBarAssignmentAddressSubsetByIndex

  • getBackgroundBarAssignmentAddressSubsetByIndex(index: number): SelectionContext

  • Accesses the item of the widget's array property 'Background Bar Assignment' at the passed index and returns the value of it's property 'Filter. Restricts this configuration to only affect data points matching all constraints'

    Parameters

    • index: number

      The index of the item whose property 'Filter' should be returned

    Returns SelectionContext

getBackgroundBarAssignmentBadColorByDescription

  • getBackgroundBarAssignmentBadColorByDescription(description: string): string

  • Accesses the item of the widget's array property 'Background Bar Assignment' whose description equals the passed one and returns the value of it's property 'Bad Color. The color used for background bar values with a negative implication. When activated, this property has a higher priority than the corresponding general property.'

    Parameters

    • description: string

      The description of the item whose property 'Bad Color' should be returned

    Returns string

getBackgroundBarAssignmentBadColorByIndex

  • getBackgroundBarAssignmentBadColorByIndex(index: number): string

  • Accesses the item of the widget's array property 'Background Bar Assignment' at the passed index and returns the value of it's property 'Bad Color. The color used for background bar values with a negative implication. When activated, this property has a higher priority than the corresponding general property.'

    Parameters

    • index: number

      The index of the item whose property 'Bad Color' should be returned

    Returns string

getBackgroundBarAssignmentComparisonGroupByDescription

  • getBackgroundBarAssignmentComparisonGroupByDescription(description: string): string

  • Accesses the item of the widget's array property 'Background Bar Assignment' whose description equals the passed one and returns the value of it's property 'Comparison Group Id. assigns a comparison group id to the cells addressed by this configuration. cells with the same comparison group id use a visually comparable scaling'

    Parameters

    • description: string

      The description of the item whose property 'Comparison Group Id' should be returned

    Returns string

getBackgroundBarAssignmentComparisonGroupByIndex

  • getBackgroundBarAssignmentComparisonGroupByIndex(index: number): string

  • Accesses the item of the widget's array property 'Background Bar Assignment' at the passed index and returns the value of it's property 'Comparison Group Id. assigns a comparison group id to the cells addressed by this configuration. cells with the same comparison group id use a visually comparable scaling'

    Parameters

    • index: number

      The index of the item whose property 'Comparison Group Id' should be returned

    Returns string

getBackgroundBarAssignmentDescriptionByIndex

  • getBackgroundBarAssignmentDescriptionByIndex(index: number): string

  • Accesses the item of the widget's array property 'Background Bar Assignment' at the passed index and returns the value of it's property 'Description (optional). Short name that describes this configuration to be recognizable'

    Parameters

    • index: number

      The index of the item whose property 'Description (optional)' should be returned

    Returns string

getBackgroundBarAssignmentEnabledByDescription

  • getBackgroundBarAssignmentEnabledByDescription(description: string): boolean

  • Accesses the item of the widget's array property 'Background Bar Assignment' whose description equals the passed one and returns the value of it's property 'Enable. If this is deactivated, the config shall have no effect'

    Parameters

    • description: string

      The description of the item whose property 'Enable' should be returned

    Returns boolean

getBackgroundBarAssignmentEnabledByIndex

  • getBackgroundBarAssignmentEnabledByIndex(index: number): boolean

  • Accesses the item of the widget's array property 'Background Bar Assignment' at the passed index and returns the value of it's property 'Enable. If this is deactivated, the config shall have no effect'

    Parameters

    • index: number

      The index of the item whose property 'Enable' should be returned

    Returns boolean

getBackgroundBarAssignmentGoodColorByDescription

  • getBackgroundBarAssignmentGoodColorByDescription(description: string): string

  • Accesses the item of the widget's array property 'Background Bar Assignment' whose description equals the passed one and returns the value of it's property 'Good Color. The color used for background bar values with a positive implication. When activated, this property has a higher priority than the corresponding general property.'

    Parameters

    • description: string

      The description of the item whose property 'Good Color' should be returned

    Returns string

getBackgroundBarAssignmentGoodColorByIndex

  • getBackgroundBarAssignmentGoodColorByIndex(index: number): string

  • Accesses the item of the widget's array property 'Background Bar Assignment' at the passed index and returns the value of it's property 'Good Color. The color used for background bar values with a positive implication. When activated, this property has a higher priority than the corresponding general property.'

    Parameters

    • index: number

      The index of the item whose property 'Good Color' should be returned

    Returns string

getBackgroundBarAssignmentJsonString

  • getBackgroundBarAssignmentJsonString(): string

  • Returns the value of the property 'Background Bar Assignment' as a JSON-String.

    Returns string

getBackgroundBarAssignmentNegativeOutlierThresholdByDescription

  • getBackgroundBarAssignmentNegativeOutlierThresholdByDescription(description: string): number

  • Accesses the item of the widget's array property 'Background Bar Assignment' whose description equals the passed one and returns the value of it's property 'Negative Outlier Threshold. Values less than this threshold are handled as outliers'

    Parameters

    • description: string

      The description of the item whose property 'Negative Outlier Threshold' should be returned

    Returns number

getBackgroundBarAssignmentNegativeOutlierThresholdByIndex

  • getBackgroundBarAssignmentNegativeOutlierThresholdByIndex(index: number): number

  • Accesses the item of the widget's array property 'Background Bar Assignment' at the passed index and returns the value of it's property 'Negative Outlier Threshold. Values less than this threshold are handled as outliers'

    Parameters

    • index: number

      The index of the item whose property 'Negative Outlier Threshold' should be returned

    Returns number

getBackgroundBarAssignmentNegativeValueIsGoodByDescription

  • getBackgroundBarAssignmentNegativeValueIsGoodByDescription(description: string): boolean

  • Accesses the item of the widget's array property 'Background Bar Assignment' whose description equals the passed one and returns the value of it's property 'Negative Value is Good. Swaps positive and negative color'

    Parameters

    • description: string

      The description of the item whose property 'Negative Value is Good' should be returned

    Returns boolean

getBackgroundBarAssignmentNegativeValueIsGoodByIndex

  • getBackgroundBarAssignmentNegativeValueIsGoodByIndex(index: number): boolean

  • Accesses the item of the widget's array property 'Background Bar Assignment' at the passed index and returns the value of it's property 'Negative Value is Good. Swaps positive and negative color'

    Parameters

    • index: number

      The index of the item whose property 'Negative Value is Good' should be returned

    Returns boolean

getBackgroundBarAssignmentOpacityByDescription

  • getBackgroundBarAssignmentOpacityByDescription(description: string): number

  • Accesses the item of the widget's array property 'Background Bar Assignment' whose description equals the passed one and returns the value of it's property 'Specific Opacity. The opacity used for background bars ranging from 0 to 1 where 0 makes them fully transparent. When activated, this property has a higher priority than the corresponding generic property 'Default Opacity'.'

    Parameters

    • description: string

      The description of the item whose property 'Specific Opacity' should be returned

    Returns number

getBackgroundBarAssignmentOpacityByIndex

  • getBackgroundBarAssignmentOpacityByIndex(index: number): number

  • Accesses the item of the widget's array property 'Background Bar Assignment' at the passed index and returns the value of it's property 'Specific Opacity. The opacity used for background bars ranging from 0 to 1 where 0 makes them fully transparent. When activated, this property has a higher priority than the corresponding generic property 'Default Opacity'.'

    Parameters

    • index: number

      The index of the item whose property 'Specific Opacity' should be returned

    Returns number

getBackgroundBarAssignmentPositiveOutlierThresholdByDescription

  • getBackgroundBarAssignmentPositiveOutlierThresholdByDescription(description: string): number

  • Accesses the item of the widget's array property 'Background Bar Assignment' whose description equals the passed one and returns the value of it's property 'Positive Outlier Threshold. Values greater than this threshold are handled as outliers'

    Parameters

    • description: string

      The description of the item whose property 'Positive Outlier Threshold' should be returned

    Returns number

getBackgroundBarAssignmentPositiveOutlierThresholdByIndex

  • getBackgroundBarAssignmentPositiveOutlierThresholdByIndex(index: number): number

  • Accesses the item of the widget's array property 'Background Bar Assignment' at the passed index and returns the value of it's property 'Positive Outlier Threshold. Values greater than this threshold are handled as outliers'

    Parameters

    • index: number

      The index of the item whose property 'Positive Outlier Threshold' should be returned

    Returns number

getBackgroundBarAssignmentScenarioIdByDescription

  • getBackgroundBarAssignmentScenarioIdByDescription(description: string): string

  • Accesses the item of the widget's array property 'Background Bar Assignment' whose description equals the passed one and returns the value of it's property 'Scenario Id. id of a scenario which should be assigned to the background bar. this overwrites a scenario assigned by using the property 'scenario assignment''

    Parameters

    • description: string

      The description of the item whose property 'Scenario Id' should be returned

    Returns string

getBackgroundBarAssignmentScenarioIdByIndex

  • getBackgroundBarAssignmentScenarioIdByIndex(index: number): string

  • Accesses the item of the widget's array property 'Background Bar Assignment' at the passed index and returns the value of it's property 'Scenario Id. id of a scenario which should be assigned to the background bar. this overwrites a scenario assigned by using the property 'scenario assignment''

    Parameters

    • index: number

      The index of the item whose property 'Scenario Id' should be returned

    Returns string

getBackgroundBarAssignmentUseOutlierThresholdByDescription

  • getBackgroundBarAssignmentUseOutlierThresholdByDescription(description: string): boolean

  • Accesses the item of the widget's array property 'Background Bar Assignment' whose description equals the passed one and returns the value of it's property 'Use Outlier Threshold. When activated all values greater than the positive and less than the negative outlier threshold are considered outliers and don't affect scaling'

    Parameters

    • description: string

      The description of the item whose property 'Use Outlier Threshold' should be returned

    Returns boolean

getBackgroundBarAssignmentUseOutlierThresholdByIndex

  • getBackgroundBarAssignmentUseOutlierThresholdByIndex(index: number): boolean

  • Accesses the item of the widget's array property 'Background Bar Assignment' at the passed index and returns the value of it's property 'Use Outlier Threshold. When activated all values greater than the positive and less than the negative outlier threshold are considered outliers and don't affect scaling'

    Parameters

    • index: number

      The index of the item whose property 'Use Outlier Threshold' should be returned

    Returns boolean

getBackgroundBarAssignmentUseSpecificBadColorByDescription

  • getBackgroundBarAssignmentUseSpecificBadColorByDescription(description: string): boolean

  • Accesses the item of the widget's array property 'Background Bar Assignment' whose description equals the passed one and returns the value of it's property 'Use Specific Bad Color. Whether to use the specific Bad Color for a chart configuration or the generic default one'

    Parameters

    • description: string

      The description of the item whose property 'Use Specific Bad Color' should be returned

    Returns boolean

getBackgroundBarAssignmentUseSpecificBadColorByIndex

  • getBackgroundBarAssignmentUseSpecificBadColorByIndex(index: number): boolean

  • Accesses the item of the widget's array property 'Background Bar Assignment' at the passed index and returns the value of it's property 'Use Specific Bad Color. Whether to use the specific Bad Color for a chart configuration or the generic default one'

    Parameters

    • index: number

      The index of the item whose property 'Use Specific Bad Color' should be returned

    Returns boolean

getBackgroundBarAssignmentUseSpecificGoodColorByDescription

  • getBackgroundBarAssignmentUseSpecificGoodColorByDescription(description: string): boolean

  • Accesses the item of the widget's array property 'Background Bar Assignment' whose description equals the passed one and returns the value of it's property 'Use Specific Good Color. Whether to use the specific Good Color for a chart configuration or the generic default one'

    Parameters

    • description: string

      The description of the item whose property 'Use Specific Good Color' should be returned

    Returns boolean

getBackgroundBarAssignmentUseSpecificGoodColorByIndex

  • getBackgroundBarAssignmentUseSpecificGoodColorByIndex(index: number): boolean

  • Accesses the item of the widget's array property 'Background Bar Assignment' at the passed index and returns the value of it's property 'Use Specific Good Color. Whether to use the specific Good Color for a chart configuration or the generic default one'

    Parameters

    • index: number

      The index of the item whose property 'Use Specific Good Color' should be returned

    Returns boolean

getBackgroundBarAssignmentUseSpecificOpacityByDescription

  • getBackgroundBarAssignmentUseSpecificOpacityByDescription(description: string): boolean

  • Accesses the item of the widget's array property 'Background Bar Assignment' whose description equals the passed one and returns the value of it's property 'Use Specific Opacity. Whether to use the specific opacity for a chart configuration or the generic default one'

    Parameters

    • description: string

      The description of the item whose property 'Use Specific Opacity' should be returned

    Returns boolean

getBackgroundBarAssignmentUseSpecificOpacityByIndex

  • getBackgroundBarAssignmentUseSpecificOpacityByIndex(index: number): boolean

  • Accesses the item of the widget's array property 'Background Bar Assignment' at the passed index and returns the value of it's property 'Use Specific Opacity. Whether to use the specific opacity for a chart configuration or the generic default one'

    Parameters

    • index: number

      The index of the item whose property 'Use Specific Opacity' should be returned

    Returns boolean

setBackgroundBarAssignmentAddressSubsetByDescription

  • setBackgroundBarAssignmentAddressSubsetByDescription(newValue: SelectionContext, description: string): void

  • Accesses the item of the widget's array property 'Background Bar Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Filter'

    Parameters

    • newValue: SelectionContext

      The new value to be assigned to the property 'Filter. Restricts this configuration to only affect data points matching all constraints'

    • description: string

      The description of the item whose property 'Filter' should be set

    Returns void

setBackgroundBarAssignmentAddressSubsetByIndex

  • setBackgroundBarAssignmentAddressSubsetByIndex(newValue: SelectionContext, index: number): void

  • Accesses the item of the widget's array property 'Background Bar Assignment' at the passed index and assigns the passed new value to it's property 'Filter'

    Parameters

    • newValue: SelectionContext

      The new value to be assigned to the property 'Filter. Restricts this configuration to only affect data points matching all constraints'

    • index: number

      The index of the item whose property 'Filter' should be set

    Returns void

setBackgroundBarAssignmentBadColorByDescription

  • setBackgroundBarAssignmentBadColorByDescription(newValue: string, description: string): void

  • Accesses the item of the widget's array property 'Background Bar Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Bad Color'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Bad Color. The color used for background bar values with a negative implication. When activated, this property has a higher priority than the corresponding general property.'

    • description: string

      The description of the item whose property 'Bad Color' should be set

    Returns void

setBackgroundBarAssignmentBadColorByIndex

  • setBackgroundBarAssignmentBadColorByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Background Bar Assignment' at the passed index and assigns the passed new value to it's property 'Bad Color'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Bad Color. The color used for background bar values with a negative implication. When activated, this property has a higher priority than the corresponding general property.'

    • index: number

      The index of the item whose property 'Bad Color' should be set

    Returns void

setBackgroundBarAssignmentComparisonGroupByDescription

  • setBackgroundBarAssignmentComparisonGroupByDescription(newValue: string, description: string): void

  • Accesses the item of the widget's array property 'Background Bar Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Comparison Group Id'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Comparison Group Id. assigns a comparison group id to the cells addressed by this configuration. cells with the same comparison group id use a visually comparable scaling'

    • description: string

      The description of the item whose property 'Comparison Group Id' should be set

    Returns void

setBackgroundBarAssignmentComparisonGroupByIndex

  • setBackgroundBarAssignmentComparisonGroupByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Background Bar Assignment' at the passed index and assigns the passed new value to it's property 'Comparison Group Id'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Comparison Group Id. assigns a comparison group id to the cells addressed by this configuration. cells with the same comparison group id use a visually comparable scaling'

    • index: number

      The index of the item whose property 'Comparison Group Id' should be set

    Returns void

setBackgroundBarAssignmentDescriptionByDescription

  • setBackgroundBarAssignmentDescriptionByDescription(newValue: string, description: string): void

  • Accesses the item of the widget's array property 'Background Bar Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Description (optional)'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Description (optional). Short name that describes this configuration to be recognizable'

    • description: string

      The description of the item whose property 'Description (optional)' should be set

    Returns void

setBackgroundBarAssignmentDescriptionByIndex

  • setBackgroundBarAssignmentDescriptionByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Background Bar Assignment' at the passed index and assigns the passed new value to it's property 'Description (optional)'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Description (optional). Short name that describes this configuration to be recognizable'

    • index: number

      The index of the item whose property 'Description (optional)' should be set

    Returns void

setBackgroundBarAssignmentEnabledByDescription

  • setBackgroundBarAssignmentEnabledByDescription(newValue: boolean, description: string): void

  • Accesses the item of the widget's array property 'Background Bar Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Enable'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Enable. If this is deactivated, the config shall have no effect'

    • description: string

      The description of the item whose property 'Enable' should be set

    Returns void

setBackgroundBarAssignmentEnabledByIndex

  • setBackgroundBarAssignmentEnabledByIndex(newValue: boolean, index: number): void

  • Accesses the item of the widget's array property 'Background Bar Assignment' at the passed index and assigns the passed new value to it's property 'Enable'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Enable. If this is deactivated, the config shall have no effect'

    • index: number

      The index of the item whose property 'Enable' should be set

    Returns void

setBackgroundBarAssignmentGoodColorByDescription

  • setBackgroundBarAssignmentGoodColorByDescription(newValue: string, description: string): void

  • Accesses the item of the widget's array property 'Background Bar Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Good Color'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Good Color. The color used for background bar values with a positive implication. When activated, this property has a higher priority than the corresponding general property.'

    • description: string

      The description of the item whose property 'Good Color' should be set

    Returns void

setBackgroundBarAssignmentGoodColorByIndex

  • setBackgroundBarAssignmentGoodColorByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Background Bar Assignment' at the passed index and assigns the passed new value to it's property 'Good Color'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Good Color. The color used for background bar values with a positive implication. When activated, this property has a higher priority than the corresponding general property.'

    • index: number

      The index of the item whose property 'Good Color' should be set

    Returns void

setBackgroundBarAssignmentJsonString

  • setBackgroundBarAssignmentJsonString(newBackgroundBarAssignment: string): void

  • Sets the value of the property 'Background Bar Assignment' as a JSON-String.

    Parameters

    • newBackgroundBarAssignment: string

      Background Bar Assignment

    Returns void

setBackgroundBarAssignmentNegativeOutlierThresholdByDescription

  • setBackgroundBarAssignmentNegativeOutlierThresholdByDescription(newValue: number, description: string): void

  • Accesses the item of the widget's array property 'Background Bar Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Negative Outlier Threshold'

    Parameters

    • newValue: number

      The new value to be assigned to the property 'Negative Outlier Threshold. Values less than this threshold are handled as outliers'

    • description: string

      The description of the item whose property 'Negative Outlier Threshold' should be set

    Returns void

setBackgroundBarAssignmentNegativeOutlierThresholdByIndex

  • setBackgroundBarAssignmentNegativeOutlierThresholdByIndex(newValue: number, index: number): void

  • Accesses the item of the widget's array property 'Background Bar Assignment' at the passed index and assigns the passed new value to it's property 'Negative Outlier Threshold'

    Parameters

    • newValue: number

      The new value to be assigned to the property 'Negative Outlier Threshold. Values less than this threshold are handled as outliers'

    • index: number

      The index of the item whose property 'Negative Outlier Threshold' should be set

    Returns void

setBackgroundBarAssignmentNegativeValueIsGoodByDescription

  • setBackgroundBarAssignmentNegativeValueIsGoodByDescription(newValue: boolean, description: string): void

  • Accesses the item of the widget's array property 'Background Bar Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Negative Value is Good'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Negative Value is Good. Swaps positive and negative color'

    • description: string

      The description of the item whose property 'Negative Value is Good' should be set

    Returns void

setBackgroundBarAssignmentNegativeValueIsGoodByIndex

  • setBackgroundBarAssignmentNegativeValueIsGoodByIndex(newValue: boolean, index: number): void

  • Accesses the item of the widget's array property 'Background Bar Assignment' at the passed index and assigns the passed new value to it's property 'Negative Value is Good'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Negative Value is Good. Swaps positive and negative color'

    • index: number

      The index of the item whose property 'Negative Value is Good' should be set

    Returns void

setBackgroundBarAssignmentOpacityByDescription

  • setBackgroundBarAssignmentOpacityByDescription(newValue: number, description: string): void

  • Accesses the item of the widget's array property 'Background Bar Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Specific Opacity'

    Parameters

    • newValue: number

      The new value to be assigned to the property 'Specific Opacity. The opacity used for background bars ranging from 0 to 1 where 0 makes them fully transparent. When activated, this property has a higher priority than the corresponding generic property 'Default Opacity'.'

    • description: string

      The description of the item whose property 'Specific Opacity' should be set

    Returns void

setBackgroundBarAssignmentOpacityByIndex

  • setBackgroundBarAssignmentOpacityByIndex(newValue: number, index: number): void

  • Accesses the item of the widget's array property 'Background Bar Assignment' at the passed index and assigns the passed new value to it's property 'Specific Opacity'

    Parameters

    • newValue: number

      The new value to be assigned to the property 'Specific Opacity. The opacity used for background bars ranging from 0 to 1 where 0 makes them fully transparent. When activated, this property has a higher priority than the corresponding generic property 'Default Opacity'.'

    • index: number

      The index of the item whose property 'Specific Opacity' should be set

    Returns void

setBackgroundBarAssignmentPositiveOutlierThresholdByDescription

  • setBackgroundBarAssignmentPositiveOutlierThresholdByDescription(newValue: number, description: string): void

  • Accesses the item of the widget's array property 'Background Bar Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Positive Outlier Threshold'

    Parameters

    • newValue: number

      The new value to be assigned to the property 'Positive Outlier Threshold. Values greater than this threshold are handled as outliers'

    • description: string

      The description of the item whose property 'Positive Outlier Threshold' should be set

    Returns void

setBackgroundBarAssignmentPositiveOutlierThresholdByIndex

  • setBackgroundBarAssignmentPositiveOutlierThresholdByIndex(newValue: number, index: number): void

  • Accesses the item of the widget's array property 'Background Bar Assignment' at the passed index and assigns the passed new value to it's property 'Positive Outlier Threshold'

    Parameters

    • newValue: number

      The new value to be assigned to the property 'Positive Outlier Threshold. Values greater than this threshold are handled as outliers'

    • index: number

      The index of the item whose property 'Positive Outlier Threshold' should be set

    Returns void

setBackgroundBarAssignmentScenarioIdByDescription

  • setBackgroundBarAssignmentScenarioIdByDescription(newValue: string, description: string): void

  • Accesses the item of the widget's array property 'Background Bar Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Scenario Id'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Scenario Id. id of a scenario which should be assigned to the background bar. this overwrites a scenario assigned by using the property 'scenario assignment''

    • description: string

      The description of the item whose property 'Scenario Id' should be set

    Returns void

setBackgroundBarAssignmentScenarioIdByIndex

  • setBackgroundBarAssignmentScenarioIdByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Background Bar Assignment' at the passed index and assigns the passed new value to it's property 'Scenario Id'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Scenario Id. id of a scenario which should be assigned to the background bar. this overwrites a scenario assigned by using the property 'scenario assignment''

    • index: number

      The index of the item whose property 'Scenario Id' should be set

    Returns void

setBackgroundBarAssignmentUseOutlierThresholdByDescription

  • setBackgroundBarAssignmentUseOutlierThresholdByDescription(newValue: boolean, description: string): void

  • Accesses the item of the widget's array property 'Background Bar Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Use Outlier Threshold'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Use Outlier Threshold. When activated all values greater than the positive and less than the negative outlier threshold are considered outliers and don't affect scaling'

    • description: string

      The description of the item whose property 'Use Outlier Threshold' should be set

    Returns void

setBackgroundBarAssignmentUseOutlierThresholdByIndex

  • setBackgroundBarAssignmentUseOutlierThresholdByIndex(newValue: boolean, index: number): void

  • Accesses the item of the widget's array property 'Background Bar Assignment' at the passed index and assigns the passed new value to it's property 'Use Outlier Threshold'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Use Outlier Threshold. When activated all values greater than the positive and less than the negative outlier threshold are considered outliers and don't affect scaling'

    • index: number

      The index of the item whose property 'Use Outlier Threshold' should be set

    Returns void

setBackgroundBarAssignmentUseSpecificBadColorByDescription

  • setBackgroundBarAssignmentUseSpecificBadColorByDescription(newValue: boolean, description: string): void

  • Accesses the item of the widget's array property 'Background Bar Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Use Specific Bad Color'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Use Specific Bad Color. Whether to use the specific Bad Color for a chart configuration or the generic default one'

    • description: string

      The description of the item whose property 'Use Specific Bad Color' should be set

    Returns void

setBackgroundBarAssignmentUseSpecificBadColorByIndex

  • setBackgroundBarAssignmentUseSpecificBadColorByIndex(newValue: boolean, index: number): void

  • Accesses the item of the widget's array property 'Background Bar Assignment' at the passed index and assigns the passed new value to it's property 'Use Specific Bad Color'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Use Specific Bad Color. Whether to use the specific Bad Color for a chart configuration or the generic default one'

    • index: number

      The index of the item whose property 'Use Specific Bad Color' should be set

    Returns void

setBackgroundBarAssignmentUseSpecificGoodColorByDescription

  • setBackgroundBarAssignmentUseSpecificGoodColorByDescription(newValue: boolean, description: string): void

  • Accesses the item of the widget's array property 'Background Bar Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Use Specific Good Color'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Use Specific Good Color. Whether to use the specific Good Color for a chart configuration or the generic default one'

    • description: string

      The description of the item whose property 'Use Specific Good Color' should be set

    Returns void

setBackgroundBarAssignmentUseSpecificGoodColorByIndex

  • setBackgroundBarAssignmentUseSpecificGoodColorByIndex(newValue: boolean, index: number): void

  • Accesses the item of the widget's array property 'Background Bar Assignment' at the passed index and assigns the passed new value to it's property 'Use Specific Good Color'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Use Specific Good Color. Whether to use the specific Good Color for a chart configuration or the generic default one'

    • index: number

      The index of the item whose property 'Use Specific Good Color' should be set

    Returns void

setBackgroundBarAssignmentUseSpecificOpacityByDescription

  • setBackgroundBarAssignmentUseSpecificOpacityByDescription(newValue: boolean, description: string): void

  • Accesses the item of the widget's array property 'Background Bar Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Use Specific Opacity'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Use Specific Opacity. Whether to use the specific opacity for a chart configuration or the generic default one'

    • description: string

      The description of the item whose property 'Use Specific Opacity' should be set

    Returns void

setBackgroundBarAssignmentUseSpecificOpacityByIndex

  • setBackgroundBarAssignmentUseSpecificOpacityByIndex(newValue: boolean, index: number): void

  • Accesses the item of the widget's array property 'Background Bar Assignment' at the passed index and assigns the passed new value to it's property 'Use Specific Opacity'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Use Specific Opacity. Whether to use the specific opacity for a chart configuration or the generic default one'

    • index: number

      The index of the item whose property 'Use Specific Opacity' should be set

    Returns void

backgroundBarBadColor Methods

getBackgroundBarBadColor

  • getBackgroundBarBadColor(): string

  • Returns the value of the property 'Background Bar Bad Color' .

    Returns string

setBackgroundBarBadColor

  • setBackgroundBarBadColor(newBackgroundBarBadColor: string): void

  • Sets the value of the property 'Background Bar Bad Color' . Only hexadecimal color codes are allowed. E.g. '#FF0000'

    Parameters

    • newBackgroundBarBadColor: string

      Background Bar Bad Color

    Returns void

backgroundBarGoodColor Methods

getBackgroundBarGoodColor

  • getBackgroundBarGoodColor(): string

  • Returns the value of the property 'Background Bar Good Color' .

    Returns string

setBackgroundBarGoodColor

  • setBackgroundBarGoodColor(newBackgroundBarGoodColor: string): void

  • Sets the value of the property 'Background Bar Good Color' . Only hexadecimal color codes are allowed. E.g. '#FF0000'

    Parameters

    • newBackgroundBarGoodColor: string

      Background Bar Good Color

    Returns void

backgroundBarNegativeRtl Methods

getBackgroundBarNegativeRtl

  • getBackgroundBarNegativeRtl(): boolean

  • Returns the value of the property 'Background Bar Negative Rtl' .

    Returns boolean

setBackgroundBarNegativeRtl

  • setBackgroundBarNegativeRtl(newBackgroundBarNegativeRtl: boolean): void

  • Sets the value of the property 'Background Bar Negative Rtl' .

    Parameters

    • newBackgroundBarNegativeRtl: boolean

      Background Bar Negative Rtl

    Returns void

backgroundBarOpacity Methods

getBackgroundBarOpacity

  • getBackgroundBarOpacity(): number

  • Returns the value of the property 'Background Bar Opacity' .

    Returns number

setBackgroundBarOpacity

  • setBackgroundBarOpacity(newBackgroundBarOpacity: number): void

  • Sets the value of the property 'Background Bar Opacity' .

    Parameters

    • newBackgroundBarOpacity: number

      Background Bar Opacity

    Returns void

backgroundColor Methods

getBackgroundColor

  • getBackgroundColor(): string

  • Returns the value of the property 'Background Color' .

    Returns string

setBackgroundColor

  • setBackgroundColor(newBackgroundColor: string): void

  • Sets the value of the property 'Background Color' . Only hexadecimal color codes are allowed. E.g. '#FF0000'

    Parameters

    • newBackgroundColor: string

      Background Color

    Returns void

badColor Methods

getBadColor

  • getBadColor(): string

  • Returns the value of the property 'Bad Color' .

    Returns string

setBadColor

  • setBadColor(newBadColor: string): void

  • Sets the value of the property 'Bad Color' . Only hexadecimal color codes are allowed. E.g. '#FF0000'

    Parameters

    • newBadColor: string

      Bad Color

    Returns void

barChartAssignment Methods

getBarChartAssignmentAddressSubsetByDescription

  • getBarChartAssignmentAddressSubsetByDescription(description: string): SelectionContext

  • Accesses the item of the widget's array property 'Bar Chart Assignment' whose description equals the passed one and returns the value of it's property 'Filter. Restricts this configuration to only affect data points matching all constraints'

    Parameters

    • description: string

      The description of the item whose property 'Filter' should be returned

    Returns SelectionContext

getBarChartAssignmentAddressSubsetByIndex

  • getBarChartAssignmentAddressSubsetByIndex(index: number): SelectionContext

  • Accesses the item of the widget's array property 'Bar Chart Assignment' at the passed index and returns the value of it's property 'Filter. Restricts this configuration to only affect data points matching all constraints'

    Parameters

    • index: number

      The index of the item whose property 'Filter' should be returned

    Returns SelectionContext

getBarChartAssignmentAxisScenarioIdByDescription

  • getBarChartAssignmentAxisScenarioIdByDescription(description: string): string

  • Accesses the item of the widget's array property 'Bar Chart Assignment' whose description equals the passed one and returns the value of it's property 'Scenario Id for Axis. id of a scenario which should be assigned to the axis'

    Parameters

    • description: string

      The description of the item whose property 'Scenario Id for Axis' should be returned

    Returns string

getBarChartAssignmentAxisScenarioIdByIndex

  • getBarChartAssignmentAxisScenarioIdByIndex(index: number): string

  • Accesses the item of the widget's array property 'Bar Chart Assignment' at the passed index and returns the value of it's property 'Scenario Id for Axis. id of a scenario which should be assigned to the axis'

    Parameters

    • index: number

      The index of the item whose property 'Scenario Id for Axis' should be returned

    Returns string

getBarChartAssignmentBadColorByDescription

  • getBarChartAssignmentBadColorByDescription(description: string): string

  • Accesses the item of the widget's array property 'Bar Chart Assignment' whose description equals the passed one and returns the value of it's property 'Specific Bad Color. The color used for visualization elements with a negative implication. When activated, this property has a higher priority than the corresponding general property 'Default Bad Color'.'

    Parameters

    • description: string

      The description of the item whose property 'Specific Bad Color' should be returned

    Returns string

getBarChartAssignmentBadColorByIndex

  • getBarChartAssignmentBadColorByIndex(index: number): string

  • Accesses the item of the widget's array property 'Bar Chart Assignment' at the passed index and returns the value of it's property 'Specific Bad Color. The color used for visualization elements with a negative implication. When activated, this property has a higher priority than the corresponding general property 'Default Bad Color'.'

    Parameters

    • index: number

      The index of the item whose property 'Specific Bad Color' should be returned

    Returns string

getBarChartAssignmentComparisonGroupByDescription

  • getBarChartAssignmentComparisonGroupByDescription(description: string): string

  • Accesses the item of the widget's array property 'Bar Chart Assignment' whose description equals the passed one and returns the value of it's property 'Comparison Group Id. assigns a comparison group id to the cells addressed by this configuration. cells with the same comparison group id use a visually comparable scaling'

    Parameters

    • description: string

      The description of the item whose property 'Comparison Group Id' should be returned

    Returns string

getBarChartAssignmentComparisonGroupByIndex

  • getBarChartAssignmentComparisonGroupByIndex(index: number): string

  • Accesses the item of the widget's array property 'Bar Chart Assignment' at the passed index and returns the value of it's property 'Comparison Group Id. assigns a comparison group id to the cells addressed by this configuration. cells with the same comparison group id use a visually comparable scaling'

    Parameters

    • index: number

      The index of the item whose property 'Comparison Group Id' should be returned

    Returns string

getBarChartAssignmentDescriptionByIndex

  • getBarChartAssignmentDescriptionByIndex(index: number): string

  • Accesses the item of the widget's array property 'Bar Chart Assignment' at the passed index and returns the value of it's property 'Description (optional). Short name that describes this configuration to be recognizable'

    Parameters

    • index: number

      The index of the item whose property 'Description (optional)' should be returned

    Returns string

getBarChartAssignmentEnabledByDescription

  • getBarChartAssignmentEnabledByDescription(description: string): boolean

  • Accesses the item of the widget's array property 'Bar Chart Assignment' whose description equals the passed one and returns the value of it's property 'Enable. If this is deactivated, the config shall have no effect'

    Parameters

    • description: string

      The description of the item whose property 'Enable' should be returned

    Returns boolean

getBarChartAssignmentEnabledByIndex

  • getBarChartAssignmentEnabledByIndex(index: number): boolean

  • Accesses the item of the widget's array property 'Bar Chart Assignment' at the passed index and returns the value of it's property 'Enable. If this is deactivated, the config shall have no effect'

    Parameters

    • index: number

      The index of the item whose property 'Enable' should be returned

    Returns boolean

getBarChartAssignmentGoodColorByDescription

  • getBarChartAssignmentGoodColorByDescription(description: string): string

  • Accesses the item of the widget's array property 'Bar Chart Assignment' whose description equals the passed one and returns the value of it's property 'Specific Good Color. The color used for visualization elements with a positive implication. When activated, this property has a higher priority than the corresponding general property 'Default Good Color'.'

    Parameters

    • description: string

      The description of the item whose property 'Specific Good Color' should be returned

    Returns string

getBarChartAssignmentGoodColorByIndex

  • getBarChartAssignmentGoodColorByIndex(index: number): string

  • Accesses the item of the widget's array property 'Bar Chart Assignment' at the passed index and returns the value of it's property 'Specific Good Color. The color used for visualization elements with a positive implication. When activated, this property has a higher priority than the corresponding general property 'Default Good Color'.'

    Parameters

    • index: number

      The index of the item whose property 'Specific Good Color' should be returned

    Returns string

getBarChartAssignmentJsonString

  • getBarChartAssignmentJsonString(): string

  • Returns the value of the property 'Bar Chart Assignment' as a JSON-String.

    Returns string

getBarChartAssignmentNegativeOutlierThresholdByDescription

  • getBarChartAssignmentNegativeOutlierThresholdByDescription(description: string): number

  • Accesses the item of the widget's array property 'Bar Chart Assignment' whose description equals the passed one and returns the value of it's property 'Negative Outlier Threshold. Values less than this threshold are handled as outliers'

    Parameters

    • description: string

      The description of the item whose property 'Negative Outlier Threshold' should be returned

    Returns number

getBarChartAssignmentNegativeOutlierThresholdByIndex

  • getBarChartAssignmentNegativeOutlierThresholdByIndex(index: number): number

  • Accesses the item of the widget's array property 'Bar Chart Assignment' at the passed index and returns the value of it's property 'Negative Outlier Threshold. Values less than this threshold are handled as outliers'

    Parameters

    • index: number

      The index of the item whose property 'Negative Outlier Threshold' should be returned

    Returns number

getBarChartAssignmentNegativeValueIsGoodByDescription

  • getBarChartAssignmentNegativeValueIsGoodByDescription(description: string): boolean

  • Accesses the item of the widget's array property 'Bar Chart Assignment' whose description equals the passed one and returns the value of it's property 'Negative Value is Good. Swaps positive and negative color'

    Parameters

    • description: string

      The description of the item whose property 'Negative Value is Good' should be returned

    Returns boolean

getBarChartAssignmentNegativeValueIsGoodByIndex

  • getBarChartAssignmentNegativeValueIsGoodByIndex(index: number): boolean

  • Accesses the item of the widget's array property 'Bar Chart Assignment' at the passed index and returns the value of it's property 'Negative Value is Good. Swaps positive and negative color'

    Parameters

    • index: number

      The index of the item whose property 'Negative Value is Good' should be returned

    Returns boolean

getBarChartAssignmentPositiveOutlierThresholdByDescription

  • getBarChartAssignmentPositiveOutlierThresholdByDescription(description: string): number

  • Accesses the item of the widget's array property 'Bar Chart Assignment' whose description equals the passed one and returns the value of it's property 'Positive Outlier Threshold. Values greater than this threshold are handled as outliers'

    Parameters

    • description: string

      The description of the item whose property 'Positive Outlier Threshold' should be returned

    Returns number

getBarChartAssignmentPositiveOutlierThresholdByIndex

  • getBarChartAssignmentPositiveOutlierThresholdByIndex(index: number): number

  • Accesses the item of the widget's array property 'Bar Chart Assignment' at the passed index and returns the value of it's property 'Positive Outlier Threshold. Values greater than this threshold are handled as outliers'

    Parameters

    • index: number

      The index of the item whose property 'Positive Outlier Threshold' should be returned

    Returns number

getBarChartAssignmentScenarioIdByDescription

  • getBarChartAssignmentScenarioIdByDescription(description: string): string

  • Accesses the item of the widget's array property 'Bar Chart Assignment' whose description equals the passed one and returns the value of it's property 'Scenario Id for Bar. id of a scenario which should be assigned to the bar'

    Parameters

    • description: string

      The description of the item whose property 'Scenario Id for Bar' should be returned

    Returns string

getBarChartAssignmentScenarioIdByIndex

  • getBarChartAssignmentScenarioIdByIndex(index: number): string

  • Accesses the item of the widget's array property 'Bar Chart Assignment' at the passed index and returns the value of it's property 'Scenario Id for Bar. id of a scenario which should be assigned to the bar'

    Parameters

    • index: number

      The index of the item whose property 'Scenario Id for Bar' should be returned

    Returns string

getBarChartAssignmentShowLabelsByDescription

  • getBarChartAssignmentShowLabelsByDescription(description: string): boolean

  • Accesses the item of the widget's array property 'Bar Chart Assignment' whose description equals the passed one and returns the value of it's property 'Labels. if activated, data values are displayed for the bars'

    Parameters

    • description: string

      The description of the item whose property 'Labels' should be returned

    Returns boolean

getBarChartAssignmentShowLabelsByIndex

  • getBarChartAssignmentShowLabelsByIndex(index: number): boolean

  • Accesses the item of the widget's array property 'Bar Chart Assignment' at the passed index and returns the value of it's property 'Labels. if activated, data values are displayed for the bars'

    Parameters

    • index: number

      The index of the item whose property 'Labels' should be returned

    Returns boolean

getBarChartAssignmentUseOutlierThresholdByDescription

  • getBarChartAssignmentUseOutlierThresholdByDescription(description: string): boolean

  • Accesses the item of the widget's array property 'Bar Chart Assignment' whose description equals the passed one and returns the value of it's property 'Use Outlier Threshold. When activated all values greater than the positive and less than the negative outlier threshold are considered outliers and don't affect scaling'

    Parameters

    • description: string

      The description of the item whose property 'Use Outlier Threshold' should be returned

    Returns boolean

getBarChartAssignmentUseOutlierThresholdByIndex

  • getBarChartAssignmentUseOutlierThresholdByIndex(index: number): boolean

  • Accesses the item of the widget's array property 'Bar Chart Assignment' at the passed index and returns the value of it's property 'Use Outlier Threshold. When activated all values greater than the positive and less than the negative outlier threshold are considered outliers and don't affect scaling'

    Parameters

    • index: number

      The index of the item whose property 'Use Outlier Threshold' should be returned

    Returns boolean

getBarChartAssignmentUseSpecificBadColorByDescription

  • getBarChartAssignmentUseSpecificBadColorByDescription(description: string): boolean

  • Accesses the item of the widget's array property 'Bar Chart Assignment' whose description equals the passed one and returns the value of it's property 'Use Specific Bad Color. Whether to use the specific Bad Color for a chart configuration or the generic default one'

    Parameters

    • description: string

      The description of the item whose property 'Use Specific Bad Color' should be returned

    Returns boolean

getBarChartAssignmentUseSpecificBadColorByIndex

  • getBarChartAssignmentUseSpecificBadColorByIndex(index: number): boolean

  • Accesses the item of the widget's array property 'Bar Chart Assignment' at the passed index and returns the value of it's property 'Use Specific Bad Color. Whether to use the specific Bad Color for a chart configuration or the generic default one'

    Parameters

    • index: number

      The index of the item whose property 'Use Specific Bad Color' should be returned

    Returns boolean

getBarChartAssignmentUseSpecificGoodColorByDescription

  • getBarChartAssignmentUseSpecificGoodColorByDescription(description: string): boolean

  • Accesses the item of the widget's array property 'Bar Chart Assignment' whose description equals the passed one and returns the value of it's property 'Use Specific Good Color. Whether to use the specific Good Color for a chart configuration or the generic default one'

    Parameters

    • description: string

      The description of the item whose property 'Use Specific Good Color' should be returned

    Returns boolean

getBarChartAssignmentUseSpecificGoodColorByIndex

  • getBarChartAssignmentUseSpecificGoodColorByIndex(index: number): boolean

  • Accesses the item of the widget's array property 'Bar Chart Assignment' at the passed index and returns the value of it's property 'Use Specific Good Color. Whether to use the specific Good Color for a chart configuration or the generic default one'

    Parameters

    • index: number

      The index of the item whose property 'Use Specific Good Color' should be returned

    Returns boolean

setBarChartAssignmentAddressSubsetByDescription

  • setBarChartAssignmentAddressSubsetByDescription(newValue: SelectionContext, description: string): void

  • Accesses the item of the widget's array property 'Bar Chart Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Filter'

    Parameters

    • newValue: SelectionContext

      The new value to be assigned to the property 'Filter. Restricts this configuration to only affect data points matching all constraints'

    • description: string

      The description of the item whose property 'Filter' should be set

    Returns void

setBarChartAssignmentAddressSubsetByIndex

  • setBarChartAssignmentAddressSubsetByIndex(newValue: SelectionContext, index: number): void

  • Accesses the item of the widget's array property 'Bar Chart Assignment' at the passed index and assigns the passed new value to it's property 'Filter'

    Parameters

    • newValue: SelectionContext

      The new value to be assigned to the property 'Filter. Restricts this configuration to only affect data points matching all constraints'

    • index: number

      The index of the item whose property 'Filter' should be set

    Returns void

setBarChartAssignmentAxisScenarioIdByDescription

  • setBarChartAssignmentAxisScenarioIdByDescription(newValue: string, description: string): void

  • Accesses the item of the widget's array property 'Bar Chart Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Scenario Id for Axis'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Scenario Id for Axis. id of a scenario which should be assigned to the axis'

    • description: string

      The description of the item whose property 'Scenario Id for Axis' should be set

    Returns void

setBarChartAssignmentAxisScenarioIdByIndex

  • setBarChartAssignmentAxisScenarioIdByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Bar Chart Assignment' at the passed index and assigns the passed new value to it's property 'Scenario Id for Axis'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Scenario Id for Axis. id of a scenario which should be assigned to the axis'

    • index: number

      The index of the item whose property 'Scenario Id for Axis' should be set

    Returns void

setBarChartAssignmentBadColorByDescription

  • setBarChartAssignmentBadColorByDescription(newValue: string, description: string): void

  • Accesses the item of the widget's array property 'Bar Chart Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Specific Bad Color'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Specific Bad Color. The color used for visualization elements with a negative implication. When activated, this property has a higher priority than the corresponding general property 'Default Bad Color'.'

    • description: string

      The description of the item whose property 'Specific Bad Color' should be set

    Returns void

setBarChartAssignmentBadColorByIndex

  • setBarChartAssignmentBadColorByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Bar Chart Assignment' at the passed index and assigns the passed new value to it's property 'Specific Bad Color'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Specific Bad Color. The color used for visualization elements with a negative implication. When activated, this property has a higher priority than the corresponding general property 'Default Bad Color'.'

    • index: number

      The index of the item whose property 'Specific Bad Color' should be set

    Returns void

setBarChartAssignmentComparisonGroupByDescription

  • setBarChartAssignmentComparisonGroupByDescription(newValue: string, description: string): void

  • Accesses the item of the widget's array property 'Bar Chart Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Comparison Group Id'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Comparison Group Id. assigns a comparison group id to the cells addressed by this configuration. cells with the same comparison group id use a visually comparable scaling'

    • description: string

      The description of the item whose property 'Comparison Group Id' should be set

    Returns void

setBarChartAssignmentComparisonGroupByIndex

  • setBarChartAssignmentComparisonGroupByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Bar Chart Assignment' at the passed index and assigns the passed new value to it's property 'Comparison Group Id'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Comparison Group Id. assigns a comparison group id to the cells addressed by this configuration. cells with the same comparison group id use a visually comparable scaling'

    • index: number

      The index of the item whose property 'Comparison Group Id' should be set

    Returns void

setBarChartAssignmentDescriptionByDescription

  • setBarChartAssignmentDescriptionByDescription(newValue: string, description: string): void

  • Accesses the item of the widget's array property 'Bar Chart Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Description (optional)'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Description (optional). Short name that describes this configuration to be recognizable'

    • description: string

      The description of the item whose property 'Description (optional)' should be set

    Returns void

setBarChartAssignmentDescriptionByIndex

  • setBarChartAssignmentDescriptionByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Bar Chart Assignment' at the passed index and assigns the passed new value to it's property 'Description (optional)'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Description (optional). Short name that describes this configuration to be recognizable'

    • index: number

      The index of the item whose property 'Description (optional)' should be set

    Returns void

setBarChartAssignmentEnabledByDescription

  • setBarChartAssignmentEnabledByDescription(newValue: boolean, description: string): void

  • Accesses the item of the widget's array property 'Bar Chart Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Enable'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Enable. If this is deactivated, the config shall have no effect'

    • description: string

      The description of the item whose property 'Enable' should be set

    Returns void

setBarChartAssignmentEnabledByIndex

  • setBarChartAssignmentEnabledByIndex(newValue: boolean, index: number): void

  • Accesses the item of the widget's array property 'Bar Chart Assignment' at the passed index and assigns the passed new value to it's property 'Enable'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Enable. If this is deactivated, the config shall have no effect'

    • index: number

      The index of the item whose property 'Enable' should be set

    Returns void

setBarChartAssignmentGoodColorByDescription

  • setBarChartAssignmentGoodColorByDescription(newValue: string, description: string): void

  • Accesses the item of the widget's array property 'Bar Chart Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Specific Good Color'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Specific Good Color. The color used for visualization elements with a positive implication. When activated, this property has a higher priority than the corresponding general property 'Default Good Color'.'

    • description: string

      The description of the item whose property 'Specific Good Color' should be set

    Returns void

setBarChartAssignmentGoodColorByIndex

  • setBarChartAssignmentGoodColorByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Bar Chart Assignment' at the passed index and assigns the passed new value to it's property 'Specific Good Color'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Specific Good Color. The color used for visualization elements with a positive implication. When activated, this property has a higher priority than the corresponding general property 'Default Good Color'.'

    • index: number

      The index of the item whose property 'Specific Good Color' should be set

    Returns void

setBarChartAssignmentJsonString

  • setBarChartAssignmentJsonString(newBarChartAssignment: string): void

  • Sets the value of the property 'Bar Chart Assignment' as a JSON-String.

    Parameters

    • newBarChartAssignment: string

      Bar Chart Assignment

    Returns void

setBarChartAssignmentNegativeOutlierThresholdByDescription

  • setBarChartAssignmentNegativeOutlierThresholdByDescription(newValue: number, description: string): void

  • Accesses the item of the widget's array property 'Bar Chart Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Negative Outlier Threshold'

    Parameters

    • newValue: number

      The new value to be assigned to the property 'Negative Outlier Threshold. Values less than this threshold are handled as outliers'

    • description: string

      The description of the item whose property 'Negative Outlier Threshold' should be set

    Returns void

setBarChartAssignmentNegativeOutlierThresholdByIndex

  • setBarChartAssignmentNegativeOutlierThresholdByIndex(newValue: number, index: number): void

  • Accesses the item of the widget's array property 'Bar Chart Assignment' at the passed index and assigns the passed new value to it's property 'Negative Outlier Threshold'

    Parameters

    • newValue: number

      The new value to be assigned to the property 'Negative Outlier Threshold. Values less than this threshold are handled as outliers'

    • index: number

      The index of the item whose property 'Negative Outlier Threshold' should be set

    Returns void

setBarChartAssignmentNegativeValueIsGoodByDescription

  • setBarChartAssignmentNegativeValueIsGoodByDescription(newValue: boolean, description: string): void

  • Accesses the item of the widget's array property 'Bar Chart Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Negative Value is Good'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Negative Value is Good. Swaps positive and negative color'

    • description: string

      The description of the item whose property 'Negative Value is Good' should be set

    Returns void

setBarChartAssignmentNegativeValueIsGoodByIndex

  • setBarChartAssignmentNegativeValueIsGoodByIndex(newValue: boolean, index: number): void

  • Accesses the item of the widget's array property 'Bar Chart Assignment' at the passed index and assigns the passed new value to it's property 'Negative Value is Good'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Negative Value is Good. Swaps positive and negative color'

    • index: number

      The index of the item whose property 'Negative Value is Good' should be set

    Returns void

setBarChartAssignmentPositiveOutlierThresholdByDescription

  • setBarChartAssignmentPositiveOutlierThresholdByDescription(newValue: number, description: string): void

  • Accesses the item of the widget's array property 'Bar Chart Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Positive Outlier Threshold'

    Parameters

    • newValue: number

      The new value to be assigned to the property 'Positive Outlier Threshold. Values greater than this threshold are handled as outliers'

    • description: string

      The description of the item whose property 'Positive Outlier Threshold' should be set

    Returns void

setBarChartAssignmentPositiveOutlierThresholdByIndex

  • setBarChartAssignmentPositiveOutlierThresholdByIndex(newValue: number, index: number): void

  • Accesses the item of the widget's array property 'Bar Chart Assignment' at the passed index and assigns the passed new value to it's property 'Positive Outlier Threshold'

    Parameters

    • newValue: number

      The new value to be assigned to the property 'Positive Outlier Threshold. Values greater than this threshold are handled as outliers'

    • index: number

      The index of the item whose property 'Positive Outlier Threshold' should be set

    Returns void

setBarChartAssignmentScenarioIdByDescription

  • setBarChartAssignmentScenarioIdByDescription(newValue: string, description: string): void

  • Accesses the item of the widget's array property 'Bar Chart Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Scenario Id for Bar'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Scenario Id for Bar. id of a scenario which should be assigned to the bar'

    • description: string

      The description of the item whose property 'Scenario Id for Bar' should be set

    Returns void

setBarChartAssignmentScenarioIdByIndex

  • setBarChartAssignmentScenarioIdByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Bar Chart Assignment' at the passed index and assigns the passed new value to it's property 'Scenario Id for Bar'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Scenario Id for Bar. id of a scenario which should be assigned to the bar'

    • index: number

      The index of the item whose property 'Scenario Id for Bar' should be set

    Returns void

setBarChartAssignmentShowLabelsByDescription

  • setBarChartAssignmentShowLabelsByDescription(newValue: boolean, description: string): void

  • Accesses the item of the widget's array property 'Bar Chart Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Labels'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Labels. if activated, data values are displayed for the bars'

    • description: string

      The description of the item whose property 'Labels' should be set

    Returns void

setBarChartAssignmentShowLabelsByIndex

  • setBarChartAssignmentShowLabelsByIndex(newValue: boolean, index: number): void

  • Accesses the item of the widget's array property 'Bar Chart Assignment' at the passed index and assigns the passed new value to it's property 'Labels'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Labels. if activated, data values are displayed for the bars'

    • index: number

      The index of the item whose property 'Labels' should be set

    Returns void

setBarChartAssignmentUseOutlierThresholdByDescription

  • setBarChartAssignmentUseOutlierThresholdByDescription(newValue: boolean, description: string): void

  • Accesses the item of the widget's array property 'Bar Chart Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Use Outlier Threshold'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Use Outlier Threshold. When activated all values greater than the positive and less than the negative outlier threshold are considered outliers and don't affect scaling'

    • description: string

      The description of the item whose property 'Use Outlier Threshold' should be set

    Returns void

setBarChartAssignmentUseOutlierThresholdByIndex

  • setBarChartAssignmentUseOutlierThresholdByIndex(newValue: boolean, index: number): void

  • Accesses the item of the widget's array property 'Bar Chart Assignment' at the passed index and assigns the passed new value to it's property 'Use Outlier Threshold'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Use Outlier Threshold. When activated all values greater than the positive and less than the negative outlier threshold are considered outliers and don't affect scaling'

    • index: number

      The index of the item whose property 'Use Outlier Threshold' should be set

    Returns void

setBarChartAssignmentUseSpecificBadColorByDescription

  • setBarChartAssignmentUseSpecificBadColorByDescription(newValue: boolean, description: string): void

  • Accesses the item of the widget's array property 'Bar Chart Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Use Specific Bad Color'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Use Specific Bad Color. Whether to use the specific Bad Color for a chart configuration or the generic default one'

    • description: string

      The description of the item whose property 'Use Specific Bad Color' should be set

    Returns void

setBarChartAssignmentUseSpecificBadColorByIndex

  • setBarChartAssignmentUseSpecificBadColorByIndex(newValue: boolean, index: number): void

  • Accesses the item of the widget's array property 'Bar Chart Assignment' at the passed index and assigns the passed new value to it's property 'Use Specific Bad Color'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Use Specific Bad Color. Whether to use the specific Bad Color for a chart configuration or the generic default one'

    • index: number

      The index of the item whose property 'Use Specific Bad Color' should be set

    Returns void

setBarChartAssignmentUseSpecificGoodColorByDescription

  • setBarChartAssignmentUseSpecificGoodColorByDescription(newValue: boolean, description: string): void

  • Accesses the item of the widget's array property 'Bar Chart Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Use Specific Good Color'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Use Specific Good Color. Whether to use the specific Good Color for a chart configuration or the generic default one'

    • description: string

      The description of the item whose property 'Use Specific Good Color' should be set

    Returns void

setBarChartAssignmentUseSpecificGoodColorByIndex

  • setBarChartAssignmentUseSpecificGoodColorByIndex(newValue: boolean, index: number): void

  • Accesses the item of the widget's array property 'Bar Chart Assignment' at the passed index and assigns the passed new value to it's property 'Use Specific Good Color'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Use Specific Good Color. Whether to use the specific Good Color for a chart configuration or the generic default one'

    • index: number

      The index of the item whose property 'Use Specific Good Color' should be set

    Returns void

bindDataPointCommentsToInstance Methods

getBindDataPointCommentsToInstance

  • getBindDataPointCommentsToInstance(): boolean

  • Returns the value of the property 'Bind Data Point Comments To Instance' .

    Returns boolean

setBindDataPointCommentsToInstance

  • setBindDataPointCommentsToInstance(newBindDataPointCommentsToInstance: boolean): void

  • Sets the value of the property 'Bind Data Point Comments To Instance' .

    Parameters

    • newBindDataPointCommentsToInstance: boolean

      Bind Data Point Comments To Instance

    Returns void

bindVisualisationCommentToInstance Methods

getBindVisualisationCommentToInstance

  • getBindVisualisationCommentToInstance(): boolean

  • Returns the value of the property 'Bind Visualisation Comment To Instance' .

    Returns boolean

setBindVisualisationCommentToInstance

  • setBindVisualisationCommentToInstance(newBindVisualisationCommentToInstance: boolean): void

  • Sets the value of the property 'Bind Visualisation Comment To Instance' .

    Parameters

    • newBindVisualisationCommentToInstance: boolean

      Bind Visualisation Comment To Instance

    Returns void

cflRules Methods

getCflRules

  • getCflRules(): unknown[]

  • Accesses the items of the widget's array property 'CFL Rules' and returns its value.'

    Returns unknown[]

getCflRulesEnabledByIndex

  • getCflRulesEnabledByIndex(index: number): boolean

  • Accesses the item of the widget's array property 'CFL Rules' at the passed index and returns the value of it's property 'Enabled. if enabled, the rule is active and gets applied to cells of the matrix'

    Parameters

    • index: number

      The index of the item whose property 'Enabled' should be returned

    Returns boolean

getCflRulesJsonString

  • getCflRulesJsonString(): string

  • Returns the value of the property 'Cfl Rules' as a JSON-String.

    Returns string

getCflRulesNameByIndex

  • getCflRulesNameByIndex(index: number): string

  • Accesses the item of the widget's array property 'CFL Rules' at the passed index and returns the value of it's property 'Name. the name of this rule for making it recognizable'

    Parameters

    • index: number

      The index of the item whose property 'Name' should be returned

    Returns string

getCflRulesScriptByIndex

  • getCflRulesScriptByIndex(index: number): string

  • Accesses the item of the widget's array property 'CFL Rules' at the passed index and returns the value of it's property 'Script Body. the JavaScript code of this rule that gets executed in the context of each rendered cell of the matrix'

    Parameters

    • index: number

      The index of the item whose property 'Script Body' should be returned

    Returns string

setCflRules

  • setCflRules(newValue: unknown[]): void

  • Sets the items of the widget's array property 'CFL Rules'. This Method overrides the previously existing items.

    Parameters

    • newValue: unknown[]

      The new items assigned to the property 'CFL Rules'

    Returns void

setCflRulesEnabledByIndex

  • setCflRulesEnabledByIndex(newValue: boolean, index: number): void

  • Accesses the item of the widget's array property 'CFL Rules' at the passed index and assigns the passed new value to it's property 'Enabled'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Enabled. if enabled, the rule is active and gets applied to cells of the matrix'

    • index: number

      The index of the item whose property 'Enabled' should be set

    Returns void

setCflRulesJsonString

  • setCflRulesJsonString(newCflRules: string): void

  • Sets the value of the property 'Cfl Rules' as a JSON-String.

    Parameters

    • newCflRules: string

      Cfl Rules

    Returns void

setCflRulesNameByIndex

  • setCflRulesNameByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'CFL Rules' at the passed index and assigns the passed new value to it's property 'Name'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Name. the name of this rule for making it recognizable'

    • index: number

      The index of the item whose property 'Name' should be set

    Returns void

setCflRulesScriptByIndex

  • setCflRulesScriptByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'CFL Rules' at the passed index and assigns the passed new value to it's property 'Script Body'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Script Body. the JavaScript code of this rule that gets executed in the context of each rendered cell of the matrix'

    • index: number

      The index of the item whose property 'Script Body' should be set

    Returns void

cflVariables Methods

getCflVariables

  • getCflVariables(): unknown[]

  • Accesses the items of the widget's array property 'CFL Variables' and returns its value.'

    Returns unknown[]

getCflVariablesJsonString

  • getCflVariablesJsonString(): string

  • Returns the value of the property 'Cfl Variables' as a JSON-String.

    Returns string

getCflVariablesKeyByIndex

  • getCflVariablesKeyByIndex(index: number): string

  • Accesses the item of the widget's array property 'CFL Variables' at the passed index and returns the value of it's property 'Identifier. A unique identifier that is used to reference this variable in the CFL'

    Parameters

    • index: number

      The index of the item whose property 'Identifier' should be returned

    Returns string

getCflVariablesValueByIndex

  • getCflVariablesValueByIndex(index: number): string

  • Accesses the item of the widget's array property 'CFL Variables' at the passed index and returns the value of it's property 'Value. The Value of the variable, represented in JSON notation. E.g. "car" for a string, or 3.14159 for a number'

    Parameters

    • index: number

      The index of the item whose property 'Value' should be returned

    Returns string

setCflVariables

  • setCflVariables(newValue: unknown[]): void

  • Sets the items of the widget's array property 'CFL Variables'. This Method overrides the previously existing items.

    Parameters

    • newValue: unknown[]

      The new items assigned to the property 'CFL Variables'

    Returns void

setCflVariablesJsonString

  • setCflVariablesJsonString(newCflVariables: string): void

  • Sets the value of the property 'Cfl Variables' as a JSON-String.

    Parameters

    • newCflVariables: string

      Cfl Variables

    Returns void

setCflVariablesKeyByIndex

  • setCflVariablesKeyByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'CFL Variables' at the passed index and assigns the passed new value to it's property 'Identifier'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Identifier. A unique identifier that is used to reference this variable in the CFL'

    • index: number

      The index of the item whose property 'Identifier' should be set

    Returns void

setCflVariablesValueByIndex

  • setCflVariablesValueByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'CFL Variables' at the passed index and assigns the passed new value to it's property 'Value'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Value. The Value of the variable, represented in JSON notation. E.g. "car" for a string, or 3.14159 for a number'

    • index: number

      The index of the item whose property 'Value' should be set

    Returns void

columnHeaderTextAlign Methods

getColumnHeaderTextAlign

  • getColumnHeaderTextAlign(): string

  • Returns the value of the property 'Column Header Text Align' .

    Returns string

setColumnHeaderTextAlign

  • setColumnHeaderTextAlign(newColumnHeaderTextAlign: string): void

  • Sets the value of the property 'Column Header Text Align' .

    Parameters

    • newColumnHeaderTextAlign: string

      Column Header Text Align

    Returns void

columnMargin Methods

getColumnMargin

  • getColumnMargin(): string

  • Returns the value of the property 'Column Margin' .

    Returns string

setColumnMargin

  • setColumnMargin(newColumnMargin: string): void

  • Sets the value of the property 'Column Margin' . Only valid css strings (value + unit[px,rem,em,%]) are allowed. E.g. '10px' or '0.5em'

    Parameters

    • newColumnMargin: string

      Column Margin

    Returns void

columnWidth Methods

getColumnWidth

  • getColumnWidth(): number

  • Returns the value of the property 'Column Width' .

    Returns number

setColumnWidth

  • setColumnWidth(newColumnWidth: number): void

  • Sets the value of the property 'Column Width' .

    Parameters

    • newColumnWidth: number

      Column Width

    Returns void

commentingBackendServerUrl Methods

getCommentingBackendServerUrl

  • getCommentingBackendServerUrl(): string

  • Returns the value of the property 'Commenting Backend Server Url' .

    Returns string

setCommentingBackendServerUrl

  • setCommentingBackendServerUrl(newCommentingBackendServerUrl: string): void

  • Sets the value of the property 'Commenting Backend Server Url' .

    Parameters

    • newCommentingBackendServerUrl: string

      Commenting Backend Server Url

    Returns void

commentingFontFamily Methods

getCommentingFontFamily

  • getCommentingFontFamily(): string

  • Returns the value of the property 'Commenting Font Family' .

    Returns string

setCommentingFontFamily

  • setCommentingFontFamily(newCommentingFontFamily: string): void

  • Sets the value of the property 'Commenting Font Family' .

    Parameters

    • newCommentingFontFamily: string

      Commenting Font Family

    Returns void

commentingHiddenContexts Methods

getCommentingHiddenContexts

  • getCommentingHiddenContexts(): unknown[]

  • Accesses the items of the widget's array property 'Hidden Contexts' and returns its value.'

    Returns unknown[]

getCommentingHiddenContextsJsonString

  • getCommentingHiddenContextsJsonString(): string

  • Returns the value of the property 'Commenting Hidden Contexts' as a JSON-String.

    Returns string

getCommentingHiddenContextsKeyByIndex

  • getCommentingHiddenContextsKeyByIndex(index: number): string

  • Accesses the item of the widget's array property 'Hidden Contexts' at the passed index and returns the value of it's property 'Key. '

    Parameters

    • index: number

      The index of the item whose property 'Key' should be returned

    Returns string

getCommentingHiddenContextsTypeByIndex

  • getCommentingHiddenContextsTypeByIndex(index: number): string

  • Accesses the item of the widget's array property 'Hidden Contexts' at the passed index and returns the value of it's property 'Type. '

    Parameters

    • index: number

      The index of the item whose property 'Type' should be returned

    Returns string

getCommentingHiddenContextsValueByIndex

  • getCommentingHiddenContextsValueByIndex(index: number): string

  • Accesses the item of the widget's array property 'Hidden Contexts' at the passed index and returns the value of it's property 'Value. '

    Parameters

    • index: number

      The index of the item whose property 'Value' should be returned

    Returns string

setCommentingHiddenContexts

  • setCommentingHiddenContexts(newValue: unknown[]): void

  • Sets the items of the widget's array property 'Hidden Contexts'. This Method overrides the previously existing items.

    Parameters

    • newValue: unknown[]

      The new items assigned to the property 'Hidden Contexts'

    Returns void

setCommentingHiddenContextsJsonString

  • setCommentingHiddenContextsJsonString(newCommentingHiddenContexts: string): void

  • Sets the value of the property 'Commenting Hidden Contexts' as a JSON-String.

    Parameters

    • newCommentingHiddenContexts: string

      Commenting Hidden Contexts

    Returns void

setCommentingHiddenContextsKeyByIndex

  • setCommentingHiddenContextsKeyByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Hidden Contexts' at the passed index and assigns the passed new value to it's property 'Key'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Key. '

    • index: number

      The index of the item whose property 'Key' should be set

    Returns void

setCommentingHiddenContextsTypeByIndex

  • setCommentingHiddenContextsTypeByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Hidden Contexts' at the passed index and assigns the passed new value to it's property 'Type'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Type. '

    • index: number

      The index of the item whose property 'Type' should be set

    Returns void

setCommentingHiddenContextsValueByIndex

  • setCommentingHiddenContextsValueByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Hidden Contexts' at the passed index and assigns the passed new value to it's property 'Value'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Value. '

    • index: number

      The index of the item whose property 'Value' should be set

    Returns void

commentingInitialText Methods

getCommentingInitialText

  • getCommentingInitialText(): string

  • Returns the value of the property 'Commenting Initial Text' .

    Returns string

setCommentingInitialText

  • setCommentingInitialText(newCommentingInitialText: string): void

  • Sets the value of the property 'Commenting Initial Text' .

    Parameters

    • newCommentingInitialText: string

      Commenting Initial Text

    Returns void

commentingMoreCommentsExpandable Methods

getCommentingMoreCommentsExpandable

  • getCommentingMoreCommentsExpandable(): boolean

  • Returns the value of the property 'Commenting More Comments Expandable' .

    Returns boolean

setCommentingMoreCommentsExpandable

  • setCommentingMoreCommentsExpandable(newCommentingMoreCommentsExpandable: boolean): void

  • Sets the value of the property 'Commenting More Comments Expandable' .

    Parameters

    • newCommentingMoreCommentsExpandable: boolean

      Commenting More Comments Expandable

    Returns void

commentingShowAuthoringInformation Methods

getCommentingShowAuthoringInformation

  • getCommentingShowAuthoringInformation(): boolean

  • Returns the value of the property 'Commenting Show Authoring Information' .

    Returns boolean

setCommentingShowAuthoringInformation

  • setCommentingShowAuthoringInformation(newCommentingShowAuthoringInformation: boolean): void

  • Sets the value of the property 'Commenting Show Authoring Information' .

    Parameters

    • newCommentingShowAuthoringInformation: boolean

      Commenting Show Authoring Information

    Returns void

commentingShowContexts Methods

getCommentingShowContexts

  • getCommentingShowContexts(): boolean

  • Returns the value of the property 'Commenting Show Contexts' .

    Returns boolean

setCommentingShowContexts

  • setCommentingShowContexts(newCommentingShowContexts: boolean): void

  • Sets the value of the property 'Commenting Show Contexts' .

    Parameters

    • newCommentingShowContexts: boolean

      Commenting Show Contexts

    Returns void

commentingShowMenuEdge Methods

getCommentingShowMenuEdge

  • getCommentingShowMenuEdge(): boolean

  • Returns the value of the property 'Commenting Show Menu Edge' .

    Returns boolean

setCommentingShowMenuEdge

  • setCommentingShowMenuEdge(newCommentingShowMenuEdge: boolean): void

  • Sets the value of the property 'Commenting Show Menu Edge' .

    Parameters

    • newCommentingShowMenuEdge: boolean

      Commenting Show Menu Edge

    Returns void

commentingShowMoreComments Methods

getCommentingShowMoreComments

  • getCommentingShowMoreComments(): boolean

  • Returns the value of the property 'Commenting Show More Comments' .

    Returns boolean

setCommentingShowMoreComments

  • setCommentingShowMoreComments(newCommentingShowMoreComments: boolean): void

  • Sets the value of the property 'Commenting Show More Comments' .

    Parameters

    • newCommentingShowMoreComments: boolean

      Commenting Show More Comments

    Returns void

crossTabRowHeader Methods

getCrossTabRowHeader

  • getCrossTabRowHeader(): boolean

  • Returns the value of the property 'Cross Tab Row Header' .

    Returns boolean

setCrossTabRowHeader

  • setCrossTabRowHeader(newCrossTabRowHeader: boolean): void

  • Sets the value of the property 'Cross Tab Row Header' .

    Parameters

    • newCrossTabRowHeader: boolean

      Cross Tab Row Header

    Returns void

customCalculationConfigs Methods

getCustomCalculationConfigsAddressSubsetByDescription

  • getCustomCalculationConfigsAddressSubsetByDescription(description: string): SelectionContext

  • Accesses the item of the widget's array property 'Calculated Members' whose description equals the passed one and returns the value of it's property 'Filter. Restricts this configuration to only affect data points matching all constraints'

    Parameters

    • description: string

      The description of the item whose property 'Filter' should be returned

    Returns SelectionContext

getCustomCalculationConfigsAddressSubsetByIndex

  • getCustomCalculationConfigsAddressSubsetByIndex(index: number): SelectionContext

  • Accesses the item of the widget's array property 'Calculated Members' at the passed index and returns the value of it's property 'Filter. Restricts this configuration to only affect data points matching all constraints'

    Parameters

    • index: number

      The index of the item whose property 'Filter' should be returned

    Returns SelectionContext

getCustomCalculationConfigsDescriptionByIndex

  • getCustomCalculationConfigsDescriptionByIndex(index: number): string

  • Accesses the item of the widget's array property 'Calculated Members' at the passed index and returns the value of it's property 'Description (optional). Short name that describes this configuration to be recognizable'

    Parameters

    • index: number

      The index of the item whose property 'Description (optional)' should be returned

    Returns string

getCustomCalculationConfigsEnabledByDescription

  • getCustomCalculationConfigsEnabledByDescription(description: string): boolean

  • Accesses the item of the widget's array property 'Calculated Members' whose description equals the passed one and returns the value of it's property 'Enable. If this is deactivated, the config shall have no effect'

    Parameters

    • description: string

      The description of the item whose property 'Enable' should be returned

    Returns boolean

getCustomCalculationConfigsEnabledByIndex

  • getCustomCalculationConfigsEnabledByIndex(index: number): boolean

  • Accesses the item of the widget's array property 'Calculated Members' at the passed index and returns the value of it's property 'Enable. If this is deactivated, the config shall have no effect'

    Parameters

    • index: number

      The index of the item whose property 'Enable' should be returned

    Returns boolean

getCustomCalculationConfigsExpressionByDescription

  • getCustomCalculationConfigsExpressionByDescription(description: string): string

  • Accesses the item of the widget's array property 'Calculated Members' whose description equals the passed one and returns the value of it's property 'Expression. An Expression that should be evaluated for each calculated datapoint'

    Parameters

    • description: string

      The description of the item whose property 'Expression' should be returned

    Returns string

getCustomCalculationConfigsExpressionByIndex

  • getCustomCalculationConfigsExpressionByIndex(index: number): string

  • Accesses the item of the widget's array property 'Calculated Members' at the passed index and returns the value of it's property 'Expression. An Expression that should be evaluated for each calculated datapoint'

    Parameters

    • index: number

      The index of the item whose property 'Expression' should be returned

    Returns string

getCustomCalculationConfigsJsonString

  • getCustomCalculationConfigsJsonString(): string

  • Returns the value of the property 'Custom Calculation Configs' as a JSON-String.

    Returns string

getCustomCalculationConfigsMemberKeyByDescription

  • getCustomCalculationConfigsMemberKeyByDescription(description: string): string

  • Accesses the item of the widget's array property 'Calculated Members' whose description equals the passed one and returns the value of it's property 'New Member Key. The key of the new calculated member'

    Parameters

    • description: string

      The description of the item whose property 'New Member Key' should be returned

    Returns string

getCustomCalculationConfigsMemberKeyByIndex

  • getCustomCalculationConfigsMemberKeyByIndex(index: number): string

  • Accesses the item of the widget's array property 'Calculated Members' at the passed index and returns the value of it's property 'New Member Key. The key of the new calculated member'

    Parameters

    • index: number

      The index of the item whose property 'New Member Key' should be returned

    Returns string

getCustomCalculationConfigsMemberNameByDescription

  • getCustomCalculationConfigsMemberNameByDescription(description: string): string

  • Accesses the item of the widget's array property 'Calculated Members' whose description equals the passed one and returns the value of it's property 'New Member Name. The name of the new calculated member'

    Parameters

    • description: string

      The description of the item whose property 'New Member Name' should be returned

    Returns string

getCustomCalculationConfigsMemberNameByIndex

  • getCustomCalculationConfigsMemberNameByIndex(index: number): string

  • Accesses the item of the widget's array property 'Calculated Members' at the passed index and returns the value of it's property 'New Member Name. The name of the new calculated member'

    Parameters

    • index: number

      The index of the item whose property 'New Member Name' should be returned

    Returns string

getCustomCalculationConfigsTargetDimensionByDescription

  • getCustomCalculationConfigsTargetDimensionByDescription(description: string): string

  • Accesses the item of the widget's array property 'Calculated Members' whose description equals the passed one and returns the value of it's property 'Target Dimension. The dimension for which the new member should be calculated'

    Parameters

    • description: string

      The description of the item whose property 'Target Dimension' should be returned

    Returns string

getCustomCalculationConfigsTargetDimensionByIndex

  • getCustomCalculationConfigsTargetDimensionByIndex(index: number): string

  • Accesses the item of the widget's array property 'Calculated Members' at the passed index and returns the value of it's property 'Target Dimension. The dimension for which the new member should be calculated'

    Parameters

    • index: number

      The index of the item whose property 'Target Dimension' should be returned

    Returns string

setCustomCalculationConfigsAddressSubsetByDescription

  • setCustomCalculationConfigsAddressSubsetByDescription(newValue: SelectionContext, description: string): void

  • Accesses the item of the widget's array property 'Calculated Members' whose description equals the passed one and assigns the passed new value to it's property 'Filter'

    Parameters

    • newValue: SelectionContext

      The new value to be assigned to the property 'Filter. Restricts this configuration to only affect data points matching all constraints'

    • description: string

      The description of the item whose property 'Filter' should be set

    Returns void

setCustomCalculationConfigsAddressSubsetByIndex

  • setCustomCalculationConfigsAddressSubsetByIndex(newValue: SelectionContext, index: number): void

  • Accesses the item of the widget's array property 'Calculated Members' at the passed index and assigns the passed new value to it's property 'Filter'

    Parameters

    • newValue: SelectionContext

      The new value to be assigned to the property 'Filter. Restricts this configuration to only affect data points matching all constraints'

    • index: number

      The index of the item whose property 'Filter' should be set

    Returns void

setCustomCalculationConfigsDescriptionByDescription

  • setCustomCalculationConfigsDescriptionByDescription(newValue: string, description: string): void

  • Accesses the item of the widget's array property 'Calculated Members' whose description equals the passed one and assigns the passed new value to it's property 'Description (optional)'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Description (optional). Short name that describes this configuration to be recognizable'

    • description: string

      The description of the item whose property 'Description (optional)' should be set

    Returns void

setCustomCalculationConfigsDescriptionByIndex

  • setCustomCalculationConfigsDescriptionByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Calculated Members' at the passed index and assigns the passed new value to it's property 'Description (optional)'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Description (optional). Short name that describes this configuration to be recognizable'

    • index: number

      The index of the item whose property 'Description (optional)' should be set

    Returns void

setCustomCalculationConfigsEnabledByDescription

  • setCustomCalculationConfigsEnabledByDescription(newValue: boolean, description: string): void

  • Accesses the item of the widget's array property 'Calculated Members' whose description equals the passed one and assigns the passed new value to it's property 'Enable'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Enable. If this is deactivated, the config shall have no effect'

    • description: string

      The description of the item whose property 'Enable' should be set

    Returns void

setCustomCalculationConfigsEnabledByIndex

  • setCustomCalculationConfigsEnabledByIndex(newValue: boolean, index: number): void

  • Accesses the item of the widget's array property 'Calculated Members' at the passed index and assigns the passed new value to it's property 'Enable'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Enable. If this is deactivated, the config shall have no effect'

    • index: number

      The index of the item whose property 'Enable' should be set

    Returns void

setCustomCalculationConfigsExpressionByDescription

  • setCustomCalculationConfigsExpressionByDescription(newValue: string, description: string): void

  • Accesses the item of the widget's array property 'Calculated Members' whose description equals the passed one and assigns the passed new value to it's property 'Expression'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Expression. An Expression that should be evaluated for each calculated datapoint'

    • description: string

      The description of the item whose property 'Expression' should be set

    Returns void

setCustomCalculationConfigsExpressionByIndex

  • setCustomCalculationConfigsExpressionByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Calculated Members' at the passed index and assigns the passed new value to it's property 'Expression'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Expression. An Expression that should be evaluated for each calculated datapoint'

    • index: number

      The index of the item whose property 'Expression' should be set

    Returns void

setCustomCalculationConfigsJsonString

  • setCustomCalculationConfigsJsonString(newCustomCalculationConfigs: string): void

  • Sets the value of the property 'Custom Calculation Configs' as a JSON-String.

    Parameters

    • newCustomCalculationConfigs: string

      Custom Calculation Configs

    Returns void

setCustomCalculationConfigsMemberKeyByDescription

  • setCustomCalculationConfigsMemberKeyByDescription(newValue: string, description: string): void

  • Accesses the item of the widget's array property 'Calculated Members' whose description equals the passed one and assigns the passed new value to it's property 'New Member Key'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'New Member Key. The key of the new calculated member'

    • description: string

      The description of the item whose property 'New Member Key' should be set

    Returns void

setCustomCalculationConfigsMemberKeyByIndex

  • setCustomCalculationConfigsMemberKeyByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Calculated Members' at the passed index and assigns the passed new value to it's property 'New Member Key'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'New Member Key. The key of the new calculated member'

    • index: number

      The index of the item whose property 'New Member Key' should be set

    Returns void

setCustomCalculationConfigsMemberNameByDescription

  • setCustomCalculationConfigsMemberNameByDescription(newValue: string, description: string): void

  • Accesses the item of the widget's array property 'Calculated Members' whose description equals the passed one and assigns the passed new value to it's property 'New Member Name'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'New Member Name. The name of the new calculated member'

    • description: string

      The description of the item whose property 'New Member Name' should be set

    Returns void

setCustomCalculationConfigsMemberNameByIndex

  • setCustomCalculationConfigsMemberNameByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Calculated Members' at the passed index and assigns the passed new value to it's property 'New Member Name'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'New Member Name. The name of the new calculated member'

    • index: number

      The index of the item whose property 'New Member Name' should be set

    Returns void

setCustomCalculationConfigsTargetDimensionByDescription

  • setCustomCalculationConfigsTargetDimensionByDescription(newValue: string, description: string): void

  • Accesses the item of the widget's array property 'Calculated Members' whose description equals the passed one and assigns the passed new value to it's property 'Target Dimension'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Target Dimension. The dimension for which the new member should be calculated'

    • description: string

      The description of the item whose property 'Target Dimension' should be set

    Returns void

setCustomCalculationConfigsTargetDimensionByIndex

  • setCustomCalculationConfigsTargetDimensionByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Calculated Members' at the passed index and assigns the passed new value to it's property 'Target Dimension'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Target Dimension. The dimension for which the new member should be calculated'

    • index: number

      The index of the item whose property 'Target Dimension' should be set

    Returns void

customCss Methods

getCustomCss

  • getCustomCss(): unknown[]

  • Accesses the items of the widget's array property 'Custom CSS' and returns its value.'

    Returns unknown[]

getCustomCssCssByIndex

  • getCustomCssCssByIndex(index: number): string

  • Accesses the item of the widget's array property 'Custom CSS' at the passed index and returns the value of it's property 'CSS. A collection of CSS rules which should be executed by the browser'

    Parameters

    • index: number

      The index of the item whose property 'CSS' should be returned

    Returns string

getCustomCssEnabledByIndex

  • getCustomCssEnabledByIndex(index: number): boolean

  • Accesses the item of the widget's array property 'Custom CSS' at the passed index and returns the value of it's property 'Enable. If enabled, the css is active and gets applied to the matrix'

    Parameters

    • index: number

      The index of the item whose property 'Enable' should be returned

    Returns boolean

getCustomCssJsonString

  • getCustomCssJsonString(): string

  • Returns the value of the property 'Custom Css' as a JSON-String.

    Returns string

getCustomCssNameByIndex

  • getCustomCssNameByIndex(index: number): string

  • Accesses the item of the widget's array property 'Custom CSS' at the passed index and returns the value of it's property 'Name. The name of this css snippet for making it recognizable'

    Parameters

    • index: number

      The index of the item whose property 'Name' should be returned

    Returns string

setCustomCss

  • setCustomCss(newValue: unknown[]): void

  • Sets the items of the widget's array property 'Custom CSS'. This Method overrides the previously existing items.

    Parameters

    • newValue: unknown[]

      The new items assigned to the property 'Custom CSS'

    Returns void

setCustomCssCssByIndex

  • setCustomCssCssByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Custom CSS' at the passed index and assigns the passed new value to it's property 'CSS'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'CSS. A collection of CSS rules which should be executed by the browser'

    • index: number

      The index of the item whose property 'CSS' should be set

    Returns void

setCustomCssEnabledByIndex

  • setCustomCssEnabledByIndex(newValue: boolean, index: number): void

  • Accesses the item of the widget's array property 'Custom CSS' at the passed index and assigns the passed new value to it's property 'Enable'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Enable. If enabled, the css is active and gets applied to the matrix'

    • index: number

      The index of the item whose property 'Enable' should be set

    Returns void

setCustomCssJsonString

  • setCustomCssJsonString(newCustomCss: string): void

  • Sets the value of the property 'Custom Css' as a JSON-String.

    Parameters

    • newCustomCss: string

      Custom Css

    Returns void

setCustomCssNameByIndex

  • setCustomCssNameByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Custom CSS' at the passed index and assigns the passed new value to it's property 'Name'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Name. The name of this css snippet for making it recognizable'

    • index: number

      The index of the item whose property 'Name' should be set

    Returns void

dataPointCommentRepresentation Methods

getDataPointCommentRepresentation

  • getDataPointCommentRepresentation(): string

  • Returns the value of the property 'Data Point Comment Representation' .

    Returns string

setDataPointCommentRepresentation

  • setDataPointCommentRepresentation(newDataPointCommentRepresentation: string): void

  • Sets the value of the property 'Data Point Comment Representation' .

    Parameters

    • newDataPointCommentRepresentation: string

      Data Point Comment Representation

    Returns void

dataTextAlign Methods

getDataTextAlign

  • getDataTextAlign(): string

  • Returns the value of the property 'Data Text Align' .

    Returns string

setDataTextAlign

  • setDataTextAlign(newDataTextAlign: string): void

  • Sets the value of the property 'Data Text Align' .

    Parameters

    • newDataTextAlign: string

      Data Text Align

    Returns void

datasourceFilter Methods

getDatasourceFilterJsonString

  • getDatasourceFilterJsonString(): string

  • Returns the value of the property 'Datasource Filter' as a JSON-String.

    Returns string

setDatasourceFilterJsonString

  • setDatasourceFilterJsonString(newDatasourceFilter: string): void

  • Sets the value of the property 'Datasource Filter' as a JSON-String.

    Parameters

    • newDatasourceFilter: string

      Datasource Filter

    Returns void

datasourceVariables Methods

getDatasourceVariablesJsonString

  • getDatasourceVariablesJsonString(): string

  • Returns the value of the property 'Datasource Variables' as a JSON-String.

    Returns string

setDatasourceVariablesJsonString

  • setDatasourceVariablesJsonString(newDatasourceVariables: string): void

  • Sets the value of the property 'Datasource Variables' as a JSON-String.

    Parameters

    • newDatasourceVariables: string

      Datasource Variables

    Returns void

deviationChartLabelSize Methods

getDeviationChartLabelSize

  • getDeviationChartLabelSize(): string

  • Returns the value of the property 'Deviation Chart Label Size' .

    Returns string

setDeviationChartLabelSize

  • setDeviationChartLabelSize(newDeviationChartLabelSize: string): void

  • Sets the value of the property 'Deviation Chart Label Size' . Only valid css strings (value + unit[px,rem,em,%]) are allowed. E.g. '10px' or '0.5em'

    Parameters

    • newDeviationChartLabelSize: string

      Deviation Chart Label Size

    Returns void

deviationConfigs Methods

getDeviationConfigsAddressSubsetByDescription

  • getDeviationConfigsAddressSubsetByDescription(description: string): SelectionContext

  • Accesses the item of the widget's array property 'Deviations' whose description equals the passed one and returns the value of it's property 'Filter. Restricts this configuration to only affect data points matching all constraints'

    Parameters

    • description: string

      The description of the item whose property 'Filter' should be returned

    Returns SelectionContext

getDeviationConfigsAddressSubsetByIndex

  • getDeviationConfigsAddressSubsetByIndex(index: number): SelectionContext

  • Accesses the item of the widget's array property 'Deviations' at the passed index and returns the value of it's property 'Filter. Restricts this configuration to only affect data points matching all constraints'

    Parameters

    • index: number

      The index of the item whose property 'Filter' should be returned

    Returns SelectionContext

getDeviationConfigsDescriptionByIndex

  • getDeviationConfigsDescriptionByIndex(index: number): string

  • Accesses the item of the widget's array property 'Deviations' at the passed index and returns the value of it's property 'Description (optional). Short name that describes this configuration to be recognizable'

    Parameters

    • index: number

      The index of the item whose property 'Description (optional)' should be returned

    Returns string

getDeviationConfigsDeviationMemberKeyByDescription

  • getDeviationConfigsDeviationMemberKeyByDescription(description: string): string

  • Accesses the item of the widget's array property 'Deviations' whose description equals the passed one and returns the value of it's property 'New Member Key. The key of the new calculated member'

    Parameters

    • description: string

      The description of the item whose property 'New Member Key' should be returned

    Returns string

getDeviationConfigsDeviationMemberKeyByIndex

  • getDeviationConfigsDeviationMemberKeyByIndex(index: number): string

  • Accesses the item of the widget's array property 'Deviations' at the passed index and returns the value of it's property 'New Member Key. The key of the new calculated member'

    Parameters

    • index: number

      The index of the item whose property 'New Member Key' should be returned

    Returns string

getDeviationConfigsDeviationMemberNameByDescription

  • getDeviationConfigsDeviationMemberNameByDescription(description: string): string

  • Accesses the item of the widget's array property 'Deviations' whose description equals the passed one and returns the value of it's property 'New Member Name. The name of the new calculated member'

    Parameters

    • description: string

      The description of the item whose property 'New Member Name' should be returned

    Returns string

getDeviationConfigsDeviationMemberNameByIndex

  • getDeviationConfigsDeviationMemberNameByIndex(index: number): string

  • Accesses the item of the widget's array property 'Deviations' at the passed index and returns the value of it's property 'New Member Name. The name of the new calculated member'

    Parameters

    • index: number

      The index of the item whose property 'New Member Name' should be returned

    Returns string

getDeviationConfigsDeviationTypeByDescription

  • getDeviationConfigsDeviationTypeByDescription(description: string): string

  • Accesses the item of the widget's array property 'Deviations' whose description equals the passed one and returns the value of it's property 'Type. Absolute deviations describe the variance between subtrahend and minuend value in absolute numbers while percent ones describe the relative increase or decrease of the subtrahend member'

    Parameters

    • description: string

      The description of the item whose property 'Type' should be returned

    Returns string

getDeviationConfigsDeviationTypeByIndex

  • getDeviationConfigsDeviationTypeByIndex(index: number): string

  • Accesses the item of the widget's array property 'Deviations' at the passed index and returns the value of it's property 'Type. Absolute deviations describe the variance between subtrahend and minuend value in absolute numbers while percent ones describe the relative increase or decrease of the subtrahend member'

    Parameters

    • index: number

      The index of the item whose property 'Type' should be returned

    Returns string

getDeviationConfigsEnabledByDescription

  • getDeviationConfigsEnabledByDescription(description: string): boolean

  • Accesses the item of the widget's array property 'Deviations' whose description equals the passed one and returns the value of it's property 'Enable. If this is deactivated, the config shall have no effect'

    Parameters

    • description: string

      The description of the item whose property 'Enable' should be returned

    Returns boolean

getDeviationConfigsEnabledByIndex

  • getDeviationConfigsEnabledByIndex(index: number): boolean

  • Accesses the item of the widget's array property 'Deviations' at the passed index and returns the value of it's property 'Enable. If this is deactivated, the config shall have no effect'

    Parameters

    • index: number

      The index of the item whose property 'Enable' should be returned

    Returns boolean

getDeviationConfigsJsonString

  • getDeviationConfigsJsonString(): string

  • Returns the value of the property 'Deviation Configs' as a JSON-String.

    Returns string

getDeviationConfigsMinuendMemberByDescription

  • getDeviationConfigsMinuendMemberByDescription(description: string): string

  • Accesses the item of the widget's array property 'Deviations' whose description equals the passed one and returns the value of it's property 'Minuend Member. The name of the member which is the 'minuend' in the deviation calculation: minuend - subtrahend'

    Parameters

    • description: string

      The description of the item whose property 'Minuend Member' should be returned

    Returns string

getDeviationConfigsMinuendMemberByIndex

  • getDeviationConfigsMinuendMemberByIndex(index: number): string

  • Accesses the item of the widget's array property 'Deviations' at the passed index and returns the value of it's property 'Minuend Member. The name of the member which is the 'minuend' in the deviation calculation: minuend - subtrahend'

    Parameters

    • index: number

      The index of the item whose property 'Minuend Member' should be returned

    Returns string

getDeviationConfigsSubtrahendMemberByDescription

  • getDeviationConfigsSubtrahendMemberByDescription(description: string): string

  • Accesses the item of the widget's array property 'Deviations' whose description equals the passed one and returns the value of it's property 'Subtrahend Member. The name of the member which is the 'subtrahend' in the deviation calculation: minuend - subtrahend'

    Parameters

    • description: string

      The description of the item whose property 'Subtrahend Member' should be returned

    Returns string

getDeviationConfigsSubtrahendMemberByIndex

  • getDeviationConfigsSubtrahendMemberByIndex(index: number): string

  • Accesses the item of the widget's array property 'Deviations' at the passed index and returns the value of it's property 'Subtrahend Member. The name of the member which is the 'subtrahend' in the deviation calculation: minuend - subtrahend'

    Parameters

    • index: number

      The index of the item whose property 'Subtrahend Member' should be returned

    Returns string

getDeviationConfigsTargetDimensionByDescription

  • getDeviationConfigsTargetDimensionByDescription(description: string): string

  • Accesses the item of the widget's array property 'Deviations' whose description equals the passed one and returns the value of it's property 'Target Dimension. The dimension for which the new member should be calculated'

    Parameters

    • description: string

      The description of the item whose property 'Target Dimension' should be returned

    Returns string

getDeviationConfigsTargetDimensionByIndex

  • getDeviationConfigsTargetDimensionByIndex(index: number): string

  • Accesses the item of the widget's array property 'Deviations' at the passed index and returns the value of it's property 'Target Dimension. The dimension for which the new member should be calculated'

    Parameters

    • index: number

      The index of the item whose property 'Target Dimension' should be returned

    Returns string

setDeviationConfigsAddressSubsetByDescription

  • setDeviationConfigsAddressSubsetByDescription(newValue: SelectionContext, description: string): void

  • Accesses the item of the widget's array property 'Deviations' whose description equals the passed one and assigns the passed new value to it's property 'Filter'

    Parameters

    • newValue: SelectionContext

      The new value to be assigned to the property 'Filter. Restricts this configuration to only affect data points matching all constraints'

    • description: string

      The description of the item whose property 'Filter' should be set

    Returns void

setDeviationConfigsAddressSubsetByIndex

  • setDeviationConfigsAddressSubsetByIndex(newValue: SelectionContext, index: number): void

  • Accesses the item of the widget's array property 'Deviations' at the passed index and assigns the passed new value to it's property 'Filter'

    Parameters

    • newValue: SelectionContext

      The new value to be assigned to the property 'Filter. Restricts this configuration to only affect data points matching all constraints'

    • index: number

      The index of the item whose property 'Filter' should be set

    Returns void

setDeviationConfigsDescriptionByDescription

  • setDeviationConfigsDescriptionByDescription(newValue: string, description: string): void

  • Accesses the item of the widget's array property 'Deviations' whose description equals the passed one and assigns the passed new value to it's property 'Description (optional)'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Description (optional). Short name that describes this configuration to be recognizable'

    • description: string

      The description of the item whose property 'Description (optional)' should be set

    Returns void

setDeviationConfigsDescriptionByIndex

  • setDeviationConfigsDescriptionByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Deviations' at the passed index and assigns the passed new value to it's property 'Description (optional)'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Description (optional). Short name that describes this configuration to be recognizable'

    • index: number

      The index of the item whose property 'Description (optional)' should be set

    Returns void

setDeviationConfigsDeviationMemberKeyByDescription

  • setDeviationConfigsDeviationMemberKeyByDescription(newValue: string, description: string): void

  • Accesses the item of the widget's array property 'Deviations' whose description equals the passed one and assigns the passed new value to it's property 'New Member Key'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'New Member Key. The key of the new calculated member'

    • description: string

      The description of the item whose property 'New Member Key' should be set

    Returns void

setDeviationConfigsDeviationMemberKeyByIndex

  • setDeviationConfigsDeviationMemberKeyByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Deviations' at the passed index and assigns the passed new value to it's property 'New Member Key'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'New Member Key. The key of the new calculated member'

    • index: number

      The index of the item whose property 'New Member Key' should be set

    Returns void

setDeviationConfigsDeviationMemberNameByDescription

  • setDeviationConfigsDeviationMemberNameByDescription(newValue: string, description: string): void

  • Accesses the item of the widget's array property 'Deviations' whose description equals the passed one and assigns the passed new value to it's property 'New Member Name'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'New Member Name. The name of the new calculated member'

    • description: string

      The description of the item whose property 'New Member Name' should be set

    Returns void

setDeviationConfigsDeviationMemberNameByIndex

  • setDeviationConfigsDeviationMemberNameByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Deviations' at the passed index and assigns the passed new value to it's property 'New Member Name'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'New Member Name. The name of the new calculated member'

    • index: number

      The index of the item whose property 'New Member Name' should be set

    Returns void

setDeviationConfigsDeviationTypeByDescription

  • setDeviationConfigsDeviationTypeByDescription(newValue: string, description: string): void

  • Accesses the item of the widget's array property 'Deviations' whose description equals the passed one and assigns the passed new value to it's property 'Type'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Type. Absolute deviations describe the variance between subtrahend and minuend value in absolute numbers while percent ones describe the relative increase or decrease of the subtrahend member'

    • description: string

      The description of the item whose property 'Type' should be set

    Returns void

setDeviationConfigsDeviationTypeByIndex

  • setDeviationConfigsDeviationTypeByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Deviations' at the passed index and assigns the passed new value to it's property 'Type'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Type. Absolute deviations describe the variance between subtrahend and minuend value in absolute numbers while percent ones describe the relative increase or decrease of the subtrahend member'

    • index: number

      The index of the item whose property 'Type' should be set

    Returns void

setDeviationConfigsEnabledByDescription

  • setDeviationConfigsEnabledByDescription(newValue: boolean, description: string): void

  • Accesses the item of the widget's array property 'Deviations' whose description equals the passed one and assigns the passed new value to it's property 'Enable'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Enable. If this is deactivated, the config shall have no effect'

    • description: string

      The description of the item whose property 'Enable' should be set

    Returns void

setDeviationConfigsEnabledByIndex

  • setDeviationConfigsEnabledByIndex(newValue: boolean, index: number): void

  • Accesses the item of the widget's array property 'Deviations' at the passed index and assigns the passed new value to it's property 'Enable'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Enable. If this is deactivated, the config shall have no effect'

    • index: number

      The index of the item whose property 'Enable' should be set

    Returns void

setDeviationConfigsJsonString

  • setDeviationConfigsJsonString(newDeviationConfigs: string): void

  • Sets the value of the property 'Deviation Configs' as a JSON-String.

    Parameters

    • newDeviationConfigs: string

      Deviation Configs

    Returns void

setDeviationConfigsMinuendMemberByDescription

  • setDeviationConfigsMinuendMemberByDescription(newValue: string, description: string): void

  • Accesses the item of the widget's array property 'Deviations' whose description equals the passed one and assigns the passed new value to it's property 'Minuend Member'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Minuend Member. The name of the member which is the 'minuend' in the deviation calculation: minuend - subtrahend'

    • description: string

      The description of the item whose property 'Minuend Member' should be set

    Returns void

setDeviationConfigsMinuendMemberByIndex

  • setDeviationConfigsMinuendMemberByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Deviations' at the passed index and assigns the passed new value to it's property 'Minuend Member'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Minuend Member. The name of the member which is the 'minuend' in the deviation calculation: minuend - subtrahend'

    • index: number

      The index of the item whose property 'Minuend Member' should be set

    Returns void

setDeviationConfigsSubtrahendMemberByDescription

  • setDeviationConfigsSubtrahendMemberByDescription(newValue: string, description: string): void

  • Accesses the item of the widget's array property 'Deviations' whose description equals the passed one and assigns the passed new value to it's property 'Subtrahend Member'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Subtrahend Member. The name of the member which is the 'subtrahend' in the deviation calculation: minuend - subtrahend'

    • description: string

      The description of the item whose property 'Subtrahend Member' should be set

    Returns void

setDeviationConfigsSubtrahendMemberByIndex

  • setDeviationConfigsSubtrahendMemberByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Deviations' at the passed index and assigns the passed new value to it's property 'Subtrahend Member'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Subtrahend Member. The name of the member which is the 'subtrahend' in the deviation calculation: minuend - subtrahend'

    • index: number

      The index of the item whose property 'Subtrahend Member' should be set

    Returns void

setDeviationConfigsTargetDimensionByDescription

  • setDeviationConfigsTargetDimensionByDescription(newValue: string, description: string): void

  • Accesses the item of the widget's array property 'Deviations' whose description equals the passed one and assigns the passed new value to it's property 'Target Dimension'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Target Dimension. The dimension for which the new member should be calculated'

    • description: string

      The description of the item whose property 'Target Dimension' should be set

    Returns void

setDeviationConfigsTargetDimensionByIndex

  • setDeviationConfigsTargetDimensionByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Deviations' at the passed index and assigns the passed new value to it's property 'Target Dimension'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Target Dimension. The dimension for which the new member should be calculated'

    • index: number

      The index of the item whose property 'Target Dimension' should be set

    Returns void

dynamicContexts Methods

getDynamicContexts

  • getDynamicContexts(): unknown[]

  • Accesses the items of the widget's array property 'Dynamic Contexts' and returns its value.'

    Returns unknown[]

getDynamicContextsJsonString

  • getDynamicContextsJsonString(): string

  • Returns the value of the property 'Dynamic Contexts' as a JSON-String.

    Returns string

getDynamicContextsKeyByIndex

  • getDynamicContextsKeyByIndex(index: number): string

  • Accesses the item of the widget's array property 'Dynamic Contexts' at the passed index and returns the value of it's property 'Key. '

    Parameters

    • index: number

      The index of the item whose property 'Key' should be returned

    Returns string

getDynamicContextsKeyTextByIndex

  • getDynamicContextsKeyTextByIndex(index: number): string

  • Accesses the item of the widget's array property 'Dynamic Contexts' at the passed index and returns the value of it's property 'Key Text. '

    Parameters

    • index: number

      The index of the item whose property 'Key Text' should be returned

    Returns string

getDynamicContextsTypeByIndex

  • getDynamicContextsTypeByIndex(index: number): string

  • Accesses the item of the widget's array property 'Dynamic Contexts' at the passed index and returns the value of it's property 'Type. '

    Parameters

    • index: number

      The index of the item whose property 'Type' should be returned

    Returns string

getDynamicContextsValueByIndex

  • getDynamicContextsValueByIndex(index: number): string

  • Accesses the item of the widget's array property 'Dynamic Contexts' at the passed index and returns the value of it's property 'Value. '

    Parameters

    • index: number

      The index of the item whose property 'Value' should be returned

    Returns string

getDynamicContextsValueTextByIndex

  • getDynamicContextsValueTextByIndex(index: number): string

  • Accesses the item of the widget's array property 'Dynamic Contexts' at the passed index and returns the value of it's property 'Value Text. '

    Parameters

    • index: number

      The index of the item whose property 'Value Text' should be returned

    Returns string

setDynamicContexts

  • setDynamicContexts(newValue: unknown[]): void

  • Sets the items of the widget's array property 'Dynamic Contexts'. This Method overrides the previously existing items.

    Parameters

    • newValue: unknown[]

      The new items assigned to the property 'Dynamic Contexts'

    Returns void

setDynamicContextsJsonString

  • setDynamicContextsJsonString(newDynamicContexts: string): void

  • Sets the value of the property 'Dynamic Contexts' as a JSON-String.

    Parameters

    • newDynamicContexts: string

      Dynamic Contexts

    Returns void

setDynamicContextsKeyByIndex

  • setDynamicContextsKeyByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Dynamic Contexts' at the passed index and assigns the passed new value to it's property 'Key'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Key. '

    • index: number

      The index of the item whose property 'Key' should be set

    Returns void

setDynamicContextsKeyTextByIndex

  • setDynamicContextsKeyTextByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Dynamic Contexts' at the passed index and assigns the passed new value to it's property 'Key Text'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Key Text. '

    • index: number

      The index of the item whose property 'Key Text' should be set

    Returns void

setDynamicContextsTypeByIndex

  • setDynamicContextsTypeByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Dynamic Contexts' at the passed index and assigns the passed new value to it's property 'Type'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Type. '

    • index: number

      The index of the item whose property 'Type' should be set

    Returns void

setDynamicContextsValueByIndex

  • setDynamicContextsValueByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Dynamic Contexts' at the passed index and assigns the passed new value to it's property 'Value'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Value. '

    • index: number

      The index of the item whose property 'Value' should be set

    Returns void

setDynamicContextsValueTextByIndex

  • setDynamicContextsValueTextByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Dynamic Contexts' at the passed index and assigns the passed new value to it's property 'Value Text'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Value Text. '

    • index: number

      The index of the item whose property 'Value Text' should be set

    Returns void

editabilityAssignment Methods

getEditabilityAssignmentAddressSubsetByDescription

  • getEditabilityAssignmentAddressSubsetByDescription(description: string): SelectionContext

  • Accesses the item of the widget's array property 'Editability Assignment' whose description equals the passed one and returns the value of it's property 'Filter. Restricts this configuration to only affect data points matching all constraints'

    Parameters

    • description: string

      The description of the item whose property 'Filter' should be returned

    Returns SelectionContext

getEditabilityAssignmentAddressSubsetByIndex

  • getEditabilityAssignmentAddressSubsetByIndex(index: number): SelectionContext

  • Accesses the item of the widget's array property 'Editability Assignment' at the passed index and returns the value of it's property 'Filter. Restricts this configuration to only affect data points matching all constraints'

    Parameters

    • index: number

      The index of the item whose property 'Filter' should be returned

    Returns SelectionContext

getEditabilityAssignmentDescriptionByIndex

  • getEditabilityAssignmentDescriptionByIndex(index: number): string

  • Accesses the item of the widget's array property 'Editability Assignment' at the passed index and returns the value of it's property 'Description (optional). Short name that describes this configuration to be recognizable'

    Parameters

    • index: number

      The index of the item whose property 'Description (optional)' should be returned

    Returns string

getEditabilityAssignmentEditableByDescription

  • getEditabilityAssignmentEditableByDescription(description: string): boolean

  • Accesses the item of the widget's array property 'Editability Assignment' whose description equals the passed one and returns the value of it's property 'Editable. Sets whether the data points selected by the filter are editable'

    Parameters

    • description: string

      The description of the item whose property 'Editable' should be returned

    Returns boolean

getEditabilityAssignmentEditableByIndex

  • getEditabilityAssignmentEditableByIndex(index: number): boolean

  • Accesses the item of the widget's array property 'Editability Assignment' at the passed index and returns the value of it's property 'Editable. Sets whether the data points selected by the filter are editable'

    Parameters

    • index: number

      The index of the item whose property 'Editable' should be returned

    Returns boolean

getEditabilityAssignmentJsonString

  • getEditabilityAssignmentJsonString(): string

  • Returns the value of the property 'Editability Assignment' as a JSON-String.

    Returns string

setEditabilityAssignmentAddressSubsetByDescription

  • setEditabilityAssignmentAddressSubsetByDescription(newValue: SelectionContext, description: string): void

  • Accesses the item of the widget's array property 'Editability Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Filter'

    Parameters

    • newValue: SelectionContext

      The new value to be assigned to the property 'Filter. Restricts this configuration to only affect data points matching all constraints'

    • description: string

      The description of the item whose property 'Filter' should be set

    Returns void

setEditabilityAssignmentAddressSubsetByIndex

  • setEditabilityAssignmentAddressSubsetByIndex(newValue: SelectionContext, index: number): void

  • Accesses the item of the widget's array property 'Editability Assignment' at the passed index and assigns the passed new value to it's property 'Filter'

    Parameters

    • newValue: SelectionContext

      The new value to be assigned to the property 'Filter. Restricts this configuration to only affect data points matching all constraints'

    • index: number

      The index of the item whose property 'Filter' should be set

    Returns void

setEditabilityAssignmentDescriptionByDescription

  • setEditabilityAssignmentDescriptionByDescription(newValue: string, description: string): void

  • Accesses the item of the widget's array property 'Editability Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Description (optional)'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Description (optional). Short name that describes this configuration to be recognizable'

    • description: string

      The description of the item whose property 'Description (optional)' should be set

    Returns void

setEditabilityAssignmentDescriptionByIndex

  • setEditabilityAssignmentDescriptionByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Editability Assignment' at the passed index and assigns the passed new value to it's property 'Description (optional)'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Description (optional). Short name that describes this configuration to be recognizable'

    • index: number

      The index of the item whose property 'Description (optional)' should be set

    Returns void

setEditabilityAssignmentEditableByDescription

  • setEditabilityAssignmentEditableByDescription(newValue: boolean, description: string): void

  • Accesses the item of the widget's array property 'Editability Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Editable'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Editable. Sets whether the data points selected by the filter are editable'

    • description: string

      The description of the item whose property 'Editable' should be set

    Returns void

setEditabilityAssignmentEditableByIndex

  • setEditabilityAssignmentEditableByIndex(newValue: boolean, index: number): void

  • Accesses the item of the widget's array property 'Editability Assignment' at the passed index and assigns the passed new value to it's property 'Editable'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Editable. Sets whether the data points selected by the filter are editable'

    • index: number

      The index of the item whose property 'Editable' should be set

    Returns void

setEditabilityAssignmentJsonString

  • setEditabilityAssignmentJsonString(newEditabilityAssignment: string): void

  • Sets the value of the property 'Editability Assignment' as a JSON-String.

    Parameters

    • newEditabilityAssignment: string

      Editability Assignment

    Returns void

followingHierarchyNodeRowDividers Methods

getFollowingHierarchyNodeRowDividers

  • getFollowingHierarchyNodeRowDividers(): boolean

  • Returns the value of the property 'Following Hierarchy Node Row Dividers' .

    Returns boolean

setFollowingHierarchyNodeRowDividers

  • setFollowingHierarchyNodeRowDividers(newFollowingHierarchyNodeRowDividers: boolean): void

  • Sets the value of the property 'Following Hierarchy Node Row Dividers' .

    Parameters

    • newFollowingHierarchyNodeRowDividers: boolean

      Following Hierarchy Node Row Dividers

    Returns void

followingResults Methods

getFollowingResults

  • getFollowingResults(): boolean

  • Returns the value of the property 'Following Results' .

    Returns boolean

setFollowingResults

  • setFollowingResults(newFollowingResults: boolean): void

  • Sets the value of the property 'Following Results' .

    Parameters

    • newFollowingResults: boolean

      Following Results

    Returns void

fontColor Methods

getFontColor

  • getFontColor(): string

  • Returns the value of the property 'Font Color' .

    Returns string

setFontColor

  • setFontColor(newFontColor: string): void

  • Sets the value of the property 'Font Color' . Only hexadecimal color codes are allowed. E.g. '#FF0000'

    Parameters

    • newFontColor: string

      Font Color

    Returns void

fontFamily Methods

getFontFamily

  • getFontFamily(): string

  • Returns the value of the property 'Font Family' .

    Returns string

setFontFamily

  • setFontFamily(newFontFamily: string): void

  • Sets the value of the property 'Font Family' .

    Parameters

    • newFontFamily: string

      Font Family

    Returns void

fontSize Methods

getFontSize

  • getFontSize(): string

  • Returns the value of the property 'Font Size' .

    Returns string

setFontSize

  • setFontSize(newFontSize: string): void

  • Sets the value of the property 'Font Size' . Only valid css strings (value + unit[px,rem,em,%]) are allowed. E.g. '10px' or '0.5em'

    Parameters

    • newFontSize: string

      Font Size

    Returns void

footerFontSize Methods

getFooterFontSize

  • getFooterFontSize(): string

  • Returns the value of the property 'Footer Font Size' .

    Returns string

setFooterFontSize

  • setFooterFontSize(newFooterFontSize: string): void

  • Sets the value of the property 'Footer Font Size' . Only valid css strings (value + unit[px,rem,em,%]) are allowed. E.g. '10px' or '0.5em'

    Parameters

    • newFooterFontSize: string

      Footer Font Size

    Returns void

footerText Methods

getFooterText

  • getFooterText(): string

  • Returns the value of the property 'Footer Text' .

    Returns string

setFooterText

  • setFooterText(newFooterText: string): void

  • Sets the value of the property 'Footer Text' .

    Parameters

    • newFooterText: string

      Footer Text

    Returns void

goodColor Methods

getGoodColor

  • getGoodColor(): string

  • Returns the value of the property 'Good Color' .

    Returns string

setGoodColor

  • setGoodColor(newGoodColor: string): void

  • Sets the value of the property 'Good Color' . Only hexadecimal color codes are allowed. E.g. '#FF0000'

    Parameters

    • newGoodColor: string

      Good Color

    Returns void

headerElipsis Methods

getHeaderElipsis

  • getHeaderElipsis(): boolean

  • Returns the value of the property 'Header Elipsis' .

    Returns boolean

setHeaderElipsis

  • setHeaderElipsis(newHeaderElipsis: boolean): void

  • Sets the value of the property 'Header Elipsis' .

    Parameters

    • newHeaderElipsis: boolean

      Header Elipsis

    Returns void

headerRowDividerColor Methods

getHeaderRowDividerColor

  • getHeaderRowDividerColor(): string

  • Returns the value of the property 'Header Row Divider Color' .

    Returns string

setHeaderRowDividerColor

  • setHeaderRowDividerColor(newHeaderRowDividerColor: string): void

  • Sets the value of the property 'Header Row Divider Color' . Only hexadecimal color codes are allowed. E.g. '#FF0000'

    Parameters

    • newHeaderRowDividerColor: string

      Header Row Divider Color

    Returns void

headerRowDividerThickness Methods

getHeaderRowDividerThickness

  • getHeaderRowDividerThickness(): string

  • Returns the value of the property 'Header Row Divider Thickness' .

    Returns string

setHeaderRowDividerThickness

  • setHeaderRowDividerThickness(newHeaderRowDividerThickness: string): void

  • Sets the value of the property 'Header Row Divider Thickness' . Only valid css strings (value + unit[px,rem,em,%]) are allowed. E.g. '10px' or '0.5em'

    Parameters

    • newHeaderRowDividerThickness: string

      Header Row Divider Thickness

    Returns void

headerRowDividers Methods

getHeaderRowDividers

  • getHeaderRowDividers(): boolean

  • Returns the value of the property 'Header Row Dividers' .

    Returns boolean

setHeaderRowDividers

  • setHeaderRowDividers(newHeaderRowDividers: boolean): void

  • Sets the value of the property 'Header Row Dividers' .

    Parameters

    • newHeaderRowDividers: boolean

      Header Row Dividers

    Returns void

hierarchyNodeBold Methods

getHierarchyNodeBold

  • getHierarchyNodeBold(): boolean

  • Returns the value of the property 'Hierarchy Node Bold' .

    Returns boolean

setHierarchyNodeBold

  • setHierarchyNodeBold(newHierarchyNodeBold: boolean): void

  • Sets the value of the property 'Hierarchy Node Bold' .

    Parameters

    • newHierarchyNodeBold: boolean

      Hierarchy Node Bold

    Returns void

hierarchyNodeCollapsible Methods

getHierarchyNodeCollapsible

  • getHierarchyNodeCollapsible(): boolean

  • Returns the value of the property 'Hierarchy Node Collapsible' .

    Returns boolean

setHierarchyNodeCollapsible

  • setHierarchyNodeCollapsible(newHierarchyNodeCollapsible: boolean): void

  • Sets the value of the property 'Hierarchy Node Collapsible' .

    Parameters

    • newHierarchyNodeCollapsible: boolean

      Hierarchy Node Collapsible

    Returns void

hierarchyNodeCollapsibleOnWholeCell Methods

getHierarchyNodeCollapsibleOnWholeCell

  • getHierarchyNodeCollapsibleOnWholeCell(): boolean

  • Returns the value of the property 'Hierarchy Node Collapsible On Whole Cell' .

    Returns boolean

setHierarchyNodeCollapsibleOnWholeCell

  • setHierarchyNodeCollapsibleOnWholeCell(newHierarchyNodeCollapsibleOnWholeCell: boolean): void

  • Sets the value of the property 'Hierarchy Node Collapsible On Whole Cell' .

    Parameters

    • newHierarchyNodeCollapsibleOnWholeCell: boolean

      Hierarchy Node Collapsible On Whole Cell

    Returns void

hierarchyNodeColor Methods

getHierarchyNodeColor

  • getHierarchyNodeColor(): string

  • Returns the value of the property 'Hierarchy Node Color' .

    Returns string

setHierarchyNodeColor

  • setHierarchyNodeColor(newHierarchyNodeColor: string): void

  • Sets the value of the property 'Hierarchy Node Color' . Only hexadecimal color codes are allowed. E.g. '#FF0000'

    Parameters

    • newHierarchyNodeColor: string

      Hierarchy Node Color

    Returns void

hierarchyNodeColumnIndentation Methods

getHierarchyNodeColumnIndentation

  • getHierarchyNodeColumnIndentation(): string

  • Returns the value of the property 'Hierarchy Node Column Indentation' .

    Returns string

setHierarchyNodeColumnIndentation

  • setHierarchyNodeColumnIndentation(newHierarchyNodeColumnIndentation: string): void

  • Sets the value of the property 'Hierarchy Node Column Indentation' . Only valid css strings (value + unit[px,rem,em,%]) are allowed. E.g. '10px' or '0.5em'

    Parameters

    • newHierarchyNodeColumnIndentation: string

      Hierarchy Node Column Indentation

    Returns void

hierarchyNodeIndentation Methods

getHierarchyNodeIndentation

  • getHierarchyNodeIndentation(): string

  • Returns the value of the property 'Hierarchy Node Indentation' .

    Returns string

setHierarchyNodeIndentation

  • setHierarchyNodeIndentation(newHierarchyNodeIndentation: string): void

  • Sets the value of the property 'Hierarchy Node Indentation' . Only valid css strings (value + unit[px,rem,em,%]) are allowed. E.g. '10px' or '0.5em'

    Parameters

    • newHierarchyNodeIndentation: string

      Hierarchy Node Indentation

    Returns void

hierarchyNodeItalic Methods

getHierarchyNodeItalic

  • getHierarchyNodeItalic(): boolean

  • Returns the value of the property 'Hierarchy Node Italic' .

    Returns boolean

setHierarchyNodeItalic

  • setHierarchyNodeItalic(newHierarchyNodeItalic: boolean): void

  • Sets the value of the property 'Hierarchy Node Italic' .

    Parameters

    • newHierarchyNodeItalic: boolean

      Hierarchy Node Italic

    Returns void

hierarchyNodeRowDividerColor Methods

getHierarchyNodeRowDividerColor

  • getHierarchyNodeRowDividerColor(): string

  • Returns the value of the property 'Hierarchy Node Row Divider Color' .

    Returns string

setHierarchyNodeRowDividerColor

  • setHierarchyNodeRowDividerColor(newHierarchyNodeRowDividerColor: string): void

  • Sets the value of the property 'Hierarchy Node Row Divider Color' . Only hexadecimal color codes are allowed. E.g. '#FF0000'

    Parameters

    • newHierarchyNodeRowDividerColor: string

      Hierarchy Node Row Divider Color

    Returns void

hierarchyNodeRowDividerThickness Methods

getHierarchyNodeRowDividerThickness

  • getHierarchyNodeRowDividerThickness(): string

  • Returns the value of the property 'Hierarchy Node Row Divider Thickness' .

    Returns string

setHierarchyNodeRowDividerThickness

  • setHierarchyNodeRowDividerThickness(newHierarchyNodeRowDividerThickness: string): void

  • Sets the value of the property 'Hierarchy Node Row Divider Thickness' . Only valid css strings (value + unit[px,rem,em,%]) are allowed. E.g. '10px' or '0.5em'

    Parameters

    • newHierarchyNodeRowDividerThickness: string

      Hierarchy Node Row Divider Thickness

    Returns void

hierarchyNodeRowDividers Methods

getHierarchyNodeRowDividers

  • getHierarchyNodeRowDividers(): boolean

  • Returns the value of the property 'Hierarchy Node Row Dividers' .

    Returns boolean

setHierarchyNodeRowDividers

  • setHierarchyNodeRowDividers(newHierarchyNodeRowDividers: boolean): void

  • Sets the value of the property 'Hierarchy Node Row Dividers' .

    Parameters

    • newHierarchyNodeRowDividers: boolean

      Hierarchy Node Row Dividers

    Returns void

hierarchyNodeRowPadding Methods

getHierarchyNodeRowPadding

  • getHierarchyNodeRowPadding(): string

  • Returns the value of the property 'Hierarchy Node Row Padding' .

    Returns string

setHierarchyNodeRowPadding

  • setHierarchyNodeRowPadding(newHierarchyNodeRowPadding: string): void

  • Sets the value of the property 'Hierarchy Node Row Padding' . Only valid css strings (value + unit[px,rem,em,%]) are allowed. E.g. '10px' or '0.5em'

    Parameters

    • newHierarchyNodeRowPadding: string

      Hierarchy Node Row Padding

    Returns void

hyperAxisConfigs Methods

getHyperAxisConfigs

  • getHyperAxisConfigs(): unknown[]

  • Accesses the items of the widget's array property 'Additional Axes' and returns its value.'

    Returns unknown[]

getHyperAxisConfigsAxisKeyByIndex

  • getHyperAxisConfigsAxisKeyByIndex(index: number): string

  • Accesses the item of the widget's array property 'Additional Axes' at the passed index and returns the value of it's property 'Identifier. A unique identifier that is used to reference this axis'

    Parameters

    • index: number

      The index of the item whose property 'Identifier' should be returned

    Returns string

getHyperAxisConfigsAxisNameByIndex

  • getHyperAxisConfigsAxisNameByIndex(index: number): string

  • Accesses the item of the widget's array property 'Additional Axes' at the passed index and returns the value of it's property 'Name. The name of the Axis that should be created'

    Parameters

    • index: number

      The index of the item whose property 'Name' should be returned

    Returns string

getHyperAxisConfigsEnabledByIndex

  • getHyperAxisConfigsEnabledByIndex(index: number): boolean

  • Accesses the item of the widget's array property 'Additional Axes' at the passed index and returns the value of it's property 'Enable. If this is deactivated, the config shall have no effect'

    Parameters

    • index: number

      The index of the item whose property 'Enable' should be returned

    Returns boolean

getHyperAxisConfigsJsonString

  • getHyperAxisConfigsJsonString(): string

  • Returns the value of the property 'Hyper Axis Configs' as a JSON-String.

    Returns string

setHyperAxisConfigs

  • setHyperAxisConfigs(newValue: unknown[]): void

  • Sets the items of the widget's array property 'Additional Axes'. This Method overrides the previously existing items.

    Parameters

    • newValue: unknown[]

      The new items assigned to the property 'Additional Axes'

    Returns void

setHyperAxisConfigsAxisKeyByIndex

  • setHyperAxisConfigsAxisKeyByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Additional Axes' at the passed index and assigns the passed new value to it's property 'Identifier'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Identifier. A unique identifier that is used to reference this axis'

    • index: number

      The index of the item whose property 'Identifier' should be set

    Returns void

setHyperAxisConfigsAxisNameByIndex

  • setHyperAxisConfigsAxisNameByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Additional Axes' at the passed index and assigns the passed new value to it's property 'Name'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Name. The name of the Axis that should be created'

    • index: number

      The index of the item whose property 'Name' should be set

    Returns void

setHyperAxisConfigsEnabledByIndex

  • setHyperAxisConfigsEnabledByIndex(newValue: boolean, index: number): void

  • Accesses the item of the widget's array property 'Additional Axes' at the passed index and assigns the passed new value to it's property 'Enable'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Enable. If this is deactivated, the config shall have no effect'

    • index: number

      The index of the item whose property 'Enable' should be set

    Returns void

setHyperAxisConfigsJsonString

  • setHyperAxisConfigsJsonString(newHyperAxisConfigs: string): void

  • Sets the value of the property 'Hyper Axis Configs' as a JSON-String.

    Parameters

    • newHyperAxisConfigs: string

      Hyper Axis Configs

    Returns void

hyperTrendAssignment Methods

getHyperTrendAssignment

  • getHyperTrendAssignment(): unknown[]

  • Accesses the items of the widget's array property 'Trend Assignment' and returns its value.'

    Returns unknown[]

getHyperTrendAssignmentAddressSubsetByDescription

  • getHyperTrendAssignmentAddressSubsetByDescription(description: string): SelectionContext

  • Accesses the item of the widget's array property 'Trend Assignment' whose description equals the passed one and returns the value of it's property 'Filter. Restricts this configuration to only affect data points matching all constraints'

    Parameters

    • description: string

      The description of the item whose property 'Filter' should be returned

    Returns SelectionContext

getHyperTrendAssignmentAddressSubsetByIndex

  • getHyperTrendAssignmentAddressSubsetByIndex(index: number): SelectionContext

  • Accesses the item of the widget's array property 'Trend Assignment' at the passed index and returns the value of it's property 'Filter. Restricts this configuration to only affect data points matching all constraints'

    Parameters

    • index: number

      The index of the item whose property 'Filter' should be returned

    Returns SelectionContext

getHyperTrendAssignmentDescriptionByIndex

  • getHyperTrendAssignmentDescriptionByIndex(index: number): string

  • Accesses the item of the widget's array property 'Trend Assignment' at the passed index and returns the value of it's property 'Description (optional). Short name that describes this configuration to be recognizable'

    Parameters

    • index: number

      The index of the item whose property 'Description (optional)' should be returned

    Returns string

getHyperTrendAssignmentEnabledByDescription

  • getHyperTrendAssignmentEnabledByDescription(description: string): boolean

  • Accesses the item of the widget's array property 'Trend Assignment' whose description equals the passed one and returns the value of it's property 'Enable. If this is deactivated, the config shall have no effect'

    Parameters

    • description: string

      The description of the item whose property 'Enable' should be returned

    Returns boolean

getHyperTrendAssignmentEnabledByIndex

  • getHyperTrendAssignmentEnabledByIndex(index: number): boolean

  • Accesses the item of the widget's array property 'Trend Assignment' at the passed index and returns the value of it's property 'Enable. If this is deactivated, the config shall have no effect'

    Parameters

    • index: number

      The index of the item whose property 'Enable' should be returned

    Returns boolean

getHyperTrendAssignmentInToolTipByDescription

  • getHyperTrendAssignmentInToolTipByDescription(description: string): boolean

  • Accesses the item of the widget's array property 'Trend Assignment' whose description equals the passed one and returns the value of it's property 'Show In Tooltip. When activated, the visualisation is shown in a tooltip, instead of hte cell itself'

    Parameters

    • description: string

      The description of the item whose property 'Show In Tooltip' should be returned

    Returns boolean

getHyperTrendAssignmentInToolTipByIndex

  • getHyperTrendAssignmentInToolTipByIndex(index: number): boolean

  • Accesses the item of the widget's array property 'Trend Assignment' at the passed index and returns the value of it's property 'Show In Tooltip. When activated, the visualisation is shown in a tooltip, instead of hte cell itself'

    Parameters

    • index: number

      The index of the item whose property 'Show In Tooltip' should be returned

    Returns boolean

getHyperTrendAssignmentIncludeAggregatesByDescription

  • getHyperTrendAssignmentIncludeAggregatesByDescription(description: string): boolean

  • Accesses the item of the widget's array property 'Trend Assignment' whose description equals the passed one and returns the value of it's property 'Include Aggregates. When activated, aggregation data points like sums are part of the showed data. This option is turned off by default to prevent aggregate peaks from distorting the scaling'

    Parameters

    • description: string

      The description of the item whose property 'Include Aggregates' should be returned

    Returns boolean

getHyperTrendAssignmentIncludeAggregatesByIndex

  • getHyperTrendAssignmentIncludeAggregatesByIndex(index: number): boolean

  • Accesses the item of the widget's array property 'Trend Assignment' at the passed index and returns the value of it's property 'Include Aggregates. When activated, aggregation data points like sums are part of the showed data. This option is turned off by default to prevent aggregate peaks from distorting the scaling'

    Parameters

    • index: number

      The index of the item whose property 'Include Aggregates' should be returned

    Returns boolean

getHyperTrendAssignmentJsonString

  • getHyperTrendAssignmentJsonString(): string

  • Returns the value of the property 'Hyper Trend Assignment' as a JSON-String.

    Returns string

getHyperTrendAssignmentScalingFactorByDescription

  • getHyperTrendAssignmentScalingFactorByDescription(description: string): number

  • Accesses the item of the widget's array property 'Trend Assignment' whose description equals the passed one and returns the value of it's property 'Scaling Factor. Scales the increase of the trend arrow'

    Parameters

    • description: string

      The description of the item whose property 'Scaling Factor' should be returned

    Returns number

getHyperTrendAssignmentScalingFactorByIndex

  • getHyperTrendAssignmentScalingFactorByIndex(index: number): number

  • Accesses the item of the widget's array property 'Trend Assignment' at the passed index and returns the value of it's property 'Scaling Factor. Scales the increase of the trend arrow'

    Parameters

    • index: number

      The index of the item whose property 'Scaling Factor' should be returned

    Returns number

getHyperTrendAssignmentTargetAxisByDescription

  • getHyperTrendAssignmentTargetAxisByDescription(description: string): string

  • Accesses the item of the widget's array property 'Trend Assignment' whose description equals the passed one and returns the value of it's property 'Target Axis. The axis which contains the data to be used for this feature. Additional Axes can be created at the data tab.'

    Parameters

    • description: string

      The description of the item whose property 'Target Axis' should be returned

    Returns string

getHyperTrendAssignmentTargetAxisByIndex

  • getHyperTrendAssignmentTargetAxisByIndex(index: number): string

  • Accesses the item of the widget's array property 'Trend Assignment' at the passed index and returns the value of it's property 'Target Axis. The axis which contains the data to be used for this feature. Additional Axes can be created at the data tab.'

    Parameters

    • index: number

      The index of the item whose property 'Target Axis' should be returned

    Returns string

setHyperTrendAssignment

  • setHyperTrendAssignment(newValue: unknown[]): void

  • Sets the items of the widget's array property 'Trend Assignment'. This Method overrides the previously existing items.

    Parameters

    • newValue: unknown[]

      The new items assigned to the property 'Trend Assignment'

    Returns void

setHyperTrendAssignmentAddressSubsetByDescription

  • setHyperTrendAssignmentAddressSubsetByDescription(newValue: SelectionContext, description: string): void

  • Accesses the item of the widget's array property 'Trend Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Filter'

    Parameters

    • newValue: SelectionContext

      The new value to be assigned to the property 'Filter. Restricts this configuration to only affect data points matching all constraints'

    • description: string

      The description of the item whose property 'Filter' should be set

    Returns void

setHyperTrendAssignmentAddressSubsetByIndex

  • setHyperTrendAssignmentAddressSubsetByIndex(newValue: SelectionContext, index: number): void

  • Accesses the item of the widget's array property 'Trend Assignment' at the passed index and assigns the passed new value to it's property 'Filter'

    Parameters

    • newValue: SelectionContext

      The new value to be assigned to the property 'Filter. Restricts this configuration to only affect data points matching all constraints'

    • index: number

      The index of the item whose property 'Filter' should be set

    Returns void

setHyperTrendAssignmentDescriptionByDescription

  • setHyperTrendAssignmentDescriptionByDescription(newValue: string, description: string): void

  • Accesses the item of the widget's array property 'Trend Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Description (optional)'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Description (optional). Short name that describes this configuration to be recognizable'

    • description: string

      The description of the item whose property 'Description (optional)' should be set

    Returns void

setHyperTrendAssignmentDescriptionByIndex

  • setHyperTrendAssignmentDescriptionByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Trend Assignment' at the passed index and assigns the passed new value to it's property 'Description (optional)'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Description (optional). Short name that describes this configuration to be recognizable'

    • index: number

      The index of the item whose property 'Description (optional)' should be set

    Returns void

setHyperTrendAssignmentEnabledByDescription

  • setHyperTrendAssignmentEnabledByDescription(newValue: boolean, description: string): void

  • Accesses the item of the widget's array property 'Trend Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Enable'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Enable. If this is deactivated, the config shall have no effect'

    • description: string

      The description of the item whose property 'Enable' should be set

    Returns void

setHyperTrendAssignmentEnabledByIndex

  • setHyperTrendAssignmentEnabledByIndex(newValue: boolean, index: number): void

  • Accesses the item of the widget's array property 'Trend Assignment' at the passed index and assigns the passed new value to it's property 'Enable'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Enable. If this is deactivated, the config shall have no effect'

    • index: number

      The index of the item whose property 'Enable' should be set

    Returns void

setHyperTrendAssignmentInToolTipByDescription

  • setHyperTrendAssignmentInToolTipByDescription(newValue: boolean, description: string): void

  • Accesses the item of the widget's array property 'Trend Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Show In Tooltip'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Show In Tooltip. When activated, the visualisation is shown in a tooltip, instead of hte cell itself'

    • description: string

      The description of the item whose property 'Show In Tooltip' should be set

    Returns void

setHyperTrendAssignmentInToolTipByIndex

  • setHyperTrendAssignmentInToolTipByIndex(newValue: boolean, index: number): void

  • Accesses the item of the widget's array property 'Trend Assignment' at the passed index and assigns the passed new value to it's property 'Show In Tooltip'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Show In Tooltip. When activated, the visualisation is shown in a tooltip, instead of hte cell itself'

    • index: number

      The index of the item whose property 'Show In Tooltip' should be set

    Returns void

setHyperTrendAssignmentIncludeAggregatesByDescription

  • setHyperTrendAssignmentIncludeAggregatesByDescription(newValue: boolean, description: string): void

  • Accesses the item of the widget's array property 'Trend Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Include Aggregates'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Include Aggregates. When activated, aggregation data points like sums are part of the showed data. This option is turned off by default to prevent aggregate peaks from distorting the scaling'

    • description: string

      The description of the item whose property 'Include Aggregates' should be set

    Returns void

setHyperTrendAssignmentIncludeAggregatesByIndex

  • setHyperTrendAssignmentIncludeAggregatesByIndex(newValue: boolean, index: number): void

  • Accesses the item of the widget's array property 'Trend Assignment' at the passed index and assigns the passed new value to it's property 'Include Aggregates'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Include Aggregates. When activated, aggregation data points like sums are part of the showed data. This option is turned off by default to prevent aggregate peaks from distorting the scaling'

    • index: number

      The index of the item whose property 'Include Aggregates' should be set

    Returns void

setHyperTrendAssignmentJsonString

  • setHyperTrendAssignmentJsonString(newHyperTrendAssignment: string): void

  • Sets the value of the property 'Hyper Trend Assignment' as a JSON-String.

    Parameters

    • newHyperTrendAssignment: string

      Hyper Trend Assignment

    Returns void

setHyperTrendAssignmentScalingFactorByDescription

  • setHyperTrendAssignmentScalingFactorByDescription(newValue: number, description: string): void

  • Accesses the item of the widget's array property 'Trend Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Scaling Factor'

    Parameters

    • newValue: number

      The new value to be assigned to the property 'Scaling Factor. Scales the increase of the trend arrow'

    • description: string

      The description of the item whose property 'Scaling Factor' should be set

    Returns void

setHyperTrendAssignmentScalingFactorByIndex

  • setHyperTrendAssignmentScalingFactorByIndex(newValue: number, index: number): void

  • Accesses the item of the widget's array property 'Trend Assignment' at the passed index and assigns the passed new value to it's property 'Scaling Factor'

    Parameters

    • newValue: number

      The new value to be assigned to the property 'Scaling Factor. Scales the increase of the trend arrow'

    • index: number

      The index of the item whose property 'Scaling Factor' should be set

    Returns void

setHyperTrendAssignmentTargetAxisByDescription

  • setHyperTrendAssignmentTargetAxisByDescription(newValue: string, description: string): void

  • Accesses the item of the widget's array property 'Trend Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Target Axis'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Target Axis. The axis which contains the data to be used for this feature. Additional Axes can be created at the data tab.'

    • description: string

      The description of the item whose property 'Target Axis' should be set

    Returns void

setHyperTrendAssignmentTargetAxisByIndex

  • setHyperTrendAssignmentTargetAxisByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Trend Assignment' at the passed index and assigns the passed new value to it's property 'Target Axis'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Target Axis. The axis which contains the data to be used for this feature. Additional Axes can be created at the data tab.'

    • index: number

      The index of the item whose property 'Target Axis' should be set

    Returns void

initialRowExpandLevel Methods

getInitialRowExpandLevel

  • getInitialRowExpandLevel(): number

  • Returns the value of the property 'Initial Row Expand Level'.

    Returns number

setInitialRowExpandLevel

  • setInitialRowExpandLevel(newInitialRowExpandLevel: number): void

  • Sets the value of the property 'Initial Row Expand Level'

    Parameters

    • newInitialRowExpandLevel: number

      Initial Row Expand Level

    Returns void

measuresInRows Methods

getMeasuresInRows

  • getMeasuresInRows(): boolean

  • Returns the value of the property 'Measures In Rows' .

    Returns boolean

setMeasuresInRows

  • setMeasuresInRows(newMeasuresInRows: boolean): void

  • Sets the value of the property 'Measures In Rows' .

    Parameters

    • newMeasuresInRows: boolean

      Measures In Rows

    Returns void

nRestConfigs Methods

getNRestConfigsAddressSubsetByDescription

  • getNRestConfigsAddressSubsetByDescription(description: string): SelectionContext

  • Accesses the item of the widget's array property 'N + Rest' whose description equals the passed one and returns the value of it's property 'Target Dimension Filter. Specify a target dimension subset on which the top/bottom determination is based on. Use this property for example to only include specific keyfigures in the ranking'

    Parameters

    • description: string

      The description of the item whose property 'Target Dimension Filter' should be returned

    Returns SelectionContext

getNRestConfigsAddressSubsetByIndex

  • getNRestConfigsAddressSubsetByIndex(index: number): SelectionContext

  • Accesses the item of the widget's array property 'N + Rest' at the passed index and returns the value of it's property 'Target Dimension Filter. Specify a target dimension subset on which the top/bottom determination is based on. Use this property for example to only include specific keyfigures in the ranking'

    Parameters

    • index: number

      The index of the item whose property 'Target Dimension Filter' should be returned

    Returns SelectionContext

getNRestConfigsDescriptionByIndex

  • getNRestConfigsDescriptionByIndex(index: number): string

  • Accesses the item of the widget's array property 'N + Rest' at the passed index and returns the value of it's property 'Description (optional). Short name that describes this configuration to be recognizable'

    Parameters

    • index: number

      The index of the item whose property 'Description (optional)' should be returned

    Returns string

getNRestConfigsEnabledByDescription

  • getNRestConfigsEnabledByDescription(description: string): boolean

  • Accesses the item of the widget's array property 'N + Rest' whose description equals the passed one and returns the value of it's property 'Enable. Enables the calculation of n top/bottom + rest members'

    Parameters

    • description: string

      The description of the item whose property 'Enable' should be returned

    Returns boolean

getNRestConfigsEnabledByIndex

  • getNRestConfigsEnabledByIndex(index: number): boolean

  • Accesses the item of the widget's array property 'N + Rest' at the passed index and returns the value of it's property 'Enable. Enables the calculation of n top/bottom + rest members'

    Parameters

    • index: number

      The index of the item whose property 'Enable' should be returned

    Returns boolean

getNRestConfigsJsonString

  • getNRestConfigsJsonString(): string

  • Returns the value of the property 'NRest Configs' as a JSON-String.

    Returns string

getNRestConfigsMemberNameByDescription

  • getNRestConfigsMemberNameByDescription(description: string): string

  • Accesses the item of the widget's array property 'N + Rest' whose description equals the passed one and returns the value of it's property 'Rest Member Name (optional). Specify a member name for the rest member of the target dimension.'

    Parameters

    • description: string

      The description of the item whose property 'Rest Member Name (optional)' should be returned

    Returns string

getNRestConfigsMemberNameByIndex

  • getNRestConfigsMemberNameByIndex(index: number): string

  • Accesses the item of the widget's array property 'N + Rest' at the passed index and returns the value of it's property 'Rest Member Name (optional). Specify a member name for the rest member of the target dimension.'

    Parameters

    • index: number

      The index of the item whose property 'Rest Member Name (optional)' should be returned

    Returns string

getNRestConfigsModeByDescription

  • getNRestConfigsModeByDescription(description: string): string

  • Accesses the item of the widget's array property 'N + Rest' whose description equals the passed one and returns the value of it's property 'Mode. Determine the ranking mode top or bottom'

    Parameters

    • description: string

      The description of the item whose property 'Mode' should be returned

    Returns string

getNRestConfigsModeByIndex

  • getNRestConfigsModeByIndex(index: number): string

  • Accesses the item of the widget's array property 'N + Rest' at the passed index and returns the value of it's property 'Mode. Determine the ranking mode top or bottom'

    Parameters

    • index: number

      The index of the item whose property 'Mode' should be returned

    Returns string

getNRestConfigsNByDescription

  • getNRestConfigsNByDescription(description: string): number

  • Accesses the item of the widget's array property 'N + Rest' whose description equals the passed one and returns the value of it's property 'Number n of top/bottom members. Number of top/bottom members (excluding the rest member)'

    Parameters

    • description: string

      The description of the item whose property 'Number n of top/bottom members' should be returned

    Returns number

getNRestConfigsNByIndex

  • getNRestConfigsNByIndex(index: number): number

  • Accesses the item of the widget's array property 'N + Rest' at the passed index and returns the value of it's property 'Number n of top/bottom members. Number of top/bottom members (excluding the rest member)'

    Parameters

    • index: number

      The index of the item whose property 'Number n of top/bottom members' should be returned

    Returns number

getNRestConfigsTargetDimensionByDescription

  • getNRestConfigsTargetDimensionByDescription(description: string): string

  • Accesses the item of the widget's array property 'N + Rest' whose description equals the passed one and returns the value of it's property 'Target Dimension. Dimension on whose members the n + rest transformation is performed'

    Parameters

    • description: string

      The description of the item whose property 'Target Dimension' should be returned

    Returns string

getNRestConfigsTargetDimensionByIndex

  • getNRestConfigsTargetDimensionByIndex(index: number): string

  • Accesses the item of the widget's array property 'N + Rest' at the passed index and returns the value of it's property 'Target Dimension. Dimension on whose members the n + rest transformation is performed'

    Parameters

    • index: number

      The index of the item whose property 'Target Dimension' should be returned

    Returns string

setNRestConfigsAddressSubsetByDescription

  • setNRestConfigsAddressSubsetByDescription(newValue: SelectionContext, description: string): void

  • Accesses the item of the widget's array property 'N + Rest' whose description equals the passed one and assigns the passed new value to it's property 'Target Dimension Filter'

    Parameters

    • newValue: SelectionContext

      The new value to be assigned to the property 'Target Dimension Filter. Specify a target dimension subset on which the top/bottom determination is based on. Use this property for example to only include specific keyfigures in the ranking'

    • description: string

      The description of the item whose property 'Target Dimension Filter' should be set

    Returns void

setNRestConfigsAddressSubsetByIndex

  • setNRestConfigsAddressSubsetByIndex(newValue: SelectionContext, index: number): void

  • Accesses the item of the widget's array property 'N + Rest' at the passed index and assigns the passed new value to it's property 'Target Dimension Filter'

    Parameters

    • newValue: SelectionContext

      The new value to be assigned to the property 'Target Dimension Filter. Specify a target dimension subset on which the top/bottom determination is based on. Use this property for example to only include specific keyfigures in the ranking'

    • index: number

      The index of the item whose property 'Target Dimension Filter' should be set

    Returns void

setNRestConfigsDescriptionByDescription

  • setNRestConfigsDescriptionByDescription(newValue: string, description: string): void

  • Accesses the item of the widget's array property 'N + Rest' whose description equals the passed one and assigns the passed new value to it's property 'Description (optional)'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Description (optional). Short name that describes this configuration to be recognizable'

    • description: string

      The description of the item whose property 'Description (optional)' should be set

    Returns void

setNRestConfigsDescriptionByIndex

  • setNRestConfigsDescriptionByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'N + Rest' at the passed index and assigns the passed new value to it's property 'Description (optional)'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Description (optional). Short name that describes this configuration to be recognizable'

    • index: number

      The index of the item whose property 'Description (optional)' should be set

    Returns void

setNRestConfigsEnabledByDescription

  • setNRestConfigsEnabledByDescription(newValue: boolean, description: string): void

  • Accesses the item of the widget's array property 'N + Rest' whose description equals the passed one and assigns the passed new value to it's property 'Enable'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Enable. Enables the calculation of n top/bottom + rest members'

    • description: string

      The description of the item whose property 'Enable' should be set

    Returns void

setNRestConfigsEnabledByIndex

  • setNRestConfigsEnabledByIndex(newValue: boolean, index: number): void

  • Accesses the item of the widget's array property 'N + Rest' at the passed index and assigns the passed new value to it's property 'Enable'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Enable. Enables the calculation of n top/bottom + rest members'

    • index: number

      The index of the item whose property 'Enable' should be set

    Returns void

setNRestConfigsJsonString

  • setNRestConfigsJsonString(newNRestConfigs: string): void

  • Sets the value of the property 'NRest Configs' as a JSON-String.

    Parameters

    • newNRestConfigs: string

      NRest Configs

    Returns void

setNRestConfigsMemberNameByDescription

  • setNRestConfigsMemberNameByDescription(newValue: string, description: string): void

  • Accesses the item of the widget's array property 'N + Rest' whose description equals the passed one and assigns the passed new value to it's property 'Rest Member Name (optional)'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Rest Member Name (optional). Specify a member name for the rest member of the target dimension.'

    • description: string

      The description of the item whose property 'Rest Member Name (optional)' should be set

    Returns void

setNRestConfigsMemberNameByIndex

  • setNRestConfigsMemberNameByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'N + Rest' at the passed index and assigns the passed new value to it's property 'Rest Member Name (optional)'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Rest Member Name (optional). Specify a member name for the rest member of the target dimension.'

    • index: number

      The index of the item whose property 'Rest Member Name (optional)' should be set

    Returns void

setNRestConfigsModeByDescription

  • setNRestConfigsModeByDescription(newValue: string, description: string): void

  • Accesses the item of the widget's array property 'N + Rest' whose description equals the passed one and assigns the passed new value to it's property 'Mode'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Mode. Determine the ranking mode top or bottom'

    • description: string

      The description of the item whose property 'Mode' should be set

    Returns void

setNRestConfigsModeByIndex

  • setNRestConfigsModeByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'N + Rest' at the passed index and assigns the passed new value to it's property 'Mode'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Mode. Determine the ranking mode top or bottom'

    • index: number

      The index of the item whose property 'Mode' should be set

    Returns void

setNRestConfigsNByDescription

  • setNRestConfigsNByDescription(newValue: number, description: string): void

  • Accesses the item of the widget's array property 'N + Rest' whose description equals the passed one and assigns the passed new value to it's property 'Number n of top/bottom members'

    Parameters

    • newValue: number

      The new value to be assigned to the property 'Number n of top/bottom members. Number of top/bottom members (excluding the rest member)'

    • description: string

      The description of the item whose property 'Number n of top/bottom members' should be set

    Returns void

setNRestConfigsNByIndex

  • setNRestConfigsNByIndex(newValue: number, index: number): void

  • Accesses the item of the widget's array property 'N + Rest' at the passed index and assigns the passed new value to it's property 'Number n of top/bottom members'

    Parameters

    • newValue: number

      The new value to be assigned to the property 'Number n of top/bottom members. Number of top/bottom members (excluding the rest member)'

    • index: number

      The index of the item whose property 'Number n of top/bottom members' should be set

    Returns void

setNRestConfigsTargetDimensionByDescription

  • setNRestConfigsTargetDimensionByDescription(newValue: string, description: string): void

  • Accesses the item of the widget's array property 'N + Rest' whose description equals the passed one and assigns the passed new value to it's property 'Target Dimension'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Target Dimension. Dimension on whose members the n + rest transformation is performed'

    • description: string

      The description of the item whose property 'Target Dimension' should be set

    Returns void

setNRestConfigsTargetDimensionByIndex

  • setNRestConfigsTargetDimensionByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'N + Rest' at the passed index and assigns the passed new value to it's property 'Target Dimension'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Target Dimension. Dimension on whose members the n + rest transformation is performed'

    • index: number

      The index of the item whose property 'Target Dimension' should be set

    Returns void

outlierStyle Methods

getOutlierStyle

  • getOutlierStyle(): string

  • Returns the value of the property 'Outlier Style'. possible values are 'LONG' or 'SHORT'

    Returns string

setOutlierStyle

  • setOutlierStyle(newOutlierStyle: string): void

  • Sets the value of the property 'Outlier Style'. Accepts case insensitive strings like 'LONG', 'SHORT' or 'long' or 'Short'

    Parameters

    • newOutlierStyle: string

      Outlier Style

    Returns void

padding Methods

getPadding

  • getPadding(): string

  • Returns the value of the property 'Padding' .

    Returns string

setPadding

  • setPadding(newPadding: string): void

  • Sets the value of the property 'Padding' . Only valid css strings (value + unit[px,rem,em,%]) are allowed. E.g. '10px' or '0.5em'

    Parameters

    • newPadding: string

      Padding

    Returns void

pinChartAssignment Methods

getPinChartAssignmentAddressSubsetByDescription

  • getPinChartAssignmentAddressSubsetByDescription(description: string): SelectionContext

  • Accesses the item of the widget's array property 'Pin Chart Assignment' whose description equals the passed one and returns the value of it's property 'Filter. Restricts this configuration to only affect data points matching all constraints'

    Parameters

    • description: string

      The description of the item whose property 'Filter' should be returned

    Returns SelectionContext

getPinChartAssignmentAddressSubsetByIndex

  • getPinChartAssignmentAddressSubsetByIndex(index: number): SelectionContext

  • Accesses the item of the widget's array property 'Pin Chart Assignment' at the passed index and returns the value of it's property 'Filter. Restricts this configuration to only affect data points matching all constraints'

    Parameters

    • index: number

      The index of the item whose property 'Filter' should be returned

    Returns SelectionContext

getPinChartAssignmentApplyScenarioColorToPinHeadByDescription

  • getPinChartAssignmentApplyScenarioColorToPinHeadByDescription(description: string): boolean

  • Accesses the item of the widget's array property 'Pin Chart Assignment' whose description equals the passed one and returns the value of it's property 'Apply Scenario Color to Pin Head. applies the pin scenario color to the Pin Head instead of the good or bad color'

    Parameters

    • description: string

      The description of the item whose property 'Apply Scenario Color to Pin Head' should be returned

    Returns boolean

getPinChartAssignmentApplyScenarioColorToPinHeadByIndex

  • getPinChartAssignmentApplyScenarioColorToPinHeadByIndex(index: number): boolean

  • Accesses the item of the widget's array property 'Pin Chart Assignment' at the passed index and returns the value of it's property 'Apply Scenario Color to Pin Head. applies the pin scenario color to the Pin Head instead of the good or bad color'

    Parameters

    • index: number

      The index of the item whose property 'Apply Scenario Color to Pin Head' should be returned

    Returns boolean

getPinChartAssignmentAxisScenarioIdByDescription

  • getPinChartAssignmentAxisScenarioIdByDescription(description: string): string

  • Accesses the item of the widget's array property 'Pin Chart Assignment' whose description equals the passed one and returns the value of it's property 'Scenario Id for Axis. id of a scenario which should be assigned to the axis'

    Parameters

    • description: string

      The description of the item whose property 'Scenario Id for Axis' should be returned

    Returns string

getPinChartAssignmentAxisScenarioIdByIndex

  • getPinChartAssignmentAxisScenarioIdByIndex(index: number): string

  • Accesses the item of the widget's array property 'Pin Chart Assignment' at the passed index and returns the value of it's property 'Scenario Id for Axis. id of a scenario which should be assigned to the axis'

    Parameters

    • index: number

      The index of the item whose property 'Scenario Id for Axis' should be returned

    Returns string

getPinChartAssignmentBadColorByDescription

  • getPinChartAssignmentBadColorByDescription(description: string): string

  • Accesses the item of the widget's array property 'Pin Chart Assignment' whose description equals the passed one and returns the value of it's property 'Bad Color. The color used for visualization elements with a negative implication. When activated, this property has a higher priority than the corresponding general property 'Default Bad Color'.'

    Parameters

    • description: string

      The description of the item whose property 'Bad Color' should be returned

    Returns string

getPinChartAssignmentBadColorByIndex

  • getPinChartAssignmentBadColorByIndex(index: number): string

  • Accesses the item of the widget's array property 'Pin Chart Assignment' at the passed index and returns the value of it's property 'Bad Color. The color used for visualization elements with a negative implication. When activated, this property has a higher priority than the corresponding general property 'Default Bad Color'.'

    Parameters

    • index: number

      The index of the item whose property 'Bad Color' should be returned

    Returns string

getPinChartAssignmentComparisonGroupByDescription

  • getPinChartAssignmentComparisonGroupByDescription(description: string): string

  • Accesses the item of the widget's array property 'Pin Chart Assignment' whose description equals the passed one and returns the value of it's property 'Comparison Group Id. assigns a comparison group id to the cells addressed by this configuration. cells with the same comparison group id use a visually comparable scaling'

    Parameters

    • description: string

      The description of the item whose property 'Comparison Group Id' should be returned

    Returns string

getPinChartAssignmentComparisonGroupByIndex

  • getPinChartAssignmentComparisonGroupByIndex(index: number): string

  • Accesses the item of the widget's array property 'Pin Chart Assignment' at the passed index and returns the value of it's property 'Comparison Group Id. assigns a comparison group id to the cells addressed by this configuration. cells with the same comparison group id use a visually comparable scaling'

    Parameters

    • index: number

      The index of the item whose property 'Comparison Group Id' should be returned

    Returns string

getPinChartAssignmentDescriptionByIndex

  • getPinChartAssignmentDescriptionByIndex(index: number): string

  • Accesses the item of the widget's array property 'Pin Chart Assignment' at the passed index and returns the value of it's property 'Description (optional). Short name that describes this configuration to be recognizable'

    Parameters

    • index: number

      The index of the item whose property 'Description (optional)' should be returned

    Returns string

getPinChartAssignmentEnabledByDescription

  • getPinChartAssignmentEnabledByDescription(description: string): boolean

  • Accesses the item of the widget's array property 'Pin Chart Assignment' whose description equals the passed one and returns the value of it's property 'Enable. If this is deactivated, the config shall have no effect'

    Parameters

    • description: string

      The description of the item whose property 'Enable' should be returned

    Returns boolean

getPinChartAssignmentEnabledByIndex

  • getPinChartAssignmentEnabledByIndex(index: number): boolean

  • Accesses the item of the widget's array property 'Pin Chart Assignment' at the passed index and returns the value of it's property 'Enable. If this is deactivated, the config shall have no effect'

    Parameters

    • index: number

      The index of the item whose property 'Enable' should be returned

    Returns boolean

getPinChartAssignmentGoodColorByDescription

  • getPinChartAssignmentGoodColorByDescription(description: string): string

  • Accesses the item of the widget's array property 'Pin Chart Assignment' whose description equals the passed one and returns the value of it's property 'Good Color. The color used for visualization elements with a positive implication. When activated, this property has a higher priority than the corresponding general property 'Default Good Color'.'

    Parameters

    • description: string

      The description of the item whose property 'Good Color' should be returned

    Returns string

getPinChartAssignmentGoodColorByIndex

  • getPinChartAssignmentGoodColorByIndex(index: number): string

  • Accesses the item of the widget's array property 'Pin Chart Assignment' at the passed index and returns the value of it's property 'Good Color. The color used for visualization elements with a positive implication. When activated, this property has a higher priority than the corresponding general property 'Default Good Color'.'

    Parameters

    • index: number

      The index of the item whose property 'Good Color' should be returned

    Returns string

getPinChartAssignmentJsonString

  • getPinChartAssignmentJsonString(): string

  • Returns the value of the property 'Pin Chart Assignment' as a JSON-String.

    Returns string

getPinChartAssignmentNegativeOutlierThresholdByDescription

  • getPinChartAssignmentNegativeOutlierThresholdByDescription(description: string): number

  • Accesses the item of the widget's array property 'Pin Chart Assignment' whose description equals the passed one and returns the value of it's property 'Negative Outlier Threshold. Values less than this threshold are handled as outliers'

    Parameters

    • description: string

      The description of the item whose property 'Negative Outlier Threshold' should be returned

    Returns number

getPinChartAssignmentNegativeOutlierThresholdByIndex

  • getPinChartAssignmentNegativeOutlierThresholdByIndex(index: number): number

  • Accesses the item of the widget's array property 'Pin Chart Assignment' at the passed index and returns the value of it's property 'Negative Outlier Threshold. Values less than this threshold are handled as outliers'

    Parameters

    • index: number

      The index of the item whose property 'Negative Outlier Threshold' should be returned

    Returns number

getPinChartAssignmentNegativeValueIsGoodByDescription

  • getPinChartAssignmentNegativeValueIsGoodByDescription(description: string): boolean

  • Accesses the item of the widget's array property 'Pin Chart Assignment' whose description equals the passed one and returns the value of it's property 'Negative Value is Good. Swaps positive and negative color'

    Parameters

    • description: string

      The description of the item whose property 'Negative Value is Good' should be returned

    Returns boolean

getPinChartAssignmentNegativeValueIsGoodByIndex

  • getPinChartAssignmentNegativeValueIsGoodByIndex(index: number): boolean

  • Accesses the item of the widget's array property 'Pin Chart Assignment' at the passed index and returns the value of it's property 'Negative Value is Good. Swaps positive and negative color'

    Parameters

    • index: number

      The index of the item whose property 'Negative Value is Good' should be returned

    Returns boolean

getPinChartAssignmentPinLineOnTopByDescription

  • getPinChartAssignmentPinLineOnTopByDescription(description: string): boolean

  • Accesses the item of the widget's array property 'Pin Chart Assignment' whose description equals the passed one and returns the value of it's property 'Pin Line on Top. Displays the pin line in front of the Axis and Pin Head'

    Parameters

    • description: string

      The description of the item whose property 'Pin Line on Top' should be returned

    Returns boolean

getPinChartAssignmentPinLineOnTopByIndex

  • getPinChartAssignmentPinLineOnTopByIndex(index: number): boolean

  • Accesses the item of the widget's array property 'Pin Chart Assignment' at the passed index and returns the value of it's property 'Pin Line on Top. Displays the pin line in front of the Axis and Pin Head'

    Parameters

    • index: number

      The index of the item whose property 'Pin Line on Top' should be returned

    Returns boolean

getPinChartAssignmentPositiveOutlierThresholdByDescription

  • getPinChartAssignmentPositiveOutlierThresholdByDescription(description: string): number

  • Accesses the item of the widget's array property 'Pin Chart Assignment' whose description equals the passed one and returns the value of it's property 'Positive Outlier Threshold. Values greater than this threshold are handled as outliers'

    Parameters

    • description: string

      The description of the item whose property 'Positive Outlier Threshold' should be returned

    Returns number

getPinChartAssignmentPositiveOutlierThresholdByIndex

  • getPinChartAssignmentPositiveOutlierThresholdByIndex(index: number): number

  • Accesses the item of the widget's array property 'Pin Chart Assignment' at the passed index and returns the value of it's property 'Positive Outlier Threshold. Values greater than this threshold are handled as outliers'

    Parameters

    • index: number

      The index of the item whose property 'Positive Outlier Threshold' should be returned

    Returns number

getPinChartAssignmentScenarioIdByDescription

  • getPinChartAssignmentScenarioIdByDescription(description: string): string

  • Accesses the item of the widget's array property 'Pin Chart Assignment' whose description equals the passed one and returns the value of it's property 'Scenario Id for Pin. id of a scenario which should be assigned to the pin'

    Parameters

    • description: string

      The description of the item whose property 'Scenario Id for Pin' should be returned

    Returns string

getPinChartAssignmentScenarioIdByIndex

  • getPinChartAssignmentScenarioIdByIndex(index: number): string

  • Accesses the item of the widget's array property 'Pin Chart Assignment' at the passed index and returns the value of it's property 'Scenario Id for Pin. id of a scenario which should be assigned to the pin'

    Parameters

    • index: number

      The index of the item whose property 'Scenario Id for Pin' should be returned

    Returns string

getPinChartAssignmentShowLabelsByDescription

  • getPinChartAssignmentShowLabelsByDescription(description: string): boolean

  • Accesses the item of the widget's array property 'Pin Chart Assignment' whose description equals the passed one and returns the value of it's property 'Labels. if activated, data values are displayed for the pins'

    Parameters

    • description: string

      The description of the item whose property 'Labels' should be returned

    Returns boolean

getPinChartAssignmentShowLabelsByIndex

  • getPinChartAssignmentShowLabelsByIndex(index: number): boolean

  • Accesses the item of the widget's array property 'Pin Chart Assignment' at the passed index and returns the value of it's property 'Labels. if activated, data values are displayed for the pins'

    Parameters

    • index: number

      The index of the item whose property 'Labels' should be returned

    Returns boolean

getPinChartAssignmentUseOutlierThresholdByDescription

  • getPinChartAssignmentUseOutlierThresholdByDescription(description: string): boolean

  • Accesses the item of the widget's array property 'Pin Chart Assignment' whose description equals the passed one and returns the value of it's property 'Use Outlier Threshold. When activated all values greater than the positive and less than the negative outlier threshold are considered outliers and don't affect scaling'

    Parameters

    • description: string

      The description of the item whose property 'Use Outlier Threshold' should be returned

    Returns boolean

getPinChartAssignmentUseOutlierThresholdByIndex

  • getPinChartAssignmentUseOutlierThresholdByIndex(index: number): boolean

  • Accesses the item of the widget's array property 'Pin Chart Assignment' at the passed index and returns the value of it's property 'Use Outlier Threshold. When activated all values greater than the positive and less than the negative outlier threshold are considered outliers and don't affect scaling'

    Parameters

    • index: number

      The index of the item whose property 'Use Outlier Threshold' should be returned

    Returns boolean

getPinChartAssignmentUseSpecificBadColorByDescription

  • getPinChartAssignmentUseSpecificBadColorByDescription(description: string): boolean

  • Accesses the item of the widget's array property 'Pin Chart Assignment' whose description equals the passed one and returns the value of it's property 'Use Specific Bad Color. Whether to use the specific Bad Color for a chart configuration or the generic default one'

    Parameters

    • description: string

      The description of the item whose property 'Use Specific Bad Color' should be returned

    Returns boolean

getPinChartAssignmentUseSpecificBadColorByIndex

  • getPinChartAssignmentUseSpecificBadColorByIndex(index: number): boolean

  • Accesses the item of the widget's array property 'Pin Chart Assignment' at the passed index and returns the value of it's property 'Use Specific Bad Color. Whether to use the specific Bad Color for a chart configuration or the generic default one'

    Parameters

    • index: number

      The index of the item whose property 'Use Specific Bad Color' should be returned

    Returns boolean

getPinChartAssignmentUseSpecificGoodColorByDescription

  • getPinChartAssignmentUseSpecificGoodColorByDescription(description: string): boolean

  • Accesses the item of the widget's array property 'Pin Chart Assignment' whose description equals the passed one and returns the value of it's property 'Use Specific Good Color. Whether to use the specific Good Color for a chart configuration or the generic default one'

    Parameters

    • description: string

      The description of the item whose property 'Use Specific Good Color' should be returned

    Returns boolean

getPinChartAssignmentUseSpecificGoodColorByIndex

  • getPinChartAssignmentUseSpecificGoodColorByIndex(index: number): boolean

  • Accesses the item of the widget's array property 'Pin Chart Assignment' at the passed index and returns the value of it's property 'Use Specific Good Color. Whether to use the specific Good Color for a chart configuration or the generic default one'

    Parameters

    • index: number

      The index of the item whose property 'Use Specific Good Color' should be returned

    Returns boolean

setPinChartAssignmentAddressSubsetByDescription

  • setPinChartAssignmentAddressSubsetByDescription(newValue: SelectionContext, description: string): void

  • Accesses the item of the widget's array property 'Pin Chart Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Filter'

    Parameters

    • newValue: SelectionContext

      The new value to be assigned to the property 'Filter. Restricts this configuration to only affect data points matching all constraints'

    • description: string

      The description of the item whose property 'Filter' should be set

    Returns void

setPinChartAssignmentAddressSubsetByIndex

  • setPinChartAssignmentAddressSubsetByIndex(newValue: SelectionContext, index: number): void

  • Accesses the item of the widget's array property 'Pin Chart Assignment' at the passed index and assigns the passed new value to it's property 'Filter'

    Parameters

    • newValue: SelectionContext

      The new value to be assigned to the property 'Filter. Restricts this configuration to only affect data points matching all constraints'

    • index: number

      The index of the item whose property 'Filter' should be set

    Returns void

setPinChartAssignmentApplyScenarioColorToPinHeadByDescription

  • setPinChartAssignmentApplyScenarioColorToPinHeadByDescription(newValue: boolean, description: string): void

  • Accesses the item of the widget's array property 'Pin Chart Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Apply Scenario Color to Pin Head'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Apply Scenario Color to Pin Head. applies the pin scenario color to the Pin Head instead of the good or bad color'

    • description: string

      The description of the item whose property 'Apply Scenario Color to Pin Head' should be set

    Returns void

setPinChartAssignmentApplyScenarioColorToPinHeadByIndex

  • setPinChartAssignmentApplyScenarioColorToPinHeadByIndex(newValue: boolean, index: number): void

  • Accesses the item of the widget's array property 'Pin Chart Assignment' at the passed index and assigns the passed new value to it's property 'Apply Scenario Color to Pin Head'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Apply Scenario Color to Pin Head. applies the pin scenario color to the Pin Head instead of the good or bad color'

    • index: number

      The index of the item whose property 'Apply Scenario Color to Pin Head' should be set

    Returns void

setPinChartAssignmentAxisScenarioIdByDescription

  • setPinChartAssignmentAxisScenarioIdByDescription(newValue: string, description: string): void

  • Accesses the item of the widget's array property 'Pin Chart Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Scenario Id for Axis'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Scenario Id for Axis. id of a scenario which should be assigned to the axis'

    • description: string

      The description of the item whose property 'Scenario Id for Axis' should be set

    Returns void

setPinChartAssignmentAxisScenarioIdByIndex

  • setPinChartAssignmentAxisScenarioIdByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Pin Chart Assignment' at the passed index and assigns the passed new value to it's property 'Scenario Id for Axis'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Scenario Id for Axis. id of a scenario which should be assigned to the axis'

    • index: number

      The index of the item whose property 'Scenario Id for Axis' should be set

    Returns void

setPinChartAssignmentBadColorByDescription

  • setPinChartAssignmentBadColorByDescription(newValue: string, description: string): void

  • Accesses the item of the widget's array property 'Pin Chart Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Bad Color'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Bad Color. The color used for visualization elements with a negative implication. When activated, this property has a higher priority than the corresponding general property 'Default Bad Color'.'

    • description: string

      The description of the item whose property 'Bad Color' should be set

    Returns void

setPinChartAssignmentBadColorByIndex

  • setPinChartAssignmentBadColorByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Pin Chart Assignment' at the passed index and assigns the passed new value to it's property 'Bad Color'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Bad Color. The color used for visualization elements with a negative implication. When activated, this property has a higher priority than the corresponding general property 'Default Bad Color'.'

    • index: number

      The index of the item whose property 'Bad Color' should be set

    Returns void

setPinChartAssignmentComparisonGroupByDescription

  • setPinChartAssignmentComparisonGroupByDescription(newValue: string, description: string): void

  • Accesses the item of the widget's array property 'Pin Chart Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Comparison Group Id'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Comparison Group Id. assigns a comparison group id to the cells addressed by this configuration. cells with the same comparison group id use a visually comparable scaling'

    • description: string

      The description of the item whose property 'Comparison Group Id' should be set

    Returns void

setPinChartAssignmentComparisonGroupByIndex

  • setPinChartAssignmentComparisonGroupByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Pin Chart Assignment' at the passed index and assigns the passed new value to it's property 'Comparison Group Id'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Comparison Group Id. assigns a comparison group id to the cells addressed by this configuration. cells with the same comparison group id use a visually comparable scaling'

    • index: number

      The index of the item whose property 'Comparison Group Id' should be set

    Returns void

setPinChartAssignmentDescriptionByDescription

  • setPinChartAssignmentDescriptionByDescription(newValue: string, description: string): void

  • Accesses the item of the widget's array property 'Pin Chart Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Description (optional)'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Description (optional). Short name that describes this configuration to be recognizable'

    • description: string

      The description of the item whose property 'Description (optional)' should be set

    Returns void

setPinChartAssignmentDescriptionByIndex

  • setPinChartAssignmentDescriptionByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Pin Chart Assignment' at the passed index and assigns the passed new value to it's property 'Description (optional)'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Description (optional). Short name that describes this configuration to be recognizable'

    • index: number

      The index of the item whose property 'Description (optional)' should be set

    Returns void

setPinChartAssignmentEnabledByDescription

  • setPinChartAssignmentEnabledByDescription(newValue: boolean, description: string): void

  • Accesses the item of the widget's array property 'Pin Chart Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Enable'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Enable. If this is deactivated, the config shall have no effect'

    • description: string

      The description of the item whose property 'Enable' should be set

    Returns void

setPinChartAssignmentEnabledByIndex

  • setPinChartAssignmentEnabledByIndex(newValue: boolean, index: number): void

  • Accesses the item of the widget's array property 'Pin Chart Assignment' at the passed index and assigns the passed new value to it's property 'Enable'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Enable. If this is deactivated, the config shall have no effect'

    • index: number

      The index of the item whose property 'Enable' should be set

    Returns void

setPinChartAssignmentGoodColorByDescription

  • setPinChartAssignmentGoodColorByDescription(newValue: string, description: string): void

  • Accesses the item of the widget's array property 'Pin Chart Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Good Color'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Good Color. The color used for visualization elements with a positive implication. When activated, this property has a higher priority than the corresponding general property 'Default Good Color'.'

    • description: string

      The description of the item whose property 'Good Color' should be set

    Returns void

setPinChartAssignmentGoodColorByIndex

  • setPinChartAssignmentGoodColorByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Pin Chart Assignment' at the passed index and assigns the passed new value to it's property 'Good Color'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Good Color. The color used for visualization elements with a positive implication. When activated, this property has a higher priority than the corresponding general property 'Default Good Color'.'

    • index: number

      The index of the item whose property 'Good Color' should be set

    Returns void

setPinChartAssignmentJsonString

  • setPinChartAssignmentJsonString(newPinChartAssignment: string): void

  • Sets the value of the property 'Pin Chart Assignment' as a JSON-String.

    Parameters

    • newPinChartAssignment: string

      Pin Chart Assignment

    Returns void

setPinChartAssignmentNegativeOutlierThresholdByDescription

  • setPinChartAssignmentNegativeOutlierThresholdByDescription(newValue: number, description: string): void

  • Accesses the item of the widget's array property 'Pin Chart Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Negative Outlier Threshold'

    Parameters

    • newValue: number

      The new value to be assigned to the property 'Negative Outlier Threshold. Values less than this threshold are handled as outliers'

    • description: string

      The description of the item whose property 'Negative Outlier Threshold' should be set

    Returns void

setPinChartAssignmentNegativeOutlierThresholdByIndex

  • setPinChartAssignmentNegativeOutlierThresholdByIndex(newValue: number, index: number): void

  • Accesses the item of the widget's array property 'Pin Chart Assignment' at the passed index and assigns the passed new value to it's property 'Negative Outlier Threshold'

    Parameters

    • newValue: number

      The new value to be assigned to the property 'Negative Outlier Threshold. Values less than this threshold are handled as outliers'

    • index: number

      The index of the item whose property 'Negative Outlier Threshold' should be set

    Returns void

setPinChartAssignmentNegativeValueIsGoodByDescription

  • setPinChartAssignmentNegativeValueIsGoodByDescription(newValue: boolean, description: string): void

  • Accesses the item of the widget's array property 'Pin Chart Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Negative Value is Good'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Negative Value is Good. Swaps positive and negative color'

    • description: string

      The description of the item whose property 'Negative Value is Good' should be set

    Returns void

setPinChartAssignmentNegativeValueIsGoodByIndex

  • setPinChartAssignmentNegativeValueIsGoodByIndex(newValue: boolean, index: number): void

  • Accesses the item of the widget's array property 'Pin Chart Assignment' at the passed index and assigns the passed new value to it's property 'Negative Value is Good'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Negative Value is Good. Swaps positive and negative color'

    • index: number

      The index of the item whose property 'Negative Value is Good' should be set

    Returns void

setPinChartAssignmentPinLineOnTopByDescription

  • setPinChartAssignmentPinLineOnTopByDescription(newValue: boolean, description: string): void

  • Accesses the item of the widget's array property 'Pin Chart Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Pin Line on Top'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Pin Line on Top. Displays the pin line in front of the Axis and Pin Head'

    • description: string

      The description of the item whose property 'Pin Line on Top' should be set

    Returns void

setPinChartAssignmentPinLineOnTopByIndex

  • setPinChartAssignmentPinLineOnTopByIndex(newValue: boolean, index: number): void

  • Accesses the item of the widget's array property 'Pin Chart Assignment' at the passed index and assigns the passed new value to it's property 'Pin Line on Top'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Pin Line on Top. Displays the pin line in front of the Axis and Pin Head'

    • index: number

      The index of the item whose property 'Pin Line on Top' should be set

    Returns void

setPinChartAssignmentPositiveOutlierThresholdByDescription

  • setPinChartAssignmentPositiveOutlierThresholdByDescription(newValue: number, description: string): void

  • Accesses the item of the widget's array property 'Pin Chart Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Positive Outlier Threshold'

    Parameters

    • newValue: number

      The new value to be assigned to the property 'Positive Outlier Threshold. Values greater than this threshold are handled as outliers'

    • description: string

      The description of the item whose property 'Positive Outlier Threshold' should be set

    Returns void

setPinChartAssignmentPositiveOutlierThresholdByIndex

  • setPinChartAssignmentPositiveOutlierThresholdByIndex(newValue: number, index: number): void

  • Accesses the item of the widget's array property 'Pin Chart Assignment' at the passed index and assigns the passed new value to it's property 'Positive Outlier Threshold'

    Parameters

    • newValue: number

      The new value to be assigned to the property 'Positive Outlier Threshold. Values greater than this threshold are handled as outliers'

    • index: number

      The index of the item whose property 'Positive Outlier Threshold' should be set

    Returns void

setPinChartAssignmentScenarioIdByDescription

  • setPinChartAssignmentScenarioIdByDescription(newValue: string, description: string): void

  • Accesses the item of the widget's array property 'Pin Chart Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Scenario Id for Pin'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Scenario Id for Pin. id of a scenario which should be assigned to the pin'

    • description: string

      The description of the item whose property 'Scenario Id for Pin' should be set

    Returns void

setPinChartAssignmentScenarioIdByIndex

  • setPinChartAssignmentScenarioIdByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Pin Chart Assignment' at the passed index and assigns the passed new value to it's property 'Scenario Id for Pin'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Scenario Id for Pin. id of a scenario which should be assigned to the pin'

    • index: number

      The index of the item whose property 'Scenario Id for Pin' should be set

    Returns void

setPinChartAssignmentShowLabelsByDescription

  • setPinChartAssignmentShowLabelsByDescription(newValue: boolean, description: string): void

  • Accesses the item of the widget's array property 'Pin Chart Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Labels'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Labels. if activated, data values are displayed for the pins'

    • description: string

      The description of the item whose property 'Labels' should be set

    Returns void

setPinChartAssignmentShowLabelsByIndex

  • setPinChartAssignmentShowLabelsByIndex(newValue: boolean, index: number): void

  • Accesses the item of the widget's array property 'Pin Chart Assignment' at the passed index and assigns the passed new value to it's property 'Labels'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Labels. if activated, data values are displayed for the pins'

    • index: number

      The index of the item whose property 'Labels' should be set

    Returns void

setPinChartAssignmentUseOutlierThresholdByDescription

  • setPinChartAssignmentUseOutlierThresholdByDescription(newValue: boolean, description: string): void

  • Accesses the item of the widget's array property 'Pin Chart Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Use Outlier Threshold'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Use Outlier Threshold. When activated all values greater than the positive and less than the negative outlier threshold are considered outliers and don't affect scaling'

    • description: string

      The description of the item whose property 'Use Outlier Threshold' should be set

    Returns void

setPinChartAssignmentUseOutlierThresholdByIndex

  • setPinChartAssignmentUseOutlierThresholdByIndex(newValue: boolean, index: number): void

  • Accesses the item of the widget's array property 'Pin Chart Assignment' at the passed index and assigns the passed new value to it's property 'Use Outlier Threshold'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Use Outlier Threshold. When activated all values greater than the positive and less than the negative outlier threshold are considered outliers and don't affect scaling'

    • index: number

      The index of the item whose property 'Use Outlier Threshold' should be set

    Returns void

setPinChartAssignmentUseSpecificBadColorByDescription

  • setPinChartAssignmentUseSpecificBadColorByDescription(newValue: boolean, description: string): void

  • Accesses the item of the widget's array property 'Pin Chart Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Use Specific Bad Color'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Use Specific Bad Color. Whether to use the specific Bad Color for a chart configuration or the generic default one'

    • description: string

      The description of the item whose property 'Use Specific Bad Color' should be set

    Returns void

setPinChartAssignmentUseSpecificBadColorByIndex

  • setPinChartAssignmentUseSpecificBadColorByIndex(newValue: boolean, index: number): void

  • Accesses the item of the widget's array property 'Pin Chart Assignment' at the passed index and assigns the passed new value to it's property 'Use Specific Bad Color'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Use Specific Bad Color. Whether to use the specific Bad Color for a chart configuration or the generic default one'

    • index: number

      The index of the item whose property 'Use Specific Bad Color' should be set

    Returns void

setPinChartAssignmentUseSpecificGoodColorByDescription

  • setPinChartAssignmentUseSpecificGoodColorByDescription(newValue: boolean, description: string): void

  • Accesses the item of the widget's array property 'Pin Chart Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Use Specific Good Color'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Use Specific Good Color. Whether to use the specific Good Color for a chart configuration or the generic default one'

    • description: string

      The description of the item whose property 'Use Specific Good Color' should be set

    Returns void

setPinChartAssignmentUseSpecificGoodColorByIndex

  • setPinChartAssignmentUseSpecificGoodColorByIndex(newValue: boolean, index: number): void

  • Accesses the item of the widget's array property 'Pin Chart Assignment' at the passed index and assigns the passed new value to it's property 'Use Specific Good Color'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Use Specific Good Color. Whether to use the specific Good Color for a chart configuration or the generic default one'

    • index: number

      The index of the item whose property 'Use Specific Good Color' should be set

    Returns void

removeDimensionConfigs Methods

getRemoveDimensionConfigs

  • getRemoveDimensionConfigs(): unknown[]

  • Accesses the items of the widget's array property 'Remove Dimensions' and returns its value.'

    Returns unknown[]

getRemoveDimensionConfigsEnabledByIndex

  • getRemoveDimensionConfigsEnabledByIndex(index: number): boolean

  • Accesses the item of the widget's array property 'Remove Dimensions' at the passed index and returns the value of it's property 'Enabled. The name of the new calculated member'

    Parameters

    • index: number

      The index of the item whose property 'Enabled' should be returned

    Returns boolean

getRemoveDimensionConfigsJsonString

  • getRemoveDimensionConfigsJsonString(): string

  • Returns the value of the property 'Remove Dimension Configs' as a JSON-String.

    Returns string

getRemoveDimensionConfigsTargetDimensionByIndex

  • getRemoveDimensionConfigsTargetDimensionByIndex(index: number): string

  • Accesses the item of the widget's array property 'Remove Dimensions' at the passed index and returns the value of it's property 'Dimension. The Dimension that should be removed'

    Parameters

    • index: number

      The index of the item whose property 'Dimension' should be returned

    Returns string

setRemoveDimensionConfigs

  • setRemoveDimensionConfigs(newValue: unknown[]): void

  • Sets the items of the widget's array property 'Remove Dimensions'. This Method overrides the previously existing items.

    Parameters

    • newValue: unknown[]

      The new items assigned to the property 'Remove Dimensions'

    Returns void

setRemoveDimensionConfigsEnabledByIndex

  • setRemoveDimensionConfigsEnabledByIndex(newValue: boolean, index: number): void

  • Accesses the item of the widget's array property 'Remove Dimensions' at the passed index and assigns the passed new value to it's property 'Enabled'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Enabled. The name of the new calculated member'

    • index: number

      The index of the item whose property 'Enabled' should be set

    Returns void

setRemoveDimensionConfigsJsonString

  • setRemoveDimensionConfigsJsonString(newRemoveDimensionConfigs: string): void

  • Sets the value of the property 'Remove Dimension Configs' as a JSON-String.

    Parameters

    • newRemoveDimensionConfigs: string

      Remove Dimension Configs

    Returns void

setRemoveDimensionConfigsTargetDimensionByIndex

  • setRemoveDimensionConfigsTargetDimensionByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Remove Dimensions' at the passed index and assigns the passed new value to it's property 'Dimension'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Dimension. The Dimension that should be removed'

    • index: number

      The index of the item whose property 'Dimension' should be set

    Returns void

rowDividerColor Methods

getRowDividerColor

  • getRowDividerColor(): string

  • Returns the value of the property 'Row Divider Color' .

    Returns string

setRowDividerColor

  • setRowDividerColor(newRowDividerColor: string): void

  • Sets the value of the property 'Row Divider Color' . Only hexadecimal color codes are allowed. E.g. '#FF0000'

    Parameters

    • newRowDividerColor: string

      Row Divider Color

    Returns void

rowDividerThickness Methods

getRowDividerThickness

  • getRowDividerThickness(): string

  • Returns the value of the property 'Row Divider Thickness' .

    Returns string

setRowDividerThickness

  • setRowDividerThickness(newRowDividerThickness: string): void

  • Sets the value of the property 'Row Divider Thickness' . Only valid css strings (value + unit[px,rem,em,%]) are allowed. E.g. '10px' or '0.5em'

    Parameters

    • newRowDividerThickness: string

      Row Divider Thickness

    Returns void

rowDividers Methods

getRowDividers

  • getRowDividers(): boolean

  • Returns the value of the property 'Row Dividers' .

    Returns boolean

setRowDividers

  • setRowDividers(newRowDividers: boolean): void

  • Sets the value of the property 'Row Dividers' .

    Parameters

    • newRowDividers: boolean

      Row Dividers

    Returns void

scenarioAssignment Methods

getScenarioAssignmentAddressSubsetByDescription

  • getScenarioAssignmentAddressSubsetByDescription(description: string): SelectionContext

  • Accesses the item of the widget's array property 'scenarioAssignment' whose description equals the passed one and returns the value of it's property 'Filter. Restricts this configuration to only affect data points matching all constraints'

    Parameters

    • description: string

      The description of the item whose property 'Filter' should be returned

    Returns SelectionContext

getScenarioAssignmentAddressSubsetByIndex

  • getScenarioAssignmentAddressSubsetByIndex(index: number): SelectionContext

  • Accesses the item of the widget's array property 'scenarioAssignment' at the passed index and returns the value of it's property 'Filter. Restricts this configuration to only affect data points matching all constraints'

    Parameters

    • index: number

      The index of the item whose property 'Filter' should be returned

    Returns SelectionContext

getScenarioAssignmentDescriptionByIndex

  • getScenarioAssignmentDescriptionByIndex(index: number): string

  • Accesses the item of the widget's array property 'scenarioAssignment' at the passed index and returns the value of it's property 'Description (optional). Short name that describes this configuration to be recognizable'

    Parameters

    • index: number

      The index of the item whose property 'Description (optional)' should be returned

    Returns string

getScenarioAssignmentEnabledByDescription

  • getScenarioAssignmentEnabledByDescription(description: string): boolean

  • Accesses the item of the widget's array property 'scenarioAssignment' whose description equals the passed one and returns the value of it's property 'Enable. If this is deactivated, the config shall have no effect'

    Parameters

    • description: string

      The description of the item whose property 'Enable' should be returned

    Returns boolean

getScenarioAssignmentEnabledByIndex

  • getScenarioAssignmentEnabledByIndex(index: number): boolean

  • Accesses the item of the widget's array property 'scenarioAssignment' at the passed index and returns the value of it's property 'Enable. If this is deactivated, the config shall have no effect'

    Parameters

    • index: number

      The index of the item whose property 'Enable' should be returned

    Returns boolean

getScenarioAssignmentJsonString

  • getScenarioAssignmentJsonString(): string

  • Returns the value of the property 'Scenario Assignment' as a JSON-String.

    Returns string

getScenarioAssignmentScenarioIdByDescription

  • getScenarioAssignmentScenarioIdByDescription(description: string): string

  • Accesses the item of the widget's array property 'scenarioAssignment' whose description equals the passed one and returns the value of it's property 'Scenario Id. identifier of the scenario that gets assigned to the data points selected by the filter'

    Parameters

    • description: string

      The description of the item whose property 'Scenario Id' should be returned

    Returns string

getScenarioAssignmentScenarioIdByIndex

  • getScenarioAssignmentScenarioIdByIndex(index: number): string

  • Accesses the item of the widget's array property 'scenarioAssignment' at the passed index and returns the value of it's property 'Scenario Id. identifier of the scenario that gets assigned to the data points selected by the filter'

    Parameters

    • index: number

      The index of the item whose property 'Scenario Id' should be returned

    Returns string

setScenarioAssignmentAddressSubsetByDescription

  • setScenarioAssignmentAddressSubsetByDescription(newValue: SelectionContext, description: string): void

  • Accesses the item of the widget's array property 'scenarioAssignment' whose description equals the passed one and assigns the passed new value to it's property 'Filter'

    Parameters

    • newValue: SelectionContext

      The new value to be assigned to the property 'Filter. Restricts this configuration to only affect data points matching all constraints'

    • description: string

      The description of the item whose property 'Filter' should be set

    Returns void

setScenarioAssignmentAddressSubsetByIndex

  • setScenarioAssignmentAddressSubsetByIndex(newValue: SelectionContext, index: number): void

  • Accesses the item of the widget's array property 'scenarioAssignment' at the passed index and assigns the passed new value to it's property 'Filter'

    Parameters

    • newValue: SelectionContext

      The new value to be assigned to the property 'Filter. Restricts this configuration to only affect data points matching all constraints'

    • index: number

      The index of the item whose property 'Filter' should be set

    Returns void

setScenarioAssignmentDescriptionByDescription

  • setScenarioAssignmentDescriptionByDescription(newValue: string, description: string): void

  • Accesses the item of the widget's array property 'scenarioAssignment' whose description equals the passed one and assigns the passed new value to it's property 'Description (optional)'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Description (optional). Short name that describes this configuration to be recognizable'

    • description: string

      The description of the item whose property 'Description (optional)' should be set

    Returns void

setScenarioAssignmentDescriptionByIndex

  • setScenarioAssignmentDescriptionByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'scenarioAssignment' at the passed index and assigns the passed new value to it's property 'Description (optional)'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Description (optional). Short name that describes this configuration to be recognizable'

    • index: number

      The index of the item whose property 'Description (optional)' should be set

    Returns void

setScenarioAssignmentEnabledByDescription

  • setScenarioAssignmentEnabledByDescription(newValue: boolean, description: string): void

  • Accesses the item of the widget's array property 'scenarioAssignment' whose description equals the passed one and assigns the passed new value to it's property 'Enable'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Enable. If this is deactivated, the config shall have no effect'

    • description: string

      The description of the item whose property 'Enable' should be set

    Returns void

setScenarioAssignmentEnabledByIndex

  • setScenarioAssignmentEnabledByIndex(newValue: boolean, index: number): void

  • Accesses the item of the widget's array property 'scenarioAssignment' at the passed index and assigns the passed new value to it's property 'Enable'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Enable. If this is deactivated, the config shall have no effect'

    • index: number

      The index of the item whose property 'Enable' should be set

    Returns void

setScenarioAssignmentJsonString

  • setScenarioAssignmentJsonString(newScenarioAssignment: string): void

  • Sets the value of the property 'Scenario Assignment' as a JSON-String.

    Parameters

    • newScenarioAssignment: string

      Scenario Assignment

    Returns void

setScenarioAssignmentScenarioIdByDescription

  • setScenarioAssignmentScenarioIdByDescription(newValue: string, description: string): void

  • Accesses the item of the widget's array property 'scenarioAssignment' whose description equals the passed one and assigns the passed new value to it's property 'Scenario Id'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Scenario Id. identifier of the scenario that gets assigned to the data points selected by the filter'

    • description: string

      The description of the item whose property 'Scenario Id' should be set

    Returns void

setScenarioAssignmentScenarioIdByIndex

  • setScenarioAssignmentScenarioIdByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'scenarioAssignment' at the passed index and assigns the passed new value to it's property 'Scenario Id'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Scenario Id. identifier of the scenario that gets assigned to the data points selected by the filter'

    • index: number

      The index of the item whose property 'Scenario Id' should be set

    Returns void

selectionType Methods

getSelectionType

  • getSelectionType(): string

  • Returns the value of the property 'Selection Type' .

    Returns string

setSelectionType

  • setSelectionType(newSelectionType: string): void

  • Sets the value of the property 'Selection Type' .

    Parameters

    • newSelectionType: string

      Selection Type

    Returns void

serverUrl Methods

getServerUrl

  • getServerUrl(): string

  • Returns the value of the property 'Server Url' .

    Returns string

setServerUrl

  • setServerUrl(newServerUrl: string): void

  • Sets the value of the property 'Server Url' .

    Parameters

    • newServerUrl: string

      Server Url

    Returns void

showFooter Methods

getShowFooter

  • getShowFooter(): boolean

  • Returns the value of the property 'Show Footer' .

    Returns boolean

setShowFooter

  • setShowFooter(newShowFooter: boolean): void

  • Sets the value of the property 'Show Footer' .

    Parameters

    • newShowFooter: boolean

      Show Footer

    Returns void

showScenariosInColumnHeaders Methods

getShowScenariosInColumnHeaders

  • getShowScenariosInColumnHeaders(): boolean

  • Returns the value of the property 'Show Scenarios In Column Headers' .

    Returns boolean

setShowScenariosInColumnHeaders

  • setShowScenariosInColumnHeaders(newShowScenariosInColumnHeaders: boolean): void

  • Sets the value of the property 'Show Scenarios In Column Headers' .

    Parameters

    • newShowScenariosInColumnHeaders: boolean

      Show Scenarios In Column Headers

    Returns void

showTitle Methods

getShowTitle

  • getShowTitle(): boolean

  • Returns the value of the property 'Show Title' .

    Returns boolean

setShowTitle

  • setShowTitle(newShowTitle: boolean): void

  • Sets the value of the property 'Show Title' .

    Parameters

    • newShowTitle: boolean

      Show Title

    Returns void

sortByMember Methods

getSortByMember

  • getSortByMember(): unknown[]

  • Accesses the items of the widget's array property 'Sort Configurations' and returns its value.'

    Returns unknown[]

getSortByMemberDescriptionByIndex

  • getSortByMemberDescriptionByIndex(index: number): string

  • Accesses the item of the widget's array property 'Sort Configurations' at the passed index and returns the value of it's property 'Description (optional). Short name that describes this configuration to be recognizable'

    Parameters

    • index: number

      The index of the item whose property 'Description (optional)' should be returned

    Returns string

getSortByMemberDimensionKeyByDescription

  • getSortByMemberDimensionKeyByDescription(description: string): string

  • Accesses the item of the widget's array property 'Sort Configurations' whose description equals the passed one and returns the value of it's property 'Dimension. The key of the Dimension that should be sorted'

    Parameters

    • description: string

      The description of the item whose property 'Dimension' should be returned

    Returns string

getSortByMemberDimensionKeyByIndex

  • getSortByMemberDimensionKeyByIndex(index: number): string

  • Accesses the item of the widget's array property 'Sort Configurations' at the passed index and returns the value of it's property 'Dimension. The key of the Dimension that should be sorted'

    Parameters

    • index: number

      The index of the item whose property 'Dimension' should be returned

    Returns string

getSortByMemberEnabledByDescription

  • getSortByMemberEnabledByDescription(description: string): boolean

  • Accesses the item of the widget's array property 'Sort Configurations' whose description equals the passed one and returns the value of it's property 'Enable. If this is deactivated, the config shall have no efect'

    Parameters

    • description: string

      The description of the item whose property 'Enable' should be returned

    Returns boolean

getSortByMemberEnabledByIndex

  • getSortByMemberEnabledByIndex(index: number): boolean

  • Accesses the item of the widget's array property 'Sort Configurations' at the passed index and returns the value of it's property 'Enable. If this is deactivated, the config shall have no efect'

    Parameters

    • index: number

      The index of the item whose property 'Enable' should be returned

    Returns boolean

getSortByMemberJsonString

  • getSortByMemberJsonString(): string

  • Returns the value of the property 'Sort By Member' as a JSON-String.

    Returns string

setSortByMember

  • setSortByMember(newValue: unknown[]): void

  • Sets the items of the widget's array property 'Sort Configurations'. This Method overrides the previously existing items.

    Parameters

    • newValue: unknown[]

      The new items assigned to the property 'Sort Configurations'

    Returns void

setSortByMemberDescriptionByDescription

  • setSortByMemberDescriptionByDescription(newValue: string, description: string): void

  • Accesses the item of the widget's array property 'Sort Configurations' whose description equals the passed one and assigns the passed new value to it's property 'Description (optional)'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Description (optional). Short name that describes this configuration to be recognizable'

    • description: string

      The description of the item whose property 'Description (optional)' should be set

    Returns void

setSortByMemberDescriptionByIndex

  • setSortByMemberDescriptionByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Sort Configurations' at the passed index and assigns the passed new value to it's property 'Description (optional)'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Description (optional). Short name that describes this configuration to be recognizable'

    • index: number

      The index of the item whose property 'Description (optional)' should be set

    Returns void

setSortByMemberDimensionKeyByDescription

  • setSortByMemberDimensionKeyByDescription(newValue: string, description: string): void

  • Accesses the item of the widget's array property 'Sort Configurations' whose description equals the passed one and assigns the passed new value to it's property 'Dimension'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Dimension. The key of the Dimension that should be sorted'

    • description: string

      The description of the item whose property 'Dimension' should be set

    Returns void

setSortByMemberDimensionKeyByIndex

  • setSortByMemberDimensionKeyByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Sort Configurations' at the passed index and assigns the passed new value to it's property 'Dimension'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Dimension. The key of the Dimension that should be sorted'

    • index: number

      The index of the item whose property 'Dimension' should be set

    Returns void

setSortByMemberEnabledByDescription

  • setSortByMemberEnabledByDescription(newValue: boolean, description: string): void

  • Accesses the item of the widget's array property 'Sort Configurations' whose description equals the passed one and assigns the passed new value to it's property 'Enable'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Enable. If this is deactivated, the config shall have no efect'

    • description: string

      The description of the item whose property 'Enable' should be set

    Returns void

setSortByMemberEnabledByIndex

  • setSortByMemberEnabledByIndex(newValue: boolean, index: number): void

  • Accesses the item of the widget's array property 'Sort Configurations' at the passed index and assigns the passed new value to it's property 'Enable'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Enable. If this is deactivated, the config shall have no efect'

    • index: number

      The index of the item whose property 'Enable' should be set

    Returns void

setSortByMemberJsonString

  • setSortByMemberJsonString(newSortByMember: string): void

  • Sets the value of the property 'Sort By Member' as a JSON-String.

    Parameters

    • newSortByMember: string

      Sort By Member

    Returns void

sparkbarAssignment Methods

getSparkbarAssignmentAddressSubsetByDescription

  • getSparkbarAssignmentAddressSubsetByDescription(description: string): SelectionContext

  • Accesses the item of the widget's array property 'Sparkbar Assignment' whose description equals the passed one and returns the value of it's property 'Filter. Restricts this configuration to only affect data points matching all constraints'

    Parameters

    • description: string

      The description of the item whose property 'Filter' should be returned

    Returns SelectionContext

getSparkbarAssignmentAddressSubsetByIndex

  • getSparkbarAssignmentAddressSubsetByIndex(index: number): SelectionContext

  • Accesses the item of the widget's array property 'Sparkbar Assignment' at the passed index and returns the value of it's property 'Filter. Restricts this configuration to only affect data points matching all constraints'

    Parameters

    • index: number

      The index of the item whose property 'Filter' should be returned

    Returns SelectionContext

getSparkbarAssignmentBadColorByDescription

  • getSparkbarAssignmentBadColorByDescription(description: string): string

  • Accesses the item of the widget's array property 'Sparkbar Assignment' whose description equals the passed one and returns the value of it's property 'Bad Color. The color used for visualization elements with a negative implication.'

    Parameters

    • description: string

      The description of the item whose property 'Bad Color' should be returned

    Returns string

getSparkbarAssignmentBadColorByIndex

  • getSparkbarAssignmentBadColorByIndex(index: number): string

  • Accesses the item of the widget's array property 'Sparkbar Assignment' at the passed index and returns the value of it's property 'Bad Color. The color used for visualization elements with a negative implication.'

    Parameters

    • index: number

      The index of the item whose property 'Bad Color' should be returned

    Returns string

getSparkbarAssignmentChartHeightByDescription

  • getSparkbarAssignmentChartHeightByDescription(description: string): number

  • Accesses the item of the widget's array property 'Sparkbar Assignment' whose description equals the passed one and returns the value of it's property 'Chart Height. height of the chart in [px]'

    Parameters

    • description: string

      The description of the item whose property 'Chart Height' should be returned

    Returns number

getSparkbarAssignmentChartHeightByIndex

  • getSparkbarAssignmentChartHeightByIndex(index: number): number

  • Accesses the item of the widget's array property 'Sparkbar Assignment' at the passed index and returns the value of it's property 'Chart Height. height of the chart in [px]'

    Parameters

    • index: number

      The index of the item whose property 'Chart Height' should be returned

    Returns number

getSparkbarAssignmentDescriptionByIndex

  • getSparkbarAssignmentDescriptionByIndex(index: number): string

  • Accesses the item of the widget's array property 'Sparkbar Assignment' at the passed index and returns the value of it's property 'Description (optional). Short name that describes this configuration to be recognizable'

    Parameters

    • index: number

      The index of the item whose property 'Description (optional)' should be returned

    Returns string

getSparkbarAssignmentEnabledByDescription

  • getSparkbarAssignmentEnabledByDescription(description: string): boolean

  • Accesses the item of the widget's array property 'Sparkbar Assignment' whose description equals the passed one and returns the value of it's property 'Enable. If this is deactivated, the config shall have no effect'

    Parameters

    • description: string

      The description of the item whose property 'Enable' should be returned

    Returns boolean

getSparkbarAssignmentEnabledByIndex

  • getSparkbarAssignmentEnabledByIndex(index: number): boolean

  • Accesses the item of the widget's array property 'Sparkbar Assignment' at the passed index and returns the value of it's property 'Enable. If this is deactivated, the config shall have no effect'

    Parameters

    • index: number

      The index of the item whose property 'Enable' should be returned

    Returns boolean

getSparkbarAssignmentGoodColorByDescription

  • getSparkbarAssignmentGoodColorByDescription(description: string): string

  • Accesses the item of the widget's array property 'Sparkbar Assignment' whose description equals the passed one and returns the value of it's property 'Good Color. The color used for visualization elements with a positive implication.'

    Parameters

    • description: string

      The description of the item whose property 'Good Color' should be returned

    Returns string

getSparkbarAssignmentGoodColorByIndex

  • getSparkbarAssignmentGoodColorByIndex(index: number): string

  • Accesses the item of the widget's array property 'Sparkbar Assignment' at the passed index and returns the value of it's property 'Good Color. The color used for visualization elements with a positive implication.'

    Parameters

    • index: number

      The index of the item whose property 'Good Color' should be returned

    Returns string

getSparkbarAssignmentInToolTipByDescription

  • getSparkbarAssignmentInToolTipByDescription(description: string): boolean

  • Accesses the item of the widget's array property 'Sparkbar Assignment' whose description equals the passed one and returns the value of it's property 'Show In Tooltip. When activated, the visualisation is shown in a tooltip, instead of hte cell itself'

    Parameters

    • description: string

      The description of the item whose property 'Show In Tooltip' should be returned

    Returns boolean

getSparkbarAssignmentInToolTipByIndex

  • getSparkbarAssignmentInToolTipByIndex(index: number): boolean

  • Accesses the item of the widget's array property 'Sparkbar Assignment' at the passed index and returns the value of it's property 'Show In Tooltip. When activated, the visualisation is shown in a tooltip, instead of hte cell itself'

    Parameters

    • index: number

      The index of the item whose property 'Show In Tooltip' should be returned

    Returns boolean

getSparkbarAssignmentIncludeAggregatesByDescription

  • getSparkbarAssignmentIncludeAggregatesByDescription(description: string): boolean

  • Accesses the item of the widget's array property 'Sparkbar Assignment' whose description equals the passed one and returns the value of it's property 'Include Aggregates. When activated, aggregation data points like sums are part of the showed data. This option is turned off by default to prevent aggregate peaks from distorting the scaling'

    Parameters

    • description: string

      The description of the item whose property 'Include Aggregates' should be returned

    Returns boolean

getSparkbarAssignmentIncludeAggregatesByIndex

  • getSparkbarAssignmentIncludeAggregatesByIndex(index: number): boolean

  • Accesses the item of the widget's array property 'Sparkbar Assignment' at the passed index and returns the value of it's property 'Include Aggregates. When activated, aggregation data points like sums are part of the showed data. This option is turned off by default to prevent aggregate peaks from distorting the scaling'

    Parameters

    • index: number

      The index of the item whose property 'Include Aggregates' should be returned

    Returns boolean

getSparkbarAssignmentJsonString

  • getSparkbarAssignmentJsonString(): string

  • Returns the value of the property 'Sparkbar Assignment' as a JSON-String.

    Returns string

getSparkbarAssignmentMaxColorByDescription

  • getSparkbarAssignmentMaxColorByDescription(description: string): string

  • Accesses the item of the widget's array property 'Sparkbar Assignment' whose description equals the passed one and returns the value of it's property 'Maximum Color. The color used for highlighting the largest value.'

    Parameters

    • description: string

      The description of the item whose property 'Maximum Color' should be returned

    Returns string

getSparkbarAssignmentMaxColorByIndex

  • getSparkbarAssignmentMaxColorByIndex(index: number): string

  • Accesses the item of the widget's array property 'Sparkbar Assignment' at the passed index and returns the value of it's property 'Maximum Color. The color used for highlighting the largest value.'

    Parameters

    • index: number

      The index of the item whose property 'Maximum Color' should be returned

    Returns string

getSparkbarAssignmentMinColorByDescription

  • getSparkbarAssignmentMinColorByDescription(description: string): string

  • Accesses the item of the widget's array property 'Sparkbar Assignment' whose description equals the passed one and returns the value of it's property 'Minimum Color. The color used for highlighting the smallest value.'

    Parameters

    • description: string

      The description of the item whose property 'Minimum Color' should be returned

    Returns string

getSparkbarAssignmentMinColorByIndex

  • getSparkbarAssignmentMinColorByIndex(index: number): string

  • Accesses the item of the widget's array property 'Sparkbar Assignment' at the passed index and returns the value of it's property 'Minimum Color. The color used for highlighting the smallest value.'

    Parameters

    • index: number

      The index of the item whose property 'Minimum Color' should be returned

    Returns string

getSparkbarAssignmentTargetAxisByDescription

  • getSparkbarAssignmentTargetAxisByDescription(description: string): string

  • Accesses the item of the widget's array property 'Sparkbar Assignment' whose description equals the passed one and returns the value of it's property 'Target Axis. The axis which contains the data to be used for this feature. Additional Axes can be created at the data tab.'

    Parameters

    • description: string

      The description of the item whose property 'Target Axis' should be returned

    Returns string

getSparkbarAssignmentTargetAxisByIndex

  • getSparkbarAssignmentTargetAxisByIndex(index: number): string

  • Accesses the item of the widget's array property 'Sparkbar Assignment' at the passed index and returns the value of it's property 'Target Axis. The axis which contains the data to be used for this feature. Additional Axes can be created at the data tab.'

    Parameters

    • index: number

      The index of the item whose property 'Target Axis' should be returned

    Returns string

setSparkbarAssignmentAddressSubsetByDescription

  • setSparkbarAssignmentAddressSubsetByDescription(newValue: SelectionContext, description: string): void

  • Accesses the item of the widget's array property 'Sparkbar Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Filter'

    Parameters

    • newValue: SelectionContext

      The new value to be assigned to the property 'Filter. Restricts this configuration to only affect data points matching all constraints'

    • description: string

      The description of the item whose property 'Filter' should be set

    Returns void

setSparkbarAssignmentAddressSubsetByIndex

  • setSparkbarAssignmentAddressSubsetByIndex(newValue: SelectionContext, index: number): void

  • Accesses the item of the widget's array property 'Sparkbar Assignment' at the passed index and assigns the passed new value to it's property 'Filter'

    Parameters

    • newValue: SelectionContext

      The new value to be assigned to the property 'Filter. Restricts this configuration to only affect data points matching all constraints'

    • index: number

      The index of the item whose property 'Filter' should be set

    Returns void

setSparkbarAssignmentBadColorByDescription

  • setSparkbarAssignmentBadColorByDescription(newValue: string, description: string): void

  • Accesses the item of the widget's array property 'Sparkbar Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Bad Color'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Bad Color. The color used for visualization elements with a negative implication.'

    • description: string

      The description of the item whose property 'Bad Color' should be set

    Returns void

setSparkbarAssignmentBadColorByIndex

  • setSparkbarAssignmentBadColorByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Sparkbar Assignment' at the passed index and assigns the passed new value to it's property 'Bad Color'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Bad Color. The color used for visualization elements with a negative implication.'

    • index: number

      The index of the item whose property 'Bad Color' should be set

    Returns void

setSparkbarAssignmentChartHeightByDescription

  • setSparkbarAssignmentChartHeightByDescription(newValue: number, description: string): void

  • Accesses the item of the widget's array property 'Sparkbar Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Chart Height'

    Parameters

    • newValue: number

      The new value to be assigned to the property 'Chart Height. height of the chart in [px]'

    • description: string

      The description of the item whose property 'Chart Height' should be set

    Returns void

setSparkbarAssignmentChartHeightByIndex

  • setSparkbarAssignmentChartHeightByIndex(newValue: number, index: number): void

  • Accesses the item of the widget's array property 'Sparkbar Assignment' at the passed index and assigns the passed new value to it's property 'Chart Height'

    Parameters

    • newValue: number

      The new value to be assigned to the property 'Chart Height. height of the chart in [px]'

    • index: number

      The index of the item whose property 'Chart Height' should be set

    Returns void

setSparkbarAssignmentDescriptionByDescription

  • setSparkbarAssignmentDescriptionByDescription(newValue: string, description: string): void

  • Accesses the item of the widget's array property 'Sparkbar Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Description (optional)'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Description (optional). Short name that describes this configuration to be recognizable'

    • description: string

      The description of the item whose property 'Description (optional)' should be set

    Returns void

setSparkbarAssignmentDescriptionByIndex

  • setSparkbarAssignmentDescriptionByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Sparkbar Assignment' at the passed index and assigns the passed new value to it's property 'Description (optional)'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Description (optional). Short name that describes this configuration to be recognizable'

    • index: number

      The index of the item whose property 'Description (optional)' should be set

    Returns void

setSparkbarAssignmentEnabledByDescription

  • setSparkbarAssignmentEnabledByDescription(newValue: boolean, description: string): void

  • Accesses the item of the widget's array property 'Sparkbar Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Enable'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Enable. If this is deactivated, the config shall have no effect'

    • description: string

      The description of the item whose property 'Enable' should be set

    Returns void

setSparkbarAssignmentEnabledByIndex

  • setSparkbarAssignmentEnabledByIndex(newValue: boolean, index: number): void

  • Accesses the item of the widget's array property 'Sparkbar Assignment' at the passed index and assigns the passed new value to it's property 'Enable'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Enable. If this is deactivated, the config shall have no effect'

    • index: number

      The index of the item whose property 'Enable' should be set

    Returns void

setSparkbarAssignmentGoodColorByDescription

  • setSparkbarAssignmentGoodColorByDescription(newValue: string, description: string): void

  • Accesses the item of the widget's array property 'Sparkbar Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Good Color'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Good Color. The color used for visualization elements with a positive implication.'

    • description: string

      The description of the item whose property 'Good Color' should be set

    Returns void

setSparkbarAssignmentGoodColorByIndex

  • setSparkbarAssignmentGoodColorByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Sparkbar Assignment' at the passed index and assigns the passed new value to it's property 'Good Color'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Good Color. The color used for visualization elements with a positive implication.'

    • index: number

      The index of the item whose property 'Good Color' should be set

    Returns void

setSparkbarAssignmentInToolTipByDescription

  • setSparkbarAssignmentInToolTipByDescription(newValue: boolean, description: string): void

  • Accesses the item of the widget's array property 'Sparkbar Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Show In Tooltip'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Show In Tooltip. When activated, the visualisation is shown in a tooltip, instead of hte cell itself'

    • description: string

      The description of the item whose property 'Show In Tooltip' should be set

    Returns void

setSparkbarAssignmentInToolTipByIndex

  • setSparkbarAssignmentInToolTipByIndex(newValue: boolean, index: number): void

  • Accesses the item of the widget's array property 'Sparkbar Assignment' at the passed index and assigns the passed new value to it's property 'Show In Tooltip'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Show In Tooltip. When activated, the visualisation is shown in a tooltip, instead of hte cell itself'

    • index: number

      The index of the item whose property 'Show In Tooltip' should be set

    Returns void

setSparkbarAssignmentIncludeAggregatesByDescription

  • setSparkbarAssignmentIncludeAggregatesByDescription(newValue: boolean, description: string): void

  • Accesses the item of the widget's array property 'Sparkbar Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Include Aggregates'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Include Aggregates. When activated, aggregation data points like sums are part of the showed data. This option is turned off by default to prevent aggregate peaks from distorting the scaling'

    • description: string

      The description of the item whose property 'Include Aggregates' should be set

    Returns void

setSparkbarAssignmentIncludeAggregatesByIndex

  • setSparkbarAssignmentIncludeAggregatesByIndex(newValue: boolean, index: number): void

  • Accesses the item of the widget's array property 'Sparkbar Assignment' at the passed index and assigns the passed new value to it's property 'Include Aggregates'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Include Aggregates. When activated, aggregation data points like sums are part of the showed data. This option is turned off by default to prevent aggregate peaks from distorting the scaling'

    • index: number

      The index of the item whose property 'Include Aggregates' should be set

    Returns void

setSparkbarAssignmentJsonString

  • setSparkbarAssignmentJsonString(newSparkbarAssignment: string): void

  • Sets the value of the property 'Sparkbar Assignment' as a JSON-String.

    Parameters

    • newSparkbarAssignment: string

      Sparkbar Assignment

    Returns void

setSparkbarAssignmentMaxColorByDescription

  • setSparkbarAssignmentMaxColorByDescription(newValue: string, description: string): void

  • Accesses the item of the widget's array property 'Sparkbar Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Maximum Color'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Maximum Color. The color used for highlighting the largest value.'

    • description: string

      The description of the item whose property 'Maximum Color' should be set

    Returns void

setSparkbarAssignmentMaxColorByIndex

  • setSparkbarAssignmentMaxColorByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Sparkbar Assignment' at the passed index and assigns the passed new value to it's property 'Maximum Color'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Maximum Color. The color used for highlighting the largest value.'

    • index: number

      The index of the item whose property 'Maximum Color' should be set

    Returns void

setSparkbarAssignmentMinColorByDescription

  • setSparkbarAssignmentMinColorByDescription(newValue: string, description: string): void

  • Accesses the item of the widget's array property 'Sparkbar Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Minimum Color'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Minimum Color. The color used for highlighting the smallest value.'

    • description: string

      The description of the item whose property 'Minimum Color' should be set

    Returns void

setSparkbarAssignmentMinColorByIndex

  • setSparkbarAssignmentMinColorByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Sparkbar Assignment' at the passed index and assigns the passed new value to it's property 'Minimum Color'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Minimum Color. The color used for highlighting the smallest value.'

    • index: number

      The index of the item whose property 'Minimum Color' should be set

    Returns void

setSparkbarAssignmentTargetAxisByDescription

  • setSparkbarAssignmentTargetAxisByDescription(newValue: string, description: string): void

  • Accesses the item of the widget's array property 'Sparkbar Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Target Axis'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Target Axis. The axis which contains the data to be used for this feature. Additional Axes can be created at the data tab.'

    • description: string

      The description of the item whose property 'Target Axis' should be set

    Returns void

setSparkbarAssignmentTargetAxisByIndex

  • setSparkbarAssignmentTargetAxisByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Sparkbar Assignment' at the passed index and assigns the passed new value to it's property 'Target Axis'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Target Axis. The axis which contains the data to be used for this feature. Additional Axes can be created at the data tab.'

    • index: number

      The index of the item whose property 'Target Axis' should be set

    Returns void

sparklineAssignment Methods

getSparklineAssignmentAddressSubsetByDescription

  • getSparklineAssignmentAddressSubsetByDescription(description: string): SelectionContext

  • Accesses the item of the widget's array property 'Sparkline Assignment' whose description equals the passed one and returns the value of it's property 'Filter. Restricts this configuration to only affect data points matching all constraints'

    Parameters

    • description: string

      The description of the item whose property 'Filter' should be returned

    Returns SelectionContext

getSparklineAssignmentAddressSubsetByIndex

  • getSparklineAssignmentAddressSubsetByIndex(index: number): SelectionContext

  • Accesses the item of the widget's array property 'Sparkline Assignment' at the passed index and returns the value of it's property 'Filter. Restricts this configuration to only affect data points matching all constraints'

    Parameters

    • index: number

      The index of the item whose property 'Filter' should be returned

    Returns SelectionContext

getSparklineAssignmentBadColorByDescription

  • getSparklineAssignmentBadColorByDescription(description: string): string

  • Accesses the item of the widget's array property 'Sparkline Assignment' whose description equals the passed one and returns the value of it's property 'Bad Color. The color used for visualization elements with a negative implication.'

    Parameters

    • description: string

      The description of the item whose property 'Bad Color' should be returned

    Returns string

getSparklineAssignmentBadColorByIndex

  • getSparklineAssignmentBadColorByIndex(index: number): string

  • Accesses the item of the widget's array property 'Sparkline Assignment' at the passed index and returns the value of it's property 'Bad Color. The color used for visualization elements with a negative implication.'

    Parameters

    • index: number

      The index of the item whose property 'Bad Color' should be returned

    Returns string

getSparklineAssignmentChartHeightByDescription

  • getSparklineAssignmentChartHeightByDescription(description: string): number

  • Accesses the item of the widget's array property 'Sparkline Assignment' whose description equals the passed one and returns the value of it's property 'Chart Height. height of the chart in [px]'

    Parameters

    • description: string

      The description of the item whose property 'Chart Height' should be returned

    Returns number

getSparklineAssignmentChartHeightByIndex

  • getSparklineAssignmentChartHeightByIndex(index: number): number

  • Accesses the item of the widget's array property 'Sparkline Assignment' at the passed index and returns the value of it's property 'Chart Height. height of the chart in [px]'

    Parameters

    • index: number

      The index of the item whose property 'Chart Height' should be returned

    Returns number

getSparklineAssignmentCurveTypeByDescription

  • getSparklineAssignmentCurveTypeByDescription(description: string): string

  • Accesses the item of the widget's array property 'Sparkline Assignment' whose description equals the passed one and returns the value of it's property 'Curve Type. Type of interpolation between data points. LINEAR produces straight lines meeting sharply at peaks. SMOOTH produces rounded peaks using a monotone cubic spline.'

    Parameters

    • description: string

      The description of the item whose property 'Curve Type' should be returned

    Returns string

getSparklineAssignmentCurveTypeByIndex

  • getSparklineAssignmentCurveTypeByIndex(index: number): string

  • Accesses the item of the widget's array property 'Sparkline Assignment' at the passed index and returns the value of it's property 'Curve Type. Type of interpolation between data points. LINEAR produces straight lines meeting sharply at peaks. SMOOTH produces rounded peaks using a monotone cubic spline.'

    Parameters

    • index: number

      The index of the item whose property 'Curve Type' should be returned

    Returns string

getSparklineAssignmentDescriptionByIndex

  • getSparklineAssignmentDescriptionByIndex(index: number): string

  • Accesses the item of the widget's array property 'Sparkline Assignment' at the passed index and returns the value of it's property 'Description (optional). Short name that describes this configuration to be recognizable'

    Parameters

    • index: number

      The index of the item whose property 'Description (optional)' should be returned

    Returns string

getSparklineAssignmentEnabledByDescription

  • getSparklineAssignmentEnabledByDescription(description: string): boolean

  • Accesses the item of the widget's array property 'Sparkline Assignment' whose description equals the passed one and returns the value of it's property 'Enable. If this is deactivated, the config shall have no effect'

    Parameters

    • description: string

      The description of the item whose property 'Enable' should be returned

    Returns boolean

getSparklineAssignmentEnabledByIndex

  • getSparklineAssignmentEnabledByIndex(index: number): boolean

  • Accesses the item of the widget's array property 'Sparkline Assignment' at the passed index and returns the value of it's property 'Enable. If this is deactivated, the config shall have no effect'

    Parameters

    • index: number

      The index of the item whose property 'Enable' should be returned

    Returns boolean

getSparklineAssignmentGoodColorByDescription

  • getSparklineAssignmentGoodColorByDescription(description: string): string

  • Accesses the item of the widget's array property 'Sparkline Assignment' whose description equals the passed one and returns the value of it's property 'Good Color. The color used for visualization elements with a positive implication.'

    Parameters

    • description: string

      The description of the item whose property 'Good Color' should be returned

    Returns string

getSparklineAssignmentGoodColorByIndex

  • getSparklineAssignmentGoodColorByIndex(index: number): string

  • Accesses the item of the widget's array property 'Sparkline Assignment' at the passed index and returns the value of it's property 'Good Color. The color used for visualization elements with a positive implication.'

    Parameters

    • index: number

      The index of the item whose property 'Good Color' should be returned

    Returns string

getSparklineAssignmentInToolTipByDescription

  • getSparklineAssignmentInToolTipByDescription(description: string): boolean

  • Accesses the item of the widget's array property 'Sparkline Assignment' whose description equals the passed one and returns the value of it's property 'Show In Tooltip. When activated, the visualisation is shown in a tooltip, instead of hte cell itself'

    Parameters

    • description: string

      The description of the item whose property 'Show In Tooltip' should be returned

    Returns boolean

getSparklineAssignmentInToolTipByIndex

  • getSparklineAssignmentInToolTipByIndex(index: number): boolean

  • Accesses the item of the widget's array property 'Sparkline Assignment' at the passed index and returns the value of it's property 'Show In Tooltip. When activated, the visualisation is shown in a tooltip, instead of hte cell itself'

    Parameters

    • index: number

      The index of the item whose property 'Show In Tooltip' should be returned

    Returns boolean

getSparklineAssignmentIncludeAggregatesByDescription

  • getSparklineAssignmentIncludeAggregatesByDescription(description: string): boolean

  • Accesses the item of the widget's array property 'Sparkline Assignment' whose description equals the passed one and returns the value of it's property 'Include Aggregates. When activated, aggregation data points like sums are part of the showed data. This option is turned off by default to prevent aggregate peaks from distorting the scaling'

    Parameters

    • description: string

      The description of the item whose property 'Include Aggregates' should be returned

    Returns boolean

getSparklineAssignmentIncludeAggregatesByIndex

  • getSparklineAssignmentIncludeAggregatesByIndex(index: number): boolean

  • Accesses the item of the widget's array property 'Sparkline Assignment' at the passed index and returns the value of it's property 'Include Aggregates. When activated, aggregation data points like sums are part of the showed data. This option is turned off by default to prevent aggregate peaks from distorting the scaling'

    Parameters

    • index: number

      The index of the item whose property 'Include Aggregates' should be returned

    Returns boolean

getSparklineAssignmentJsonString

  • getSparklineAssignmentJsonString(): string

  • Returns the value of the property 'Sparkline Assignment' as a JSON-String.

    Returns string

getSparklineAssignmentMaxColorByDescription

  • getSparklineAssignmentMaxColorByDescription(description: string): string

  • Accesses the item of the widget's array property 'Sparkline Assignment' whose description equals the passed one and returns the value of it's property 'Maximum Color. The color used for highlighting the largest value.'

    Parameters

    • description: string

      The description of the item whose property 'Maximum Color' should be returned

    Returns string

getSparklineAssignmentMaxColorByIndex

  • getSparklineAssignmentMaxColorByIndex(index: number): string

  • Accesses the item of the widget's array property 'Sparkline Assignment' at the passed index and returns the value of it's property 'Maximum Color. The color used for highlighting the largest value.'

    Parameters

    • index: number

      The index of the item whose property 'Maximum Color' should be returned

    Returns string

getSparklineAssignmentMinColorByDescription

  • getSparklineAssignmentMinColorByDescription(description: string): string

  • Accesses the item of the widget's array property 'Sparkline Assignment' whose description equals the passed one and returns the value of it's property 'Minimum Color. The color used for highlighting the smallest value.'

    Parameters

    • description: string

      The description of the item whose property 'Minimum Color' should be returned

    Returns string

getSparklineAssignmentMinColorByIndex

  • getSparklineAssignmentMinColorByIndex(index: number): string

  • Accesses the item of the widget's array property 'Sparkline Assignment' at the passed index and returns the value of it's property 'Minimum Color. The color used for highlighting the smallest value.'

    Parameters

    • index: number

      The index of the item whose property 'Minimum Color' should be returned

    Returns string

getSparklineAssignmentTargetAxisByDescription

  • getSparklineAssignmentTargetAxisByDescription(description: string): string

  • Accesses the item of the widget's array property 'Sparkline Assignment' whose description equals the passed one and returns the value of it's property 'Target Axis. The axis which contains the data to be used for this feature. Additional Axes can be created at the data tab.'

    Parameters

    • description: string

      The description of the item whose property 'Target Axis' should be returned

    Returns string

getSparklineAssignmentTargetAxisByIndex

  • getSparklineAssignmentTargetAxisByIndex(index: number): string

  • Accesses the item of the widget's array property 'Sparkline Assignment' at the passed index and returns the value of it's property 'Target Axis. The axis which contains the data to be used for this feature. Additional Axes can be created at the data tab.'

    Parameters

    • index: number

      The index of the item whose property 'Target Axis' should be returned

    Returns string

setSparklineAssignmentAddressSubsetByDescription

  • setSparklineAssignmentAddressSubsetByDescription(newValue: SelectionContext, description: string): void

  • Accesses the item of the widget's array property 'Sparkline Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Filter'

    Parameters

    • newValue: SelectionContext

      The new value to be assigned to the property 'Filter. Restricts this configuration to only affect data points matching all constraints'

    • description: string

      The description of the item whose property 'Filter' should be set

    Returns void

setSparklineAssignmentAddressSubsetByIndex

  • setSparklineAssignmentAddressSubsetByIndex(newValue: SelectionContext, index: number): void

  • Accesses the item of the widget's array property 'Sparkline Assignment' at the passed index and assigns the passed new value to it's property 'Filter'

    Parameters

    • newValue: SelectionContext

      The new value to be assigned to the property 'Filter. Restricts this configuration to only affect data points matching all constraints'

    • index: number

      The index of the item whose property 'Filter' should be set

    Returns void

setSparklineAssignmentBadColorByDescription

  • setSparklineAssignmentBadColorByDescription(newValue: string, description: string): void

  • Accesses the item of the widget's array property 'Sparkline Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Bad Color'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Bad Color. The color used for visualization elements with a negative implication.'

    • description: string

      The description of the item whose property 'Bad Color' should be set

    Returns void

setSparklineAssignmentBadColorByIndex

  • setSparklineAssignmentBadColorByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Sparkline Assignment' at the passed index and assigns the passed new value to it's property 'Bad Color'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Bad Color. The color used for visualization elements with a negative implication.'

    • index: number

      The index of the item whose property 'Bad Color' should be set

    Returns void

setSparklineAssignmentChartHeightByDescription

  • setSparklineAssignmentChartHeightByDescription(newValue: number, description: string): void

  • Accesses the item of the widget's array property 'Sparkline Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Chart Height'

    Parameters

    • newValue: number

      The new value to be assigned to the property 'Chart Height. height of the chart in [px]'

    • description: string

      The description of the item whose property 'Chart Height' should be set

    Returns void

setSparklineAssignmentChartHeightByIndex

  • setSparklineAssignmentChartHeightByIndex(newValue: number, index: number): void

  • Accesses the item of the widget's array property 'Sparkline Assignment' at the passed index and assigns the passed new value to it's property 'Chart Height'

    Parameters

    • newValue: number

      The new value to be assigned to the property 'Chart Height. height of the chart in [px]'

    • index: number

      The index of the item whose property 'Chart Height' should be set

    Returns void

setSparklineAssignmentCurveTypeByDescription

  • setSparklineAssignmentCurveTypeByDescription(newValue: string, description: string): void

  • Accesses the item of the widget's array property 'Sparkline Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Curve Type'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Curve Type. Type of interpolation between data points. LINEAR produces straight lines meeting sharply at peaks. SMOOTH produces rounded peaks using a monotone cubic spline.'

    • description: string

      The description of the item whose property 'Curve Type' should be set

    Returns void

setSparklineAssignmentCurveTypeByIndex

  • setSparklineAssignmentCurveTypeByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Sparkline Assignment' at the passed index and assigns the passed new value to it's property 'Curve Type'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Curve Type. Type of interpolation between data points. LINEAR produces straight lines meeting sharply at peaks. SMOOTH produces rounded peaks using a monotone cubic spline.'

    • index: number

      The index of the item whose property 'Curve Type' should be set

    Returns void

setSparklineAssignmentDescriptionByDescription

  • setSparklineAssignmentDescriptionByDescription(newValue: string, description: string): void

  • Accesses the item of the widget's array property 'Sparkline Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Description (optional)'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Description (optional). Short name that describes this configuration to be recognizable'

    • description: string

      The description of the item whose property 'Description (optional)' should be set

    Returns void

setSparklineAssignmentDescriptionByIndex

  • setSparklineAssignmentDescriptionByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Sparkline Assignment' at the passed index and assigns the passed new value to it's property 'Description (optional)'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Description (optional). Short name that describes this configuration to be recognizable'

    • index: number

      The index of the item whose property 'Description (optional)' should be set

    Returns void

setSparklineAssignmentEnabledByDescription

  • setSparklineAssignmentEnabledByDescription(newValue: boolean, description: string): void

  • Accesses the item of the widget's array property 'Sparkline Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Enable'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Enable. If this is deactivated, the config shall have no effect'

    • description: string

      The description of the item whose property 'Enable' should be set

    Returns void

setSparklineAssignmentEnabledByIndex

  • setSparklineAssignmentEnabledByIndex(newValue: boolean, index: number): void

  • Accesses the item of the widget's array property 'Sparkline Assignment' at the passed index and assigns the passed new value to it's property 'Enable'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Enable. If this is deactivated, the config shall have no effect'

    • index: number

      The index of the item whose property 'Enable' should be set

    Returns void

setSparklineAssignmentGoodColorByDescription

  • setSparklineAssignmentGoodColorByDescription(newValue: string, description: string): void

  • Accesses the item of the widget's array property 'Sparkline Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Good Color'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Good Color. The color used for visualization elements with a positive implication.'

    • description: string

      The description of the item whose property 'Good Color' should be set

    Returns void

setSparklineAssignmentGoodColorByIndex

  • setSparklineAssignmentGoodColorByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Sparkline Assignment' at the passed index and assigns the passed new value to it's property 'Good Color'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Good Color. The color used for visualization elements with a positive implication.'

    • index: number

      The index of the item whose property 'Good Color' should be set

    Returns void

setSparklineAssignmentInToolTipByDescription

  • setSparklineAssignmentInToolTipByDescription(newValue: boolean, description: string): void

  • Accesses the item of the widget's array property 'Sparkline Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Show In Tooltip'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Show In Tooltip. When activated, the visualisation is shown in a tooltip, instead of hte cell itself'

    • description: string

      The description of the item whose property 'Show In Tooltip' should be set

    Returns void

setSparklineAssignmentInToolTipByIndex

  • setSparklineAssignmentInToolTipByIndex(newValue: boolean, index: number): void

  • Accesses the item of the widget's array property 'Sparkline Assignment' at the passed index and assigns the passed new value to it's property 'Show In Tooltip'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Show In Tooltip. When activated, the visualisation is shown in a tooltip, instead of hte cell itself'

    • index: number

      The index of the item whose property 'Show In Tooltip' should be set

    Returns void

setSparklineAssignmentIncludeAggregatesByDescription

  • setSparklineAssignmentIncludeAggregatesByDescription(newValue: boolean, description: string): void

  • Accesses the item of the widget's array property 'Sparkline Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Include Aggregates'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Include Aggregates. When activated, aggregation data points like sums are part of the showed data. This option is turned off by default to prevent aggregate peaks from distorting the scaling'

    • description: string

      The description of the item whose property 'Include Aggregates' should be set

    Returns void

setSparklineAssignmentIncludeAggregatesByIndex

  • setSparklineAssignmentIncludeAggregatesByIndex(newValue: boolean, index: number): void

  • Accesses the item of the widget's array property 'Sparkline Assignment' at the passed index and assigns the passed new value to it's property 'Include Aggregates'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Include Aggregates. When activated, aggregation data points like sums are part of the showed data. This option is turned off by default to prevent aggregate peaks from distorting the scaling'

    • index: number

      The index of the item whose property 'Include Aggregates' should be set

    Returns void

setSparklineAssignmentJsonString

  • setSparklineAssignmentJsonString(newSparklineAssignment: string): void

  • Sets the value of the property 'Sparkline Assignment' as a JSON-String.

    Parameters

    • newSparklineAssignment: string

      Sparkline Assignment

    Returns void

setSparklineAssignmentMaxColorByDescription

  • setSparklineAssignmentMaxColorByDescription(newValue: string, description: string): void

  • Accesses the item of the widget's array property 'Sparkline Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Maximum Color'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Maximum Color. The color used for highlighting the largest value.'

    • description: string

      The description of the item whose property 'Maximum Color' should be set

    Returns void

setSparklineAssignmentMaxColorByIndex

  • setSparklineAssignmentMaxColorByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Sparkline Assignment' at the passed index and assigns the passed new value to it's property 'Maximum Color'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Maximum Color. The color used for highlighting the largest value.'

    • index: number

      The index of the item whose property 'Maximum Color' should be set

    Returns void

setSparklineAssignmentMinColorByDescription

  • setSparklineAssignmentMinColorByDescription(newValue: string, description: string): void

  • Accesses the item of the widget's array property 'Sparkline Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Minimum Color'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Minimum Color. The color used for highlighting the smallest value.'

    • description: string

      The description of the item whose property 'Minimum Color' should be set

    Returns void

setSparklineAssignmentMinColorByIndex

  • setSparklineAssignmentMinColorByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Sparkline Assignment' at the passed index and assigns the passed new value to it's property 'Minimum Color'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Minimum Color. The color used for highlighting the smallest value.'

    • index: number

      The index of the item whose property 'Minimum Color' should be set

    Returns void

setSparklineAssignmentTargetAxisByDescription

  • setSparklineAssignmentTargetAxisByDescription(newValue: string, description: string): void

  • Accesses the item of the widget's array property 'Sparkline Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Target Axis'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Target Axis. The axis which contains the data to be used for this feature. Additional Axes can be created at the data tab.'

    • description: string

      The description of the item whose property 'Target Axis' should be set

    Returns void

setSparklineAssignmentTargetAxisByIndex

  • setSparklineAssignmentTargetAxisByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Sparkline Assignment' at the passed index and assigns the passed new value to it's property 'Target Axis'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Target Axis. The axis which contains the data to be used for this feature. Additional Axes can be created at the data tab.'

    • index: number

      The index of the item whose property 'Target Axis' should be set

    Returns void

staticContexts Methods

getStaticContexts

  • getStaticContexts(): unknown[]

  • Accesses the items of the widget's array property 'Static Contexts' and returns its value.'

    Returns unknown[]

getStaticContextsJsonString

  • getStaticContextsJsonString(): string

  • Returns the value of the property 'Static Contexts' as a JSON-String.

    Returns string

getStaticContextsKeyByIndex

  • getStaticContextsKeyByIndex(index: number): string

  • Accesses the item of the widget's array property 'Static Contexts' at the passed index and returns the value of it's property 'Key. '

    Parameters

    • index: number

      The index of the item whose property 'Key' should be returned

    Returns string

getStaticContextsKeyTextByIndex

  • getStaticContextsKeyTextByIndex(index: number): string

  • Accesses the item of the widget's array property 'Static Contexts' at the passed index and returns the value of it's property 'Key Text. '

    Parameters

    • index: number

      The index of the item whose property 'Key Text' should be returned

    Returns string

getStaticContextsTypeByIndex

  • getStaticContextsTypeByIndex(index: number): string

  • Accesses the item of the widget's array property 'Static Contexts' at the passed index and returns the value of it's property 'Type. '

    Parameters

    • index: number

      The index of the item whose property 'Type' should be returned

    Returns string

getStaticContextsValueByIndex

  • getStaticContextsValueByIndex(index: number): string

  • Accesses the item of the widget's array property 'Static Contexts' at the passed index and returns the value of it's property 'Value. '

    Parameters

    • index: number

      The index of the item whose property 'Value' should be returned

    Returns string

getStaticContextsValueTextByIndex

  • getStaticContextsValueTextByIndex(index: number): string

  • Accesses the item of the widget's array property 'Static Contexts' at the passed index and returns the value of it's property 'Value Text. '

    Parameters

    • index: number

      The index of the item whose property 'Value Text' should be returned

    Returns string

setStaticContexts

  • setStaticContexts(newValue: unknown[]): void

  • Sets the items of the widget's array property 'Static Contexts'. This Method overrides the previously existing items.

    Parameters

    • newValue: unknown[]

      The new items assigned to the property 'Static Contexts'

    Returns void

setStaticContextsJsonString

  • setStaticContextsJsonString(newStaticContexts: string): void

  • Sets the value of the property 'Static Contexts' as a JSON-String.

    Parameters

    • newStaticContexts: string

      Static Contexts

    Returns void

setStaticContextsKeyByIndex

  • setStaticContextsKeyByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Static Contexts' at the passed index and assigns the passed new value to it's property 'Key'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Key. '

    • index: number

      The index of the item whose property 'Key' should be set

    Returns void

setStaticContextsKeyTextByIndex

  • setStaticContextsKeyTextByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Static Contexts' at the passed index and assigns the passed new value to it's property 'Key Text'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Key Text. '

    • index: number

      The index of the item whose property 'Key Text' should be set

    Returns void

setStaticContextsTypeByIndex

  • setStaticContextsTypeByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Static Contexts' at the passed index and assigns the passed new value to it's property 'Type'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Type. '

    • index: number

      The index of the item whose property 'Type' should be set

    Returns void

setStaticContextsValueByIndex

  • setStaticContextsValueByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Static Contexts' at the passed index and assigns the passed new value to it's property 'Value'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Value. '

    • index: number

      The index of the item whose property 'Value' should be set

    Returns void

setStaticContextsValueTextByIndex

  • setStaticContextsValueTextByIndex(newValue: string, index: number): void

  • Accesses the item of the widget's array property 'Static Contexts' at the passed index and assigns the passed new value to it's property 'Value Text'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Value Text. '

    • index: number

      The index of the item whose property 'Value Text' should be set

    Returns void

suppressRepeatingColumnHeader Methods

getSuppressRepeatingColumnHeader

  • getSuppressRepeatingColumnHeader(): boolean

  • Returns the value of the property 'Suppress Repeating Column Header' .

    Returns boolean

setSuppressRepeatingColumnHeader

  • setSuppressRepeatingColumnHeader(newSuppressRepeatingColumnHeader: boolean): void

  • Sets the value of the property 'Suppress Repeating Column Header' .

    Parameters

    • newSuppressRepeatingColumnHeader: boolean

      Suppress Repeating Column Header

    Returns void

suppressRepeatingRowHeader Methods

getSuppressRepeatingRowHeader

  • getSuppressRepeatingRowHeader(): boolean

  • Returns the value of the property 'Suppress Repeating Row Header' .

    Returns boolean

setSuppressRepeatingRowHeader

  • setSuppressRepeatingRowHeader(newSuppressRepeatingRowHeader: boolean): void

  • Sets the value of the property 'Suppress Repeating Row Header' .

    Parameters

    • newSuppressRepeatingRowHeader: boolean

      Suppress Repeating Row Header

    Returns void

templateName Methods

getTemplateName

  • getTemplateName(): string

  • Returns the value of the property 'Template Name' .

    Returns string

setTemplateName

  • setTemplateName(newTemplateName: string): void

  • Sets the value of the property 'Template Name' .

    Parameters

    • newTemplateName: string

      Template Name

    Returns void

titleFontSize Methods

getTitleFontSize

  • getTitleFontSize(): string

  • Returns the value of the property 'Title Font Size' .

    Returns string

setTitleFontSize

  • setTitleFontSize(newTitleFontSize: string): void

  • Sets the value of the property 'Title Font Size' . Only valid css strings (value + unit[px,rem,em,%]) are allowed. E.g. '10px' or '0.5em'

    Parameters

    • newTitleFontSize: string

      Title Font Size

    Returns void

titleText Methods

getTitleText

  • getTitleText(): string

  • Returns the value of the property 'Title Text' .

    Returns string

setTitleText

  • setTitleText(newTitleText: string): void

  • Sets the value of the property 'Title Text' .

    Parameters

    • newTitleText: string

      Title Text

    Returns void

useRuntimeData Methods

getUseRuntimeData

  • getUseRuntimeData(): boolean

  • Returns the value of the property 'Use Runtime Data' .

    Returns boolean

setUseRuntimeData

  • setUseRuntimeData(newUseRuntimeData: boolean): void

  • Sets the value of the property 'Use Runtime Data' .

    Parameters

    • newUseRuntimeData: boolean

      Use Runtime Data

    Returns void

visualisationCommentRepresentation Methods

getVisualisationCommentRepresentation

  • getVisualisationCommentRepresentation(): string

  • Returns the value of the property 'Visualisation Comment Representation' .

    Returns string

setVisualisationCommentRepresentation

  • setVisualisationCommentRepresentation(newVisualisationCommentRepresentation: string): void

  • Sets the value of the property 'Visualisation Comment Representation' .

    Parameters

    • newVisualisationCommentRepresentation: string

      Visualisation Comment Representation

    Returns void

widthPerColumn Methods

getWidthPerColumn

  • getWidthPerColumn(): number[]

  • Returns the value of the property 'Width Per Column [px]. Assigns pixel widths to columns by index. The first value gets assigned to the first row header column and so on. 'default' leads to the property 'column width' being used instead, 'auto' leads to the remaining width of the matrix being uniformly distributed to all 'auto'-assigned columns.

    Returns number[]

getWidthPerColumnJsonString

  • getWidthPerColumnJsonString(): string

  • Returns the value of the property 'Width Per Column' as a JSON-String.

    Returns string

setWidthPerColumn

  • setWidthPerColumn(newValue: number[]): void

  • Sets the value of the property 'Width Per Column [px]'

    Parameters

    • newValue: number[]

      The new value of property 'Width Per Column [px]. Assigns pixel widths to columns by index. The first value gets assigned to the first row header column and so on. 'default' leads to the property 'column width' being used instead, 'auto' leads to the remaining width of the matrix being uniformly distributed to all 'auto'-assigned columns.'

    Returns void

setWidthPerColumnJsonString

  • setWidthPerColumnJsonString(newWidthPerColumn: string): void

  • Sets the value of the property 'Width Per Column' as a JSON-String.

    Parameters

    • newWidthPerColumn: string

      Width Per Column

    Returns void