ContainerView - API / NativeScript

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

Base class for all UI components that are containers.

Extends

View

Extended by

CustomLayoutView

Constructors

Constructor

new ContainerView(): ContainerView;

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

Returns

ContainerView

Inherited from

View.constructor

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

View._androidContentDescriptionUpdated

_automaticallyAdjustsScrollViewInsets

_automaticallyAdjustsScrollViewInsets: boolean;

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

Inherited from

View._automaticallyAdjustsScrollViewInsets

_closeModalCallback

protected _closeModalCallback: Function;

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

Inherited from

View._closeModalCallback

_context

_context: any;

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

Inherited from

View._context

_cssState

_cssState: CssState;

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

Inherited from

View._cssState

_defaultPaddingBottom

protected _defaultPaddingBottom: number;

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

Inherited from

View._defaultPaddingBottom

_defaultPaddingLeft

protected _defaultPaddingLeft: number;

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

Inherited from

View._defaultPaddingLeft

_defaultPaddingRight

protected _defaultPaddingRight: number;

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

Inherited from

View._defaultPaddingRight

_defaultPaddingTop

protected _defaultPaddingTop: number;

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

Inherited from

View._defaultPaddingTop

_domId

_domId: number;

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

Inherited from

View._domId

_ignoreFlexMinWidthHeightReset

_ignoreFlexMinWidthHeightReset: boolean;

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

Inherited from

View._ignoreFlexMinWidthHeightReset

_isAddedToNativeVisualTree

_isAddedToNativeVisualTree: boolean;

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

Inherited from

View._isAddedToNativeVisualTree

_isPaddingRelative

protected _isPaddingRelative: boolean;

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

Inherited from

View._isPaddingRelative

_isStyleScopeHost

_isStyleScopeHost: boolean;

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

Inherited from

View._isStyleScopeHost

_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

View._nativeWindow

_oldBottom

_oldBottom: number;

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

Inherited from

View._oldBottom

_oldLeft

_oldLeft: number;

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

Inherited from

View._oldLeft

_oldRight

_oldRight: number;

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

Inherited from

View._oldRight

_oldTop

_oldTop: number;

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

Inherited from

View._oldTop

_styleScope

_styleScope: StyleScope;

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

Inherited from

View._styleScope

_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

View._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

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

View.accessibilityHint

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

View.accessibilityIdentifier

accessibilityIgnoresInvertColors

accessibilityIgnoresInvertColors: boolean;

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

Ns Property

Inherited from

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

View.accessibilityLabel

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

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

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

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

View.accessibilityRole

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

View.accessibilityState

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

View.accessibilityValue

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

View.accessible

alignSelf

alignSelf: AlignSelf;

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

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

Ns Property

Inherited from

View.alignSelf

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

View.android

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

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

View.androidElevation

androidOverflowEdge

androidOverflowEdge: AndroidOverflow;

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

Inherited from

View.androidOverflowEdge

automationText

automationText: string;

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

Ns Property

Inherited from

View.automationText

background

background: string;

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

Gets or sets the background style property.

Ns Property

Inherited from

View.background

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

View.backgroundColor

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

View.backgroundImage

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

View.bindingContext

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

View.borderBottomColor

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

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

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

View.borderBottomWidth

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

View.borderColor

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

View.borderLeftColor

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

View.borderLeftWidth

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

View.borderRadius

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

View.borderRightColor

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

View.borderRightWidth

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

View.borderTopColor

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

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

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

View.borderTopWidth

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

View.borderWidth

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

View.boxShadow

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

View.className

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

View.col

color

color: Color;

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

Gets or sets the color of the view.

Ns Property

Inherited from

View.color

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

View.colSpan

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

View.column

columnSpan

columnSpan: number;

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

Ns Property

Inherited from

View.columnSpan

cssClasses

cssClasses: Set<string>;

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

Inherited from

View.cssClasses

cssPseudoClasses

cssPseudoClasses: Set<string>;

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

Inherited from

View.cssPseudoClasses

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

View.cssType

defaultVisualState

defaultVisualState: string;

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

Default visual state, defaults to 'normal'

Ns Property

Inherited from

View.defaultVisualState

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

View.direction

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

View.dock

domNode

domNode: DOMNode;

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

Inherited from

View.domNode

effectiveBorderBottomWidth

effectiveBorderBottomWidth: number;

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

Inherited from

View.effectiveBorderBottomWidth

effectiveBorderLeftWidth

effectiveBorderLeftWidth: number;

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

Inherited from

View.effectiveBorderLeftWidth

effectiveBorderRightWidth

effectiveBorderRightWidth: number;

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

Inherited from

View.effectiveBorderRightWidth

effectiveBorderTopWidth

effectiveBorderTopWidth: number;

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

Inherited from

View.effectiveBorderTopWidth

effectiveColumnGap

effectiveColumnGap: number;

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

Inherited from

View.effectiveColumnGap

effectiveHeight

effectiveHeight: number;

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

Inherited from

View.effectiveHeight

effectiveLeft

effectiveLeft: number;

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

Inherited from

View.effectiveLeft

effectiveMarginBottom

effectiveMarginBottom: number;

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

Inherited from

View.effectiveMarginBottom

effectiveMarginLeft

effectiveMarginLeft: number;

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

Inherited from

View.effectiveMarginLeft

effectiveMarginRight

effectiveMarginRight: number;

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

Inherited from

View.effectiveMarginRight

effectiveMarginTop

effectiveMarginTop: number;

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

Inherited from

View.effectiveMarginTop

effectiveMaxHeight

effectiveMaxHeight: number;

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

Inherited from

View.effectiveMaxHeight

effectiveMaxWidth

effectiveMaxWidth: number;

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

Inherited from

View.effectiveMaxWidth

effectiveMinHeight

effectiveMinHeight: number;

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

Inherited from

View.effectiveMinHeight

effectiveMinWidth

effectiveMinWidth: number;

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

Inherited from

View.effectiveMinWidth

effectiveRowGap

effectiveRowGap: number;

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

Inherited from

View.effectiveRowGap

effectiveTop

effectiveTop: number;

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

Inherited from

View.effectiveTop

effectiveWidth

effectiveWidth: number;

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

Inherited from

View.effectiveWidth

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

View.flex

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

View.flexFlow

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

View.flexGrow

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

View.flexShrink

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

View.flexWrapBefore

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

View.height

hidden

hidden: boolean;

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

Gets or sets the visual state of the view.

Ns Property

Inherited from

View.hidden

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

View.horizontalAlignment

id

id: string;

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

Gets or sets the id for this view.

Ns Property

Inherited from

View.id

ignoreTouchAnimation

ignoreTouchAnimation: boolean;

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

Ns Property

Inherited from

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

View.ios

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

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

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

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

View.iosGlassEffect

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

View.iosIgnoreSafeArea

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

Overrides

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

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

View.isCollapsed

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

View.isEnabled

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

View.isLayoutValid

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

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

View.left

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

View.margin

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

View.marginBottom

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

View.marginLeft

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

View.marginRight

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

View.marginTop

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

View.maxHeight

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

View.maxWidth

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

View.minHeight

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

View.minWidth

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

View.modal

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

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

View.nativeViewProtected

opacity

opacity: number;

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

Gets or sets the opacity style property.

Ns Property

Inherited from

View.opacity

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

View.order

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

View.originX

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

View.originY

parent

parent: ViewBase;

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

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

Inherited from

View.parent

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

View.perspective

recycleNativeView

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

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

Inherited from

View.recycleNativeView

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

View.reusable

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

View.rotate

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

View.rotateX

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

View.rotateY

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

View.row

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

View.rowSpan

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

View.scaleX

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

View.scaleY

sharedTransitionIgnore

sharedTransitionIgnore: boolean;

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

Opt out of shared transition under different binding conditions

Ns Property

Inherited from

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

View.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 UIViewControllerBasedStatusBarAppearance It 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

View.statusBarStyle

testID

testID: string;

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

Ns Property

Inherited from

View.testID

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

View.top

touchAnimation

touchAnimation: 
  | boolean
  | TouchAnimationOptions;

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

Ns Property

Inherited from

View.touchAnimation

touchDelay

touchDelay: number;

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

Ns Property

Inherited from

View.touchDelay

transitionId

transitionId: number;

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

Active transition instance id for tracking state

Inherited from

View.transitionId

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

View.translateX

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

View.translateY

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

View.verticalAlignment

viewController

viewController: any;

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

returns the native UIViewController.

Inherited from

View.viewController

visibility

visibility: VisibilityType;

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

Gets or sets the visibility of the view.

Ns Property

Inherited from

View.visibility

visionHoverStyle

visionHoverStyle: string | VisionHoverOptions;

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

visionOS only

Ns Property

Inherited from

View.visionHoverStyle

visionIgnoreHoverStyle

visionIgnoreHoverStyle: boolean;

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

visionOS only

Ns Property

Inherited from

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

View.width

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

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

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

View.accessibilityFocusEvent

accessibilityPerformEscapeEvent

static accessibilityPerformEscapeEvent: string;

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

Inherited from

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

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

View.closedModallyEvent

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

View.createdEvent

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

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

View.layoutChangedEvent

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

View.loadedEvent

propertyChangeEvent

static propertyChangeEvent: string;

Defined in: data/observable/index.ts

String value used when hooking to propertyChange event.

Ns Event

propertyChange

Inherited from

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

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

View.shownModallyEvent

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

View.unloadedEvent

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

View.backgroundPosition

backgroundRepeat

Get Signature

get backgroundRepeat(): BackgroundRepeatType;

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

Returns

BackgroundRepeatType

Set Signature

set backgroundRepeat(value: BackgroundRepeatType): void;

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

Parameters

Parameter	Type
`value`	`BackgroundRepeatType`

Returns

void

Inherited from

View.backgroundRepeat

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

View.backgroundSize

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

View.class

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

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

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

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

View.effectivePaddingTop

isLoaded

Get Signature

get isLoaded(): boolean;

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

Returns

boolean

Inherited from

View.isLoaded

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

View.nativeView

page

Get Signature

get page(): Page;

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

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

Returns

Page

Inherited from

View.page

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

ViewBase

Set Signature

set parentNode(node: ViewBase): void;

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

Parameters

Parameter	Type
`node`	`ViewBase`

Returns

void

Inherited from

View.parentNode

style

Get Signature

get style(): Style;

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

Gets the style object associated to this view.

Returns

Style

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

View.style

textTransform

Get Signature

get textTransform(): TextTransformType;

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

Returns

TextTransformType

Set Signature

set textTransform(value: TextTransformType): void;

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

Parameters

Parameter	Type
`value`	`TextTransformType`

Returns

void

Inherited from

View.textTransform

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

View.typeName

visualState

Get Signature

get visualState(): string;

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

Deprecated

Returns

string

Inherited from

View.visualState

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

View._addView

_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

View._addViewCore

_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

View._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

View._applyGlassEffect

_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

View._applyXmlAttribute

_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

View._batchUpdate

_childIndexToNativeChildIndex()

_childIndexToNativeChildIndex(index?: number): number;

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

Parameters

Parameter	Type
`index?`	`number`

Returns

number

Inherited from

View._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

View._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

PropertyChangeData

Inherited from

View._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

View._dialogClosed

_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

View._eachLayoutView

_emit()

_emit(eventName: string): void;

Defined in: data/observable/index.ts

Parameters

Parameter	Type
`eventName`	`string`

Returns

void

Inherited from

View._emit

_getNativeViewsCount()

_getNativeViewsCount(): number;

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

Returns

number

Inherited from

View._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

ViewBase

Inherited from

View._getRootModalHost

_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

View._getRootModalViews

_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

View._getValue

_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

View._handleLivesync

_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

View._hasAncestorView

_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

View._hideNativeModalView

_inheritStyles()

_inheritStyles(view: ViewBase): void;

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

Parameters

Parameter	Type
`view`	`ViewBase`

Returns

void

Inherited from

View._inheritStyles

_inheritStyleScope()

_inheritStyleScope(styleScope: StyleScope): void;

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

Parameters

Parameter	Type
`styleScope`	`StyleScope`

Returns

void

Inherited from

View._inheritStyleScope

_layoutParent()

_layoutParent(): void;

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

Returns

void

Inherited from

View._layoutParent

_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

View._observe

_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

View._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

View._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

View._onRootViewReset

_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

View._onSizeChanged

_parentChanged()

_parentChanged(oldParent: ViewBase): void;

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

Parameters

Parameter	Type
`oldParent`	`ViewBase`

Returns

void

Inherited from

View._parentChanged

_raiseLayoutChangedEvent()

protected _raiseLayoutChangedEvent(): void;

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

Returns

void

Inherited from

View._raiseLayoutChangedEvent

_raiseShowingModallyEvent()

protected _raiseShowingModallyEvent(): void;

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

Returns

void

Inherited from

View._raiseShowingModallyEvent

_raiseShownModallyEvent()

protected _raiseShownModallyEvent(): void;

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

Returns

void

Inherited from

View._raiseShownModallyEvent

_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

View._removeView

_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

View._removeViewCore

_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

View._removeViewFromNativeVisualTree

_resumeNativeUpdates()

_resumeNativeUpdates(type: SuspendType): void;

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

Parameters

Parameter	Type
`type`	`SuspendType`

Returns

void

Inherited from

View._resumeNativeUpdates

_setDefaultPaddings()

_setDefaultPaddings(insets: any): void;

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

Parameters

Parameter	Type
`insets`	`any`

Returns

void

Inherited from

View._setDefaultPaddings

_setupAsRootView()

_setupAsRootView(context: any): void;

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

Parameters

Parameter	Type
`context`	`any`

Returns

void

Inherited from

View._setupAsRootView

_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

View._setupUI

_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

View._setValue

_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

View._shouldDelayLayout

_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

View._showNativeModalView

_suspendNativeUpdates()

_suspendNativeUpdates(type: SuspendType): void;

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

Parameters

Parameter	Type
`type`	`SuspendType`

Returns

void

Inherited from

View._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

View._tearDownUI

_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

View._updateStyleScope

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

View.accessibilityAnnouncement

accessibilityScreenChanged()

accessibilityScreenChanged(): void;

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

Announce screen changed

Returns

void

Inherited from

View.accessibilityScreenChanged

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

View.addEventListener

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

View.addPseudoClass

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

AnimationPromise

Inherited from

View.animate

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

View.bind

callLoaded()

callLoaded(): void;

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

Returns

void

Inherited from

View.callLoaded

callUnloaded()

callUnloaded(): void;

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

Returns

void

Inherited from

View.callUnloaded

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

View.closeModal

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

Animation

Inherited from

View.createAnimation

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

View.createNativeView

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

View.deletePseudoClass

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

View.destroyNode

disposeNativeView()

disposeNativeView(): void;

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

Clean up references to the native view.

Returns

void

Inherited from

View.disposeNativeView

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

View.eachChild

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

View.eachChildView

ensureDomNode()

ensureDomNode(): void;

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

Returns

void

Unstable

Ensures a dom-node for this view.

Inherited from

View.ensureDomNode

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

View.focus

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

View.get

getActualSize()

getActualSize(): Size;

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

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

Returns

Size

Inherited from

View.getActualSize

getClosestWindow()

getClosestWindow(): Window;

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

(Android only) Gets closest window parent considering modals.

Returns

Window

Inherited from

View.getClosestWindow

getEffectivePaddingShorthand()

getEffectivePaddingShorthand(): string;

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

Returns

string

Inherited from

View.getEffectivePaddingShorthand

getGestureObservers()

getGestureObservers(type: GestureTypes): GesturesObserver[];

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

Parameters

Parameter	Type
`type`	`GestureTypes`

Returns

GesturesObserver[]

Inherited from

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

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

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

View.getLocationRelativeTo

getMeasuredHeight()

getMeasuredHeight(): number;

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

Returns the raw height component.

Returns

number

Inherited from

View.getMeasuredHeight

getMeasuredState()

getMeasuredState(): number;

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

Returns

number

Inherited from

View.getMeasuredState

getMeasuredWidth()

getMeasuredWidth(): number;

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

Returns the raw width component.

Returns

number

Inherited from

View.getMeasuredWidth

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

NativeWindow

Inherited from

View.getNativeWindow

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

View.getSafeAreaInsets

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

View.getViewByDomId

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

View.getViewById

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

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

View.hasListeners

initNativeView()

initNativeView(): void;

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

Initializes properties/listeners of the native view.

Returns

void

Inherited from

View.initNativeView

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

View.layout

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

View.layoutNativeView

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

View.loadView

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

View.measure

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

View.notify

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

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

View.off

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

View.on

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

View.on

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

View.on

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

View.on

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

View.on

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

View.on

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

View.on

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

View.onBackPressed

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

View.once

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

View.onLayout

onLoaded()

onLoaded(): void;

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

Returns

void

Inherited from

View.onLoaded

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

View.onMeasure

onResumeNativeUpdates()

onResumeNativeUpdates(): void;

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

Returns

void

Inherited from

View.onResumeNativeUpdates

onUnloaded()

onUnloaded(): void;

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

Returns

void

Inherited from

View.onUnloaded

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

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

View.requestLayout

resetNativeView()

resetNativeView(): void;

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

Resets properties/listeners set to the native view.

Returns

void

Inherited from

View.resetNativeView

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

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

View.set

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

View.setAccessibilityIdentifier

setInlineStyle()

setInlineStyle(style: string): void;

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

Parameters

Parameter	Type
`style`	`string`

Returns

void

Inherited from

View.setInlineStyle

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

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

View.setNativeView

setOnTouchListener()?

optional setOnTouchListener(): void;

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

Android only to set the touch listener

Returns

void

Inherited from

View.setOnTouchListener

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

View.setProperty

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

View

Inherited from

View.showModal

toString()

toString(): string;

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

Returns a string representation of an object.

Returns

string

Inherited from

View.toString

unbind()

unbind(property: string): void;

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

Parameters

Parameter	Type
`property`	`string`

Returns

void

Inherited from

View.unbind

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

View.unloadView

updateStatusBarStyle()

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

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

Parameters

Parameter	Type
`value`	`"dark"` \| `"light"`

Returns

void

Inherited from

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

View.addEventListener

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

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

View.layoutChild

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

View.measureChild

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

View.off

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

View.on

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

View.once

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

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

Inherited from

View.resolveSizeAndState

Extends ​

Extended by ​

Constructors ​

Constructor ​

Returns ​

Inherited from ​

Properties ​

_androidContentDescriptionUpdated? ​

Inherited from ​

_automaticallyAdjustsScrollViewInsets ​

Inherited from ​

_closeModalCallback ​

Inherited from ​

_context ​

Inherited from ​

_cssState ​

Inherited from ​

_defaultPaddingBottom ​

Inherited from ​

_defaultPaddingLeft ​

Inherited from ​

_defaultPaddingRight ​

Inherited from ​

_defaultPaddingTop ​

Inherited from ​

_domId ​

Inherited from ​

_ignoreFlexMinWidthHeightReset ​

Inherited from ​

_isAddedToNativeVisualTree ​

Inherited from ​

_isPaddingRelative ​

Inherited from ​

_isStyleScopeHost ​

Inherited from ​

_nativeWindow? ​

Inherited from ​

_oldBottom ​

Inherited from ​

_oldLeft ​

Inherited from ​

_oldRight ​

Inherited from ​

_oldTop ​

Inherited from ​

_styleScope ​

Inherited from ​

_suspendNativeUpdatesCount ​

Inherited from ​

accessibilityHidden ​

Ns Property ​

Inherited from ​

accessibilityHint ​

Ns Property ​

Inherited from ​

accessibilityIdentifier ​

Ns Property ​

Inherited from ​

accessibilityIgnoresInvertColors ​

Ns Property ​

Inherited from ​

accessibilityLabel ​

Ns Property ​

Inherited from ​

accessibilityLanguage ​

Ns Property ​

Inherited from ​

accessibilityLiveRegion ​

Ns Property ​

Inherited from ​

accessibilityMediaSession ​

Ns Property ​

Inherited from ​

accessibilityRole ​

Ns Property ​

Inherited from ​

accessibilityState ​

Ns Property ​

Inherited from ​

accessibilityValue ​

Extends

Extended by

Constructors

Constructor

Returns

Inherited from

Properties

_androidContentDescriptionUpdated?

Inherited from

_automaticallyAdjustsScrollViewInsets

Inherited from

_closeModalCallback

Inherited from

_context

Inherited from

_cssState

Inherited from

_defaultPaddingBottom

Inherited from

_defaultPaddingLeft

Inherited from

_defaultPaddingRight

Inherited from

_defaultPaddingTop

Inherited from

_domId

Inherited from

_ignoreFlexMinWidthHeightReset

Inherited from

_isAddedToNativeVisualTree

Inherited from

_isPaddingRelative

Inherited from

_isStyleScopeHost

Inherited from

_nativeWindow?

Inherited from

_oldBottom

Inherited from

_oldLeft

Inherited from

_oldRight

Inherited from

_oldTop

Inherited from

_styleScope

Inherited from

_suspendNativeUpdatesCount

Inherited from

accessibilityHidden

Ns Property

Inherited from

accessibilityHint

Ns Property

Inherited from

accessibilityIdentifier

Ns Property

Inherited from

accessibilityIgnoresInvertColors

Ns Property

Inherited from

accessibilityLabel

Ns Property

Inherited from

accessibilityLanguage

Ns Property

Inherited from

accessibilityLiveRegion

Ns Property

Inherited from

accessibilityMediaSession

Ns Property

Inherited from

accessibilityRole

Ns Property

Inherited from

accessibilityState

Ns Property

Inherited from

accessibilityValue