Class GradientSettings

A set of gradient settings

Hierarchy

HasSettings
- GradientSettings

Implements

IGradient

Index

Properties

Methods

Properties

Optional endColor

endColor: string

The end color for the gradient

Optional endValue

endValue: number

The end value of the gradient

Optional startColor

startColor: string

The start color for the gradient

Optional startValue

startValue: number

The start value of the gradient

Methods

buildEnumerationObjects

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

Inherited from HasSettings.buildEnumerationObjects
- Defined in lib/settings/HasSettings.ts:85
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

Inherited from HasSettings.buildPersistObjects
- Defined in lib/settings/HasSettings.ts:94
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

equals

equals(other: GradientSettings): boolean

- Defined in lib/settings/gradient/GradientSettings.ts:75
Determines if this color settings is equal to another

Parameters
- other: GradientSettings
Returns boolean

receive

receive(props?: any): this

Inherited from HasSettings.receive
- Defined in lib/settings/HasSettings.ts:67
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

Inherited from HasSettings.receiveFromPBI
- Defined in lib/settings/HasSettings.ts:75
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

Inherited from HasSettings.toJSONObject
- Defined in lib/settings/HasSettings.ts:101
Converts this class into a json object.

Returns any

Static buildCapabilitiesObjects

buildCapabilitiesObjects(): DataViewObjectDescriptors

Inherited from HasSettings.buildCapabilitiesObjects
- Defined in lib/settings/HasSettings.ts:59
Builds the capability objects for this settings class

Returns DataViewObjectDescriptors

Static create

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

Inherited from HasSettings.create
- Defined in lib/settings/HasSettings.ts:43
Creates a new instance of this class

Type parameters
- T: HasSettings
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

Inherited from HasSettings.createFromPBI
- Defined in lib/settings/HasSettings.ts:52
Creates a new instance of this class with the data from powerbi and the additional properties.

Type parameters
- T: HasSettings
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