Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "lib/settings/helpers"

Index

Variables

Functions

Variables

METADATA_KEY

METADATA_KEY: string = "__settings__"

assignIn

assignIn: any = require("lodash/assignIn")

ldget

ldget: any = require("lodash/get")

merge

merge: any = require("lodash/merge")

stringify

stringify: any = require("json-stringify-safe")

Functions

buildCapabilitiesObject

  • buildCapabilitiesObject(setting: ISetting): object

  • Builds a single capabilities object for the given setting

    Parameters

    • setting: ISetting

      The setting to generate the capabilities object from

    Returns object

    • displayName: string
    • objectName: string
    • properties: object

buildCapabilitiesObjects

  • buildCapabilitiesObjects<T>(settingsClass: ISettingsClass<T>): DataViewObjectDescriptors

  • Builds the capabilities objects dynamically from a settings class

    Type parameters

    • T

    Parameters

    • settingsClass: ISettingsClass<T>

      The settings class type to generate the capabilities object from

    Returns DataViewObjectDescriptors

buildEnumerationObject

  • buildEnumerationObject(setting: ISetting, settingsObj: any, dataView: DataView, includeHidden?: boolean, instances: VisualObjectInstance[]): void

  • Builds a single enumeration object for the given setting and adds it to the list of instances TODO: Think about removing the instances param, and just returning an instance and making the caller deal with how to add it

    Parameters

    • setting: ISetting

      The setting to get the enumeration object for

    • settingsObj: any

      The instance of the class to read the current setting values from

    • dataView: DataView

      The dataview to construct the settings from

    • Default value includeHidden: boolean = false

      If True, 'hidden' settings will be returned

    • instances: VisualObjectInstance[]

      The set of instances to add to

    Returns void

buildEnumerationObjects

  • buildEnumerationObjects<T>(settingsClass: ISettingsClass<T>, settingsObj: T, objectName: string, dataView: DataView, includeHidden?: boolean): VisualObjectInstance[]

  • Builds the enumeration objects for the given settings object

    Type parameters

    • T

    Parameters

    • settingsClass: ISettingsClass<T>

      The class type of the class with the settings

    • settingsObj: T

      The instance of the class to read the current setting values from

    • objectName: string

      The objectName being requested from enumerateObjectInstances

    • dataView: DataView

      The dataview to construct the settings from

    • Default value includeHidden: boolean = false

      If True, 'hidden' settings will be returned

    Returns VisualObjectInstance[]

buildPersistObject

  • Builds a single persist object for the given setting

    Parameters

    • setting: ISetting

      The setting to persist the value for

    • settingsObj: any

      The instance of the class to read the current setting values from

    • dataView: DataView

      The dataview to construct the settings from

    • Default value includeHidden: boolean = true

      If True, 'hidden' settings will be returned

    • builder: IPersistObjectBuilder

      The persist object builder to add the setting value to

    Returns void

buildPersistObjects

  • buildPersistObjects<T>(settingsClass: ISettingsClass<T>, settingsObj: T, dataView: DataView, includeHidden?: boolean): VisualObjectInstancesToPersist

  • Builds a set of persistance objects to be persisted from the current set of settings. Can be used with IVisualHost.persistProperties

    Type parameters

    • T

    Parameters

    • settingsClass: ISettingsClass<T>

      The class type of the class with the settings

    • settingsObj: T

      The instance of the class to read the current setting values from

    • dataView: DataView

      The dataview to construct the settings from

    • Default value includeHidden: boolean = true

      If True, 'hidden' settings will be returned

    Returns VisualObjectInstancesToPersist

camelize

  • camelize(str: string): string

  • Converts any string into a camel cased string

    Parameters

    • str: string

      The string to conver to camel case

    Returns string

composeInstance

  • composeInstance(setting: ISetting, selector?: Selector, displayName?: string, value?: any): object

  • Composes an object instance with the given values

    Parameters

    • setting: ISetting
    • Optional selector: Selector
    • Optional displayName: string
    • Optional value: any

    Returns object

    • displayName: string
    • objectName: string
    • selector: Selector
    • properties: object
      • __computed: any

convertValueFromPBI

  • convertValueFromPBI(setting: ISetting, dv: DataView): object

  • Converts the value for the given setting in PBI to a regular setting value

    Parameters

    • setting: ISetting

      The setting to get the value for

    • dv: DataView

      The dataView to pass to the setting

    Returns object

    • adaptedValue: any

convertValueToPBI

  • convertValueToPBI(settingsObj: any, setting: ISetting, dataView: DataView, includeHidden?: boolean): object

  • Converts the value of the given setting on the object to a powerbi compatible value

    Parameters

    • settingsObj: any

      The instance of a settings object

    • setting: ISetting

      The setting to get the value for

    • dataView: DataView

      The dataView to pass to the setting

    • Default value includeHidden: boolean = false

      If True, 'hidden' settings will be returned

    Returns object

    • adaptedValue: any

createObjectSelectorForColumn

  • createObjectSelectorForColumn(column: DataViewMetadataColumn, id?: string): Selector

  • Creates a selector for PBI that is for a specific column, and an optional unique user defined id Having an id allows for storing multiple instances of objects under a single objectName/propertyName in VisualObjectInstancesToPersist

    Parameters

    • column: DataViewMetadataColumn
    • Optional id: string

    Returns Selector

getObjectsForColumn

  • getObjectsForColumn(column: DataViewMetadataColumn, setting: ISetting, id?: string): any

  • Gets all of the objects for the given column, if an id is specified, it looks for the specific instance with the given id

    Parameters

    • column: DataViewMetadataColumn
    • setting: ISetting
    • Optional id: string

    Returns any

getPBIObjectNameAndPropertyName

  • getPBIObjectNameAndPropertyName(setting: ISetting): object

  • Gets the appropriate object name and property name for powerbi from the given setting

    Parameters

    • setting: ISetting

      The setting to get the powerbi objectName and property name for.

    Returns object

    • objName: string
    • propName: string

getSetting

getSettingsMetadata

parseSettingsFromPBI

  • parseSettingsFromPBI<T>(settingClass: ISettingsClass<T>, dv?: DataView, props?: object, propsHavePrecedence?: boolean, coerceNullAsUndefined?: boolean): T

  • Parses settings from powerbi dataview objects

    Type parameters

    • T

    Parameters

    • settingClass: ISettingsClass<T>
    • Optional dv: DataView

      The dataview to construct the settings from

    • Default value props: object = {}

      Any additional properties to merge into the settings object

    • Default value propsHavePrecedence: boolean = true

      If true, the additional properties passed in should override any that are retrieved from PBI

    • Default value coerceNullAsUndefined: boolean = true

      If true, the props that are 'null' will get converted to undefined

    Returns T

shouldEnumerate

  • shouldEnumerate(settingsObj: any, descriptor: ISettingDescriptor<any>, dataView: DataView): boolean

  • Determines if the given descriptor should be enumerated

    Parameters

    • settingsObj: any

      The instance of the settings class

    • descriptor: ISettingDescriptor<any>

      The descriptor to check

    • dataView: DataView

      The current dataView

    Returns boolean

shouldPersist

toJSON

  • Converts the given settings object into a JSON object

    Type parameters

    • T

    Parameters

    • settingsClass: ISettingsClass<T>

      The settings class type to generate the JSON object for

    • instance: any

      The instance of settingsClass to get the values from

    Returns any

Generated using TypeDoc