Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HasSettings

A simple class with utility methods to facilitate settings parsing.

Hierarchy

Index

Methods

Methods

buildEnumerationObjects

  • buildEnumerationObjects(objectName: string, dataView: DataView, includeHidden?: boolean): Array<VisualObjectInstance>

  • Builds the enumeration objects

    Parameters

    • objectName: string

      The objectName being requested from enumerateObjectInstances

    • dataView: DataView

      The currently loaded dataView

    • Default value includeHidden: boolean = false

      If true, 'hidden' settings will be returned

    Returns Array<VisualObjectInstance>

buildPersistObjects

  • buildPersistObjects(dataView: DataView, includeHidden?: boolean): VisualObjectInstancesToPersist

  • Builds a set of persistance objects to be persisted from the current set of settings.

    Parameters

    • dataView: DataView

      The currently loaded dataView

    • Default value includeHidden: boolean = false

      If true, 'hidden' settings will be returned

    Returns VisualObjectInstancesToPersist

receive

  • receive(props?: any): this

  • Receives the given object and returns a new state with the object overlayed with the this set of settings

    Parameters

    • Optional props: any

      The properties to mixin to the resulting class

    Returns this

receiveFromPBI

  • receiveFromPBI(dv?: DataView): this

  • Receives the given pbi settings and returns a new state with the new pbi settings overlayed with the this state

    Parameters

    • Optional dv: DataView

      The dataView to receive

    Returns this

toJSONObject

  • toJSONObject(): any

Static buildCapabilitiesObjects

  • buildCapabilitiesObjects(): DataViewObjectDescriptors

Static create

  • create<T>(props?: any): T

  • Creates a new instance of this class

    Type parameters

    Parameters

    • Optional props: any

      A set of additional properties to mixin to this settings class

    Returns T

Static createFromPBI

  • createFromPBI<T>(dv?: DataView, additionalProps?: any): T

  • Creates a new instance of this class with the data from powerbi and the additional properties.

    Type parameters

    Parameters

    • Optional dv: DataView

      The dataview to create the settings from

    • Optional additionalProps: any

      The additional set of properties to mixin to this settings class

    Returns T

Generated using TypeDoc