Interface: SteamInputActionLabel

Interface describing base panel properties that all other panels extend.

Properties

NameTypeDescription
activationenabledbooleanNo description provided.
actuallayoutheightnumberNo description provided.
actuallayoutwidthnumberNo description provided.
actualuiscale_xnumberNo description provided.
actualuiscale_ynumberNo description provided.
actualxoffsetnumberNo description provided.
actualyoffsetnumberNo description provided.
checkedbooleanNo description provided.
contentheightnumberNo description provided.
contentwidthnumberNo description provided.
defaultfocusstringNo description provided.
desiredlayoutheightnumberNo description provided.
desiredlayoutwidthnumberNo description provided.
enabledbooleanNo description provided.
hittestbooleanNo description provided.
hittestchildrenbooleanNo description provided.
idstringNo description provided.
inputnamespacestringNo description provided.
layoutfilestringNo description provided.
paneltypeSteamInputActionLabelNo description provided.
rememberchildfocusbooleanNo description provided.
scrolloffset_xnumberNo description provided.
scrolloffset_ynumberNo description provided.
selectionpos_xnumberNo description provided.
selectionpos_ynumberNo description provided.
stylepano-typed.StyleNo description provided.
tabindexnumberNo description provided.
visiblebooleanNo description provided.

Functions

AcceptsFocus

SteamInputActionLabel.AcceptsFocus(): boolean

No description provided.

AcceptsInput

SteamInputActionLabel.AcceptsInput(): boolean

No description provided.

AddClass

SteamInputActionLabel.AddClass(classname: string): void

No description provided.

Parameter

NameTypeDescription
classnamestringNo description provided.

ApplyStyles

SteamInputActionLabel.ApplyStyles(arg0: boolean): void

No description provided.

Parameter

NameTypeDescription
arg0booleanNo description provided.

BAscendantHasClass

SteamInputActionLabel.BAscendantHasClass(arg0: string): boolean

No description provided.

Parameter

NameTypeDescription
arg0stringNo description provided.

CanSeeInParentScroll

SteamInputActionLabel.CanSeeInParentScroll(): boolean

No description provided.

Children

SteamInputActionLabel.Children(): pano-typed.GenericPanel[]

No description provided.

ClearPanelEvent

SteamInputActionLabel.ClearPanelEvent(event: string): void

No description provided.

Parameter

NameTypeDescription
eventstringNo description provided.

ClearPropertyFromCode

SteamInputActionLabel.ClearPropertyFromCode(arg0: unknown): void

No description provided.

Parameter

NameTypeDescription
arg0unknownNo description provided.

CreateChildren

SteamInputActionLabel.CreateChildren(elements: string): boolean

No description provided.

Parameter

NameTypeDescription
elementsstringNo description provided.

CreateCopyOfCSSKeyframes

SteamInputActionLabel.CreateCopyOfCSSKeyframes(animation: string): unknown

No description provided.

Parameter

NameTypeDescription
animationstringNo description provided.

Data

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

No description provided.

Parameter

NameTypeDescription
...argsany[]No description provided.

DeleteAsync

SteamInputActionLabel.DeleteAsync(delay: number): void

No description provided.

Parameter

NameTypeDescription
delaynumberNo description provided.

DeleteKeyframes

SteamInputActionLabel.DeleteKeyframes(animation: unknown): void

No description provided.

Parameter

NameTypeDescription
animationunknownNo description provided.

FindChild

SteamInputActionLabel.FindChild(id: string): pano-typed.T

Searches this element's direct children and returns a child with the specified id.

Parameter

NameTypeDescription
idstringNo description provided.

FindChildInLayoutFile

SteamInputActionLabel.FindChildInLayoutFile(id: string): pano-typed.T

No description provided.

Parameter

NameTypeDescription
idstringNo description provided.

FindChildrenWithClassTraverse

SteamInputActionLabel.FindChildrenWithClassTraverse(classname: string): pano-typed.T[]

No description provided.

Parameter

NameTypeDescription
classnamestringNo description provided.

FindChildTraverse

SteamInputActionLabel.FindChildTraverse(id: string): pano-typed.T

No description provided.

Parameter

NameTypeDescription
idstringNo description provided.

GetAttributeInt

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

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
fallbacknumberNo description provided.

GetAttributeString

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

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
fallbackstringNo description provided.

GetAttributeUInt32

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

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
fallbacknumberNo description provided.

GetChild

SteamInputActionLabel.GetChild(index: number): pano-typed.T

No description provided.

Parameter

NameTypeDescription
indexnumberNo description provided.

GetChildCount

SteamInputActionLabel.GetChildCount(): number

No description provided.

GetChildIndex

SteamInputActionLabel.GetChildIndex(child: pano-typed.GenericPanel): number

No description provided.

Parameter

NameTypeDescription
childpano-typed.GenericPanelNo description provided.

GetFirstChild

SteamInputActionLabel.GetFirstChild(): pano-typed.T

No description provided.

GetLastChild

SteamInputActionLabel.GetLastChild(): pano-typed.T

No description provided.

GetLayoutFileDefine

SteamInputActionLabel.GetLayoutFileDefine(def: string): unknown

No description provided.

Parameter

NameTypeDescription
defstringNo description provided.

GetParent

SteamInputActionLabel.GetParent(): pano-typed.T

No description provided.

GetPositionWithinWindow

SteamInputActionLabel.GetPositionWithinWindow(): unknown

No description provided.

HasClass

SteamInputActionLabel.HasClass(classname: string): boolean

No description provided.

Parameter

NameTypeDescription
classnamestringNo description provided.

HasDescendantKeyFocus

SteamInputActionLabel.HasDescendantKeyFocus(): boolean

No description provided.

HasHoverStyle

SteamInputActionLabel.HasHoverStyle(): boolean

No description provided.

HasKeyFocus

SteamInputActionLabel.HasKeyFocus(): boolean

No description provided.

IsDraggable

SteamInputActionLabel.IsDraggable(): boolean

No description provided.

IsReadyForDisplay

SteamInputActionLabel.IsReadyForDisplay(): boolean

No description provided.

IsSelected

SteamInputActionLabel.IsSelected(): boolean

No description provided.

IsSizeValid

SteamInputActionLabel.IsSizeValid(): boolean

No description provided.

IsTransparent

SteamInputActionLabel.IsTransparent(): boolean

No description provided.

IsValid

SteamInputActionLabel.IsValid(): boolean

Check if this panel is still valid

LoadLayout

SteamInputActionLabel.LoadLayout(url: string, override: boolean, partial: boolean): boolean

No description provided.

Parameters

NameTypeDescription
urlstringNo description provided.
overridebooleanNo description provided.
partialbooleanNo description provided.

LoadLayoutAsync

SteamInputActionLabel.LoadLayoutAsync(url: string, override: boolean, partial: boolean): void

No description provided.

Parameters

NameTypeDescription
urlstringNo description provided.
overridebooleanNo description provided.
partialbooleanNo description provided.

LoadLayoutFromString

SteamInputActionLabel.LoadLayoutFromString(layout: string, override: boolean, partial: boolean): void

No description provided.

Parameters

NameTypeDescription
layoutstringNo description provided.
overridebooleanNo description provided.
partialbooleanNo description provided.

LoadLayoutFromStringAsync

SteamInputActionLabel.LoadLayoutFromStringAsync(layout: string, override: boolean, partial: boolean): void

No description provided.

Parameters

NameTypeDescription
layoutstringNo description provided.
overridebooleanNo description provided.
partialbooleanNo description provided.

LoadLayoutSnippet

SteamInputActionLabel.LoadLayoutSnippet(snippet: string): boolean

No description provided.

Parameter

NameTypeDescription
snippetstringNo description provided.

MoveChildAfter

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

No description provided.

Parameters

NameTypeDescription
arg0unknownNo description provided.
arg1unknownNo description provided.

MoveChildBefore

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

No description provided.

Parameters

NameTypeDescription
arg0unknownNo description provided.
arg1unknownNo description provided.

RegisterForReadyEvents

SteamInputActionLabel.RegisterForReadyEvents(enable: boolean): void

Registers this panel to receive ready/unready events.

Parameter

NameTypeDescription
enablebooleanShould this panel receive ready/unready events?

RemoveAndDeleteChildren

SteamInputActionLabel.RemoveAndDeleteChildren(): void

No description provided.

RemoveClass

SteamInputActionLabel.RemoveClass(classname: string): void

No description provided.

Parameter

NameTypeDescription
classnamestringNo description provided.

ScrollParentToFitWhenFocused

SteamInputActionLabel.ScrollParentToFitWhenFocused(): boolean

No description provided.

ScrollParentToMakePanelFit

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

No description provided.

Parameters

NameTypeDescription
arg0numberNo description provided.
arg1booleanNo description provided.

ScrollToBottom

SteamInputActionLabel.ScrollToBottom(): void

No description provided.

ScrollToFitRegion

SteamInputActionLabel.ScrollToFitRegion(arg0: number, arg1: number, arg2: number, arg3: number, arg4: unknown, arg5: boolean, arg6: boolean): void

No description provided.

Parameters

NameTypeDescription
arg0numberNo description provided.
arg1numberNo description provided.
arg2numberNo description provided.
arg3numberNo description provided.
arg4unknownNo description provided.
arg5booleanNo description provided.
arg6booleanNo description provided.

ScrollToLeftEdge

SteamInputActionLabel.ScrollToLeftEdge(): void

No description provided.

ScrollToRightEdge

SteamInputActionLabel.ScrollToRightEdge(): void

No description provided.

ScrollToTop

SteamInputActionLabel.ScrollToTop(): void

No description provided.

SetAcceptsFocus

SteamInputActionLabel.SetAcceptsFocus(istrue: boolean): void

No description provided.

Parameter

NameTypeDescription
istruebooleanNo description provided.

SetAttributeInt

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

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
valuenumberNo description provided.

SetAttributeString

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

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
valuestringNo description provided.

SetAttributeUInt32

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

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
valuenumberNo description provided.

SetDialogVariable

SteamInputActionLabel.SetDialogVariable(name: string, value: string): void

Sets a dialog variable for the Panel.

Parameters

NameTypeDescription
namestringNo description provided.
valuestringNo description provided.

SetDialogVariableFloat

SteamInputActionLabel.SetDialogVariableFloat(name: string, value: number): void

Sets a float dialog variable for the Panel.

Parameters

NameTypeDescription
namestringNo description provided.
valuenumberNo description provided.

SetDialogVariableInt

SteamInputActionLabel.SetDialogVariableInt(name: string, value: number): void

Sets an integer dialog variable for the Panel.

Parameters

NameTypeDescription
namestringNo description provided.
valuenumberNo description provided.

SetDialogVariableTime

SteamInputActionLabel.SetDialogVariableTime(name: string, value: string | number): void

Sets a time dialog variable for the Panel.

Parameters

NameTypeDescription
namestringNo description provided.
valuestring | numberNo description provided.

SetDisableFocusOnMouseDown

SteamInputActionLabel.SetDisableFocusOnMouseDown(istrue: boolean): void

No description provided.

Parameter

NameTypeDescription
istruebooleanNo description provided.

SetDraggable

SteamInputActionLabel.SetDraggable(istrue: boolean): void

No description provided.

Parameter

NameTypeDescription
istruebooleanNo description provided.

SetFocus

SteamInputActionLabel.SetFocus(): boolean

No description provided.

SetHasClass

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

No description provided.

Parameters

NameTypeDescription
classnamestringNo description provided.
hasclassbooleanNo description provided.

SetInputNamespace

SteamInputActionLabel.SetInputNamespace(arg0: string): void

No description provided.

Parameter

NameTypeDescription
arg0stringNo description provided.

SetPanelEvent

SteamInputActionLabel.SetPanelEvent(event: string, callback: pano-typed.Func<any[], void>): void

Sets an event trigger for this panel.

Example

latestUpdateImage.SetPanelEvent('onactivate', () => SteamOverlayAPI.OpenURLModal(item.link));

Parameters

NameTypeDescription
eventstringNo description provided.
callbackpano-typed.Func<any[], void>No description provided.

See also

SetParent

SteamInputActionLabel.SetParent(parent: pano-typed.GenericPanel): void

No description provided.

Parameter

NameTypeDescription
parentpano-typed.GenericPanelNo description provided.

SetReadyForDisplay

SteamInputActionLabel.SetReadyForDisplay(arg0: boolean): void

No description provided.

Parameter

NameTypeDescription
arg0booleanNo description provided.

SetScrollParentToFitWhenFocused

SteamInputActionLabel.SetScrollParentToFitWhenFocused(arg0: boolean): void

No description provided.

Parameter

NameTypeDescription
arg0booleanNo description provided.

SetTopOfInputContext

SteamInputActionLabel.SetTopOfInputContext(arg0: boolean): void

No description provided.

Parameter

NameTypeDescription
arg0booleanNo description provided.

SortChildrenOnAttribute

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

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
ascendingbooleanNo description provided.

SwitchClass

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

No description provided.

Parameters

NameTypeDescription
oldclassstringNo description provided.
newclassstringNo description provided.

ToggleClass

SteamInputActionLabel.ToggleClass(classname: string): void

No description provided.

Parameter

NameTypeDescription
classnamestringNo description provided.

TriggerClass

SteamInputActionLabel.TriggerClass(classname: string): void

No description provided.

Parameter

NameTypeDescription
classnamestringNo description provided.

UpdateCurrentAnimationKeyframes

SteamInputActionLabel.UpdateCurrentAnimationKeyframes(animation: unknown): void

No description provided.

Parameter

NameTypeDescription
animationunknownNo description provided.

UpdateFocusInContext

SteamInputActionLabel.UpdateFocusInContext(): boolean

No description provided.