Interface: TooltipPanel

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

TooltipPanel.AcceptsFocus(): boolean

No description provided.

AcceptsInput

TooltipPanel.AcceptsInput(): boolean

No description provided.

AddClass

TooltipPanel.AddClass(classname: string): void

No description provided.

Parameter

NameTypeDescription
classnamestringNo description provided.

ApplyStyles

TooltipPanel.ApplyStyles(arg0: boolean): void

No description provided.

Parameter

NameTypeDescription
arg0booleanNo description provided.

BAscendantHasClass

TooltipPanel.BAscendantHasClass(arg0: string): boolean

No description provided.

Parameter

NameTypeDescription
arg0stringNo description provided.

CanSeeInParentScroll

TooltipPanel.CanSeeInParentScroll(): boolean

No description provided.

Children

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

No description provided.

ClearPanelEvent

TooltipPanel.ClearPanelEvent(event: string): void

No description provided.

Parameter

NameTypeDescription
eventstringNo description provided.

ClearPropertyFromCode

TooltipPanel.ClearPropertyFromCode(arg0: unknown): void

No description provided.

Parameter

NameTypeDescription
arg0unknownNo description provided.

CreateChildren

TooltipPanel.CreateChildren(elements: string): boolean

No description provided.

Parameter

NameTypeDescription
elementsstringNo description provided.

CreateCopyOfCSSKeyframes

TooltipPanel.CreateCopyOfCSSKeyframes(animation: string): unknown

No description provided.

Parameter

NameTypeDescription
animationstringNo description provided.

Data

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

No description provided.

Parameter

NameTypeDescription
...argsany[]No description provided.

DeleteAsync

TooltipPanel.DeleteAsync(delay: number): void

No description provided.

Parameter

NameTypeDescription
delaynumberNo description provided.

DeleteKeyframes

TooltipPanel.DeleteKeyframes(animation: unknown): void

No description provided.

Parameter

NameTypeDescription
animationunknownNo description provided.

FindChild

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

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

No description provided.

Parameter

NameTypeDescription
idstringNo description provided.

FindChildrenWithClassTraverse

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

No description provided.

Parameter

NameTypeDescription
classnamestringNo description provided.

FindChildTraverse

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

No description provided.

Parameter

NameTypeDescription
idstringNo description provided.

GetAttributeInt

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

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
fallbacknumberNo description provided.

GetAttributeString

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

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
fallbackstringNo description provided.

GetAttributeUInt32

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

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
fallbacknumberNo description provided.

GetChild

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

No description provided.

Parameter

NameTypeDescription
indexnumberNo description provided.

GetChildCount

TooltipPanel.GetChildCount(): number

No description provided.

GetChildIndex

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

No description provided.

Parameter

NameTypeDescription
childpano-typed.GenericPanelNo description provided.

GetFirstChild

TooltipPanel.GetFirstChild(): pano-typed.T

No description provided.

GetLastChild

TooltipPanel.GetLastChild(): pano-typed.T

No description provided.

GetLayoutFileDefine

TooltipPanel.GetLayoutFileDefine(def: string): unknown

No description provided.

Parameter

NameTypeDescription
defstringNo description provided.

GetParent

TooltipPanel.GetParent(): pano-typed.T

No description provided.

GetPositionWithinWindow

TooltipPanel.GetPositionWithinWindow(): unknown

No description provided.

HasClass

TooltipPanel.HasClass(classname: string): boolean

No description provided.

Parameter

NameTypeDescription
classnamestringNo description provided.

HasDescendantKeyFocus

TooltipPanel.HasDescendantKeyFocus(): boolean

No description provided.

HasHoverStyle

TooltipPanel.HasHoverStyle(): boolean

No description provided.

HasKeyFocus

TooltipPanel.HasKeyFocus(): boolean

No description provided.

IsDraggable

TooltipPanel.IsDraggable(): boolean

No description provided.

IsReadyForDisplay

TooltipPanel.IsReadyForDisplay(): boolean

No description provided.

IsSelected

TooltipPanel.IsSelected(): boolean

No description provided.

IsSizeValid

TooltipPanel.IsSizeValid(): boolean

No description provided.

IsTransparent

TooltipPanel.IsTransparent(): boolean

No description provided.

IsValid

TooltipPanel.IsValid(): boolean

Check if this panel is still valid

LoadLayout

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

No description provided.

Parameters

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

LoadLayoutAsync

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

No description provided.

Parameters

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

LoadLayoutFromString

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

No description provided.

Parameters

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

LoadLayoutFromStringAsync

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

No description provided.

Parameters

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

LoadLayoutSnippet

TooltipPanel.LoadLayoutSnippet(snippet: string): boolean

No description provided.

Parameter

NameTypeDescription
snippetstringNo description provided.

MoveChildAfter

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

No description provided.

Parameters

NameTypeDescription
arg0unknownNo description provided.
arg1unknownNo description provided.

MoveChildBefore

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

No description provided.

Parameters

NameTypeDescription
arg0unknownNo description provided.
arg1unknownNo description provided.

RegisterForReadyEvents

TooltipPanel.RegisterForReadyEvents(enable: boolean): void

Registers this panel to receive ready/unready events.

Parameter

NameTypeDescription
enablebooleanShould this panel receive ready/unready events?

RemoveAndDeleteChildren

TooltipPanel.RemoveAndDeleteChildren(): void

No description provided.

RemoveClass

TooltipPanel.RemoveClass(classname: string): void

No description provided.

Parameter

NameTypeDescription
classnamestringNo description provided.

ScrollParentToFitWhenFocused

TooltipPanel.ScrollParentToFitWhenFocused(): boolean

No description provided.

ScrollParentToMakePanelFit

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

No description provided.

Parameters

NameTypeDescription
arg0numberNo description provided.
arg1booleanNo description provided.

ScrollToBottom

TooltipPanel.ScrollToBottom(): void

No description provided.

ScrollToFitRegion

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

TooltipPanel.ScrollToLeftEdge(): void

No description provided.

ScrollToRightEdge

TooltipPanel.ScrollToRightEdge(): void

No description provided.

ScrollToTop

TooltipPanel.ScrollToTop(): void

No description provided.

SetAcceptsFocus

TooltipPanel.SetAcceptsFocus(istrue: boolean): void

No description provided.

Parameter

NameTypeDescription
istruebooleanNo description provided.

SetAttributeInt

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

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
valuenumberNo description provided.

SetAttributeString

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

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
valuestringNo description provided.

SetAttributeUInt32

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

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
valuenumberNo description provided.

SetDialogVariable

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

Sets a dialog variable for the Panel.

Parameters

NameTypeDescription
namestringNo description provided.
valuestringNo description provided.

SetDialogVariableFloat

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

Sets a float dialog variable for the Panel.

Parameters

NameTypeDescription
namestringNo description provided.
valuenumberNo description provided.

SetDialogVariableInt

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

Sets an integer dialog variable for the Panel.

Parameters

NameTypeDescription
namestringNo description provided.
valuenumberNo description provided.

SetDialogVariableTime

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

TooltipPanel.SetDisableFocusOnMouseDown(istrue: boolean): void

No description provided.

Parameter

NameTypeDescription
istruebooleanNo description provided.

SetDraggable

TooltipPanel.SetDraggable(istrue: boolean): void

No description provided.

Parameter

NameTypeDescription
istruebooleanNo description provided.

SetFocus

TooltipPanel.SetFocus(): boolean

No description provided.

SetHasClass

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

No description provided.

Parameters

NameTypeDescription
classnamestringNo description provided.
hasclassbooleanNo description provided.

SetInputNamespace

TooltipPanel.SetInputNamespace(arg0: string): void

No description provided.

Parameter

NameTypeDescription
arg0stringNo description provided.

SetPanelEvent

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

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

No description provided.

Parameter

NameTypeDescription
parentpano-typed.GenericPanelNo description provided.

SetReadyForDisplay

TooltipPanel.SetReadyForDisplay(arg0: boolean): void

No description provided.

Parameter

NameTypeDescription
arg0booleanNo description provided.

SetScrollParentToFitWhenFocused

TooltipPanel.SetScrollParentToFitWhenFocused(arg0: boolean): void

No description provided.

Parameter

NameTypeDescription
arg0booleanNo description provided.

SetTopOfInputContext

TooltipPanel.SetTopOfInputContext(arg0: boolean): void

No description provided.

Parameter

NameTypeDescription
arg0booleanNo description provided.

SortChildrenOnAttribute

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

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
ascendingbooleanNo description provided.

SwitchClass

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

No description provided.

Parameters

NameTypeDescription
oldclassstringNo description provided.
newclassstringNo description provided.

ToggleClass

TooltipPanel.ToggleClass(classname: string): void

No description provided.

Parameter

NameTypeDescription
classnamestringNo description provided.

TriggerClass

TooltipPanel.TriggerClass(classname: string): void

No description provided.

Parameter

NameTypeDescription
classnamestringNo description provided.

UpdateCurrentAnimationKeyframes

TooltipPanel.UpdateCurrentAnimationKeyframes(animation: unknown): void

No description provided.

Parameter

NameTypeDescription
animationunknownNo description provided.

UpdateFocusInContext

TooltipPanel.UpdateFocusInContext(): boolean

No description provided.