Interface: TripleMonitorBackground

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

TripleMonitorBackground.AcceptsFocus(): boolean

No description provided.

AcceptsInput

TripleMonitorBackground.AcceptsInput(): boolean

No description provided.

AddClass

TripleMonitorBackground.AddClass(classname: string): void

No description provided.

Parameter

Name Type Description
classname string No description provided.

ApplyStyles

TripleMonitorBackground.ApplyStyles(arg0: boolean): void

No description provided.

Parameter

Name Type Description
arg0 boolean No description provided.

BAscendantHasClass

TripleMonitorBackground.BAscendantHasClass(arg0: string): boolean

No description provided.

Parameter

Name Type Description
arg0 string No description provided.

CanSeeInParentScroll

TripleMonitorBackground.CanSeeInParentScroll(): boolean

No description provided.

Children

TripleMonitorBackground.Children(): GenericPanel[]

No description provided.

ClearPanelEvent

TripleMonitorBackground.ClearPanelEvent(event: string): void

No description provided.

Parameter

Name Type Description
event string No description provided.

ClearPropertyFromCode

TripleMonitorBackground.ClearPropertyFromCode(arg0: unknown): void

No description provided.

Parameter

Name Type Description
arg0 unknown No description provided.

CreateChildren

TripleMonitorBackground.CreateChildren(elements: string): boolean

No description provided.

Parameter

Name Type Description
elements string No description provided.

CreateCopyOfCSSKeyframes

TripleMonitorBackground.CreateCopyOfCSSKeyframes(animation: string): unknown

No description provided.

Parameter

Name Type Description
animation string No description provided.

Data

TripleMonitorBackground.Data(...args: any[]): void

No description provided.

Parameter

Name Type Description
...args any[] No description provided.

DeleteAsync

TripleMonitorBackground.DeleteAsync(delay: number): void

No description provided.

Parameter

Name Type Description
delay number No description provided.

DeleteKeyframes

TripleMonitorBackground.DeleteKeyframes(animation: unknown): void

No description provided.

Parameter

Name Type Description
animation unknown No description provided.

FindChild

TripleMonitorBackground.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

TripleMonitorBackground.FindChildInLayoutFile(id: string): T

No description provided.

Parameter

Name Type Description
id string No description provided.

FindChildrenWithClassTraverse

TripleMonitorBackground.FindChildrenWithClassTraverse(classname: string): T[]

No description provided.

Parameter

Name Type Description
classname string No description provided.

FindChildTraverse

TripleMonitorBackground.FindChildTraverse(id: string): T

No description provided.

Parameter

Name Type Description
id string No description provided.

GetAttributeInt

TripleMonitorBackground.GetAttributeInt(attribute: string, fallback: number): number

No description provided.

Parameters

Name Type Description
attribute string No description provided.
fallback number No description provided.

GetAttributeString

TripleMonitorBackground.GetAttributeString(attribute: string, fallback: string): string

No description provided.

Parameters

Name Type Description
attribute string No description provided.
fallback string No description provided.

GetAttributeUInt32

TripleMonitorBackground.GetAttributeUInt32(attribute: string, fallback: number): number

No description provided.

Parameters

Name Type Description
attribute string No description provided.
fallback number No description provided.

GetChild

TripleMonitorBackground.GetChild(index: number): T

No description provided.

Parameter

Name Type Description
index number No description provided.

GetChildCount

TripleMonitorBackground.GetChildCount(): number

No description provided.

GetChildIndex

TripleMonitorBackground.GetChildIndex(child: GenericPanel): number

No description provided.

Parameter

Name Type Description
child GenericPanel No description provided.

GetFirstChild

TripleMonitorBackground.GetFirstChild(): T

No description provided.

GetLastChild

TripleMonitorBackground.GetLastChild(): T

No description provided.

GetLayoutFileDefine

TripleMonitorBackground.GetLayoutFileDefine(def: string): unknown

No description provided.

Parameter

Name Type Description
def string No description provided.

GetParent

TripleMonitorBackground.GetParent(): T

No description provided.

GetPositionWithinWindow

TripleMonitorBackground.GetPositionWithinWindow(): unknown

No description provided.

HasClass

TripleMonitorBackground.HasClass(classname: string): boolean

No description provided.

Parameter

Name Type Description
classname string No description provided.

HasDescendantKeyFocus

TripleMonitorBackground.HasDescendantKeyFocus(): boolean

No description provided.

HasHoverStyle

TripleMonitorBackground.HasHoverStyle(): boolean

No description provided.

HasKeyFocus

TripleMonitorBackground.HasKeyFocus(): boolean

No description provided.

IsDraggable

TripleMonitorBackground.IsDraggable(): boolean

No description provided.

IsReadyForDisplay

TripleMonitorBackground.IsReadyForDisplay(): boolean

No description provided.

IsSelected

TripleMonitorBackground.IsSelected(): boolean

No description provided.

IsSizeValid

TripleMonitorBackground.IsSizeValid(): boolean

No description provided.

IsTransparent

TripleMonitorBackground.IsTransparent(): boolean

No description provided.

IsValid

TripleMonitorBackground.IsValid(): boolean

Check if this panel is still valid

LoadLayout

TripleMonitorBackground.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

TripleMonitorBackground.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

TripleMonitorBackground.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

TripleMonitorBackground.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

TripleMonitorBackground.LoadLayoutSnippet(snippet: string): boolean

No description provided.

Parameter

Name Type Description
snippet string No description provided.

MoveChildAfter

TripleMonitorBackground.MoveChildAfter(arg0: unknown, arg1: unknown): void

No description provided.

Parameters

Name Type Description
arg0 unknown No description provided.
arg1 unknown No description provided.

MoveChildBefore

TripleMonitorBackground.MoveChildBefore(arg0: unknown, arg1: unknown): void

No description provided.

Parameters

Name Type Description
arg0 unknown No description provided.
arg1 unknown No description provided.

RegisterForReadyEvents

TripleMonitorBackground.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

TripleMonitorBackground.RemoveAndDeleteChildren(): void

No description provided.

RemoveClass

TripleMonitorBackground.RemoveClass(classname: string): void

No description provided.

Parameter

Name Type Description
classname string No description provided.

ScrollParentToFitWhenFocused

TripleMonitorBackground.ScrollParentToFitWhenFocused(): boolean

No description provided.

ScrollParentToMakePanelFit

TripleMonitorBackground.ScrollParentToMakePanelFit(arg0: number, arg1: boolean): void

No description provided.

Parameters

Name Type Description
arg0 number No description provided.
arg1 boolean No description provided.

ScrollToBottom

TripleMonitorBackground.ScrollToBottom(): void

No description provided.

ScrollToFitRegion

TripleMonitorBackground.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

TripleMonitorBackground.ScrollToLeftEdge(): void

No description provided.

ScrollToRightEdge

TripleMonitorBackground.ScrollToRightEdge(): void

No description provided.

ScrollToTop

TripleMonitorBackground.ScrollToTop(): void

No description provided.

SetAcceptsFocus

TripleMonitorBackground.SetAcceptsFocus(istrue: boolean): void

No description provided.

Parameter

Name Type Description
istrue boolean No description provided.

SetAttributeInt

TripleMonitorBackground.SetAttributeInt(attribute: string, value: number): void

No description provided.

Parameters

Name Type Description
attribute string No description provided.
value number No description provided.

SetAttributeString

TripleMonitorBackground.SetAttributeString(attribute: string, value: string): void

No description provided.

Parameters

Name Type Description
attribute string No description provided.
value string No description provided.

SetAttributeUInt32

TripleMonitorBackground.SetAttributeUInt32(attribute: string, value: number): void

No description provided.

Parameters

Name Type Description
attribute string No description provided.
value number No description provided.

SetDialogVariable

TripleMonitorBackground.SetDialogVariable(arg0: string, arg1: string): void

No description provided.

Parameters

Name Type Description
arg0 string No description provided.
arg1 string No description provided.

SetDialogVariableFloat

TripleMonitorBackground.SetDialogVariableFloat(arg0: string, arg1: number): void

No description provided.

Parameters

Name Type Description
arg0 string No description provided.
arg1 number No description provided.

SetDialogVariableInt

TripleMonitorBackground.SetDialogVariableInt(arg0: string, arg1: number): void

No description provided.

Parameters

Name Type Description
arg0 string No description provided.
arg1 number No description provided.

SetDialogVariableTime

TripleMonitorBackground.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

TripleMonitorBackground.SetDisableFocusOnMouseDown(istrue: boolean): void

No description provided.

Parameter

Name Type Description
istrue boolean No description provided.

SetDraggable

TripleMonitorBackground.SetDraggable(istrue: boolean): void

No description provided.

Parameter

Name Type Description
istrue boolean No description provided.

SetFocus

TripleMonitorBackground.SetFocus(focus: boolean): boolean

No description provided.

Parameter

Name Type Description
focus boolean No description provided.

SetHasClass

TripleMonitorBackground.SetHasClass(classname: string, hasclass: boolean): void

No description provided.

Parameters

Name Type Description
classname string No description provided.
hasclass boolean No description provided.

SetInputNamespace

TripleMonitorBackground.SetInputNamespace(arg0: string): void

No description provided.

Parameter

Name Type Description
arg0 string No description provided.

SetPanelEvent

TripleMonitorBackground.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

TripleMonitorBackground.SetParent(parent: GenericPanel): void

No description provided.

Parameter

Name Type Description
parent GenericPanel No description provided.

SetReadyForDisplay

TripleMonitorBackground.SetReadyForDisplay(arg0: boolean): void

No description provided.

Parameter

Name Type Description
arg0 boolean No description provided.

SetScrollParentToFitWhenFocused

TripleMonitorBackground.SetScrollParentToFitWhenFocused(arg0: boolean): void

No description provided.

Parameter

Name Type Description
arg0 boolean No description provided.

SetTopOfInputContext

TripleMonitorBackground.SetTopOfInputContext(arg0: boolean): void

No description provided.

Parameter

Name Type Description
arg0 boolean No description provided.

SortChildrenOnAttribute

TripleMonitorBackground.SortChildrenOnAttribute(attribute: string, ascending: boolean): void

No description provided.

Parameters

Name Type Description
attribute string No description provided.
ascending boolean No description provided.

SwitchClass

TripleMonitorBackground.SwitchClass(oldclass: string, newclass: string): void

No description provided.

Parameters

Name Type Description
oldclass string No description provided.
newclass string No description provided.

ToggleClass

TripleMonitorBackground.ToggleClass(classname: string): void

No description provided.

Parameter

Name Type Description
classname string No description provided.

TriggerClass

TripleMonitorBackground.TriggerClass(classname: string): void

No description provided.

Parameter

Name Type Description
classname string No description provided.

UpdateCurrentAnimationKeyframes

TripleMonitorBackground.UpdateCurrentAnimationKeyframes(animation: unknown): void

No description provided.

Parameter

Name Type Description
animation unknown No description provided.

UpdateFocusInContext

TripleMonitorBackground.UpdateFocusInContext(): boolean

No description provided.