Interface: RangeColorDisplay

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.
colorstringNo 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.
paneltypeRangeColorDisplayNo description provided.
rememberchildfocusbooleanNo description provided.
scrolloffset_xnumberNo description provided.
scrolloffset_ynumberNo description provided.
selectionpos_xnumberNo description provided.
selectionpos_ynumberNo description provided.
styleStyle No description provided.
tabindexnumberNo description provided.
visiblebooleanNo 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

NameTypeDescription
classnamestringNo description provided.

ApplyStyles

RangeColorDisplay.ApplyStyles(arg0: boolean): void

No description provided.

Parameter

NameTypeDescription
arg0booleanNo description provided.

BAscendantHasClass

RangeColorDisplay.BAscendantHasClass(arg0: string): boolean

No description provided.

Parameter

NameTypeDescription
arg0stringNo 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

NameTypeDescription
eventstringNo description provided.

ClearPropertyFromCode

RangeColorDisplay.ClearPropertyFromCode(arg0: unknown): void

No description provided.

Parameter

NameTypeDescription
arg0unknownNo description provided.

CreateChildren

RangeColorDisplay.CreateChildren(elements: string): boolean

No description provided.

Parameter

NameTypeDescription
elementsstringNo description provided.

CreateCopyOfCSSKeyframes

RangeColorDisplay.CreateCopyOfCSSKeyframes(animation: string): unknown

No description provided.

Parameter

NameTypeDescription
animationstringNo description provided.

Data

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

No description provided.

Parameter

NameTypeDescription
...argsany[]No description provided.

DeleteAsync

RangeColorDisplay.DeleteAsync(delay: number): void

No description provided.

Parameter

NameTypeDescription
delaynumberNo description provided.

DeleteKeyframes

RangeColorDisplay.DeleteKeyframes(animation: unknown): void

No description provided.

Parameter

NameTypeDescription
animationunknownNo description provided.

FindChild

RangeColorDisplay.FindChild(id: string): T

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

Parameter

NameTypeDescription
idstringNo description provided.

FindChildInLayoutFile

RangeColorDisplay.FindChildInLayoutFile(id: string): T

No description provided.

Parameter

NameTypeDescription
idstringNo description provided.

FindChildrenWithClassTraverse

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

No description provided.

Parameter

NameTypeDescription
classnamestringNo description provided.

FindChildTraverse

RangeColorDisplay.FindChildTraverse(id: string): T

No description provided.

Parameter

NameTypeDescription
idstringNo description provided.

GetAttributeInt

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

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
fallbacknumberNo description provided.

GetAttributeString

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

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
fallbackstringNo description provided.

GetAttributeUInt32

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

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
fallbacknumberNo description provided.

GetChild

RangeColorDisplay.GetChild(index: number): T

No description provided.

Parameter

NameTypeDescription
indexnumberNo description provided.

GetChildCount

RangeColorDisplay.GetChildCount(): number

No description provided.

GetChildIndex

RangeColorDisplay.GetChildIndex(child: GenericPanel): number

No description provided.

Parameter

NameTypeDescription
childGenericPanel 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

NameTypeDescription
defstringNo 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

NameTypeDescription
classnamestringNo 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

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

LoadLayoutAsync

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

No description provided.

Parameters

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

LoadLayoutFromString

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

No description provided.

Parameters

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

LoadLayoutFromStringAsync

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

No description provided.

Parameters

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

LoadLayoutSnippet

RangeColorDisplay.LoadLayoutSnippet(snippet: string): boolean

No description provided.

Parameter

NameTypeDescription
snippetstringNo description provided.

MoveChildAfter

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

No description provided.

Parameters

NameTypeDescription
arg0unknownNo description provided.
arg1unknownNo description provided.

MoveChildBefore

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

No description provided.

Parameters

NameTypeDescription
arg0unknownNo description provided.
arg1unknownNo description provided.

RegisterForReadyEvents

RangeColorDisplay.RegisterForReadyEvents(enable: boolean): void

Registers this panel to receive ready/unready events.

Parameter

NameTypeDescription
enablebooleanShould this panel receive ready/unready events?

RemoveAndDeleteChildren

RangeColorDisplay.RemoveAndDeleteChildren(): void

No description provided.

RemoveClass

RangeColorDisplay.RemoveClass(classname: string): void

No description provided.

Parameter

NameTypeDescription
classnamestringNo description provided.

ScrollParentToFitWhenFocused

RangeColorDisplay.ScrollParentToFitWhenFocused(): boolean

No description provided.

ScrollParentToMakePanelFit

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

No description provided.

Parameters

NameTypeDescription
arg0numberNo description provided.
arg1booleanNo 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

NameTypeDescription
arg0numberNo description provided.
arg1numberNo description provided.
arg2numberNo description provided.
arg3numberNo description provided.
arg4unknownNo description provided.
arg5booleanNo description provided.
arg6booleanNo 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

NameTypeDescription
istruebooleanNo description provided.

SetAttributeInt

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

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
valuenumberNo description provided.

SetAttributeString

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

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
valuestringNo description provided.

SetAttributeUInt32

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

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
valuenumberNo description provided.

SetBounds

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

No description provided.

Parameters

NameTypeDescription
minnumberNo description provided.
maxnumberNo description provided.

SetDialogVariable

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

No description provided.

Parameters

NameTypeDescription
arg0stringNo description provided.
arg1stringNo description provided.

SetDialogVariableFloat

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

No description provided.

Parameters

NameTypeDescription
arg0stringNo description provided.
arg1numberNo description provided.

SetDialogVariableInt

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

No description provided.

Parameters

NameTypeDescription
arg0stringNo description provided.
arg1numberNo description provided.

SetDialogVariableTime

RangeColorDisplay.SetDialogVariableTime(arg0: string, arg1: string | number): void

No description provided.

Parameters

NameTypeDescription
arg0stringNo description provided.
arg1string | numberNo description provided.

SetDisableFocusOnMouseDown

RangeColorDisplay.SetDisableFocusOnMouseDown(istrue: boolean): void

No description provided.

Parameter

NameTypeDescription
istruebooleanNo description provided.

SetDraggable

RangeColorDisplay.SetDraggable(istrue: boolean): void

No description provided.

Parameter

NameTypeDescription
istruebooleanNo description provided.

SetFocus

RangeColorDisplay.SetFocus(focus: boolean): boolean

No description provided.

Parameter

NameTypeDescription
focusbooleanNo description provided.

SetHasClass

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

No description provided.

Parameters

NameTypeDescription
classnamestringNo description provided.
hasclassbooleanNo description provided.

SetInputNamespace

RangeColorDisplay.SetInputNamespace(arg0: string): void

No description provided.

Parameter

NameTypeDescription
arg0stringNo 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

NameTypeDescription
eventstringNo description provided.
callbackFunc<any[], void>No description provided.

See also

SetParent

RangeColorDisplay.SetParent(parent: GenericPanel): void

No description provided.

Parameter

NameTypeDescription
parentGenericPanel No description provided.

SetReadyForDisplay

RangeColorDisplay.SetReadyForDisplay(arg0: boolean): void

No description provided.

Parameter

NameTypeDescription
arg0booleanNo description provided.

SetScrollParentToFitWhenFocused

RangeColorDisplay.SetScrollParentToFitWhenFocused(arg0: boolean): void

No description provided.

Parameter

NameTypeDescription
arg0booleanNo description provided.

SetTopOfInputContext

RangeColorDisplay.SetTopOfInputContext(arg0: boolean): void

No description provided.

Parameter

NameTypeDescription
arg0booleanNo description provided.

SortChildrenOnAttribute

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

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
ascendingbooleanNo description provided.

SwitchClass

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

No description provided.

Parameters

NameTypeDescription
oldclassstringNo description provided.
newclassstringNo description provided.

ToggleClass

RangeColorDisplay.ToggleClass(classname: string): void

No description provided.

Parameter

NameTypeDescription
classnamestringNo description provided.

TriggerClass

RangeColorDisplay.TriggerClass(classname: string): void

No description provided.

Parameter

NameTypeDescription
classnamestringNo description provided.

UpdateCurrentAnimationKeyframes

RangeColorDisplay.UpdateCurrentAnimationKeyframes(animation: unknown): void

No description provided.

Parameter

NameTypeDescription
animationunknownNo description provided.

UpdateFocusInContext

RangeColorDisplay.UpdateFocusInContext(): boolean

No description provided.

©2023-2025 Strata Source Contributors - Content License