Menu

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

Hierarchy

  • ScriptingApi

Index

Event Properties

General Methods

absoluteCircleValues Methods

arcLabel Methods

arcMeasureKey Methods

badColor Methods

beginXAxisWith Methods

beginXAxisWithZero Methods

beginYAxisWith Methods

beginYAxisWithZero Methods

circleLabel Methods

circleMeasureKey Methods

collisionAdjustmentFactor Methods

coloredCircle Methods

conditionalFormatting Methods

connectBubbles Methods

connectOnHover Methods

connectionMatcherIndex Methods

dataColor1 Methods

dataColor2 Methods

debugging Methods

devLabel Methods

deviationIsGood Methods

deviationMeasureKey Methods

displayAnnotations Methods

displayCategoryLabels Methods

displayCircleLabels Methods

displayInnerGridLines Methods

displayLegend Methods

displayOuterGridLines Methods

displaySeriesLabels Methods

displayTitle Methods

displayTooltip Methods

displayValues Methods

drawFullBoxes Methods

endXAxisWith Methods

endXAxisWithZero Methods

endYAxisWith Methods

endYAxisWithZero Methods

fadeOutOpacity Methods

fontFamily Methods

goodColor Methods

graphFunctions Methods

guidelinesXAxis Methods

guidelinesYAxis Methods

highlightGroup Methods

highlightGroupColor Methods

highlightGroupMatchMeasures Methods

highlightOnHover Methods

highlightRangesXAxis Methods

highlightRangesYAxis Methods

highlightedBubbles Methods

intervalXAxis Methods

intervalYAxis Methods

manualArcLabel Methods

manualCircleLabel Methods

manualDevLabel Methods

manualXLabel Methods

manualYLabel Methods

maxRadius Methods

minRadius Methods

padding Methods

performanceLimit Methods

regressionLine Methods

reserveSpaceForAnnotations Methods

reserveSpaceForHiddenLabels Methods

serverUrl Methods

smallTextFontSize Methods

stepsXAxis Methods

stepsYAxis Methods

templateName Methods

textColor1 Methods

titleFontSize Methods

titlePadding Methods

valueFormatAssignment Methods

valueLabelFontSize Methods

xLabel Methods

xMeasureKey Methods

yLabel Methods

yMeasureKey Methods

zoomMode 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

getDimensions

  • getDimensions(): string[]

  • Returns the dimensions of a selected datapoint.

    Returns string[]

getSelectedData

  • getSelectedData(): SelectionContext[]

  • Returns the current selection state of this component

    Returns SelectionContext[]

getSelectedMember

  • getSelectedMember(dimension: string): string

  • Returns the selected member of a given dimension.

    Parameters

    • dimension: string

      Dimension

    Returns string

getTitle

  • getTitle(): string

  • Returns the value of the property 'Title' .

    Returns string

setResultSetFromChart

  • setResultSetFromChart(chart: unknown): void

  • Sets the result set of a chart as bubble data where each measure represents a bubble series.

    Parameters

    • chart: unknown

      Chart widget the data of which will be bound to the graphomate bubbles instance

    Returns void

setTitle

  • setTitle(newTitle: string): void

  • Sets the value of the property 'Title' .

    Parameters

    • newTitle: string

      Title

    Returns void

absoluteCircleValues Methods

getAbsoluteCircleValues

  • getAbsoluteCircleValues(): boolean

  • Returns the value of the property 'Absolute Circle Values' .

    Returns boolean

setAbsoluteCircleValues

  • setAbsoluteCircleValues(newAbsoluteCircleValues: boolean): void

  • Sets the value of the property 'Absolute Circle Values' .

    Parameters

    • newAbsoluteCircleValues: boolean

      Absolute Circle Values

    Returns void

arcLabel Methods

getArcLabel

  • getArcLabel(): string

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

    Returns string

setArcLabel

  • setArcLabel(newArcLabel: string): void

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

    Parameters

    • newArcLabel: string

      Arc Label

    Returns void

arcMeasureKey Methods

getArcMeasureKey

  • getArcMeasureKey(): string

  • Returns the value of the property 'Arc Measure Key' .

    Returns string

setArcMeasureKey

  • setArcMeasureKey(newArcMeasureKey: string): void

  • Sets the value of the property 'Arc Measure Key' .

    Parameters

    • newArcMeasureKey: string

      Arc Measure Key

    Returns void

badColor Methods

getBadColor

  • getBadColor(): string

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

    Returns string

setBadColor

  • setBadColor(newBadColor: string): void

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

    Parameters

    • newBadColor: string

      Bad Color

    Returns void

beginXAxisWith Methods

getBeginXAxisWith

  • getBeginXAxisWith(): number

  • Returns the value of the property 'Begin XAxis With' .

    Returns number

setBeginXAxisWith

  • setBeginXAxisWith(newBeginXAxisWith: number): void

  • Sets the value of the property 'Begin XAxis With' .

    Parameters

    • newBeginXAxisWith: number

      Begin XAxis With

    Returns void

beginXAxisWithZero Methods

getBeginXAxisWithZero

  • getBeginXAxisWithZero(): boolean

  • Returns the value of the property 'Begin XAxis With Zero' .

    Returns boolean

setBeginXAxisWithZero

  • setBeginXAxisWithZero(newBeginXAxisWithZero: boolean): void

  • Sets the value of the property 'Begin XAxis With Zero' .

    Parameters

    • newBeginXAxisWithZero: boolean

      Begin XAxis With Zero

    Returns void

beginYAxisWith Methods

getBeginYAxisWith

  • getBeginYAxisWith(): number

  • Returns the value of the property 'Begin YAxis With' .

    Returns number

setBeginYAxisWith

  • setBeginYAxisWith(newBeginYAxisWith: number): void

  • Sets the value of the property 'Begin YAxis With' .

    Parameters

    • newBeginYAxisWith: number

      Begin YAxis With

    Returns void

beginYAxisWithZero Methods

getBeginYAxisWithZero

  • getBeginYAxisWithZero(): boolean

  • Returns the value of the property 'Begin YAxis With Zero' .

    Returns boolean

setBeginYAxisWithZero

  • setBeginYAxisWithZero(newBeginYAxisWithZero: boolean): void

  • Sets the value of the property 'Begin YAxis With Zero' .

    Parameters

    • newBeginYAxisWithZero: boolean

      Begin YAxis With Zero

    Returns void

circleLabel Methods

getCircleLabel

  • getCircleLabel(): string

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

    Returns string

setCircleLabel

  • setCircleLabel(newCircleLabel: string): void

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

    Parameters

    • newCircleLabel: string

      Circle Label

    Returns void

circleMeasureKey Methods

getCircleMeasureKey

  • getCircleMeasureKey(): string

  • Returns the value of the property 'Circle Measure Key' .

    Returns string

setCircleMeasureKey

  • setCircleMeasureKey(newCircleMeasureKey: string): void

  • Sets the value of the property 'Circle Measure Key' .

    Parameters

    • newCircleMeasureKey: string

      Circle Measure Key

    Returns void

collisionAdjustmentFactor Methods

getCollisionAdjustmentFactor

  • getCollisionAdjustmentFactor(): number

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

    Returns number

setCollisionAdjustmentFactor

  • setCollisionAdjustmentFactor(newCollisionAdjustmentFactor: number): void

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

    Parameters

    • newCollisionAdjustmentFactor: number

      Collision Adjustment Factor

    Returns void

coloredCircle Methods

getColoredCircle

  • getColoredCircle(): boolean

  • Returns the value of the property 'Colored Circle' .

    Returns boolean

setColoredCircle

  • setColoredCircle(newColoredCircle: boolean): void

  • Sets the value of the property 'Colored Circle' .

    Parameters

    • newColoredCircle: boolean

      Colored Circle

    Returns void

conditionalFormatting Methods

getConditionalFormattingDescriptionByIndex

  • getConditionalFormattingDescriptionByIndex(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 'Description. Configuration Description'

    Parameters

    • index: number

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

    Returns string

getConditionalFormattingEffectByDescription

  • getConditionalFormattingEffectByDescription(description: string): string

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

    Parameters

    • description: string

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

    Returns string

getConditionalFormattingEffectByIndex

  • getConditionalFormattingEffectByIndex(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 'Effect. Effect'

    Parameters

    • index: number

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

    Returns string

getConditionalFormattingEnabledByDescription

  • getConditionalFormattingEnabledByDescription(description: string): boolean

  • Accesses the item of the widget's array property 'Configuration' whose description equals the passed one and returns the value of it's property 'Enable. Enable this Configuration'

    Parameters

    • description: string

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

    Returns boolean

getConditionalFormattingEnabledByIndex

  • getConditionalFormattingEnabledByIndex(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 'Enable. Enable this Configuration'

    Parameters

    • index: number

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

    Returns boolean

getConditionalFormattingJsonString

  • getConditionalFormattingJsonString(): string

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

    Returns string

getConditionalFormattingOperatorByDescription

  • getConditionalFormattingOperatorByDescription(description: string): string

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

    Parameters

    • description: string

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

    Returns string

getConditionalFormattingOperatorByIndex

  • getConditionalFormattingOperatorByIndex(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 'Operator. Operator'

    Parameters

    • index: number

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

    Returns string

getConditionalFormattingValue1ByDescription

  • getConditionalFormattingValue1ByDescription(description: string): string

  • Accesses the item of the widget's array property 'Configuration' whose description equals the passed one and returns the value of it's property 'Value 1. First Value'

    Parameters

    • description: string

      The description of the item whose property 'Value 1' should be returned

    Returns string

getConditionalFormattingValue1ByIndex

  • getConditionalFormattingValue1ByIndex(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 'Value 1. First Value'

    Parameters

    • index: number

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

    Returns string

getConditionalFormattingValue2ByDescription

  • getConditionalFormattingValue2ByDescription(description: string): string

  • Accesses the item of the widget's array property 'Configuration' whose description equals the passed one and returns the value of it's property 'Value 2. Second Value'

    Parameters

    • description: string

      The description of the item whose property 'Value 2' should be returned

    Returns string

getConditionalFormattingValue2ByIndex

  • getConditionalFormattingValue2ByIndex(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 'Value 2. Second Value'

    Parameters

    • index: number

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

    Returns string

getConditionalFormattingValueByDescription

  • getConditionalFormattingValueByDescription(description: string): string

  • Accesses the item of the widget's array property 'Configuration' whose description equals the passed one and returns the value of it's property 'Characteristic. Effect Characteristic'

    Parameters

    • description: string

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

    Returns string

getConditionalFormattingValueByIndex

  • getConditionalFormattingValueByIndex(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 'Characteristic. Effect Characteristic'

    Parameters

    • index: number

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

    Returns string

getConditionalFormattingVariableByDescription

  • getConditionalFormattingVariableByDescription(description: string): string

  • Accesses the item of the widget's array property 'Configuration' whose description equals the passed one and returns the value of it's property 'Source. Source Series'

    Parameters

    • description: string

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

    Returns string

getConditionalFormattingVariableByIndex

  • getConditionalFormattingVariableByIndex(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 'Source. Source Series'

    Parameters

    • index: number

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

    Returns string

setConditionalFormattingDescriptionByDescription

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

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

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Description. Configuration Description'

    • description: string

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

    Returns void

setConditionalFormattingDescriptionByIndex

  • setConditionalFormattingDescriptionByIndex(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 'Description'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Description. Configuration Description'

    • index: number

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

    Returns void

setConditionalFormattingEffectByDescription

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

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

    Parameters

    • newValue: string

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

    • description: string

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

    Returns void

setConditionalFormattingEffectByIndex

  • setConditionalFormattingEffectByIndex(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 'Effect'

    Parameters

    • newValue: string

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

    • index: number

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

    Returns void

setConditionalFormattingEnabledByDescription

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

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

    • description: string

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

    Returns void

setConditionalFormattingEnabledByIndex

  • setConditionalFormattingEnabledByIndex(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 'Enable'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Enable. Enable this Configuration'

    • index: number

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

    Returns void

setConditionalFormattingJsonString

  • setConditionalFormattingJsonString(newConditionalFormatting: string): void

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

    Parameters

    • newConditionalFormatting: string

      Conditional Formatting

    Returns void

setConditionalFormattingOperatorByDescription

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

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

    Parameters

    • newValue: string

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

    • description: string

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

    Returns void

setConditionalFormattingOperatorByIndex

  • setConditionalFormattingOperatorByIndex(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 'Operator'

    Parameters

    • newValue: string

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

    • index: number

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

    Returns void

setConditionalFormattingValue1ByDescription

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

  • Accesses the item of the widget's array property 'Configuration' whose description equals the passed one and assigns the passed new value to it's property 'Value 1'

    Parameters

    • newValue: string

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

    • description: string

      The description of the item whose property 'Value 1' should be set

    Returns void

setConditionalFormattingValue1ByIndex

  • setConditionalFormattingValue1ByIndex(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 'Value 1'

    Parameters

    • newValue: string

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

    • index: number

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

    Returns void

setConditionalFormattingValue2ByDescription

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

  • Accesses the item of the widget's array property 'Configuration' whose description equals the passed one and assigns the passed new value to it's property 'Value 2'

    Parameters

    • newValue: string

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

    • description: string

      The description of the item whose property 'Value 2' should be set

    Returns void

setConditionalFormattingValue2ByIndex

  • setConditionalFormattingValue2ByIndex(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 'Value 2'

    Parameters

    • newValue: string

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

    • index: number

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

    Returns void

setConditionalFormattingValueByDescription

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

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

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Characteristic. Effect Characteristic'

    • description: string

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

    Returns void

setConditionalFormattingValueByIndex

  • setConditionalFormattingValueByIndex(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 'Characteristic'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Characteristic. Effect Characteristic'

    • index: number

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

    Returns void

setConditionalFormattingVariableByDescription

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

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

    Parameters

    • newValue: string

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

    • description: string

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

    Returns void

setConditionalFormattingVariableByIndex

  • setConditionalFormattingVariableByIndex(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 'Source'

    Parameters

    • newValue: string

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

    • index: number

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

    Returns void

connectBubbles Methods

getConnectBubbles

  • getConnectBubbles(): boolean

  • Returns the value of the property 'Connect Bubbles' .

    Returns boolean

setConnectBubbles

  • setConnectBubbles(newConnectBubbles: boolean): void

  • Sets the value of the property 'Connect Bubbles' .

    Parameters

    • newConnectBubbles: boolean

      Connect Bubbles

    Returns void

connectOnHover Methods

getConnectOnHover

  • getConnectOnHover(): boolean

  • Returns the value of the property 'Connect On Hover' .

    Returns boolean

setConnectOnHover

  • setConnectOnHover(newConnectOnHover: boolean): void

  • Sets the value of the property 'Connect On Hover' .

    Parameters

    • newConnectOnHover: boolean

      Connect On Hover

    Returns void

connectionMatcherIndex Methods

getConnectionMatcherIndex

  • getConnectionMatcherIndex(): number

  • Returns the value of the property 'Connection Matcher Index' .

    Returns number

setConnectionMatcherIndex

  • setConnectionMatcherIndex(newConnectionMatcherIndex: number): void

  • Sets the value of the property 'Connection Matcher Index' .

    Parameters

    • newConnectionMatcherIndex: number

      Connection Matcher Index

    Returns void

dataColor1 Methods

getDataColor1

  • getDataColor1(): string

  • Returns the value of the property 'Data Color1' .

    Returns string

setDataColor1

  • setDataColor1(newDataColor1: string): void

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

    Parameters

    • newDataColor1: string

      Data Color1

    Returns void

dataColor2 Methods

getDataColor2

  • getDataColor2(): string

  • Returns the value of the property 'Data Color2' .

    Returns string

setDataColor2

  • setDataColor2(newDataColor2: string): void

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

    Parameters

    • newDataColor2: string

      Data Color2

    Returns void

debugging Methods

getDebugging

  • getDebugging(): boolean

  • Returns the value of the property 'Debugging' .

    Returns boolean

setDebugging

  • setDebugging(newDebugging: boolean): void

  • Sets the value of the property 'Debugging' .

    Parameters

    • newDebugging: boolean

      Debugging

    Returns void

devLabel Methods

getDevLabel

  • getDevLabel(): string

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

    Returns string

setDevLabel

  • setDevLabel(newDevLabel: string): void

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

    Parameters

    • newDevLabel: string

      Dev Label

    Returns void

deviationIsGood Methods

getDeviationIsGood

  • getDeviationIsGood(): boolean

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

    Returns boolean

setDeviationIsGood

  • setDeviationIsGood(newDeviationIsGood: boolean): void

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

    Parameters

    • newDeviationIsGood: boolean

      Deviation Is Good

    Returns void

deviationMeasureKey Methods

getDeviationMeasureKey

  • getDeviationMeasureKey(): string

  • Returns the value of the property 'Deviation Measure Key' .

    Returns string

setDeviationMeasureKey

  • setDeviationMeasureKey(newDeviationMeasureKey: string): void

  • Sets the value of the property 'Deviation Measure Key' .

    Parameters

    • newDeviationMeasureKey: string

      Deviation Measure Key

    Returns void

displayAnnotations Methods

getDisplayAnnotations

  • getDisplayAnnotations(): boolean

  • Returns the value of the property 'Display Annotations' .

    Returns boolean

setDisplayAnnotations

  • setDisplayAnnotations(newDisplayAnnotations: boolean): void

  • Sets the value of the property 'Display Annotations' .

    Parameters

    • newDisplayAnnotations: boolean

      Display Annotations

    Returns void

displayCategoryLabels Methods

getDisplayCategoryLabels

  • getDisplayCategoryLabels(): string

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

    Returns string

setDisplayCategoryLabels

  • setDisplayCategoryLabels(newDisplayCategoryLabels: string): void

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

    Parameters

    • newDisplayCategoryLabels: string

      Display Category Labels

    Returns void

displayCircleLabels Methods

getDisplayCircleLabels

  • getDisplayCircleLabels(): string

  • Returns the value of the property 'Display Circle Labels' .

    Returns string

setDisplayCircleLabels

  • setDisplayCircleLabels(newDisplayCircleLabels: string): void

  • Sets the value of the property 'Display Circle Labels' .

    Parameters

    • newDisplayCircleLabels: string

      Display Circle Labels

    Returns void

displayInnerGridLines Methods

getDisplayInnerGridLines

  • getDisplayInnerGridLines(): boolean

  • Returns the value of the property 'Display Inner Grid Lines' .

    Returns boolean

setDisplayInnerGridLines

  • setDisplayInnerGridLines(newDisplayInnerGridLines: boolean): void

  • Sets the value of the property 'Display Inner Grid Lines' .

    Parameters

    • newDisplayInnerGridLines: boolean

      Display Inner Grid Lines

    Returns void

displayLegend Methods

getDisplayLegend

  • getDisplayLegend(): boolean

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

    Returns boolean

setDisplayLegend

  • setDisplayLegend(newDisplayLegend: boolean): void

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

    Parameters

    • newDisplayLegend: boolean

      Display Legend

    Returns void

displayOuterGridLines Methods

getDisplayOuterGridLines

  • getDisplayOuterGridLines(): boolean

  • Returns the value of the property 'Display Outer Grid Lines' .

    Returns boolean

setDisplayOuterGridLines

  • setDisplayOuterGridLines(newDisplayOuterGridLines: boolean): void

  • Sets the value of the property 'Display Outer Grid Lines' .

    Parameters

    • newDisplayOuterGridLines: boolean

      Display Outer Grid Lines

    Returns void

displaySeriesLabels Methods

getDisplaySeriesLabels

  • getDisplaySeriesLabels(): boolean

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

    Returns boolean

setDisplaySeriesLabels

  • setDisplaySeriesLabels(newDisplaySeriesLabels: boolean): void

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

    Parameters

    • newDisplaySeriesLabels: boolean

      Display Series Labels

    Returns void

displayTitle Methods

getDisplayTitle

  • getDisplayTitle(): boolean

  • Returns the value of the property 'Display Title' .

    Returns boolean

setDisplayTitle

  • setDisplayTitle(newDisplayTitle: boolean): void

  • Sets the value of the property 'Display Title' .

    Parameters

    • newDisplayTitle: boolean

      Display Title

    Returns void

displayTooltip Methods

getDisplayTooltip

  • getDisplayTooltip(): boolean

  • Returns the value of the property 'Display Tooltip' .

    Returns boolean

setDisplayTooltip

  • setDisplayTooltip(newDisplayTooltip: boolean): void

  • Sets the value of the property 'Display Tooltip' .

    Parameters

    • newDisplayTooltip: boolean

      Display Tooltip

    Returns void

displayValues Methods

getDisplayValues

  • getDisplayValues(): boolean

  • Returns the value of the property 'Display Values' .

    Returns boolean

setDisplayValues

  • setDisplayValues(newDisplayValues: boolean): void

  • Sets the value of the property 'Display Values' .

    Parameters

    • newDisplayValues: boolean

      Display Values

    Returns void

drawFullBoxes Methods

getDrawFullBoxes

  • getDrawFullBoxes(): boolean

  • Returns the value of the property 'Draw Full Boxes' .

    Returns boolean

setDrawFullBoxes

  • setDrawFullBoxes(newDrawFullBoxes: boolean): void

  • Sets the value of the property 'Draw Full Boxes' .

    Parameters

    • newDrawFullBoxes: boolean

      Draw Full Boxes

    Returns void

endXAxisWith Methods

getEndXAxisWith

  • getEndXAxisWith(): number

  • Returns the value of the property 'End XAxis With' .

    Returns number

setEndXAxisWith

  • setEndXAxisWith(newEndXAxisWith: number): void

  • Sets the value of the property 'End XAxis With' .

    Parameters

    • newEndXAxisWith: number

      End XAxis With

    Returns void

endXAxisWithZero Methods

getEndXAxisWithZero

  • getEndXAxisWithZero(): boolean

  • Returns the value of the property 'End XAxis With Zero' .

    Returns boolean

setEndXAxisWithZero

  • setEndXAxisWithZero(newEndXAxisWithZero: boolean): void

  • Sets the value of the property 'End XAxis With Zero' .

    Parameters

    • newEndXAxisWithZero: boolean

      End XAxis With Zero

    Returns void

endYAxisWith Methods

getEndYAxisWith

  • getEndYAxisWith(): number

  • Returns the value of the property 'End YAxis With' .

    Returns number

setEndYAxisWith

  • setEndYAxisWith(newEndYAxisWith: number): void

  • Sets the value of the property 'End YAxis With' .

    Parameters

    • newEndYAxisWith: number

      End YAxis With

    Returns void

endYAxisWithZero Methods

getEndYAxisWithZero

  • getEndYAxisWithZero(): boolean

  • Returns the value of the property 'End YAxis With Zero' .

    Returns boolean

setEndYAxisWithZero

  • setEndYAxisWithZero(newEndYAxisWithZero: boolean): void

  • Sets the value of the property 'End YAxis With Zero' .

    Parameters

    • newEndYAxisWithZero: boolean

      End YAxis With Zero

    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

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

goodColor Methods

getGoodColor

  • getGoodColor(): string

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

    Returns string

setGoodColor

  • setGoodColor(newGoodColor: string): void

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

    Parameters

    • newGoodColor: string

      Good Color

    Returns void

graphFunctions Methods

getGraphFunctionsDescriptionByIndex

  • getGraphFunctionsDescriptionByIndex(index: number): string

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

    Parameters

    • index: number

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

    Returns string

getGraphFunctionsEnabledByDescription

  • getGraphFunctionsEnabledByDescription(description: string): boolean

  • Accesses the item of the widget's array property 'Definitions' whose description equals the passed one and returns the value of it's property 'Enable. Enable this Graph'

    Parameters

    • description: string

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

    Returns boolean

getGraphFunctionsEnabledByIndex

  • getGraphFunctionsEnabledByIndex(index: number): boolean

  • Accesses the item of the widget's array property 'Definitions' at the passed index and returns the value of it's property 'Enable. Enable this Graph'

    Parameters

    • index: number

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

    Returns boolean

getGraphFunctionsFuncByDescription

  • getGraphFunctionsFuncByDescription(description: string): string

  • Accesses the item of the widget's array property 'Definitions' whose description equals the passed one and returns the value of it's property 'Expression. Mathematical Expression'

    Parameters

    • description: string

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

    Returns string

getGraphFunctionsFuncByIndex

  • getGraphFunctionsFuncByIndex(index: number): string

  • Accesses the item of the widget's array property 'Definitions' at the passed index and returns the value of it's property 'Expression. Mathematical Expression'

    Parameters

    • index: number

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

    Returns string

getGraphFunctionsJsonString

  • getGraphFunctionsJsonString(): string

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

    Returns string

getGraphFunctionsStrokeByDescription

  • getGraphFunctionsStrokeByDescription(description: string): string

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

    Parameters

    • description: string

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

    Returns string

getGraphFunctionsStrokeByIndex

  • getGraphFunctionsStrokeByIndex(index: number): string

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

    Parameters

    • index: number

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

    Returns string

getGraphFunctionsWidthByDescription

  • getGraphFunctionsWidthByDescription(description: string): number

  • Accesses the item of the widget's array property 'Definitions' whose description equals the passed one and returns the value of it's property 'Width [px]. Width in Pixel'

    Parameters

    • description: string

      The description of the item whose property 'Width [px]' should be returned

    Returns number

getGraphFunctionsWidthByIndex

  • getGraphFunctionsWidthByIndex(index: number): number

  • Accesses the item of the widget's array property 'Definitions' at the passed index and returns the value of it's property 'Width [px]. Width in Pixel'

    Parameters

    • index: number

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

    Returns number

setGraphFunctionsDescriptionByDescription

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

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

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Description. Configuration Description'

    • description: string

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

    Returns void

setGraphFunctionsDescriptionByIndex

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

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

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Description. Configuration Description'

    • index: number

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

    Returns void

setGraphFunctionsEnabledByDescription

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

  • Accesses the item of the widget's array property 'Definitions' 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. Enable this Graph'

    • description: string

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

    Returns void

setGraphFunctionsEnabledByIndex

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

  • Accesses the item of the widget's array property 'Definitions' 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. Enable this Graph'

    • index: number

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

    Returns void

setGraphFunctionsFuncByDescription

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

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

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Expression. Mathematical Expression'

    • description: string

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

    Returns void

setGraphFunctionsFuncByIndex

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

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

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Expression. Mathematical Expression'

    • index: number

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

    Returns void

setGraphFunctionsJsonString

  • setGraphFunctionsJsonString(newGraphFunctions: string): void

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

    Parameters

    • newGraphFunctions: string

      Graph Functions

    Returns void

setGraphFunctionsStrokeByDescription

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

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

    Parameters

    • newValue: string

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

    • description: string

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

    Returns void

setGraphFunctionsStrokeByIndex

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

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

    • index: number

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

    Returns void

setGraphFunctionsWidthByDescription

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

  • Accesses the item of the widget's array property 'Definitions' whose description equals the passed one and assigns the passed new value to it's property 'Width [px]'

    Parameters

    • newValue: number

      The new value to be assigned to the property 'Width [px]. Width in Pixel'

    • description: string

      The description of the item whose property 'Width [px]' should be set

    Returns void

setGraphFunctionsWidthByIndex

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

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

    Parameters

    • newValue: number

      The new value to be assigned to the property 'Width [px]. Width in Pixel'

    • index: number

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

    Returns void

guidelinesXAxis Methods

getGuidelinesXAxisDescriptionByIndex

  • getGuidelinesXAxisDescriptionByIndex(index: number): string

  • Accesses the item of the widget's array property 'X-Axis' at the passed index and returns the value of it's property 'Description. Configuration Description'

    Parameters

    • index: number

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

    Returns string

getGuidelinesXAxisEnabledByDescription

  • getGuidelinesXAxisEnabledByDescription(description: string): boolean

  • Accesses the item of the widget's array property 'X-Axis' whose description equals the passed one and returns the value of it's property 'Enable. Enable this Configuration'

    Parameters

    • description: string

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

    Returns boolean

getGuidelinesXAxisEnabledByIndex

  • getGuidelinesXAxisEnabledByIndex(index: number): boolean

  • Accesses the item of the widget's array property 'X-Axis' at the passed index and returns the value of it's property 'Enable. Enable this Configuration'

    Parameters

    • index: number

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

    Returns boolean

getGuidelinesXAxisJsonString

  • getGuidelinesXAxisJsonString(): string

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

    Returns string

getGuidelinesXAxisLabelBoldByDescription

  • getGuidelinesXAxisLabelBoldByDescription(description: string): boolean

  • Accesses the item of the widget's array property 'X-Axis' whose description equals the passed one and returns the value of it's property 'Bold Label. Bold Label'

    Parameters

    • description: string

      The description of the item whose property 'Bold Label' should be returned

    Returns boolean

getGuidelinesXAxisLabelBoldByIndex

  • getGuidelinesXAxisLabelBoldByIndex(index: number): boolean

  • Accesses the item of the widget's array property 'X-Axis' at the passed index and returns the value of it's property 'Bold Label. Bold Label'

    Parameters

    • index: number

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

    Returns boolean

getGuidelinesXAxisLabelByDescription

  • getGuidelinesXAxisLabelByDescription(description: string): string

  • Accesses the item of the widget's array property 'X-Axis' whose description equals the passed one and returns the value of it's property 'Label. Label'

    Parameters

    • description: string

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

    Returns string

getGuidelinesXAxisLabelByIndex

  • getGuidelinesXAxisLabelByIndex(index: number): string

  • Accesses the item of the widget's array property 'X-Axis' at the passed index and returns the value of it's property 'Label. Label'

    Parameters

    • index: number

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

    Returns string

getGuidelinesXAxisStrokeByDescription

  • getGuidelinesXAxisStrokeByDescription(description: string): string

  • Accesses the item of the widget's array property 'X-Axis' whose description equals the passed one and returns the value of it's property 'Color. Color'

    Parameters

    • description: string

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

    Returns string

getGuidelinesXAxisStrokeByIndex

  • getGuidelinesXAxisStrokeByIndex(index: number): string

  • Accesses the item of the widget's array property 'X-Axis' at the passed index and returns the value of it's property 'Color. Color'

    Parameters

    • index: number

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

    Returns string

getGuidelinesXAxisValueByDescription

  • getGuidelinesXAxisValueByDescription(description: string): string

  • Accesses the item of the widget's array property 'X-Axis' whose description equals the passed one and returns the value of it's property 'Value. Value'

    Parameters

    • description: string

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

    Returns string

getGuidelinesXAxisValueByIndex

  • getGuidelinesXAxisValueByIndex(index: number): string

  • Accesses the item of the widget's array property 'X-Axis' at the passed index and returns the value of it's property 'Value. Value'

    Parameters

    • index: number

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

    Returns string

getGuidelinesXAxisWidthByDescription

  • getGuidelinesXAxisWidthByDescription(description: string): number

  • Accesses the item of the widget's array property 'X-Axis' whose description equals the passed one and returns the value of it's property 'Width [px]. Width in Pixel'

    Parameters

    • description: string

      The description of the item whose property 'Width [px]' should be returned

    Returns number

getGuidelinesXAxisWidthByIndex

  • getGuidelinesXAxisWidthByIndex(index: number): number

  • Accesses the item of the widget's array property 'X-Axis' at the passed index and returns the value of it's property 'Width [px]. Width in Pixel'

    Parameters

    • index: number

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

    Returns number

setGuidelinesXAxisDescriptionByDescription

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

  • Accesses the item of the widget's array property 'X-Axis' whose description equals the passed one and assigns the passed new value to it's property 'Description'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Description. Configuration Description'

    • description: string

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

    Returns void

setGuidelinesXAxisDescriptionByIndex

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

  • Accesses the item of the widget's array property 'X-Axis' at the passed index and assigns the passed new value to it's property 'Description'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Description. Configuration Description'

    • index: number

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

    Returns void

setGuidelinesXAxisEnabledByDescription

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

  • Accesses the item of the widget's array property 'X-Axis' 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. Enable this Configuration'

    • description: string

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

    Returns void

setGuidelinesXAxisEnabledByIndex

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

  • Accesses the item of the widget's array property 'X-Axis' 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. Enable this Configuration'

    • index: number

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

    Returns void

setGuidelinesXAxisJsonString

  • setGuidelinesXAxisJsonString(newGuidelinesXAxis: string): void

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

    Parameters

    • newGuidelinesXAxis: string

      Guidelines XAxis

    Returns void

setGuidelinesXAxisLabelBoldByDescription

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

  • Accesses the item of the widget's array property 'X-Axis' whose description equals the passed one and assigns the passed new value to it's property 'Bold Label'

    Parameters

    • newValue: boolean

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

    • description: string

      The description of the item whose property 'Bold Label' should be set

    Returns void

setGuidelinesXAxisLabelBoldByIndex

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

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

    Parameters

    • newValue: boolean

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

    • index: number

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

    Returns void

setGuidelinesXAxisLabelByDescription

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

  • Accesses the item of the widget's array property 'X-Axis' whose description equals the passed one and assigns the passed new value to it's property 'Label'

    Parameters

    • newValue: string

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

    • description: string

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

    Returns void

setGuidelinesXAxisLabelByIndex

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

  • Accesses the item of the widget's array property 'X-Axis' 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. Label'

    • index: number

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

    Returns void

setGuidelinesXAxisStrokeByDescription

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

  • Accesses the item of the widget's array property 'X-Axis' whose description equals the passed one and assigns the passed new value to it's property 'Color'

    Parameters

    • newValue: string

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

    • description: string

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

    Returns void

setGuidelinesXAxisStrokeByIndex

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

  • Accesses the item of the widget's array property 'X-Axis' 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. Color'

    • index: number

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

    Returns void

setGuidelinesXAxisValueByDescription

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

  • Accesses the item of the widget's array property 'X-Axis' whose description equals the passed one and assigns the passed new value to it's property 'Value'

    Parameters

    • newValue: string

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

    • description: string

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

    Returns void

setGuidelinesXAxisValueByIndex

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

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

    Parameters

    • newValue: string

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

    • index: number

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

    Returns void

setGuidelinesXAxisWidthByDescription

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

  • Accesses the item of the widget's array property 'X-Axis' whose description equals the passed one and assigns the passed new value to it's property 'Width [px]'

    Parameters

    • newValue: number

      The new value to be assigned to the property 'Width [px]. Width in Pixel'

    • description: string

      The description of the item whose property 'Width [px]' should be set

    Returns void

setGuidelinesXAxisWidthByIndex

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

  • Accesses the item of the widget's array property 'X-Axis' at the passed index and assigns the passed new value to it's property 'Width [px]'

    Parameters

    • newValue: number

      The new value to be assigned to the property 'Width [px]. Width in Pixel'

    • index: number

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

    Returns void

guidelinesYAxis Methods

getGuidelinesYAxisDescriptionByIndex

  • getGuidelinesYAxisDescriptionByIndex(index: number): string

  • Accesses the item of the widget's array property 'Y-Axis' at the passed index and returns the value of it's property 'Description. Configuration Description'

    Parameters

    • index: number

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

    Returns string

getGuidelinesYAxisEnabledByDescription

  • getGuidelinesYAxisEnabledByDescription(description: string): boolean

  • Accesses the item of the widget's array property 'Y-Axis' whose description equals the passed one and returns the value of it's property 'Enable. Enable this Configuration'

    Parameters

    • description: string

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

    Returns boolean

getGuidelinesYAxisEnabledByIndex

  • getGuidelinesYAxisEnabledByIndex(index: number): boolean

  • Accesses the item of the widget's array property 'Y-Axis' at the passed index and returns the value of it's property 'Enable. Enable this Configuration'

    Parameters

    • index: number

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

    Returns boolean

getGuidelinesYAxisJsonString

  • getGuidelinesYAxisJsonString(): string

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

    Returns string

getGuidelinesYAxisLabelBoldByDescription

  • getGuidelinesYAxisLabelBoldByDescription(description: string): boolean

  • Accesses the item of the widget's array property 'Y-Axis' whose description equals the passed one and returns the value of it's property 'Bold Label. Bold Label'

    Parameters

    • description: string

      The description of the item whose property 'Bold Label' should be returned

    Returns boolean

getGuidelinesYAxisLabelBoldByIndex

  • getGuidelinesYAxisLabelBoldByIndex(index: number): boolean

  • Accesses the item of the widget's array property 'Y-Axis' at the passed index and returns the value of it's property 'Bold Label. Bold Label'

    Parameters

    • index: number

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

    Returns boolean

getGuidelinesYAxisLabelByDescription

  • getGuidelinesYAxisLabelByDescription(description: string): string

  • Accesses the item of the widget's array property 'Y-Axis' whose description equals the passed one and returns the value of it's property 'Label. Label'

    Parameters

    • description: string

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

    Returns string

getGuidelinesYAxisLabelByIndex

  • getGuidelinesYAxisLabelByIndex(index: number): string

  • Accesses the item of the widget's array property 'Y-Axis' at the passed index and returns the value of it's property 'Label. Label'

    Parameters

    • index: number

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

    Returns string

getGuidelinesYAxisStrokeByDescription

  • getGuidelinesYAxisStrokeByDescription(description: string): string

  • Accesses the item of the widget's array property 'Y-Axis' whose description equals the passed one and returns the value of it's property 'Color. Color'

    Parameters

    • description: string

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

    Returns string

getGuidelinesYAxisStrokeByIndex

  • getGuidelinesYAxisStrokeByIndex(index: number): string

  • Accesses the item of the widget's array property 'Y-Axis' at the passed index and returns the value of it's property 'Color. Color'

    Parameters

    • index: number

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

    Returns string

getGuidelinesYAxisValueByDescription

  • getGuidelinesYAxisValueByDescription(description: string): string

  • Accesses the item of the widget's array property 'Y-Axis' whose description equals the passed one and returns the value of it's property 'Value. Value'

    Parameters

    • description: string

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

    Returns string

getGuidelinesYAxisValueByIndex

  • getGuidelinesYAxisValueByIndex(index: number): string

  • Accesses the item of the widget's array property 'Y-Axis' at the passed index and returns the value of it's property 'Value. Value'

    Parameters

    • index: number

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

    Returns string

getGuidelinesYAxisWidthByDescription

  • getGuidelinesYAxisWidthByDescription(description: string): number

  • Accesses the item of the widget's array property 'Y-Axis' whose description equals the passed one and returns the value of it's property 'Width [px]. Width in Pixel'

    Parameters

    • description: string

      The description of the item whose property 'Width [px]' should be returned

    Returns number

getGuidelinesYAxisWidthByIndex

  • getGuidelinesYAxisWidthByIndex(index: number): number

  • Accesses the item of the widget's array property 'Y-Axis' at the passed index and returns the value of it's property 'Width [px]. Width in Pixel'

    Parameters

    • index: number

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

    Returns number

setGuidelinesYAxisDescriptionByDescription

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

  • Accesses the item of the widget's array property 'Y-Axis' whose description equals the passed one and assigns the passed new value to it's property 'Description'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Description. Configuration Description'

    • description: string

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

    Returns void

setGuidelinesYAxisDescriptionByIndex

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

  • Accesses the item of the widget's array property 'Y-Axis' at the passed index and assigns the passed new value to it's property 'Description'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Description. Configuration Description'

    • index: number

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

    Returns void

setGuidelinesYAxisEnabledByDescription

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

  • Accesses the item of the widget's array property 'Y-Axis' 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. Enable this Configuration'

    • description: string

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

    Returns void

setGuidelinesYAxisEnabledByIndex

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

  • Accesses the item of the widget's array property 'Y-Axis' 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. Enable this Configuration'

    • index: number

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

    Returns void

setGuidelinesYAxisJsonString

  • setGuidelinesYAxisJsonString(newGuidelinesYAxis: string): void

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

    Parameters

    • newGuidelinesYAxis: string

      Guidelines YAxis

    Returns void

setGuidelinesYAxisLabelBoldByDescription

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

  • Accesses the item of the widget's array property 'Y-Axis' whose description equals the passed one and assigns the passed new value to it's property 'Bold Label'

    Parameters

    • newValue: boolean

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

    • description: string

      The description of the item whose property 'Bold Label' should be set

    Returns void

setGuidelinesYAxisLabelBoldByIndex

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

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

    Parameters

    • newValue: boolean

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

    • index: number

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

    Returns void

setGuidelinesYAxisLabelByDescription

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

  • Accesses the item of the widget's array property 'Y-Axis' whose description equals the passed one and assigns the passed new value to it's property 'Label'

    Parameters

    • newValue: string

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

    • description: string

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

    Returns void

setGuidelinesYAxisLabelByIndex

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

  • Accesses the item of the widget's array property 'Y-Axis' 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. Label'

    • index: number

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

    Returns void

setGuidelinesYAxisStrokeByDescription

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

  • Accesses the item of the widget's array property 'Y-Axis' whose description equals the passed one and assigns the passed new value to it's property 'Color'

    Parameters

    • newValue: string

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

    • description: string

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

    Returns void

setGuidelinesYAxisStrokeByIndex

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

  • Accesses the item of the widget's array property 'Y-Axis' 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. Color'

    • index: number

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

    Returns void

setGuidelinesYAxisValueByDescription

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

  • Accesses the item of the widget's array property 'Y-Axis' whose description equals the passed one and assigns the passed new value to it's property 'Value'

    Parameters

    • newValue: string

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

    • description: string

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

    Returns void

setGuidelinesYAxisValueByIndex

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

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

    Parameters

    • newValue: string

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

    • index: number

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

    Returns void

setGuidelinesYAxisWidthByDescription

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

  • Accesses the item of the widget's array property 'Y-Axis' whose description equals the passed one and assigns the passed new value to it's property 'Width [px]'

    Parameters

    • newValue: number

      The new value to be assigned to the property 'Width [px]. Width in Pixel'

    • description: string

      The description of the item whose property 'Width [px]' should be set

    Returns void

setGuidelinesYAxisWidthByIndex

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

  • Accesses the item of the widget's array property 'Y-Axis' at the passed index and assigns the passed new value to it's property 'Width [px]'

    Parameters

    • newValue: number

      The new value to be assigned to the property 'Width [px]. Width in Pixel'

    • index: number

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

    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

highlightOnHover Methods

getHighlightOnHover

  • getHighlightOnHover(): boolean

  • Returns the value of the property 'Highlight On Hover' .

    Returns boolean

setHighlightOnHover

  • setHighlightOnHover(newHighlightOnHover: boolean): void

  • Sets the value of the property 'Highlight On Hover' .

    Parameters

    • newHighlightOnHover: boolean

      Highlight On Hover

    Returns void

highlightRangesXAxis Methods

getHighlightRangesXAxisColorByDescription

  • getHighlightRangesXAxisColorByDescription(description: string): string

  • Accesses the item of the widget's array property 'X-Axis' whose description equals the passed one and returns the value of it's property 'Color. Color'

    Parameters

    • description: string

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

    Returns string

getHighlightRangesXAxisColorByIndex

  • getHighlightRangesXAxisColorByIndex(index: number): string

  • Accesses the item of the widget's array property 'X-Axis' at the passed index and returns the value of it's property 'Color. Color'

    Parameters

    • index: number

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

    Returns string

getHighlightRangesXAxisDescriptionByIndex

  • getHighlightRangesXAxisDescriptionByIndex(index: number): string

  • Accesses the item of the widget's array property 'X-Axis' at the passed index and returns the value of it's property 'Description. Configuration Description'

    Parameters

    • index: number

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

    Returns string

getHighlightRangesXAxisEnabledByDescription

  • getHighlightRangesXAxisEnabledByDescription(description: string): boolean

  • Accesses the item of the widget's array property 'X-Axis' whose description equals the passed one and returns the value of it's property 'Enable. Enable this Configuration'

    Parameters

    • description: string

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

    Returns boolean

getHighlightRangesXAxisEnabledByIndex

  • getHighlightRangesXAxisEnabledByIndex(index: number): boolean

  • Accesses the item of the widget's array property 'X-Axis' at the passed index and returns the value of it's property 'Enable. Enable this Configuration'

    Parameters

    • index: number

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

    Returns boolean

getHighlightRangesXAxisEndByDescription

  • getHighlightRangesXAxisEndByDescription(description: string): string

  • Accesses the item of the widget's array property 'X-Axis' whose description equals the passed one and returns the value of it's property 'End. End Value'

    Parameters

    • description: string

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

    Returns string

getHighlightRangesXAxisEndByIndex

  • getHighlightRangesXAxisEndByIndex(index: number): string

  • Accesses the item of the widget's array property 'X-Axis' at the passed index and returns the value of it's property 'End. End Value'

    Parameters

    • index: number

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

    Returns string

getHighlightRangesXAxisJsonString

  • getHighlightRangesXAxisJsonString(): string

  • Returns the value of the property 'Highlight Ranges XAxis' as a JSON-String.

    Returns string

getHighlightRangesXAxisOpacityByDescription

  • getHighlightRangesXAxisOpacityByDescription(description: string): string

  • Accesses the item of the widget's array property 'X-Axis' whose description equals the passed one and returns the value of it's property 'Opacity. Opacity'

    Parameters

    • description: string

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

    Returns string

getHighlightRangesXAxisOpacityByIndex

  • getHighlightRangesXAxisOpacityByIndex(index: number): string

  • Accesses the item of the widget's array property 'X-Axis' at the passed index and returns the value of it's property 'Opacity. Opacity'

    Parameters

    • index: number

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

    Returns string

getHighlightRangesXAxisStartByDescription

  • getHighlightRangesXAxisStartByDescription(description: string): string

  • Accesses the item of the widget's array property 'X-Axis' whose description equals the passed one and returns the value of it's property 'Start. Start Value'

    Parameters

    • description: string

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

    Returns string

getHighlightRangesXAxisStartByIndex

  • getHighlightRangesXAxisStartByIndex(index: number): string

  • Accesses the item of the widget's array property 'X-Axis' at the passed index and returns the value of it's property 'Start. Start Value'

    Parameters

    • index: number

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

    Returns string

setHighlightRangesXAxisColorByDescription

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

  • Accesses the item of the widget's array property 'X-Axis' whose description equals the passed one and assigns the passed new value to it's property 'Color'

    Parameters

    • newValue: string

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

    • description: string

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

    Returns void

setHighlightRangesXAxisColorByIndex

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

  • Accesses the item of the widget's array property 'X-Axis' 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. Color'

    • index: number

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

    Returns void

setHighlightRangesXAxisDescriptionByDescription

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

  • Accesses the item of the widget's array property 'X-Axis' whose description equals the passed one and assigns the passed new value to it's property 'Description'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Description. Configuration Description'

    • description: string

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

    Returns void

setHighlightRangesXAxisDescriptionByIndex

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

  • Accesses the item of the widget's array property 'X-Axis' at the passed index and assigns the passed new value to it's property 'Description'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Description. Configuration Description'

    • index: number

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

    Returns void

setHighlightRangesXAxisEnabledByDescription

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

  • Accesses the item of the widget's array property 'X-Axis' 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. Enable this Configuration'

    • description: string

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

    Returns void

setHighlightRangesXAxisEnabledByIndex

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

  • Accesses the item of the widget's array property 'X-Axis' 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. Enable this Configuration'

    • index: number

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

    Returns void

setHighlightRangesXAxisEndByDescription

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

  • Accesses the item of the widget's array property 'X-Axis' whose description equals the passed one and assigns the passed new value to it's property 'End'

    Parameters

    • newValue: string

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

    • description: string

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

    Returns void

setHighlightRangesXAxisEndByIndex

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

  • Accesses the item of the widget's array property 'X-Axis' at the passed index and assigns the passed new value to it's property 'End'

    Parameters

    • newValue: string

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

    • index: number

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

    Returns void

setHighlightRangesXAxisJsonString

  • setHighlightRangesXAxisJsonString(newHighlightRangesXAxis: string): void

  • Sets the value of the property 'Highlight Ranges XAxis' as a JSON-String.

    Parameters

    • newHighlightRangesXAxis: string

      Highlight Ranges XAxis

    Returns void

setHighlightRangesXAxisOpacityByDescription

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

  • Accesses the item of the widget's array property 'X-Axis' whose description equals the passed one and assigns the passed new value to it's property 'Opacity'

    Parameters

    • newValue: string

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

    • description: string

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

    Returns void

setHighlightRangesXAxisOpacityByIndex

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

  • Accesses the item of the widget's array property 'X-Axis' at the passed index and assigns the passed new value to it's property 'Opacity'

    Parameters

    • newValue: string

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

    • index: number

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

    Returns void

setHighlightRangesXAxisStartByDescription

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

  • Accesses the item of the widget's array property 'X-Axis' whose description equals the passed one and assigns the passed new value to it's property 'Start'

    Parameters

    • newValue: string

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

    • description: string

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

    Returns void

setHighlightRangesXAxisStartByIndex

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

  • Accesses the item of the widget's array property 'X-Axis' at the passed index and assigns the passed new value to it's property 'Start'

    Parameters

    • newValue: string

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

    • index: number

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

    Returns void

highlightRangesYAxis Methods

getHighlightRangesYAxisColorByDescription

  • getHighlightRangesYAxisColorByDescription(description: string): string

  • Accesses the item of the widget's array property 'Y-Axis' whose description equals the passed one and returns the value of it's property 'Color. Color'

    Parameters

    • description: string

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

    Returns string

getHighlightRangesYAxisColorByIndex

  • getHighlightRangesYAxisColorByIndex(index: number): string

  • Accesses the item of the widget's array property 'Y-Axis' at the passed index and returns the value of it's property 'Color. Color'

    Parameters

    • index: number

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

    Returns string

getHighlightRangesYAxisDescriptionByIndex

  • getHighlightRangesYAxisDescriptionByIndex(index: number): string

  • Accesses the item of the widget's array property 'Y-Axis' at the passed index and returns the value of it's property 'Description. Configuration Description'

    Parameters

    • index: number

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

    Returns string

getHighlightRangesYAxisEnabledByDescription

  • getHighlightRangesYAxisEnabledByDescription(description: string): boolean

  • Accesses the item of the widget's array property 'Y-Axis' whose description equals the passed one and returns the value of it's property 'Enable. Enable this Configuration'

    Parameters

    • description: string

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

    Returns boolean

getHighlightRangesYAxisEnabledByIndex

  • getHighlightRangesYAxisEnabledByIndex(index: number): boolean

  • Accesses the item of the widget's array property 'Y-Axis' at the passed index and returns the value of it's property 'Enable. Enable this Configuration'

    Parameters

    • index: number

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

    Returns boolean

getHighlightRangesYAxisEndByDescription

  • getHighlightRangesYAxisEndByDescription(description: string): string

  • Accesses the item of the widget's array property 'Y-Axis' whose description equals the passed one and returns the value of it's property 'End. End Value'

    Parameters

    • description: string

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

    Returns string

getHighlightRangesYAxisEndByIndex

  • getHighlightRangesYAxisEndByIndex(index: number): string

  • Accesses the item of the widget's array property 'Y-Axis' at the passed index and returns the value of it's property 'End. End Value'

    Parameters

    • index: number

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

    Returns string

getHighlightRangesYAxisJsonString

  • getHighlightRangesYAxisJsonString(): string

  • Returns the value of the property 'Highlight Ranges YAxis' as a JSON-String.

    Returns string

getHighlightRangesYAxisOpacityByDescription

  • getHighlightRangesYAxisOpacityByDescription(description: string): string

  • Accesses the item of the widget's array property 'Y-Axis' whose description equals the passed one and returns the value of it's property 'Opacity. Opacity'

    Parameters

    • description: string

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

    Returns string

getHighlightRangesYAxisOpacityByIndex

  • getHighlightRangesYAxisOpacityByIndex(index: number): string

  • Accesses the item of the widget's array property 'Y-Axis' at the passed index and returns the value of it's property 'Opacity. Opacity'

    Parameters

    • index: number

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

    Returns string

getHighlightRangesYAxisStartByDescription

  • getHighlightRangesYAxisStartByDescription(description: string): string

  • Accesses the item of the widget's array property 'Y-Axis' whose description equals the passed one and returns the value of it's property 'Start. Start Value'

    Parameters

    • description: string

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

    Returns string

getHighlightRangesYAxisStartByIndex

  • getHighlightRangesYAxisStartByIndex(index: number): string

  • Accesses the item of the widget's array property 'Y-Axis' at the passed index and returns the value of it's property 'Start. Start Value'

    Parameters

    • index: number

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

    Returns string

setHighlightRangesYAxisColorByDescription

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

  • Accesses the item of the widget's array property 'Y-Axis' whose description equals the passed one and assigns the passed new value to it's property 'Color'

    Parameters

    • newValue: string

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

    • description: string

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

    Returns void

setHighlightRangesYAxisColorByIndex

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

  • Accesses the item of the widget's array property 'Y-Axis' 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. Color'

    • index: number

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

    Returns void

setHighlightRangesYAxisDescriptionByDescription

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

  • Accesses the item of the widget's array property 'Y-Axis' whose description equals the passed one and assigns the passed new value to it's property 'Description'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Description. Configuration Description'

    • description: string

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

    Returns void

setHighlightRangesYAxisDescriptionByIndex

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

  • Accesses the item of the widget's array property 'Y-Axis' at the passed index and assigns the passed new value to it's property 'Description'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Description. Configuration Description'

    • index: number

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

    Returns void

setHighlightRangesYAxisEnabledByDescription

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

  • Accesses the item of the widget's array property 'Y-Axis' 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. Enable this Configuration'

    • description: string

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

    Returns void

setHighlightRangesYAxisEnabledByIndex

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

  • Accesses the item of the widget's array property 'Y-Axis' 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. Enable this Configuration'

    • index: number

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

    Returns void

setHighlightRangesYAxisEndByDescription

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

  • Accesses the item of the widget's array property 'Y-Axis' whose description equals the passed one and assigns the passed new value to it's property 'End'

    Parameters

    • newValue: string

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

    • description: string

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

    Returns void

setHighlightRangesYAxisEndByIndex

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

  • Accesses the item of the widget's array property 'Y-Axis' at the passed index and assigns the passed new value to it's property 'End'

    Parameters

    • newValue: string

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

    • index: number

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

    Returns void

setHighlightRangesYAxisJsonString

  • setHighlightRangesYAxisJsonString(newHighlightRangesYAxis: string): void

  • Sets the value of the property 'Highlight Ranges YAxis' as a JSON-String.

    Parameters

    • newHighlightRangesYAxis: string

      Highlight Ranges YAxis

    Returns void

setHighlightRangesYAxisOpacityByDescription

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

  • Accesses the item of the widget's array property 'Y-Axis' whose description equals the passed one and assigns the passed new value to it's property 'Opacity'

    Parameters

    • newValue: string

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

    • description: string

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

    Returns void

setHighlightRangesYAxisOpacityByIndex

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

  • Accesses the item of the widget's array property 'Y-Axis' at the passed index and assigns the passed new value to it's property 'Opacity'

    Parameters

    • newValue: string

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

    • index: number

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

    Returns void

setHighlightRangesYAxisStartByDescription

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

  • Accesses the item of the widget's array property 'Y-Axis' whose description equals the passed one and assigns the passed new value to it's property 'Start'

    Parameters

    • newValue: string

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

    • description: string

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

    Returns void

setHighlightRangesYAxisStartByIndex

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

  • Accesses the item of the widget's array property 'Y-Axis' at the passed index and assigns the passed new value to it's property 'Start'

    Parameters

    • newValue: string

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

    • index: number

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

    Returns void

highlightedBubbles Methods

getHighlightedBubbles

  • getHighlightedBubbles(): string[]

  • Returns the value of the property 'Category Emphasis. Initial Emphasised Bubble Category Selector

    Returns string[]

getHighlightedBubblesJsonString

  • getHighlightedBubblesJsonString(): string

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

    Returns string

setHighlightedBubbles

  • setHighlightedBubbles(newValue: string[]): void

  • Sets the value of the property 'Category Emphasis'

    Parameters

    • newValue: string[]

      The new value of property 'Category Emphasis. Initial Emphasised Bubble Category Selector'

    Returns void

setHighlightedBubblesJsonString

  • setHighlightedBubblesJsonString(newHighlightedBubbles: string): void

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

    Parameters

    • newHighlightedBubbles: string

      Highlighted Bubbles

    Returns void

intervalXAxis Methods

getIntervalXAxis

  • getIntervalXAxis(): number

  • Returns the value of the property 'Interval XAxis' .

    Returns number

setIntervalXAxis

  • setIntervalXAxis(newIntervalXAxis: number): void

  • Sets the value of the property 'Interval XAxis' .

    Parameters

    • newIntervalXAxis: number

      Interval XAxis

    Returns void

intervalYAxis Methods

getIntervalYAxis

  • getIntervalYAxis(): number

  • Returns the value of the property 'Interval YAxis' .

    Returns number

setIntervalYAxis

  • setIntervalYAxis(newIntervalYAxis: number): void

  • Sets the value of the property 'Interval YAxis' .

    Parameters

    • newIntervalYAxis: number

      Interval YAxis

    Returns void

manualArcLabel Methods

getManualArcLabel

  • getManualArcLabel(): boolean

  • Returns the value of the property 'Manual Arc Label' .

    Returns boolean

setManualArcLabel

  • setManualArcLabel(newManualArcLabel: boolean): void

  • Sets the value of the property 'Manual Arc Label' .

    Parameters

    • newManualArcLabel: boolean

      Manual Arc Label

    Returns void

manualCircleLabel Methods

getManualCircleLabel

  • getManualCircleLabel(): boolean

  • Returns the value of the property 'Manual Circle Label' .

    Returns boolean

setManualCircleLabel

  • setManualCircleLabel(newManualCircleLabel: boolean): void

  • Sets the value of the property 'Manual Circle Label' .

    Parameters

    • newManualCircleLabel: boolean

      Manual Circle Label

    Returns void

manualDevLabel Methods

getManualDevLabel

  • getManualDevLabel(): boolean

  • Returns the value of the property 'Manual Dev Label' .

    Returns boolean

setManualDevLabel

  • setManualDevLabel(newManualDevLabel: boolean): void

  • Sets the value of the property 'Manual Dev Label' .

    Parameters

    • newManualDevLabel: boolean

      Manual Dev Label

    Returns void

manualXLabel Methods

getManualXLabel

  • getManualXLabel(): boolean

  • Returns the value of the property 'Manual XLabel' .

    Returns boolean

setManualXLabel

  • setManualXLabel(newManualXLabel: boolean): void

  • Sets the value of the property 'Manual XLabel' .

    Parameters

    • newManualXLabel: boolean

      Manual XLabel

    Returns void

manualYLabel Methods

getManualYLabel

  • getManualYLabel(): boolean

  • Returns the value of the property 'Manual YLabel' .

    Returns boolean

setManualYLabel

  • setManualYLabel(newManualYLabel: boolean): void

  • Sets the value of the property 'Manual YLabel' .

    Parameters

    • newManualYLabel: boolean

      Manual YLabel

    Returns void

maxRadius Methods

getMaxRadius

  • getMaxRadius(): number

  • Returns the value of the property 'Max Radius' .

    Returns number

setMaxRadius

  • setMaxRadius(newMaxRadius: number): void

  • Sets the value of the property 'Max Radius' .

    Parameters

    • newMaxRadius: number

      Max Radius

    Returns void

minRadius Methods

getMinRadius

  • getMinRadius(): number

  • Returns the value of the property 'Min Radius' .

    Returns number

setMinRadius

  • setMinRadius(newMinRadius: number): void

  • Sets the value of the property 'Min Radius' .

    Parameters

    • newMinRadius: number

      Min Radius

    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

performanceLimit Methods

getPerformanceLimit

  • getPerformanceLimit(): number

  • Returns the value of the property 'Performance Limit' .

    Returns number

setPerformanceLimit

  • setPerformanceLimit(newPerformanceLimit: number): void

  • Sets the value of the property 'Performance Limit' .

    Parameters

    • newPerformanceLimit: number

      Performance Limit

    Returns void

regressionLine Methods

getRegressionLineJsonString

  • getRegressionLineJsonString(): string

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

    Returns string

setRegressionLineJsonString

  • setRegressionLineJsonString(newRegressionLine: string): void

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

    Parameters

    • newRegressionLine: string

      Regression Line

    Returns void

reserveSpaceForAnnotations Methods

getReserveSpaceForAnnotations

  • getReserveSpaceForAnnotations(): boolean

  • Returns the value of the property 'Reserve Space For Annotations' .

    Returns boolean

setReserveSpaceForAnnotations

  • setReserveSpaceForAnnotations(newReserveSpaceForAnnotations: boolean): void

  • Sets the value of the property 'Reserve Space For Annotations' .

    Parameters

    • newReserveSpaceForAnnotations: boolean

      Reserve Space For Annotations

    Returns void

reserveSpaceForHiddenLabels Methods

getReserveSpaceForHiddenLabels

  • getReserveSpaceForHiddenLabels(): boolean

  • Returns the value of the property 'Reserve Space For Hidden Labels' .

    Returns boolean

setReserveSpaceForHiddenLabels

  • setReserveSpaceForHiddenLabels(newReserveSpaceForHiddenLabels: boolean): void

  • Sets the value of the property 'Reserve Space For Hidden Labels' .

    Parameters

    • newReserveSpaceForHiddenLabels: boolean

      Reserve Space For Hidden Labels

    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

smallTextFontSize Methods

getSmallTextFontSize

  • getSmallTextFontSize(): number

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

    Returns number

setSmallTextFontSize

  • setSmallTextFontSize(newSmallTextFontSize: number): void

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

    Parameters

    • newSmallTextFontSize: number

      Small Text Font Size

    Returns void

stepsXAxis Methods

getStepsXAxis

  • getStepsXAxis(): number

  • Returns the value of the property 'Steps XAxis' .

    Returns number

setStepsXAxis

  • setStepsXAxis(newStepsXAxis: number): void

  • Sets the value of the property 'Steps XAxis' .

    Parameters

    • newStepsXAxis: number

      Steps XAxis

    Returns void

stepsYAxis Methods

getStepsYAxis

  • getStepsYAxis(): number

  • Returns the value of the property 'Steps YAxis' .

    Returns number

setStepsYAxis

  • setStepsYAxis(newStepsYAxis: number): void

  • Sets the value of the property 'Steps YAxis' .

    Parameters

    • newStepsYAxis: number

      Steps YAxis

    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

textColor1 Methods

getTextColor1

  • getTextColor1(): string

  • Returns the value of the property 'Text Color1' .

    Returns string

setTextColor1

  • setTextColor1(newTextColor1: string): void

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

    Parameters

    • newTextColor1: string

      Text Color1

    Returns void

titleFontSize Methods

getTitleFontSize

  • getTitleFontSize(): number

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

    Returns number

setTitleFontSize

  • setTitleFontSize(newTitleFontSize: number): void

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

    Parameters

    • newTitleFontSize: number

      Title Font Size

    Returns void

titlePadding Methods

getTitlePadding

  • getTitlePadding(): number

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

    Returns number

setTitlePadding

  • setTitlePadding(newTitlePadding: number): void

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

    Parameters

    • newTitlePadding: number

      Title Padding

    Returns void

valueFormatAssignment Methods

getValueFormatAssignmentAbbreviationByDescription

  • getValueFormatAssignmentAbbreviationByDescription(description: string): string

  • Accesses the item of the widget's array property 'valueFormatAssignment' whose description equals the passed one and returns the value of it's property 'Abbreviations. Sets the way of finding the best suitable abbreviation for each value'

    Parameters

    • description: string

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

    Returns string

getValueFormatAssignmentAbbreviationByIndex

  • getValueFormatAssignmentAbbreviationByIndex(index: number): string

  • Accesses the item of the widget's array property 'valueFormatAssignment' at the passed index and returns the value of it's property 'Abbreviations. Sets the way of finding the best suitable abbreviation for each value'

    Parameters

    • index: number

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

    Returns string

getValueFormatAssignmentAddressSubsetByDescription

  • getValueFormatAssignmentAddressSubsetByDescription(description: string): SelectionContext

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

getValueFormatAssignmentAddressSubsetByIndex

  • getValueFormatAssignmentAddressSubsetByIndex(index: number): SelectionContext

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

getValueFormatAssignmentDescriptionByIndex

  • getValueFormatAssignmentDescriptionByIndex(index: number): string

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

getValueFormatAssignmentExplicitPositiveSignByDescription

  • getValueFormatAssignmentExplicitPositiveSignByDescription(description: string): boolean

  • Accesses the item of the widget's array property 'valueFormatAssignment' whose description equals the passed one and returns the value of it's property 'Explicit Positive Sign. When enabled, positive numbers will be displayed with a positive sign. By default positive numbers are shown without any sign'

    Parameters

    • description: string

      The description of the item whose property 'Explicit Positive Sign' should be returned

    Returns boolean

getValueFormatAssignmentExplicitPositiveSignByIndex

  • getValueFormatAssignmentExplicitPositiveSignByIndex(index: number): boolean

  • Accesses the item of the widget's array property 'valueFormatAssignment' at the passed index and returns the value of it's property 'Explicit Positive Sign. When enabled, positive numbers will be displayed with a positive sign. By default positive numbers are shown without any sign'

    Parameters

    • index: number

      The index of the item whose property 'Explicit Positive Sign' should be returned

    Returns boolean

getValueFormatAssignmentFormatByDescription

  • getValueFormatAssignmentFormatByDescription(description: string): string

  • Accesses the item of the widget's array property 'valueFormatAssignment' whose description equals the passed one and returns the value of it's property 'Format Type. Defines the format mode used for formatting values'

    Parameters

    • description: string

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

    Returns string

getValueFormatAssignmentFormatByIndex

  • getValueFormatAssignmentFormatByIndex(index: number): string

  • Accesses the item of the widget's array property 'valueFormatAssignment' at the passed index and returns the value of it's property 'Format Type. Defines the format mode used for formatting values'

    Parameters

    • index: number

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

    Returns string

getValueFormatAssignmentFractionalDigitsByDescription

  • getValueFormatAssignmentFractionalDigitsByDescription(description: string): number

  • Accesses the item of the widget's array property 'valueFormatAssignment' whose description equals the passed one and returns the value of it's property 'Decimal Digits. The value is formatted so its amount of fractional digits matches this number. If not defined, this option has no effect'

    Parameters

    • description: string

      The description of the item whose property 'Decimal Digits' should be returned

    Returns number

getValueFormatAssignmentFractionalDigitsByIndex

  • getValueFormatAssignmentFractionalDigitsByIndex(index: number): number

  • Accesses the item of the widget's array property 'valueFormatAssignment' at the passed index and returns the value of it's property 'Decimal Digits. The value is formatted so its amount of fractional digits matches this number. If not defined, this option has no effect'

    Parameters

    • index: number

      The index of the item whose property 'Decimal Digits' should be returned

    Returns number

getValueFormatAssignmentInfinityOutputByDescription

  • getValueFormatAssignmentInfinityOutputByDescription(description: string): string

  • Accesses the item of the widget's array property 'valueFormatAssignment' whose description equals the passed one and returns the value of it's property 'Infinity Format. This string gets used for displaying values which are results of undefined or failed arithmetic operations like dividing by zero'

    Parameters

    • description: string

      The description of the item whose property 'Infinity Format' should be returned

    Returns string

getValueFormatAssignmentInfinityOutputByIndex

  • getValueFormatAssignmentInfinityOutputByIndex(index: number): string

  • Accesses the item of the widget's array property 'valueFormatAssignment' at the passed index and returns the value of it's property 'Infinity Format. This string gets used for displaying values which are results of undefined or failed arithmetic operations like dividing by zero'

    Parameters

    • index: number

      The index of the item whose property 'Infinity Format' should be returned

    Returns string

getValueFormatAssignmentJsonString

  • getValueFormatAssignmentJsonString(): string

  • Returns the value of the property 'Value Format Assignment' as a JSON-String.

    Returns string

getValueFormatAssignmentLocaleIdByDescription

  • getValueFormatAssignmentLocaleIdByDescription(description: string): string

  • Accesses the item of the widget's array property 'valueFormatAssignment' whose description equals the passed one and returns the value of it's property 'Locale. Defines the locale used for formatting values. The locale setting affects separator signs and abbreviation notation'

    Parameters

    • description: string

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

    Returns string

getValueFormatAssignmentLocaleIdByIndex

  • getValueFormatAssignmentLocaleIdByIndex(index: number): string

  • Accesses the item of the widget's array property 'valueFormatAssignment' at the passed index and returns the value of it's property 'Locale. Defines the locale used for formatting values. The locale setting affects separator signs and abbreviation notation'

    Parameters

    • index: number

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

    Returns string

getValueFormatAssignmentNegativeSignByDescription

  • getValueFormatAssignmentNegativeSignByDescription(description: string): string

  • Accesses the item of the widget's array property 'valueFormatAssignment' whose description equals the passed one and returns the value of it's property 'Negative Sign. Defines how negative signs are displayed'

    Parameters

    • description: string

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

    Returns string

getValueFormatAssignmentNegativeSignByIndex

  • getValueFormatAssignmentNegativeSignByIndex(index: number): string

  • Accesses the item of the widget's array property 'valueFormatAssignment' at the passed index and returns the value of it's property 'Negative Sign. Defines how negative signs are displayed'

    Parameters

    • index: number

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

    Returns string

getValueFormatAssignmentNullOutputByDescription

  • getValueFormatAssignmentNullOutputByDescription(description: string): string

  • Accesses the item of the widget's array property 'valueFormatAssignment' whose description equals the passed one and returns the value of it's property 'Null Format. This string gets used for displaying null (non existing) values'

    Parameters

    • description: string

      The description of the item whose property 'Null Format' should be returned

    Returns string

getValueFormatAssignmentNullOutputByIndex

  • getValueFormatAssignmentNullOutputByIndex(index: number): string

  • Accesses the item of the widget's array property 'valueFormatAssignment' at the passed index and returns the value of it's property 'Null Format. This string gets used for displaying null (non existing) values'

    Parameters

    • index: number

      The index of the item whose property 'Null Format' should be returned

    Returns string

getValueFormatAssignmentPrefixByDescription

  • getValueFormatAssignmentPrefixByDescription(description: string): string

  • Accesses the item of the widget's array property 'valueFormatAssignment' whose description equals the passed one and returns the value of it's property 'Prefix. This string gets prepended to the value'

    Parameters

    • description: string

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

    Returns string

getValueFormatAssignmentPrefixByIndex

  • getValueFormatAssignmentPrefixByIndex(index: number): string

  • Accesses the item of the widget's array property 'valueFormatAssignment' at the passed index and returns the value of it's property 'Prefix. This string gets prepended to the value'

    Parameters

    • index: number

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

    Returns string

getValueFormatAssignmentRoundingMethodByDescription

  • getValueFormatAssignmentRoundingMethodByDescription(description: string): string

  • Accesses the item of the widget's array property 'valueFormatAssignment' whose description equals the passed one and returns the value of it's property 'Rounding Method. Defines the way values get rounded'

    Parameters

    • description: string

      The description of the item whose property 'Rounding Method' should be returned

    Returns string

getValueFormatAssignmentRoundingMethodByIndex

  • getValueFormatAssignmentRoundingMethodByIndex(index: number): string

  • Accesses the item of the widget's array property 'valueFormatAssignment' at the passed index and returns the value of it's property 'Rounding Method. Defines the way values get rounded'

    Parameters

    • index: number

      The index of the item whose property 'Rounding Method' should be returned

    Returns string

getValueFormatAssignmentScalingFactorByDescription

  • getValueFormatAssignmentScalingFactorByDescription(description: string): number

  • Accesses the item of the widget's array property 'valueFormatAssignment' whose description equals the passed one and returns the value of it's property 'Scaling Factor. The value gets multiplied by this number'

    Parameters

    • description: string

      The description of the item whose property 'Scaling Factor' should be returned

    Returns number

getValueFormatAssignmentScalingFactorByIndex

  • getValueFormatAssignmentScalingFactorByIndex(index: number): number

  • Accesses the item of the widget's array property 'valueFormatAssignment' at the passed index and returns the value of it's property 'Scaling Factor. The value gets multiplied by this number'

    Parameters

    • index: number

      The index of the item whose property 'Scaling Factor' should be returned

    Returns number

getValueFormatAssignmentSuffixByDescription

  • getValueFormatAssignmentSuffixByDescription(description: string): string

  • Accesses the item of the widget's array property 'valueFormatAssignment' whose description equals the passed one and returns the value of it's property 'Suffix. This string gets appended to the value'

    Parameters

    • description: string

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

    Returns string

getValueFormatAssignmentSuffixByIndex

  • getValueFormatAssignmentSuffixByIndex(index: number): string

  • Accesses the item of the widget's array property 'valueFormatAssignment' at the passed index and returns the value of it's property 'Suffix. This string gets appended to the value'

    Parameters

    • index: number

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

    Returns string

setValueFormatAssignmentAbbreviationByDescription

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

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

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Abbreviations. Sets the way of finding the best suitable abbreviation for each value'

    • description: string

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

    Returns void

setValueFormatAssignmentAbbreviationByIndex

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

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

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Abbreviations. Sets the way of finding the best suitable abbreviation for each value'

    • index: number

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

    Returns void

setValueFormatAssignmentAddressSubsetByDescription

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

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

setValueFormatAssignmentAddressSubsetByIndex

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

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

setValueFormatAssignmentDescriptionByDescription

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

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

setValueFormatAssignmentDescriptionByIndex

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

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

setValueFormatAssignmentExplicitPositiveSignByDescription

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

  • Accesses the item of the widget's array property 'valueFormatAssignment' whose description equals the passed one and assigns the passed new value to it's property 'Explicit Positive Sign'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Explicit Positive Sign. When enabled, positive numbers will be displayed with a positive sign. By default positive numbers are shown without any sign'

    • description: string

      The description of the item whose property 'Explicit Positive Sign' should be set

    Returns void

setValueFormatAssignmentExplicitPositiveSignByIndex

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

  • Accesses the item of the widget's array property 'valueFormatAssignment' at the passed index and assigns the passed new value to it's property 'Explicit Positive Sign'

    Parameters

    • newValue: boolean

      The new value to be assigned to the property 'Explicit Positive Sign. When enabled, positive numbers will be displayed with a positive sign. By default positive numbers are shown without any sign'

    • index: number

      The index of the item whose property 'Explicit Positive Sign' should be set

    Returns void

setValueFormatAssignmentFormatByDescription

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

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

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Format Type. Defines the format mode used for formatting values'

    • description: string

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

    Returns void

setValueFormatAssignmentFormatByIndex

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

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

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Format Type. Defines the format mode used for formatting values'

    • index: number

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

    Returns void

setValueFormatAssignmentFractionalDigitsByDescription

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

  • Accesses the item of the widget's array property 'valueFormatAssignment' whose description equals the passed one and assigns the passed new value to it's property 'Decimal Digits'

    Parameters

    • newValue: number

      The new value to be assigned to the property 'Decimal Digits. The value is formatted so its amount of fractional digits matches this number. If not defined, this option has no effect'

    • description: string

      The description of the item whose property 'Decimal Digits' should be set

    Returns void

setValueFormatAssignmentFractionalDigitsByIndex

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

  • Accesses the item of the widget's array property 'valueFormatAssignment' at the passed index and assigns the passed new value to it's property 'Decimal Digits'

    Parameters

    • newValue: number

      The new value to be assigned to the property 'Decimal Digits. The value is formatted so its amount of fractional digits matches this number. If not defined, this option has no effect'

    • index: number

      The index of the item whose property 'Decimal Digits' should be set

    Returns void

setValueFormatAssignmentInfinityOutputByDescription

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

  • Accesses the item of the widget's array property 'valueFormatAssignment' whose description equals the passed one and assigns the passed new value to it's property 'Infinity Format'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Infinity Format. This string gets used for displaying values which are results of undefined or failed arithmetic operations like dividing by zero'

    • description: string

      The description of the item whose property 'Infinity Format' should be set

    Returns void

setValueFormatAssignmentInfinityOutputByIndex

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

  • Accesses the item of the widget's array property 'valueFormatAssignment' at the passed index and assigns the passed new value to it's property 'Infinity Format'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Infinity Format. This string gets used for displaying values which are results of undefined or failed arithmetic operations like dividing by zero'

    • index: number

      The index of the item whose property 'Infinity Format' should be set

    Returns void

setValueFormatAssignmentJsonString

  • setValueFormatAssignmentJsonString(newValueFormatAssignment: string): void

  • Sets the value of the property 'Value Format Assignment' as a JSON-String.

    Parameters

    • newValueFormatAssignment: string

      Value Format Assignment

    Returns void

setValueFormatAssignmentLocaleIdByDescription

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

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

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Locale. Defines the locale used for formatting values. The locale setting affects separator signs and abbreviation notation'

    • description: string

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

    Returns void

setValueFormatAssignmentLocaleIdByIndex

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

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

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Locale. Defines the locale used for formatting values. The locale setting affects separator signs and abbreviation notation'

    • index: number

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

    Returns void

setValueFormatAssignmentNegativeSignByDescription

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

  • Accesses the item of the widget's array property 'valueFormatAssignment' whose description equals the passed one and assigns the passed new value to it's property 'Negative Sign'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Negative Sign. Defines how negative signs are displayed'

    • description: string

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

    Returns void

setValueFormatAssignmentNegativeSignByIndex

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

  • Accesses the item of the widget's array property 'valueFormatAssignment' at the passed index and assigns the passed new value to it's property 'Negative Sign'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Negative Sign. Defines how negative signs are displayed'

    • index: number

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

    Returns void

setValueFormatAssignmentNullOutputByDescription

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

  • Accesses the item of the widget's array property 'valueFormatAssignment' whose description equals the passed one and assigns the passed new value to it's property 'Null Format'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Null Format. This string gets used for displaying null (non existing) values'

    • description: string

      The description of the item whose property 'Null Format' should be set

    Returns void

setValueFormatAssignmentNullOutputByIndex

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

  • Accesses the item of the widget's array property 'valueFormatAssignment' at the passed index and assigns the passed new value to it's property 'Null Format'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Null Format. This string gets used for displaying null (non existing) values'

    • index: number

      The index of the item whose property 'Null Format' should be set

    Returns void

setValueFormatAssignmentPrefixByDescription

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

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

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Prefix. This string gets prepended to the value'

    • description: string

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

    Returns void

setValueFormatAssignmentPrefixByIndex

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

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

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Prefix. This string gets prepended to the value'

    • index: number

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

    Returns void

setValueFormatAssignmentRoundingMethodByDescription

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

  • Accesses the item of the widget's array property 'valueFormatAssignment' whose description equals the passed one and assigns the passed new value to it's property 'Rounding Method'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Rounding Method. Defines the way values get rounded'

    • description: string

      The description of the item whose property 'Rounding Method' should be set

    Returns void

setValueFormatAssignmentRoundingMethodByIndex

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

  • Accesses the item of the widget's array property 'valueFormatAssignment' at the passed index and assigns the passed new value to it's property 'Rounding Method'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Rounding Method. Defines the way values get rounded'

    • index: number

      The index of the item whose property 'Rounding Method' should be set

    Returns void

setValueFormatAssignmentScalingFactorByDescription

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

  • Accesses the item of the widget's array property 'valueFormatAssignment' whose description equals the passed one and assigns the passed new value to it's property 'Scaling Factor'

    Parameters

    • newValue: number

      The new value to be assigned to the property 'Scaling Factor. The value gets multiplied by this number'

    • description: string

      The description of the item whose property 'Scaling Factor' should be set

    Returns void

setValueFormatAssignmentScalingFactorByIndex

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

  • Accesses the item of the widget's array property 'valueFormatAssignment' at the passed index and assigns the passed new value to it's property 'Scaling Factor'

    Parameters

    • newValue: number

      The new value to be assigned to the property 'Scaling Factor. The value gets multiplied by this number'

    • index: number

      The index of the item whose property 'Scaling Factor' should be set

    Returns void

setValueFormatAssignmentSuffixByDescription

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

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

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Suffix. This string gets appended to the value'

    • description: string

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

    Returns void

setValueFormatAssignmentSuffixByIndex

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

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

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Suffix. This string gets appended to the value'

    • index: number

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

    Returns void

valueLabelFontSize Methods

getValueLabelFontSize

  • getValueLabelFontSize(): number

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

    Returns number

setValueLabelFontSize

  • setValueLabelFontSize(newValueLabelFontSize: number): void

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

    Parameters

    • newValueLabelFontSize: number

      Value Label Font Size

    Returns void

xLabel Methods

getXLabel

  • getXLabel(): string

  • Returns the value of the property 'XLabel' .

    Returns string

setXLabel

  • setXLabel(newXLabel: string): void

  • Sets the value of the property 'XLabel' .

    Parameters

    • newXLabel: string

      XLabel

    Returns void

xMeasureKey Methods

getXMeasureKey

  • getXMeasureKey(): string

  • Returns the value of the property 'XMeasure Key' .

    Returns string

setXMeasureKey

  • setXMeasureKey(newXMeasureKey: string): void

  • Sets the value of the property 'XMeasure Key' .

    Parameters

    • newXMeasureKey: string

      XMeasure Key

    Returns void

yLabel Methods

getYLabel

  • getYLabel(): string

  • Returns the value of the property 'YLabel' .

    Returns string

setYLabel

  • setYLabel(newYLabel: string): void

  • Sets the value of the property 'YLabel' .

    Parameters

    • newYLabel: string

      YLabel

    Returns void

yMeasureKey Methods

getYMeasureKey

  • getYMeasureKey(): string

  • Returns the value of the property 'YMeasure Key' .

    Returns string

setYMeasureKey

  • setYMeasureKey(newYMeasureKey: string): void

  • Sets the value of the property 'YMeasure Key' .

    Parameters

    • newYMeasureKey: string

      YMeasure Key

    Returns void

zoomMode Methods

getZoomMode

  • getZoomMode(): string

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

    Returns string

setZoomMode

  • setZoomMode(newZoomMode: string): void

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

    Parameters

    • newZoomMode: string

      Zoom Mode

    Returns void