Interface: Frame
Interface describing base panel properties that all other panels extend.
Properties
| Name | Type | Description |
activationenabled | boolean | No description provided. |
actuallayoutheight | number | No description provided. |
actuallayoutwidth | number | No description provided. |
actualuiscale_x | number | No description provided. |
actualuiscale_y | number | No description provided. |
actualxoffset | number | No description provided. |
actualyoffset | number | No description provided. |
checked | boolean | No description provided. |
contentheight | number | No description provided. |
contentwidth | number | No description provided. |
defaultfocus | string | No description provided. |
desiredlayoutheight | number | No description provided. |
desiredlayoutwidth | number | No description provided. |
enabled | boolean | No description provided. |
hittest | boolean | No description provided. |
hittestchildren | boolean | No description provided. |
id | string | No description provided. |
inputnamespace | string | No description provided. |
layoutfile | string | No description provided. |
paneltype | Frame | No description provided. |
rememberchildfocus | boolean | No description provided. |
scrolloffset_x | number | No description provided. |
scrolloffset_y | number | No description provided. |
selectionpos_x | number | No description provided. |
selectionpos_y | number | No description provided. |
style | Style | No description provided. |
tabindex | number | No description provided. |
visible | boolean | No description provided. |
Functions
AcceptsFocus
Frame.AcceptsFocus(): boolean
No description provided.
AcceptsInput
Frame.AcceptsInput(): boolean
No description provided.
AddClass
Frame.AddClass(classname: string): void
No description provided.
Parameter
| Name | Type | Description |
classname | string | No description provided. |
ApplyStyles
Frame.ApplyStyles(arg0: boolean): void
No description provided.
Parameter
| Name | Type | Description |
arg0 | boolean | No description provided. |
BAscendantHasClass
Frame.BAscendantHasClass(arg0: string): boolean
No description provided.
Parameter
| Name | Type | Description |
arg0 | string | No description provided. |
CanSeeInParentScroll
Frame.CanSeeInParentScroll(): boolean
No description provided.
Children
Frame.Children(): GenericPanel[]
No description provided.
ClearPanelEvent
Frame.ClearPanelEvent(event: string): void
No description provided.
Parameter
| Name | Type | Description |
event | string | No description provided. |
ClearPropertyFromCode
Frame.ClearPropertyFromCode(arg0: unknown): void
No description provided.
Parameter
| Name | Type | Description |
arg0 | unknown | No description provided. |
CreateChildren
Frame.CreateChildren(elements: string): boolean
No description provided.
Parameter
| Name | Type | Description |
elements | string | No description provided. |
CreateCopyOfCSSKeyframes
Frame.CreateCopyOfCSSKeyframes(animation: string): unknown
No description provided.
Parameter
| Name | Type | Description |
animation | string | No description provided. |
Data
Frame.Data(...args: any[]): void
No description provided.
Parameter
| Name | Type | Description |
...args | any[] | No description provided. |
DeleteAsync
Frame.DeleteAsync(delay: number): void
No description provided.
Parameter
| Name | Type | Description |
delay | number | No description provided. |
DeleteKeyframes
Frame.DeleteKeyframes(animation: unknown): void
No description provided.
Parameter
| Name | Type | Description |
animation | unknown | No description provided. |
FindChild
Frame.FindChild(id: string): T
Searches this element's direct children and returns a child with the specified id.
Parameter
| Name | Type | Description |
id | string | No description provided. |
FindChildInLayoutFile
Frame.FindChildInLayoutFile(id: string): T
No description provided.
Parameter
| Name | Type | Description |
id | string | No description provided. |
FindChildrenWithClassTraverse
Frame.FindChildrenWithClassTraverse(classname: string): T[]
No description provided.
Parameter
| Name | Type | Description |
classname | string | No description provided. |
FindChildTraverse
Frame.FindChildTraverse(id: string): T
No description provided.
Parameter
| Name | Type | Description |
id | string | No description provided. |
GetAttributeInt
Frame.GetAttributeInt(attribute: string, fallback: number): number
No description provided.
Parameters
| Name | Type | Description |
attribute | string | No description provided. |
fallback | number | No description provided. |
GetAttributeString
Frame.GetAttributeString(attribute: string, fallback: string): string
No description provided.
Parameters
| Name | Type | Description |
attribute | string | No description provided. |
fallback | string | No description provided. |
GetAttributeUInt32
Frame.GetAttributeUInt32(attribute: string, fallback: number): number
No description provided.
Parameters
| Name | Type | Description |
attribute | string | No description provided. |
fallback | number | No description provided. |
GetChild
Frame.GetChild(index: number): T
No description provided.
Parameter
| Name | Type | Description |
index | number | No description provided. |
GetChildCount
Frame.GetChildCount(): number
No description provided.
GetChildIndex
Frame.GetChildIndex(child: GenericPanel): number
No description provided.
Parameter
| Name | Type | Description |
child | GenericPanel | No description provided. |
GetFirstChild
Frame.GetFirstChild(): T
No description provided.
GetLastChild
Frame.GetLastChild(): T
No description provided.
GetLayoutFileDefine
Frame.GetLayoutFileDefine(def: string): unknown
No description provided.
Parameter
| Name | Type | Description |
def | string | No description provided. |
GetParent
Frame.GetParent(): T
No description provided.
GetPositionWithinWindow
Frame.GetPositionWithinWindow(): unknown
No description provided.
HasClass
Frame.HasClass(classname: string): boolean
No description provided.
Parameter
| Name | Type | Description |
classname | string | No description provided. |
HasDescendantKeyFocus
Frame.HasDescendantKeyFocus(): boolean
No description provided.
HasHoverStyle
Frame.HasHoverStyle(): boolean
No description provided.
HasKeyFocus
Frame.HasKeyFocus(): boolean
No description provided.
IsDraggable
Frame.IsDraggable(): boolean
No description provided.
IsReadyForDisplay
Frame.IsReadyForDisplay(): boolean
No description provided.
IsSelected
Frame.IsSelected(): boolean
No description provided.
IsSizeValid
Frame.IsSizeValid(): boolean
No description provided.
IsTransparent
Frame.IsTransparent(): boolean
No description provided.
IsValid
Frame.IsValid(): boolean
Check if this panel is still valid
LoadLayout
Frame.LoadLayout(url: string, override: boolean, partial: boolean): boolean
No description provided.
Parameters
| Name | Type | Description |
url | string | No description provided. |
override | boolean | No description provided. |
partial | boolean | No description provided. |
LoadLayoutAsync
Frame.LoadLayoutAsync(url: string, override: boolean, partial: boolean): void
No description provided.
Parameters
| Name | Type | Description |
url | string | No description provided. |
override | boolean | No description provided. |
partial | boolean | No description provided. |
LoadLayoutFromString
Frame.LoadLayoutFromString(layout: string, override: boolean, partial: boolean): void
No description provided.
Parameters
| Name | Type | Description |
layout | string | No description provided. |
override | boolean | No description provided. |
partial | boolean | No description provided. |
LoadLayoutFromStringAsync
Frame.LoadLayoutFromStringAsync(layout: string, override: boolean, partial: boolean): void
No description provided.
Parameters
| Name | Type | Description |
layout | string | No description provided. |
override | boolean | No description provided. |
partial | boolean | No description provided. |
LoadLayoutSnippet
Frame.LoadLayoutSnippet(snippet: string): boolean
No description provided.
Parameter
| Name | Type | Description |
snippet | string | No description provided. |
MoveChildAfter
Frame.MoveChildAfter(arg0: unknown, arg1: unknown): void
No description provided.
Parameters
| Name | Type | Description |
arg0 | unknown | No description provided. |
arg1 | unknown | No description provided. |
MoveChildBefore
Frame.MoveChildBefore(arg0: unknown, arg1: unknown): void
No description provided.
Parameters
| Name | Type | Description |
arg0 | unknown | No description provided. |
arg1 | unknown | No description provided. |
RegisterForReadyEvents
Frame.RegisterForReadyEvents(enable: boolean): void
Registers this panel to receive ready/unready events.
Parameter
| Name | Type | Description |
enable | boolean | Should this panel receive ready/unready events? |
RemoveAndDeleteChildren
Frame.RemoveAndDeleteChildren(): void
No description provided.
RemoveClass
Frame.RemoveClass(classname: string): void
No description provided.
Parameter
| Name | Type | Description |
classname | string | No description provided. |
ScrollParentToFitWhenFocused
Frame.ScrollParentToFitWhenFocused(): boolean
No description provided.
ScrollParentToMakePanelFit
Frame.ScrollParentToMakePanelFit(arg0: number, arg1: boolean): void
No description provided.
Parameters
| Name | Type | Description |
arg0 | number | No description provided. |
arg1 | boolean | No description provided. |
ScrollToBottom
Frame.ScrollToBottom(): void
No description provided.
ScrollToFitRegion
Frame.ScrollToFitRegion(arg0: number, arg1: number, arg2: number, arg3: number, arg4: unknown, arg5: boolean, arg6: boolean): void
No description provided.
Parameters
| Name | Type | Description |
arg0 | number | No description provided. |
arg1 | number | No description provided. |
arg2 | number | No description provided. |
arg3 | number | No description provided. |
arg4 | unknown | No description provided. |
arg5 | boolean | No description provided. |
arg6 | boolean | No description provided. |
ScrollToLeftEdge
Frame.ScrollToLeftEdge(): void
No description provided.
ScrollToRightEdge
Frame.ScrollToRightEdge(): void
No description provided.
ScrollToTop
Frame.ScrollToTop(): void
No description provided.
SetAcceptsFocus
Frame.SetAcceptsFocus(istrue: boolean): void
No description provided.
Parameter
| Name | Type | Description |
istrue | boolean | No description provided. |
SetAttributeInt
Frame.SetAttributeInt(attribute: string, value: number): void
No description provided.
Parameters
| Name | Type | Description |
attribute | string | No description provided. |
value | number | No description provided. |
SetAttributeString
Frame.SetAttributeString(attribute: string, value: string): void
No description provided.
Parameters
| Name | Type | Description |
attribute | string | No description provided. |
value | string | No description provided. |
SetAttributeUInt32
Frame.SetAttributeUInt32(attribute: string, value: number): void
No description provided.
Parameters
| Name | Type | Description |
attribute | string | No description provided. |
value | number | No description provided. |
SetDialogVariable
Frame.SetDialogVariable(arg0: string, arg1: string): void
No description provided.
Parameters
| Name | Type | Description |
arg0 | string | No description provided. |
arg1 | string | No description provided. |
SetDialogVariableFloat
Frame.SetDialogVariableFloat(arg0: string, arg1: number): void
No description provided.
Parameters
| Name | Type | Description |
arg0 | string | No description provided. |
arg1 | number | No description provided. |
SetDialogVariableInt
Frame.SetDialogVariableInt(arg0: string, arg1: number): void
No description provided.
Parameters
| Name | Type | Description |
arg0 | string | No description provided. |
arg1 | number | No description provided. |
SetDialogVariableTime
Frame.SetDialogVariableTime(arg0: string, arg1: string | number): void
No description provided.
Parameters
| Name | Type | Description |
arg0 | string | No description provided. |
arg1 | string | number | No description provided. |
SetDisableFocusOnMouseDown
Frame.SetDisableFocusOnMouseDown(istrue: boolean): void
No description provided.
Parameter
| Name | Type | Description |
istrue | boolean | No description provided. |
SetDraggable
Frame.SetDraggable(istrue: boolean): void
No description provided.
Parameter
| Name | Type | Description |
istrue | boolean | No description provided. |
SetFocus
Frame.SetFocus(focus: boolean): boolean
No description provided.
Parameter
| Name | Type | Description |
focus | boolean | No description provided. |
SetHasClass
Frame.SetHasClass(classname: string, hasclass: boolean): void
No description provided.
Parameters
| Name | Type | Description |
classname | string | No description provided. |
hasclass | boolean | No description provided. |
SetInputNamespace
Frame.SetInputNamespace(arg0: string): void
No description provided.
Parameter
| Name | Type | Description |
arg0 | string | No description provided. |
SetPanelEvent
Frame.SetPanelEvent(event: string, callback: Func<any[], void>): void
Sets an event trigger for this panel.
Example
latestUpdateImage.SetPanelEvent('onactivate', () => SteamOverlayAPI.OpenURLModal(item.link));
Parameters
| Name | Type | Description |
event | string | No description provided. |
callback | Func<any[], void> | No description provided. |
See also
SetParent
Frame.SetParent(parent: GenericPanel): void
No description provided.
Parameter
| Name | Type | Description |
parent | GenericPanel | No description provided. |
SetReadyForDisplay
Frame.SetReadyForDisplay(arg0: boolean): void
No description provided.
Parameter
| Name | Type | Description |
arg0 | boolean | No description provided. |
SetScrollParentToFitWhenFocused
Frame.SetScrollParentToFitWhenFocused(arg0: boolean): void
No description provided.
Parameter
| Name | Type | Description |
arg0 | boolean | No description provided. |
SetSnippet
Frame.SetSnippet(snippet: string): void
Sets the Frame content to the specified snippet.
Parameter
| Name | Type | Description |
snippet | string | No description provided. |
SetSource
Frame.SetSource(source: string): void
Sets the Frame content to the specified layout file url.
Parameter
| Name | Type | Description |
source | string | No description provided. |
SetTopOfInputContext
Frame.SetTopOfInputContext(arg0: boolean): void
No description provided.
Parameter
| Name | Type | Description |
arg0 | boolean | No description provided. |
SortChildrenOnAttribute
Frame.SortChildrenOnAttribute(attribute: string, ascending: boolean): void
No description provided.
Parameters
| Name | Type | Description |
attribute | string | No description provided. |
ascending | boolean | No description provided. |
SwitchClass
Frame.SwitchClass(oldclass: string, newclass: string): void
No description provided.
Parameters
| Name | Type | Description |
oldclass | string | No description provided. |
newclass | string | No description provided. |
ToggleClass
Frame.ToggleClass(classname: string): void
No description provided.
Parameter
| Name | Type | Description |
classname | string | No description provided. |
TriggerClass
Frame.TriggerClass(classname: string): void
No description provided.
Parameter
| Name | Type | Description |
classname | string | No description provided. |
UpdateCurrentAnimationKeyframes
Frame.UpdateCurrentAnimationKeyframes(animation: unknown): void
No description provided.
Parameter
| Name | Type | Description |
animation | unknown | No description provided. |
UpdateFocusInContext
Frame.UpdateFocusInContext(): boolean
No description provided.