Class: ObjectPropertyBag
dg.ObjectPropertyBag
Constructors
constructor
• new ObjectPropertyBag(source, x?)
Parameters
| Name | Type | Default value |
|---|---|---|
source | any | undefined |
x | any | null |
Defined in
Properties
source
• source: any
Defined in
Methods
get
▸ get(propertyName): object
Gets the value of the specified property
Parameters
| Name | Type |
|---|---|
propertyName | string |
Returns
object
Defined in
getProperties
▸ getProperties(): Property[]
Returns
Property[]
Defined in
getProperty
▸ getProperty(name): Property
Gets property by name (case-sensitive).
Parameters
| Name | Type |
|---|---|
name | string |
Returns
Defined in
hasProperty
▸ hasProperty(name): boolean
Parameters
| Name | Type |
|---|---|
name | string |
Returns
boolean
Defined in
resetDefault
▸ resetDefault(): void
Clears the previously remembered default settings for viewers of this type. See also: [setDefault]
Returns
void
Defined in
set
▸ set(propertyName, propertyValue): void
Sets the value of the specified property
Parameters
| Name | Type |
|---|---|
propertyName | string |
propertyValue | object |
Returns
void
Defined in
setAll
▸ setAll(params): void
Sets all properties according to the passed object containing key-value pairs
Parameters
| Name | Type |
|---|---|
params | object |
Returns
void
Defined in
setDefault
▸ setDefault(data?, style?): void
Sets the current state of viewer properties as the default configuration used to create new viewer instances of this type. Equivalent to the "Pick Up / Apply | Set as Default" context menu command. Read more about viewer commands: https://datagrok.ai/help/visualize/viewers/#common-actions
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
data | boolean | false | indicates if data settings should be copied. |
style | boolean | true | indicates if style (non-data) settings should be copied. |
Returns
void
Defined in
setDefaultProperty
▸ Static setDefaultProperty(viewerType, propertyName, propertyValue): void
Parameters
| Name | Type |
|---|---|
viewerType | string |
propertyName | string |
propertyValue | any |
Returns
void