Interface: AnimatedImageStrip

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.
animatingbooleanWhether to start animating or not
checkedbooleanNo description provided.
contentheightnumberNo description provided.
contentwidthnumberNo description provided.
defaultfocusstringNo description provided.
defaultframenumberStarting frame
desiredlayoutheightnumberNo description provided.
desiredlayoutwidthnumberNo description provided.
enabledbooleanNo description provided.
frametimenumberPeriod between frames
hittestbooleanNo description provided.
hittestchildrenbooleanNo description provided.
idstringNo description provided.
inputnamespacestringNo description provided.
layoutfilestringNo description provided.
paneltypeAnimatedImageStripNo 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

AnimatedImageStrip.AcceptsFocus(): boolean

No description provided.

AcceptsInput

AnimatedImageStrip.AcceptsInput(): boolean

No description provided.

AddClass

AnimatedImageStrip.AddClass(classname: string): void

No description provided.

Parameter

NameTypeDescription
classnamestringNo description provided.

ApplyStyles

AnimatedImageStrip.ApplyStyles(arg0: boolean): void

No description provided.

Parameter

NameTypeDescription
arg0booleanNo description provided.

BAscendantHasClass

AnimatedImageStrip.BAscendantHasClass(arg0: string): boolean

No description provided.

Parameter

NameTypeDescription
arg0stringNo description provided.

CanSeeInParentScroll

AnimatedImageStrip.CanSeeInParentScroll(): boolean

No description provided.

Children

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

No description provided.

ClearPanelEvent

AnimatedImageStrip.ClearPanelEvent(event: string): void

No description provided.

Parameter

NameTypeDescription
eventstringNo description provided.

ClearPropertyFromCode

AnimatedImageStrip.ClearPropertyFromCode(arg0: unknown): void

No description provided.

Parameter

NameTypeDescription
arg0unknownNo description provided.

CreateChildren

AnimatedImageStrip.CreateChildren(elements: string): boolean

No description provided.

Parameter

NameTypeDescription
elementsstringNo description provided.

CreateCopyOfCSSKeyframes

AnimatedImageStrip.CreateCopyOfCSSKeyframes(animation: string): unknown

No description provided.

Parameter

NameTypeDescription
animationstringNo description provided.

Data

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

No description provided.

Parameter

NameTypeDescription
...argsany[]No description provided.

DeleteAsync

AnimatedImageStrip.DeleteAsync(delay: number): void

No description provided.

Parameter

NameTypeDescription
delaynumberNo description provided.

DeleteKeyframes

AnimatedImageStrip.DeleteKeyframes(animation: unknown): void

No description provided.

Parameter

NameTypeDescription
animationunknownNo description provided.

FindChild

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

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

No description provided.

Parameter

NameTypeDescription
idstringNo description provided.

FindChildrenWithClassTraverse

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

No description provided.

Parameter

NameTypeDescription
classnamestringNo description provided.

FindChildTraverse

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

No description provided.

Parameter

NameTypeDescription
idstringNo description provided.

GetAttributeInt

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

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
fallbacknumberNo description provided.

GetAttributeString

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

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
fallbackstringNo description provided.

GetAttributeUInt32

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

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
fallbacknumberNo description provided.

GetChild

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

No description provided.

Parameter

NameTypeDescription
indexnumberNo description provided.

GetChildCount

AnimatedImageStrip.GetChildCount(): number

No description provided.

GetChildIndex

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

No description provided.

Parameter

NameTypeDescription
childpano-typed.GenericPanelNo description provided.

GetFirstChild

AnimatedImageStrip.GetFirstChild(): pano-typed.T

No description provided.

GetLastChild

AnimatedImageStrip.GetLastChild(): pano-typed.T

No description provided.

GetLayoutFileDefine

AnimatedImageStrip.GetLayoutFileDefine(def: string): unknown

No description provided.

Parameter

NameTypeDescription
defstringNo description provided.

GetParent

AnimatedImageStrip.GetParent(): pano-typed.T

No description provided.

GetPositionWithinWindow

AnimatedImageStrip.GetPositionWithinWindow(): unknown

No description provided.

HasClass

AnimatedImageStrip.HasClass(classname: string): boolean

No description provided.

Parameter

NameTypeDescription
classnamestringNo description provided.

HasDescendantKeyFocus

AnimatedImageStrip.HasDescendantKeyFocus(): boolean

No description provided.

HasHoverStyle

AnimatedImageStrip.HasHoverStyle(): boolean

No description provided.

HasKeyFocus

AnimatedImageStrip.HasKeyFocus(): boolean

No description provided.

IsDraggable

AnimatedImageStrip.IsDraggable(): boolean

No description provided.

IsReadyForDisplay

AnimatedImageStrip.IsReadyForDisplay(): boolean

No description provided.

IsSelected

AnimatedImageStrip.IsSelected(): boolean

No description provided.

IsSizeValid

AnimatedImageStrip.IsSizeValid(): boolean

No description provided.

IsTransparent

AnimatedImageStrip.IsTransparent(): boolean

No description provided.

IsValid

AnimatedImageStrip.IsValid(): boolean

Check if this panel is still valid

LoadLayout

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

No description provided.

Parameters

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

LoadLayoutAsync

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

No description provided.

Parameters

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

LoadLayoutFromString

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

No description provided.

Parameters

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

LoadLayoutFromStringAsync

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

No description provided.

Parameters

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

LoadLayoutSnippet

AnimatedImageStrip.LoadLayoutSnippet(snippet: string): boolean

No description provided.

Parameter

NameTypeDescription
snippetstringNo description provided.

MoveChildAfter

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

No description provided.

Parameters

NameTypeDescription
arg0unknownNo description provided.
arg1unknownNo description provided.

MoveChildBefore

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

No description provided.

Parameters

NameTypeDescription
arg0unknownNo description provided.
arg1unknownNo description provided.

RegisterForReadyEvents

AnimatedImageStrip.RegisterForReadyEvents(enable: boolean): void

Registers this panel to receive ready/unready events.

Parameter

NameTypeDescription
enablebooleanShould this panel receive ready/unready events?

RemoveAndDeleteChildren

AnimatedImageStrip.RemoveAndDeleteChildren(): void

No description provided.

RemoveClass

AnimatedImageStrip.RemoveClass(classname: string): void

No description provided.

Parameter

NameTypeDescription
classnamestringNo description provided.

ScrollParentToFitWhenFocused

AnimatedImageStrip.ScrollParentToFitWhenFocused(): boolean

No description provided.

ScrollParentToMakePanelFit

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

No description provided.

Parameters

NameTypeDescription
arg0numberNo description provided.
arg1booleanNo description provided.

ScrollToBottom

AnimatedImageStrip.ScrollToBottom(): void

No description provided.

ScrollToFitRegion

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

AnimatedImageStrip.ScrollToLeftEdge(): void

No description provided.

ScrollToRightEdge

AnimatedImageStrip.ScrollToRightEdge(): void

No description provided.

ScrollToTop

AnimatedImageStrip.ScrollToTop(): void

No description provided.

SetAcceptsFocus

AnimatedImageStrip.SetAcceptsFocus(istrue: boolean): void

No description provided.

Parameter

NameTypeDescription
istruebooleanNo description provided.

SetAttributeInt

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

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
valuenumberNo description provided.

SetAttributeString

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

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
valuestringNo description provided.

SetAttributeUInt32

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

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
valuenumberNo description provided.

SetDialogVariable

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

Sets a dialog variable for the Panel.

Parameters

NameTypeDescription
namestringNo description provided.
valuestringNo description provided.

SetDialogVariableFloat

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

Sets a float dialog variable for the Panel.

Parameters

NameTypeDescription
namestringNo description provided.
valuenumberNo description provided.

SetDialogVariableInt

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

Sets an integer dialog variable for the Panel.

Parameters

NameTypeDescription
namestringNo description provided.
valuenumberNo description provided.

SetDialogVariableTime

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

AnimatedImageStrip.SetDisableFocusOnMouseDown(istrue: boolean): void

No description provided.

Parameter

NameTypeDescription
istruebooleanNo description provided.

SetDraggable

AnimatedImageStrip.SetDraggable(istrue: boolean): void

No description provided.

Parameter

NameTypeDescription
istruebooleanNo description provided.

SetFocus

AnimatedImageStrip.SetFocus(): boolean

No description provided.

SetHasClass

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

No description provided.

Parameters

NameTypeDescription
classnamestringNo description provided.
hasclassbooleanNo description provided.

SetImage

AnimatedImageStrip.SetImage(path: string): void

Can also be set via src XML attribute

Parameter

NameTypeDescription
pathstringNo description provided.

SetInputNamespace

AnimatedImageStrip.SetInputNamespace(arg0: string): void

No description provided.

Parameter

NameTypeDescription
arg0stringNo description provided.

SetPanelEvent

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

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

No description provided.

Parameter

NameTypeDescription
parentpano-typed.GenericPanelNo description provided.

SetReadyForDisplay

AnimatedImageStrip.SetReadyForDisplay(arg0: boolean): void

No description provided.

Parameter

NameTypeDescription
arg0booleanNo description provided.

SetScaling

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

Can also be set via scaling XML attribute

Parameter

NameTypeDescription
modepano-typed.ImageScalingModeNo description provided.

SetScrollParentToFitWhenFocused

AnimatedImageStrip.SetScrollParentToFitWhenFocused(arg0: boolean): void

No description provided.

Parameter

NameTypeDescription
arg0booleanNo description provided.

SetSvgTextureSize

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

Used to resize SVG images

Parameters

NameTypeDescription
widthnumberNo description provided.
heightnumberNo description provided.

SetTopOfInputContext

AnimatedImageStrip.SetTopOfInputContext(arg0: boolean): void

No description provided.

Parameter

NameTypeDescription
arg0booleanNo description provided.

SortChildrenOnAttribute

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

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
ascendingbooleanNo description provided.

SwitchClass

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

No description provided.

Parameters

NameTypeDescription
oldclassstringNo description provided.
newclassstringNo description provided.

ToggleClass

AnimatedImageStrip.ToggleClass(classname: string): void

No description provided.

Parameter

NameTypeDescription
classnamestringNo description provided.

TriggerClass

AnimatedImageStrip.TriggerClass(classname: string): void

No description provided.

Parameter

NameTypeDescription
classnamestringNo description provided.

UpdateCurrentAnimationKeyframes

AnimatedImageStrip.UpdateCurrentAnimationKeyframes(animation: unknown): void

No description provided.

Parameter

NameTypeDescription
animationunknownNo description provided.

UpdateFocusInContext

AnimatedImageStrip.UpdateFocusInContext(): boolean

No description provided.