Info

File

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

Description

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

Example :

this.prefs.graph.showMatchKeys = true;
this.prefs.graph.buildOut =  5;

Example :

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

Extends

SzSdkPrefsBase

Index

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 :

[
    'openInNewTab',
    'openInSidePanel',
    'dataSourceColors',
    'showLinkLabels',
    'rememberStateOptions',
    'maxDegreesOfSeparation',
    'maxEntities',
    'buildOut',
    'dataSourcesFiltered',
    'matchKeysIncluded',
    'matchKeyTokensIncluded',
    'matchKeyCoreTokensIncluded',
    'neverFilterQueriedEntityIds',
    'queriedEntitiesColor',
    'focusedEntitiesColor',
    'linkColor',
    'indirectLinkColor',
    'unlimitedMaxEntities',
    'unlimitedMaxScope',
    'suppressL1InterLinks',
    'matchKeyTokenSelectionScope'
  ]

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

openInNewTab

getopenInNewTab()

open graph entity clicks in new tab

Returns : boolean

setopenInNewTab(value: boolean)

open graph entity clicks in new tab

Parameters :

Name	Type	Optional
value	`boolean`	No

Returns : void

openInSidePanel

getopenInSidePanel()

open graph entity clicks in side panel

Returns : boolean

setopenInSidePanel(value: boolean)

open graph entity clicks in side panel

Parameters :

Name	Type	Optional
value	`boolean`	No

Returns : void

dataSourceColors

getdataSourceColors()

colors to apply to entity node when belonging to particular datasources

Returns : SzDataSourceComposite[]

setdataSourceColors(value: SzDataSourceComposite[])

colors to apply to entity node when belonging to particular datasources

Parameters :

Name	Type	Optional
value	`SzDataSourceComposite[]`	No

Returns : void

showLinkLabels

getshowLinkLabels()

show match keys/edge labels on relationships

Returns : boolean

setshowLinkLabels(value: boolean)

show match keys/edge labels on relationships

Parameters :

Name	Type	Optional
value	`boolean`	No

Returns : void

rememberStateOptions

getrememberStateOptions()

whether or not to publish change events on property value changes. useful for not getting notified on bulk property sets.

Returns : boolean

setrememberStateOptions(value: boolean)

whether or not to publish change events on property value changes. useful for not getting notified on bulk property sets.

Parameters :

Name	Type	Optional
value	`boolean`	No

Returns : void

maxDegreesOfSeparation

getmaxDegreesOfSeparation()

maximum degrees of separatation between relationships

Returns : number

setmaxDegreesOfSeparation(value: number)

maximum degrees of separatation between relationships

Parameters :

Name	Type	Optional
value	`number`	No

Returns : void

maxEntities

getmaxEntities()

maximum number of entities to show

Returns : number

setmaxEntities(value: number)

maximum number of entities to show

Parameters :

Name	Type	Optional
value	`number`	No

Returns : void

buildOut

getbuildOut()

how many nodes away from queried entity to show

Returns : number

setbuildOut(value: number)

how many nodes away from queried entity to show

Parameters :

Name	Type	Optional
value	`number`	No

Returns : void

dataSourcesFiltered

getdataSourcesFiltered()

hide any entity node when belonging to particular datasources

Returns : string[]

setdataSourcesFiltered(value: string[])

hide any entity node when belonging to particular datasources

Parameters :

Name	Type	Optional
value	`string[]`	No

Returns : void

matchKeysIncluded

getmatchKeysIncluded()