Interface: RangeColorDisplay

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.
color string 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 RangeColorDisplay 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

RangeColorDisplay.AcceptsFocus(): boolean

No description provided.

AcceptsInput

RangeColorDisplay.AcceptsInput(): boolean

No description provided.

AddClass

RangeColorDisplay.AddClass(classname: string): void

No description provided.

Parameter

Name Type Description
classname string No description provided.

ApplyStyles

RangeColorDisplay.ApplyStyles(arg0: boolean): void

No description provided.

Parameter

Name Type Description
arg0 boolean No description provided.

BAscendantHasClass

RangeColorDisplay.BAscendantHasClass(arg0: string): boolean

No description provided.

Parameter

Name Type Description
arg0 string No description provided.

CanSeeInParentScroll

RangeColorDisplay.CanSeeInParentScroll(): boolean

No description provided.

Children

RangeColorDisplay.Children(): GenericPanel[]

No description provided.

ClearPanelEvent

RangeColorDisplay.ClearPanelEvent(event: string): void

No description provided.

Parameter

Name Type Description
event string No description provided.

ClearPropertyFromCode

RangeColorDisplay.ClearPropertyFromCode(arg0: unknown): void

No description provided.

Parameter

Name Type Description
arg0 unknown No description provided.

CreateChildren

RangeColorDisplay.CreateChildren(elements: string): boolean

No description provided.

Parameter

Name Type Description
elements string No description provided.

CreateCopyOfCSSKeyframes

RangeColorDisplay.CreateCopyOfCSSKeyframes(animation: string): unknown

No description provided.

Parameter

Name Type Description
animation string No description provided.

Data

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

No description provided.

Parameter

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

DeleteAsync

RangeColorDisplay.DeleteAsync(delay: number): void

No description provided.

Parameter

Name Type Description
delay number No description provided.

DeleteKeyframes

RangeColorDisplay.DeleteKeyframes(animation: unknown): void

No description provided.

Parameter

Name Type Description
animation unknown No description provided.

FindChild

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

RangeColorDisplay.FindChildInLayoutFile(id: string): T

No description provided.

Parameter

Name Type Description
id string No description provided.

FindChildrenWithClassTraverse

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

No description provided.

Parameter

Name Type Description
classname string No description provided.

FindChildTraverse

RangeColorDisplay.FindChildTraverse(id: string): T

No description provided.

Parameter

Name Type Description
id string No description provided.

GetAttributeInt

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

No description provided.

Parameters

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

GetAttributeString

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

No description provided.

Parameters

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

GetAttributeUInt32

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

No description provided.

Parameters

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

GetChild

RangeColorDisplay.GetChild(index: number): T

No description provided.

Parameter

Name Type Description
index number No description provided.

GetChildCount

RangeColorDisplay.GetChildCount(): number

No description provided.

GetChildIndex

RangeColorDisplay.GetChildIndex(child: GenericPanel): number

No description provided.

Parameter

Name Type Description
child GenericPanel No description provided.

GetFirstChild

RangeColorDisplay.GetFirstChild(): T

No description provided.

GetLastChild

RangeColorDisplay.GetLastChild(): T

No description provided.

GetLayoutFileDefine

RangeColorDisplay.GetLayoutFileDefine(def: string): unknown

No description provided.

Parameter

Name Type Description
def string No description provided.

GetParent

RangeColorDisplay.GetParent(): T

No description provided.

GetPositionWithinWindow

RangeColorDisplay.GetPositionWithinWindow(): unknown

No description provided.

HasClass

RangeColorDisplay.HasClass(classname: string): boolean

No description provided.

Parameter

Name Type Description
classname string No description provided.

HasDescendantKeyFocus

RangeColorDisplay.HasDescendantKeyFocus(): boolean

No description provided.

HasHoverStyle

RangeColorDisplay.HasHoverStyle(): boolean

No description provided.

HasKeyFocus

RangeColorDisplay.HasKeyFocus(): boolean

No description provided.

IsDraggable

RangeColorDisplay.IsDraggable(): boolean

No description provided.

IsReadyForDisplay

RangeColorDisplay.IsReadyForDisplay(): boolean

No description provided.

IsSelected

RangeColorDisplay.IsSelected(): boolean

No description provided.

IsSizeValid

RangeColorDisplay.IsSizeValid(): boolean

No description provided.

IsTransparent

RangeColorDisplay.IsTransparent(): boolean

No description provided.

IsValid

RangeColorDisplay.IsValid(): boolean

Check if this panel is still valid

LoadLayout

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

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

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

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

RangeColorDisplay.LoadLayoutSnippet(snippet: string): boolean

No description provided.

Parameter

Name Type Description
snippet string No description provided.

MoveChildAfter

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

No description provided.

Parameters

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

MoveChildBefore

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

No description provided.

Parameters

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

RegisterForReadyEvents

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

RangeColorDisplay.RemoveAndDeleteChildren(): void

No description provided.

RemoveClass

RangeColorDisplay.RemoveClass(classname: string): void

No description provided.

Parameter

Name Type Description
classname string No description provided.

ScrollParentToFitWhenFocused

RangeColorDisplay.ScrollParentToFitWhenFocused(): boolean

No description provided.

ScrollParentToMakePanelFit

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

No description provided.

Parameters

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

ScrollToBottom

RangeColorDisplay.ScrollToBottom(): void

No description provided.

ScrollToFitRegion

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

RangeColorDisplay.ScrollToLeftEdge(): void

No description provided.

ScrollToRightEdge

RangeColorDisplay.ScrollToRightEdge(): void

No description provided.

ScrollToTop

RangeColorDisplay.ScrollToTop(): void

No description provided.

SetAcceptsFocus

RangeColorDisplay.SetAcceptsFocus(istrue: boolean): void

No description provided.

Parameter

Name Type Description
istrue boolean No description provided.

SetAttributeInt

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

No description provided.

Parameters

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

SetAttributeString

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

No description provided.

Parameters

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

SetAttributeUInt32

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

No description provided.

Parameters

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

SetBounds

RangeColorDisplay.SetBounds(min: number, max: number): void

No description provided.

Parameters

Name Type Description
min number No description provided.
max number No description provided.

SetDialogVariable

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

No description provided.

Parameters

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

SetDialogVariableFloat

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

No description provided.

Parameters

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

SetDialogVariableInt

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

No description provided.

Parameters

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

SetDialogVariableTime

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

RangeColorDisplay.SetDisableFocusOnMouseDown(istrue: boolean): void

No description provided.

Parameter

Name Type Description
istrue boolean No description provided.

SetDraggable

RangeColorDisplay.SetDraggable(istrue: boolean): void

No description provided.

Parameter

Name Type Description
istrue boolean No description provided.

SetFocus

RangeColorDisplay.SetFocus(focus: boolean): boolean

No description provided.

Parameter

Name Type Description
focus boolean No description provided.

SetHasClass

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

No description provided.

Parameters

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

SetInputNamespace

RangeColorDisplay.SetInputNamespace(arg0: string): void

No description provided.

Parameter

Name Type Description
arg0 string No description provided.

SetPanelEvent

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

RangeColorDisplay.SetParent(parent: GenericPanel): void

No description provided.

Parameter

Name Type Description
parent GenericPanel No description provided.

SetReadyForDisplay

RangeColorDisplay.SetReadyForDisplay(arg0: boolean): void

No description provided.

Parameter

Name Type Description
arg0 boolean No description provided.

SetScrollParentToFitWhenFocused

RangeColorDisplay.SetScrollParentToFitWhenFocused(arg0: boolean): void

No description provided.

Parameter

Name Type Description
arg0 boolean No description provided.

SetTopOfInputContext

RangeColorDisplay.SetTopOfInputContext(arg0: boolean): void

No description provided.

Parameter

Name Type Description
arg0 boolean No description provided.

SortChildrenOnAttribute

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

No description provided.

Parameters

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

SwitchClass

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

No description provided.

Parameters

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

ToggleClass

RangeColorDisplay.ToggleClass(classname: string): void

No description provided.

Parameter

Name Type Description
classname string No description provided.

TriggerClass

RangeColorDisplay.TriggerClass(classname: string): void

No description provided.

Parameter

Name Type Description
classname string No description provided.

UpdateCurrentAnimationKeyframes

RangeColorDisplay.UpdateCurrentAnimationKeyframes(animation: unknown): void

No description provided.

Parameter

Name Type Description
animation unknown No description provided.

UpdateFocusInContext

RangeColorDisplay.UpdateFocusInContext(): boolean

No description provided.