Class: ViewInfo
dg.ViewInfo
Hierarchy
↳
ViewInfo
Constructors
constructor
• new ViewInfo(dart
)
Constructs
ViewInfo
Parameters
Name | Type |
---|---|
dart | any |
Overrides
Defined in
Properties
dart
• dart: any
Inherited from
Defined in
Accessors
author
• get
author(): User
Who created entity *
Returns
Inherited from
Entity.author
Defined in
createdOn
• get
createdOn(): Dayjs
Time when entity was created *
Returns
Dayjs
Inherited from
Entity.createdOn
Defined in
friendlyName
• get
friendlyName(): string
Entity friendly name
Returns
string
Inherited from
Entity.friendlyName
Defined in
• set
friendlyName(x
): void
Parameters
Name | Type |
---|---|
x | string |
Returns
void
Inherited from
Entity.friendlyName
Defined in
id
• get
id(): string
Entity ID (GUID)
Returns
string
Inherited from
Entity.id
Defined in
• set
id(x
): void
Parameters
Name | Type |
---|---|
x | string |
Returns
void
Inherited from
Entity.id
Defined in
name
• get
name(): string
Entity short name
Returns
string
Inherited from
Entity.name
Defined in
• set
name(x
): void
Parameters
Name | Type |
---|---|
x | string |
Returns
void
Inherited from
Entity.name
Defined in
nqName
• get
nqName(): string
Entity full-qualified name
Returns
string
Inherited from
Entity.nqName
Defined in
path
• get
path(): string
Entity path
Returns
string
Inherited from
Entity.path
Defined in
updatedOn
• get
updatedOn(): Dayjs
Time when entity was updated *
Returns
Dayjs
Inherited from
Entity.updatedOn
Defined in
view
• get
view(): View
Only defined within the context of the OnViewLayoutXXX events
Returns
Defined in
viewState
• get
viewState(): string
Returns
string
Defined in
• set
viewState(state
): void
Parameters
Name | Type |
---|---|
state | string |
Returns
void
Defined in
Methods
getProperties
▸ getProperties(): Promise
<{ [index: string]
: any
; }>
Gets entity properties
Returns
Promise
<{ [index: string]
: any
; }>
Inherited from
Defined in
getUserDataValue
▸ getUserDataValue(key
): string
Parameters
Name | Type |
---|---|
key | string |
Returns
string
Defined in
hasTag
▸ hasTag(tag
): boolean
Parameters
Name | Type |
---|---|
tag | string |
Returns
boolean
Inherited from
Defined in
newId
▸ newId(): void
Generates new id for this entity.
Returns
void
Inherited from
Defined in
setProperties
▸ setProperties(props
): Promise
<any
>
Sets entity properties
Parameters
Name | Type |
---|---|
props | Object |
Returns
Promise
<any
>
Inherited from
Defined in
setUserDataValue
▸ setUserDataValue(key
, value
): any
Parameters
Name | Type |
---|---|
key | string |
value | string |
Returns
any
Defined in
tag
▸ tag(tag
): boolean
Adds a specified tag
Parameters
Name | Type |
---|---|
tag | string |
Returns
boolean
Inherited from
Defined in
toJson
▸ toJson(): string
Returns
string
Defined in
toString
▸ toString(): string
Returns a string representing the object
Returns
string
Inherited from
Defined in
unTag
▸ unTag(tag
): boolean
Removes a specified tag
Parameters
Name | Type |
---|---|
tag | string |
Returns
boolean
Inherited from
Defined in
fromJson
▸ Static
fromJson(json
): ViewInfo
Parameters
Name | Type |
---|---|
json | string |
Returns
Defined in
fromViewState
▸ Static
fromViewState(state
): ViewInfo
Parameters
Name | Type |
---|---|
state | string |