9.0 Released! → Native ESM runtimes 🚀, Vite support ⚡️, multi-window apps and more...
Read Announcement

Defined in: ui/layouts/liquid-glass/index.d.ts:3

Extends ​

  • LiquidGlassCommon

Constructors ​

Constructor ​

ts
new LiquidGlass(): LiquidGlass;

Defined in: ui/core/view-base/index.ts

Returns ​

LiquidGlass

Inherited from ​

ts
LiquidGlassCommon.constructor

Properties ​

_androidContentDescriptionUpdated? ​

ts
optional _androidContentDescriptionUpdated?: boolean;

Defined in: ui/core/view/index.d.ts:348

Internal use only. This is used to limit the number of updates to android.view.View.setContentDescription()

Inherited from ​

ts
LiquidGlassCommon._androidContentDescriptionUpdated

_automaticallyAdjustsScrollViewInsets ​

ts
_automaticallyAdjustsScrollViewInsets: boolean;

Defined in: ui/core/view-base/index.ts

Inherited from ​

ts
LiquidGlassCommon._automaticallyAdjustsScrollViewInsets

_closeModalCallback ​

ts
protected _closeModalCallback: Function;

Defined in: ui/core/view/view-common.ts

Inherited from ​

ts
LiquidGlassCommon._closeModalCallback

_context ​

ts
_context: any;

Defined in: ui/core/view-base/index.ts

Inherited from ​

ts
LiquidGlassCommon._context

_cssState ​

ts
_cssState: CssState;

Defined in: ui/core/view-base/index.ts

Inherited from ​

ts
LiquidGlassCommon._cssState

_defaultPaddingBottom ​

ts
protected _defaultPaddingBottom: number;

Defined in: ui/core/view-base/index.ts

Inherited from ​

ts
LiquidGlassCommon._defaultPaddingBottom

_defaultPaddingLeft ​

ts
protected _defaultPaddingLeft: number;

Defined in: ui/core/view-base/index.ts

Inherited from ​

ts
LiquidGlassCommon._defaultPaddingLeft

_defaultPaddingRight ​

ts
protected _defaultPaddingRight: number;

Defined in: ui/core/view-base/index.ts

Inherited from ​

ts
LiquidGlassCommon._defaultPaddingRight

_defaultPaddingTop ​

ts
protected _defaultPaddingTop: number;

Defined in: ui/core/view-base/index.ts

Inherited from ​

ts
LiquidGlassCommon._defaultPaddingTop

_domId ​

ts
_domId: number;

Defined in: ui/core/view-base/index.ts

Inherited from ​

ts
LiquidGlassCommon._domId

_ignoreFlexMinWidthHeightReset ​

ts
_ignoreFlexMinWidthHeightReset: boolean;

Defined in: ui/core/view-base/index.ts

Inherited from ​

ts
LiquidGlassCommon._ignoreFlexMinWidthHeightReset

_isAddedToNativeVisualTree ​

ts
_isAddedToNativeVisualTree: boolean;

Defined in: ui/core/view-base/index.ts

Inherited from ​

ts
LiquidGlassCommon._isAddedToNativeVisualTree

_isPaddingRelative ​

ts
protected _isPaddingRelative: boolean;

Defined in: ui/core/view-base/index.ts

Inherited from ​

ts
LiquidGlassCommon._isPaddingRelative

_isStyleScopeHost ​

ts
_isStyleScopeHost: boolean;

Defined in: ui/core/view-base/index.ts

Inherited from ​

ts
LiquidGlassCommon._isStyleScopeHost

_oldBottom ​

ts
_oldBottom: number;

Defined in: ui/core/view-base/index.ts

Inherited from ​

ts
LiquidGlassCommon._oldBottom

_oldLeft ​

ts
_oldLeft: number;

Defined in: ui/core/view-base/index.ts

Inherited from ​

ts
LiquidGlassCommon._oldLeft

_oldRight ​

ts
_oldRight: number;

Defined in: ui/core/view-base/index.ts

Inherited from ​

ts
LiquidGlassCommon._oldRight

_oldTop ​

ts
_oldTop: number;

Defined in: ui/core/view-base/index.ts

Inherited from ​

ts
LiquidGlassCommon._oldTop

_styleScope ​

ts
_styleScope: StyleScope;

Defined in: ui/core/view-base/index.ts

Inherited from ​

ts
LiquidGlassCommon._styleScope

_suspendNativeUpdatesCount ​

ts
_suspendNativeUpdatesCount: number;

Defined in: ui/core/view-base/index.ts

Determines the depth of suspended updates. When the value is 0 the current property updates are not batched nor scoped and must be immediately applied. If the value is 1 or greater, the current updates are batched and does not have to provide immediate update. Do not set this field, the _batchUpdate method is responsible to keep the count up to date, as well as adding/rmoving the view to/from the visual tree.

Inherited from ​

ts
LiquidGlassCommon._suspendNativeUpdatesCount

accessibilityHidden ​

ts
accessibilityHidden: boolean;

Defined in: ui/core/view/index.d.ts:250

Hide the view and its children from the a11y service

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.accessibilityHidden

accessibilityHint ​

ts
accessibilityHint: string;

Defined in: ui/core/view/index.d.ts:295

A hint describes the elements behavior. Example: 'Tap change playback speed'

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.accessibilityHint

accessibilityIdentifier ​

ts
accessibilityIdentifier: string;

Defined in: ui/core/view/index.d.ts:259

The view's unique accessibilityIdentifier.

This is used for automated testing.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.accessibilityIdentifier

accessibilityIgnoresInvertColors ​

ts
accessibilityIgnoresInvertColors: boolean;

Defined in: ui/core/view/index.d.ts:322

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.accessibilityIgnoresInvertColors

accessibilityLabel ​

ts
accessibilityLabel: string;

Defined in: ui/core/view/index.d.ts:281

Short description of the element, ideally one word.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.accessibilityLabel

accessibilityLanguage ​

ts
accessibilityLanguage: string;

Defined in: ui/core/view/index.d.ts:310

Sets the language in which to speak the element's label and value. Accepts language ID tags that follows the "BCP 47" specification.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.accessibilityLanguage

accessibilityLiveRegion ​

ts
accessibilityLiveRegion: AccessibilityLiveRegion;

Defined in: ui/core/view/index.d.ts:302

When components dynamically change, we want TalkBack to alert the end user. This is made possible by the accessibilityLiveRegion property.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.accessibilityLiveRegion

accessibilityMediaSession ​

ts
accessibilityMediaSession: boolean;

Defined in: ui/core/view/index.d.ts:317

This view starts a media session. Equivalent to trait = startsMedia

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.accessibilityMediaSession

accessibilityRole ​

ts
accessibilityRole: AccessibilityRole;

Defined in: ui/core/view/index.d.ts:266

Which role should this view be treated by the a11y service?

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.accessibilityRole

accessibilityState ​

ts
accessibilityState: AccessibilityState;

Defined in: ui/core/view/index.d.ts:274

Which state should this view be treated as by the a11y service?

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.accessibilityState

accessibilityValue ​

ts
accessibilityValue: string;

Defined in: ui/core/view/index.d.ts:288

Current value of the element in a localized string.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.accessibilityValue

accessible ​

ts
accessible: boolean;

Defined in: ui/core/view/index.d.ts:243

If true the element is an accessibility element and all the children will be treated as a single selectable component.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.accessible

alignSelf ​

ts
alignSelf: AlignSelf;

Defined in: ui/core/view-base/index.ts

(Android-only) Overrides the alignItems value for the child.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.alignSelf

android ​

ts
android: any;

Defined in: ui/core/view/index.d.ts:111

Gets the android-specific native instance that lies behind this proxy. Will be available if running on an Android platform.

Inherited from ​

ts
LiquidGlassCommon.android

androidDynamicElevationOffset ​

ts
androidDynamicElevationOffset: number;

Defined in: ui/core/view/index.d.ts:368

Gets or sets the dynamic elevation offset of the android view.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.androidDynamicElevationOffset

androidElevation ​

ts
androidElevation: number;

Defined in: ui/core/view/index.d.ts:361

Gets or sets the elevation of the android view.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.androidElevation

androidOverflowEdge ​

ts
androidOverflowEdge: AndroidOverflow;

Defined in: ui/core/view/view-common.ts

Inherited from ​

ts
LiquidGlassCommon.androidOverflowEdge

automationText ​

ts
automationText: string;

Defined in: ui/core/view/index.d.ts:354

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.automationText

background ​

ts
background: string;

Defined in: ui/core/view/index.d.ts:375

Gets or sets the background style property.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.background

backgroundColor ​

ts
backgroundColor: string | Color;

Defined in: ui/core/view/index.d.ts:382

Gets or sets the background color of the view.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.backgroundColor

backgroundImage ​

ts
backgroundImage: string | LinearGradient;

Defined in: ui/core/view/index.d.ts:389

Gets or sets the background image of the view.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.backgroundImage

bindingContext ​

ts
bindingContext: any;

Defined in: ui/core/view/index.d.ts:124

Gets or sets the binding context of this instance. This object is used as a source for each Binding that does not have a source object specified.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.bindingContext

borderBottomColor ​

ts
borderBottomColor: Color;

Defined in: ui/core/view/index.d.ts:152

Gets or sets the bottom border color of the view.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.borderBottomColor

borderBottomLeftRadius ​

ts
borderBottomLeftRadius: LengthType;

Defined in: ui/core/view/index.d.ts:229

Gets or sets the bottom left border radius of the view.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.borderBottomLeftRadius

borderBottomRightRadius ​

ts
borderBottomRightRadius: LengthType;

Defined in: ui/core/view/index.d.ts:222

Gets or sets the bottom right border radius of the view.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.borderBottomRightRadius

borderBottomWidth ​

ts
borderBottomWidth: LengthType;

Defined in: ui/core/view/index.d.ts:187

Gets or sets the bottom border width of the view.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.borderBottomWidth

borderColor ​

ts
borderColor: string | Color;

Defined in: ui/core/view/index.d.ts:131

Gets or sets the border color of the view.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.borderColor

borderLeftColor ​

ts
borderLeftColor: Color;

Defined in: ui/core/view/index.d.ts:159

Gets or sets the left border color of the view.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.borderLeftColor

borderLeftWidth ​

ts
borderLeftWidth: LengthType;

Defined in: ui/core/view/index.d.ts:194

Gets or sets the left border width of the view.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.borderLeftWidth

borderRadius ​

ts
borderRadius: 
  | string
  | number
  | LengthDipUnit
  | LengthPxUnit;

Defined in: ui/core/view/index.d.ts:201

Gets or sets the border radius of the view.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.borderRadius

borderRightColor ​

ts
borderRightColor: Color;

Defined in: ui/core/view/index.d.ts:145

Gets or sets the right border color of the view.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.borderRightColor

borderRightWidth ​

ts
borderRightWidth: LengthType;

Defined in: ui/core/view/index.d.ts:180

Gets or sets the right border width of the view.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.borderRightWidth

borderTopColor ​

ts
borderTopColor: Color;

Defined in: ui/core/view/index.d.ts:138

Gets or sets the top border color of the view.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.borderTopColor

borderTopLeftRadius ​

ts
borderTopLeftRadius: LengthType;

Defined in: ui/core/view/index.d.ts:208

Gets or sets the top left border radius of the view.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.borderTopLeftRadius

borderTopRightRadius ​

ts
borderTopRightRadius: LengthType;

Defined in: ui/core/view/index.d.ts:215

Gets or sets the top right border radius of the view.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.borderTopRightRadius

borderTopWidth ​

ts
borderTopWidth: LengthType;

Defined in: ui/core/view/index.d.ts:173

Gets or sets the top border width of the view.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.borderTopWidth

borderWidth ​

ts
borderWidth: 
  | string
  | number
  | LengthDipUnit
  | LengthPxUnit;

Defined in: ui/core/view/index.d.ts:166

Gets or sets the border width of the view.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.borderWidth

boxShadow ​

ts
boxShadow: string | ShadowCSSValues[];

Defined in: ui/core/view/index.d.ts:396

Gets or sets the box shadow of the view.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.boxShadow

className ​

ts
className: string;

Defined in: ui/core/view-base/index.ts

Gets or sets the CSS class name for this view.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.className

clipToBounds ​

ts
clipToBounds: boolean;

Defined in: ui/layouts/layout-base.d.ts:106

Gets or sets a value indicating whether to clip the content of this layout.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.clipToBounds

col ​

ts
col: number;

Defined in: ui/core/view-base/index.ts

The column for the element. The columns are 0-indexed, so the first column is indicated by 0.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.col

color ​

ts
color: Color;

Defined in: ui/core/view/index.d.ts:236

Gets or sets the color of the view.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.color

colSpan ​

ts
colSpan: number;

Defined in: ui/core/view-base/index.ts

The number of columns for the element to span across.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.colSpan

column ​

ts
column: number;

Defined in: ui/core/view-base/index.ts

The column for the element. The columns are 0-indexed, so the first column is indicated by 0.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.column

columns ​

ts
columns: string;

Defined in: ui/layouts/grid-layout/index.d.ts:67

A string value representing column widths delimited with commas.

Valid values: an absolute number, auto, or *:

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.columns

columnSpan ​

ts
columnSpan: number;

Defined in: ui/core/view-base/index.ts

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.columnSpan

cssClasses ​

ts
cssClasses: Set<string>;

Defined in: ui/core/view/index.d.ts:685

Inherited from ​

ts
LiquidGlassCommon.cssClasses

cssPseudoClasses ​

ts
cssPseudoClasses: Set<string>;

Defined in: ui/core/view/index.d.ts:686

Inherited from ​

ts
LiquidGlassCommon.cssPseudoClasses

cssType ​

ts
cssType: string;

Defined in: ui/core/view/index.d.ts:667

Gets the CSS fully qualified type name. Using this as element type should allow for PascalCase and kebap-case selectors, when fully qualified, to match the element.

Inherited from ​

ts
LiquidGlassCommon.cssType

defaultVisualState ​

ts
defaultVisualState: string;

Defined in: ui/core/view-base/index.ts

Default visual state, defaults to 'normal'

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.defaultVisualState

direction ​

ts
direction: LayoutDirectionType;

Defined in: ui/core/view/index.d.ts:403

Gets or sets the layout direction of the view.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.direction

dock ​

ts
dock: "left" | "right" | "top" | "bottom";

Defined in: ui/core/view-base/index.ts

Dock position of the view within its parent.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.dock

domNode ​

ts
domNode: DOMNode;

Defined in: ui/core/view-base/index.ts

Inherited from ​

ts
LiquidGlassCommon.domNode

effectiveBorderBottomWidth ​

ts
effectiveBorderBottomWidth: number;

Defined in: ui/core/view-base/index.ts

Inherited from ​

ts
LiquidGlassCommon.effectiveBorderBottomWidth

effectiveBorderLeftWidth ​

ts
effectiveBorderLeftWidth: number;

Defined in: ui/core/view-base/index.ts

Inherited from ​

ts
LiquidGlassCommon.effectiveBorderLeftWidth

effectiveBorderRightWidth ​

ts
effectiveBorderRightWidth: number;

Defined in: ui/core/view-base/index.ts

Inherited from ​

ts
LiquidGlassCommon.effectiveBorderRightWidth

effectiveBorderTopWidth ​

ts
effectiveBorderTopWidth: number;

Defined in: ui/core/view-base/index.ts

Inherited from ​

ts
LiquidGlassCommon.effectiveBorderTopWidth

effectiveHeight ​

ts
effectiveHeight: number;

Defined in: ui/core/view-base/index.ts

Inherited from ​

ts
LiquidGlassCommon.effectiveHeight

effectiveLeft ​

ts
effectiveLeft: number;

Defined in: ui/core/view-base/index.ts

Inherited from ​

ts
LiquidGlassCommon.effectiveLeft

effectiveMarginBottom ​

ts
effectiveMarginBottom: number;

Defined in: ui/core/view-base/index.ts

Inherited from ​

ts
LiquidGlassCommon.effectiveMarginBottom

effectiveMarginLeft ​

ts
effectiveMarginLeft: number;

Defined in: ui/core/view-base/index.ts

Inherited from ​

ts
LiquidGlassCommon.effectiveMarginLeft

effectiveMarginRight ​

ts
effectiveMarginRight: number;

Defined in: ui/core/view-base/index.ts

Inherited from ​

ts
LiquidGlassCommon.effectiveMarginRight

effectiveMarginTop ​

ts
effectiveMarginTop: number;

Defined in: ui/core/view-base/index.ts

Inherited from ​

ts
LiquidGlassCommon.effectiveMarginTop

effectiveMinHeight ​

ts
effectiveMinHeight: number;

Defined in: ui/core/view-base/index.ts

Inherited from ​

ts
LiquidGlassCommon.effectiveMinHeight

effectiveMinWidth ​

ts
effectiveMinWidth: number;

Defined in: ui/core/view-base/index.ts

Inherited from ​

ts
LiquidGlassCommon.effectiveMinWidth

effectiveTop ​

ts
effectiveTop: number;

Defined in: ui/core/view-base/index.ts

Inherited from ​

ts
LiquidGlassCommon.effectiveTop

effectiveWidth ​

ts
effectiveWidth: number;

Defined in: ui/core/view-base/index.ts

Inherited from ​

ts
LiquidGlassCommon.effectiveWidth

flex ​

ts
flex: Flex;

Defined in: ui/core/view/index.d.ts:578

The flex shorthand property sets how a flex item will grow or shrink to fit the space available in its flex container.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.flex

flexFlow ​

ts
flexFlow: FlexFlow;

Defined in: ui/core/view/index.d.ts:573

The flex-flow Shorthand property specifies the direction of a flex container, as well as its wrapping behavior.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.flexFlow

flexGrow ​

ts
flexGrow: number;

Defined in: ui/core/view-base/index.ts

Indicates that the child should grow in size, if necessary. Sets how much the child will grow in proportion to the rest of the child elements in the flex container.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.flexGrow

flexShrink ​

ts
flexShrink: number;

Defined in: ui/core/view-base/index.ts

Indicates that the child should shrink when the row runs out of space. Sets how much the flex item will shrink in proportion to the rest of the child elements in the flex container. When not specified, its value is set to 1.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.flexShrink

flexWrapBefore ​

ts
flexWrapBefore: boolean;

Defined in: ui/core/view-base/index.ts

When true, forces the item to wrap onto a new line.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.flexWrapBefore

height ​

ts
height: PercentLengthType;

Defined in: ui/core/view/index.d.ts:431

Gets or sets the desired height of the view.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.height

hidden ​

ts
hidden: boolean;

Defined in: ui/core/view-base/index.ts

Gets or sets the visual state of the view.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.hidden

horizontalAlignment ​

ts
horizontalAlignment: HorizontalAlignmentType;

Defined in: ui/core/view/index.d.ts:473

Gets or sets the alignment of this view within its parent along the Horizontal axis.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.horizontalAlignment

id ​

ts
id: string;

Defined in: ui/core/view-base/index.ts

Gets or sets the id for this view.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.id

ignoreTouchAnimation ​

ts
ignoreTouchAnimation: boolean;

Defined in: ui/core/view/index.d.ts:647

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.ignoreTouchAnimation

ios ​

ts
ios: any;

Defined in: ui/core/view/index.d.ts:117

Gets the ios-specific native instance that lies behind this proxy. Will be available if running on an iOS platform.

Inherited from ​

ts
LiquidGlassCommon.ios

iosAccessibilityAdjustsFontSize ​

ts
iosAccessibilityAdjustsFontSize: boolean;

Defined in: ui/core/view/index.d.ts:329

Defines whether accessibility font scale should affect font size.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.iosAccessibilityAdjustsFontSize

iosAccessibilityMaxFontScale ​

ts
iosAccessibilityMaxFontScale: number;

Defined in: ui/core/view/index.d.ts:343

Gets or sets the maximum accessibility font scale.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.iosAccessibilityMaxFontScale

iosAccessibilityMinFontScale ​

ts
iosAccessibilityMinFontScale: number;

Defined in: ui/core/view/index.d.ts:336

Gets or sets the minimum accessibility font scale.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.iosAccessibilityMinFontScale

iosGlassEffect ​

ts
iosGlassEffect: GlassEffectType;

Defined in: ui/core/view/index.d.ts:634

Set the iOS liquid glass effect style on the view.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.iosGlassEffect

iosIgnoreSafeArea ​

ts
iosIgnoreSafeArea: boolean;

Defined in: ui/core/view/index.d.ts:613

Gets or sets a value indicating whether the the view should totally ignore safe areas computation. This property is iOS specific. Default value: false

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.iosIgnoreSafeArea

iosOverflowSafeArea ​

ts
iosOverflowSafeArea: boolean;

Defined in: ui/core/view/index.d.ts:1130

Instruct container view to expand beyond the safe area. This property is iOS specific. Default value: true

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.iosOverflowSafeArea

iosOverflowSafeAreaEnabled ​

ts
iosOverflowSafeAreaEnabled: boolean;

Defined in: ui/core/view/index.d.ts:606

Enables or disables the iosOverflowSafeArea property for all children. This property is iOS specific. Default value: true

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.iosOverflowSafeAreaEnabled

isCollapsed ​

ts
isCollapsed: any;

Defined in: ui/core/view-base/index.ts

Returns true if visibility is set to 'collapse'. Default(false) set in prototype Readonly property

Inherited from ​

ts
LiquidGlassCommon.isCollapsed

isEnabled ​

ts
isEnabled: boolean;

Defined in: ui/core/view/index.d.ts:585

Gets or sets a value indicating whether the the view is enabled. This affects the appearance of the view.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.isEnabled

isLayoutValid ​

ts
isLayoutValid: boolean;

Defined in: ui/core/view/index.d.ts:656

Gets if layout is valid. This is a read-only property.

Inherited from ​

ts
LiquidGlassCommon.isLayoutValid

isPassThroughParentEnabled ​

ts
isPassThroughParentEnabled: boolean;

Defined in: ui/layouts/layout-base.d.ts:115

Gets or sets a value indicating whether touch event should pass through to a parent view of the layout container in case an interactive child view did not handle it. Default value of this property is false. This does not affect the appearance of the view.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.isPassThroughParentEnabled

isUserInteractionEnabled ​

ts
isUserInteractionEnabled: boolean;

Defined in: ui/core/view/index.d.ts:592

Gets or sets a value indicating whether the user can interact with the view. This does not affect the appearance of the view.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.isUserInteractionEnabled

left ​

ts
left: LengthType;

Defined in: ui/core/view-base/index.ts

Gets or sets the distance, in pixels, between the left edge of the child and the left edge of its parent.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.left

margin ​

ts
margin: 
  | string
  | number
  | LengthDipUnit
  | LengthPxUnit
  | LengthPercentUnit;

Defined in: ui/core/view/index.d.ts:438

Gets or sets margin style property.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.margin

marginBottom ​

ts
marginBottom: PercentLengthType;

Defined in: ui/core/view/index.d.ts:466

Specifies extra space on the bottom side of this view.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.marginBottom

marginLeft ​

ts
marginLeft: PercentLengthType;

Defined in: ui/core/view/index.d.ts:445

Specifies extra space on the left side of this view.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.marginLeft

marginRight ​

ts
marginRight: PercentLengthType;

Defined in: ui/core/view/index.d.ts:459

Specifies extra space on the right side of this view.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.marginRight

marginTop ​

ts
marginTop: PercentLengthType;

Defined in: ui/core/view/index.d.ts:452

Specifies extra space on the top side of this view.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.marginTop

minHeight ​

ts
minHeight: LengthType;

Defined in: ui/core/view/index.d.ts:417

Gets or sets the minimum height the view may grow to.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.minHeight

minWidth ​

ts
minWidth: LengthType;

Defined in: ui/core/view/index.d.ts:410

Gets or sets the minimum width the view may grow to.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.minWidth

mIsRootView ​

ts
mIsRootView: boolean;

Defined in: ui/core/view-base/index.ts

if _setupAsRootView is called it means it is not supposed to be added to a parent. However parent can be set before for the purpose of CSS variables/classes. That variable ensures that _addViewToNativeVisualTree is not called in _setupAsRootView

Inherited from ​

ts
LiquidGlassCommon.mIsRootView

ts
modal: View;

Defined in: ui/core/view/index.d.ts:848

Returns the current modal view that this page is showing (is parent of), if any.

Inherited from ​

ts
LiquidGlassCommon.modal

nativeBackgroundState? ​

ts
optional nativeBackgroundState?: "unset" | "invalid" | "drawn";

Defined in: ui/core/view/index.d.ts:661

Native background states. This is a read-only property.

Inherited from ​

ts
LiquidGlassCommon.nativeBackgroundState

nativeViewProtected ​

ts
nativeViewProtected: any;

Defined in: ui/core/view-base/index.ts

read-only. If you want to set out-of-band the nativeView use the setNativeView method.

Inherited from ​

ts
LiquidGlassCommon.nativeViewProtected

opacity ​

ts
opacity: number;

Defined in: ui/core/view/index.d.ts:494

Gets or sets the opacity style property.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.opacity

order ​

ts
order: number;

Defined in: ui/core/view-base/index.ts

Sets the order in which child elements inside a Flex appear in relation to one another.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.order

originX ​

ts
originX: number;

Defined in: ui/core/view/index.d.ts:560

Gets or sets the X component of the origin point around which the view will be transformed. The default value is 0.5 representing the center of the view.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.originX

originY ​

ts
originY: number;

Defined in: ui/core/view/index.d.ts:567

Gets or sets the Y component of the origin point around which the view will be transformed. The default value is 0.5 representing the center of the view.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.originY

padding ​

ts
padding: 
  | string
  | number
  | LengthDipUnit
  | LengthPxUnit;

Defined in: ui/layouts/layout-base.d.ts:71

Gets or sets padding style property.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.padding

paddingBottom ​

ts
paddingBottom: LengthType;

Defined in: ui/layouts/layout-base.d.ts:78

Specify the bottom padding of this layout.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.paddingBottom

paddingLeft ​

ts
paddingLeft: LengthType;

Defined in: ui/layouts/layout-base.d.ts:85

Specify the left padding of this layout.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.paddingLeft

paddingRight ​

ts
paddingRight: LengthType;

Defined in: ui/layouts/layout-base.d.ts:92

Specify the right padding of this layout.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.paddingRight

paddingTop ​

ts
paddingTop: LengthType;

Defined in: ui/layouts/layout-base.d.ts:99

Specify the top padding of this layout.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.paddingTop

parent ​

ts
parent: ViewBase;

Defined in: ui/core/view-base/index.ts

Gets the parent view. This property is read-only.

Inherited from ​

ts
LiquidGlassCommon.parent

perspective ​

ts
perspective: number;

Defined in: ui/core/view/index.d.ts:523

Gets or sets the distance of the camera form the view perspective. Usually needed when rotating the view over the X or Y axis.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.perspective

recycleNativeView ​

ts
recycleNativeView: "auto" | "always" | "never";

Defined in: ui/core/view-base/index.ts

Inherited from ​

ts
LiquidGlassCommon.recycleNativeView

reusable ​

ts
reusable: boolean;

Defined in: ui/core/view-base/index.ts

Gets or sets if the view is reusable. Reusable views are not automatically destroyed when removed from the View tree.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.reusable

rotate ​

ts
rotate: number;

Defined in: ui/core/view/index.d.ts:501

Gets or sets the rotate affine transform of the view along the Z axis.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.rotate

rotateX ​

ts
rotateX: number;

Defined in: ui/core/view/index.d.ts:508

Gets or sets the rotate affine transform of the view along the X axis.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.rotateX

rotateY ​

ts
rotateY: number;

Defined in: ui/core/view/index.d.ts:515

Gets or sets the rotate affine transform of the view along the Y axis.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.rotateY

row ​

ts
row: number;

Defined in: ui/core/view-base/index.ts

The row for the element. The rows are 0-indexed, so the first row is indicated by 0.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.row

rows ​

ts
rows: string;

Defined in: ui/layouts/grid-layout/index.d.ts:59

A string value representing row heights delimited with commas.

Valid values: an absolute number, auto, or *:

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.rows

rowSpan ​

ts
rowSpan: number;

Defined in: ui/core/view-base/index.ts

The number of rows for the element to span across.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.rowSpan

scaleX ​

ts
scaleX: number;

Defined in: ui/core/view/index.d.ts:544

Gets or sets the scaleX affine transform of the view.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.scaleX

scaleY ​

ts
scaleY: number;

Defined in: ui/core/view/index.d.ts:551

Gets or sets the scaleY affine transform of the view.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.scaleY

sharedTransitionIgnore ​

ts
sharedTransitionIgnore: boolean;

Defined in: ui/core/view-base/index.ts

Opt out of shared transition under different binding conditions

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.sharedTransitionIgnore

sharedTransitionTag ​

ts
sharedTransitionTag: string;

Defined in: ui/core/view-base/index.ts

Gets or sets the shared transition tag for animated view transitions

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.sharedTransitionTag

statusBarStyle ​

ts
statusBarStyle: "dark" | "light";

Defined in: ui/core/view/index.d.ts:683

Gets or sets the status bar style for this view. Platform Notes:

False value will make this property have no effect.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.statusBarStyle

testID ​

ts
testID: string;

Defined in: ui/core/view/index.d.ts:639

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.testID

top ​

ts
top: LengthType;

Defined in: ui/core/view-base/index.ts

Gets or sets the distance, in pixels, between the top edge of the child and the top edge of its parent.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.top

touchAnimation ​

ts
touchAnimation: 
  | boolean
  | TouchAnimationOptions;

Defined in: ui/core/view/index.d.ts:643

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.touchAnimation

touchDelay ​

ts
touchDelay: number;

Defined in: ui/core/view/index.d.ts:651

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.touchDelay

transitionId ​

ts
transitionId: number;

Defined in: ui/core/view/view-common.ts

Active transition instance id for tracking state

Inherited from ​

ts
LiquidGlassCommon.transitionId

translateX ​

ts
translateX: number;

Defined in: ui/core/view/index.d.ts:530

Gets or sets the translateX affine transform of the view in device independent pixels.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.translateX

translateY ​

ts
translateY: number;

Defined in: ui/core/view/index.d.ts:537

Gets or sets the translateY affine transform of the view in device independent pixels.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.translateY

verticalAlignment ​

ts
verticalAlignment: VerticalAlignmentType;

Defined in: ui/core/view/index.d.ts:480

Gets or sets the alignment of this view within its parent along the Vertical axis.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.verticalAlignment

viewController ​

ts
viewController: any;

Defined in: ui/core/view-base/index.ts

returns the native UIViewController.

Inherited from ​

ts
LiquidGlassCommon.viewController

visibility ​

ts
visibility: VisibilityType;

Defined in: ui/core/view/index.d.ts:487

Gets or sets the visibility of the view.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.visibility

visionHoverStyle ​

ts
visionHoverStyle: string | VisionHoverOptions;

Defined in: ui/core/view/index.d.ts:627

visionOS only

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.visionHoverStyle

visionIgnoreHoverStyle ​

ts
visionIgnoreHoverStyle: boolean;

Defined in: ui/core/view/index.d.ts:620

visionOS only

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.visionIgnoreHoverStyle

width ​

ts
width: PercentLengthType;

Defined in: ui/core/view/index.d.ts:424

Gets or sets the desired width of the view.

Ns Property ​

Inherited from ​

ts
LiquidGlassCommon.width

accessibilityBlurEvent ​

ts
static accessibilityBlurEvent: string;

Defined in: ui/core/view/index.d.ts:79

String value used when hooking to accessibilityBlur event.

Ns Event ​

accessibilityBlur

Inherited from ​

ts
LiquidGlassCommon.accessibilityBlurEvent

accessibilityFocusChangedEvent ​

ts
static accessibilityFocusChangedEvent: string;

Defined in: ui/core/view/index.d.ts:93

String value used when hooking to accessibilityFocusChanged event.

Ns Event ​

accessibilityFocusChanged

Inherited from ​

ts
LiquidGlassCommon.accessibilityFocusChangedEvent

accessibilityFocusEvent ​

ts
static accessibilityFocusEvent: string;

Defined in: ui/core/view/index.d.ts:86

String value used when hooking to accessibilityFocus event.

Ns Event ​

accessibilityFocus

Inherited from ​

ts
LiquidGlassCommon.accessibilityFocusEvent

accessibilityPerformEscapeEvent ​

ts
static accessibilityPerformEscapeEvent: string;

Defined in: ui/core/view/view-common.ts

Inherited from ​

ts
LiquidGlassCommon.accessibilityPerformEscapeEvent

androidOverflowInsetEvent ​

ts
static androidOverflowInsetEvent: string;

Defined in: ui/core/view/index.d.ts:100

String value used when hooking to androidOverflowInset event.

Ns Event ​

androidOverflowInset

Inherited from ​

ts
LiquidGlassCommon.androidOverflowInsetEvent

createdEvent ​

ts
static createdEvent: string;

Defined in: ui/core/view-base/index.ts

String value used when hooking to creation event

Ns Event ​

created

Inherited from ​

ts
LiquidGlassCommon.createdEvent

disposeNativeViewEvent ​

ts
static disposeNativeViewEvent: string;

Defined in: ui/core/view-base/index.ts

String value used when hooking to disposeNativeView event

Ns Event ​

disposeNativeView

Inherited from ​

ts
LiquidGlassCommon.disposeNativeViewEvent

layoutChangedEvent ​

ts
static layoutChangedEvent: string;

Defined in: ui/core/view/index.d.ts:59

String value used when hooking to layoutChanged event.

Ns Event ​

layoutChanged

Inherited from ​

ts
LiquidGlassCommon.layoutChangedEvent

loadedEvent ​

ts
static loadedEvent: string;

Defined in: ui/core/view-base/index.ts

String value used when hooking to loaded event.

Ns Event ​

loaded

Inherited from ​

ts
LiquidGlassCommon.loadedEvent

propertyChangeEvent ​

ts
static propertyChangeEvent: string;

Defined in: data/observable/index.ts

String value used when hooking to propertyChange event.

Ns Event ​

propertyChange

Inherited from ​

ts
LiquidGlassCommon.propertyChangeEvent

showingModallyEvent ​

ts
static showingModallyEvent: string;

Defined in: ui/core/view/index.d.ts:65

String value used when hooking to showingModally event.

Ns Event ​

showingModally

Inherited from ​

ts
LiquidGlassCommon.showingModallyEvent

shownModallyEvent ​

ts
static shownModallyEvent: string;

Defined in: ui/core/view/index.d.ts:72

String value used when hooking to shownModally event.

Ns Event ​

shownModally

Inherited from ​

ts
LiquidGlassCommon.shownModallyEvent

unloadedEvent ​

ts
static unloadedEvent: string;

Defined in: ui/core/view-base/index.ts

String value used when hooking to unloaded event.

Ns Event ​

unloaded

Inherited from ​

ts
LiquidGlassCommon.unloadedEvent

Accessors ​

backgroundPosition ​

Get Signature ​

ts
get backgroundPosition(): string;

Defined in: ui/core/view/view-common.ts

Returns ​

string

Set Signature ​

ts
set backgroundPosition(value: string): void;

Defined in: ui/core/view/view-common.ts

Parameters ​
ParameterType
valuestring
Returns ​

void

Inherited from ​

ts
LiquidGlassCommon.backgroundPosition

backgroundRepeat ​

Get Signature ​

ts
get backgroundRepeat(): BackgroundRepeatType;

Defined in: ui/core/view/view-common.ts

Returns ​

BackgroundRepeatType

Set Signature ​

ts
set backgroundRepeat(value: BackgroundRepeatType): void;

Defined in: ui/core/view/view-common.ts

Parameters ​
ParameterType
valueBackgroundRepeatType
Returns ​

void

Inherited from ​

ts
LiquidGlassCommon.backgroundRepeat

backgroundSize ​

Get Signature ​

ts
get backgroundSize(): string;

Defined in: ui/core/view/view-common.ts

Returns ​

string

Set Signature ​

ts
set backgroundSize(value: string): void;

Defined in: ui/core/view/view-common.ts

Parameters ​
ParameterType
valuestring
Returns ​

void

Inherited from ​

ts
LiquidGlassCommon.backgroundSize

class ​

Get Signature ​

ts
get class(): string;

Defined in: ui/core/view-base/index.ts

Returns ​

string

Set Signature ​

ts
set class(v: string): void;

Defined in: ui/core/view-base/index.ts

Parameters ​
ParameterType
vstring
Returns ​

void

Inherited from ​

ts
LiquidGlassCommon.class

effectivePaddingBottom ​

Get Signature ​

ts
get effectivePaddingBottom(): number;

Defined in: ui/core/view-base/index.ts

Returns ​

number

Set Signature ​

ts
set effectivePaddingBottom(v: number): void;

Defined in: ui/core/view-base/index.ts

Parameters ​
ParameterType
vnumber
Returns ​

void

Inherited from ​

ts
LiquidGlassCommon.effectivePaddingBottom

effectivePaddingLeft ​

Get Signature ​

ts
get effectivePaddingLeft(): number;

Defined in: ui/core/view-base/index.ts

Returns ​

number

Set Signature ​

ts
set effectivePaddingLeft(v: number): void;

Defined in: ui/core/view-base/index.ts

Parameters ​
ParameterType
vnumber
Returns ​

void

Inherited from ​

ts
LiquidGlassCommon.effectivePaddingLeft

effectivePaddingRight ​

Get Signature ​

ts
get effectivePaddingRight(): number;

Defined in: ui/core/view-base/index.ts

Returns ​

number

Set Signature ​

ts
set effectivePaddingRight(v: number): void;

Defined in: ui/core/view-base/index.ts

Parameters ​
ParameterType
vnumber
Returns ​

void

Inherited from ​

ts
LiquidGlassCommon.effectivePaddingRight

effectivePaddingTop ​

Get Signature ​

ts
get effectivePaddingTop(): number;

Defined in: ui/core/view-base/index.ts

Returns ​

number

Set Signature ​

ts
set effectivePaddingTop(v: number): void;

Defined in: ui/core/view-base/index.ts

Parameters ​
ParameterType
vnumber
Returns ​

void

Inherited from ​

ts
LiquidGlassCommon.effectivePaddingTop

isLoaded ​

Get Signature ​

ts
get isLoaded(): boolean;

Defined in: ui/core/view-base/index.ts

Returns ​

boolean

Inherited from ​

ts
LiquidGlassCommon.isLoaded

nativeView ​

Get Signature ​

ts
get nativeView(): any;

Defined in: ui/core/view-base/index.ts

Returns ​

any

Set Signature ​

ts
set nativeView(value: any): void;

Defined in: ui/core/view-base/index.ts

Parameters ​
ParameterType
valueany
Returns ​

void

Inherited from ​

ts
LiquidGlassCommon.nativeView

page ​

Get Signature ​

ts
get page(): Page;

Defined in: ui/core/view-base/index.ts

Gets owner page. This is a read-only property.

Returns ​

Page

Inherited from ​

ts
LiquidGlassCommon.page

parentNode ​

Get Signature ​

ts
get parentNode(): ViewBase;

Defined in: ui/core/view-base/index.ts

Gets the template parent or the native parent. Sets the template parent.

Returns ​

ViewBase

Set Signature ​

ts
set parentNode(node: ViewBase): void;

Defined in: ui/core/view-base/index.ts

Parameters ​
ParameterType
nodeViewBase
Returns ​

void

Inherited from ​

ts
LiquidGlassCommon.parentNode

style ​

Get Signature ​

ts
get style(): Style;

Defined in: ui/core/view-base/index.ts

Gets the style object associated to this view.

Returns ​

Style

Set Signature ​

ts
set style(inlineStyle: Style): void;

Defined in: ui/core/view-base/index.ts

Ns Property ​
Parameters ​
ParameterType
inlineStyleStyle
Returns ​

void

Inherited from ​

ts
LiquidGlassCommon.style

textTransform ​

Get Signature ​

ts
get textTransform(): TextTransformType;

Defined in: ui/core/view/view-common.ts

Returns ​

TextTransformType

Set Signature ​

ts
set textTransform(value: TextTransformType): void;

Defined in: ui/core/view/view-common.ts

Parameters ​
ParameterType
valueTextTransformType
Returns ​

void

Inherited from ​

ts
LiquidGlassCommon.textTransform

typeName ​

Get Signature ​

ts
get typeName(): string;

Defined in: ui/core/view-base/index.ts

Gets the name of the constructor function for this instance. E.g. for a Button class this will return "Button".

Returns ​

string

Inherited from ​

ts
LiquidGlassCommon.typeName

visualState ​

Get Signature ​

ts
get visualState(): string;

Defined in: ui/core/view-base/index.ts

Deprecated ​
Returns ​

string

Inherited from ​

ts
LiquidGlassCommon.visualState

Methods ​

_addView() ​

ts
_addView(view: ViewBase, atIndex?: number): void;

Defined in: ui/core/view-base/index.ts

Parameters ​

ParameterType
viewViewBase
atIndex?number

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon._addView

_addViewCore() ​

ts
_addViewCore(view: ViewBase, atIndex?: number): void;

Defined in: ui/core/view-base/index.ts

Method is intended to be overridden by inheritors and used as "protected"

Parameters ​

ParameterType
viewViewBase
atIndex?number

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon._addViewCore

_addViewToNativeVisualTree() ​

ts
_addViewToNativeVisualTree(view: ViewBase, atIndex?: number): boolean;

Defined in: ui/core/view-base/index.ts

Performs the core logic of adding a child view to the native visual tree. Returns true if the view's native representation has been successfully added, false otherwise. Method is intended to be overridden by inheritors and used as "protected".

Parameters ​

ParameterType
viewViewBase
atIndex?number

Returns ​

boolean

Inherited from ​

ts
LiquidGlassCommon._addViewToNativeVisualTree

_applyGlassEffect() ​

ts
protected _applyGlassEffect(value: GlassEffectType, options: {
  effectType: "glass" | "container";
  onCreate?: (effectView: UIVisualEffectView, effect: UIVisualEffect) => void;
  onUpdate?: (effectView: UIVisualEffectView, effect: UIVisualEffect, duration: number) => void;
  targetView?: UIVisualEffectView;
  toGlassStyleFn?: (variant?: GlassEffectVariant) => number;
}): any;

Defined in: ui/core/view/view-common.ts

Shared helper method for applying glass effects to views. This method can be used by View and its subclasses (LiquidGlass, LiquidGlassContainer, etc.) iOS only at the moment but could be applied to others once supported in other platforms.

Parameters ​

ParameterTypeDescription
valueGlassEffectTypeThe glass effect configuration
options{ effectType: "glass" | "container"; onCreate?: (effectView: UIVisualEffectView, effect: UIVisualEffect) => void; onUpdate?: (effectView: UIVisualEffectView, effect: UIVisualEffect, duration: number) => void; targetView?: UIVisualEffectView; toGlassStyleFn?: (variant?: GlassEffectVariant) => number; }Configuration options for different glass effect behaviors
options.effectType"glass" | "container"Type of effect to create: 'glass'
options.onCreate?(effectView: UIVisualEffectView, effect: UIVisualEffect) => voidCallback when a new effect view is created (for initial setup)
options.onUpdate?(effectView: UIVisualEffectView, effect: UIVisualEffect, duration: number) => voidCallback when an existing effect view is updated
options.targetView?UIVisualEffectViewThe UIVisualEffectView to apply the effect to (if updating existing view)
options.toGlassStyleFn?(variant?: GlassEffectVariant) => numberCustom function to convert variant to UIGlassEffectStyle

Returns ​

any

Inherited from ​

ts
LiquidGlassCommon._applyGlassEffect

_applyXmlAttribute() ​

ts
_applyXmlAttribute(attribute: string, value: string): boolean;

Defined in: ui/core/view-base/index.ts

Parameters ​

ParameterType
attributestring
valuestring

Returns ​

boolean

Deprecated ​

This used to be the way to set attribute values in early {N} versions. Now attributes are expected to be set as plain properties on the view instances.

Inherited from ​

ts
LiquidGlassCommon._applyXmlAttribute

_batchUpdate() ​

ts
_batchUpdate<T>(callback: () => T): T;

Defined in: ui/core/view-base/index.ts

Allow multiple updates to be performed on the instance at once.

Type Parameters ​

Type Parameter
T

Parameters ​

ParameterType
callback() => T

Returns ​

T

Inherited from ​

ts
LiquidGlassCommon._batchUpdate

_childIndexToNativeChildIndex() ​

ts
_childIndexToNativeChildIndex(index?: number): number;

Defined in: ui/core/view-base/index.ts

Parameters ​

ParameterType
index?number

Returns ​

number

Inherited from ​

ts
LiquidGlassCommon._childIndexToNativeChildIndex

_closeAllModalViewsInternal() ​

ts
_closeAllModalViewsInternal(): boolean;

Defined in: ui/core/view/index.d.ts:924

Internal method: Closes all modal views. Should be used by plugins like nativescript-angular which implement their own modal views service.

Returns ​

boolean

Inherited from ​

ts
LiquidGlassCommon._closeAllModalViewsInternal

_createPropertyChangeData() ​

ts
_createPropertyChangeData(
   propertyName: string, 
   value: any, 
   oldValue?: any): PropertyChangeData;

Defined in: data/observable/index.ts

This method is intended to be overriden by inheritors to provide additional implementation.

Parameters ​

ParameterType
propertyNamestring
valueany
oldValue?any

Returns ​

PropertyChangeData

Inherited from ​

ts
LiquidGlassCommon._createPropertyChangeData

_dialogClosed() ​

ts
_dialogClosed(): void;

Defined in: ui/core/view-base/index.ts

Method is intended to be overridden by inheritors and used as "protected"

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon._dialogClosed

_eachLayoutView() ​

ts
_eachLayoutView(callback: (View: any) => void): void;

Defined in: ui/core/view/index.d.ts:932

Parameters ​

ParameterType
callback(View: any) => void

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon._eachLayoutView

_emit() ​

ts
_emit(eventName: string): void;

Defined in: data/observable/index.ts

Parameters ​

ParameterType
eventNamestring

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon._emit

_getNativeViewsCount() ​

ts
_getNativeViewsCount(): number;

Defined in: ui/core/view/index.d.ts:918

Returns ​

number

Inherited from ​

ts
LiquidGlassCommon._getNativeViewsCount

_getRootModalViews() ​

ts
_getRootModalViews(): ViewBase[];

Defined in: ui/core/view/index.d.ts:930

Internal method: Gets all modal views of the current view.

Returns ​

ViewBase[]

Inherited from ​

ts
LiquidGlassCommon._getRootModalViews

_getValue() ​

ts
_getValue(property: any): never;

Defined in: ui/core/view/index.d.ts:1113

Obsolete: There is a new property system that does not rely on _getValue.

Parameters ​

ParameterType
propertyany

Returns ​

never

Inherited from ​

ts
LiquidGlassCommon._getValue

_handleLivesync() ​

ts
_handleLivesync(context?: {
  path: string;
  type: string;
}): boolean;

Defined in: ui/core/view/index.d.ts:1084

Parameters ​

ParameterType
context?{ path: string; type: string; }
context.path?string
context.type?string

Returns ​

boolean

Inherited from ​

ts
LiquidGlassCommon._handleLivesync

_hasAncestorView() ​

ts
_hasAncestorView(ancestorView: View): boolean;

Defined in: ui/core/view/index.d.ts:1107

Checks whether the current view has specific view for an ancestor.

Parameters ​

ParameterType
ancestorViewView

Returns ​

boolean

Inherited from ​

ts
LiquidGlassCommon._hasAncestorView

_hideNativeModalView() ​

ts
protected _hideNativeModalView(parent: ViewCommon, whenClosedCallback: () => void): void;

Defined in: ui/core/view/view-common.ts

Parameters ​

ParameterType
parentViewCommon
whenClosedCallback() => void

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon._hideNativeModalView

_inheritStyles() ​

ts
_inheritStyles(view: ViewBase): void;

Defined in: ui/core/view-base/index.ts

Parameters ​

ParameterType
viewViewBase

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon._inheritStyles

_inheritStyleScope() ​

ts
_inheritStyleScope(styleScope: StyleScope): void;

Defined in: ui/core/view-base/index.ts

Parameters ​

ParameterType
styleScopeStyleScope

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon._inheritStyleScope

_layoutParent() ​

ts
_layoutParent(): void;

Defined in: ui/core/view-base/index.ts

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon._layoutParent

_observe() ​

ts
protected _observe(
   type: GestureTypes, 
   callback: (args: GestureEventData) => void, 
   thisArg?: any): void;

Defined in: ui/core/view/view-common.ts

Parameters ​

ParameterType
typeGestureTypes
callback(args: GestureEventData) => void
thisArg?any

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon._observe

_onAttachedToWindow() ​

ts
_onAttachedToWindow(): void;

Defined in: ui/core/view/index.d.ts:1097

Called in android when native view is attached to window.

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon._onAttachedToWindow

_onDetachedFromWindow() ​

ts
_onDetachedFromWindow(): void;

Defined in: ui/core/view/index.d.ts:1102

Called in android when native view is dettached from window.

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon._onDetachedFromWindow

_onRootViewReset() ​

ts
_onRootViewReset(): void;

Defined in: ui/core/view-base/index.ts

Method is intended to be overridden by inheritors and used as "protected"

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon._onRootViewReset

_onSizeChanged()? ​

ts
optional _onSizeChanged(): void;

Defined in: ui/core/view/index.d.ts:937

iOS Only Internal method used to update various view details like background rerendering, border, etc.

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon._onSizeChanged

_parentChanged() ​

ts
_parentChanged(oldParent: ViewBase): void;

Defined in: ui/core/view-base/index.ts

Parameters ​

ParameterType
oldParentViewBase

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon._parentChanged

_raiseLayoutChangedEvent() ​

ts
protected _raiseLayoutChangedEvent(): void;

Defined in: ui/core/view/view-common.ts

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon._raiseLayoutChangedEvent

_raiseShowingModallyEvent() ​

ts
protected _raiseShowingModallyEvent(): void;

Defined in: ui/core/view/view-common.ts

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon._raiseShowingModallyEvent

_raiseShownModallyEvent() ​

ts
protected _raiseShownModallyEvent(): void;

Defined in: ui/core/view/view-common.ts

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon._raiseShownModallyEvent

_registerLayoutChild() ​

ts
_registerLayoutChild(child: View): void;

Defined in: ui/layouts/layout-base.d.ts:53

INTERNAL. Used by the layout system.

Parameters ​

ParameterType
childView

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon._registerLayoutChild

_removeView() ​

ts
_removeView(view: ViewBase): void;

Defined in: ui/core/view-base/index.ts

Core logic for removing a child view from this instance. Used by the framework to handle lifecycle events more centralized. Do not use outside the UI Stack implementation.

Parameters ​

ParameterType
viewViewBase

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon._removeView

_removeViewCore() ​

ts
_removeViewCore(view: ViewBase): void;

Defined in: ui/core/view-base/index.ts

Method is intended to be overridden by inheritors and used as "protected"

Parameters ​

ParameterType
viewViewBase

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon._removeViewCore

_removeViewFromNativeVisualTree() ​

ts
_removeViewFromNativeVisualTree(view: ViewBase): void;

Defined in: ui/core/view-base/index.ts

Method is intended to be overridden by inheritors and used as "protected"

Parameters ​

ParameterType
viewViewBase

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon._removeViewFromNativeVisualTree

_resumeNativeUpdates() ​

ts
_resumeNativeUpdates(type: SuspendType): void;

Defined in: ui/core/view-base/index.ts

Parameters ​

ParameterType
typeSuspendType

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon._resumeNativeUpdates

_setDefaultPaddings() ​

ts
_setDefaultPaddings(insets: any): void;

Defined in: ui/core/view-base/index.ts

Parameters ​

ParameterType
insetsany

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon._setDefaultPaddings

_setupAsRootView() ​

ts
_setupAsRootView(context: any): void;

Defined in: ui/core/view/view-common.ts

Parameters ​

ParameterType
contextany

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon._setupAsRootView

_setupUI() ​

ts
_setupUI(
   context: any, 
   atIndex?: number, 
   parentIsLoaded?: boolean): void;

Defined in: ui/core/view-base/index.ts

Setups the UI for ViewBase and all its children recursively. This method should not be overridden by derived views.

Parameters ​

ParameterType
contextany
atIndex?number
parentIsLoaded?boolean

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon._setupUI

_setValue() ​

ts
_setValue(property: any, value: any): never;

Defined in: ui/core/view/index.d.ts:1118

Obsolete: There is a new property system that does not rely on _setValue.

Parameters ​

ParameterType
propertyany
valueany

Returns ​

never

Inherited from ​

ts
LiquidGlassCommon._setValue

_shouldDelayLayout() ​

ts
_shouldDelayLayout(): boolean;

Defined in: ui/core/view-base/index.ts

When returning true the callLoaded method will be run in setTimeout Method is intended to be overridden by inheritors and used as "protected"

Returns ​

boolean

Inherited from ​

ts
LiquidGlassCommon._shouldDelayLayout

_showNativeModalView() ​

ts
protected _showNativeModalView(parent: ViewCommon, options: ShowModalOptions): void;

Defined in: ui/core/view/view-common.ts

Parameters ​

ParameterType
parentViewCommon
optionsShowModalOptions

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon._showNativeModalView

_suspendNativeUpdates() ​

ts
_suspendNativeUpdates(type: SuspendType): void;

Defined in: ui/core/view-base/index.ts

Parameters ​

ParameterType
typeSuspendType

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon._suspendNativeUpdates

_tearDownUI() ​

ts
_tearDownUI(force?: boolean): void;

Defined in: ui/core/view-base/index.ts

Tears down the UI for ViewBase and all its children recursively. This method should not be overridden by derived views.

Parameters ​

ParameterType
force?boolean

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon._tearDownUI

_unregisterLayoutChild() ​

ts
_unregisterLayoutChild(child: View): void;

Defined in: ui/layouts/layout-base.d.ts:58

INTERNAL. Used by the layout system.

Parameters ​

ParameterType
childView

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon._unregisterLayoutChild

_updateStyleScope() ​

ts
_updateStyleScope(
   cssFileName?: string, 
   cssString?: string, 
   css?: string): void;

Defined in: ui/core/view/index.d.ts:1092

Updates styleScope or create new styleScope.

Parameters ​

ParameterTypeDescription
cssFileName?string-
cssString?string-
css?string-

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon._updateStyleScope

accessibilityAnnouncement() ​

ts
accessibilityAnnouncement(msg?: string): void;

Defined in: ui/core/view/index.d.ts:972

Make an announcement to the screen reader.

Parameters ​

ParameterType
msg?string

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon.accessibilityAnnouncement

accessibilityScreenChanged() ​

ts
accessibilityScreenChanged(): void;

Defined in: ui/core/view/index.d.ts:977

Announce screen changed

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon.accessibilityScreenChanged

addChild() ​

ts
addChild(view: View): void;

Defined in: ui/layouts/layout-base.d.ts:30

Adds the view to children array.

Parameters ​

ParameterTypeDescription
viewViewThe view to be added to the end of the children array.

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon.addChild

addChildAtCell() ​

ts
addChildAtCell(
   view: View, 
   row: number, 
   column: number, 
   rowSpan?: number, 
   columnSpan?: number): void;

Defined in: ui/layouts/grid-layout/index.d.ts:122

Adds a child at specific cell in GridLayout. Optional rowSpan and columnSpan attributes

Parameters ​

ParameterType
viewView
rownumber
columnnumber
rowSpan?number
columnSpan?number

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon.addChildAtCell

addColumn() ​

ts
addColumn(itemSpec: ItemSpec): void;

Defined in: ui/layouts/grid-layout/index.d.ts:112

Adds a column specification to a GridLayout.

Parameters ​

ParameterType
itemSpecItemSpec

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon.addColumn

addEventListener() ​

ts
addEventListener(
   eventNames: string, 
   callback: (data: EventData) => void, 
   thisArg?: any, 
   once?: boolean): void;

Defined in: ui/core/view/view-common.ts

Adds a listener for the specified event name.

Parameters ​

ParameterTypeDescription
eventNamesstring-
callback(data: EventData) => voidA function to be called when some of the specified event(s) is raised.
thisArg?anyAn optional parameter which when set will be used as "this" in callback method call.
once?booleanAn optional parameter which when set will cause the event listener to fire once.

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon.addEventListener

addPseudoClass() ​

ts
protected addPseudoClass(name: string): void;

Defined in: ui/core/view-base/index.ts

Parameters ​

ParameterType
namestring

Returns ​

void

Unstable ​

A widget can call this method to add a matching css pseudo class.

Inherited from ​

ts
LiquidGlassCommon.addPseudoClass

addRow() ​

ts
addRow(itemSpec: ItemSpec): void;

Defined in: ui/layouts/grid-layout/index.d.ts:117

Adds a row specification to a GridLayout.

Parameters ​

ParameterType
itemSpecItemSpec

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon.addRow

animate() ​

ts
animate(options: AnimationDefinition): AnimationPromise;

Defined in: ui/core/view/index.d.ts:853

Animates one or more properties of the view based on the supplied options.

Parameters ​

ParameterType
optionsAnimationDefinition

Returns ​

AnimationPromise

Inherited from ​

ts
LiquidGlassCommon.animate

bind() ​

ts
bind(options: BindingOptions, source?: Object): void;

Defined in: ui/core/view-base/index.ts

Parameters ​

ParameterType
optionsBindingOptions
source?Object

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon.bind

callLoaded() ​

ts
callLoaded(): void;

Defined in: ui/core/view-base/index.ts

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon.callLoaded

callUnloaded() ​

ts
callUnloaded(): void;

Defined in: ui/core/view-base/index.ts

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon.callUnloaded

closeModal() ​

ts
closeModal(...args: any[]): void;

Defined in: ui/core/view/view-common.ts

Closes the current modal view that this page is showing.

Parameters ​

ParameterType
...argsany[]

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon.closeModal

createAnimation() ​

ts
createAnimation(options: AnimationDefinition): Animation;

Defined in: ui/core/view/index.d.ts:858

Creates an Animation object based on the supplied options.

Parameters ​

ParameterType
optionsAnimationDefinition

Returns ​

Animation

Inherited from ​

ts
LiquidGlassCommon.createAnimation

createNativeView() ​

ts
createNativeView(): Object;

Defined in: ui/core/view-base/index.ts

Creates a native view. Returns either android.view.View or UIView.

Returns ​

Object

Inherited from ​

ts
LiquidGlassCommon.createNativeView

deletePseudoClass() ​

ts
protected deletePseudoClass(name: string): void;

Defined in: ui/core/view-base/index.ts

Parameters ​

ParameterType
namestring

Returns ​

void

Unstable ​

A widget can call this method to discard matching css pseudo class.

Inherited from ​

ts
LiquidGlassCommon.deletePseudoClass

destroyNode() ​

ts
destroyNode(forceDestroyChildren?: boolean): void;

Defined in: ui/core/view-base/index.ts

Tears down the UI of a reusable node by making it no longer reusable.

Parameters ​

ParameterTypeDescription
forceDestroyChildren?booleanForce destroy the children (even if they are reusable)

Returns ​

void

See ​

_tearDownUI

Inherited from ​

ts
LiquidGlassCommon.destroyNode

disposeNativeView() ​

ts
disposeNativeView(): void;

Defined in: ui/core/view-base/index.ts

Clean up references to the native view.

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon.disposeNativeView

eachChild() ​

ts
eachChild(callback: (child: ViewBase) => boolean): void;

Defined in: ui/core/view/view-common.ts

Iterates over children of type ViewBase.

Parameters ​

ParameterTypeDescription
callback(child: ViewBase) => booleanCalled for each child of type ViewBase. Iteration stops if this method returns falsy value.

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon.eachChild

eachChildView() ​

ts
eachChildView(callback: (view: View) => boolean): void;

Defined in: ui/core/view/index.d.ts:953

Iterates over children of type View.

Parameters ​

ParameterTypeDescription
callback(view: View) => booleanCalled for each child of type View. Iteration stops if this method returns falsy value.

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon.eachChildView

eachLayoutChild() ​

ts
eachLayoutChild(callback: (child: View, isLast: boolean) => void): void;

Defined in: ui/layouts/layout-base.d.ts:64

Calls the callback for each child that should be laid out.

Parameters ​

ParameterTypeDescription
callback(child: View, isLast: boolean) => voidThe callback

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon.eachLayoutChild

ensureDomNode() ​

ts
ensureDomNode(): void;

Defined in: ui/core/view-base/index.ts

Returns ​

void

Unstable ​

Ensures a dom-node for this view.

Inherited from ​

ts
LiquidGlassCommon.ensureDomNode

focus() ​

ts
focus(): boolean;

Defined in: ui/core/view/index.d.ts:787

Tries to focus the view. Returns a value indicating whether this view or one of its descendants actually took focus.

Returns ​

boolean

Inherited from ​

ts
LiquidGlassCommon.focus

get() ​

ts
get(name: string): any;

Defined in: data/observable/index.ts

Gets the value of the specified property.

Parameters ​

ParameterType
namestring

Returns ​

any

Inherited from ​

ts
LiquidGlassCommon.get

getActualSize() ​

ts
getActualSize(): Size;

Defined in: ui/core/view/index.d.ts:883

Returns the actual size of the view in device-independent pixels.

Returns ​

Size

Inherited from ​

ts
LiquidGlassCommon.getActualSize

getChildAt() ​

ts
getChildAt(index: number): View;

Defined in: ui/layouts/layout-base.d.ts:18

Returns the view at the specified position.

Parameters ​

ParameterTypeDescription
indexnumberThe position at which to get the child from.

Returns ​

View

Inherited from ​

ts
LiquidGlassCommon.getChildAt

getChildIndex() ​

ts
getChildIndex(child: View): number;

Defined in: ui/layouts/layout-base.d.ts:24

Returns the position of the child view

Parameters ​

ParameterTypeDescription
childViewThe child view that we are looking for.

Returns ​

number

Inherited from ​

ts
LiquidGlassCommon.getChildIndex

getChildrenCount() ​

ts
getChildrenCount(): number;

Defined in: ui/layouts/layout-base.d.ts:12

Returns the number of children in this Layout.

Returns ​

number

Inherited from ​

ts
LiquidGlassCommon.getChildrenCount

getClosestWindow() ​

ts
getClosestWindow(): Window;

Defined in: ui/core/view/view-common.ts

(Android only) Gets closest window parent considering modals.

Returns ​

Window

Inherited from ​

ts
LiquidGlassCommon.getClosestWindow

getColumns() ​

ts
getColumns(): ItemSpec[];

Defined in: ui/layouts/grid-layout/index.d.ts:147

Gets array of column specifications defined on this instance of GridLayout.

Returns ​

ItemSpec[]

Inherited from ​

ts
LiquidGlassCommon.getColumns

getEffectivePaddingShorthand() ​

ts
getEffectivePaddingShorthand(): string;

Defined in: ui/core/view-base/index.ts

Returns ​

string

Inherited from ​

ts
LiquidGlassCommon.getEffectivePaddingShorthand

getGestureObservers() ​

ts
getGestureObservers(type: GestureTypes): GesturesObserver[];

Defined in: ui/core/view/index.d.ts:789

Parameters ​

ParameterType
typeGestureTypes

Returns ​

GesturesObserver[]

Inherited from ​

ts
LiquidGlassCommon.getGestureObservers

getLocationInWindow() ​

ts
getLocationInWindow(): Point;

Defined in: ui/core/view/index.d.ts:868

Returns the location of this view in the window coordinate system.

Returns ​

Point

Inherited from ​

ts
LiquidGlassCommon.getLocationInWindow

getLocationOnScreen() ​

ts
getLocationOnScreen(): Point;

Defined in: ui/core/view/index.d.ts:873

Returns the location of this view in the screen coordinate system.

Returns ​

Point

Inherited from ​

ts
LiquidGlassCommon.getLocationOnScreen

getLocationRelativeTo() ​

ts
getLocationRelativeTo(otherView: View): Point;

Defined in: ui/core/view/index.d.ts:878

Returns the location of this view in the otherView's coordinate system.

Parameters ​

ParameterType
otherViewView

Returns ​

Point

Inherited from ​

ts
LiquidGlassCommon.getLocationRelativeTo

getMeasuredHeight() ​

ts
getMeasuredHeight(): number;

Defined in: ui/core/view/index.d.ts:715

Returns the raw height component.

Returns ​

number

Inherited from ​

ts
LiquidGlassCommon.getMeasuredHeight

getMeasuredState() ​

ts
getMeasuredState(): number;

Defined in: ui/core/view/index.d.ts:717

Returns ​

number

Inherited from ​

ts
LiquidGlassCommon.getMeasuredState

getMeasuredWidth() ​

ts
getMeasuredWidth(): number;

Defined in: ui/core/view/index.d.ts:710

Returns the raw width component.

Returns ​

number

Inherited from ​

ts
LiquidGlassCommon.getMeasuredWidth

getRows() ​

ts
getRows(): ItemSpec[];

Defined in: ui/layouts/grid-layout/index.d.ts:152

Gets array of row specifications defined on this instance of GridLayout.

Returns ​

ItemSpec[]

Inherited from ​

ts
LiquidGlassCommon.getRows

getSafeAreaInsets() ​

ts
getSafeAreaInsets(): Position;

Defined in: ui/core/view/index.d.ts:863

Returns the iOS safe area insets of this view.

Returns ​

Position

Inherited from ​

ts
LiquidGlassCommon.getSafeAreaInsets

getViewByDomId() ​

ts
getViewByDomId<T>(domId: number): T;

Defined in: ui/core/view-base/index.ts

Returns the child view with the specified domId.

Type Parameters ​

Type Parameter
T extends ViewBase

Parameters ​

ParameterType
domIdnumber

Returns ​

T

Inherited from ​

ts
LiquidGlassCommon.getViewByDomId

getViewById() ​

ts
getViewById<T>(id: string): T;

Defined in: ui/core/view-base/index.ts

Returns the child view with the specified id.

Type Parameters ​

Type Parameter
T extends ViewBase

Parameters ​

ParameterType
idstring

Returns ​

T

Inherited from ​

ts
LiquidGlassCommon.getViewById

hasGestureObservers()? ​

ts
optional hasGestureObservers(): boolean;

Defined in: ui/core/view/index.d.ts:942

Android only check if gesture observers are attached

Returns ​

boolean

Inherited from ​

ts
LiquidGlassCommon.hasGestureObservers

hasListeners() ​

ts
hasListeners(eventName: string): boolean;

Defined in: data/observable/index.ts

Checks whether a listener is registered for the specified event name.

Parameters ​

ParameterTypeDescription
eventNamestringThe name of the event to check for.

Returns ​

boolean

Inherited from ​

ts
LiquidGlassCommon.hasListeners

initNativeView() ​

ts
initNativeView(): void;

Defined in: ui/core/view-base/index.ts

Initializes properties/listeners of the native view.

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon.initNativeView

insertChild() ​

ts
insertChild(child: View, atIndex: number): boolean;

Defined in: ui/layouts/layout-base.d.ts:37

Inserts the view to children array at the specified index.

Parameters ​

ParameterTypeDescription
childView-
atIndexnumberThe insertion index.

Returns ​

boolean

Inherited from ​

ts
LiquidGlassCommon.insertChild

layout() ​

ts
layout(
   left: number, 
   top: number, 
   right: number, 
   bottom: number, 
   setFrame?: boolean): void;

Defined in: ui/core/view/index.d.ts:705

Assign a size and position to a view and all of its descendants This is the second phase of the layout mechanism. (The first is measuring). In this phase, each parent calls layout on all of its children to position them. This is typically done using the child measurements that were stored in the measure pass(). Derived classes should not override this method. Derived classes with children should override onLayout. In that method, they should call layout on each of their children.

Parameters ​

ParameterType
leftnumber
topnumber
rightnumber
bottomnumber
setFrame?boolean

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon.layout

layoutNativeView() ​

ts
layoutNativeView(
   left: number, 
   top: number, 
   right: number, 
   bottom: number): void;

Defined in: ui/core/view/index.d.ts:750

Called from onLayout when native view position is about to be changed.

Parameters ​

ParameterTypeDescription
leftnumberLeft position, relative to parent
topnumberTop position, relative to parent
rightnumberRight position, relative to parent
bottomnumberBottom position, relative to parent

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon.layoutNativeView

loadView() ​

ts
loadView(view: ViewBase): void;

Defined in: ui/core/view-base/index.ts

Load view.

Parameters ​

ParameterTypeDescription
viewViewBaseto load.

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon.loadView

measure() ​

ts
measure(widthMeasureSpec: number, heightMeasureSpec: number): void;

Defined in: ui/core/view/index.d.ts:694

This is called to find out how big a view should be. The parent supplies constraint information in the width and height parameters. The actual measurement work of a view is performed in onMeasure(int, int), called by this method. Therefore, only onMeasure(int, int) can and must be overridden by subclasses.

Parameters ​

ParameterTypeDescription
widthMeasureSpecnumberHorizontal space requirements as imposed by the parent
heightMeasureSpecnumberVertical space requirements as imposed by the parent

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon.measure

notify() ​

ts
notify<T>(data: T): void;

Defined in: data/observable/index.ts

Notify this Observable instance with some data. This causes all event handlers on the Observable instance to be called, as well as any 'global' event handlers set on the instance's class.

Type Parameters ​

Type Parameter
T extends Optional<EventData, "object">

Parameters ​

ParameterTypeDescription
dataTan object that satisfies the EventData interface, though with an optional 'object' property. If left undefined, the 'object' property will implicitly be set as this Observable instance.

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon.notify

notifyPropertyChange() ​

ts
notifyPropertyChange(
   name: string, 
   value: any, 
   oldValue?: any): void;

Defined in: data/observable/index.ts

Notifies all the registered listeners for the property change event.

Parameters ​

ParameterType
namestring
valueany
oldValue?any

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon.notifyPropertyChange

off() ​

ts
off(
   eventName: string, 
   callback?: (args: EventData) => void, 
   thisArg?: any): any;

Defined in: ui/core/view/index.d.ts:800

Removes the listener(s) for the specified event name.

Parameters ​

ParameterTypeDescription
eventNamestringThe name of the event.
callback?(args: EventData) => voidAn optional specific event listener to remove (if omitted, all event listeners by this name will be removed).
thisArg?anyAn optional parameter which, when set, will be used to refine search of the correct event listener to be removed.

Returns ​

any

Inherited from ​

ts
LiquidGlassCommon.off

on() ​

Call Signature ​

ts
on(
   eventName: string, 
   callback: (args: EventData) => void, 
   thisArg?: any): any;

Defined in: ui/core/view/index.d.ts:812

Adds a listener for the specified event name.

Parameters ​
ParameterTypeDescription
eventNamestringThe name of the event.
callback(args: EventData) => voidThe event listener to add. Will be called when an event of the given name is raised.
thisArg?anyAn optional parameter which, when set, will be bound as the this context when the callback is called. Falsy values will be not be bound.
Returns ​

any

Inherited from ​
ts
LiquidGlassCommon.on

Call Signature ​

ts
on(
   event: "loaded", 
   callback: (args: EventData) => void, 
   thisArg?: any): any;

Defined in: ui/core/view/index.d.ts:817

Raised when a loaded event occurs.

Parameters ​
ParameterType
event"loaded"
callback(args: EventData) => void
thisArg?any
Returns ​

any

Inherited from ​
ts
LiquidGlassCommon.on

Call Signature ​

ts
on(
   event: "unloaded", 
   callback: (args: EventData) => void, 
   thisArg?: any): any;

Defined in: ui/core/view/index.d.ts:822

Raised when an unloaded event occurs.

Parameters ​
ParameterType
event"unloaded"
callback(args: EventData) => void
thisArg?any
Returns ​

any

Inherited from ​
ts
LiquidGlassCommon.on

Call Signature ​

ts
on(
   event: "androidBackPressed", 
   callback: (args: EventData) => void, 
   thisArg?: any): any;

Defined in: ui/core/view/index.d.ts:828

Raised when a back button is pressed. This event is raised only for android.

Parameters ​
ParameterType
event"androidBackPressed"
callback(args: EventData) => void
thisArg?any
Returns ​

any

Inherited from ​
ts
LiquidGlassCommon.on

Call Signature ​

ts
on(
   event: "showingModally", 
   callback: (args: ShownModallyData) => void, 
   thisArg?: any): void;

Defined in: ui/core/view/index.d.ts:833

Raised before the view is shown as a modal dialog.

Parameters ​
ParameterType
event"showingModally"
callback(args: ShownModallyData) => void
thisArg?any
Returns ​

void

Inherited from ​
ts
LiquidGlassCommon.on

Call Signature ​

ts
on(
   event: "shownModally", 
   callback: (args: ShownModallyData) => void, 
   thisArg?: any): any;

Defined in: ui/core/view/index.d.ts:838

Raised after the view is shown as a modal dialog.

Parameters ​
ParameterType
event"shownModally"
callback(args: ShownModallyData) => void
thisArg?any
Returns ​

any

Inherited from ​
ts
LiquidGlassCommon.on

Call Signature ​

ts
on(
   event: "androidOverflowInset", 
   callback: (args: ShownModallyData) => void, 
   thisArg?: any): any;

Defined in: ui/core/view/index.d.ts:843

Raised after the view is shown as a modal dialog.

Parameters ​
ParameterType
event"androidOverflowInset"
callback(args: ShownModallyData) => void
thisArg?any
Returns ​

any

Inherited from ​
ts
LiquidGlassCommon.on

onBackPressed() ​

ts
onBackPressed(): boolean;

Defined in: ui/core/view/index.d.ts:888

Derived classes can override this method to handle Android back button press.

Returns ​

boolean

Inherited from ​

ts
LiquidGlassCommon.onBackPressed

once() ​

ts
once(
   eventName: string, 
   callback: (data: EventData) => void, 
   thisArg?: any): void;

Defined in: data/observable/index.ts

Adds a listener for the specified event name, which, once fired, will remove itself.

Parameters ​

ParameterTypeDescription
eventNamestringThe name of the event.
callback(data: EventData) => voidThe event listener to add. Will be called when an event of the given name is raised.
thisArg?anyAn optional parameter which, when set, will be bound as the this context when the callback is called. Falsy values will be not be bound.

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon.once

onLayout() ​

ts
onLayout(
   left: number, 
   top: number, 
   right: number, 
   bottom: number): void;

Defined in: ui/core/view/index.d.ts:734

Called from layout when this view should assign a size and position to each of its children. Derived classes with children should override this method and call layout on each of their children.

Parameters ​

ParameterTypeDescription
leftnumberLeft position, relative to parent
topnumberTop position, relative to parent
rightnumberRight position, relative to parent
bottomnumberBottom position, relative to parent

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon.onLayout

onLoaded() ​

ts
onLoaded(): void;

Defined in: ui/core/view/view-common.ts

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon.onLoaded

onMeasure() ​

ts
onMeasure(widthMeasureSpec: number, heightMeasureSpec: number): void;

Defined in: ui/core/view/index.d.ts:725

Measure the view and its content to determine the measured width and the measured height. This method is invoked by measure(int, int) and should be overriden by subclasses to provide accurate and efficient measurement of their contents. When overriding this method, you must call setMeasuredDimension(int, int) to store the measured width and height of this view. Failure to do so will trigger an exception, thrown by measure(int, int).

Parameters ​

ParameterTypeDescription
widthMeasureSpecnumberhorizontal space requirements as imposed by the parent. The requirements are encoded with View.MeasureSpec.
heightMeasureSpecnumbervertical space requirements as imposed by the parent. The requirements are encoded with View.MeasureSpec.

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon.onMeasure

onResumeNativeUpdates() ​

ts
onResumeNativeUpdates(): void;

Defined in: ui/core/view-base/index.ts

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon.onResumeNativeUpdates

onUnloaded() ​

ts
onUnloaded(): void;

Defined in: ui/core/view-base/index.ts

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon.onUnloaded

removeChild() ​

ts
removeChild(view: View): void;

Defined in: ui/layouts/layout-base.d.ts:43

Removes the specified view from the children array.

Parameters ​

ParameterTypeDescription
viewViewThe view to remove from the children array.

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon.removeChild

removeChildren() ​

ts
removeChildren(): void;

Defined in: ui/layouts/layout-base.d.ts:48

Removes all views in this layout.

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon.removeChildren

removeColumn() ​

ts
removeColumn(itemSpec: ItemSpec): void;

Defined in: ui/layouts/grid-layout/index.d.ts:127

Removes a column specification from a GridLayout.

Parameters ​

ParameterType
itemSpecItemSpec

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon.removeColumn

removeColumns() ​

ts
removeColumns(): void;

Defined in: ui/layouts/grid-layout/index.d.ts:132

Removes all column specifications from a GridLayout.

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon.removeColumns

removeEventListener() ​

ts
removeEventListener(
   eventNames: string, 
   callback?: (data: EventData) => void, 
   thisArg?: any): void;

Defined in: ui/core/view/view-common.ts

Removes listener(s) for the specified event name.

Parameters ​

ParameterTypeDescription
eventNamesstring-
callback?(data: EventData) => voidAn optional parameter pointing to a specific listener. If not defined, all listeners for the event names will be removed.
thisArg?anyAn optional parameter which when set will be used to refine search of the correct callback which will be removed as event listener.

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon.removeEventListener

removeRow() ​

ts
removeRow(itemSpec: ItemSpec): void;

Defined in: ui/layouts/grid-layout/index.d.ts:137

Removes a row specification from a GridLayout.

Parameters ​

ParameterType
itemSpecItemSpec

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon.removeRow

removeRows() ​

ts
removeRows(): void;

Defined in: ui/layouts/grid-layout/index.d.ts:142

Removes all row specifications from a GridLayout.

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon.removeRows

requestLayout() ​

ts
requestLayout(): void;

Defined in: ui/core/view-base/index.ts

Invalidates the layout of the view and triggers a new layout pass.

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon.requestLayout

resetNativeView() ​

ts
resetNativeView(): void;

Defined in: ui/core/view/view-common.ts

Resets properties/listeners set to the native view.

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon.resetNativeView

sendAccessibilityEvent() ​

ts
sendAccessibilityEvent(options: AccessibilityEventOptions): void;

Defined in: ui/core/view/index.d.ts:967

Send accessibility event

Parameters ​

ParameterType
optionsAccessibilityEventOptions

Returns ​

void

Params ​

options AccessibilityEventOptions androidAccessibilityEvent: AndroidAccessibilityEvent; iosNotificationType: IOSPostAccessibilityNotificationType; message: string;

iOS Notes: type = 'announcement' will announce args via VoiceOver. If no args element will be announced instead. type = 'layout' used when the layout of a screen changes. type = 'screen' large change made to the screen.

Inherited from ​

ts
LiquidGlassCommon.sendAccessibilityEvent

set() ​

ts
set(name: string, value: any): void;

Defined in: ui/core/view-base/index.ts

Updates the specified property with the provided value.

Parameters ​

ParameterType
namestring
valueany

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon.set

setAccessibilityIdentifier() ​

ts
setAccessibilityIdentifier(view: any, value: string): void;

Defined in: ui/core/view/view-common.ts

Parameters ​

ParameterType
viewany
valuestring

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon.setAccessibilityIdentifier

setInlineStyle() ​

ts
setInlineStyle(style: string): void;

Defined in: ui/core/view-base/index.ts

Parameters ​

ParameterType
stylestring

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon.setInlineStyle

setMeasuredDimension() ​

ts
setMeasuredDimension(measuredWidth: number, measuredHeight: number): void;

Defined in: ui/core/view/index.d.ts:741

This method must be called by onMeasure(int, int) to store the measured width and measured height. Failing to do so will trigger an exception at measurement time.

Parameters ​

ParameterTypeDescription
measuredWidthnumberThe measured width of this view. May be a complex bit mask as defined by MEASURED_SIZE_MASK and MEASURED_STATE_TOO_SMALL.
measuredHeightnumberThe measured height of this view. May be a complex bit mask as defined by MEASURED_SIZE_MASK and MEASURED_STATE_TOO_SMALL.

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon.setMeasuredDimension

setNativeView() ​

ts
setNativeView(value: any): void;

Defined in: ui/core/view-base/index.ts

Set the nativeView field performing extra checks and updates to the native properties on the new view. Use in cases where the createNativeView is not suitable. As an example use in item controls where the native parent view will create the native views for child items.

Parameters ​

ParameterType
valueany

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon.setNativeView

setOnTouchListener()? ​

ts
optional setOnTouchListener(): void;

Defined in: ui/core/view/index.d.ts:947

Android only to set the touch listener

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon.setOnTouchListener

setProperty() ​

ts
setProperty(name: string, value: any): void;

Defined in: data/observable/index.ts

Updates the specified property with the provided value and raises a property change event and a specific change event based on the property name.

Parameters ​

ParameterType
namestring
valueany

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon.setProperty

showModal() ​

ts
showModal(...args: any[]): View;

Defined in: ui/core/view/view-common.ts

Shows the view passed as parameter as a modal view.

Parameters ​

ParameterType
...argsany[]

Returns ​

View

Inherited from ​

ts
LiquidGlassCommon.showModal

toString() ​

ts
toString(): string;

Defined in: ui/core/view-base/index.ts

Returns a string representation of an object.

Returns ​

string

Inherited from ​

ts
LiquidGlassCommon.toString

unbind() ​

ts
unbind(property: string): void;

Defined in: ui/core/view-base/index.ts

Parameters ​

ParameterType
propertystring

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon.unbind

unloadView() ​

ts
unloadView(view: ViewBase): void;

Defined in: ui/core/view-base/index.ts

Unload view.

Parameters ​

ParameterTypeDescription
viewViewBaseto unload.

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon.unloadView

updateStatusBarStyle() ​

ts
updateStatusBarStyle(value: "dark" | "light"): void;

Defined in: ui/core/view/view-common.ts

Parameters ​

ParameterType
value"dark" | "light"

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon.updateStatusBarStyle

addEventListener() ​

ts
static addEventListener(
   eventName: string, 
   callback: (data: EventData) => void, 
   thisArg?: any, 
   once?: boolean): void;

Defined in: data/observable/index.ts

Please avoid using the static event-handling APIs as they will be removed in future.

Parameters ​

ParameterType
eventNamestring
callback(data: EventData) => void
thisArg?any
once?boolean

Returns ​

void

Deprecated ​

Inherited from ​

ts
LiquidGlassCommon.addEventListener

combineMeasuredStates() ​

ts
static combineMeasuredStates(curState: number, newState: any): number;

Defined in: ui/core/view/index.d.ts:781

Parameters ​

ParameterType
curStatenumber
newStateany

Returns ​

number

Inherited from ​

ts
LiquidGlassCommon.combineMeasuredStates

getColumn() ​

ts
static getColumn(view: View): number;

Defined in: ui/layouts/grid-layout/index.d.ts:72

Gets the value of the Column attached property from a given View.

Parameters ​

ParameterType
viewView

Returns ​

number

Inherited from ​

ts
LiquidGlassCommon.getColumn

getColumnSpan() ​

ts
static getColumnSpan(view: View): number;

Defined in: ui/layouts/grid-layout/index.d.ts:82

Gets the value of the ColumnSpan attached property from a given View.

Parameters ​

ParameterType
viewView

Returns ​

number

Inherited from ​

ts
LiquidGlassCommon.getColumnSpan

getRow() ​

ts
static getRow(view: View): number;

Defined in: ui/layouts/grid-layout/index.d.ts:92

Gets the value of the Row attached property from a given View.

Parameters ​

ParameterType
viewView

Returns ​

number

Inherited from ​

ts
LiquidGlassCommon.getRow

getRowSpan() ​

ts
static getRowSpan(view: View): number;

Defined in: ui/layouts/grid-layout/index.d.ts:102

Gets the value of the RowSpan attached property from a given View.

Parameters ​

ParameterType
viewView

Returns ​

number

Inherited from ​

ts
LiquidGlassCommon.getRowSpan

layoutChild() ​

ts
static layoutChild(
   parent: View, 
   child: View, 
   left: number, 
   top: number, 
   right: number, 
   bottom: number): void;

Defined in: ui/core/view/index.d.ts:769

Layout a child by taking into account its margins, horizontal and vertical alignments and a given bounds.

Parameters ​

ParameterTypeDescription
parentViewThis parameter is not used. You can pass null.
childView-
leftnumberLeft position, relative to parent
topnumberTop position, relative to parent
rightnumberRight position, relative to parent
bottomnumberBottom position, relative to parent

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon.layoutChild

measureChild() ​

ts
static measureChild(
   parent: View, 
   child: View, 
   widthMeasureSpec: number, 
   heightMeasureSpec: number): {
  measuredHeight: number;
  measuredWidth: number;
};

Defined in: ui/core/view/index.d.ts:759

Measure a child by taking into account its margins and a given measureSpecs.

Parameters ​

ParameterTypeDescription
parentViewThis parameter is not used. You can pass null.
childViewThe view to be measured.
widthMeasureSpecnumber-
heightMeasureSpecnumber-

Returns ​

ts
{
  measuredHeight: number;
  measuredWidth: number;
}
measuredHeight ​
ts
measuredHeight: number;
measuredWidth ​
ts
measuredWidth: number;

Inherited from ​

ts
LiquidGlassCommon.measureChild

off() ​

ts
static off(
   eventName: string, 
   callback?: (data: EventData) => void, 
   thisArg?: any): void;

Defined in: data/observable/index.ts

Please avoid using the static event-handling APIs as they will be removed in future.

Parameters ​

ParameterType
eventNamestring
callback?(data: EventData) => void
thisArg?any

Returns ​

void

Deprecated ​

Inherited from ​

ts
LiquidGlassCommon.off

on() ​

ts
static on(
   eventName: string, 
   callback: (data: EventData) => void, 
   thisArg?: any, 
   once?: boolean): void;

Defined in: data/observable/index.ts

Please avoid using the static event-handling APIs as they will be removed in future.

Parameters ​

ParameterType
eventNamestring
callback(data: EventData) => void
thisArg?any
once?boolean

Returns ​

void

Deprecated ​

Inherited from ​

ts
LiquidGlassCommon.on

once() ​

ts
static once(
   eventName: string, 
   callback: (data: EventData) => void, 
   thisArg?: any): void;

Defined in: data/observable/index.ts

Please avoid using the static event-handling APIs as they will be removed in future.

Parameters ​

ParameterType
eventNamestring
callback(data: EventData) => void
thisArg?any

Returns ​

void

Deprecated ​

Inherited from ​

ts
LiquidGlassCommon.once

removeEventListener() ​

ts
static removeEventListener(
   eventName: string, 
   callback?: (data: EventData) => void, 
   thisArg?: any): void;

Defined in: data/observable/index.ts

Please avoid using the static event-handling APIs as they will be removed in future.

Parameters ​

ParameterType
eventNamestring
callback?(data: EventData) => void
thisArg?any

Returns ​

void

Deprecated ​

Inherited from ​

ts
LiquidGlassCommon.removeEventListener

resolveSizeAndState() ​

ts
static resolveSizeAndState(
   size: number, 
   specSize: number, 
   specMode: number, 
   childMeasuredState: number): number;

Defined in: ui/core/view/index.d.ts:779

Utility to reconcile a desired size and state, with constraints imposed by a MeasureSpec. Will take the desired size, unless a different size is imposed by the constraints. The returned value is a compound integer, with the resolved size in the MEASURED_SIZE_MASK bits and optionally the bit MEASURED_STATE_TOO_SMALL set if the resulting size is smaller than the size the view wants to be.

Parameters ​

ParameterType
sizenumber
specSizenumber
specModenumber
childMeasuredStatenumber

Returns ​

number

Inherited from ​

ts
LiquidGlassCommon.resolveSizeAndState

setColumn() ​

ts
static setColumn(view: View, value: number): void;

Defined in: ui/layouts/grid-layout/index.d.ts:77

Sets the value of the Column attached property to a given View.

Parameters ​

ParameterType
viewView
valuenumber

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon.setColumn

setColumnSpan() ​

ts
static setColumnSpan(view: View, value: number): void;

Defined in: ui/layouts/grid-layout/index.d.ts:87

Sets the value of the ColumnSpan attached property to a given View.

Parameters ​

ParameterType
viewView
valuenumber

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon.setColumnSpan

setRow() ​

ts
static setRow(view: View, value: number): void;

Defined in: ui/layouts/grid-layout/index.d.ts:97

Sets the value of the Row attached property to a given View.

Parameters ​

ParameterType
viewView
valuenumber

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon.setRow

setRowSpan() ​

ts
static setRowSpan(view: View, value: number): void;

Defined in: ui/layouts/grid-layout/index.d.ts:107

Sets the value of the RowSpan attached property to a given View.

Parameters ​

ParameterType
viewView
valuenumber

Returns ​

void

Inherited from ​

ts
LiquidGlassCommon.setRowSpan