Info

File

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

Description

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

Example :

this.prefs.datamart.datasource1 = 'MYDS_NAME';

Example :

this.prefs.datamart.prefsChanged.subscribe( (prefs) => { console.log('datamart 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 :

[
    'dataSource1',
    'dataSource2',
    'defaultDataSource1',
    'defaultDataSource2',
    'defaultMatchLevel',
    'defaultStatType',
    'rememberSelectedDataSources',
    'sampleDataSource1',
    'sampleDataSource2',
    'sampleMatchLevel',
    'samplePageSize',
    'sampleSize',
    'sampleStatType',
    'showAllColumns',
    'showDiagramHeader',
    'showMatchKeyFiltersOnSelect',
    'truncateDataTableCellLines',
    'wrapDataTableCellLines'
  ]

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

dataSource1

getdataSource1()

first datasource to use in the datamart stats queries

Returns : string

setdataSource1(value: string)

first datasource to use in the datamart stats queries

Parameters :

Name	Type	Optional
value	`string`	No

Returns : void

dataSource2

getdataSource2()

first datasource to use in the datamart stats queries

Returns : string

setdataSource2(value: string)

first datasource to use in the datamart stats queries

Parameters :

Name	Type	Optional
value	`string`	No

Returns : void

defaultDataSource1

getdefaultDataSource1()

first datasource to use as the default in datamart stats queries

Returns : string

setdefaultDataSource1(value: string)

first datasource to use as the default in datamart stats queries

Parameters :

Name	Type	Optional
value	`string`	No

Returns : void

defaultDataSource2

getdefaultDataSource2()

second datasource to use as the default in datamart stats queries

Returns : string

setdefaultDataSource2(value: string)

second datasource to use as the default in datamart stats queries

Parameters :

Name	Type	Optional
value	`string`	No

Returns : void

defaultMatchLevel

getdefaultMatchLevel()

first datasource to use in the datamart stats queries

Returns : number

setdefaultMatchLevel(value: number)

first datasource to use in the datamart stats queries

Parameters :

Name	Type	Optional
value	`number`	No

Returns : void

defaultStatType

getdefaultStatType()

first datasource to use in the datamart stats queries

Returns : SzCrossSourceSummaryCategoryType

setdefaultStatType(value: SzCrossSourceSummaryCategoryType)

first datasource to use in the datamart stats queries

Parameters :

Name	Type	Optional
value	`SzCrossSourceSummaryCategoryType`	No

Returns : void

rememberSelectedDataSources

getrememberSelectedDataSources()

if true and there are values for "dataSource1" and/or "dataSource2" then the datatable will default to these previous values

Returns : boolean

setrememberSelectedDataSources(value: boolean)

if true and there are values for "dataSource1" and/or "dataSource2" then the datatable will default to these previous values

Parameters :

Name	Type	Optional
value	`boolean`	No

Returns : void

sampleDataSource1

getsampleDataSource1()

first datasource to use in the datamart sampling stats queries

Returns : string

setsampleDataSource1(value: string)

first datasource to use in the datamart sampling stats queries

Parameters :

Name	Type	Optional
value	`string`	No

Returns : void

sampleDataSource2

getsampleDataSource2()

second datasource to use in the datamart sampling stats queries

Returns : string

setsampleDataSource2(value: string)

second datasource to use in the datamart sampling stats queries

Parameters :

Name	Type	Optional
value	`string`	No

Returns : void

sampleMatchLevel

getsampleMatchLevel()

sample match level parameter to use in stats queries

Returns : number

setsampleMatchLevel(value: number)

sample match leve parameter to use in stats queries

Parameters :

Name	Type	Optional
value	`number`	No

Returns : void

samplePageSize

getsamplePageSize()

sample page size parameter to use in stats queries

Returns : number

setsamplePageSize(value: number)

sample page size parameter to use in stats queries

Parameters :

Name	Type	Optional
value	`number`	No

Returns : void

sampleSize

getsampleSize()

samplesize parameter to use in stats queries

Returns : number

setsampleSize(value: number)

samplesize parameter to use in stats queries

Parameters :

Name	Type	Optional
value	`number`	No

Returns : void

sampleStatType

getsampleStatType()

sample stat type enum member value

Returns : SzCrossSourceSummaryCategoryType

setsampleStatType(value: SzCrossSourceSummaryCategoryType)

sample stat type enum member value

Parameters :

Name	Type	Optional
value	`SzCrossSourceSummaryCategoryType`	No

Returns : void

showAllColumns

getshowAllColumns()

whether or not hidden or empty columns are shown by default

Returns : boolean

setshowAllColumns(value: boolean)

whether or not hidden or empty columns are shown by default

Parameters :

Name	Type	Optional
value	`boolean`	No

Returns : void

showDiagramHeader

getshowDiagramHeader()

whether or not the venn diagrams are expanded

Returns : boolean

setshowDiagramHeader(value: boolean)

whether or not the venn diagrams are expanded

Parameters :

Name	Type	Optional
value	`boolean`	No

Returns : void

showMatchKeyFiltersOnSelect

getshowMatchKeyFiltersOnSelect()

whether or not prompt the user to select a match key on diagram click

Returns : boolean

setshowMatchKeyFiltersOnSelect(value: boolean)

whether or not prompt the user to select a match key on diagram click

Parameters :

Name	Type	Optional
value	`boolean`	No

Returns : void

truncateDataTableCellLines

gettruncateDataTableCellLines()

truncate table cell data at X number of lines, or not at all

Returns : boolean | number

settruncateDataTableCellLines(value: boolean | number)

truncate table cell data at X number of lines, or not at all

Parameters :

Name	Type	Optional
value	`boolean \| number`	No

Returns : void

wrapDataTableCellLines

getwrapDataTableCellLines()

wrap lines displayed in table cells

Returns : boolean

setwrapDataTableCellLines(value: boolean)

wrap lines displayed in table cells

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 ""