Info

File

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

Description

entity detail related preferences bus class. used by SzPrefsService to store it's entity detail prefs.

Should really be used from SzPrefsService context, not on its own.

Example :

this.prefs.entityDetail.showGraphSection = false;
this.prefs.entityDetail.showOtherDataInSummary =  true;

Example :

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

Extends

SzSdkPrefsBase

Index

Constructor

constructor()

Properties

jsonKeys

Type : []

Default value :

[
    'showGraphSection',
    'showHowSection',
    'showMatchesSection',
    'showPossibleMatchesSection',
    'showPossibleRelationshipsSection',
    'showDisclosedSection',
    'graphSectionCollapsed',
    'howSectionCollapsed',
    'recordsSectionCollapsed',
    'possibleMatchesSectionCollapsed',
    'possibleRelationshipsSectionCollapsed',
    'disclosedRelationshipsSectionCollapsed',
    'rememberSectionCollapsedState',
    'truncateSummaryAt',
    'showOtherData',
    'truncateOtherDataAt',
    'openLinksInNewTab',
    'showOtherDataInRecords',
    'showOtherDataInEntities',
    'showOtherDataInSummary',
    'truncateOtherDataInRecordsAt',
    'hideGraphWhenZeroRelations',
    'showRecordIdWhenNative',
    'showTopEntityRecordIdsWhenSingular'
  ]

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

showGraphSection

getshowGraphSection()

show graph section

Returns : boolean

setshowGraphSection(value: boolean)

show graph section

Parameters :

Name	Type	Optional
value	`boolean`	No

Returns : void

showHowSection

getshowHowSection()

show graph section

Returns : boolean

setshowHowSection(value: boolean)

show graph section

Parameters :

Name	Type	Optional
value	`boolean`	No

Returns : void

showMatchesSection

getshowMatchesSection()

show matches/records section

Returns : boolean

setshowMatchesSection(value: boolean)

show matches/records section

Parameters :

Name	Type	Optional
value	`boolean`	No

Returns : void

showPossibleMatchesSection

getshowPossibleMatchesSection()

show possible matches section

Returns : boolean

setshowPossibleMatchesSection(value: boolean)

show possible matches section

Parameters :

Name	Type	Optional
value	`boolean`	No

Returns : void

showPossibleRelationshipsSection

getshowPossibleRelationshipsSection()

show possible relationships section

Returns : boolean

setshowPossibleRelationshipsSection(value: boolean)

show possible relationships section

Parameters :

Name	Type	Optional
value	`boolean`	No

Returns : void

showDisclosedSection

getshowDisclosedSection()

show disclosed relationships section

Returns : boolean

setshowDisclosedSection(value: boolean)

show disclosed relationships section

Parameters :

Name	Type	Optional
value	`boolean`	No

Returns : void

graphSectionCollapsed

getgraphSectionCollapsed()

graph section collapsed

Returns : boolean

setgraphSectionCollapsed(value: boolean)

graph section collapsed

Parameters :

Name	Type	Optional
value	`boolean`	No

Returns : void

howSectionCollapsed

gethowSectionCollapsed()

how report section collapsed

Returns : boolean

sethowSectionCollapsed(value: boolean)

how report section collapsed

Parameters :

Name	Type	Optional
value	`boolean`	No

Returns : void

recordsSectionCollapsed

getrecordsSectionCollapsed()

records/matches section collapsed

Returns : boolean

setrecordsSectionCollapsed(value: boolean)

records/matches section collapsed

Parameters :

Name	Type	Optional
value	`boolean`	No

Returns : void

possibleMatchesSectionCollapsed

getpossibleMatchesSectionCollapsed()

possible matches section collapsed

Returns : boolean

setpossibleMatchesSectionCollapsed(value: boolean)

possible matches section collapsed

Parameters :

Name	Type	Optional
value	`boolean`	No

Returns : void

possibleRelationshipsSectionCollapsed

getpossibleRelationshipsSectionCollapsed()

possible relationships section collapsed

Returns : boolean

setpossibleRelationshipsSectionCollapsed(value: boolean)

possible relationships section collapsed

Parameters :

Name	Type	Optional
value	`boolean`	No

Returns : void

disclosedRelationshipsSectionCollapsed

getdisclosedRelationshipsSectionCollapsed()

disclosed relationships section collapsed

Returns : boolean

setdisclosedRelationshipsSectionCollapsed(value: boolean)

disclosed relationships section collapsed

Parameters :

Name	Type	Optional
value	`boolean`	No

Returns : void

rememberSectionCollapsedState

getrememberSectionCollapsedState()

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

Returns : boolean

setrememberSectionCollapsedState(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

truncateSummaryAt

gettruncateSummaryAt()

rows to show in header summary before ellipsis

Returns : number

settruncateSummaryAt(value: number)

rows to show in header summary before ellipsis

Parameters :

Name	Type	Optional
value	`number`	No

Returns : void

showOtherData

getshowOtherData()

show "other data" column in header summary

Returns : boolean

setshowOtherData(value: boolean)

show "other data" column in header summary

Parameters :

Name	Type	Optional
value	`boolean`	No

Returns : void

truncateOtherDataAt

gettruncateOtherDataAt()

rows of "other data" to show

Returns : number

settruncateOtherDataAt(value: number)

rows of "other data" to show

Parameters :

Name	Type	Optional
value	`number`	No

Returns : void

openLinksInNewTab

getopenLinksInNewTab()

open entity row clicks in new tab

Returns : boolean

setopenLinksInNewTab(value: boolean)

open entity row clicks in new tab

Parameters :

Name	Type	Optional
value	`boolean`	No

Returns : void

showOtherDataInRecords

getshowOtherDataInRecords()

show "other data" in matches/records section

Returns : boolean

setshowOtherDataInRecords(value: boolean)

show "other data" in matches/records section

Parameters :

Name	Type	Optional
value	`boolean`	No

Returns : void

showOtherDataInEntities

getshowOtherDataInEntities()

show "other data" in sections other than matches section

Returns : boolean

setshowOtherDataInEntities(value: boolean)

show "other data" in sections other than matches section

Parameters :

Name	Type	Optional
value	`boolean`	No

Returns : void

showOtherDataInSummary

getshowOtherDataInSummary()

show "other data" in header summary below icon

Returns : boolean

setshowOtherDataInSummary(value: boolean)

show "other data" in header summary below icon

Parameters :

Name	Type	Optional
value	`boolean`	No

Returns : void

truncateOtherDataInRecordsAt

gettruncateOtherDataInRecordsAt()

how many lines of "other data" to show in matches section before ellipsis

Returns : number

settruncateOtherDataInRecordsAt(value: number)

how many lines of "other data" to show in matches section before ellipsis

Parameters :

Name	Type	Optional
value	`number`	No

Returns : void

hideGraphWhenZeroRelations

gethideGraphWhenZeroRelations()

hide the graph when 0 relationships in network query are returned for entity

Returns : boolean

sethideGraphWhenZeroRelations(value: boolean)

hide the graph when 0 relationships in network query are returned for entity

Parameters :

Name	Type	Optional
value	`boolean`	No

Returns : void

showRecordIdWhenNative

getshowRecordIdWhenNative()

show record id's in matches/records section when not auto-generated hash. not fully implemented

Returns : boolean

setshowRecordIdWhenNative(value: boolean)

show record id's in matches/records section when not auto-generated hash. not fully implemented

Parameters :

Name	Type	Optional
value	`boolean`	No

Returns : void

showTopEntityRecordIdsWhenSingular

getshowTopEntityRecordIdsWhenSingular()

show record id next to data source name in entity rows when only one source record

Returns : boolean

setshowTopEntityRecordIdsWhenSingular(value: boolean)

show record id next to data source name in entity rows when only one source record

Parameters :

Name	Type	Optional
value	`boolean`	No

Returns : void

File

Description

Extends

Index

Properties

Methods

Accessors

Constructor

Properties

Methods

Accessors

results matching ""

No results matching ""