Classes
SegmentedBarItem
Represents a SegmentedBar item.
Defined in: ui/segmented-bar/index.d.ts:13
Represents a SegmentedBar item.
Ns View
SegmentedBarItem
Extends
Constructors
Constructor
new SegmentedBarItem(): SegmentedBarItem;Defined in: ui/core/view-base/index.ts
Returns
SegmentedBarItem
Inherited from
Properties
_automaticallyAdjustsScrollViewInsets
_automaticallyAdjustsScrollViewInsets: boolean;Defined in: ui/core/view-base/index.ts
Inherited from
ViewBase._automaticallyAdjustsScrollViewInsets
_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
ViewBase._defaultPaddingBottom
_defaultPaddingLeft
protected _defaultPaddingLeft: number;Defined in: ui/core/view-base/index.ts
Inherited from
_defaultPaddingRight
protected _defaultPaddingRight: number;Defined in: ui/core/view-base/index.ts
Inherited from
_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
ViewBase._ignoreFlexMinWidthHeightReset
_isAddedToNativeVisualTree
_isAddedToNativeVisualTree: boolean;Defined in: ui/core/view-base/index.ts
Inherited from
ViewBase._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
_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
ViewBase._suspendNativeUpdatesCount
alignSelf
alignSelf: AlignSelf;Defined in: ui/core/view-base/index.ts
(Android-only) Overrides the alignItems value for the child.
Ns Property
Inherited from
bindingContext
bindingContext: any;Defined in: ui/core/view-base/index.ts
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
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
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
readonly cssClasses: Set<string>;Defined in: ui/core/view-base/index.ts
Inherited from
cssPseudoClasses
readonly cssPseudoClasses: Set<string>;Defined in: ui/core/view-base/index.ts
Inherited from
defaultVisualState
defaultVisualState: string;Defined in: ui/core/view-base/index.ts
Default visual state, defaults to 'normal'
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
ViewBase.effectiveBorderBottomWidth
effectiveBorderLeftWidth
effectiveBorderLeftWidth: number;Defined in: ui/core/view-base/index.ts
Inherited from
ViewBase.effectiveBorderLeftWidth
effectiveBorderRightWidth
effectiveBorderRightWidth: number;Defined in: ui/core/view-base/index.ts
Inherited from
ViewBase.effectiveBorderRightWidth
effectiveBorderTopWidth
effectiveBorderTopWidth: number;Defined in: ui/core/view-base/index.ts
Inherited from
ViewBase.effectiveBorderTopWidth
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
ViewBase.effectiveMarginBottom
effectiveMarginLeft
effectiveMarginLeft: number;Defined in: ui/core/view-base/index.ts
Inherited from
effectiveMarginRight
effectiveMarginRight: number;Defined in: ui/core/view-base/index.ts
Inherited from
effectiveMarginTop
effectiveMarginTop: 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
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
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
hidden
hidden: boolean;Defined in: ui/core/view-base/index.ts
Gets or sets the visual state of the view.
Ns Property
Inherited from
id
id: string;Defined in: ui/core/view-base/index.ts
Gets or sets the id for this view.
Ns Property
Inherited from
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
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
mIsRootView
mIsRootView: boolean;Defined in: ui/core/view-base/index.ts
if _setupAsRootView is called it means it is not supposed to be added to a parent. However parent can be set before for the purpose of CSS variables/classes. That variable ensures that _addViewToNativeVisualTree is not called in _setupAsRootView
Inherited from
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
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
parent
parent: ViewBase;Defined in: ui/core/view-base/index.ts
Gets the parent view. This property is read-only.
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
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
sharedTransitionIgnore
sharedTransitionIgnore: boolean;Defined in: ui/core/view-base/index.ts
Opt out of shared transition under different binding conditions
Ns Property
Inherited from
ViewBase.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
title
title: string;Defined in: ui/segmented-bar/index.d.ts:19
Gets or sets the title of the SegmentedBarItem.
Ns Property
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
viewController
viewController: any;Defined in: ui/core/view-base/index.ts
returns the native UIViewController.
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
ViewBase.disposeNativeViewEvent
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
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
android
Get Signature
get android(): any;Defined in: ui/core/view-base/index.ts
Returns
any
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
ViewBase.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
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
ViewBase.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
ios
Get Signature
get ios(): any;Defined in: ui/core/view-base/index.ts
Returns
any
Inherited from
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
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
ViewBase._addViewToNativeVisualTree
_addVisualState()
_addVisualState(state: string): void;Defined in: ui/core/view-base/index.ts
Parameters
| Parameter | Type |
|---|---|
state | string |
Returns
void
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
ViewBase._childIndexToNativeChildIndex
_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
ViewBase._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
_emit()
_emit(eventName: string): void;Defined in: data/observable/index.ts
Parameters
| Parameter | Type |
|---|---|
eventName | string |
Returns
void
Inherited from
_goToVisualState()
_goToVisualState(state: string): void;Defined in: ui/core/view-base/index.ts
Parameters
| Parameter | Type |
|---|---|
state | string |
Returns
void
Deprecated
Use View._addVisualState() and View._removeVisualState() instead.
Inherited from
_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
_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
_parentChanged()
_parentChanged(oldParent: ViewBase): void;Defined in: ui/core/view-base/index.ts
Parameters
| Parameter | Type |
|---|---|
oldParent | ViewBase |
Returns
void
Inherited from
_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
ViewBase._removeViewFromNativeVisualTree
_removeVisualState()
_removeVisualState(state: string): void;Defined in: ui/core/view-base/index.ts
Parameters
| Parameter | Type |
|---|---|
state | string |
Returns
void
Inherited from
_resumeNativeUpdates()
_resumeNativeUpdates(type: SuspendType): void;Defined in: ui/core/view-base/index.ts
Parameters
| Parameter | Type |
|---|---|
type | SuspendType |
Returns
void
Inherited from
_setDefaultPaddings()
_setDefaultPaddings(insets: any): void;Defined in: ui/core/view-base/index.ts
Parameters
| Parameter | Type |
|---|---|
insets | any |
Returns
void
Inherited from
_setupAsRootView()
_setupAsRootView(context: any): void;Defined in: ui/core/view-base/index.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
_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
_suspendNativeUpdates()
_suspendNativeUpdates(type: SuspendType): void;Defined in: ui/core/view-base/index.ts
Parameters
| Parameter | Type |
|---|---|
type | SuspendType |
Returns
void
Inherited from
ViewBase._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
addEventListener()
addEventListener(
eventName: string,
callback: (data: EventData) => void,
thisArg?: any,
once?: boolean): void;Defined in: data/observable/index.ts
Adds a listener for the specified event name.
Parameters
| Parameter | Type | Description |
|---|---|---|
eventName | string | Name of the event to attach to. |
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
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-base/index.ts
Closes the current modal view that this page is showing.
Parameters
| Parameter | Type |
|---|---|
...args | any[] |
Returns
void
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-base/index.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
ensureDomNode()
ensureDomNode(): void;Defined in: ui/core/view-base/index.ts
Returns
void
Unstable
Ensures a dom-node for this view.
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
getEffectivePaddingShorthand()
getEffectivePaddingShorthand(): string;Defined in: ui/core/view-base/index.ts
Returns
string
Inherited from
ViewBase.getEffectivePaddingShorthand
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
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
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
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
off()
off(
eventName: string,
callback?: (data: EventData) => void,
thisArg?: any): void;Defined in: data/observable/index.ts
Removes the listener(s) for the specified event name.
Parameters
| Parameter | Type | Description |
|---|---|---|
eventName | string | The name of the event. |
callback? | (data: 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
void
Inherited from
on()
on(
eventName: string,
callback: (data: EventData) => void,
thisArg?: any): void;Defined in: data/observable/index.ts
Adds a listener for the specified event name.
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
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
onLoaded()
onLoaded(): void;Defined in: ui/core/view-base/index.ts
Returns
void
Inherited from
onResumeNativeUpdates()
onResumeNativeUpdates(): void;Defined in: ui/core/view-base/index.ts
Returns
void
Inherited from
ViewBase.onResumeNativeUpdates
onUnloaded()
onUnloaded(): void;Defined in: ui/core/view-base/index.ts
Returns
void
Inherited from
removeEventListener()
removeEventListener(
eventName: string,
callback?: (data: EventData) => void,
thisArg?: any): void;Defined in: data/observable/index.ts
Removes listener(s) for the specified event name.
Parameters
| Parameter | Type | Description |
|---|---|---|
eventName | string | Name of the event to attach to. |
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
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-base/index.ts
Resets properties/listeners set to the native view.
Returns
void
Inherited from
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
setInlineStyle()
setInlineStyle(style: string): void;Defined in: ui/core/view-base/index.ts
Parameters
| Parameter | Type |
|---|---|
style | string |
Returns
void
Inherited from
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
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()
Call Signature
showModal(view: ViewBase, modalOptions?: ShowModalOptions): ViewBase;Defined in: ui/core/view-base/index.ts
Shows the view passed as parameter as a modal view.
Parameters
| Parameter | Type | Description |
|---|---|---|
view | ViewBase | View instance to be shown modally. |
modalOptions? | ShowModalOptions | A ShowModalOptions instance |
Returns
Inherited from
Call Signature
showModal(moduleName: string, modalOptions?: ShowModalOptions): ViewBase;Defined in: ui/core/view-base/index.ts
Shows the View contained in moduleName as a modal view.
Parameters
| Parameter | Type | Description |
|---|---|---|
moduleName | string | The name of the module to load starting from the application root. |
modalOptions? | ShowModalOptions | A ShowModalOptions instance |
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
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
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
- Previous
- SegmentedBar
- Next
- SharedTransition