API Index | API - NativeScript

Summary

References

sanitizeModuleName

Namespaces

Functions

References

Type Aliases

GridUnitType

GridUnitType: "pixel" | "star" | "auto"

defined in @nativescript/core/ui/layouts/grid-layout/index.d.ts:175:12

defined in @nativescript/core/ui/layouts/grid-layout/index.d.ts:176:17

Headers

Headers: {}

defined in @nativescript/core/http/index.d.ts:127:12

HorizontalAlignment

HorizontalAlignment: HorizontalAlignmentType

defined in @nativescript/core/core-types/index.d.ts:285:12

InstrumentationMode

InstrumentationMode: "counters" | "timeline" | "lifecycle"

defined in @nativescript/core/profiling/index.d.ts:17:5

Profiling mode to use. - `counters` Accumulates method call counts and times until dumpProfiles is called and then prints aggregated statistic in the console. This is the default. - `timeline` Outputs method names along start/end timestamps in the console on the go. - `lifecycle` Outputs basic non-verbose times for startup, navigation, etc.

LengthDipUnit

LengthDipUnit: LengthDipUnit

defined in @nativescript/core/core-types/index.d.ts:261:12

LengthPercentUnit

LengthPercentUnit: LengthPercentUnit

defined in @nativescript/core/core-types/index.d.ts:269:12

LengthPxUnit

LengthPxUnit: LengthPxUnit

defined in @nativescript/core/core-types/index.d.ts:265:12

LengthType

LengthType: LengthType

defined in @nativescript/core/core-types/index.d.ts:273:12

ModuleListProvider

ModuleListProvider: () => string[]

defined in @nativescript/core/module-name-resolver/index.d.ts:9:12

PercentLengthType

PercentLengthType: PercentLengthType

defined in @nativescript/core/core-types/index.d.ts:277:12

SharedTransitionTagProperties

SharedTransitionTagProperties: SharedProperties & {
callback?: (view: View, action: SharedTransitionEventAction) => Promise<void>;
propertiesToMatch?: SharedTransitionTagPropertiesToMatch;
}

defined in @nativescript/core/ui/transition/shared-transition.d.ts:37:12

Properties which can be set on individual Shared Elements

TouchAnimationOptions

TouchAnimationOptions: {
  down?: TouchAnimationFn | AnimationDefinition
}

defined in @nativescript/core/ui/gestures/touch-manager.d.ts:5:12

VerticalAlignment

VerticalAlignment: VerticalAlignmentType

defined in @nativescript/core/core-types/index.d.ts:289:12

WebViewNavigationType

WebViewNavigationType: "linkClicked" | "formSubmitted" | "backForward" | "reload" | "formResubmitted" | "other" | undefined

defined in @nativescript/core/ui/web-view/index.d.ts:17:12

Represents navigation type

dip

dip: number

defined in @nativescript/core/core-types/index.d.ts:249:12

percent

percent: number

defined in @nativescript/core/core-types/index.d.ts:257:12

px

px: number

defined in @nativescript/core/core-types/index.d.ts:253:12

Variables

AnimationCurve

AnimationCurve: typeof AnimationCurve

defined in @nativescript/core/core-types/index.d.ts:281:21

Application

Application: ApplicationCommon

defined in @nativescript/core/application/application.d.ts:6:13

CSSHelper

CSSHelper: {
  AttributeSelector: typeof AttributeSelector
  ClassSelector: typeof ClassSelector
  InvalidSelector: typeof InvalidSelector
  PseudoClassSelector: typeof PseudoClassSelector
  RuleSet: typeof RuleSet
  Selector: typeof Selector
  SelectorCore: typeof SelectorCore
  SelectorsMap: typeof SelectorsMap
  SelectorsMatch: typeof SelectorsMatch
  SimpleSelector: typeof SimpleSelector
  SimpleSelectorSequence: typeof SimpleSelectorSequence
  TypeSelector: typeof TypeSelector
  UniversalSelector: typeof UniversalSelector
  createSelector: typeof createSelector
}

defined in @nativescript/core/ui/styling/css-selector.d.ts:197:21

Device

Device: IDevice

defined in @nativescript/core/platform/index.d.ts:134:13

Gets the current device information.

Dialogs

Dialogs: {
action: typeof action;
alert: typeof alert;
confirm: typeof confirm;
login: typeof login;
}

defined in @nativescript/core/ui/dialogs/index.d.ts:305:21

Singular rollup for convenience of all dialog methods

Enums

Enums: {
Accuracy: typeof Accuracy;
AndroidActionBarIconVisibility: typeof AndroidActionBarIconVisibility;
AndroidActionItemPosition: typeof AndroidActionItemPosition;
AnimationCurve: typeof AnimationCurve;
AutocapitalizationType: typeof AutocapitalizationType;
BackgroundRepeat: typeof BackgroundRepeat;
DeviceOrientation: typeof DeviceOrientation;
DeviceType: typeof DeviceType;
Dock: typeof Dock;
FontAttributes: typeof FontAttributes;
FontStyle: typeof FontStyle;
FontWeight: typeof FontWeight;
HorizontalAlignment: typeof HorizontalAlignment;
IOSActionItemPosition: typeof IOSActionItemPosition;
ImageFormat: typeof ImageFormat;
KeyboardType: typeof KeyboardType;
NavigationBarVisibility: typeof NavigationBarVisibility;
Orientation: typeof Orientation;
ReturnKeyType: typeof ReturnKeyType;
StatusBarStyle: typeof StatusBarStyle;
Stretch: typeof ImageStretch;
SystemAppearance: typeof SystemAppearance;
TextAlignment: typeof TextAlignment;
TextDecoration: typeof TextDecoration;
TextTransform: typeof TextTransform;
UpdateTextTrigger: typeof UpdateTextTrigger;
VerticalAlignment: typeof VerticalAlignment;
Visibility: typeof Visibility;
}

defined in @nativescript/core/core-types/index.d.ts:293:21

_resetRootView

_resetRootView: any

defined in @nativescript/core/application/application-shims.d.ts:135:21

addCss

addCss: any

defined in @nativescript/core/application/application-shims.d.ts:9:21

android

android: AndroidApplication

defined in @nativescript/core/application/application-shims.d.ts:342:21

androidDynamicElevationOffsetProperty

androidDynamicElevationOffsetProperty: CssProperty<Style, number>

defined in @nativescript/core/ui/styling/style-properties.d.ts:106:13

androidElevationProperty

androidElevationProperty: CssProperty<Style, number>

defined in @nativescript/core/ui/styling/style-properties.d.ts:105:13

autocapitalizationTypeProperty

autocapitalizationTypeProperty: Property<EditableTextBase, AutocapitalizationInputType>

defined in @nativescript/core/ui/editable-text-base/index.d.ts:89:13

autocorrectProperty

autocorrectProperty: Property<EditableTextBase, boolean>

defined in @nativescript/core/ui/editable-text-base/index.d.ts:90:13

backgroundColorProperty

backgroundColorProperty: CssAnimationProperty<Style, Color>

defined in @nativescript/core/ui/styling/style-properties.d.ts:48:13

backgroundEvent

backgroundEvent: "background" = "background"

defined in @nativescript/core/application/application-shims.d.ts:306:21

backgroundImageProperty

backgroundImageProperty: CssProperty<Style, string>

defined in @nativescript/core/ui/styling/style-properties.d.ts:49:13

backgroundInternalProperty

backgroundInternalProperty: CssProperty<Style, Background>

defined in @nativescript/core/ui/styling/style-properties.d.ts:101:13

backgroundPositionProperty

backgroundPositionProperty: CssProperty<Style, string>

defined in @nativescript/core/ui/styling/style-properties.d.ts:52:13

backgroundProperty

backgroundProperty: ShorthandProperty<Style, string>

defined in @nativescript/core/ui/styling/style-properties.d.ts:47:13

backgroundRepeatProperty

backgroundRepeatProperty: CssProperty<Style, BackgroundRepeatType>

defined in @nativescript/core/ui/styling/style-properties.d.ts:50:13

backgroundSizeProperty

backgroundSizeProperty: CssProperty<Style, string>

defined in @nativescript/core/ui/styling/style-properties.d.ts:51:13

borderBottomColorProperty

borderBottomColorProperty: CssProperty<Style, Color>

defined in @nativescript/core/ui/styling/style-properties.d.ts:57:13

borderBottomLeftRadiusProperty

borderBottomLeftRadiusProperty: CssProperty<Style, LengthType>

defined in @nativescript/core/ui/styling/style-properties.d.ts:70:13

borderBottomRightRadiusProperty

borderBottomRightRadiusProperty: CssProperty<Style, LengthType>

defined in @nativescript/core/ui/styling/style-properties.d.ts:69:13

borderBottomWidthProperty

borderBottomWidthProperty: CssProperty<Style, LengthType>

defined in @nativescript/core/ui/styling/style-properties.d.ts:63:13

borderColorProperty

borderColorProperty: ShorthandProperty<Style, string | Color>

defined in @nativescript/core/ui/styling/style-properties.d.ts:54:13

borderLeftColorProperty

borderLeftColorProperty: CssProperty<Style, Color>

defined in @nativescript/core/ui/styling/style-properties.d.ts:58:13

borderLeftWidthProperty

borderLeftWidthProperty: CssProperty<Style, LengthType>

defined in @nativescript/core/ui/styling/style-properties.d.ts:64:13

borderRadiusProperty

borderRadiusProperty: ShorthandProperty<Style, string | LengthType>

defined in @nativescript/core/ui/styling/style-properties.d.ts:66:13

borderRightColorProperty

borderRightColorProperty: CssProperty<Style, Color>

defined in @nativescript/core/ui/styling/style-properties.d.ts:56:13

borderRightWidthProperty

borderRightWidthProperty: CssProperty<Style, LengthType>

defined in @nativescript/core/ui/styling/style-properties.d.ts:62:13

borderTopColorProperty

borderTopColorProperty: CssProperty<Style, Color>

defined in @nativescript/core/ui/styling/style-properties.d.ts:55:13

borderTopLeftRadiusProperty

borderTopLeftRadiusProperty: CssProperty<Style, LengthType>

defined in @nativescript/core/ui/styling/style-properties.d.ts:67:13

borderTopRightRadiusProperty

borderTopRightRadiusProperty: CssProperty<Style, LengthType>

defined in @nativescript/core/ui/styling/style-properties.d.ts:68:13

borderTopWidthProperty

borderTopWidthProperty: CssProperty<Style, LengthType>

defined in @nativescript/core/ui/styling/style-properties.d.ts:61:13

borderWidthProperty

borderWidthProperty: ShorthandProperty<Style, string | LengthType>

defined in @nativescript/core/ui/styling/style-properties.d.ts:60:13

clipPathProperty

clipPathProperty: CssProperty<Style, string>

defined in @nativescript/core/ui/styling/style-properties.d.ts:44:13

colorProperty

colorProperty: InheritedCssProperty<Style, Color>

defined in @nativescript/core/ui/styling/style-properties.d.ts:45:13

discardedErrorEvent

discardedErrorEvent: "discardedError" = "discardedError"

defined in @nativescript/core/application/application-shims.d.ts:207:21

displayedEvent

displayedEvent: "displayed" = "displayed"

defined in @nativescript/core/application/application-shims.d.ts:225:21

editableProperty

editableProperty: Property<EditableTextBase, boolean>

defined in @nativescript/core/ui/editable-text-base/index.d.ts:87:13

exitEvent

exitEvent: "exit" = "exit"

defined in @nativescript/core/application/application-shims.d.ts:234:21

fontFamilyProperty

fontFamilyProperty: InheritedCssProperty<Style, string>

defined in @nativescript/core/ui/styling/style-properties.d.ts:97:13

fontInternalProperty

fontInternalProperty: InheritedCssProperty<Style, Font>

defined in @nativescript/core/ui/styling/style-properties.d.ts:102:13

fontScaleChangedEvent

fontScaleChangedEvent: "fontScaleChanged" = "fontScaleChanged"

defined in @nativescript/core/application/application-shims.d.ts:243:21

fontScaleInternalProperty

fontScaleInternalProperty: InheritedCssProperty<Style, number>

defined in @nativescript/core/ui/styling/style-properties.d.ts:103:13

fontSizeProperty

fontSizeProperty: InheritedCssProperty<Style, number>

defined in @nativescript/core/ui/styling/style-properties.d.ts:96:13

fontStyleProperty

fontStyleProperty: InheritedCssProperty<Style, FontStyleType>

defined in @nativescript/core/ui/styling/style-properties.d.ts:98:13

fontWeightProperty

fontWeightProperty: InheritedCssProperty<Style, FontWeightType>

defined in @nativescript/core/ui/styling/style-properties.d.ts:99:13

foregroundEvent

foregroundEvent: "foreground" = "foreground"

defined in @nativescript/core/application/application-shims.d.ts:315:21

getCssFileName

getCssFileName: any

defined in @nativescript/core/application/application-shims.d.ts:18:21

getMainEntry

getMainEntry: any

defined in @nativescript/core/application/application-shims.d.ts:27:21

getNativeApplication

getNativeApplication: any

defined in @nativescript/core/application/application-shims.d.ts:36:21

getResources

getResources: any

defined in @nativescript/core/application/application-shims.d.ts:45:21

getRootView

getRootView: any

defined in @nativescript/core/application/application-shims.d.ts:54:21

hasLaunched

hasLaunched: any

defined in @nativescript/core/application/application-shims.d.ts:63:21

hasListeners

hasListeners: any

defined in @nativescript/core/application/application-shims.d.ts:72:21

heightProperty

heightProperty: CssAnimationProperty<Style, PercentLengthType>

defined in @nativescript/core/ui/styling/style-properties.d.ts:79:13

hintProperty

hintProperty: Property<EditableTextBase, string>

defined in @nativescript/core/ui/editable-text-base/index.d.ts:91:13

horizontalAlignmentProperty

horizontalAlignmentProperty: CssProperty<Style, HorizontalAlignmentType>

defined in @nativescript/core/ui/styling/style-properties.d.ts:93:13

inBackground

inBackground: boolean

defined in @nativescript/core/application/application-shims.d.ts:324:21

ios

ios: iOSApplication

defined in @nativescript/core/application/application-shims.d.ts:351:21

isAndroid

isAndroid: boolean

defined in @nativescript/core/platform/index.d.ts:10:13

Gets a value indicating if the app is running on the Android platform.

isIOS

isIOS: boolean

defined in @nativescript/core/platform/index.d.ts:15:13

Gets a value indicating if the app is running on the iOS platform.

isUserInteractionEnabledProperty

isUserInteractionEnabledProperty: Property<View, boolean>

defined in @nativescript/core/ui/core/view/index.d.ts:988:13

keyboardTypeProperty

keyboardTypeProperty: Property<EditableTextBase, KeyboardInputType>

defined in @nativescript/core/ui/editable-text-base/index.d.ts:85:13

launchEvent

launchEvent: "launch" = "launch"

defined in @nativescript/core/application/application-shims.d.ts:252:21

letterSpacingProperty

letterSpacingProperty: CssProperty<Style, number>

defined in @nativescript/core/ui/text-base/index.d.ts:137:13

lineHeightProperty

lineHeightProperty: CssProperty<Style, number>

defined in @nativescript/core/ui/text-base/index.d.ts:138:13

loadAppCss

loadAppCss: any

defined in @nativescript/core/application/application-shims.d.ts:81:21

lowMemoryEvent

lowMemoryEvent: "lowMemory" = "lowMemory"

defined in @nativescript/core/application/application-shims.d.ts:261:21

marginBottomProperty

marginBottomProperty: CssProperty<Style, PercentLengthType>

defined in @nativescript/core/ui/styling/style-properties.d.ts:85:13

marginLeftProperty

marginLeftProperty: CssProperty<Style, PercentLengthType>

defined in @nativescript/core/ui/styling/style-properties.d.ts:82:13

marginProperty

marginProperty: ShorthandProperty<Style, string | PercentLengthType>

defined in @nativescript/core/ui/styling/style-properties.d.ts:81:13

marginRightProperty

marginRightProperty: CssProperty<Style, PercentLengthType>

defined in @nativescript/core/ui/styling/style-properties.d.ts:83:13

marginTopProperty

marginTopProperty: CssProperty<Style, PercentLengthType>

defined in @nativescript/core/ui/styling/style-properties.d.ts:84:13

maxLengthProperty

maxLengthProperty: Property<EditableTextBase, number>

defined in @nativescript/core/ui/editable-text-base/index.d.ts:93:13

minHeightProperty

minHeightProperty: CssProperty<Style, dip | LengthDipUnit | LengthPxUnit>

defined in @nativescript/core/ui/styling/style-properties.d.ts:77:13

minWidthProperty

minWidthProperty: CssProperty<Style, dip | LengthDipUnit | LengthPxUnit>

defined in @nativescript/core/ui/styling/style-properties.d.ts:76:13

notify

notify: any

defined in @nativescript/core/application/application-shims.d.ts:90:21

off

off: any

defined in @nativescript/core/application/application-shims.d.ts:99:21

on

on: any

defined in @nativescript/core/application/application-shims.d.ts:108:21

opacityProperty

opacityProperty: CssAnimationProperty<Style, number>

defined in @nativescript/core/ui/styling/style-properties.d.ts:74:13

orientation

orientation: any

defined in @nativescript/core/application/application-shims.d.ts:117:21

orientationChangedEvent

orientationChangedEvent: "orientationChanged" = "orientationChanged"

defined in @nativescript/core/application/application-shims.d.ts:279:21

paddingBottomProperty

paddingBottomProperty: CssProperty<Style, LengthType>

defined in @nativescript/core/ui/styling/style-properties.d.ts:91:13

paddingLeftProperty

paddingLeftProperty: CssProperty<Style, LengthType>

defined in @nativescript/core/ui/styling/style-properties.d.ts:88:13

paddingProperty

paddingProperty: ShorthandProperty<Style, string | LengthType>

defined in @nativescript/core/ui/styling/style-properties.d.ts:87:13

paddingRightProperty

paddingRightProperty: CssProperty<Style, LengthType>

defined in @nativescript/core/ui/styling/style-properties.d.ts:89:13

paddingTopProperty

paddingTopProperty: CssProperty<Style, LengthType>

defined in @nativescript/core/ui/styling/style-properties.d.ts:90:13

placeholderColorProperty

placeholderColorProperty: CssProperty<Style, Color>

defined in @nativescript/core/ui/editable-text-base/index.d.ts:92:13

platformNames

platformNames: {
  android: string
}

defined in @nativescript/core/platform/index.d.ts:20:13

resetRootView

resetRootView: any

defined in @nativescript/core/application/application-shims.d.ts:126:21

resumeEvent

resumeEvent: "resume" = "resume"

defined in @nativescript/core/application/application-shims.d.ts:270:21

returnKeyTypeProperty

returnKeyTypeProperty: Property<EditableTextBase, ReturnKeyButtonType>

defined in @nativescript/core/ui/editable-text-base/index.d.ts:86:13

rotateProperty

rotateProperty: CssAnimationProperty<Style, number>

defined in @nativescript/core/ui/styling/style-properties.d.ts:36:13

run

run: any

defined in @nativescript/core/application/application-shims.d.ts:144:21

scaleXProperty

scaleXProperty: CssAnimationProperty<Style, number>

defined in @nativescript/core/ui/styling/style-properties.d.ts:37:13

scaleYProperty

scaleYProperty: CssAnimationProperty<Style, number>

defined in @nativescript/core/ui/styling/style-properties.d.ts:38:13

setAutoSystemAppearanceChanged

setAutoSystemAppearanceChanged: any

defined in @nativescript/core/application/application-shims.d.ts:153:21

setCssFileName

setCssFileName: any

defined in @nativescript/core/application/application-shims.d.ts:162:21

setMaxRefreshRate

setMaxRefreshRate: any

defined in @nativescript/core/application/application-shims.d.ts:171:21

setResources

setResources: any

defined in @nativescript/core/application/application-shims.d.ts:180:21

suspendEvent

suspendEvent: "suspend" = "suspend"

defined in @nativescript/core/application/application-shims.d.ts:288:21

suspended

suspended: boolean

defined in @nativescript/core/application/application-shims.d.ts:333:21

systemAppearance

systemAppearance: any

defined in @nativescript/core/application/application-shims.d.ts:189:21

systemAppearanceChanged

systemAppearanceChanged: any

defined in @nativescript/core/application/application-shims.d.ts:198:21

systemAppearanceChangedEvent

systemAppearanceChangedEvent: "systemAppearanceChanged" = "systemAppearanceChanged"

defined in @nativescript/core/application/application-shims.d.ts:297:21

textAlignmentProperty

textAlignmentProperty: InheritedCssProperty<Style, TextAlignmentType>

defined in @nativescript/core/ui/text-base/index.d.ts:132:13

textDecorationProperty

textDecorationProperty: CssProperty<Style, TextDecorationType>

defined in @nativescript/core/ui/text-base/index.d.ts:133:13

textShadowProperty

textShadowProperty: CssProperty<Style, CSSShadow>

defined in @nativescript/core/ui/text-base/index.d.ts:135:13

textTransformProperty

textTransformProperty: CssProperty<Style, TextTransformType>

defined in @nativescript/core/ui/text-base/index.d.ts:134:13

translateXProperty

translateXProperty: CssAnimationProperty<Style, dip>

defined in @nativescript/core/ui/styling/style-properties.d.ts:39:13

translateYProperty

translateYProperty: CssAnimationProperty<Style, dip>

defined in @nativescript/core/ui/styling/style-properties.d.ts:40:13

uncaughtErrorEvent

uncaughtErrorEvent: "uncaughtError" = "uncaughtError"

defined in @nativescript/core/application/application-shims.d.ts:216:21

unsetValue

unsetValue: any

defined in @nativescript/core/ui/core/properties/index.d.ts:6:21

Value specifying that Property should be set to its initial value.

updateTextTriggerProperty

updateTextTriggerProperty: Property<EditableTextBase, UpdateTextTriggerType>

defined in @nativescript/core/ui/editable-text-base/index.d.ts:88:13

verticalAlignmentProperty

verticalAlignmentProperty: CssProperty<Style, VerticalAlignmentType>

defined in @nativescript/core/ui/styling/style-properties.d.ts:94:13

visibilityProperty

visibilityProperty: CssProperty<Style, VisibilityType>

defined in @nativescript/core/ui/styling/style-properties.d.ts:73:13

whiteSpaceProperty

whiteSpaceProperty: CssProperty<Style, WhiteSpaceType>

defined in @nativescript/core/ui/text-base/index.d.ts:136:13

widthProperty

widthProperty: CssAnimationProperty<Style, PercentLengthType>

defined in @nativescript/core/ui/styling/style-properties.d.ts:78:13

zIndexProperty

zIndexProperty: CssProperty<Style, number>

defined in @nativescript/core/ui/styling/style-properties.d.ts:72:13

zeroLength

zeroLength: LengthType

defined in @nativescript/core/ui/styling/style-properties.d.ts:34:13

Functions

CSSType

CSSType(type: string): ClassDecorator

defined in @nativescript/core/ui/core/view/index.d.ts:36

Specifies the type name for the instances of this View class, that is used when matching CSS type selectors. Usage:

```
@CSSType("Button")
class Button extends View {
}
```

Internally the decorator set `Button.prototype.cssType = "Button"`.

Parameter	Default	Description
`type`		`string` The type name, e. g. "Button", "Label", etc.

Returns ClassDecorator

PseudoClassHandler

PseudoClassHandler(...pseudoClasses: string[]): MethodDecorator

defined in @nativescript/core/ui/core/view/index.d.ts:20

Parameter	Default	Description
`pseudoClasses`		`string[]`

Returns MethodDecorator

_setResolver

_setResolver(resolver: ModuleNameResolver): any

defined in @nativescript/core/module-name-resolver/index.d.ts:24

Used to set a global singular instance of ModuleNameResolver

Parameter	Default	Description
`resolver`		`ModuleNameResolver` instance

Returns any

action

action(message: string, cancelButtonText: string, actions: string[]): Promise&lt;string&gt;

defined in @nativescript/core/ui/dialogs/index.d.ts:129

The action() method displays a action box that prompts the visitor to choose some action.

Parameter	Default	Description
`message`		`string` The text to display in the dialog box.
`cancelButtonText`		`string` The text to display in the cancel button.
`actions`		`string[]` List of available actions.

Returns Promise<string>

action(options: ActionOptions): Promise<string>

defined in @nativescript/core/ui/dialogs/index.d.ts:135

The action() method displays a action box that prompts the visitor to choose some action.

Parameter	Default	Description
`options`		`ActionOptions` The options for the dialog box.

Returns Promise<string>

addTaggedAdditionalCSS

addTaggedAdditionalCSS(cssText: string, tag?: string | Number): boolean

defined in @nativescript/core/ui/styling/style-scope.d.ts:49

Parameter	Default	Description
`cssText`		`string`
`tag`		`string \| Number`

Returns boolean

addWeakEventListener

addWeakEventListener(source: Observable, eventName: string, handler: (eventData: EventData) => void, target: any): void

defined in @nativescript/core/ui/core/weak-event-listener/index.d.ts:10

Attaches a WeakEventListener.

Parameter	Default	Description
`source`		`Observable` Observable class which emits the event.
`eventName`		`string` The event name.
`handler`		`(eventData: EventData) => void` The function which should be called when event occurs.
`target`		`any` Subscriber (target) of the event listener. It will be used as a thisArg in the handler function.

Returns void

alert

alert(message: string | number | boolean): Promise&lt;void&gt;

defined in @nativescript/core/ui/dialogs/index.d.ts:66

The alert() method displays an alert box with a specified message.

Parameter	Default	Description
`message`		`string \| number \| boolean` Specifies the text to display in the alert box.

Returns Promise<void>

alert(options: AlertOptions): Promise<void>

defined in @nativescript/core/ui/dialogs/index.d.ts:72

The alert() method displays an alert box with a specified message.

Parameter	Default	Description
`options`		`AlertOptions` Specifies the options for the alert box.

Returns Promise<void>

animationTimingFunctionConverter

animationTimingFunctionConverter(value: string): any

defined in @nativescript/core/ui/styling/converters.d.ts:2

Parameter	Default	Description
`value`		`string`

Returns any

booleanConverter

booleanConverter(v: string | boolean): boolean

defined in @nativescript/core/ui/core/view-base/index.d.ts:478

Parameter	Default	Description
`v`		`string \| boolean`

Returns boolean

confirm

confirm(message: string): Promise&lt;boolean&gt;

defined in @nativescript/core/ui/dialogs/index.d.ts:78

The confirm() method displays a dialog box with a specified message.

Parameter	Default	Description
`message`		`string` Specifies the text to display in the confirm box.

Returns Promise<boolean>

confirm(options: ConfirmOptions): Promise<boolean>

defined in @nativescript/core/ui/dialogs/index.d.ts:84

The confirm() method displays a dialog box with a specified message.

Parameter	Default	Description
`options`		`ConfirmOptions` Specifies the options for the confirm box.

Returns Promise<boolean>

eachDescendant

eachDescendant(view: ViewBase, callback: (child: ViewBase) => boolean): void

defined in @nativescript/core/ui/core/view-base/index.d.ts:112

Iterates through all child views (via visual tree) and executes a function.

Parameter	Default	Description
`view`		`ViewBase` Starting view (parent container).
`callback`		`(child: ViewBase) => boolean` A function to execute on every child. If function returns false it breaks the iteration.

Returns void

fromObject

fromObject(source: any): Observable

defined in @nativescript/core/data/observable/index.d.ts:163

Creates an Observable instance and sets its properties according to the supplied JavaScript object. param obj - A JavaScript object used to initialize nativescript Observable instance.

Parameter	Default	Description
`source`		`any`

Returns Observable

fromObjectRecursive

fromObjectRecursive(source: any): Observable

defined in @nativescript/core/data/observable/index.d.ts:169

Creates an Observable instance and sets its properties according to the supplied JavaScript object. This function will create new Observable for each nested object (expect arrays and functions) from supplied JavaScript object. param obj - A JavaScript object used to initialize nativescript Observable instance.

Parameter	Default	Description
`source`		`any`

Returns Observable

getAncestor

getAncestor(view: ViewBase, criterion: string | () => any): ViewBase

defined in @nativescript/core/ui/core/view-base/index.d.ts:83

Gets an ancestor from a given type.

Parameter	Default	Description
`view`		`ViewBase` Starting view (child view).
`criterion`		`string \| () => any` The type of ancestor view we are looking for. Could be a string containing a class name or an actual type. Returns an instance of a view (if found), otherwise undefined.

Returns ViewBase

getCurrentPage

getCurrentPage(): Page

defined in @nativescript/core/ui/dialogs/dialogs-common.d.ts:203

Returns Page

getFileAccess

getFileAccess(): FileSystemAccess

defined in @nativescript/core/file-system/index.d.ts:22

Returns FileSystemAccess, a shared singleton utility class to provide methods to access and work with the file system. This is used under the hood of all the file system apis in @nativescript/core and provided as a lower level convenience if needed.

Returns FileSystemAccess

getRootLayout

getRootLayout(): RootLayout

defined in @nativescript/core/ui/layouts/root-layout/index.d.ts:15

Returns RootLayout

getTransformedText

getTransformedText(text: string, textTransform: TextTransformType): string

defined in @nativescript/core/ui/text-base/index.d.ts:141

Parameter	Default	Description
`text`		`string`
`textTransform`		`TextTransformType`

Returns string

getViewById

getViewById(view: ViewBase, id: string): ViewBase

defined in @nativescript/core/ui/core/view-base/index.d.ts:92

Gets a child view by id.

Parameter	Default	Description
`view`		`ViewBase` The parent (container) view of the view to look for.
`id`		`string` The id of the view to look for. Returns an instance of a view (if found), otherwise undefined.

Returns ViewBase

login(message: string, userNameHint?: string, passwordHint?: string, userName?: string, password?: string): Promise<LoginResult>

defined in @nativescript/core/ui/dialogs/index.d.ts:107

The login() method displays a login dialog box that prompts the visitor for user name and password.

Parameter	Default	Description
`message`		`string` The text to display in the dialog box.
`userNameHint`		`string` The default text to display as a hint in the username input. Optional.
`passwordHint`		`string` The default text to display as a hint in the password input. Optional.
`userName`		`string` The default text to display in the user name input box. Optional.
`password`		`string` The default text to display in the password input box. Optional.

Returns Promise<LoginResult>

login(message: string, userNameHint?: string, passwordHint?: string): Promise<LoginResult>

defined in @nativescript/core/ui/dialogs/index.d.ts:115

The login() method displays a login dialog box that prompts the visitor for user name and password.

Parameter	Default	Description
`message`		`string` The text to display in the dialog box.
`userNameHint`		`string` The default text to display as a hint in the username input. Optional.
`passwordHint`		`string` The default text to display as a hint in the password input. Optional.

Returns Promise<LoginResult>

login(options: LoginOptions): Promise<LoginResult>

defined in @nativescript/core/ui/dialogs/index.d.ts:121

The login() method displays a login dialog box that prompts the visitor for user name and password.

Parameter	Default	Description
`options`		`LoginOptions` The options for the dialog box.

Returns Promise<LoginResult>

makeParser

makeParser&lt;T&gt;(isValid: (value: any) => boolean, allowNumbers?: boolean): (value: any) => T

defined in @nativescript/core/ui/core/properties/index.d.ts:143

Parameter	Default	Description
`isValid`		`(value: any) => boolean`
`allowNumbers`		`boolean`

Returns (value: any) => T

makeValidator

makeValidator&lt;T&gt;(...values: T[]): (value: any) => value is T

defined in @nativescript/core/ui/core/properties/index.d.ts:142

Parameter	Default	Description
`values`		`T[]`

Returns (value: any) => value is T

parseCSSShadow

parseCSSShadow(value: string): CSSShadow

defined in @nativescript/core/ui/styling/css-shadow.d.ts:19

Parse a string into a CSSShadow Supports any valid css box/text shadow combination. inspired by https://github.com/jxnblk/css-box-shadow/blob/master/index.js (MIT License)

Parameter	Default	Description
`value`		`string`

Returns CSSShadow

parseKeyframeDeclarations

parseKeyframeDeclarations(unparsedKeyframeDeclarations: KeyframeDeclaration[]): KeyframeDeclaration[]

defined in @nativescript/core/ui/styling/css-animation-parser.d.ts:14

Parameter	Default	Description
`unparsedKeyframeDeclarations`		`KeyframeDeclaration[]`

Returns KeyframeDeclaration[]

profile

profile(name?: string): MethodDecorator

defined in @nativescript/core/profiling/index.d.ts:98

Method decorator factory. It will intercept the method call and start and pause a timer before and after the method call. Works only if profiling is enabled.

Parameter	Default	Description
`name`		`string` Name of the timer which will be used for method calls. If not provided - the name of the method will be used.

Returns MethodDecorator

profile&lt;F&gt;(fn: F): F

defined in @nativescript/core/profiling/index.d.ts:105

Function factory. It will intercept the function call and start and pause a timer before and after the function call. Works only if profiling is enabled. Works only if profiling is enabled.

Parameter	Default	Description
`fn`		`F` The function to wrap. Uses the function name to track the times.

Returns F

profile&lt;F&gt;(name: string, fn: F): F

defined in @nativescript/core/profiling/index.d.ts:112

Function factory. It will intercept the function call and start and pause a timer before and after the function call. Works only if profiling is enabled.

Parameter	Default	Description
`name`		`string` The name used to track calls and times.
`fn`		`F` The function to wrap.

Returns F

profile&lt;T&gt;(target: Object, propertyKey: string | symbol, descriptor: TypedPropertyDescriptor&lt;T&gt;): TypedPropertyDescriptor&lt;T&gt; | void

defined in @nativescript/core/profiling/index.d.ts:117

Method decorator. It will intercept the method calls and start and pause a timer before and after the method call. Works only if profiling is enabled.

Parameter	Default	Description
`target`		`Object`
`propertyKey`		`string \| symbol`
`descriptor`		`TypedPropertyDescriptor<T>`

Returns TypedPropertyDescriptor<T> | void

profile(): any

defined in @nativescript/core/profiling/index.d.ts:118

Returns any

profilingDisable

profilingDisable(): void

defined in @nativescript/core/profiling/index.d.ts:58

Disables profiling.

Returns void

profilingDumpProfiles

profilingDumpProfiles(): void

defined in @nativescript/core/profiling/index.d.ts:123

Prints the timer for all methods instrumented with profile decorator.

Returns void

profilingEnable

profilingEnable(type?: InstrumentationMode): void

defined in @nativescript/core/profiling/index.d.ts:53

Enables profiling. Upon loading of the module it will cache the package.json of the app and check if there is a "profiling" key set, its value can be one of the options available for InstrumentationMode, and if set, enable() will be called in pre app start with the value in the package.json. An example for an `app/package.json` enabling the manual instrumentation profiling is:

```
{
    "main": "main.js",
    "profiling": "timeline"
}
```

Parameter	Default	Description
`type`		`InstrumentationMode` Profiling mode to use. - "counters" - Accumulates method call counts and times until dumpProfiles is called and then prints aggregated statistic in the console. This is the default. - "timeline" - Outputs method names along start/end timestamps in the console on the go. - "lifecycle" - Outputs basic non-verbose times for startup, navigation, etc.

Returns void

profilingIsRunning

profilingIsRunning(name: string): boolean

defined in @nativescript/core/profiling/index.d.ts:91

Returns true if a timer is currently running.

Parameter	Default	Description
`name`		`string` Name of the timer.

Returns boolean

profilingResetProfiles

profilingResetProfiles(): void

defined in @nativescript/core/profiling/index.d.ts:128

Resets the timers for all methods instrumented with profile decorator.

Returns void

profilingStart

profilingStart(name: string): void

defined in @nativescript/core/profiling/index.d.ts:70

Starts a timer with a specific name. Works only if profiling is enabled.

Parameter	Default	Description
`name`		`string` Name of the timer.

Returns void

profilingStartCPU

profilingStartCPU(name: string): void

defined in @nativescript/core/profiling/index.d.ts:134

Starts android cpu profiling.

Parameter	Default	Description
`name`		`string` Name of the cpu profiling session.

Returns void

profilingStop

profilingStop(name: string): TimerInfo

defined in @nativescript/core/profiling/index.d.ts:78

Pauses a timer with a specific name. This will increase call count and accumulate time. Works only if profiling is enabled.

Parameter	Default	Description
`name`		`string` Name of the timer.

Returns TimerInfo

profilingStopCPU

profilingStopCPU(name: string): void

defined in @nativescript/core/profiling/index.d.ts:140

Stops android cpu profiling.

Parameter	Default	Description
`name`		`string` Name of the cpu profiling session.

Returns void

profilingTime

profilingTime(): number

defined in @nativescript/core/profiling/index.d.ts:63

Gets accurate system timestamp in ms.

Returns number

profilingUptime

profilingUptime(): number

defined in @nativescript/core/profiling/index.d.ts:145

Gets the uptime of the current process in milliseconds.

Returns number

prompt

prompt(message: string, defaultText?: string): Promise<PromptResult>

defined in @nativescript/core/ui/dialogs/index.d.ts:91

The prompt() method displays a dialog box that prompts the visitor for input.

Parameter	Default	Description
`message`		`string` The text to display in the dialog box.
`defaultText`		`string` The default text to display in the input box. Optional.

Returns Promise<PromptResult>

prompt(options: PromptOptions): Promise<PromptResult>

defined in @nativescript/core/ui/dialogs/index.d.ts:97

The prompt() method displays a dialog box that prompts the visitor for input.

Parameter	Default	Description
`options`		`PromptOptions` The options for the dialog box.

Returns Promise<PromptResult>

querySelectorAll

querySelectorAll(view: ViewBase, selector: string): ViewBase[]

defined in @nativescript/core/ui/core/view-base/index.d.ts:106

Gets a child view by selector.

Parameter	Default	Description
`view`		`ViewBase` The parent (container) view of the view to look for.
`selector`		`string` The selector of the view to look for. Returns an instance of a view (if found), otherwise undefined.

Returns ViewBase[]

removeTaggedAdditionalCSS

removeTaggedAdditionalCSS(tag: String | Number): boolean

defined in @nativescript/core/ui/styling/style-scope.d.ts:50

Parameter	Default	Description
`tag`		`String \| Number`

Returns boolean

removeWeakEventListener

removeWeakEventListener(source: Observable, eventName: string, handler: (eventData: EventData) => void, target: any): void

defined in @nativescript/core/ui/core/weak-event-listener/index.d.ts:19

Removes a WeakEventListener.

Parameter	Default	Description
`source`		`Observable` Observable class which emits the event.
`eventName`		`string` The event name.
`handler`		`(eventData: EventData) => void` The function which should be called when event occurs.
`target`		`any` Subscriber (target) of the event listener. It will be used as a thisArg in the handler function.

Returns void

resolveFileNameFromUrl

resolveFileNameFromUrl(
  url: string,
  appDirectory: string,
  fileExists: (filepath: string) => boolean,
  importSource?: string
): string

defined in @nativescript/core/ui/styling/style-scope.d.ts:47

Parameter	Default	Description
`url`		`string`
`appDirectory`		`string`
`fileExists`		`(filepath: string) => boolean`
`importSource`		`string`

Returns string

setActivityCallbacks

setActivityCallbacks(activity: any): void

defined in @nativescript/core/ui/frame/index.d.ts:510

Parameter	Default	Description
`activity`		`any`

Returns void

timeConverter

timeConverter(value: string): number

defined in @nativescript/core/ui/styling/converters.d.ts:1

Parameter	Default	Description
`value`		`string`

Returns number

transformConverter

transformConverter(text: string): TransformFunctionsInfo

defined in @nativescript/core/ui/styling/style-properties.d.ts:42

Parameter	Default	Description
`text`		`string`

Returns TransformFunctionsInfo

Summary ​

References

Namespaces

Enumerations

Classes

Interfaces

Type Aliases

Variables

Functions

References ​

Type Aliases ​

GridUnitType ​

Headers ​

HorizontalAlignment ​

InstrumentationMode ​

LengthDipUnit ​

LengthPercentUnit ​

LengthPxUnit ​

LengthType ​

ModuleListProvider ​

PercentLengthType ​

SharedTransitionTagProperties ​

TouchAnimationOptions ​

VerticalAlignment ​

WebViewNavigationType ​

dip ​

percent ​

px ​

Variables ​

AnimationCurve ​

Application ​

CSSHelper ​

Device ​

Dialogs ​

Enums ​

_resetRootView ​

addCss ​

android ​

androidDynamicElevationOffsetProperty ​

androidElevationProperty ​

autocapitalizationTypeProperty ​

autocorrectProperty ​

backgroundColorProperty ​

backgroundEvent ​

backgroundImageProperty ​

backgroundInternalProperty ​

backgroundPositionProperty ​

backgroundProperty ​

backgroundRepeatProperty ​

backgroundSizeProperty ​

borderBottomColorProperty ​

borderBottomLeftRadiusProperty ​

borderBottomRightRadiusProperty ​

borderBottomWidthProperty ​

borderColorProperty ​

borderLeftColorProperty ​

borderLeftWidthProperty ​

borderRadiusProperty ​

borderRightColorProperty ​

borderRightWidthProperty ​

borderTopColorProperty ​

borderTopLeftRadiusProperty ​

borderTopRightRadiusProperty ​

borderTopWidthProperty ​

borderWidthProperty ​

clipPathProperty ​

colorProperty ​

discardedErrorEvent ​

displayedEvent ​

editableProperty ​

exitEvent ​

fontFamilyProperty ​

fontInternalProperty ​

fontScaleChangedEvent ​

fontScaleInternalProperty ​

fontSizeProperty ​

fontStyleProperty ​

fontWeightProperty ​

foregroundEvent ​

getCssFileName ​

Summary

References

Type Aliases

GridUnitType

Headers

HorizontalAlignment

InstrumentationMode

LengthDipUnit

LengthPercentUnit

LengthPxUnit

LengthType

ModuleListProvider

PercentLengthType

SharedTransitionTagProperties

TouchAnimationOptions

VerticalAlignment

WebViewNavigationType

dip

percent

px

Variables

AnimationCurve

Application

CSSHelper

Device

Dialogs

Enums

_resetRootView

addCss

android

androidDynamicElevationOffsetProperty

androidElevationProperty

autocapitalizationTypeProperty

autocorrectProperty

backgroundColorProperty

backgroundEvent

backgroundImageProperty

backgroundInternalProperty

backgroundPositionProperty

backgroundProperty

backgroundRepeatProperty

backgroundSizeProperty

borderBottomColorProperty

borderBottomLeftRadiusProperty

borderBottomRightRadiusProperty

borderBottomWidthProperty

borderColorProperty

borderLeftColorProperty

borderLeftWidthProperty

borderRadiusProperty

borderRightColorProperty

borderRightWidthProperty

borderTopColorProperty

borderTopLeftRadiusProperty

borderTopRightRadiusProperty

borderTopWidthProperty

borderWidthProperty

clipPathProperty

colorProperty

discardedErrorEvent

displayedEvent

editableProperty

exitEvent

fontFamilyProperty

fontInternalProperty

fontScaleChangedEvent

fontScaleInternalProperty

fontSizeProperty

fontStyleProperty

fontWeightProperty

foregroundEvent

getCssFileName

getMainEntry

getNativeApplication

getResources

getRootView

hasLaunched

hasListeners

heightProperty

hintProperty