src/lib/services/sz-prefs.service.ts
search form related preferences bus class. used by SzPrefsService to store it's admin area related prefs. Should really be used from SzPrefsService context, not on its own.
Example :this.prefs.admin.streamConnectionProperties = {
connected: boolean;
clientId?: string;
hostname: string;
sampleSize: number;
port?: number;
connectionTest: boolean;
reconnectOnClose: boolean;
};this.prefs.searchResults.prefsChanged.subscribe( (prefs) => { console.log('search form pref change happened.', prefs); })
Properties |
|
Methods |
|
Accessors |
constructor()
|
| 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 : {}
|
| Public fromJSONObject | ||||||
fromJSONObject(value: string)
|
||||||
|
populate values by calling setters with the same names as json keys
Parameters :
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
|
| streamAnalysisConfig | ||||||
getstreamAnalysisConfig()
|
||||||
|
configuration parameters for doing analysis on a file stream prior to importing
Returns :
AdminStreamAnalysisConfig
|
||||||
setstreamAnalysisConfig(value: AdminStreamAnalysisConfig)
|
||||||
|
configuration parameters for doing analysis on a file stream prior to importing
Parameters :
Returns :
void
|
| streamConnectionProperties | ||||||
getstreamConnectionProperties()
|
||||||
|
connection parameters defining how and where to stream to bulk-loading endpoints
Returns :
AdminStreamConnProperties | undefined
|
||||||
setstreamConnectionProperties(value: AdminStreamConnProperties | undefined)
|
||||||
|
connection parameters defining how and where to stream to bulk-loading endpoints
Parameters :
Returns :
void
|
| streamLoadConfig | ||||||
getstreamLoadConfig()
|
||||||
|
configuration parameters for related to importing records using the stream connection
Returns :
AdminStreamLoadConfig
|
||||||
setstreamLoadConfig(value: AdminStreamLoadConfig)
|
||||||
|
configuration parameters for related to importing records using the stream connection
Parameters :
Returns :
void
|
| useStreamingForAnalysis | ||||||
getuseStreamingForAnalysis()
|
||||||
|
whether or not to use the streamConnectionProperties to do analysis through websocket stream.
Returns :
boolean
|
||||||
setuseStreamingForAnalysis(value: boolean)
|
||||||
|
whether or not to use the streamConnectionProperties to do analysis through websocket stream.
Parameters :
Returns :
void
|
| useStreamingForLoad | ||||||
getuseStreamingForLoad()
|
||||||
|
whether or not to use the streamConnectionProperties to do analysis through websocket stream.
Returns :
boolean
|
||||||
setuseStreamingForLoad(value: boolean)
|
||||||
|
whether or not to use the streamConnectionProperties to do record importing through websocket stream.
Parameters :
Returns :
void
|