Interface: AbstractImagePanel

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.
paneltypepano-typed.AbstractImagePanel.TNo description provided.
rememberchildfocusbooleanNo description provided.
scalingstringThe scaling mode of the image. Set this through Image.SetScaling(...)!
scrolloffset_xnumberNo description provided.
scrolloffset_ynumberNo description provided.
selectionpos_xnumberNo description provided.
selectionpos_ynumberNo description provided.
srcstringThe image source. Set this through Image.SetImage(...)!
stylepano-typed.StyleNo description provided.
tabindexnumberNo description provided.
textureheightstringNo description provided.
visiblebooleanNo description provided.

Functions

AcceptsFocus

AbstractImagePanel.AcceptsFocus(): boolean

No description provided.

AcceptsInput

AbstractImagePanel.AcceptsInput(): boolean

No description provided.

AddClass

AbstractImagePanel.AddClass(classname: string): void

No description provided.

Parameter

NameTypeDescription
classnamestringNo description provided.

ApplyStyles

AbstractImagePanel.ApplyStyles(arg0: boolean): void

No description provided.

Parameter

NameTypeDescription
arg0booleanNo description provided.

BAscendantHasClass

AbstractImagePanel.BAscendantHasClass(arg0: string): boolean

No description provided.

Parameter

NameTypeDescription
arg0stringNo description provided.

CanSeeInParentScroll

AbstractImagePanel.CanSeeInParentScroll(): boolean

No description provided.

Children

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

No description provided.

ClearPanelEvent

AbstractImagePanel.ClearPanelEvent(event: string): void

No description provided.

Parameter

NameTypeDescription
eventstringNo description provided.

ClearPropertyFromCode

AbstractImagePanel.ClearPropertyFromCode(arg0: unknown): void

No description provided.

Parameter

NameTypeDescription
arg0unknownNo description provided.

CreateChildren

AbstractImagePanel.CreateChildren(elements: string): boolean

No description provided.

Parameter

NameTypeDescription
elementsstringNo description provided.

CreateCopyOfCSSKeyframes

AbstractImagePanel.CreateCopyOfCSSKeyframes(animation: string): unknown

No description provided.

Parameter

NameTypeDescription
animationstringNo description provided.

Data

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

No description provided.

Parameter

NameTypeDescription
...argsany[]No description provided.

DeleteAsync

AbstractImagePanel.DeleteAsync(delay: number): void

No description provided.

Parameter

NameTypeDescription
delaynumberNo description provided.

DeleteKeyframes

AbstractImagePanel.DeleteKeyframes(animation: unknown): void

No description provided.

Parameter

NameTypeDescription
animationunknownNo description provided.

FindChild

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

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

No description provided.

Parameter

NameTypeDescription
idstringNo description provided.

FindChildrenWithClassTraverse

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

No description provided.

Parameter

NameTypeDescription
classnamestringNo description provided.

FindChildTraverse

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

No description provided.

Parameter

NameTypeDescription
idstringNo description provided.

GetAttributeInt

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

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
fallbacknumberNo description provided.

GetAttributeString

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

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
fallbackstringNo description provided.

GetAttributeUInt32

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

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
fallbacknumberNo description provided.

GetChild

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

No description provided.

Parameter

NameTypeDescription
indexnumberNo description provided.

GetChildCount

AbstractImagePanel.GetChildCount(): number

No description provided.

GetChildIndex

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

No description provided.

Parameter

NameTypeDescription
childpano-typed.GenericPanelNo description provided.

GetFirstChild

AbstractImagePanel.GetFirstChild(): pano-typed.T

No description provided.

GetLastChild

AbstractImagePanel.GetLastChild(): pano-typed.T

No description provided.

GetLayoutFileDefine

AbstractImagePanel.GetLayoutFileDefine(def: string): unknown

No description provided.

Parameter

NameTypeDescription
defstringNo description provided.

GetParent

AbstractImagePanel.GetParent(): pano-typed.T

No description provided.

GetPositionWithinWindow

AbstractImagePanel.GetPositionWithinWindow(): unknown

No description provided.

HasClass

AbstractImagePanel.HasClass(classname: string): boolean

No description provided.

Parameter

NameTypeDescription
classnamestringNo description provided.

HasDescendantKeyFocus

AbstractImagePanel.HasDescendantKeyFocus(): boolean

No description provided.

HasHoverStyle

AbstractImagePanel.HasHoverStyle(): boolean

No description provided.

HasKeyFocus

AbstractImagePanel.HasKeyFocus(): boolean

No description provided.

IsDraggable

AbstractImagePanel.IsDraggable(): boolean

No description provided.

IsReadyForDisplay

AbstractImagePanel.IsReadyForDisplay(): boolean

No description provided.

IsSelected

AbstractImagePanel.IsSelected(): boolean

No description provided.

IsSizeValid

AbstractImagePanel.IsSizeValid(): boolean

No description provided.

IsTransparent

AbstractImagePanel.IsTransparent(): boolean

No description provided.

IsValid

AbstractImagePanel.IsValid(): boolean

Check if this panel is still valid

LoadLayout

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

No description provided.

Parameters

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

LoadLayoutAsync

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

No description provided.

Parameters

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

LoadLayoutFromString

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

No description provided.

Parameters

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

LoadLayoutFromStringAsync

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

No description provided.

Parameters

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

LoadLayoutSnippet

AbstractImagePanel.LoadLayoutSnippet(snippet: string): boolean

No description provided.

Parameter

NameTypeDescription
snippetstringNo description provided.

MoveChildAfter

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

No description provided.

Parameters

NameTypeDescription
arg0unknownNo description provided.
arg1unknownNo description provided.

MoveChildBefore

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

No description provided.

Parameters

NameTypeDescription
arg0unknownNo description provided.
arg1unknownNo description provided.

RegisterForReadyEvents

AbstractImagePanel.RegisterForReadyEvents(enable: boolean): void

Registers this panel to receive ready/unready events.

Parameter

NameTypeDescription
enablebooleanShould this panel receive ready/unready events?

RemoveAndDeleteChildren

AbstractImagePanel.RemoveAndDeleteChildren(): void

No description provided.

RemoveClass

AbstractImagePanel.RemoveClass(classname: string): void

No description provided.

Parameter

NameTypeDescription
classnamestringNo description provided.

ScrollParentToFitWhenFocused

AbstractImagePanel.ScrollParentToFitWhenFocused(): boolean

No description provided.

ScrollParentToMakePanelFit

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

No description provided.

Parameters

NameTypeDescription
arg0numberNo description provided.
arg1booleanNo description provided.

ScrollToBottom

AbstractImagePanel.ScrollToBottom(): void

No description provided.

ScrollToFitRegion

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

AbstractImagePanel.ScrollToLeftEdge(): void

No description provided.

ScrollToRightEdge

AbstractImagePanel.ScrollToRightEdge(): void

No description provided.

ScrollToTop

AbstractImagePanel.ScrollToTop(): void

No description provided.

SetAcceptsFocus

AbstractImagePanel.SetAcceptsFocus(istrue: boolean): void

No description provided.

Parameter

NameTypeDescription
istruebooleanNo description provided.

SetAttributeInt

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

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
valuenumberNo description provided.

SetAttributeString

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

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
valuestringNo description provided.

SetAttributeUInt32

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

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
valuenumberNo description provided.

SetDialogVariable

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

Sets a dialog variable for the Panel.

Parameters

NameTypeDescription
namestringNo description provided.
valuestringNo description provided.

SetDialogVariableFloat

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

Sets a float dialog variable for the Panel.

Parameters

NameTypeDescription
namestringNo description provided.
valuenumberNo description provided.

SetDialogVariableInt

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

Sets an integer dialog variable for the Panel.

Parameters

NameTypeDescription
namestringNo description provided.
valuenumberNo description provided.

SetDialogVariableTime

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

AbstractImagePanel.SetDisableFocusOnMouseDown(istrue: boolean): void

No description provided.

Parameter

NameTypeDescription
istruebooleanNo description provided.

SetDraggable

AbstractImagePanel.SetDraggable(istrue: boolean): void

No description provided.

Parameter

NameTypeDescription
istruebooleanNo description provided.

SetFocus

AbstractImagePanel.SetFocus(): boolean

No description provided.

SetHasClass

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

No description provided.

Parameters

NameTypeDescription
classnamestringNo description provided.
hasclassbooleanNo description provided.

SetImage

AbstractImagePanel.SetImage(path: string): void

Can also be set via src XML attribute

Parameter

NameTypeDescription
pathstringNo description provided.

SetInputNamespace

AbstractImagePanel.SetInputNamespace(arg0: string): void

No description provided.

Parameter

NameTypeDescription
arg0stringNo description provided.

SetPanelEvent

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

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

No description provided.

Parameter

NameTypeDescription
parentpano-typed.GenericPanelNo description provided.

SetReadyForDisplay

AbstractImagePanel.SetReadyForDisplay(arg0: boolean): void

No description provided.

Parameter

NameTypeDescription
arg0booleanNo description provided.

SetScaling

AbstractImagePanel.SetScaling(mode: pano-typed.ImageScalingMode): void

Can also be set via scaling XML attribute

Parameter

NameTypeDescription
modepano-typed.ImageScalingModeNo description provided.

SetScrollParentToFitWhenFocused

AbstractImagePanel.SetScrollParentToFitWhenFocused(arg0: boolean): void

No description provided.

Parameter

NameTypeDescription
arg0booleanNo description provided.

SetSvgTextureSize

AbstractImagePanel.SetSvgTextureSize(width: number, height: number): void

Used to resize SVG images

Parameters

NameTypeDescription
widthnumberNo description provided.
heightnumberNo description provided.

SetTopOfInputContext

AbstractImagePanel.SetTopOfInputContext(arg0: boolean): void

No description provided.

Parameter

NameTypeDescription
arg0booleanNo description provided.

SortChildrenOnAttribute

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

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
ascendingbooleanNo description provided.

SwitchClass

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

No description provided.

Parameters

NameTypeDescription
oldclassstringNo description provided.
newclassstringNo description provided.

ToggleClass

AbstractImagePanel.ToggleClass(classname: string): void

No description provided.

Parameter

NameTypeDescription
classnamestringNo description provided.

TriggerClass

AbstractImagePanel.TriggerClass(classname: string): void

No description provided.

Parameter

NameTypeDescription
classnamestringNo description provided.

UpdateCurrentAnimationKeyframes

AbstractImagePanel.UpdateCurrentAnimationKeyframes(animation: unknown): void

No description provided.

Parameter

NameTypeDescription
animationunknownNo description provided.

UpdateFocusInContext

AbstractImagePanel.UpdateFocusInContext(): boolean

No description provided.