Menu

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

Hierarchy

  • ScriptingApi

Index

Event Properties

General Methods

axisThickness Methods

categorySpacing Methods

dualMode Methods

fadeOutOpacity Methods

fontColor Methods

fontFamily Methods

fontSize Methods

footerFontSize Methods

footerSpacing Methods

footerText Methods

hierarchicalCategorySpacing Methods

iconAssignment Methods

iconSpacing Methods

legendPosition Methods

maxIconNumber Methods

measuresInCategories Methods

membersInCategories Methods

orientation Methods

padding Methods

scaleMode Methods

serverUrl Methods

showElementLabels Methods

showFooterText Methods

showTitleText Methods

showTooltips Methods

suppressRepeatingCategoryLabels Methods

templateName Methods

titleFontSize Methods

titleSpacing Methods

titleText Methods

Event Properties

onSelect

onSelect: Function

Fires when a data selection was made on this component.

General Methods

clearSelection

  • clearSelection(): void

  • Clears the selection of this visual

    Returns void

filterDataSourceBySelectedData

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

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

    Parameters

    • dataSource: unknown

      Data Source

    • Optional dimensions: string[]

    Returns void

getSelectedData

  • getSelectedData(): SelectionContext[]

  • Returns the current selection state of this component

    Returns SelectionContext[]

getValueFormatAssignmentJsonString

  • getValueFormatAssignmentJsonString(): string

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

    Returns string

setResultSetFromChart

  • setResultSetFromChart(chart: unknown): void

  • Sets the resultset from choosen chart as pictograms data.

    Parameters

    • chart: unknown

      Chart widget whose resultset will be bound to the graphomate pictograms

    Returns void

setValueFormatAssignmentJsonString

  • setValueFormatAssignmentJsonString(newValueFormatAssignment: string): void

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

    Parameters

    • newValueFormatAssignment: string

      Value Format Assignment

    Returns void

axisThickness Methods

getAxisThickness

  • getAxisThickness(): string

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

    Returns string

setAxisThickness

  • setAxisThickness(newAxisThickness: string): void

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

    Parameters

    • newAxisThickness: string

      Axis Thickness

    Returns void

categorySpacing Methods

getCategorySpacing

  • getCategorySpacing(): string

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

    Returns string

setCategorySpacing

  • setCategorySpacing(newCategorySpacing: string): void

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

    Parameters

    • newCategorySpacing: string

      Category Spacing

    Returns void

dualMode Methods

getDualMode

  • getDualMode(): boolean

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

    Returns boolean

setDualMode

  • setDualMode(newDualMode: boolean): void

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

    Parameters

    • newDualMode: boolean

      Dual Mode

    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

fontColor Methods

getFontColor

  • getFontColor(): string

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

    Returns string

setFontColor

  • setFontColor(newFontColor: string): void

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

    Parameters

    • newFontColor: string

      Font Color

    Returns void

fontFamily Methods

getFontFamily

  • getFontFamily(): string

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

    Returns string

setFontFamily

  • setFontFamily(newFontFamily: string): void

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

    Parameters

    • newFontFamily: string

      Font Family

    Returns void

fontSize Methods

getFontSize

  • getFontSize(): string

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

    Returns string

setFontSize

  • setFontSize(newFontSize: string): void

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

    Parameters

    • newFontSize: string

      Font Size

    Returns void

footerFontSize Methods

getFooterFontSize

  • getFooterFontSize(): string

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

    Returns string

setFooterFontSize

  • setFooterFontSize(newFooterFontSize: string): void

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

    Parameters

    • newFooterFontSize: string

      Footer Font Size

    Returns void

footerSpacing Methods

getFooterSpacing

  • getFooterSpacing(): string

  • Returns the value of the property 'Footer Spacing' .

    Returns string

setFooterSpacing

  • setFooterSpacing(newFooterSpacing: string): void

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

    Parameters

    • newFooterSpacing: string

      Footer Spacing

    Returns void

footerText Methods

getFooterText

  • getFooterText(): string

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

    Returns string

setFooterText

  • setFooterText(newFooterText: string): void

  • Sets the value of the property 'Footer Text' .

    Parameters

    • newFooterText: string

      Footer Text

    Returns void

hierarchicalCategorySpacing Methods

getHierarchicalCategorySpacing

  • getHierarchicalCategorySpacing(): string

  • Returns the value of the property 'Hierarchical Category Spacing' .

    Returns string

setHierarchicalCategorySpacing

  • setHierarchicalCategorySpacing(newHierarchicalCategorySpacing: string): void

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

    Parameters

    • newHierarchicalCategorySpacing: string

      Hierarchical Category Spacing

    Returns void

iconAssignment Methods

getIconAssignmentAddressSubsetByDescription

  • getIconAssignmentAddressSubsetByDescription(description: string): SelectionContext

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

    Parameters

    • description: string

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

    Returns SelectionContext

getIconAssignmentAddressSubsetByIndex

  • getIconAssignmentAddressSubsetByIndex(index: number): SelectionContext

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

    Parameters

    • index: number

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

    Returns SelectionContext

getIconAssignmentCustomIconUrlByDescription

  • getIconAssignmentCustomIconUrlByDescription(description: string): string

  • Accesses the item of the widget's array property 'Icon Assignment' whose description equals the passed one and returns the value of it's property 'Custom Icon URL. Custom icon url or base64-encoded data-url'

    Parameters

    • description: string

      The description of the item whose property 'Custom Icon URL' should be returned

    Returns string

getIconAssignmentCustomIconUrlByIndex

  • getIconAssignmentCustomIconUrlByIndex(index: number): string

  • Accesses the item of the widget's array property 'Icon Assignment' at the passed index and returns the value of it's property 'Custom Icon URL. Custom icon url or base64-encoded data-url'

    Parameters

    • index: number

      The index of the item whose property 'Custom Icon URL' should be returned

    Returns string

getIconAssignmentDescriptionByIndex

  • getIconAssignmentDescriptionByIndex(index: number): string

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

    Parameters

    • index: number

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

    Returns string

getIconAssignmentIconByDescription

  • getIconAssignmentIconByDescription(description: string): string

  • Accesses the item of the widget's array property 'Icon Assignment' whose description equals the passed one and returns the value of it's property 'Source. Icon selection of predefined icons'

    Parameters

    • description: string

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

    Returns string

getIconAssignmentIconByIndex

  • getIconAssignmentIconByIndex(index: number): string

  • Accesses the item of the widget's array property 'Icon Assignment' at the passed index and returns the value of it's property 'Source. Icon selection of predefined icons'

    Parameters

    • index: number

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

    Returns string

getIconAssignmentJsonString

  • getIconAssignmentJsonString(): string

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

    Returns string

setIconAssignmentAddressSubsetByDescription

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

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

    Parameters

    • newValue: SelectionContext

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

    • description: string

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

    Returns void

setIconAssignmentAddressSubsetByIndex

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

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

    Parameters

    • newValue: SelectionContext

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

    • index: number

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

    Returns void

setIconAssignmentCustomIconUrlByDescription

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

  • Accesses the item of the widget's array property 'Icon Assignment' whose description equals the passed one and assigns the passed new value to it's property 'Custom Icon URL'

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Custom Icon URL. Custom icon url or base64-encoded data-url'

    • description: string

      The description of the item whose property 'Custom Icon URL' should be set

    Returns void

setIconAssignmentCustomIconUrlByIndex

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

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

    Parameters

    • newValue: string

      The new value to be assigned to the property 'Custom Icon URL. Custom icon url or base64-encoded data-url'

    • index: number

      The index of the item whose property 'Custom Icon URL' should be set

    Returns void

setIconAssignmentDescriptionByDescription

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

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

    Parameters

    • newValue: string

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

    • description: string

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

    Returns void

setIconAssignmentDescriptionByIndex

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

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

    Parameters

    • newValue: string

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

    • index: number

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

    Returns void

setIconAssignmentIconByDescription

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

  • Accesses the item of the widget's array property 'Icon Assignment' 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. Icon selection of predefined icons'

    • description: string

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

    Returns void

setIconAssignmentIconByIndex

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

  • Accesses the item of the widget's array property 'Icon Assignment' 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. Icon selection of predefined icons'

    • index: number

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

    Returns void

setIconAssignmentJsonString

  • setIconAssignmentJsonString(newIconAssignment: string): void

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

    Parameters

    • newIconAssignment: string

      Icon Assignment

    Returns void

iconSpacing Methods

getIconSpacing

  • getIconSpacing(): string

  • Returns the value of the property 'Icon Spacing' .

    Returns string

setIconSpacing

  • setIconSpacing(newIconSpacing: string): void

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

    Parameters

    • newIconSpacing: string

      Icon Spacing

    Returns void

legendPosition Methods

getLegendPosition

  • getLegendPosition(): string

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

    Returns string

setLegendPosition

  • setLegendPosition(newLegendPosition: string): void

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

    Parameters

    • newLegendPosition: string

      Legend Position

    Returns void

maxIconNumber Methods

getMaxIconNumber

  • getMaxIconNumber(): number

  • Returns the value of the property 'Max Icon Number' .

    Returns number

setMaxIconNumber

  • setMaxIconNumber(newMaxIconNumber: number): void

  • Sets the value of the property 'Max Icon Number' .

    Parameters

    • newMaxIconNumber: number

      Max Icon Number

    Returns void

measuresInCategories Methods

getMeasuresInCategories

  • getMeasuresInCategories(): boolean

  • Returns the value of the property 'Measures In Categories' .

    Returns boolean

setMeasuresInCategories

  • setMeasuresInCategories(newMeasuresInCategories: boolean): void

  • Sets the value of the property 'Measures In Categories' .

    Parameters

    • newMeasuresInCategories: boolean

      Measures In Categories

    Returns void

membersInCategories Methods

getMembersInCategories

  • getMembersInCategories(): boolean

  • Returns the value of the property 'Members In Categories' .

    Returns boolean

setMembersInCategories

  • setMembersInCategories(newMembersInCategories: boolean): void

  • Sets the value of the property 'Members In Categories' .

    Parameters

    • newMembersInCategories: boolean

      Members In Categories

    Returns void

orientation Methods

getOrientation

  • getOrientation(): string

  • Returns the value of the property 'Orientation' .

    Returns string

setOrientation

  • setOrientation(newOrientation: string): void

  • Sets the value of the property 'Orientation' .

    Parameters

    • newOrientation: string

      Orientation

    Returns void

padding Methods

getPadding

  • getPadding(): string

  • Returns the value of the property 'Padding' .

    Returns string

setPadding

  • setPadding(newPadding: string): void

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

    Parameters

    • newPadding: string

      Padding

    Returns void

scaleMode Methods

getScaleMode

  • getScaleMode(): string

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

    Returns string

setScaleMode

  • setScaleMode(newScaleMode: string): void

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

    Parameters

    • newScaleMode: string

      Scale Mode

    Returns void

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

showElementLabels Methods

getShowElementLabels

  • getShowElementLabels(): boolean

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

    Returns boolean

setShowElementLabels

  • setShowElementLabels(newShowElementLabels: boolean): void

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

    Parameters

    • newShowElementLabels: boolean

      Show Element Labels

    Returns void

showFooterText Methods

getShowFooterText

  • getShowFooterText(): boolean

  • Returns the value of the property 'Show Footer Text' .

    Returns boolean

setShowFooterText

  • setShowFooterText(newShowFooterText: boolean): void

  • Sets the value of the property 'Show Footer Text' .

    Parameters

    • newShowFooterText: boolean

      Show Footer Text

    Returns void

showTitleText Methods

getShowTitleText

  • getShowTitleText(): boolean

  • Returns the value of the property 'Show Title Text' .

    Returns boolean

setShowTitleText

  • setShowTitleText(newShowTitleText: boolean): void

  • Sets the value of the property 'Show Title Text' .

    Parameters

    • newShowTitleText: boolean

      Show Title Text

    Returns void

showTooltips Methods

getShowTooltips

  • getShowTooltips(): boolean

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

    Returns boolean

setShowTooltips

  • setShowTooltips(newShowTooltips: boolean): void

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

    Parameters

    • newShowTooltips: boolean

      Show Tooltips

    Returns void

suppressRepeatingCategoryLabels Methods

getSuppressRepeatingCategoryLabels

  • getSuppressRepeatingCategoryLabels(): boolean

  • Returns the value of the property 'Suppress Repeating Category Labels' .

    Returns boolean

setSuppressRepeatingCategoryLabels

  • setSuppressRepeatingCategoryLabels(newSuppressRepeatingCategoryLabels: boolean): void

  • Sets the value of the property 'Suppress Repeating Category Labels' .

    Parameters

    • newSuppressRepeatingCategoryLabels: boolean

      Suppress Repeating Category Labels

    Returns void

templateName Methods

getTemplateName

  • getTemplateName(): string

  • Returns the value of the property 'Template Name' .

    Returns string

setTemplateName

  • setTemplateName(newTemplateName: string): void

  • Sets the value of the property 'Template Name' .

    Parameters

    • newTemplateName: string

      Template Name

    Returns void

titleFontSize Methods

getTitleFontSize

  • getTitleFontSize(): string

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

    Returns string

setTitleFontSize

  • setTitleFontSize(newTitleFontSize: string): void

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

    Parameters

    • newTitleFontSize: string

      Title Font Size

    Returns void

titleSpacing Methods

getTitleSpacing

  • getTitleSpacing(): string

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

    Returns string

setTitleSpacing

  • setTitleSpacing(newTitleSpacing: string): void

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

    Parameters

    • newTitleSpacing: string

      Title Spacing

    Returns void

titleText Methods

getTitleText

  • getTitleText(): string

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

    Returns string

setTitleText

  • setTitleText(newTitleText: string): void

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

    Parameters

    • newTitleText: string

      Title Text

    Returns void