Menu

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

Hierarchy

  • ScriptingApi

Index

Event Properties

General Methods

applyDotColorsToLines Methods

axisLabels Methods

axisThickness Methods

barWidth Methods

calcPath Methods

calculateDeviationsFromNull Methods

categoryCount Methods

categoryLabelRotation Methods

categoryLabelsVisibility Methods

categoryWidth Methods

chartType Methods

chartTypeBySeries Methods

checkOnlyLeadingValuesForPeaking Methods

collisionAdjustment Methods

comparisonGroup Methods

cropCategoryLabels Methods

customSeriesLabels Methods

datatypes1 Methods

datatypes10 Methods

datatypes11 Methods

datatypes12 Methods

datatypes13 Methods

datatypes14 Methods

datatypes15 Methods

datatypes16 Methods

datatypes17 Methods

datatypes18 Methods

datatypes19 Methods

datatypes2 Methods

datatypes20 Methods

datatypes21 Methods

datatypes22 Methods

datatypes23 Methods

datatypes24 Methods

datatypes3 Methods

datatypes4 Methods

datatypes5 Methods

datatypes6 Methods

datatypes7 Methods

datatypes8 Methods

datatypes9 Methods

deviationBadColor Methods

deviationBarSizeFactor Methods

deviationGoodColor Methods

deviationNeutralColor Methods

deviationPinLineBlack Methods

deviationPinWidth Methods

deviationVisibility Methods

deviationsConfig Methods

elementsOffset Methods

endingLineColor Methods

endingLineOverlap Methods

endingLineThickness Methods

endingLineVisible Methods

fadeOutOpacity Methods

fixedCategoryWidth Methods

flipValueAxis Methods

fontColor Methods

fontFamily Methods

fontSize Methods

forceBeforeSeparators Methods

forceFirstValueLabel Methods

forceLastValueLabel Methods

forceMaxValueLabel Methods

forceMinValueLabel Methods

forcePeakLabels Methods

forceTickInterval Methods

hierarchicalLabelDisplay Methods

highlightEndIndex Methods

highlightEndSeries Methods

highlightGroup Methods

highlightGroupColor Methods

highlightGroupMatchMeasures Methods

highlightLabelAbsolute Methods

highlightLabelPercentage Methods

highlightMode Methods

highlightStartIndex Methods

highlightStartSeries Methods

labelPositioningMode Methods

labelShadowColor Methods

labelShadows Methods

legendEnabled Methods

lineBreakAxisLabel Methods

lineDotRadiusX Methods

lineDotRadiusY Methods

manualScaleMax Methods

manualScaleMin Methods

manualScalePercentMax Methods

manualScalePercentMin Methods

maxCategoryLabelWidth Methods

maxSeriesLabelsWidth Methods

minCategoryWidth Methods

minimumPeakSize Methods

multiHighlights Methods

nRest Methods

negativeDeviationIsGood Methods

negativeOutlierThreshold Methods

negativeOutlierThresholdPercent Methods

offsetPerSeries Methods

offsetbarDeviationLabelsOnTop Methods

offsetbarLabelsOnTop Methods

outlierMode Methods

outlierSize Methods

padding Methods

pickLabels Methods

pinHeadColor Methods

pinHeadMode Methods

pinHeadRadiusX Methods

pinHeadRadiusY Methods

pinHeadShape Methods

pinWidth Methods

positiveOutlierThreshold Methods

positiveOutlierThresholdPercent Methods

rotated Methods

scaleMode Methods

scalingHelper Methods

scalingHelperAreaColor Methods

scalingHelperBarColor Methods

scalingHelperBarLineWidth Methods

scalingHelperValue Methods

scenarioAssignment Methods

scenariosBySeries Methods

scenariosInDeviations Methods

separatorColor Methods

separatorLength Methods

separatorMode Methods

separatorPositions Methods

separatorSourceRowIndex Methods

separatorThickness Methods

separatorsInFront Methods

seriesLabels Methods

seriesStyles Methods

serverUrl Methods

showAxisLabelsLeft Methods

showAxisLabelsRight Methods

showBaseChart Methods

showCategoryAxis Methods

showCategoryLabels Methods

showDatatypesInAxis Methods

showOffsetsOnLeft Methods

showPinHeadColor Methods

showSeriesLabelsLeft Methods

showSeriesLabelsRight Methods

showTitle Methods

showTooltips Methods

showValueAxis Methods

smallMultiplesDimension Methods

smallMultiplesMinHeight Methods

smallMultiplesMinWidth Methods

smallMultiplesNCount Methods

spaceFactorBaseChart Methods

spaceFactorDeviationChart Methods

spacing Methods

splitSignForCategoryLabels Methods

stackedBarLabelPosition Methods

stackedBarMode Methods

stackedBarSumsVisible Methods

suppressRepeatingCategoryLabels Methods

synchronizeAxesPosition Methods

synchronizePadding Methods

synchronizeScaling Methods

templateName Methods

thresholdLinesConfig Methods

useOutlierThreshold Methods

userHighlightCol Methods

userHighlights Methods

valueAxisShowHelplines Methods

valueAxisTickDistance Methods

visibleElementLabels Methods

visibleSeries Methods

waterfallMinusColor Methods

waterfallNeutralColor Methods

waterfallPlusColor Methods

waterfallSpanMinusColor Methods

waterfallSpanPlusColor Methods

waterfallSumColor Methods

Event Properties

onSelect

onSelect: Function

Fires when a data selection was made on this component.

General Methods

clearSelection

  • clearSelection(): void

  • Clears the selection of this visual

    Returns void

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

getSelectedData

  • getSelectedData(): SelectionContext[]

  • Returns the current selection state of this component

    Returns SelectionContext[]

getTitle

  • getTitle(): string

  • Returns the value of the property 'Title' .

    Returns string

getTooltipValueFormatAssignmentJsonString

  • getTooltipValueFormatAssignmentJsonString(): string

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

    Returns string

getValueFormatAssignmentJsonString

  • getValueFormatAssignmentJsonString(): string

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

    Returns string

setResultSetFromChart

  • setResultSetFromChart(chart: unknown, seriesDimensions?: string[]): void

  • Sets the resultset from choosen chart as charts data where each measure represents a chart series.

    Parameters

    • chart: unknown

      Chart widget whose resultset will be bound to the graphomate charts

    • Optional seriesDimensions: string[]

    Returns void

setResultSetFromTable

  • setResultSetFromTable(table: unknown): void

  • Sets the resultset from choosen table as charts data where each measure represents a chart series.

    Parameters

    • table: unknown

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

    Returns void

setTitle

  • setTitle(newTitle: string): void

  • Sets the value of the property 'Title' .

    Parameters

    • newTitle: string

      Title

    Returns void

setTooltipValueFormatAssignmentJsonString

  • setTooltipValueFormatAssignmentJsonString(newTooltipValueFormatAssignment: string): void

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

    Parameters

    • newTooltipValueFormatAssignment: string

      Tooltip Value Format Assignment

    Returns void

setTransposeData

  • setTransposeData(): void

  • Transposes the current dataset.

    Returns void

setValueFormatAssignmentJsonString

  • setValueFormatAssignmentJsonString(newValueFormatAssignment: string): void

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

    Parameters

    • newValueFormatAssignment: string

      Value Format Assignment

    Returns void

applyDotColorsToLines Methods

getApplyDotColorsToLines

  • getApplyDotColorsToLines(): boolean

  • Returns the value of the property 'Apply Dot Colors To Lines' .

    Returns boolean

setApplyDotColorsToLines

  • setApplyDotColorsToLines(newApplyDotColorsToLines: boolean): void

  • Sets the value of the property 'Apply Dot Colors To Lines' .

    Parameters

    • newApplyDotColorsToLines: boolean

      Apply Dot Colors To Lines

    Returns void

axisLabels Methods

getAxisLabels

  • getAxisLabels(): string[]

  • Returns the value of the property 'Axis Labels.

    Returns string[]

getAxisLabelsJsonString

  • getAxisLabelsJsonString(): string

  • Returns the value of the property 'Axis Labels' as a JSON-String.

    Returns string

setAxisLabels

  • setAxisLabels(newValue: string[]): void

  • Sets the value of the property 'Axis Labels'

    Parameters

    • newValue: string[]

      The new value of property 'Axis Labels. '

    Returns void

setAxisLabelsJsonString

  • setAxisLabelsJsonString(newAxisLabels: string): void

  • Sets the value of the property 'Axis Labels' as a JSON-String.

    Parameters

    • newAxisLabels: string

      Axis Labels

    Returns void

axisThickness Methods

getAxisThickness

  • getAxisThickness(): number

  • Returns the value of the property 'Axis Thickness' .

    Returns number

setAxisThickness

  • setAxisThickness(newAxisThickness: number): void

  • Sets the value of the property 'Axis Thickness' .

    Parameters

    • newAxisThickness: number

      Axis Thickness

    Returns void

barWidth Methods

getBarWidth

  • getBarWidth(): number

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

    Returns number

setBarWidth

  • setBarWidth(newBarWidth: number): void

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

    Parameters

    • newBarWidth: number

      Bar Width

    Returns void

calcPath Methods

getCalcPath

  • getCalcPath(): string[]

  • Returns the value of the property 'Calculation Path.

    Returns string[]

getCalcPathJsonString

  • getCalcPathJsonString(): string

  • Returns the value of the property 'Calc Path' as a JSON-String.

    Returns string

setCalcPath

  • setCalcPath(newValue: string[]): void

  • Sets the value of the property 'Calculation Path'

    Parameters

    • newValue: string[]

      The new value of property 'Calculation Path. '

    Returns void

setCalcPathJsonString

  • setCalcPathJsonString(newCalcPath: string): void

  • Sets the value of the property 'Calc Path' as a JSON-String.

    Parameters

    • newCalcPath: string

      Calc Path

    Returns void

calculateDeviationsFromNull Methods

getCalculateDeviationsFromNull

  • getCalculateDeviationsFromNull(): boolean

  • Returns the value of the property 'Calculate Deviations From Null' .

    Returns boolean

setCalculateDeviationsFromNull

  • setCalculateDeviationsFromNull(newCalculateDeviationsFromNull: boolean): void

  • Sets the value of the property 'Calculate Deviations From Null' .

    Parameters

    • newCalculateDeviationsFromNull: boolean

      Calculate Deviations From Null

    Returns void

categoryCount Methods

getCategoryCount

  • getCategoryCount(): number

  • Returns the value of the property 'Category Count' .

    Returns number

setCategoryCount

  • setCategoryCount(newCategoryCount: number): void

  • Sets the value of the property 'Category Count' .

    Parameters

    • newCategoryCount: number

      Category Count

    Returns void

categoryLabelRotation Methods

getCategoryLabelRotation

  • getCategoryLabelRotation(): number

  • Returns the value of the property 'Category Label Rotation' .

    Returns number

setCategoryLabelRotation

  • setCategoryLabelRotation(newCategoryLabelRotation: number): void

  • Sets the value of the property 'Category Label Rotation' .

    Parameters

    • newCategoryLabelRotation: number

      Category Label Rotation

    Returns void

categoryLabelsVisibility Methods

getCategoryLabelsVisibility

  • getCategoryLabelsVisibility(): boolean[]

  • Returns the value of the property 'Visibility.

    Returns boolean[]

getCategoryLabelsVisibilityJsonString

  • getCategoryLabelsVisibilityJsonString(): string

  • Returns the value of the property 'Category Labels Visibility' as a JSON-String.

    Returns string

setCategoryLabelsVisibility

  • setCategoryLabelsVisibility(newValue: boolean[]): void

  • Sets the value of the property 'Visibility'

    Parameters

    • newValue: boolean[]

      The new value of property 'Visibility. '

    Returns void

setCategoryLabelsVisibilityJsonString

  • setCategoryLabelsVisibilityJsonString(newCategoryLabelsVisibility: string): void

  • Sets the value of the property 'Category Labels Visibility' as a JSON-String.

    Parameters

    • newCategoryLabelsVisibility: string

      Category Labels Visibility

    Returns void

categoryWidth Methods

getCategoryWidth

  • getCategoryWidth(): number

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

    Returns number

setCategoryWidth

  • setCategoryWidth(newCategoryWidth: number): void

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

    Parameters

    • newCategoryWidth: number

      Category Width

    Returns void

chartType Methods

getChartType

  • getChartType(): string

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

    Returns string

setChartType

  • setChartType(newChartType: string): void

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

    Parameters

    • newChartType: string

      Chart Type

    Returns void

chartTypeBySeries Methods

getChartTypeBySeries

  • getChartTypeBySeries(): string[]

  • Returns the value of the property 'Chart Type By Series.

    Returns string[]

getChartTypeBySeriesJsonString

  • getChartTypeBySeriesJsonString(): string

  • Returns the value of the property 'Chart Type By Series' as a JSON-String.

    Returns string

setChartTypeBySeries

  • setChartTypeBySeries(newValue: string[]): void

  • Sets the value of the property 'Chart Type By Series'

    Parameters

    • newValue: string[]

      The new value of property 'Chart Type By Series. '

    Returns void

setChartTypeBySeriesJsonString

  • setChartTypeBySeriesJsonString(newChartTypeBySeries: string): void

  • Sets the value of the property 'Chart Type By Series' as a JSON-String.

    Parameters

    • newChartTypeBySeries: string

      Chart Type By Series

    Returns void

checkOnlyLeadingValuesForPeaking Methods

getCheckOnlyLeadingValuesForPeaking

  • getCheckOnlyLeadingValuesForPeaking(): boolean

  • Returns the value of the property 'Check Only Leading Values For Peaking' .

    Returns boolean

setCheckOnlyLeadingValuesForPeaking

  • setCheckOnlyLeadingValuesForPeaking(newCheckOnlyLeadingValuesForPeaking: boolean): void

  • Sets the value of the property 'Check Only Leading Values For Peaking' .

    Parameters

    • newCheckOnlyLeadingValuesForPeaking: boolean

      Check Only Leading Values For Peaking

    Returns void

collisionAdjustment Methods

getCollisionAdjustment

  • getCollisionAdjustment(): number

  • Returns the value of the property 'Collision Adjustment' .

    Returns number

setCollisionAdjustment

  • setCollisionAdjustment(newCollisionAdjustment: number): void

  • Sets the value of the property 'Collision Adjustment' .

    Parameters

    • newCollisionAdjustment: number

      Collision Adjustment

    Returns void

comparisonGroup Methods

getComparisonGroup

  • getComparisonGroup(): string

  • Returns the value of the property 'Comparison Group' .

    Returns string

setComparisonGroup

  • setComparisonGroup(newComparisonGroup: string): void

  • Sets the value of the property 'Comparison Group' .

    Parameters

    • newComparisonGroup: string

      Comparison Group

    Returns void

cropCategoryLabels Methods

getCropCategoryLabels

  • getCropCategoryLabels(): boolean

  • Returns the value of the property 'Crop Category Labels' .

    Returns boolean

setCropCategoryLabels

  • setCropCategoryLabels(newCropCategoryLabels: boolean): void

  • Sets the value of the property 'Crop Category Labels' .

    Parameters

    • newCropCategoryLabels: boolean

      Crop Category Labels

    Returns void

customSeriesLabels Methods

getCustomSeriesLabels

  • getCustomSeriesLabels(): boolean

  • Returns the value of the property 'Custom Series Labels' .

    Returns boolean

setCustomSeriesLabels

  • setCustomSeriesLabels(newCustomSeriesLabels: boolean): void

  • Sets the value of the property 'Custom Series Labels' .

    Parameters

    • newCustomSeriesLabels: boolean

      Custom Series Labels

    Returns void

datatypes1 Methods

getDatatypes1

  • getDatatypes1(): string[]

  • Returns the value of the property 'Scenarios 1.

    Returns string[]

getDatatypes1JsonString

  • getDatatypes1JsonString(): string

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

    Returns string

setDatatypes1

  • setDatatypes1(newValue: string[]): void

  • Sets the value of the property 'Scenarios 1'

    Parameters

    • newValue: string[]

      The new value of property 'Scenarios 1. '

    Returns void

setDatatypes1JsonString

  • setDatatypes1JsonString(newDatatypes1: string): void

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

    Parameters

    • newDatatypes1: string

      Datatypes1

    Returns void

datatypes10 Methods

getDatatypes10

  • getDatatypes10(): string[]

  • Returns the value of the property 'Scenarios 10.

    Returns string[]

getDatatypes10JsonString

  • getDatatypes10JsonString(): string

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

    Returns string

setDatatypes10

  • setDatatypes10(newValue: string[]): void

  • Sets the value of the property 'Scenarios 10'

    Parameters

    • newValue: string[]

      The new value of property 'Scenarios 10. '

    Returns void

setDatatypes10JsonString

  • setDatatypes10JsonString(newDatatypes10: string): void

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

    Parameters

    • newDatatypes10: string

      Datatypes10

    Returns void

datatypes11 Methods

getDatatypes11

  • getDatatypes11(): string[]

  • Returns the value of the property 'Scenarios 11.

    Returns string[]

getDatatypes11JsonString

  • getDatatypes11JsonString(): string

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

    Returns string

setDatatypes11

  • setDatatypes11(newValue: string[]): void

  • Sets the value of the property 'Scenarios 11'

    Parameters

    • newValue: string[]

      The new value of property 'Scenarios 11. '

    Returns void

setDatatypes11JsonString

  • setDatatypes11JsonString(newDatatypes11: string): void

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

    Parameters

    • newDatatypes11: string

      Datatypes11

    Returns void

datatypes12 Methods

getDatatypes12

  • getDatatypes12(): string[]

  • Returns the value of the property 'Scenarios 12.

    Returns string[]

getDatatypes12JsonString

  • getDatatypes12JsonString(): string

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

    Returns string

setDatatypes12

  • setDatatypes12(newValue: string[]): void

  • Sets the value of the property 'Scenarios 12'

    Parameters

    • newValue: string[]

      The new value of property 'Scenarios 12. '

    Returns void

setDatatypes12JsonString

  • setDatatypes12JsonString(newDatatypes12: string): void

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

    Parameters

    • newDatatypes12: string

      Datatypes12

    Returns void

datatypes13 Methods

getDatatypes13

  • getDatatypes13(): string[]

  • Returns the value of the property 'Scenarios 13.

    Returns string[]

getDatatypes13JsonString

  • getDatatypes13JsonString(): string

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

    Returns string

setDatatypes13

  • setDatatypes13(newValue: string[]): void

  • Sets the value of the property 'Scenarios 13'

    Parameters

    • newValue: string[]

      The new value of property 'Scenarios 13. '

    Returns void

setDatatypes13JsonString

  • setDatatypes13JsonString(newDatatypes13: string): void

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

    Parameters

    • newDatatypes13: string

      Datatypes13

    Returns void

datatypes14 Methods

getDatatypes14

  • getDatatypes14(): string[]

  • Returns the value of the property 'Scenarios 14.

    Returns string[]

getDatatypes14JsonString

  • getDatatypes14JsonString(): string

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

    Returns string

setDatatypes14

  • setDatatypes14(newValue: string[]): void

  • Sets the value of the property 'Scenarios 14'

    Parameters

    • newValue: string[]

      The new value of property 'Scenarios 14. '

    Returns void

setDatatypes14JsonString

  • setDatatypes14JsonString(newDatatypes14: string): void

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

    Parameters

    • newDatatypes14: string

      Datatypes14

    Returns void

datatypes15 Methods

getDatatypes15

  • getDatatypes15(): string[]

  • Returns the value of the property 'Scenarios 15.

    Returns string[]

getDatatypes15JsonString

  • getDatatypes15JsonString(): string

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

    Returns string

setDatatypes15

  • setDatatypes15(newValue: string[]): void

  • Sets the value of the property 'Scenarios 15'

    Parameters

    • newValue: string[]

      The new value of property 'Scenarios 15. '

    Returns void

setDatatypes15JsonString

  • setDatatypes15JsonString(newDatatypes15: string): void

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

    Parameters

    • newDatatypes15: string

      Datatypes15

    Returns void

datatypes16 Methods

getDatatypes16

  • getDatatypes16(): string[]

  • Returns the value of the property 'Scenarios 16.

    Returns string[]

getDatatypes16JsonString

  • getDatatypes16JsonString(): string

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

    Returns string

setDatatypes16

  • setDatatypes16(newValue: string[]): void

  • Sets the value of the property 'Scenarios 16'

    Parameters

    • newValue: string[]

      The new value of property 'Scenarios 16. '

    Returns void

setDatatypes16JsonString

  • setDatatypes16JsonString(newDatatypes16: string): void

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

    Parameters

    • newDatatypes16: string

      Datatypes16

    Returns void

datatypes17 Methods

getDatatypes17

  • getDatatypes17(): string[]

  • Returns the value of the property 'Scenarios 17.

    Returns string[]

getDatatypes17JsonString

  • getDatatypes17JsonString(): string

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

    Returns string

setDatatypes17

  • setDatatypes17(newValue: string[]): void

  • Sets the value of the property 'Scenarios 17'

    Parameters

    • newValue: string[]

      The new value of property 'Scenarios 17. '

    Returns void

setDatatypes17JsonString

  • setDatatypes17JsonString(newDatatypes17: string): void

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

    Parameters

    • newDatatypes17: string

      Datatypes17

    Returns void

datatypes18 Methods

getDatatypes18

  • getDatatypes18(): string[]

  • Returns the value of the property 'Scenarios 18.

    Returns string[]

getDatatypes18JsonString

  • getDatatypes18JsonString(): string

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

    Returns string

setDatatypes18

  • setDatatypes18(newValue: string[]): void

  • Sets the value of the property 'Scenarios 18'

    Parameters

    • newValue: string[]

      The new value of property 'Scenarios 18. '

    Returns void

setDatatypes18JsonString

  • setDatatypes18JsonString(newDatatypes18: string): void

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

    Parameters

    • newDatatypes18: string

      Datatypes18

    Returns void

datatypes19 Methods

getDatatypes19

  • getDatatypes19(): string[]

  • Returns the value of the property 'Scenarios 19.

    Returns string[]

getDatatypes19JsonString

  • getDatatypes19JsonString(): string

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

    Returns string

setDatatypes19

  • setDatatypes19(newValue: string[]): void

  • Sets the value of the property 'Scenarios 19'

    Parameters

    • newValue: string[]

      The new value of property 'Scenarios 19. '

    Returns void

setDatatypes19JsonString

  • setDatatypes19JsonString(newDatatypes19: string): void

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

    Parameters

    • newDatatypes19: string

      Datatypes19

    Returns void

datatypes2 Methods

getDatatypes2

  • getDatatypes2(): string[]

  • Returns the value of the property 'Scenarios 2.

    Returns string[]

getDatatypes2JsonString

  • getDatatypes2JsonString(): string

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

    Returns string

setDatatypes2

  • setDatatypes2(newValue: string[]): void

  • Sets the value of the property 'Scenarios 2'

    Parameters

    • newValue: string[]

      The new value of property 'Scenarios 2. '

    Returns void

setDatatypes2JsonString

  • setDatatypes2JsonString(newDatatypes2: string): void

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

    Parameters

    • newDatatypes2: string

      Datatypes2

    Returns void

datatypes20 Methods

getDatatypes20

  • getDatatypes20(): string[]

  • Returns the value of the property 'Scenarios 20.

    Returns string[]

getDatatypes20JsonString

  • getDatatypes20JsonString(): string

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

    Returns string

setDatatypes20

  • setDatatypes20(newValue: string[]): void

  • Sets the value of the property 'Scenarios 20'

    Parameters

    • newValue: string[]

      The new value of property 'Scenarios 20. '

    Returns void

setDatatypes20JsonString

  • setDatatypes20JsonString(newDatatypes20: string): void

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

    Parameters

    • newDatatypes20: string

      Datatypes20

    Returns void

datatypes21 Methods

getDatatypes21

  • getDatatypes21(): string[]

  • Returns the value of the property 'Scenarios 21.

    Returns string[]

getDatatypes21JsonString

  • getDatatypes21JsonString(): string

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

    Returns string

setDatatypes21

  • setDatatypes21(newValue: string[]): void

  • Sets the value of the property 'Scenarios 21'

    Parameters

    • newValue: string[]

      The new value of property 'Scenarios 21. '

    Returns void

setDatatypes21JsonString

  • setDatatypes21JsonString(newDatatypes21: string): void

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

    Parameters

    • newDatatypes21: string

      Datatypes21

    Returns void

datatypes22 Methods

getDatatypes22

  • getDatatypes22(): string[]

  • Returns the value of the property 'Scenarios 22.

    Returns string[]

getDatatypes22JsonString

  • getDatatypes22JsonString(): string

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

    Returns string

setDatatypes22

  • setDatatypes22(newValue: string[]): void

  • Sets the value of the property 'Scenarios 22'

    Parameters

    • newValue: string[]

      The new value of property 'Scenarios 22. '

    Returns void

setDatatypes22JsonString

  • setDatatypes22JsonString(newDatatypes22: string): void

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

    Parameters

    • newDatatypes22: string

      Datatypes22

    Returns void

datatypes23 Methods

getDatatypes23

  • getDatatypes23(): string[]

  • Returns the value of the property 'Scenarios 23.

    Returns string[]

getDatatypes23JsonString

  • getDatatypes23JsonString(): string

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

    Returns string

setDatatypes23

  • setDatatypes23(newValue: string[]): void

  • Sets the value of the property 'Scenarios 23'

    Parameters

    • newValue: string[]

      The new value of property 'Scenarios 23. '

    Returns void

setDatatypes23JsonString

  • setDatatypes23JsonString(newDatatypes23: string): void

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

    Parameters

    • newDatatypes23: string

      Datatypes23

    Returns void

datatypes24 Methods

getDatatypes24

  • getDatatypes24(): string[]

  • Returns the value of the property 'Scenarios 24.

    Returns string[]

getDatatypes24JsonString

  • getDatatypes24JsonString(): string

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

    Returns string

setDatatypes24

  • setDatatypes24(newValue: string[]): void

  • Sets the value of the property 'Scenarios 24'

    Parameters

    • newValue: string[]

      The new value of property 'Scenarios 24. '

    Returns void

setDatatypes24JsonString

  • setDatatypes24JsonString(newDatatypes24: string): void

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

    Parameters

    • newDatatypes24: string

      Datatypes24

    Returns void

datatypes3 Methods

getDatatypes3

  • getDatatypes3(): string[]

  • Returns the value of the property 'Scenarios 3.

    Returns string[]

getDatatypes3JsonString

  • getDatatypes3JsonString(): string

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

    Returns string

setDatatypes3

  • setDatatypes3(newValue: string[]): void

  • Sets the value of the property 'Scenarios 3'

    Parameters

    • newValue: string[]

      The new value of property 'Scenarios 3. '

    Returns void

setDatatypes3JsonString

  • setDatatypes3JsonString(newDatatypes3: string): void

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

    Parameters

    • newDatatypes3: string

      Datatypes3

    Returns void

datatypes4 Methods

getDatatypes4

  • getDatatypes4(): string[]

  • Returns the value of the property 'Scenarios 4.

    Returns string[]

getDatatypes4JsonString

  • getDatatypes4JsonString(): string

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

    Returns string

setDatatypes4

  • setDatatypes4(newValue: string[]): void

  • Sets the value of the property 'Scenarios 4'

    Parameters

    • newValue: string[]

      The new value of property 'Scenarios 4. '

    Returns void

setDatatypes4JsonString

  • setDatatypes4JsonString(newDatatypes4: string): void

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

    Parameters

    • newDatatypes4: string

      Datatypes4

    Returns void

datatypes5 Methods

getDatatypes5

  • getDatatypes5(): string[]

  • Returns the value of the property 'Scenarios 5.

    Returns string[]

getDatatypes5JsonString

  • getDatatypes5JsonString(): string

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

    Returns string

setDatatypes5

  • setDatatypes5(newValue: string[]): void

  • Sets the value of the property 'Scenarios 5'

    Parameters

    • newValue: string[]

      The new value of property 'Scenarios 5. '

    Returns void

setDatatypes5JsonString

  • setDatatypes5JsonString(newDatatypes5: string): void

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

    Parameters

    • newDatatypes5: string

      Datatypes5

    Returns void

datatypes6 Methods

getDatatypes6

  • getDatatypes6(): string[]

  • Returns the value of the property 'Scenarios 6.

    Returns string[]

getDatatypes6JsonString

  • getDatatypes6JsonString(): string

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

    Returns string

setDatatypes6

  • setDatatypes6(newValue: string[]): void

  • Sets the value of the property 'Scenarios 6'

    Parameters

    • newValue: string[]

      The new value of property 'Scenarios 6. '

    Returns void

setDatatypes6JsonString

  • setDatatypes6JsonString(newDatatypes6: string): void

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

    Parameters

    • newDatatypes6: string

      Datatypes6

    Returns void

datatypes7 Methods

getDatatypes7

  • getDatatypes7(): string[]

  • Returns the value of the property 'Scenarios 7.

    Returns string[]

getDatatypes7JsonString

  • getDatatypes7JsonString(): string

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

    Returns string

setDatatypes7

  • setDatatypes7(newValue: string[]): void

  • Sets the value of the property 'Scenarios 7'

    Parameters

    • newValue: string[]

      The new value of property 'Scenarios 7. '

    Returns void

setDatatypes7JsonString

  • setDatatypes7JsonString(newDatatypes7: string): void

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

    Parameters

    • newDatatypes7: string

      Datatypes7

    Returns void

datatypes8 Methods

getDatatypes8

  • getDatatypes8(): string[]

  • Returns the value of the property 'Scenarios 8.

    Returns string[]

getDatatypes8JsonString

  • getDatatypes8JsonString(): string

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

    Returns string

setDatatypes8

  • setDatatypes8(newValue: string[]): void

  • Sets the value of the property 'Scenarios 8'

    Parameters

    • newValue: string[]

      The new value of property 'Scenarios 8. '

    Returns void

setDatatypes8JsonString

  • setDatatypes8JsonString(newDatatypes8: string): void

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

    Parameters

    • newDatatypes8: string

      Datatypes8

    Returns void

datatypes9 Methods

getDatatypes9

  • getDatatypes9(): string[]

  • Returns the value of the property 'Scenarios 9.

    Returns string[]

getDatatypes9JsonString

  • getDatatypes9JsonString(): string

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

    Returns string

setDatatypes9

  • setDatatypes9(newValue: string[]): void

  • Sets the value of the property 'Scenarios 9'

    Parameters

    • newValue: string[]

      The new value of property 'Scenarios 9. '

    Returns void

setDatatypes9JsonString

  • setDatatypes9JsonString(newDatatypes9: string): void

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

    Parameters

    • newDatatypes9: string

      Datatypes9

    Returns void

deviationBadColor Methods

getDeviationBadColor

  • getDeviationBadColor(): string

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

    Returns string

setDeviationBadColor

  • setDeviationBadColor(newDeviationBadColor: string): void

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

    Parameters

    • newDeviationBadColor: string

      Deviation Bad Color

    Returns void

deviationBarSizeFactor Methods

getDeviationBarSizeFactor

  • getDeviationBarSizeFactor(): number

  • Returns the value of the property 'Deviation Bar Size Factor' .

    Returns number

setDeviationBarSizeFactor

  • setDeviationBarSizeFactor(newDeviationBarSizeFactor: number): void

  • Sets the value of the property 'Deviation Bar Size Factor' .

    Parameters

    • newDeviationBarSizeFactor: number

      Deviation Bar Size Factor

    Returns void

deviationGoodColor Methods

getDeviationGoodColor

  • getDeviationGoodColor(): string

  • Returns the value of the property 'Deviation Good Color' .

    Returns string

setDeviationGoodColor

  • setDeviationGoodColor(newDeviationGoodColor: string): void

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

    Parameters

    • newDeviationGoodColor: string

      Deviation Good Color

    Returns void

deviationNeutralColor Methods

getDeviationNeutralColor

  • getDeviationNeutralColor(): string

  • Returns the value of the property 'Deviation Neutral Color' .

    Returns string

setDeviationNeutralColor

  • setDeviationNeutralColor(newDeviationNeutralColor: string): void

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

    Parameters

    • newDeviationNeutralColor: string

      Deviation Neutral Color

    Returns void

deviationPinLineBlack Methods

getDeviationPinLineBlack

  • getDeviationPinLineBlack(): boolean

  • Returns the value of the property 'Deviation Pin Line Black' .

    Returns boolean

setDeviationPinLineBlack

  • setDeviationPinLineBlack(newDeviationPinLineBlack: boolean): void

  • Sets the value of the property 'Deviation Pin Line Black' .

    Parameters

    • newDeviationPinLineBlack: boolean

      Deviation Pin Line Black

    Returns void

deviationPinWidth Methods

getDeviationPinWidth

  • getDeviationPinWidth(): number

  • Returns the value of the property 'Deviation Pin Width' .

    Returns number

setDeviationPinWidth

  • setDeviationPinWidth(newDeviationPinWidth: number): void

  • Sets the value of the property 'Deviation Pin Width' .

    Parameters

    • newDeviationPinWidth: number

      Deviation Pin Width

    Returns void

deviationVisibility Methods

getDeviationVisibility

  • getDeviationVisibility(): number[]

  • Returns the value of the property 'Deviation Visibility.

    Returns number[]

getDeviationVisibilityJsonString

  • getDeviationVisibilityJsonString(): string

  • Returns the value of the property 'Deviation Visibility' as a JSON-String.

    Returns string

setDeviationVisibility

  • setDeviationVisibility(newValue: number[]): void

  • Sets the value of the property 'Deviation Visibility'

    Parameters

    • newValue: number[]

      The new value of property 'Deviation Visibility. '

    Returns void

setDeviationVisibilityJsonString

  • setDeviationVisibilityJsonString(newDeviationVisibility: string): void

  • Sets the value of the property 'Deviation Visibility' as a JSON-String.

    Parameters

    • newDeviationVisibility: string

      Deviation Visibility

    Returns void

deviationsConfig Methods

getDeviationsConfigBaseByIndex

  • getDeviationsConfigBaseByIndex(index: number): number

  • Accesses the item of the widget's array property 'Configuration' at the passed index and returns the value of it's property 'Subtrahend. Series which is the 'Subtrahend' in the deviation calculation: Minuend - Subtrahend'

    Parameters

    • index: number

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

    Returns number

getDeviationsConfigJsonString

  • getDeviationsConfigJsonString(): string

  • Returns the value of the property 'Deviations Config' as a JSON-String.

    Returns string

getDeviationsConfigLabelByIndex

  • getDeviationsConfigLabelByIndex(index: number): string

  • Accesses the item of the widget's array property 'Configuration' at the passed index and returns the value of it's property 'Label. Deviation Label'

    Parameters

    • index: number

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

    Returns string

getDeviationsConfigMeasureByIndex

  • getDeviationsConfigMeasureByIndex(index: number): number

  • Accesses the item of the widget's array property 'Configuration' at the passed index and returns the value of it's property 'Minuend. Series which is the 'Minuend' in the deviation calculation: Minuend - Subtrahend'

    Parameters

    • index: number

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

    Returns number

getDeviationsConfigRandomByIndex

  • getDeviationsConfigRandomByIndex(index: number): string

  • Accesses the item of the widget's array property 'Configuration' at the passed index and returns the value of it's property 'Random Id. Random Id'

    Parameters

    • index: number

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

    Returns string

getDeviationsConfigTypeByIndex

  • getDeviationsConfigTypeByIndex(index: number): string

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

    Parameters

    • index: number

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

    Returns string

setDeviationsConfigBaseByIndex

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

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

    Parameters

    • newValue: number

      The new value to be assigned to the property 'Subtrahend. Series which is the 'Subtrahend' in the deviation calculation: Minuend - Subtrahend'

    • index: number

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

    Returns void

setDeviationsConfigJsonString

  • setDeviationsConfigJsonString(newDeviationsConfig: string): void

  • Sets the value of the property 'Deviations Config' as a JSON-String.

    Parameters

    • newDeviationsConfig: string

      Deviations Config

    Returns void

setDeviationsConfigLabelByIndex

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

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

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Label. Deviation Label'

    • index: number

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

    Returns void

setDeviationsConfigMeasureByIndex

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

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

    Parameters

    • newValue: number

      The new value to be assigned to the property 'Minuend. Series which is the 'Minuend' in the deviation calculation: Minuend - Subtrahend'

    • index: number

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

    Returns void

setDeviationsConfigRandomByIndex

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

  • Accesses the item of the widget's array property 'Configuration' at the passed index and assigns the passed new value to it's property 'Random Id'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Random Id. Random Id'

    • index: number

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

    Returns void

setDeviationsConfigTypeByIndex

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

  • Accesses the item of the widget's array property 'Configuration' 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. Deviation Type'

    • index: number

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

    Returns void

elementsOffset Methods

getElementsOffset

  • getElementsOffset(): number

  • Returns the value of the property 'Elements Offset' .

    Returns number

setElementsOffset

  • setElementsOffset(newElementsOffset: number): void

  • Sets the value of the property 'Elements Offset' .

    Parameters

    • newElementsOffset: number

      Elements Offset

    Returns void

endingLineColor Methods

getEndingLineColor

  • getEndingLineColor(): string

  • Returns the value of the property 'Ending Line Color' .

    Returns string

setEndingLineColor

  • setEndingLineColor(newEndingLineColor: string): void

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

    Parameters

    • newEndingLineColor: string

      Ending Line Color

    Returns void

endingLineOverlap Methods

getEndingLineOverlap

  • getEndingLineOverlap(): number

  • Returns the value of the property 'Ending Line Overlap' .

    Returns number

setEndingLineOverlap

  • setEndingLineOverlap(newEndingLineOverlap: number): void

  • Sets the value of the property 'Ending Line Overlap' .

    Parameters

    • newEndingLineOverlap: number

      Ending Line Overlap

    Returns void

endingLineThickness Methods

getEndingLineThickness

  • getEndingLineThickness(): number

  • Returns the value of the property 'Ending Line Thickness' .

    Returns number

setEndingLineThickness

  • setEndingLineThickness(newEndingLineThickness: number): void

  • Sets the value of the property 'Ending Line Thickness' .

    Parameters

    • newEndingLineThickness: number

      Ending Line Thickness

    Returns void

endingLineVisible Methods

getEndingLineVisible

  • getEndingLineVisible(): boolean

  • Returns the value of the property 'Ending Line Visible' .

    Returns boolean

setEndingLineVisible

  • setEndingLineVisible(newEndingLineVisible: boolean): void

  • Sets the value of the property 'Ending Line Visible' .

    Parameters

    • newEndingLineVisible: boolean

      Ending Line Visible

    Returns void

fadeOutOpacity Methods

getFadeOutOpacity

  • getFadeOutOpacity(): number

  • Returns the value of the property 'Fade Out Opacity' .

    Returns number

setFadeOutOpacity

  • setFadeOutOpacity(newFadeOutOpacity: number): void

  • Sets the value of the property 'Fade Out Opacity' .

    Parameters

    • newFadeOutOpacity: number

      Fade Out Opacity

    Returns void

fixedCategoryWidth Methods

getFixedCategoryWidth

  • getFixedCategoryWidth(): boolean

  • Returns the value of the property 'Fixed Category Width' .

    Returns boolean

setFixedCategoryWidth

  • setFixedCategoryWidth(newFixedCategoryWidth: boolean): void

  • Sets the value of the property 'Fixed Category Width' .

    Parameters

    • newFixedCategoryWidth: boolean

      Fixed Category Width

    Returns void

flipValueAxis Methods

getFlipValueAxis

  • getFlipValueAxis(): boolean

  • Returns the value of the property 'Flip Value Axis' .

    Returns boolean

setFlipValueAxis

  • setFlipValueAxis(newFlipValueAxis: boolean): void

  • Sets the value of the property 'Flip Value Axis' .

    Parameters

    • newFlipValueAxis: boolean

      Flip Value Axis

    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(): number

  • Returns the value of the property 'Font Size' .

    Returns number

setFontSize

  • setFontSize(newFontSize: number): void

  • Sets the value of the property 'Font Size' .

    Parameters

    • newFontSize: number

      Font Size

    Returns void

forceBeforeSeparators Methods

getForceBeforeSeparators

  • getForceBeforeSeparators(): boolean

  • Returns the value of the property 'Force Before Separators' .

    Returns boolean

setForceBeforeSeparators

  • setForceBeforeSeparators(newForceBeforeSeparators: boolean): void

  • Sets the value of the property 'Force Before Separators' .

    Parameters

    • newForceBeforeSeparators: boolean

      Force Before Separators

    Returns void

forceFirstValueLabel Methods

getForceFirstValueLabel

  • getForceFirstValueLabel(): boolean

  • Returns the value of the property 'Force First Value Label' .

    Returns boolean

setForceFirstValueLabel

  • setForceFirstValueLabel(newForceFirstValueLabel: boolean): void

  • Sets the value of the property 'Force First Value Label' .

    Parameters

    • newForceFirstValueLabel: boolean

      Force First Value Label

    Returns void

forceLastValueLabel Methods

getForceLastValueLabel

  • getForceLastValueLabel(): boolean

  • Returns the value of the property 'Force Last Value Label' .

    Returns boolean

setForceLastValueLabel

  • setForceLastValueLabel(newForceLastValueLabel: boolean): void

  • Sets the value of the property 'Force Last Value Label' .

    Parameters

    • newForceLastValueLabel: boolean

      Force Last Value Label

    Returns void

forceMaxValueLabel Methods

getForceMaxValueLabel

  • getForceMaxValueLabel(): boolean

  • Returns the value of the property 'Force Max Value Label' .

    Returns boolean

setForceMaxValueLabel

  • setForceMaxValueLabel(newForceMaxValueLabel: boolean): void

  • Sets the value of the property 'Force Max Value Label' .

    Parameters

    • newForceMaxValueLabel: boolean

      Force Max Value Label

    Returns void

forceMinValueLabel Methods

getForceMinValueLabel

  • getForceMinValueLabel(): boolean

  • Returns the value of the property 'Force Min Value Label' .

    Returns boolean

setForceMinValueLabel

  • setForceMinValueLabel(newForceMinValueLabel: boolean): void

  • Sets the value of the property 'Force Min Value Label' .

    Parameters

    • newForceMinValueLabel: boolean

      Force Min Value Label

    Returns void

forcePeakLabels Methods

getForcePeakLabels

  • getForcePeakLabels(): boolean

  • Returns the value of the property 'Force Peak Labels' .

    Returns boolean

setForcePeakLabels

  • setForcePeakLabels(newForcePeakLabels: boolean): void

  • Sets the value of the property 'Force Peak Labels' .

    Parameters

    • newForcePeakLabels: boolean

      Force Peak Labels

    Returns void

forceTickInterval Methods

getForceTickInterval

  • getForceTickInterval(): boolean

  • Returns the value of the property 'Force Tick Interval' .

    Returns boolean

setForceTickInterval

  • setForceTickInterval(newForceTickInterval: boolean): void

  • Sets the value of the property 'Force Tick Interval' .

    Parameters

    • newForceTickInterval: boolean

      Force Tick Interval

    Returns void

hierarchicalLabelDisplay Methods

getHierarchicalLabelDisplay

  • getHierarchicalLabelDisplay(): boolean

  • Returns the value of the property 'Hierarchical Label Display' .

    Returns boolean

setHierarchicalLabelDisplay

  • setHierarchicalLabelDisplay(newHierarchicalLabelDisplay: boolean): void

  • Sets the value of the property 'Hierarchical Label Display' .

    Parameters

    • newHierarchicalLabelDisplay: boolean

      Hierarchical Label Display

    Returns void

highlightEndIndex Methods

getHighlightEndIndex

  • getHighlightEndIndex(): number

  • Returns the value of the property 'Highlight End Index' .

    Returns number

setHighlightEndIndex

  • setHighlightEndIndex(newHighlightEndIndex: number): void

  • Sets the value of the property 'Highlight End Index' .

    Parameters

    • newHighlightEndIndex: number

      Highlight End Index

    Returns void

highlightEndSeries Methods

getHighlightEndSeries

  • getHighlightEndSeries(): number

  • Returns the value of the property 'Highlight End Series' .

    Returns number

setHighlightEndSeries

  • setHighlightEndSeries(newHighlightEndSeries: number): void

  • Sets the value of the property 'Highlight End Series' .

    Parameters

    • newHighlightEndSeries: number

      Highlight End Series

    Returns void

highlightGroup Methods

getHighlightGroup

  • getHighlightGroup(): boolean

  • Returns the value of the property 'Highlight Group' .

    Returns boolean

setHighlightGroup

  • setHighlightGroup(newHighlightGroup: boolean): void

  • Sets the value of the property 'Highlight Group' .

    Parameters

    • newHighlightGroup: boolean

      Highlight Group

    Returns void

highlightGroupColor Methods

getHighlightGroupColor

  • getHighlightGroupColor(): string

  • Returns the value of the property 'Highlight Group Color' .

    Returns string

setHighlightGroupColor

  • setHighlightGroupColor(newHighlightGroupColor: string): void

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

    Parameters

    • newHighlightGroupColor: string

      Highlight Group Color

    Returns void

highlightGroupMatchMeasures Methods

getHighlightGroupMatchMeasures

  • getHighlightGroupMatchMeasures(): boolean

  • Returns the value of the property 'Highlight Group Match Measures' .

    Returns boolean

setHighlightGroupMatchMeasures

  • setHighlightGroupMatchMeasures(newHighlightGroupMatchMeasures: boolean): void

  • Sets the value of the property 'Highlight Group Match Measures' .

    Parameters

    • newHighlightGroupMatchMeasures: boolean

      Highlight Group Match Measures

    Returns void

highlightLabelAbsolute Methods

getHighlightLabelAbsolute

  • getHighlightLabelAbsolute(): boolean

  • Returns the value of the property 'Highlight Label Absolute' .

    Returns boolean

setHighlightLabelAbsolute

  • setHighlightLabelAbsolute(newHighlightLabelAbsolute: boolean): void

  • Sets the value of the property 'Highlight Label Absolute' .

    Parameters

    • newHighlightLabelAbsolute: boolean

      Highlight Label Absolute

    Returns void

highlightLabelPercentage Methods

getHighlightLabelPercentage

  • getHighlightLabelPercentage(): boolean

  • Returns the value of the property 'Highlight Label Percentage' .

    Returns boolean

setHighlightLabelPercentage

  • setHighlightLabelPercentage(newHighlightLabelPercentage: boolean): void

  • Sets the value of the property 'Highlight Label Percentage' .

    Parameters

    • newHighlightLabelPercentage: boolean

      Highlight Label Percentage

    Returns void

highlightMode Methods

getHighlightMode

  • getHighlightMode(): string

  • Returns the value of the property 'Highlight Mode' .

    Returns string

setHighlightMode

  • setHighlightMode(newHighlightMode: string): void

  • Sets the value of the property 'Highlight Mode' .

    Parameters

    • newHighlightMode: string

      Highlight Mode

    Returns void

highlightStartIndex Methods

getHighlightStartIndex

  • getHighlightStartIndex(): number

  • Returns the value of the property 'Highlight Start Index' .

    Returns number

setHighlightStartIndex

  • setHighlightStartIndex(newHighlightStartIndex: number): void

  • Sets the value of the property 'Highlight Start Index' .

    Parameters

    • newHighlightStartIndex: number

      Highlight Start Index

    Returns void

highlightStartSeries Methods

getHighlightStartSeries

  • getHighlightStartSeries(): number

  • Returns the value of the property 'Highlight Start Series' .

    Returns number

setHighlightStartSeries

  • setHighlightStartSeries(newHighlightStartSeries: number): void

  • Sets the value of the property 'Highlight Start Series' .

    Parameters

    • newHighlightStartSeries: number

      Highlight Start Series

    Returns void

labelPositioningMode Methods

getLabelPositioningMode

  • getLabelPositioningMode(): string

  • Returns the value of the property 'Label Positioning Mode' .

    Returns string

setLabelPositioningMode

  • setLabelPositioningMode(newLabelPositioningMode: string): void

  • Sets the value of the property 'Label Positioning Mode' .

    Parameters

    • newLabelPositioningMode: string

      Label Positioning Mode

    Returns void

labelShadowColor Methods

getLabelShadowColor

  • getLabelShadowColor(): string

  • Returns the value of the property 'Label Shadow Color' .

    Returns string

setLabelShadowColor

  • setLabelShadowColor(newLabelShadowColor: string): void

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

    Parameters

    • newLabelShadowColor: string

      Label Shadow Color

    Returns void

labelShadows Methods

getLabelShadows

  • getLabelShadows(): boolean

  • Returns the value of the property 'Label Shadows' .

    Returns boolean

setLabelShadows

  • setLabelShadows(newLabelShadows: boolean): void

  • Sets the value of the property 'Label Shadows' .

    Parameters

    • newLabelShadows: boolean

      Label Shadows

    Returns void

legendEnabled Methods

getLegendEnabled

  • getLegendEnabled(): boolean

  • Returns the value of the property 'Legend Enabled' .

    Returns boolean

setLegendEnabled

  • setLegendEnabled(newLegendEnabled: boolean): void

  • Sets the value of the property 'Legend Enabled' .

    Parameters

    • newLegendEnabled: boolean

      Legend Enabled

    Returns void

lineBreakAxisLabel Methods

getLineBreakAxisLabel

  • getLineBreakAxisLabel(): string

  • Returns the value of the property 'Line Break Axis Label' .

    Returns string

setLineBreakAxisLabel

  • setLineBreakAxisLabel(newLineBreakAxisLabel: string): void

  • Sets the value of the property 'Line Break Axis Label' .

    Parameters

    • newLineBreakAxisLabel: string

      Line Break Axis Label

    Returns void

lineDotRadiusX Methods

getLineDotRadiusX

  • getLineDotRadiusX(): number

  • Returns the value of the property 'Line Dot Radius X' .

    Returns number

setLineDotRadiusX

  • setLineDotRadiusX(newLineDotRadiusX: number): void

  • Sets the value of the property 'Line Dot Radius X' .

    Parameters

    • newLineDotRadiusX: number

      Line Dot Radius X

    Returns void

lineDotRadiusY Methods

getLineDotRadiusY

  • getLineDotRadiusY(): number

  • Returns the value of the property 'Line Dot Radius Y' .

    Returns number

setLineDotRadiusY

  • setLineDotRadiusY(newLineDotRadiusY: number): void

  • Sets the value of the property 'Line Dot Radius Y' .

    Parameters

    • newLineDotRadiusY: number

      Line Dot Radius Y

    Returns void

manualScaleMax Methods

getManualScaleMax

  • getManualScaleMax(): number

  • Returns the value of the property 'Manual Scale Max' .

    Returns number

setManualScaleMax

  • setManualScaleMax(newManualScaleMax: number): void

  • Sets the value of the property 'Manual Scale Max' .

    Parameters

    • newManualScaleMax: number

      Manual Scale Max

    Returns void

manualScaleMin Methods

getManualScaleMin

  • getManualScaleMin(): number

  • Returns the value of the property 'Manual Scale Min' .

    Returns number

setManualScaleMin

  • setManualScaleMin(newManualScaleMin: number): void

  • Sets the value of the property 'Manual Scale Min' .

    Parameters

    • newManualScaleMin: number

      Manual Scale Min

    Returns void

manualScalePercentMax Methods

getManualScalePercentMax

  • getManualScalePercentMax(): number

  • Returns the value of the property 'Manual Scale Percent Max' .

    Returns number

setManualScalePercentMax

  • setManualScalePercentMax(newManualScalePercentMax: number): void

  • Sets the value of the property 'Manual Scale Percent Max' .

    Parameters

    • newManualScalePercentMax: number

      Manual Scale Percent Max

    Returns void

manualScalePercentMin Methods

getManualScalePercentMin

  • getManualScalePercentMin(): number

  • Returns the value of the property 'Manual Scale Percent Min' .

    Returns number

setManualScalePercentMin

  • setManualScalePercentMin(newManualScalePercentMin: number): void

  • Sets the value of the property 'Manual Scale Percent Min' .

    Parameters

    • newManualScalePercentMin: number

      Manual Scale Percent Min

    Returns void

maxCategoryLabelWidth Methods

getMaxCategoryLabelWidth

  • getMaxCategoryLabelWidth(): number

  • Returns the value of the property 'Max Category Label Width' .

    Returns number

setMaxCategoryLabelWidth

  • setMaxCategoryLabelWidth(newMaxCategoryLabelWidth: number): void

  • Sets the value of the property 'Max Category Label Width' .

    Parameters

    • newMaxCategoryLabelWidth: number

      Max Category Label Width

    Returns void

maxSeriesLabelsWidth Methods

getMaxSeriesLabelsWidth

  • getMaxSeriesLabelsWidth(): number

  • Returns the value of the property 'Max Series Labels Width' .

    Returns number

setMaxSeriesLabelsWidth

  • setMaxSeriesLabelsWidth(newMaxSeriesLabelsWidth: number): void

  • Sets the value of the property 'Max Series Labels Width' .

    Parameters

    • newMaxSeriesLabelsWidth: number

      Max Series Labels Width

    Returns void

minCategoryWidth Methods

getMinCategoryWidth

  • getMinCategoryWidth(): number

  • Returns the value of the property 'Min Category Width' .

    Returns number

setMinCategoryWidth

  • setMinCategoryWidth(newMinCategoryWidth: number): void

  • Sets the value of the property 'Min Category Width' .

    Parameters

    • newMinCategoryWidth: number

      Min Category Width

    Returns void

minimumPeakSize Methods

getMinimumPeakSize

  • getMinimumPeakSize(): number

  • Returns the value of the property 'Minimum Peak Size' .

    Returns number

setMinimumPeakSize

  • setMinimumPeakSize(newMinimumPeakSize: number): void

  • Sets the value of the property 'Minimum Peak Size' .

    Parameters

    • newMinimumPeakSize: number

      Minimum Peak Size

    Returns void

multiHighlights Methods

getMultiHighlightsEndElementByIndex

  • getMultiHighlightsEndElementByIndex(index: number): number

  • Accesses the item of the widget's array property 'Multi Highlights' at the passed index and returns the value of it's property 'End Element. End Element'

    Parameters

    • index: number

      The index of the item whose property 'End Element' should be returned

    Returns number

getMultiHighlightsEndSeriesByIndex

  • getMultiHighlightsEndSeriesByIndex(index: number): number

  • Accesses the item of the widget's array property 'Multi Highlights' at the passed index and returns the value of it's property 'End Series. End Series'

    Parameters

    • index: number

      The index of the item whose property 'End Series' should be returned

    Returns number

getMultiHighlightsJsonString

  • getMultiHighlightsJsonString(): string

  • Returns the value of the property 'Multi Highlights' as a JSON-String.

    Returns string

getMultiHighlightsStartElementByIndex

  • getMultiHighlightsStartElementByIndex(index: number): number

  • Accesses the item of the widget's array property 'Multi Highlights' at the passed index and returns the value of it's property 'Start Element. Start Element'

    Parameters

    • index: number

      The index of the item whose property 'Start Element' should be returned

    Returns number

getMultiHighlightsStartSeriesByIndex

  • getMultiHighlightsStartSeriesByIndex(index: number): number

  • Accesses the item of the widget's array property 'Multi Highlights' at the passed index and returns the value of it's property 'Start Series. Start Series'

    Parameters

    • index: number

      The index of the item whose property 'Start Series' should be returned

    Returns number

setMultiHighlightsEndElementByIndex

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

  • Accesses the item of the widget's array property 'Multi Highlights' at the passed index and assigns the passed new value to it's property 'End Element'

    Parameters

    • newValue: number

      The new value to be assigned to the property 'End Element. End Element'

    • index: number

      The index of the item whose property 'End Element' should be set

    Returns void

setMultiHighlightsEndSeriesByIndex

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

  • Accesses the item of the widget's array property 'Multi Highlights' at the passed index and assigns the passed new value to it's property 'End Series'

    Parameters

    • newValue: number

      The new value to be assigned to the property 'End Series. End Series'

    • index: number

      The index of the item whose property 'End Series' should be set

    Returns void

setMultiHighlightsJsonString

  • setMultiHighlightsJsonString(newMultiHighlights: string): void

  • Sets the value of the property 'Multi Highlights' as a JSON-String.

    Parameters

    • newMultiHighlights: string

      Multi Highlights

    Returns void

setMultiHighlightsStartElementByIndex

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

  • Accesses the item of the widget's array property 'Multi Highlights' at the passed index and assigns the passed new value to it's property 'Start Element'

    Parameters

    • newValue: number

      The new value to be assigned to the property 'Start Element. Start Element'

    • index: number

      The index of the item whose property 'Start Element' should be set

    Returns void

setMultiHighlightsStartSeriesByIndex

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

  • Accesses the item of the widget's array property 'Multi Highlights' at the passed index and assigns the passed new value to it's property 'Start Series'

    Parameters

    • newValue: number

      The new value to be assigned to the property 'Start Series. Start Series'

    • index: number

      The index of the item whose property 'Start Series' should be set

    Returns void

nRest Methods

getNRestAddressSubsetByDescription

  • getNRestAddressSubsetByDescription(description: string): SelectionContext

  • Accesses the item of the widget's array property 'nRest' 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

getNRestAddressSubsetByIndex

  • getNRestAddressSubsetByIndex(index: number): SelectionContext

  • Accesses the item of the widget's array property 'nRest' 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

getNRestDescriptionByIndex

  • getNRestDescriptionByIndex(index: number): string

  • Accesses the item of the widget's array property 'nRest' 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

getNRestEnabledByDescription

  • getNRestEnabledByDescription(description: string): boolean

  • Accesses the item of the widget's array property 'nRest' 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

getNRestEnabledByIndex

  • getNRestEnabledByIndex(index: number): boolean

  • Accesses the item of the widget's array property 'nRest' 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

getNRestJsonString

  • getNRestJsonString(): string

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

    Returns string

getNRestMemberNameByDescription

  • getNRestMemberNameByDescription(description: string): string

  • Accesses the item of the widget's array property 'nRest' 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

getNRestMemberNameByIndex

  • getNRestMemberNameByIndex(index: number): string

  • Accesses the item of the widget's array property 'nRest' 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

getNRestModeByDescription

  • getNRestModeByDescription(description: string): string

  • Accesses the item of the widget's array property 'nRest' 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

getNRestModeByIndex

  • getNRestModeByIndex(index: number): string

  • Accesses the item of the widget's array property 'nRest' 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

getNRestNByDescription

  • getNRestNByDescription(description: string): number

  • Accesses the item of the widget's array property 'nRest' 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

getNRestNByIndex

  • getNRestNByIndex(index: number): number

  • Accesses the item of the widget's array property 'nRest' 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

getNRestTargetDimensionByDescription

  • getNRestTargetDimensionByDescription(description: string): string

  • Accesses the item of the widget's array property 'nRest' 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

getNRestTargetDimensionByIndex

  • getNRestTargetDimensionByIndex(index: number): string

  • Accesses the item of the widget's array property 'nRest' 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

setNRestAddressSubsetByDescription

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

  • Accesses the item of the widget's array property 'nRest' 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

setNRestAddressSubsetByIndex

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

  • Accesses the item of the widget's array property 'nRest' 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

setNRestDescriptionByDescription

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

  • Accesses the item of the widget's array property 'nRest' 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

setNRestDescriptionByIndex

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

  • Accesses the item of the widget's array property 'nRest' 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

setNRestEnabledByDescription

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

  • Accesses the item of the widget's array property 'nRest' 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

setNRestEnabledByIndex

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

  • Accesses the item of the widget's array property 'nRest' 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

setNRestJsonString

  • setNRestJsonString(newNRest: string): void

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

    Parameters

    • newNRest: string

      NRest

    Returns void

setNRestMemberNameByDescription

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

  • Accesses the item of the widget's array property 'nRest' 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

setNRestMemberNameByIndex

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

  • Accesses the item of the widget's array property 'nRest' 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

setNRestModeByDescription

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

  • Accesses the item of the widget's array property 'nRest' 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

setNRestModeByIndex

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

  • Accesses the item of the widget's array property 'nRest' 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

setNRestNByDescription

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

  • Accesses the item of the widget's array property 'nRest' 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

setNRestNByIndex

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

  • Accesses the item of the widget's array property 'nRest' 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

setNRestTargetDimensionByDescription

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

  • Accesses the item of the widget's array property 'nRest' 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

setNRestTargetDimensionByIndex

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

  • Accesses the item of the widget's array property 'nRest' 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

negativeDeviationIsGood Methods

getNegativeDeviationIsGood

  • getNegativeDeviationIsGood(): boolean

  • Returns the value of the property 'Negative Deviation Is Good' .

    Returns boolean

setNegativeDeviationIsGood

  • setNegativeDeviationIsGood(newNegativeDeviationIsGood: boolean): void

  • Sets the value of the property 'Negative Deviation Is Good' .

    Parameters

    • newNegativeDeviationIsGood: boolean

      Negative Deviation Is Good

    Returns void

negativeOutlierThreshold Methods

getNegativeOutlierThreshold

  • getNegativeOutlierThreshold(): number

  • Returns the value of the property 'Negative Outlier Threshold' .

    Returns number

setNegativeOutlierThreshold

  • setNegativeOutlierThreshold(newNegativeOutlierThreshold: number): void

  • Sets the value of the property 'Negative Outlier Threshold' .

    Parameters

    • newNegativeOutlierThreshold: number

      Negative Outlier Threshold

    Returns void

negativeOutlierThresholdPercent Methods

getNegativeOutlierThresholdPercent

  • getNegativeOutlierThresholdPercent(): number

  • Returns the value of the property 'Negative Outlier Threshold Percent' .

    Returns number

setNegativeOutlierThresholdPercent

  • setNegativeOutlierThresholdPercent(newNegativeOutlierThresholdPercent: number): void

  • Sets the value of the property 'Negative Outlier Threshold Percent' .

    Parameters

    • newNegativeOutlierThresholdPercent: number

      Negative Outlier Threshold Percent

    Returns void

offsetPerSeries Methods

getOffsetPerSeries

  • getOffsetPerSeries(): number[]

  • Returns the value of the property 'Offset Per Series.

    Returns number[]

getOffsetPerSeriesJsonString

  • getOffsetPerSeriesJsonString(): string

  • Returns the value of the property 'Offset Per Series' as a JSON-String.

    Returns string

setOffsetPerSeries

  • setOffsetPerSeries(newValue: number[]): void

  • Sets the value of the property 'Offset Per Series'

    Parameters

    • newValue: number[]

      The new value of property 'Offset Per Series. '

    Returns void

setOffsetPerSeriesJsonString

  • setOffsetPerSeriesJsonString(newOffsetPerSeries: string): void

  • Sets the value of the property 'Offset Per Series' as a JSON-String.

    Parameters

    • newOffsetPerSeries: string

      Offset Per Series

    Returns void

offsetbarDeviationLabelsOnTop Methods

getOffsetbarDeviationLabelsOnTop

  • getOffsetbarDeviationLabelsOnTop(): boolean

  • Returns the value of the property 'Offsetbar Deviation Labels On Top' .

    Returns boolean

setOffsetbarDeviationLabelsOnTop

  • setOffsetbarDeviationLabelsOnTop(newOffsetbarDeviationLabelsOnTop: boolean): void

  • Sets the value of the property 'Offsetbar Deviation Labels On Top' .

    Parameters

    • newOffsetbarDeviationLabelsOnTop: boolean

      Offsetbar Deviation Labels On Top

    Returns void

offsetbarLabelsOnTop Methods

getOffsetbarLabelsOnTop

  • getOffsetbarLabelsOnTop(): boolean

  • Returns the value of the property 'Offsetbar Labels On Top' .

    Returns boolean

setOffsetbarLabelsOnTop

  • setOffsetbarLabelsOnTop(newOffsetbarLabelsOnTop: boolean): void

  • Sets the value of the property 'Offsetbar Labels On Top' .

    Parameters

    • newOffsetbarLabelsOnTop: boolean

      Offsetbar Labels On Top

    Returns void

outlierMode Methods

getOutlierMode

  • getOutlierMode(): string

  • Returns the value of the property 'Outlier Mode' .

    Returns string

setOutlierMode

  • setOutlierMode(newOutlierMode: string): void

  • Sets the value of the property 'Outlier Mode' .

    Parameters

    • newOutlierMode: string

      Outlier Mode

    Returns void

outlierSize Methods

getOutlierSize

  • getOutlierSize(): number

  • Returns the value of the property 'Outlier Size' .

    Returns number

setOutlierSize

  • setOutlierSize(newOutlierSize: number): void

  • Sets the value of the property 'Outlier Size' .

    Parameters

    • newOutlierSize: number

      Outlier Size

    Returns void

padding Methods

getPadding

  • getPadding(): number

  • Returns the value of the property 'Padding' .

    Returns number

setPadding

  • setPadding(newPadding: number): void

  • Sets the value of the property 'Padding' .

    Parameters

    • newPadding: number

      Padding

    Returns void

pickLabels Methods

getPickLabels

  • getPickLabels(): boolean

  • Returns the value of the property 'Pick Labels' .

    Returns boolean

setPickLabels

  • setPickLabels(newPickLabels: boolean): void

  • Sets the value of the property 'Pick Labels' .

    Parameters

    • newPickLabels: boolean

      Pick Labels

    Returns void

pinHeadColor Methods

getPinHeadColor

  • getPinHeadColor(): string

  • Returns the value of the property 'Pin Head Color' .

    Returns string

setPinHeadColor

  • setPinHeadColor(newPinHeadColor: string): void

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

    Parameters

    • newPinHeadColor: string

      Pin Head Color

    Returns void

pinHeadMode Methods

getPinHeadMode

  • getPinHeadMode(): string

  • Returns the value of the property 'Pin Head Mode' .

    Returns string

setPinHeadMode

  • setPinHeadMode(newPinHeadMode: string): void

  • Sets the value of the property 'Pin Head Mode' .

    Parameters

    • newPinHeadMode: string

      Pin Head Mode

    Returns void

pinHeadRadiusX Methods

getPinHeadRadiusX

  • getPinHeadRadiusX(): number

  • Returns the value of the property 'Pin Head Radius X' .

    Returns number

setPinHeadRadiusX

  • setPinHeadRadiusX(newPinHeadRadiusX: number): void

  • Sets the value of the property 'Pin Head Radius X' .

    Parameters

    • newPinHeadRadiusX: number

      Pin Head Radius X

    Returns void

pinHeadRadiusY Methods

getPinHeadRadiusY

  • getPinHeadRadiusY(): number

  • Returns the value of the property 'Pin Head Radius Y' .

    Returns number

setPinHeadRadiusY

  • setPinHeadRadiusY(newPinHeadRadiusY: number): void

  • Sets the value of the property 'Pin Head Radius Y' .

    Parameters

    • newPinHeadRadiusY: number

      Pin Head Radius Y

    Returns void

pinHeadShape Methods

getPinHeadShape

  • getPinHeadShape(): string

  • Returns the value of the property 'Pin Head Shape' .

    Returns string

setPinHeadShape

  • setPinHeadShape(newPinHeadShape: string): void

  • Sets the value of the property 'Pin Head Shape' .

    Parameters

    • newPinHeadShape: string

      Pin Head Shape

    Returns void

pinWidth Methods

getPinWidth

  • getPinWidth(): number

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

    Returns number

setPinWidth

  • setPinWidth(newPinWidth: number): void

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

    Parameters

    • newPinWidth: number

      Pin Width

    Returns void

positiveOutlierThreshold Methods

getPositiveOutlierThreshold

  • getPositiveOutlierThreshold(): number

  • Returns the value of the property 'Positive Outlier Threshold' .

    Returns number

setPositiveOutlierThreshold

  • setPositiveOutlierThreshold(newPositiveOutlierThreshold: number): void

  • Sets the value of the property 'Positive Outlier Threshold' .

    Parameters

    • newPositiveOutlierThreshold: number

      Positive Outlier Threshold

    Returns void

positiveOutlierThresholdPercent Methods

getPositiveOutlierThresholdPercent

  • getPositiveOutlierThresholdPercent(): number

  • Returns the value of the property 'Positive Outlier Threshold Percent' .

    Returns number

setPositiveOutlierThresholdPercent

  • setPositiveOutlierThresholdPercent(newPositiveOutlierThresholdPercent: number): void

  • Sets the value of the property 'Positive Outlier Threshold Percent' .

    Parameters

    • newPositiveOutlierThresholdPercent: number

      Positive Outlier Threshold Percent

    Returns void

rotated Methods

getRotated

  • getRotated(): boolean

  • Returns the value of the property 'Rotated' .

    Returns boolean

setRotated

  • setRotated(newRotated: boolean): void

  • Sets the value of the property 'Rotated' .

    Parameters

    • newRotated: boolean

      Rotated

    Returns void

scaleMode Methods

getScaleMode

  • getScaleMode(): string

  • Returns the value of the property 'Scale Mode' .

    Returns string

setScaleMode

  • setScaleMode(newScaleMode: string): void

  • Sets the value of the property 'Scale Mode' .

    Parameters

    • newScaleMode: string

      Scale Mode

    Returns void

scalingHelper Methods

getScalingHelper

  • getScalingHelper(): string

  • Returns the value of the property 'Scaling Helper' .

    Returns string

setScalingHelper

  • setScalingHelper(newScalingHelper: string): void

  • Sets the value of the property 'Scaling Helper' .

    Parameters

    • newScalingHelper: string

      Scaling Helper

    Returns void

scalingHelperAreaColor Methods

getScalingHelperAreaColor

  • getScalingHelperAreaColor(): string

  • Returns the value of the property 'Scaling Helper Area Color' .

    Returns string

setScalingHelperAreaColor

  • setScalingHelperAreaColor(newScalingHelperAreaColor: string): void

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

    Parameters

    • newScalingHelperAreaColor: string

      Scaling Helper Area Color

    Returns void

scalingHelperBarColor Methods

getScalingHelperBarColor

  • getScalingHelperBarColor(): string

  • Returns the value of the property 'Scaling Helper Bar Color' .

    Returns string

setScalingHelperBarColor

  • setScalingHelperBarColor(newScalingHelperBarColor: string): void

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

    Parameters

    • newScalingHelperBarColor: string

      Scaling Helper Bar Color

    Returns void

scalingHelperBarLineWidth Methods

getScalingHelperBarLineWidth

  • getScalingHelperBarLineWidth(): number

  • Returns the value of the property 'Scaling Helper Bar Line Width' .

    Returns number

setScalingHelperBarLineWidth

  • setScalingHelperBarLineWidth(newScalingHelperBarLineWidth: number): void

  • Sets the value of the property 'Scaling Helper Bar Line Width' .

    Parameters

    • newScalingHelperBarLineWidth: number

      Scaling Helper Bar Line Width

    Returns void

scalingHelperValue Methods

getScalingHelperValue

  • getScalingHelperValue(): number

  • Returns the value of the property 'Scaling Helper Value' .

    Returns number

setScalingHelperValue

  • setScalingHelperValue(newScalingHelperValue: number): void

  • Sets the value of the property 'Scaling Helper Value' .

    Parameters

    • newScalingHelperValue: number

      Scaling Helper Value

    Returns void

scenarioAssignment Methods

getScenarioAssignmentAddressSubsetByDescription

  • getScenarioAssignmentAddressSubsetByDescription(description: string): SelectionContext

  • Accesses the item of the widget's array property 'Scenarios By Dataselection' 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 'Scenarios By Dataselection' 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 'Scenarios By Dataselection' 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

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 'Scenarios By Dataselection' 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 'Scenarios By Dataselection' 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 'Scenarios By Dataselection' 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 'Scenarios By Dataselection' 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 'Scenarios By Dataselection' 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 'Scenarios By Dataselection' 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

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 'Scenarios By Dataselection' 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 'Scenarios By Dataselection' 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

scenariosBySeries Methods

getScenariosBySeries

  • getScenariosBySeries(): string[]

  • Returns the value of the property 'Scenarios by Series.

    Returns string[]

getScenariosBySeriesJsonString

  • getScenariosBySeriesJsonString(): string

  • Returns the value of the property 'Scenarios By Series' as a JSON-String.

    Returns string

setScenariosBySeries

  • setScenariosBySeries(newValue: string[]): void

  • Sets the value of the property 'Scenarios by Series'

    Parameters

    • newValue: string[]

      The new value of property 'Scenarios by Series. '

    Returns void

setScenariosBySeriesJsonString

  • setScenariosBySeriesJsonString(newScenariosBySeries: string): void

  • Sets the value of the property 'Scenarios By Series' as a JSON-String.

    Parameters

    • newScenariosBySeries: string

      Scenarios By Series

    Returns void

scenariosInDeviations Methods

getScenariosInDeviations

  • getScenariosInDeviations(): boolean

  • Returns the value of the property 'Scenarios In Deviations' .

    Returns boolean

setScenariosInDeviations

  • setScenariosInDeviations(newScenariosInDeviations: boolean): void

  • Sets the value of the property 'Scenarios In Deviations' .

    Parameters

    • newScenariosInDeviations: boolean

      Scenarios In Deviations

    Returns void

separatorColor Methods

getSeparatorColor

  • getSeparatorColor(): string

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

    Returns string

setSeparatorColor

  • setSeparatorColor(newSeparatorColor: string): void

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

    Parameters

    • newSeparatorColor: string

      Separator Color

    Returns void

separatorLength Methods

getSeparatorLength

  • getSeparatorLength(): number

  • Returns the value of the property 'Separator Length' .

    Returns number

setSeparatorLength

  • setSeparatorLength(newSeparatorLength: number): void

  • Sets the value of the property 'Separator Length' .

    Parameters

    • newSeparatorLength: number

      Separator Length

    Returns void

separatorMode Methods

getSeparatorMode

  • getSeparatorMode(): string

  • Returns the value of the property 'Separator Mode' .

    Returns string

setSeparatorMode

  • setSeparatorMode(newSeparatorMode: string): void

  • Sets the value of the property 'Separator Mode' .

    Parameters

    • newSeparatorMode: string

      Separator Mode

    Returns void

separatorPositions Methods

getSeparatorPositions

  • getSeparatorPositions(): number[]

  • Returns the value of the property 'Manual Separator Positions.

    Returns number[]

getSeparatorPositionsJsonString

  • getSeparatorPositionsJsonString(): string

  • Returns the value of the property 'Separator Positions' as a JSON-String.

    Returns string

setSeparatorPositions

  • setSeparatorPositions(newValue: number[]): void

  • Sets the value of the property 'Manual Separator Positions'

    Parameters

    • newValue: number[]

      The new value of property 'Manual Separator Positions. '

    Returns void

setSeparatorPositionsJsonString

  • setSeparatorPositionsJsonString(newSeparatorPositions: string): void

  • Sets the value of the property 'Separator Positions' as a JSON-String.

    Parameters

    • newSeparatorPositions: string

      Separator Positions

    Returns void

separatorSourceRowIndex Methods

getSeparatorSourceRowIndex

  • getSeparatorSourceRowIndex(): number

  • Returns the value of the property 'Separator Source Row Index' .

    Returns number

setSeparatorSourceRowIndex

  • setSeparatorSourceRowIndex(newSeparatorSourceRowIndex: number): void

  • Sets the value of the property 'Separator Source Row Index' .

    Parameters

    • newSeparatorSourceRowIndex: number

      Separator Source Row Index

    Returns void

separatorThickness Methods

getSeparatorThickness

  • getSeparatorThickness(): number

  • Returns the value of the property 'Separator Thickness' .

    Returns number

setSeparatorThickness

  • setSeparatorThickness(newSeparatorThickness: number): void

  • Sets the value of the property 'Separator Thickness' .

    Parameters

    • newSeparatorThickness: number

      Separator Thickness

    Returns void

separatorsInFront Methods

getSeparatorsInFront

  • getSeparatorsInFront(): boolean

  • Returns the value of the property 'Separators In Front' .

    Returns boolean

setSeparatorsInFront

  • setSeparatorsInFront(newSeparatorsInFront: boolean): void

  • Sets the value of the property 'Separators In Front' .

    Parameters

    • newSeparatorsInFront: boolean

      Separators In Front

    Returns void

seriesLabels Methods

getSeriesLabels

  • getSeriesLabels(): string[]

  • Returns the value of the property 'seriesLabels.

    Returns string[]

getSeriesLabelsJsonString

  • getSeriesLabelsJsonString(): string

  • Returns the value of the property 'Series Labels' as a JSON-String.

    Returns string

setSeriesLabels

  • setSeriesLabels(newValue: string[]): void

  • Sets the value of the property 'seriesLabels'

    Parameters

    • newValue: string[]

      The new value of property 'seriesLabels. '

    Returns void

setSeriesLabelsJsonString

  • setSeriesLabelsJsonString(newSeriesLabels: string): void

  • Sets the value of the property 'Series Labels' as a JSON-String.

    Parameters

    • newSeriesLabels: string

      Series Labels

    Returns void

seriesStyles Methods

getSeriesStylesBarwidthByIndex

  • getSeriesStylesBarwidthByIndex(index: number): number

  • Accesses the item of the widget's array property 'Styles' at the passed index and returns the value of it's property 'Width. Series Style Barwidth'

    Parameters

    • index: number

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

    Returns number

getSeriesStylesColorByIndex

  • getSeriesStylesColorByIndex(index: number): string

  • Accesses the item of the widget's array property 'Styles' at the passed index and returns the value of it's property 'Color. Series Style Color'

    Parameters

    • index: number

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

    Returns string

getSeriesStylesFilltypeByIndex

  • getSeriesStylesFilltypeByIndex(index: number): string

  • Accesses the item of the widget's array property 'Styles' at the passed index and returns the value of it's property 'Fill Type. Series Style Filltype'

    Parameters

    • index: number

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

    Returns string

getSeriesStylesFontweightByIndex

  • getSeriesStylesFontweightByIndex(index: number): string

  • Accesses the item of the widget's array property 'Styles' at the passed index and returns the value of it's property 'Font Weight. Series Style Fontweight'

    Parameters

    • index: number

      The index of the item whose property 'Font Weight' should be returned

    Returns string

getSeriesStylesJsonString

  • getSeriesStylesJsonString(): string

  • Returns the value of the property 'Series Styles' as a JSON-String.

    Returns string

getSeriesStylesPinwidthByIndex

  • getSeriesStylesPinwidthByIndex(index: number): number

  • Accesses the item of the widget's array property 'Styles' at the passed index and returns the value of it's property 'Pinwidth. Series Style Pinwidth'

    Parameters

    • index: number

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

    Returns number

getSeriesStylesShapeByIndex

  • getSeriesStylesShapeByIndex(index: number): string

  • Accesses the item of the widget's array property 'Styles' at the passed index and returns the value of it's property 'Shape. Series Style Shape'

    Parameters

    • index: number

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

    Returns string

getSeriesStylesShortByIndex

  • getSeriesStylesShortByIndex(index: number): string

  • Accesses the item of the widget's array property 'Styles' at the passed index and returns the value of it's property 'Label. Series Style Label'

    Parameters

    • index: number

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

    Returns string

getSeriesStylesThicknessByIndex

  • getSeriesStylesThicknessByIndex(index: number): number

  • Accesses the item of the widget's array property 'Styles' at the passed index and returns the value of it's property 'Thickness. Series Style Thickness'

    Parameters

    • index: number

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

    Returns number

setSeriesStylesBarwidthByIndex

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

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

    Parameters

    • newValue: number

      The new value to be assigned to the property 'Width. Series Style Barwidth'

    • index: number

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

    Returns void

setSeriesStylesColorByIndex

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

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

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Color. Series Style Color'

    • index: number

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

    Returns void

setSeriesStylesFilltypeByIndex

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

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

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Fill Type. Series Style Filltype'

    • index: number

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

    Returns void

setSeriesStylesFontweightByIndex

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

  • Accesses the item of the widget's array property 'Styles' at the passed index and assigns the passed new value to it's property 'Font Weight'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Font Weight. Series Style Fontweight'

    • index: number

      The index of the item whose property 'Font Weight' should be set

    Returns void

setSeriesStylesJsonString

  • setSeriesStylesJsonString(newSeriesStyles: string): void

  • Sets the value of the property 'Series Styles' as a JSON-String.

    Parameters

    • newSeriesStyles: string

      Series Styles

    Returns void

setSeriesStylesPinwidthByIndex

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

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

    Parameters

    • newValue: number

      The new value to be assigned to the property 'Pinwidth. Series Style Pinwidth'

    • index: number

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

    Returns void

setSeriesStylesShapeByIndex

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

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

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Shape. Series Style Shape'

    • index: number

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

    Returns void

setSeriesStylesShortByIndex

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

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

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Label. Series Style Label'

    • index: number

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

    Returns void

setSeriesStylesThicknessByIndex

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

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

    Parameters

    • newValue: number

      The new value to be assigned to the property 'Thickness. Series Style Thickness'

    • index: number

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

    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

showAxisLabelsLeft Methods

getShowAxisLabelsLeft

  • getShowAxisLabelsLeft(): boolean

  • Returns the value of the property 'Show Axis Labels Left' .

    Returns boolean

setShowAxisLabelsLeft

  • setShowAxisLabelsLeft(newShowAxisLabelsLeft: boolean): void

  • Sets the value of the property 'Show Axis Labels Left' .

    Parameters

    • newShowAxisLabelsLeft: boolean

      Show Axis Labels Left

    Returns void

showAxisLabelsRight Methods

getShowAxisLabelsRight

  • getShowAxisLabelsRight(): boolean

  • Returns the value of the property 'Show Axis Labels Right' .

    Returns boolean

setShowAxisLabelsRight

  • setShowAxisLabelsRight(newShowAxisLabelsRight: boolean): void

  • Sets the value of the property 'Show Axis Labels Right' .

    Parameters

    • newShowAxisLabelsRight: boolean

      Show Axis Labels Right

    Returns void

showBaseChart Methods

getShowBaseChart

  • getShowBaseChart(): boolean

  • Returns the value of the property 'Show Base Chart' .

    Returns boolean

setShowBaseChart

  • setShowBaseChart(newShowBaseChart: boolean): void

  • Sets the value of the property 'Show Base Chart' .

    Parameters

    • newShowBaseChart: boolean

      Show Base Chart

    Returns void

showCategoryAxis Methods

getShowCategoryAxis

  • getShowCategoryAxis(): boolean

  • Returns the value of the property 'Show Category Axis' .

    Returns boolean

setShowCategoryAxis

  • setShowCategoryAxis(newShowCategoryAxis: boolean): void

  • Sets the value of the property 'Show Category Axis' .

    Parameters

    • newShowCategoryAxis: boolean

      Show Category Axis

    Returns void

showCategoryLabels Methods

getShowCategoryLabels

  • getShowCategoryLabels(): boolean

  • Returns the value of the property 'Show Category Labels' .

    Returns boolean

setShowCategoryLabels

  • setShowCategoryLabels(newShowCategoryLabels: boolean): void

  • Sets the value of the property 'Show Category Labels' .

    Parameters

    • newShowCategoryLabels: boolean

      Show Category Labels

    Returns void

showDatatypesInAxis Methods

getShowDatatypesInAxis

  • getShowDatatypesInAxis(): boolean

  • Returns the value of the property 'Show Datatypes In Axis' .

    Returns boolean

setShowDatatypesInAxis

  • setShowDatatypesInAxis(newShowDatatypesInAxis: boolean): void

  • Sets the value of the property 'Show Datatypes In Axis' .

    Parameters

    • newShowDatatypesInAxis: boolean

      Show Datatypes In Axis

    Returns void

showOffsetsOnLeft Methods

getShowOffsetsOnLeft

  • getShowOffsetsOnLeft(): boolean

  • Returns the value of the property 'Show Offsets On Left' .

    Returns boolean

setShowOffsetsOnLeft

  • setShowOffsetsOnLeft(newShowOffsetsOnLeft: boolean): void

  • Sets the value of the property 'Show Offsets On Left' .

    Parameters

    • newShowOffsetsOnLeft: boolean

      Show Offsets On Left

    Returns void

showPinHeadColor Methods

getShowPinHeadColor

  • getShowPinHeadColor(): boolean

  • Returns the value of the property 'Show Pin Head Color' .

    Returns boolean

setShowPinHeadColor

  • setShowPinHeadColor(newShowPinHeadColor: boolean): void

  • Sets the value of the property 'Show Pin Head Color' .

    Parameters

    • newShowPinHeadColor: boolean

      Show Pin Head Color

    Returns void

showSeriesLabelsLeft Methods

getShowSeriesLabelsLeft

  • getShowSeriesLabelsLeft(): boolean

  • Returns the value of the property 'Show Series Labels Left' .

    Returns boolean

setShowSeriesLabelsLeft

  • setShowSeriesLabelsLeft(newShowSeriesLabelsLeft: boolean): void

  • Sets the value of the property 'Show Series Labels Left' .

    Parameters

    • newShowSeriesLabelsLeft: boolean

      Show Series Labels Left

    Returns void

showSeriesLabelsRight Methods

getShowSeriesLabelsRight

  • getShowSeriesLabelsRight(): boolean

  • Returns the value of the property 'Show Series Labels Right' .

    Returns boolean

setShowSeriesLabelsRight

  • setShowSeriesLabelsRight(newShowSeriesLabelsRight: boolean): void

  • Sets the value of the property 'Show Series Labels Right' .

    Parameters

    • newShowSeriesLabelsRight: boolean

      Show Series Labels Right

    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

showTooltips Methods

getShowTooltips

  • getShowTooltips(): boolean

  • Returns the value of the property 'Show Tooltips' .

    Returns boolean

setShowTooltips

  • setShowTooltips(newShowTooltips: boolean): void

  • Sets the value of the property 'Show Tooltips' .

    Parameters

    • newShowTooltips: boolean

      Show Tooltips

    Returns void

showValueAxis Methods

getShowValueAxis

  • getShowValueAxis(): boolean

  • Returns the value of the property 'Show Value Axis' .

    Returns boolean

setShowValueAxis

  • setShowValueAxis(newShowValueAxis: boolean): void

  • Sets the value of the property 'Show Value Axis' .

    Parameters

    • newShowValueAxis: boolean

      Show Value Axis

    Returns void

smallMultiplesDimension Methods

getSmallMultiplesDimension

  • getSmallMultiplesDimension(): string

  • Returns the value of the property 'Small Multiples Dimension' .

    Returns string

setSmallMultiplesDimension

  • setSmallMultiplesDimension(newSmallMultiplesDimension: string): void

  • Sets the value of the property 'Small Multiples Dimension' .

    Parameters

    • newSmallMultiplesDimension: string

      Small Multiples Dimension

    Returns void

smallMultiplesMinHeight Methods

getSmallMultiplesMinHeight

  • getSmallMultiplesMinHeight(): number

  • Returns the value of the property 'Small Multiples Min Height' .

    Returns number

setSmallMultiplesMinHeight

  • setSmallMultiplesMinHeight(newSmallMultiplesMinHeight: number): void

  • Sets the value of the property 'Small Multiples Min Height' .

    Parameters

    • newSmallMultiplesMinHeight: number

      Small Multiples Min Height

    Returns void

smallMultiplesMinWidth Methods

getSmallMultiplesMinWidth

  • getSmallMultiplesMinWidth(): number

  • Returns the value of the property 'Small Multiples Min Width' .

    Returns number

setSmallMultiplesMinWidth

  • setSmallMultiplesMinWidth(newSmallMultiplesMinWidth: number): void

  • Sets the value of the property 'Small Multiples Min Width' .

    Parameters

    • newSmallMultiplesMinWidth: number

      Small Multiples Min Width

    Returns void

smallMultiplesNCount Methods

getSmallMultiplesNCount

  • getSmallMultiplesNCount(): string

  • Returns the value of the property 'Small Multiples NCount' .

    Returns string

setSmallMultiplesNCount

  • setSmallMultiplesNCount(newSmallMultiplesNCount: string): void

  • Sets the value of the property 'Small Multiples NCount' .

    Parameters

    • newSmallMultiplesNCount: string

      Small Multiples NCount

    Returns void

spaceFactorBaseChart Methods

getSpaceFactorBaseChart

  • getSpaceFactorBaseChart(): number

  • Returns the value of the property 'Space Factor Base Chart' .

    Returns number

setSpaceFactorBaseChart

  • setSpaceFactorBaseChart(newSpaceFactorBaseChart: number): void

  • Sets the value of the property 'Space Factor Base Chart' .

    Parameters

    • newSpaceFactorBaseChart: number

      Space Factor Base Chart

    Returns void

spaceFactorDeviationChart Methods

getSpaceFactorDeviationChart

  • getSpaceFactorDeviationChart(): number

  • Returns the value of the property 'Space Factor Deviation Chart' .

    Returns number

setSpaceFactorDeviationChart

  • setSpaceFactorDeviationChart(newSpaceFactorDeviationChart: number): void

  • Sets the value of the property 'Space Factor Deviation Chart' .

    Parameters

    • newSpaceFactorDeviationChart: number

      Space Factor Deviation Chart

    Returns void

spacing Methods

getSpacing

  • getSpacing(): number

  • Returns the value of the property 'Spacing' .

    Returns number

setSpacing

  • setSpacing(newSpacing: number): void

  • Sets the value of the property 'Spacing' .

    Parameters

    • newSpacing: number

      Spacing

    Returns void

splitSignForCategoryLabels Methods

getSplitSignForCategoryLabels

  • getSplitSignForCategoryLabels(): string

  • Returns the value of the property 'Split Sign For Category Labels' .

    Returns string

setSplitSignForCategoryLabels

  • setSplitSignForCategoryLabels(newSplitSignForCategoryLabels: string): void

  • Sets the value of the property 'Split Sign For Category Labels' .

    Parameters

    • newSplitSignForCategoryLabels: string

      Split Sign For Category Labels

    Returns void

stackedBarLabelPosition Methods

getStackedBarLabelPosition

  • getStackedBarLabelPosition(): string

  • Returns the value of the property 'Stacked Bar Label Position' .

    Returns string

setStackedBarLabelPosition

  • setStackedBarLabelPosition(newStackedBarLabelPosition: string): void

  • Sets the value of the property 'Stacked Bar Label Position' .

    Parameters

    • newStackedBarLabelPosition: string

      Stacked Bar Label Position

    Returns void

stackedBarMode Methods

getStackedBarMode

  • getStackedBarMode(): string

  • Returns the value of the property 'Stacked Bar Mode' .

    Returns string

setStackedBarMode

  • setStackedBarMode(newStackedBarMode: string): void

  • Sets the value of the property 'Stacked Bar Mode' .

    Parameters

    • newStackedBarMode: string

      Stacked Bar Mode

    Returns void

stackedBarSumsVisible Methods

getStackedBarSumsVisible

  • getStackedBarSumsVisible(): boolean

  • Returns the value of the property 'Stacked Bar Sums Visible' .

    Returns boolean

setStackedBarSumsVisible

  • setStackedBarSumsVisible(newStackedBarSumsVisible: boolean): void

  • Sets the value of the property 'Stacked Bar Sums Visible' .

    Parameters

    • newStackedBarSumsVisible: boolean

      Stacked Bar Sums Visible

    Returns void

suppressRepeatingCategoryLabels Methods

getSuppressRepeatingCategoryLabels

  • getSuppressRepeatingCategoryLabels(): boolean[]

  • Returns the value of the property 'Suppress Repetition.

    Returns boolean[]

getSuppressRepeatingCategoryLabelsJsonString

  • getSuppressRepeatingCategoryLabelsJsonString(): string

  • Returns the value of the property 'Suppress Repeating Category Labels' as a JSON-String.

    Returns string

setSuppressRepeatingCategoryLabels

  • setSuppressRepeatingCategoryLabels(newValue: boolean[]): void

  • Sets the value of the property 'Suppress Repetition'

    Parameters

    • newValue: boolean[]

      The new value of property 'Suppress Repetition. '

    Returns void

setSuppressRepeatingCategoryLabelsJsonString

  • setSuppressRepeatingCategoryLabelsJsonString(newSuppressRepeatingCategoryLabels: string): void

  • Sets the value of the property 'Suppress Repeating Category Labels' as a JSON-String.

    Parameters

    • newSuppressRepeatingCategoryLabels: string

      Suppress Repeating Category Labels

    Returns void

synchronizeAxesPosition Methods

getSynchronizeAxesPosition

  • getSynchronizeAxesPosition(): boolean

  • Returns the value of the property 'Synchronize Axes Position' .

    Returns boolean

setSynchronizeAxesPosition

  • setSynchronizeAxesPosition(newSynchronizeAxesPosition: boolean): void

  • Sets the value of the property 'Synchronize Axes Position' .

    Parameters

    • newSynchronizeAxesPosition: boolean

      Synchronize Axes Position

    Returns void

synchronizePadding Methods

getSynchronizePadding

  • getSynchronizePadding(): boolean

  • Returns the value of the property 'Synchronize Padding' .

    Returns boolean

setSynchronizePadding

  • setSynchronizePadding(newSynchronizePadding: boolean): void

  • Sets the value of the property 'Synchronize Padding' .

    Parameters

    • newSynchronizePadding: boolean

      Synchronize Padding

    Returns void

synchronizeScaling Methods

getSynchronizeScaling

  • getSynchronizeScaling(): boolean

  • Returns the value of the property 'Synchronize Scaling' .

    Returns boolean

setSynchronizeScaling

  • setSynchronizeScaling(newSynchronizeScaling: boolean): void

  • Sets the value of the property 'Synchronize Scaling' .

    Parameters

    • newSynchronizeScaling: boolean

      Synchronize Scaling

    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

thresholdLinesConfig Methods

getThresholdLinesConfigBaseByIndex

  • getThresholdLinesConfigBaseByIndex(index: number): number

  • Accesses the item of the widget's array property 'Configuration' at the passed index and returns the value of it's property 'Line Base. Threshold: Line Base, Other: Index of Baseseries'

    Parameters

    • index: number

      The index of the item whose property 'Line Base' should be returned

    Returns number

getThresholdLinesConfigColorByIndex

  • getThresholdLinesConfigColorByIndex(index: number): string

  • Accesses the item of the widget's array property 'Configuration' at the passed index and returns the value of it's property 'Line Color. Line Color'

    Parameters

    • index: number

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

    Returns string

getThresholdLinesConfigJsonString

  • getThresholdLinesConfigJsonString(): string

  • Returns the value of the property 'Threshold Lines Config' as a JSON-String.

    Returns string

getThresholdLinesConfigLabelByIndex

  • getThresholdLinesConfigLabelByIndex(index: number): string

  • Accesses the item of the widget's array property 'Configuration' at the passed index and returns the value of it's property 'Line Label. Line Label'

    Parameters

    • index: number

      The index of the item whose property 'Line Label' should be returned

    Returns string

getThresholdLinesConfigLineSizeByIndex

  • getThresholdLinesConfigLineSizeByIndex(index: number): number

  • Accesses the item of the widget's array property 'Configuration' at the passed index and returns the value of it's property 'Line Size [px]. Line Size [px]'

    Parameters

    • index: number

      The index of the item whose property 'Line Size [px]' should be returned

    Returns number

getThresholdLinesConfigLineStyleByIndex

  • getThresholdLinesConfigLineStyleByIndex(index: number): string

  • Accesses the item of the widget's array property 'Configuration' at the passed index and returns the value of it's property 'Line Style. Line Style'

    Parameters

    • index: number

      The index of the item whose property 'Line Style' should be returned

    Returns string

getThresholdLinesConfigTypeByIndex

  • getThresholdLinesConfigTypeByIndex(index: number): string

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

    Parameters

    • index: number

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

    Returns string

getThresholdLinesConfigVisibleByIndex

  • getThresholdLinesConfigVisibleByIndex(index: number): boolean

  • Accesses the item of the widget's array property 'Configuration' at the passed index and returns the value of it's property 'Line Visibility. Line Visibility'

    Parameters

    • index: number

      The index of the item whose property 'Line Visibility' should be returned

    Returns boolean

setThresholdLinesConfigBaseByIndex

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

  • Accesses the item of the widget's array property 'Configuration' at the passed index and assigns the passed new value to it's property 'Line Base'

    Parameters

    • newValue: number

      The new value to be assigned to the property 'Line Base. Threshold: Line Base, Other: Index of Baseseries'

    • index: number

      The index of the item whose property 'Line Base' should be set

    Returns void

setThresholdLinesConfigColorByIndex

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

  • Accesses the item of the widget's array property 'Configuration' at the passed index and assigns the passed new value to it's property 'Line Color'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Line Color. Line Color'

    • index: number

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

    Returns void

setThresholdLinesConfigJsonString

  • setThresholdLinesConfigJsonString(newThresholdLinesConfig: string): void

  • Sets the value of the property 'Threshold Lines Config' as a JSON-String.

    Parameters

    • newThresholdLinesConfig: string

      Threshold Lines Config

    Returns void

setThresholdLinesConfigLabelByIndex

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

  • Accesses the item of the widget's array property 'Configuration' at the passed index and assigns the passed new value to it's property 'Line Label'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Line Label. Line Label'

    • index: number

      The index of the item whose property 'Line Label' should be set

    Returns void

setThresholdLinesConfigLineSizeByIndex

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

  • Accesses the item of the widget's array property 'Configuration' at the passed index and assigns the passed new value to it's property 'Line Size [px]'

    Parameters

    • newValue: number

      The new value to be assigned to the property 'Line Size [px]. Line Size [px]'

    • index: number

      The index of the item whose property 'Line Size [px]' should be set

    Returns void

setThresholdLinesConfigLineStyleByIndex

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

  • Accesses the item of the widget's array property 'Configuration' at the passed index and assigns the passed new value to it's property 'Line Style'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Line Style. Line Style'

    • index: number

      The index of the item whose property 'Line Style' should be set

    Returns void

setThresholdLinesConfigTypeByIndex

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

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

    Parameters

    • newValue: string

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

    • index: number

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

    Returns void

setThresholdLinesConfigVisibleByIndex

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

  • Accesses the item of the widget's array property 'Configuration' at the passed index and assigns the passed new value to it's property 'Line Visibility'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Line Visibility. Line Visibility'

    • index: number

      The index of the item whose property 'Line Visibility' should be set

    Returns void

useOutlierThreshold Methods

getUseOutlierThreshold

  • getUseOutlierThreshold(): boolean

  • Returns the value of the property 'Use Outlier Threshold' .

    Returns boolean

setUseOutlierThreshold

  • setUseOutlierThreshold(newUseOutlierThreshold: boolean): void

  • Sets the value of the property 'Use Outlier Threshold' .

    Parameters

    • newUseOutlierThreshold: boolean

      Use Outlier Threshold

    Returns void

userHighlightCol Methods

getUserHighlightCol

  • getUserHighlightCol(): string[]

  • Returns the value of the property 'Toggle Colors.

    Returns string[]

getUserHighlightColJsonString

  • getUserHighlightColJsonString(): string

  • Returns the value of the property 'User Highlight Col' as a JSON-String.

    Returns string

setUserHighlightCol

  • setUserHighlightCol(newValue: string[]): void

  • Sets the value of the property 'Toggle Colors'

    Parameters

    • newValue: string[]

      The new value of property 'Toggle Colors. '

    Returns void

setUserHighlightColJsonString

  • setUserHighlightColJsonString(newUserHighlightCol: string): void

  • Sets the value of the property 'User Highlight Col' as a JSON-String.

    Parameters

    • newUserHighlightCol: string

      User Highlight Col

    Returns void

userHighlights Methods

getUserHighlightsJsonString

  • getUserHighlightsJsonString(): string

  • Returns the value of the property 'User Highlights' as a JSON-String.

    Returns string

setUserHighlightsJsonString

  • setUserHighlightsJsonString(newUserHighlights: string): void

  • Sets the value of the property 'User Highlights' as a JSON-String.

    Parameters

    • newUserHighlights: string

      User Highlights

    Returns void

valueAxisShowHelplines Methods

getValueAxisShowHelplines

  • getValueAxisShowHelplines(): boolean

  • Returns the value of the property 'Value Axis Show Helplines' .

    Returns boolean

setValueAxisShowHelplines

  • setValueAxisShowHelplines(newValueAxisShowHelplines: boolean): void

  • Sets the value of the property 'Value Axis Show Helplines' .

    Parameters

    • newValueAxisShowHelplines: boolean

      Value Axis Show Helplines

    Returns void

valueAxisTickDistance Methods

getValueAxisTickDistance

  • getValueAxisTickDistance(): number

  • Returns the value of the property 'Value Axis Tick Distance' .

    Returns number

setValueAxisTickDistance

  • setValueAxisTickDistance(newValueAxisTickDistance: number): void

  • Sets the value of the property 'Value Axis Tick Distance' .

    Parameters

    • newValueAxisTickDistance: number

      Value Axis Tick Distance

    Returns void

visibleElementLabels Methods

getVisibleElementLabels

  • getVisibleElementLabels(): number[]

  • Returns the value of the property 'Visible Element Labels.

    Returns number[]

getVisibleElementLabelsJsonString

  • getVisibleElementLabelsJsonString(): string

  • Returns the value of the property 'Visible Element Labels' as a JSON-String.

    Returns string

setVisibleElementLabels

  • setVisibleElementLabels(newValue: number[]): void

  • Sets the value of the property 'Visible Element Labels'

    Parameters

    • newValue: number[]

      The new value of property 'Visible Element Labels. '

    Returns void

setVisibleElementLabelsJsonString

  • setVisibleElementLabelsJsonString(newVisibleElementLabels: string): void

  • Sets the value of the property 'Visible Element Labels' as a JSON-String.

    Parameters

    • newVisibleElementLabels: string

      Visible Element Labels

    Returns void

visibleSeries Methods

getVisibleSeries

  • getVisibleSeries(): number[]

  • Returns the value of the property 'Visibilities.

    Returns number[]

getVisibleSeriesJsonString

  • getVisibleSeriesJsonString(): string

  • Returns the value of the property 'Visible Series' as a JSON-String.

    Returns string

setVisibleSeries

  • setVisibleSeries(newValue: number[]): void

  • Sets the value of the property 'Visibilities'

    Parameters

    • newValue: number[]

      The new value of property 'Visibilities. '

    Returns void

setVisibleSeriesJsonString

  • setVisibleSeriesJsonString(newVisibleSeries: string): void

  • Sets the value of the property 'Visible Series' as a JSON-String.

    Parameters

    • newVisibleSeries: string

      Visible Series

    Returns void

waterfallMinusColor Methods

getWaterfallMinusColor

  • getWaterfallMinusColor(): string

  • Returns the value of the property 'Waterfall Minus Color' .

    Returns string

setWaterfallMinusColor

  • setWaterfallMinusColor(newWaterfallMinusColor: string): void

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

    Parameters

    • newWaterfallMinusColor: string

      Waterfall Minus Color

    Returns void

waterfallNeutralColor Methods

getWaterfallNeutralColor

  • getWaterfallNeutralColor(): string

  • Returns the value of the property 'Waterfall Neutral Color' .

    Returns string

setWaterfallNeutralColor

  • setWaterfallNeutralColor(newWaterfallNeutralColor: string): void

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

    Parameters

    • newWaterfallNeutralColor: string

      Waterfall Neutral Color

    Returns void

waterfallPlusColor Methods

getWaterfallPlusColor

  • getWaterfallPlusColor(): string

  • Returns the value of the property 'Waterfall Plus Color' .

    Returns string

setWaterfallPlusColor

  • setWaterfallPlusColor(newWaterfallPlusColor: string): void

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

    Parameters

    • newWaterfallPlusColor: string

      Waterfall Plus Color

    Returns void

waterfallSpanMinusColor Methods

getWaterfallSpanMinusColor

  • getWaterfallSpanMinusColor(): string

  • Returns the value of the property 'Waterfall Span Minus Color' .

    Returns string

setWaterfallSpanMinusColor

  • setWaterfallSpanMinusColor(newWaterfallSpanMinusColor: string): void

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

    Parameters

    • newWaterfallSpanMinusColor: string

      Waterfall Span Minus Color

    Returns void

waterfallSpanPlusColor Methods

getWaterfallSpanPlusColor

  • getWaterfallSpanPlusColor(): string

  • Returns the value of the property 'Waterfall Span Plus Color' .

    Returns string

setWaterfallSpanPlusColor

  • setWaterfallSpanPlusColor(newWaterfallSpanPlusColor: string): void

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

    Parameters

    • newWaterfallSpanPlusColor: string

      Waterfall Span Plus Color

    Returns void

waterfallSumColor Methods

getWaterfallSumColor

  • getWaterfallSumColor(): string

  • Returns the value of the property 'Waterfall Sum Color' .

    Returns string

setWaterfallSumColor

  • setWaterfallSumColor(newWaterfallSumColor: string): void

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

    Parameters

    • newWaterfallSumColor: string

      Waterfall Sum Color

    Returns void