Classes
StackLayout
A Layout that arranges its children horizontally or vertically. The direction can be set by orientation property.
Defined in: ui/layouts/stack-layout/index.d.ts:10
A Layout that arranges its children horizontally or vertically. The direction can be set by orientation property.
Ns View
StackLayout
Extends
Constructors
Constructor
new StackLayout(): StackLayout;Defined in: ui/core/view-base/index.ts
Returns
StackLayout
Inherited from
Properties
_androidContentDescriptionUpdated?
optional _androidContentDescriptionUpdated?: boolean;Defined in: ui/core/view/index.d.ts:358
Internal use only. This is used to limit the number of updates to android.view.View.setContentDescription()
Inherited from
LayoutBase._androidContentDescriptionUpdated
_automaticallyAdjustsScrollViewInsets
_automaticallyAdjustsScrollViewInsets: boolean;Defined in: ui/core/view-base/index.ts
Inherited from
LayoutBase._automaticallyAdjustsScrollViewInsets
_closeModalCallback
protected _closeModalCallback: Function;Defined in: ui/core/view/view-common.ts
Inherited from
LayoutBase._closeModalCallback
_context
_context: any;Defined in: ui/core/view-base/index.ts
Inherited from
_cssState
_cssState: CssState;Defined in: ui/core/view-base/index.ts
Inherited from
_defaultPaddingBottom
protected _defaultPaddingBottom: number;Defined in: ui/core/view-base/index.ts
Inherited from
LayoutBase._defaultPaddingBottom
_defaultPaddingLeft
protected _defaultPaddingLeft: number;Defined in: ui/core/view-base/index.ts
Inherited from
LayoutBase._defaultPaddingLeft
_defaultPaddingRight
protected _defaultPaddingRight: number;Defined in: ui/core/view-base/index.ts
Inherited from
LayoutBase._defaultPaddingRight
_defaultPaddingTop
protected _defaultPaddingTop: number;Defined in: ui/core/view-base/index.ts
Inherited from
_domId
_domId: number;Defined in: ui/core/view-base/index.ts
Inherited from
_ignoreFlexMinWidthHeightReset
_ignoreFlexMinWidthHeightReset: boolean;Defined in: ui/core/view-base/index.ts
Inherited from
LayoutBase._ignoreFlexMinWidthHeightReset
_isAddedToNativeVisualTree
_isAddedToNativeVisualTree: boolean;Defined in: ui/core/view-base/index.ts
Inherited from
LayoutBase._isAddedToNativeVisualTree
_isPaddingRelative
protected _isPaddingRelative: boolean;Defined in: ui/core/view-base/index.ts
Inherited from
_isStyleScopeHost
_isStyleScopeHost: boolean;Defined in: ui/core/view-base/index.ts
Inherited from
_nativeWindow?
optional _nativeWindow?: NativeWindow;Defined in: ui/core/view/index.d.ts:970
Internal property: The window this view is the root view of. Only ever set on a window's root view; use getNativeWindow() to resolve the window of any other view.
Inherited from
_oldBottom
_oldBottom: number;Defined in: ui/core/view-base/index.ts
Inherited from
_oldLeft
_oldLeft: number;Defined in: ui/core/view-base/index.ts
Inherited from
_oldRight
_oldRight: number;Defined in: ui/core/view-base/index.ts
Inherited from
_oldTop
_oldTop: number;Defined in: ui/core/view-base/index.ts
Inherited from
_styleScope
_styleScope: StyleScope;Defined in: ui/core/view-base/index.ts
Inherited from
_suspendNativeUpdatesCount
_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
LayoutBase._suspendNativeUpdatesCount
accessibilityHidden
accessibilityHidden: boolean;Defined in: ui/core/view/index.d.ts:260
Hide the view and its children from the a11y service
Ns Property
Inherited from
LayoutBase.accessibilityHidden
accessibilityHint
accessibilityHint: string;Defined in: ui/core/view/index.d.ts:305
A hint describes the elements behavior. Example: 'Tap change playback speed'
Ns Property
Inherited from
accessibilityIdentifier
accessibilityIdentifier: string;Defined in: ui/core/view/index.d.ts:269
The view's unique accessibilityIdentifier.
This is used for automated testing.
Ns Property
Inherited from
LayoutBase.accessibilityIdentifier
accessibilityIgnoresInvertColors
accessibilityIgnoresInvertColors: boolean;Defined in: ui/core/view/index.d.ts:332
Ns Property
Inherited from
LayoutBase.accessibilityIgnoresInvertColors
accessibilityLabel
accessibilityLabel: string;Defined in: ui/core/view/index.d.ts:291
Short description of the element, ideally one word.
Ns Property
Inherited from
accessibilityLanguage
accessibilityLanguage: string;Defined in: ui/core/view/index.d.ts:320
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
LayoutBase.accessibilityLanguage
accessibilityLiveRegion
accessibilityLiveRegion: AccessibilityLiveRegion;Defined in: ui/core/view/index.d.ts:312
When components dynamically change, we want TalkBack to alert the end user. This is made possible by the accessibilityLiveRegion property.
Ns Property
Inherited from
LayoutBase.accessibilityLiveRegion
accessibilityMediaSession
accessibilityMediaSession: boolean;Defined in: ui/core/view/index.d.ts:327
This view starts a media session. Equivalent to trait = startsMedia
Ns Property
Inherited from
LayoutBase.accessibilityMediaSession
accessibilityRole
accessibilityRole: AccessibilityRole;Defined in: ui/core/view/index.d.ts:276
Which role should this view be treated by the a11y service?
Ns Property
Inherited from
accessibilityState
accessibilityState: AccessibilityState;Defined in: ui/core/view/index.d.ts:284
Which state should this view be treated as by the a11y service?
Ns Property
Inherited from
accessibilityValue
accessibilityValue: string;Defined in: ui/core/view/index.d.ts:298
Current value of the element in a localized string.
Ns Property
Inherited from
accessible
accessible: boolean;Defined in: ui/core/view/index.d.ts:253
If true the element is an accessibility element and all the children will be treated as a single selectable component.
Ns Property
Inherited from
alignSelf
alignSelf: AlignSelf;Defined in: ui/core/view-base/index.ts
(Android-only) Overrides the alignItems value for the child.
Ns Property
Inherited from
android
android: any;Defined in: ui/core/view/index.d.ts:121
Gets the android-specific native instance that lies behind this proxy. Will be available if running on an Android platform.
Inherited from
androidDynamicElevationOffset
androidDynamicElevationOffset: number;Defined in: ui/core/view/index.d.ts:378
Gets or sets the dynamic elevation offset of the android view.
Ns Property
Inherited from
LayoutBase.androidDynamicElevationOffset
androidElevation
androidElevation: number;Defined in: ui/core/view/index.d.ts:371
Gets or sets the elevation of the android view.
Ns Property
Inherited from
androidOverflowEdge
androidOverflowEdge: AndroidOverflow;Defined in: ui/core/view/view-common.ts
Inherited from
LayoutBase.androidOverflowEdge
automationText
automationText: string;Defined in: ui/core/view/index.d.ts:364
Ns Property
Inherited from
background
background: string;Defined in: ui/core/view/index.d.ts:385
Gets or sets the background style property.
Ns Property
Inherited from
backgroundColor
backgroundColor: string | Color;Defined in: ui/core/view/index.d.ts:392
Gets or sets the background color of the view.
Ns Property
Inherited from
backgroundImage
backgroundImage: string | LinearGradient;Defined in: ui/core/view/index.d.ts:399
Gets or sets the background image of the view.
Ns Property
Inherited from
bindingContext
bindingContext: any;Defined in: ui/core/view/index.d.ts:134
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
borderBottomColor
borderBottomColor: Color;Defined in: ui/core/view/index.d.ts:162
Gets or sets the bottom border color of the view.
Ns Property
Inherited from
borderBottomLeftRadius
borderBottomLeftRadius: LengthType;Defined in: ui/core/view/index.d.ts:239
Gets or sets the bottom left border radius of the view.
Ns Property
Inherited from
LayoutBase.borderBottomLeftRadius
borderBottomRightRadius
borderBottomRightRadius: LengthType;Defined in: ui/core/view/index.d.ts:232
Gets or sets the bottom right border radius of the view.
Ns Property
Inherited from
LayoutBase.borderBottomRightRadius
borderBottomWidth
borderBottomWidth: LengthType;Defined in: ui/core/view/index.d.ts:197
Gets or sets the bottom border width of the view.
Ns Property
Inherited from
borderColor
borderColor: string | Color;Defined in: ui/core/view/index.d.ts:141
Gets or sets the border color of the view.
Ns Property
Inherited from
borderLeftColor
borderLeftColor: Color;Defined in: ui/core/view/index.d.ts:169
Gets or sets the left border color of the view.
Ns Property
Inherited from
borderLeftWidth
borderLeftWidth: LengthType;Defined in: ui/core/view/index.d.ts:204
Gets or sets the left border width of the view.
Ns Property
Inherited from
borderRadius
borderRadius:
| string
| number
| LengthDipUnit
| LengthPxUnit;Defined in: ui/core/view/index.d.ts:211
Gets or sets the border radius of the view.
Ns Property
Inherited from
borderRightColor
borderRightColor: Color;Defined in: ui/core/view/index.d.ts:155
Gets or sets the right border color of the view.
Ns Property
Inherited from
borderRightWidth
borderRightWidth: LengthType;Defined in: ui/core/view/index.d.ts:190
Gets or sets the right border width of the view.
Ns Property
Inherited from
borderTopColor
borderTopColor: Color;Defined in: ui/core/view/index.d.ts:148
Gets or sets the top border color of the view.
Ns Property
Inherited from
borderTopLeftRadius
borderTopLeftRadius: LengthType;Defined in: ui/core/view/index.d.ts:218
Gets or sets the top left border radius of the view.
Ns Property
Inherited from
LayoutBase.borderTopLeftRadius
borderTopRightRadius
borderTopRightRadius: LengthType;Defined in: ui/core/view/index.d.ts:225
Gets or sets the top right border radius of the view.
Ns Property
Inherited from
LayoutBase.borderTopRightRadius
borderTopWidth
borderTopWidth: LengthType;Defined in: ui/core/view/index.d.ts:183
Gets or sets the top border width of the view.
Ns Property
Inherited from
borderWidth
borderWidth:
| string
| number
| LengthDipUnit
| LengthPxUnit;Defined in: ui/core/view/index.d.ts:176
Gets or sets the border width of the view.
Ns Property
Inherited from
boxShadow
boxShadow: string | ShadowCSSValues[];Defined in: ui/core/view/index.d.ts:406
Gets or sets the box shadow of the view.
Ns Property
Inherited from
className
className: string;Defined in: ui/core/view-base/index.ts
Gets or sets the CSS class name for this view.
Ns Property
Inherited from
clipToBounds
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
col
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
color
color: Color;Defined in: ui/core/view/index.d.ts:246
Gets or sets the color of the view.
Ns Property
Inherited from
colSpan
colSpan: number;Defined in: ui/core/view-base/index.ts
The number of columns for the element to span across.
Ns Property
Inherited from
column
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
columnSpan
columnSpan: number;Defined in: ui/core/view-base/index.ts
Ns Property
Inherited from
cssClasses
cssClasses: Set<string>;Defined in: ui/core/view/index.d.ts:711
Inherited from
cssPseudoClasses
cssPseudoClasses: Set<string>;Defined in: ui/core/view/index.d.ts:712
Inherited from
cssType
cssType: string;Defined in: ui/core/view/index.d.ts:693
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
defaultVisualState
defaultVisualState: string;Defined in: ui/core/view-base/index.ts
Default visual state, defaults to 'normal'
Ns Property
Inherited from
direction
direction: LayoutDirectionType;Defined in: ui/core/view/index.d.ts:413
Gets or sets the layout direction of the view.
Ns Property
Inherited from
dock
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
domNode
domNode: DOMNode;Defined in: ui/core/view-base/index.ts
Inherited from
effectiveBorderBottomWidth
effectiveBorderBottomWidth: number;Defined in: ui/core/view-base/index.ts
Inherited from
LayoutBase.effectiveBorderBottomWidth
effectiveBorderLeftWidth
effectiveBorderLeftWidth: number;Defined in: ui/core/view-base/index.ts
Inherited from
LayoutBase.effectiveBorderLeftWidth
effectiveBorderRightWidth
effectiveBorderRightWidth: number;Defined in: ui/core/view-base/index.ts
Inherited from
LayoutBase.effectiveBorderRightWidth
effectiveBorderTopWidth
effectiveBorderTopWidth: number;Defined in: ui/core/view-base/index.ts
Inherited from
LayoutBase.effectiveBorderTopWidth
effectiveColumnGap
effectiveColumnGap: number;Defined in: ui/core/view-base/index.ts
Inherited from
effectiveHeight
effectiveHeight: number;Defined in: ui/core/view-base/index.ts
Inherited from
effectiveLeft
effectiveLeft: number;Defined in: ui/core/view-base/index.ts
Inherited from
effectiveMarginBottom
effectiveMarginBottom: number;Defined in: ui/core/view-base/index.ts
Inherited from
LayoutBase.effectiveMarginBottom
effectiveMarginLeft
effectiveMarginLeft: number;Defined in: ui/core/view-base/index.ts
Inherited from
LayoutBase.effectiveMarginLeft
effectiveMarginRight
effectiveMarginRight: number;Defined in: ui/core/view-base/index.ts
Inherited from
LayoutBase.effectiveMarginRight
effectiveMarginTop
effectiveMarginTop: number;Defined in: ui/core/view-base/index.ts
Inherited from
effectiveMaxHeight
effectiveMaxHeight: number;Defined in: ui/core/view-base/index.ts
Inherited from
effectiveMaxWidth
effectiveMaxWidth: number;Defined in: ui/core/view-base/index.ts
Inherited from
effectiveMinHeight
effectiveMinHeight: number;Defined in: ui/core/view-base/index.ts
Inherited from
effectiveMinWidth
effectiveMinWidth: number;Defined in: ui/core/view-base/index.ts
Inherited from
effectiveRowGap
effectiveRowGap: number;Defined in: ui/core/view-base/index.ts
Inherited from
effectiveTop
effectiveTop: number;Defined in: ui/core/view-base/index.ts
Inherited from
effectiveWidth
effectiveWidth: number;Defined in: ui/core/view-base/index.ts
Inherited from
flex
flex: Flex;Defined in: ui/core/view/index.d.ts:604
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
flexFlow
flexFlow: FlexFlow;Defined in: ui/core/view/index.d.ts:599
The flex-flow Shorthand property specifies the direction of a flex container, as well as its wrapping behavior.
Ns Property
Inherited from
flexGrow
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
flexShrink
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
flexWrapBefore
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
height
height: PercentLengthType;Defined in: ui/core/view/index.d.ts:457
Gets or sets the desired height of the view.
Ns Property
Inherited from
hidden
hidden: boolean;Defined in: ui/core/view-base/index.ts
Gets or sets the visual state of the view.
Ns Property
Inherited from
horizontalAlignment
horizontalAlignment: HorizontalAlignmentType;Defined in: ui/core/view/index.d.ts:499
Gets or sets the alignment of this view within its parent along the Horizontal axis.
Ns Property
Inherited from
LayoutBase.horizontalAlignment
id
id: string;Defined in: ui/core/view-base/index.ts
Gets or sets the id for this view.
Ns Property
Inherited from
ignoreTouchAnimation
ignoreTouchAnimation: boolean;Defined in: ui/core/view/index.d.ts:673
Ns Property
Inherited from
LayoutBase.ignoreTouchAnimation
ios
ios: any;Defined in: ui/core/view/index.d.ts:127
Gets the ios-specific native instance that lies behind this proxy. Will be available if running on an iOS platform.
Inherited from
iosAccessibilityAdjustsFontSize
iosAccessibilityAdjustsFontSize: boolean;Defined in: ui/core/view/index.d.ts:339
Defines whether accessibility font scale should affect font size.
Ns Property
Inherited from
LayoutBase.iosAccessibilityAdjustsFontSize
iosAccessibilityMaxFontScale
iosAccessibilityMaxFontScale: number;Defined in: ui/core/view/index.d.ts:353
Gets or sets the maximum accessibility font scale.
Ns Property
Inherited from
LayoutBase.iosAccessibilityMaxFontScale
iosAccessibilityMinFontScale
iosAccessibilityMinFontScale: number;Defined in: ui/core/view/index.d.ts:346
Gets or sets the minimum accessibility font scale.
Ns Property
Inherited from
LayoutBase.iosAccessibilityMinFontScale
iosGlassEffect
iosGlassEffect: GlassEffectType;Defined in: ui/core/view/index.d.ts:660
Set the iOS liquid glass effect style on the view.
Ns Property
Inherited from
iosIgnoreSafeArea
iosIgnoreSafeArea: boolean;Defined in: ui/core/view/index.d.ts:639
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
iosOverflowSafeArea
iosOverflowSafeArea: boolean;Defined in: ui/core/view/index.d.ts:1187
Instruct container view to expand beyond the safe area. This property is iOS specific. Default value: true
Ns Property
Inherited from
LayoutBase.iosOverflowSafeArea
iosOverflowSafeAreaEnabled
iosOverflowSafeAreaEnabled: boolean;Defined in: ui/core/view/index.d.ts:632
Enables or disables the iosOverflowSafeArea property for all children. This property is iOS specific. Default value: true
Ns Property
Inherited from
LayoutBase.iosOverflowSafeAreaEnabled
isCollapsed
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
isEnabled
isEnabled: boolean;Defined in: ui/core/view/index.d.ts:611
Gets or sets a value indicating whether the the view is enabled. This affects the appearance of the view.
Ns Property
Inherited from
isLayoutValid
isLayoutValid: boolean;Defined in: ui/core/view/index.d.ts:682
Gets if layout is valid. This is a read-only property.
Inherited from
isPassThroughParentEnabled
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
LayoutBase.isPassThroughParentEnabled
isUserInteractionEnabled
isUserInteractionEnabled: boolean;Defined in: ui/core/view/index.d.ts:618
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
LayoutBase.isUserInteractionEnabled
left
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
margin
margin:
| string
| number
| LengthDipUnit
| LengthPxUnit
| LengthPercentUnit;Defined in: ui/core/view/index.d.ts:464
Gets or sets margin style property.
Ns Property
Inherited from
marginBottom
marginBottom: PercentLengthType;Defined in: ui/core/view/index.d.ts:492
Specifies extra space on the bottom side of this view.
Ns Property
Inherited from
marginLeft
marginLeft: PercentLengthType;Defined in: ui/core/view/index.d.ts:471
Specifies extra space on the left side of this view.
Ns Property
Inherited from
marginRight
marginRight: PercentLengthType;Defined in: ui/core/view/index.d.ts:485
Specifies extra space on the right side of this view.
Ns Property
Inherited from
marginTop
marginTop: PercentLengthType;Defined in: ui/core/view/index.d.ts:478
Specifies extra space on the top side of this view.
Ns Property
Inherited from
maxHeight
maxHeight: PercentLengthType;Defined in: ui/core/view/index.d.ts:443
Gets or sets the maximum height the view may grow to. Accepts a fixed length or a percentage of the available height. Defaults to 'auto' (no maximum).
Ns Property
Inherited from
maxWidth
maxWidth: PercentLengthType;Defined in: ui/core/view/index.d.ts:435
Gets or sets the maximum width the view may grow to. Accepts a fixed length or a percentage of the available width. Defaults to 'auto' (no maximum).
Ns Property
Inherited from
minHeight
minHeight: LengthType;Defined in: ui/core/view/index.d.ts:427
Gets or sets the minimum height the view may grow to.
Ns Property
Inherited from
minWidth
minWidth: LengthType;Defined in: ui/core/view/index.d.ts:420
Gets or sets the minimum width the view may grow to.
Ns Property
Inherited from
modal
modal: View;Defined in: ui/core/view/index.d.ts:874
Returns the current modal view that this page is showing (is parent of), if any.
Inherited from
nativeBackgroundState?
optional nativeBackgroundState?: "unset" | "invalid" | "drawn";Defined in: ui/core/view/index.d.ts:687
Native background states. This is a read-only property.
Inherited from
LayoutBase.nativeBackgroundState
nativeViewProtected
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
LayoutBase.nativeViewProtected
opacity
opacity: number;Defined in: ui/core/view/index.d.ts:520
Gets or sets the opacity style property.
Ns Property
Inherited from
order
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
orientation
orientation: OrientationType;Defined in: ui/layouts/stack-layout/index.d.ts:16
Gets or sets if layout should be horizontal or vertical. The default value is vertical.
Ns Property
originX
originX: number;Defined in: ui/core/view/index.d.ts:586
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
originY
originY: number;Defined in: ui/core/view/index.d.ts:593
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
padding
padding:
| string
| number
| LengthDipUnit
| LengthPxUnit;Defined in: ui/layouts/layout-base.d.ts:71
Gets or sets padding style property.
Ns Property
Inherited from
paddingBottom
paddingBottom: LengthType;Defined in: ui/layouts/layout-base.d.ts:78
Specify the bottom padding of this layout.
Ns Property
Inherited from
paddingLeft
paddingLeft: LengthType;Defined in: ui/layouts/layout-base.d.ts:85
Specify the left padding of this layout.
Ns Property
Inherited from
paddingRight
paddingRight: LengthType;Defined in: ui/layouts/layout-base.d.ts:92
Specify the right padding of this layout.
Ns Property
Inherited from
paddingTop
paddingTop: LengthType;Defined in: ui/layouts/layout-base.d.ts:99
Specify the top padding of this layout.
Ns Property
Inherited from
parent
parent: ViewBase;Defined in: ui/core/view-base/index.ts
Gets the parent view. This property is read-only.
Inherited from
perspective
perspective: number;Defined in: ui/core/view/index.d.ts:549
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
recycleNativeView
recycleNativeView: "auto" | "always" | "never";Defined in: ui/core/view-base/index.ts
Inherited from
reusable
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
rotate
rotate: number;Defined in: ui/core/view/index.d.ts:527
Gets or sets the rotate affine transform of the view along the Z axis.
Ns Property
Inherited from
rotateX
rotateX: number;Defined in: ui/core/view/index.d.ts:534
Gets or sets the rotate affine transform of the view along the X axis.
Ns Property
Inherited from
rotateY
rotateY: number;Defined in: ui/core/view/index.d.ts:541
Gets or sets the rotate affine transform of the view along the Y axis.
Ns Property
Inherited from
row
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
rowSpan
rowSpan: number;Defined in: ui/core/view-base/index.ts
The number of rows for the element to span across.
Ns Property
Inherited from
scaleX
scaleX: number;Defined in: ui/core/view/index.d.ts:570
Gets or sets the scaleX affine transform of the view.
Ns Property
Inherited from
scaleY
scaleY: number;Defined in: ui/core/view/index.d.ts:577
Gets or sets the scaleY affine transform of the view.
Ns Property
Inherited from
sharedTransitionIgnore
sharedTransitionIgnore: boolean;Defined in: ui/core/view-base/index.ts
Opt out of shared transition under different binding conditions
Ns Property
Inherited from
LayoutBase.sharedTransitionIgnore
sharedTransitionTag
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
LayoutBase.sharedTransitionTag
statusBarStyle
statusBarStyle: "dark" | "light";Defined in: ui/core/view/index.d.ts:709
Gets or sets the status bar style for this view. Platform Notes:
- Android: When using this property throughout navigations, ensure starting views have it set as well. Ensures it will reset on back navigation.
- iOS: You must remove Info.plist key
UIViewControllerBasedStatusBarAppearanceIt defaults to true when not present: https://developer.apple.com/documentation/bundleresources/information-property-list/uiviewcontrollerbasedstatusbarappearance Or you can explicitly set it to true: <key>UIViewControllerBasedStatusBarAppearance</key> <true/>
False value will make this property have no effect.
Ns Property
Inherited from
testID
testID: string;Defined in: ui/core/view/index.d.ts:665
Ns Property
Inherited from
top
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
touchAnimation
touchAnimation:
| boolean
| TouchAnimationOptions;Defined in: ui/core/view/index.d.ts:669
Ns Property
Inherited from
touchDelay
touchDelay: number;Defined in: ui/core/view/index.d.ts:677
Ns Property
Inherited from
transitionId
transitionId: number;Defined in: ui/core/view/view-common.ts
Active transition instance id for tracking state
Inherited from
translateX
translateX: number;Defined in: ui/core/view/index.d.ts:556
Gets or sets the translateX affine transform of the view in device independent pixels.
Ns Property
Inherited from
translateY
translateY: number;Defined in: ui/core/view/index.d.ts:563
Gets or sets the translateY affine transform of the view in device independent pixels.
Ns Property
Inherited from
verticalAlignment
verticalAlignment: VerticalAlignmentType;Defined in: ui/core/view/index.d.ts:506
Gets or sets the alignment of this view within its parent along the Vertical axis.
Ns Property
Inherited from
viewController
viewController: any;Defined in: ui/core/view-base/index.ts
returns the native UIViewController.
Inherited from
visibility
visibility: VisibilityType;Defined in: ui/core/view/index.d.ts:513
Gets or sets the visibility of the view.
Ns Property
Inherited from
visionHoverStyle
visionHoverStyle: string | VisionHoverOptions;Defined in: ui/core/view/index.d.ts:653
visionOS only
Ns Property
Inherited from
visionIgnoreHoverStyle
visionIgnoreHoverStyle: boolean;Defined in: ui/core/view/index.d.ts:646
visionOS only
Ns Property
Inherited from
LayoutBase.visionIgnoreHoverStyle
width
width: PercentLengthType;Defined in: ui/core/view/index.d.ts:450
Gets or sets the desired width of the view.
Ns Property
Inherited from
accessibilityBlurEvent
static accessibilityBlurEvent: string;Defined in: ui/core/view/index.d.ts:89
String value used when hooking to accessibilityBlur event.
Ns Event
accessibilityBlur
Inherited from
LayoutBase.accessibilityBlurEvent
accessibilityFocusChangedEvent
static accessibilityFocusChangedEvent: string;Defined in: ui/core/view/index.d.ts:103
String value used when hooking to accessibilityFocusChanged event.
Ns Event
accessibilityFocusChanged
Inherited from
LayoutBase.accessibilityFocusChangedEvent
accessibilityFocusEvent
static accessibilityFocusEvent: string;Defined in: ui/core/view/index.d.ts:96
String value used when hooking to accessibilityFocus event.
Ns Event
accessibilityFocus
Inherited from
LayoutBase.accessibilityFocusEvent
accessibilityPerformEscapeEvent
static accessibilityPerformEscapeEvent: string;Defined in: ui/core/view/view-common.ts
Inherited from
LayoutBase.accessibilityPerformEscapeEvent
androidOverflowInsetEvent
static androidOverflowInsetEvent: string;Defined in: ui/core/view/index.d.ts:110
String value used when hooking to androidOverflowInset event.
Ns Event
androidOverflowInset
Inherited from
LayoutBase.androidOverflowInsetEvent
closedModallyEvent
static closedModallyEvent: string;Defined in: ui/core/view/index.d.ts:82
String value used when hooking to closedModally event. Fired on the modal view once its native dismissal has fully completed (after the close callback and UI teardown).
Ns Event
closedModally
Inherited from
createdEvent
static createdEvent: string;Defined in: ui/core/view-base/index.ts
String value used when hooking to creation event
Ns Event
created
Inherited from
disposeNativeViewEvent
static disposeNativeViewEvent: string;Defined in: ui/core/view-base/index.ts
String value used when hooking to disposeNativeView event
Ns Event
disposeNativeView
Inherited from
LayoutBase.disposeNativeViewEvent
layoutChangedEvent
static layoutChangedEvent: string;Defined in: ui/core/view/index.d.ts:60
String value used when hooking to layoutChanged event.
Ns Event
layoutChanged
Inherited from
loadedEvent
static loadedEvent: string;Defined in: ui/core/view-base/index.ts
String value used when hooking to loaded event.
Ns Event
loaded
Inherited from
propertyChangeEvent
static propertyChangeEvent: string;Defined in: data/observable/index.ts
String value used when hooking to propertyChange event.
Ns Event
propertyChange
Inherited from
LayoutBase.propertyChangeEvent
showingModallyEvent
static showingModallyEvent: string;Defined in: ui/core/view/index.d.ts:66
String value used when hooking to showingModally event.
Ns Event
showingModally
Inherited from
LayoutBase.showingModallyEvent
shownModallyEvent
static shownModallyEvent: string;Defined in: ui/core/view/index.d.ts:73
String value used when hooking to shownModally event.
Ns Event
shownModally
Inherited from
unloadedEvent
static unloadedEvent: string;Defined in: ui/core/view-base/index.ts
String value used when hooking to unloaded event.
Ns Event
unloaded
Inherited from
Accessors
backgroundPosition
Get Signature
get backgroundPosition(): string;Defined in: ui/core/view/view-common.ts
Returns
string
Set Signature
set backgroundPosition(value: string): void;Defined in: ui/core/view/view-common.ts
Parameters
| Parameter | Type |
|---|---|
value | string |
Returns
void
Inherited from
backgroundRepeat
Get Signature
get backgroundRepeat(): BackgroundRepeatType;Defined in: ui/core/view/view-common.ts
Returns
Set Signature
set backgroundRepeat(value: BackgroundRepeatType): void;Defined in: ui/core/view/view-common.ts
Parameters
| Parameter | Type |
|---|---|
value | BackgroundRepeatType |
Returns
void
Inherited from
backgroundSize
Get Signature
get backgroundSize(): string;Defined in: ui/core/view/view-common.ts
Returns
string
Set Signature
set backgroundSize(value: string): void;Defined in: ui/core/view/view-common.ts
Parameters
| Parameter | Type |
|---|---|
value | string |
Returns
void
Inherited from
class
Get Signature
get class(): string;Defined in: ui/core/view-base/index.ts
Returns
string
Set Signature
set class(v: string): void;Defined in: ui/core/view-base/index.ts
Parameters
| Parameter | Type |
|---|---|
v | string |
Returns
void
Inherited from
effectivePaddingBottom
Get Signature
get effectivePaddingBottom(): number;Defined in: ui/core/view-base/index.ts
Returns
number
Set Signature
set effectivePaddingBottom(v: number): void;Defined in: ui/core/view-base/index.ts
Parameters
| Parameter | Type |
|---|---|
v | number |
Returns
void
Inherited from
LayoutBase.effectivePaddingBottom
effectivePaddingLeft
Get Signature
get effectivePaddingLeft(): number;Defined in: ui/core/view-base/index.ts
Returns
number
Set Signature
set effectivePaddingLeft(v: number): void;Defined in: ui/core/view-base/index.ts
Parameters
| Parameter | Type |
|---|---|
v | number |
Returns
void
Inherited from
LayoutBase.effectivePaddingLeft
effectivePaddingRight
Get Signature
get effectivePaddingRight(): number;Defined in: ui/core/view-base/index.ts
Returns
number
Set Signature
set effectivePaddingRight(v: number): void;Defined in: ui/core/view-base/index.ts
Parameters
| Parameter | Type |
|---|---|
v | number |
Returns
void
Inherited from
LayoutBase.effectivePaddingRight
effectivePaddingTop
Get Signature
get effectivePaddingTop(): number;Defined in: ui/core/view-base/index.ts
Returns
number
Set Signature
set effectivePaddingTop(v: number): void;Defined in: ui/core/view-base/index.ts
Parameters
| Parameter | Type |
|---|---|
v | number |
Returns
void
Inherited from
LayoutBase.effectivePaddingTop
isLoaded
Get Signature
get isLoaded(): boolean;Defined in: ui/core/view-base/index.ts
Returns
boolean
Inherited from
nativeView
Get Signature
get nativeView(): any;Defined in: ui/core/view-base/index.ts
Returns
any
Set Signature
set nativeView(value: any): void;Defined in: ui/core/view-base/index.ts
Parameters
| Parameter | Type |
|---|---|
value | any |
Returns
void
Inherited from
page
Get Signature
get page(): Page;Defined in: ui/core/view-base/index.ts
Gets owner page. This is a read-only property.
Returns
Inherited from
parentNode
Get Signature
get parentNode(): ViewBase;Defined in: ui/core/view-base/index.ts
Gets the template parent or the native parent. Sets the template parent.
Returns
Set Signature
set parentNode(node: ViewBase): void;Defined in: ui/core/view-base/index.ts
Parameters
| Parameter | Type |
|---|---|
node | ViewBase |
Returns
void
Inherited from
style
Get Signature
get style(): Style;Defined in: ui/core/view-base/index.ts
Gets the style object associated to this view.
Returns
Set Signature
set style(inlineStyle: Style): void;Defined in: ui/core/view-base/index.ts
Ns Property
Parameters
| Parameter | Type |
|---|---|
inlineStyle | Style |
Returns
void
Inherited from
textTransform
Get Signature
get textTransform(): TextTransformType;Defined in: ui/core/view/view-common.ts
Returns
Set Signature
set textTransform(value: TextTransformType): void;Defined in: ui/core/view/view-common.ts
Parameters
| Parameter | Type |
|---|---|
value | TextTransformType |
Returns
void
Inherited from
typeName
Get Signature
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
visualState
Get Signature
get visualState(): string;Defined in: ui/core/view-base/index.ts
Deprecated
Returns
string
Inherited from
Methods
_addView()
_addView(view: ViewBase, atIndex?: number): void;Defined in: ui/core/view-base/index.ts
Parameters
| Parameter | Type |
|---|---|
view | ViewBase |
atIndex? | number |
Returns
void
Inherited from
_addViewCore()
_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
| Parameter | Type |
|---|---|
view | ViewBase |
atIndex? | number |
Returns
void
Inherited from
_addViewToNativeVisualTree()
_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
| Parameter | Type |
|---|---|
view | ViewBase |
atIndex? | number |
Returns
boolean
Inherited from
LayoutBase._addViewToNativeVisualTree
_applyGlassEffect()
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
| Parameter | Type | Description |
|---|---|---|
value | GlassEffectType | The 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) => void | Callback when a new effect view is created (for initial setup) |
options.onUpdate? | (effectView: UIVisualEffectView, effect: UIVisualEffect, duration: number) => void | Callback when an existing effect view is updated |
options.targetView? | UIVisualEffectView | The UIVisualEffectView to apply the effect to (if updating existing view) |
options.toGlassStyleFn? | (variant?: GlassEffectVariant) => number | Custom function to convert variant to UIGlassEffectStyle |
Returns
any
Inherited from
_applyXmlAttribute()
_applyXmlAttribute(attribute: string, value: string): boolean;Defined in: ui/core/view-base/index.ts
Parameters
| Parameter | Type |
|---|---|
attribute | string |
value | string |
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
_batchUpdate()
_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
| Parameter | Type |
|---|---|
callback | () => T |
Returns
T
Inherited from
_childIndexToNativeChildIndex()
_childIndexToNativeChildIndex(index?: number): number;Defined in: ui/core/view-base/index.ts
Parameters
| Parameter | Type |
|---|---|
index? | number |
Returns
number
Inherited from
LayoutBase._childIndexToNativeChildIndex
_closeAllModalViewsInternal()
_closeAllModalViewsInternal(): boolean;Defined in: ui/core/view/index.d.ts:950
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
LayoutBase._closeAllModalViewsInternal
_createPropertyChangeData()
_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
| Parameter | Type |
|---|---|
propertyName | string |
value | any |
oldValue? | any |
Returns
Inherited from
LayoutBase._createPropertyChangeData
_dialogClosed()
_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
_eachLayoutView()
_eachLayoutView(callback: (View: any) => void): void;Defined in: ui/core/view/index.d.ts:982
Parameters
| Parameter | Type |
|---|---|
callback | (View: any) => void |
Returns
void
Inherited from
_emit()
_emit(eventName: string): void;Defined in: data/observable/index.ts
Parameters
| Parameter | Type |
|---|---|
eventName | string |
Returns
void
Inherited from
_getNativeViewsCount()
_getNativeViewsCount(): number;Defined in: ui/core/view/index.d.ts:944
Returns
number
Inherited from
LayoutBase._getNativeViewsCount
_getRootModalHost()
_getRootModalHost(): ViewBase;Defined in: ui/core/view/index.d.ts:963
Internal method: Walks up the view tree — through the presenting view of any modal on the way — to the root this view ultimately lives under, which is the root view of its window.
Returns
Inherited from
_getRootModalViews()
_getRootModalViews(): ViewBase[];Defined in: ui/core/view/index.d.ts:956
Internal method: Gets all modal views of the current view.
Returns
ViewBase[]
Inherited from
_getValue()
_getValue(property: any): never;Defined in: ui/core/view/index.d.ts:1170
Obsolete: There is a new property system that does not rely on _getValue.
Parameters
| Parameter | Type |
|---|---|
property | any |
Returns
never
Inherited from
_handleLivesync()
_handleLivesync(context?: {
path: string;
type: string;
}): boolean;Defined in: ui/core/view/index.d.ts:1141
Parameters
| Parameter | Type |
|---|---|
context? | { path: string; type: string; } |
context.path? | string |
context.type? | string |
Returns
boolean
Inherited from
_hasAncestorView()
_hasAncestorView(ancestorView: View): boolean;Defined in: ui/core/view/index.d.ts:1164
Checks whether the current view has specific view for an ancestor.
Parameters
| Parameter | Type |
|---|---|
ancestorView | View |
Returns
boolean
Inherited from
_hideNativeModalView()
protected _hideNativeModalView(parent: ViewCommon, whenClosedCallback: () => void): void;Defined in: ui/core/view/view-common.ts
Parameters
| Parameter | Type |
|---|---|
parent | ViewCommon |
whenClosedCallback | () => void |
Returns
void
Inherited from
LayoutBase._hideNativeModalView
_inheritStyles()
_inheritStyles(view: ViewBase): void;Defined in: ui/core/view-base/index.ts
Parameters
| Parameter | Type |
|---|---|
view | ViewBase |
Returns
void
Inherited from
_inheritStyleScope()
_inheritStyleScope(styleScope: StyleScope): void;Defined in: ui/core/view-base/index.ts
Parameters
| Parameter | Type |
|---|---|
styleScope | StyleScope |
Returns
void
Inherited from
_layoutParent()
_layoutParent(): void;Defined in: ui/core/view-base/index.ts
Returns
void
Inherited from
_observe()
protected _observe(
type: GestureTypes,
callback: (args: GestureEventData) => void,
thisArg?: any): void;Defined in: ui/core/view/view-common.ts
Parameters
| Parameter | Type |
|---|---|
type | GestureTypes |
callback | (args: GestureEventData) => void |
thisArg? | any |
Returns
void
Inherited from
_onAttachedToWindow()
_onAttachedToWindow(): void;Defined in: ui/core/view/index.d.ts:1154
Called in android when native view is attached to window.
Returns
void
Inherited from
LayoutBase._onAttachedToWindow
_onDetachedFromWindow()
_onDetachedFromWindow(): void;Defined in: ui/core/view/index.d.ts:1159
Called in android when native view is dettached from window.
Returns
void
Inherited from
LayoutBase._onDetachedFromWindow
_onRootViewReset()
_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
_onSizeChanged()?
optional _onSizeChanged(): void;Defined in: ui/core/view/index.d.ts:987
iOS Only Internal method used to update various view details like background rerendering, border, etc.
Returns
void
Inherited from
_parentChanged()
_parentChanged(oldParent: ViewBase): void;Defined in: ui/core/view-base/index.ts
Parameters
| Parameter | Type |
|---|---|
oldParent | ViewBase |
Returns
void
Inherited from
_raiseLayoutChangedEvent()
protected _raiseLayoutChangedEvent(): void;Defined in: ui/core/view/view-common.ts
Returns
void
Inherited from
LayoutBase._raiseLayoutChangedEvent
_raiseShowingModallyEvent()
protected _raiseShowingModallyEvent(): void;Defined in: ui/core/view/view-common.ts
Returns
void
Inherited from
LayoutBase._raiseShowingModallyEvent
_raiseShownModallyEvent()
protected _raiseShownModallyEvent(): void;Defined in: ui/core/view/view-common.ts
Returns
void
Inherited from
LayoutBase._raiseShownModallyEvent
_registerLayoutChild()
_registerLayoutChild(child: View): void;Defined in: ui/layouts/layout-base.d.ts:53
INTERNAL. Used by the layout system.
Parameters
| Parameter | Type |
|---|---|
child | View |
Returns
void
Inherited from
LayoutBase._registerLayoutChild
_removeView()
_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
| Parameter | Type |
|---|---|
view | ViewBase |
Returns
void
Inherited from
_removeViewCore()
_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
| Parameter | Type |
|---|---|
view | ViewBase |
Returns
void
Inherited from
_removeViewFromNativeVisualTree()
_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
| Parameter | Type |
|---|---|
view | ViewBase |
Returns
void
Inherited from
LayoutBase._removeViewFromNativeVisualTree
_resumeNativeUpdates()
_resumeNativeUpdates(type: SuspendType): void;Defined in: ui/core/view-base/index.ts
Parameters
| Parameter | Type |
|---|---|
type | SuspendType |
Returns
void
Inherited from
LayoutBase._resumeNativeUpdates
_setDefaultPaddings()
_setDefaultPaddings(insets: any): void;Defined in: ui/core/view-base/index.ts
Parameters
| Parameter | Type |
|---|---|
insets | any |
Returns
void
Inherited from
LayoutBase._setDefaultPaddings
_setupAsRootView()
_setupAsRootView(context: any): void;Defined in: ui/core/view/view-common.ts
Parameters
| Parameter | Type |
|---|---|
context | any |
Returns
void
Inherited from
_setupUI()
_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
| Parameter | Type |
|---|---|
context | any |
atIndex? | number |
parentIsLoaded? | boolean |
Returns
void
Inherited from
_setValue()
_setValue(property: any, value: any): never;Defined in: ui/core/view/index.d.ts:1175
Obsolete: There is a new property system that does not rely on _setValue.
Parameters
| Parameter | Type |
|---|---|
property | any |
value | any |
Returns
never
Inherited from
_shouldDelayLayout()
_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
_showNativeModalView()
protected _showNativeModalView(parent: ViewCommon, options: ShowModalOptions): void;Defined in: ui/core/view/view-common.ts
Parameters
| Parameter | Type |
|---|---|
parent | ViewCommon |
options | ShowModalOptions |
Returns
void
Inherited from
LayoutBase._showNativeModalView
_suspendNativeUpdates()
_suspendNativeUpdates(type: SuspendType): void;Defined in: ui/core/view-base/index.ts
Parameters
| Parameter | Type |
|---|---|
type | SuspendType |
Returns
void
Inherited from
LayoutBase._suspendNativeUpdates
_tearDownUI()
_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
| Parameter | Type |
|---|---|
force? | boolean |
Returns
void
Inherited from
_unregisterLayoutChild()
_unregisterLayoutChild(child: View): void;Defined in: ui/layouts/layout-base.d.ts:58
INTERNAL. Used by the layout system.
Parameters
| Parameter | Type |
|---|---|
child | View |
Returns
void
Inherited from
LayoutBase._unregisterLayoutChild
_updateStyleScope()
_updateStyleScope(
cssFileName?: string,
cssString?: string,
css?: string): void;Defined in: ui/core/view/index.d.ts:1149
Updates styleScope or create new styleScope.
Parameters
| Parameter | Type | Description |
|---|---|---|
cssFileName? | string | - |
cssString? | string | - |
css? | string | - |
Returns
void
Inherited from
accessibilityAnnouncement()
accessibilityAnnouncement(msg?: string): void;Defined in: ui/core/view/index.d.ts:1022
Make an announcement to the screen reader.
Parameters
| Parameter | Type |
|---|---|
msg? | string |
Returns
void
Inherited from
LayoutBase.accessibilityAnnouncement
accessibilityScreenChanged()
accessibilityScreenChanged(): void;Defined in: ui/core/view/index.d.ts:1027
Announce screen changed
Returns
void
Inherited from
LayoutBase.accessibilityScreenChanged
addChild()
addChild(view: View): void;Defined in: ui/layouts/layout-base.d.ts:30
Adds the view to children array.
Parameters
| Parameter | Type | Description |
|---|---|---|
view | View | The view to be added to the end of the children array. |
Returns
void
Inherited from
addEventListener()
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
| Parameter | Type | Description |
|---|---|---|
eventNames | string | - |
callback | (data: EventData) => void | A function to be called when some of the specified event(s) is raised. |
thisArg? | any | An optional parameter which when set will be used as "this" in callback method call. |
once? | boolean | An optional parameter which when set will cause the event listener to fire once. |
Returns
void
Inherited from
addPseudoClass()
protected addPseudoClass(name: string): void;Defined in: ui/core/view-base/index.ts
Parameters
| Parameter | Type |
|---|---|
name | string |
Returns
void
Unstable
A widget can call this method to add a matching css pseudo class.
Inherited from
animate()
animate(options: AnimationDefinition): AnimationPromise;Defined in: ui/core/view/index.d.ts:879
Animates one or more properties of the view based on the supplied options.
Parameters
| Parameter | Type |
|---|---|
options | AnimationDefinition |
Returns
Inherited from
bind()
bind(options: BindingOptions, source?: Object): void;Defined in: ui/core/view-base/index.ts
Parameters
| Parameter | Type |
|---|---|
options | BindingOptions |
source? | Object |
Returns
void
Inherited from
callLoaded()
callLoaded(): void;Defined in: ui/core/view-base/index.ts
Returns
void
Inherited from
callUnloaded()
callUnloaded(): void;Defined in: ui/core/view-base/index.ts
Returns
void
Inherited from
closeModal()
closeModal(...args: any[]): void;Defined in: ui/core/view/view-common.ts
Closes the current modal view that this page is showing.
Parameters
| Parameter | Type |
|---|---|
...args | any[] |
Returns
void
Inherited from
createAnimation()
createAnimation(options: AnimationDefinition): Animation;Defined in: ui/core/view/index.d.ts:884
Creates an Animation object based on the supplied options.
Parameters
| Parameter | Type |
|---|---|
options | AnimationDefinition |
Returns
Inherited from
createNativeView()
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
deletePseudoClass()
protected deletePseudoClass(name: string): void;Defined in: ui/core/view-base/index.ts
Parameters
| Parameter | Type |
|---|---|
name | string |
Returns
void
Unstable
A widget can call this method to discard matching css pseudo class.
Inherited from
destroyNode()
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
| Parameter | Type | Description |
|---|---|---|
forceDestroyChildren? | boolean | Force destroy the children (even if they are reusable) |
Returns
void
See
_tearDownUI
Inherited from
disposeNativeView()
disposeNativeView(): void;Defined in: ui/core/view-base/index.ts
Clean up references to the native view.
Returns
void
Inherited from
eachChild()
eachChild(callback: (child: ViewBase) => boolean): void;Defined in: ui/core/view/view-common.ts
Iterates over children of type ViewBase.
Parameters
| Parameter | Type | Description |
|---|---|---|
callback | (child: ViewBase) => boolean | Called for each child of type ViewBase. Iteration stops if this method returns falsy value. |
Returns
void
Inherited from
eachChildView()
eachChildView(callback: (view: View) => boolean): void;Defined in: ui/core/view/index.d.ts:1003
Iterates over children of type View.
Parameters
| Parameter | Type | Description |
|---|---|---|
callback | (view: View) => boolean | Called for each child of type View. Iteration stops if this method returns falsy value. |
Returns
void
Inherited from
eachLayoutChild()
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
| Parameter | Type | Description |
|---|---|---|
callback | (child: View, isLast: boolean) => void | The callback |
Returns
void
Inherited from
ensureDomNode()
ensureDomNode(): void;Defined in: ui/core/view-base/index.ts
Returns
void
Unstable
Ensures a dom-node for this view.
Inherited from
focus()
focus(): boolean;Defined in: ui/core/view/index.d.ts:813
Tries to focus the view. Returns a value indicating whether this view or one of its descendants actually took focus.
Returns
boolean
Inherited from
get()
get(name: string): any;Defined in: data/observable/index.ts
Gets the value of the specified property.
Parameters
| Parameter | Type |
|---|---|
name | string |
Returns
any
Inherited from
getActualSize()
getActualSize(): Size;Defined in: ui/core/view/index.d.ts:909
Returns the actual size of the view in device-independent pixels.
Returns
Inherited from
getChildAt()
getChildAt(index: number): View;Defined in: ui/layouts/layout-base.d.ts:18
Returns the view at the specified position.
Parameters
| Parameter | Type | Description |
|---|---|---|
index | number | The position at which to get the child from. |
Returns
Inherited from
getChildIndex()
getChildIndex(child: View): number;Defined in: ui/layouts/layout-base.d.ts:24
Returns the position of the child view
Parameters
| Parameter | Type | Description |
|---|---|---|
child | View | The child view that we are looking for. |
Returns
number
Inherited from
getChildrenCount()
getChildrenCount(): number;Defined in: ui/layouts/layout-base.d.ts:12
Returns the number of children in this Layout.
Returns
number
Inherited from
getClosestWindow()
getClosestWindow(): Window;Defined in: ui/core/view/view-common.ts
(Android only) Gets closest window parent considering modals.
Returns
Window
Inherited from
getEffectivePaddingShorthand()
getEffectivePaddingShorthand(): string;Defined in: ui/core/view-base/index.ts
Returns
string
Inherited from
LayoutBase.getEffectivePaddingShorthand
getGestureObservers()
getGestureObservers(type: GestureTypes): GesturesObserver[];Defined in: ui/core/view/index.d.ts:815
Parameters
| Parameter | Type |
|---|---|
type | GestureTypes |
Returns
Inherited from
LayoutBase.getGestureObservers
getLocationInWindow()
getLocationInWindow(): Point;Defined in: ui/core/view/index.d.ts:894
Returns the location of this view in the window coordinate system.
Returns
Point
Inherited from
LayoutBase.getLocationInWindow
getLocationOnScreen()
getLocationOnScreen(): Point;Defined in: ui/core/view/index.d.ts:899
Returns the location of this view in the screen coordinate system.
Returns
Point
Inherited from
LayoutBase.getLocationOnScreen
getLocationRelativeTo()
getLocationRelativeTo(otherView: View): Point;Defined in: ui/core/view/index.d.ts:904
Returns the location of this view in the otherView's coordinate system.
Parameters
| Parameter | Type |
|---|---|
otherView | View |
Returns
Point
Inherited from
LayoutBase.getLocationRelativeTo
getMeasuredHeight()
getMeasuredHeight(): number;Defined in: ui/core/view/index.d.ts:741
Returns the raw height component.
Returns
number
Inherited from
getMeasuredState()
getMeasuredState(): number;Defined in: ui/core/view/index.d.ts:743
Returns
number
Inherited from
getMeasuredWidth()
getMeasuredWidth(): number;Defined in: ui/core/view/index.d.ts:736
Returns the raw width component.
Returns
number
Inherited from
getNativeWindow()
getNativeWindow(): NativeWindow;Defined in: ui/core/view/index.d.ts:980
The window currently hosting this view, or undefined when the view is not part of any window's view tree — including a view whose window has been closed.
Resolved on every call by walking up to the root view — through the presenting view of any modal on the way — so a view re-parented into another window's tree reports the window it moved to.
Returns
Inherited from
getSafeAreaInsets()
getSafeAreaInsets(): Position;Defined in: ui/core/view/index.d.ts:889
Returns the iOS safe area insets of this view.
Returns
Position
Inherited from
getViewByDomId()
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
| Parameter | Type |
|---|---|
domId | number |
Returns
T
Inherited from
getViewById()
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
| Parameter | Type |
|---|---|
id | string |
Returns
T
Inherited from
hasGestureObservers()?
optional hasGestureObservers(): boolean;Defined in: ui/core/view/index.d.ts:992
Android only check if gesture observers are attached
Returns
boolean
Inherited from
LayoutBase.hasGestureObservers
hasListeners()
hasListeners(eventName: string): boolean;Defined in: data/observable/index.ts
Checks whether a listener is registered for the specified event name.
Parameters
| Parameter | Type | Description |
|---|---|---|
eventName | string | The name of the event to check for. |
Returns
boolean
Inherited from
initNativeView()
initNativeView(): void;Defined in: ui/core/view-base/index.ts
Initializes properties/listeners of the native view.
Returns
void
Inherited from
insertChild()
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
| Parameter | Type | Description |
|---|---|---|
child | View | - |
atIndex | number | The insertion index. |
Returns
boolean
Inherited from
layout()
layout(
left: number,
top: number,
right: number,
bottom: number,
setFrame?: boolean): void;Defined in: ui/core/view/index.d.ts:731
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
| Parameter | Type |
|---|---|
left | number |
top | number |
right | number |
bottom | number |
setFrame? | boolean |
Returns
void
Inherited from
layoutNativeView()
layoutNativeView(
left: number,
top: number,
right: number,
bottom: number): void;Defined in: ui/core/view/index.d.ts:776
Called from onLayout when native view position is about to be changed.
Parameters
| Parameter | Type | Description |
|---|---|---|
left | number | Left position, relative to parent |
top | number | Top position, relative to parent |
right | number | Right position, relative to parent |
bottom | number | Bottom position, relative to parent |
Returns
void
Inherited from
loadView()
loadView(view: ViewBase): void;Defined in: ui/core/view-base/index.ts
Load view.
Parameters
| Parameter | Type | Description |
|---|---|---|
view | ViewBase | to load. |
Returns
void
Inherited from
measure()
measure(widthMeasureSpec: number, heightMeasureSpec: number): void;Defined in: ui/core/view/index.d.ts:720
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
| Parameter | Type | Description |
|---|---|---|
widthMeasureSpec | number | Horizontal space requirements as imposed by the parent |
heightMeasureSpec | number | Vertical space requirements as imposed by the parent |
Returns
void
Inherited from
notify()
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
| Parameter | Type | Description |
|---|---|---|
data | T | an 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
notifyPropertyChange()
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
| Parameter | Type |
|---|---|
name | string |
value | any |
oldValue? | any |
Returns
void
Inherited from
LayoutBase.notifyPropertyChange
off()
off(
eventName: string,
callback?: (args: EventData) => void,
thisArg?: any): any;Defined in: ui/core/view/index.d.ts:826
Removes the listener(s) for the specified event name.
Parameters
| Parameter | Type | Description |
|---|---|---|
eventName | string | The name of the event. |
callback? | (args: EventData) => void | An optional specific event listener to remove (if omitted, all event listeners by this name will be removed). |
thisArg? | any | An optional parameter which, when set, will be used to refine search of the correct event listener to be removed. |
Returns
any
Inherited from
on()
Call Signature
on(
eventName: string,
callback: (args: EventData) => void,
thisArg?: any): any;Defined in: ui/core/view/index.d.ts:838
Adds a listener for the specified event name.
Parameters
| Parameter | Type | Description |
|---|---|---|
eventName | string | The name of the event. |
callback | (args: EventData) => void | The event listener to add. Will be called when an event of the given name is raised. |
thisArg? | any | An 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
Call Signature
on(
event: "loaded",
callback: (args: EventData) => void,
thisArg?: any): any;Defined in: ui/core/view/index.d.ts:843
Raised when a loaded event occurs.
Parameters
| Parameter | Type |
|---|---|
event | "loaded" |
callback | (args: EventData) => void |
thisArg? | any |
Returns
any
Inherited from
Call Signature
on(
event: "unloaded",
callback: (args: EventData) => void,
thisArg?: any): any;Defined in: ui/core/view/index.d.ts:848
Raised when an unloaded event occurs.
Parameters
| Parameter | Type |
|---|---|
event | "unloaded" |
callback | (args: EventData) => void |
thisArg? | any |
Returns
any
Inherited from
Call Signature
on(
event: "androidBackPressed",
callback: (args: EventData) => void,
thisArg?: any): any;Defined in: ui/core/view/index.d.ts:854
Raised when a back button is pressed. This event is raised only for android.
Parameters
| Parameter | Type |
|---|---|
event | "androidBackPressed" |
callback | (args: EventData) => void |
thisArg? | any |
Returns
any
Inherited from
Call Signature
on(
event: "showingModally",
callback: (args: ShownModallyData) => void,
thisArg?: any): void;Defined in: ui/core/view/index.d.ts:859
Raised before the view is shown as a modal dialog.
Parameters
| Parameter | Type |
|---|---|
event | "showingModally" |
callback | (args: ShownModallyData) => void |
thisArg? | any |
Returns
void
Inherited from
Call Signature
on(
event: "shownModally",
callback: (args: ShownModallyData) => void,
thisArg?: any): any;Defined in: ui/core/view/index.d.ts:864
Raised after the view is shown as a modal dialog.
Parameters
| Parameter | Type |
|---|---|
event | "shownModally" |
callback | (args: ShownModallyData) => void |
thisArg? | any |
Returns
any
Inherited from
Call Signature
on(
event: "androidOverflowInset",
callback: (args: ShownModallyData) => void,
thisArg?: any): any;Defined in: ui/core/view/index.d.ts:869
Raised after the view is shown as a modal dialog.
Parameters
| Parameter | Type |
|---|---|
event | "androidOverflowInset" |
callback | (args: ShownModallyData) => void |
thisArg? | any |
Returns
any
Inherited from
onBackPressed()
onBackPressed(): boolean;Defined in: ui/core/view/index.d.ts:914
Derived classes can override this method to handle Android back button press.
Returns
boolean
Inherited from
once()
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
| Parameter | Type | Description |
|---|---|---|
eventName | string | The name of the event. |
callback | (data: EventData) => void | The event listener to add. Will be called when an event of the given name is raised. |
thisArg? | any | An 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
onLayout()
onLayout(
left: number,
top: number,
right: number,
bottom: number): void;Defined in: ui/core/view/index.d.ts:760
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
| Parameter | Type | Description |
|---|---|---|
left | number | Left position, relative to parent |
top | number | Top position, relative to parent |
right | number | Right position, relative to parent |
bottom | number | Bottom position, relative to parent |
Returns
void
Inherited from
onLoaded()
onLoaded(): void;Defined in: ui/core/view/view-common.ts
Returns
void
Inherited from
onMeasure()
onMeasure(widthMeasureSpec: number, heightMeasureSpec: number): void;Defined in: ui/core/view/index.d.ts:751
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
| Parameter | Type | Description |
|---|---|---|
widthMeasureSpec | number | horizontal space requirements as imposed by the parent. The requirements are encoded with View.MeasureSpec. |
heightMeasureSpec | number | vertical space requirements as imposed by the parent. The requirements are encoded with View.MeasureSpec. |
Returns
void
Inherited from
onResumeNativeUpdates()
onResumeNativeUpdates(): void;Defined in: ui/core/view-base/index.ts
Returns
void
Inherited from
LayoutBase.onResumeNativeUpdates
onUnloaded()
onUnloaded(): void;Defined in: ui/core/view-base/index.ts
Returns
void
Inherited from
removeChild()
removeChild(view: View): void;Defined in: ui/layouts/layout-base.d.ts:43
Removes the specified view from the children array.
Parameters
| Parameter | Type | Description |
|---|---|---|
view | View | The view to remove from the children array. |
Returns
void
Inherited from
removeChildren()
removeChildren(): void;Defined in: ui/layouts/layout-base.d.ts:48
Removes all views in this layout.
Returns
void
Inherited from
removeEventListener()
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
| Parameter | Type | Description |
|---|---|---|
eventNames | string | - |
callback? | (data: EventData) => void | An optional parameter pointing to a specific listener. If not defined, all listeners for the event names will be removed. |
thisArg? | any | An 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
LayoutBase.removeEventListener
requestLayout()
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
resetNativeView()
resetNativeView(): void;Defined in: ui/core/view/view-common.ts
Resets properties/listeners set to the native view.
Returns
void
Inherited from
sendAccessibilityEvent()
sendAccessibilityEvent(options: AccessibilityEventOptions): void;Defined in: ui/core/view/index.d.ts:1017
Send accessibility event
Parameters
| Parameter | Type |
|---|---|
options | AccessibilityEventOptions |
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
LayoutBase.sendAccessibilityEvent
set()
set(name: string, value: any): void;Defined in: ui/core/view-base/index.ts
Updates the specified property with the provided value.
Parameters
| Parameter | Type |
|---|---|
name | string |
value | any |
Returns
void
Inherited from
setAccessibilityIdentifier()
setAccessibilityIdentifier(view: any, value: string): void;Defined in: ui/core/view/view-common.ts
Parameters
| Parameter | Type |
|---|---|
view | any |
value | string |
Returns
void
Inherited from
LayoutBase.setAccessibilityIdentifier
setInlineStyle()
setInlineStyle(style: string): void;Defined in: ui/core/view-base/index.ts
Parameters
| Parameter | Type |
|---|---|
style | string |
Returns
void
Inherited from
setMeasuredDimension()
setMeasuredDimension(measuredWidth: number, measuredHeight: number): void;Defined in: ui/core/view/index.d.ts:767
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
| Parameter | Type | Description |
|---|---|---|
measuredWidth | number | The measured width of this view. May be a complex bit mask as defined by MEASURED_SIZE_MASK and MEASURED_STATE_TOO_SMALL. |
measuredHeight | number | The 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
LayoutBase.setMeasuredDimension
setNativeView()
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
| Parameter | Type |
|---|---|
value | any |
Returns
void
Inherited from
setOnTouchListener()?
optional setOnTouchListener(): void;Defined in: ui/core/view/index.d.ts:997
Android only to set the touch listener
Returns
void
Inherited from
setProperty()
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
| Parameter | Type |
|---|---|
name | string |
value | any |
Returns
void
Inherited from
showModal()
showModal(...args: any[]): View;Defined in: ui/core/view/view-common.ts
Shows the view passed as parameter as a modal view.
Parameters
| Parameter | Type |
|---|---|
...args | any[] |
Returns
Inherited from
toString()
toString(): string;Defined in: ui/core/view-base/index.ts
Returns a string representation of an object.
Returns
string
Inherited from
unbind()
unbind(property: string): void;Defined in: ui/core/view-base/index.ts
Parameters
| Parameter | Type |
|---|---|
property | string |
Returns
void
Inherited from
unloadView()
unloadView(view: ViewBase): void;Defined in: ui/core/view-base/index.ts
Unload view.
Parameters
| Parameter | Type | Description |
|---|---|---|
view | ViewBase | to unload. |
Returns
void
Inherited from
updateStatusBarStyle()
updateStatusBarStyle(value: "dark" | "light"): void;Defined in: ui/core/view/view-common.ts
Parameters
| Parameter | Type |
|---|---|
value | "dark" | "light" |
Returns
void
Inherited from
LayoutBase.updateStatusBarStyle
addEventListener()
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
| Parameter | Type |
|---|---|
eventName | string |
callback | (data: EventData) => void |
thisArg? | any |
once? | boolean |
Returns
void
Deprecated
Inherited from
combineMeasuredStates()
static combineMeasuredStates(curState: number, newState: any): number;Defined in: ui/core/view/index.d.ts:807
Parameters
| Parameter | Type |
|---|---|
curState | number |
newState | any |
Returns
number
Inherited from
LayoutBase.combineMeasuredStates
layoutChild()
static layoutChild(
parent: View,
child: View,
left: number,
top: number,
right: number,
bottom: number): void;Defined in: ui/core/view/index.d.ts:795
Layout a child by taking into account its margins, horizontal and vertical alignments and a given bounds.
Parameters
| Parameter | Type | Description |
|---|---|---|
parent | View | This parameter is not used. You can pass null. |
child | View | - |
left | number | Left position, relative to parent |
top | number | Top position, relative to parent |
right | number | Right position, relative to parent |
bottom | number | Bottom position, relative to parent |
Returns
void
Inherited from
measureChild()
static measureChild(
parent: View,
child: View,
widthMeasureSpec: number,
heightMeasureSpec: number): {
measuredHeight: number;
measuredWidth: number;
};Defined in: ui/core/view/index.d.ts:785
Measure a child by taking into account its margins and a given measureSpecs.
Parameters
| Parameter | Type | Description |
|---|---|---|
parent | View | This parameter is not used. You can pass null. |
child | View | The view to be measured. |
widthMeasureSpec | number | - |
heightMeasureSpec | number | - |
Returns
{
measuredHeight: number;
measuredWidth: number;
}measuredHeight
measuredHeight: number;measuredWidth
measuredWidth: number;Inherited from
off()
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
| Parameter | Type |
|---|---|
eventName | string |
callback? | (data: EventData) => void |
thisArg? | any |
Returns
void
Deprecated
Inherited from
on()
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
| Parameter | Type |
|---|---|
eventName | string |
callback | (data: EventData) => void |
thisArg? | any |
once? | boolean |
Returns
void
Deprecated
Inherited from
once()
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
| Parameter | Type |
|---|---|
eventName | string |
callback | (data: EventData) => void |
thisArg? | any |
Returns
void
Deprecated
Inherited from
removeEventListener()
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
| Parameter | Type |
|---|---|
eventName | string |
callback? | (data: EventData) => void |
thisArg? | any |
Returns
void
Deprecated
Inherited from
LayoutBase.removeEventListener
resolveSizeAndState()
static resolveSizeAndState(
size: number,
specSize: number,
specMode: number,
childMeasuredState: number): number;Defined in: ui/core/view/index.d.ts:805
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
| Parameter | Type |
|---|---|
size | number |
specSize | number |
specMode | number |
childMeasuredState | number |
Returns
number