File

src/lib/services/sz-prefs.service.ts

Description

How Report related preferences bus class. used by SzPrefsService to store it's How related prefs. Should really be used from SzPrefsService context, not on its own.

Example :
this.prefs.how.showResolutionRule = true;
Example :
this.prefs.graph.prefsChanged.subscribe( (prefs) => { console.log('how pref change happened.', prefs); })

Extends

SzSdkPrefsBase

Index

Properties
Methods
Accessors

Constructor

constructor()

publish out a "first" real payload so that subscribers get an initial payload from this subclass instead of the empty superclass

Properties

jsonKeys
Type : []
Default value : [ 'showResolutionRule' ]

the keys of member setters or variables in the object to output in json, or to take as json input

Public bulkSet
Type : boolean
Default value : false

during a bulk property set, set this to true to not publish change events on every single value change

Public prefChanged
Type : Subject<literal type>
Default value : new Subject<{name: string, value: any}>()

subject that can be subscribed to for INDIVIDUAL value change notifications.

Public prefsChanged
Type : BehaviorSubject<any>
Default value : new BehaviorSubject<any>(this.toJSONObject())

behavior subject that can be subscribed to for change notifications.

typemap
Type : object
Default value : {}

Methods

Public fromJSONObject
fromJSONObject(value: string)

populate values by calling setters with the same names as json keys

Parameters :
Name Type Optional
value string No
Returns : void
Public getPublicPropertiesSchema
getPublicPropertiesSchema()

gets an array of all public json properties and their types

Returns : {}
Public toJSONObject
toJSONObject()

get shallow JSON copy of object state. properties are filtered by members of jsonKeys

Returns : {}
Public toJSONString
toJSONString()

get object state representation as a string

Returns : string

Accessors

showResolutionRule
getshowResolutionRule()

whether or not to show the Resolution Rule code or principle in a card

Returns : boolean
setshowResolutionRule(value: boolean)

whether or not to show the Resolution Rule code or principle in a card

Parameters :
Name Type Optional
value boolean No
Returns : void

results matching ""

    No results matching ""