API Reference
Summary
Namespaces
Enumerations
Classes
- AbsoluteLayout
- ActionBar
- ActionItem
- ActionItems
- ActivityIndicator
- AndroidApplication
- Animation
- Background
- Binding
- Builder
- Button
- ChangeType
- CoercibleProperty
- Color
- ContainerView
- ContentView
- ControlStateChangeListener
- CssAnimationParser
- CssAnimationProperty
- CssProperty
- CustomLayoutView
- DatePicker
- DockLayout
- EditableTextBase
- File
- FileSystemEntity
- FlexboxLayout
- Folder
- Font
- FormattedString
- Frame
- GesturesObserver
- GridLayout
- HtmlView
- Image
- ImageAsset
- ImageCache
- ImageSource
- InheritedCssProperty
- InheritedProperty
- iOSApplication
- ItemSpec
- KeyframeAnimation
- KeyframeAnimationInfo
- Label
- LayoutBase
- ListPicker
- ListView
- ModuleNameResolver
- NavigationButton
- Observable
- ObservableArray
- Page
- PageBase
- ParserEventType
- Placeholder
- Progress
- Property
- ProxyViewContainer
- Repeater
- RootLayout
- Screen
- ScrollView
- SearchBar
- SegmentedBar
- SegmentedBarItem
- ShorthandProperty
- Slider
- Span
- StackLayout
- Style
- Switch
- TabView
- TabViewItem
- TextBase
- TextField
- TextView
- TimePicker
- TouchManager
- Transition
- View
- ViewBase
- ViewCommon
- ViewHelper
- VirtualArray
- WebView
- WrapLayout
- WrappedValue
- XmlParser
Interfaces
- ActionOptions
- AddArrayFromBuilder
- AddChildFromBuilder
- AlertOptions
- AndroidActivityBackPressedEventData
- AndroidActivityBundleEventData
- AndroidActivityCallbacks
- AndroidActivityEventData
- AndroidActivityNewIntentEventData
- AndroidActivityRequestPermissionsEventData
- AndroidActivityResultEventData
- AnimationDefinition
- ApplicationEventData
- BackstackEntry
- BindingOptions
- CancelableOptions
- ChangedData
- CommonLayoutParams
- ComponentModule
- ConfirmOptions
- CreateViewEventData
- CssChangedEventData
- DialogOptions
- DiscardedErrorEventData
- DownloadedData
- DownloadError
- DownloadRequest
- EventData
- GestureEventData
- GestureEventDataWithState
- HttpContent
- HttpRequestOptions
- HttpResponse
- IDevice
- ImageAssetOptions
- ItemEventData
- ItemsLoading
- ItemsSource
- KeyedTemplate
- KeyframeDeclaration
- KeyframeInfo
- LaunchEventData
- LoadAppCSSEventData
- LoadEventData
- LoadOptions
- LoginOptions
- LoginResult
- NativeScriptConfig
- NavigatedData
- NavigationContext
- NavigationEntry
- NavigationTransition
- OrientationChangedEventData
- PanGestureEventData
- ParserEvent
- PinchGestureEventData
- PlatformContext
- PromptOptions
- PromptResult
- PropertyChangeData
- RootLayoutOptions
- RotationGestureEventData
- ScrollEventData
- ShadeCoverOptions
- ShowModalOptions
- ShownModallyData
- Size
- SwipeGestureEventData
- SystemAppearanceChangedEventData
- TapGestureEventData
- Template
- TemplatedItemsView
- TimerInfo
- TouchGestureEventData
- TraceErrorHandler
- TraceEventListener
- TraceWriter
- UnhandledErrorEventData
- ViewEntry
Type Aliases
Variables
- AccessibilityEvents
- androidDynamicElevationOffsetProperty
- androidElevationProperty
- AnimationCurve
- Application
- autocapitalizationTypeProperty
- autocorrectProperty
- backgroundColorProperty
- backgroundImageProperty
- backgroundInternalProperty
- backgroundPositionProperty
- backgroundProperty
- backgroundRepeatProperty
- backgroundSizeProperty
- borderBottomColorProperty
- borderBottomLeftRadiusProperty
- borderBottomRightRadiusProperty
- borderBottomWidthProperty
- borderColorProperty
- borderLeftColorProperty
- borderLeftWidthProperty
- borderRadiusProperty
- borderRightColorProperty
- borderRightWidthProperty
- borderTopColorProperty
- borderTopLeftRadiusProperty
- borderTopRightRadiusProperty
- borderTopWidthProperty
- borderWidthProperty
- clipPathProperty
- colorProperty
- CSSHelper
- Device
- Dialogs
- editableProperty
- Enums
- fontFamilyProperty
- fontInternalProperty
- fontSizeProperty
- fontStyleProperty
- fontWeightProperty
- heightProperty
- hintProperty
- horizontalAlignmentProperty
- isAndroid
- isIOS
- isUserInteractionEnabledProperty
- keyboardTypeProperty
- letterSpacingProperty
- lineHeightProperty
- marginBottomProperty
- marginLeftProperty
- marginProperty
- marginRightProperty
- marginTopProperty
- maxLengthProperty
- minHeightProperty
- minWidthProperty
- opacityProperty
- paddingBottomProperty
- paddingLeftProperty
- paddingProperty
- paddingRightProperty
- paddingTopProperty
- placeholderColorProperty
- platformNames
- returnKeyTypeProperty
- rotateProperty
- scaleXProperty
- scaleYProperty
- TESTING
- textAlignmentProperty
- textDecorationProperty
- textShadowProperty
- textTransformProperty
- translateXProperty
- translateYProperty
- unsetValue
- updateTextTriggerProperty
- verticalAlignmentProperty
- visibilityProperty
- whiteSpaceProperty
- widthProperty
- zeroLength
- zIndexProperty
Functions
- _setResolver
- _updateCharactersInRangeReplacementString
- action
- addTaggedAdditionalCSS
- addWeakEventListener
- alert
- animationTimingFunctionConverter
- booleanConverter
- confirm
- CSSType
- eachDescendant
- fromObject
- fromObjectRecursive
- getAncestor
- getCurrentPage
- getFileAccess
- getRootLayout
- getTransformedText
- getViewById
- login
- makeParser
- makeValidator
- parseCSSShadow
- parseKeyframeDeclarations
- profile
- profilingDisable
- profilingDumpProfiles
- profilingEnable
- profilingIsRunning
- profilingResetProfiles
- profilingStart
- profilingStartCPU
- profilingStop
- profilingStopCPU
- profilingTime
- profilingUptime
- prompt
- PseudoClassHandler
- removeTaggedAdditionalCSS
- removeWeakEventListener
- resolveFileNameFromUrl
- sanitizeModuleName
- setActivityCallbacks
- timeConverter
- transformConverter
Type Aliases
FontStyle
FontWeight
GridUnitType
Headers
defined in @nativescript/core/http/index.d.ts:127:12
HorizontalAlignment
HorizontalAlignment: HorizontalAlignmentType
InstrumentationMode
defined in @nativescript/core/profiling/index.d.ts:17:5
LengthDipUnit
LengthDipUnit: LengthDipUnit
LengthPercentUnit
LengthPercentUnit: LengthPercentUnit
LengthPxUnit
LengthPxUnit: LengthPxUnit
LengthType
LengthType: LengthType
ModuleListProvider
PercentLengthType
PercentLengthType: PercentLengthType
TouchAnimationOptions
VerticalAlignment
VerticalAlignment: VerticalAlignmentType
WebViewNavigationType
dip
dip: dip
percent
percent: percent
px
px: px
Variables
AccessibilityEvents
defined in @nativescript/core/index.d.ts:52:21
AnimationCurve
AnimationCurve: typeof AnimationCurve
Application
Application: {
addCss: typeof addCss;
android: AndroidApplication;
discardedErrorEvent: string;
displayedEvent: string;
exitEvent: string;
fontScaleChangedEvent: string;
getCssFileName: typeof getCssFileName;
getMainEntry: typeof getMainEntry;
getNativeApplication: typeof getNativeApplication;
getResources: typeof getResources;
getRootView: typeof getRootView;
hasLaunched: typeof hasLaunched;
hasListeners: typeof hasListeners;
inBackground: boolean;
ios: iOSApplication;
launchEvent: string;
loadAppCss: typeof loadAppCss;
lowMemoryEvent: string;
notify: typeof notify;
off: typeof off;
on: typeof on;
orientation: typeof orientation;
orientationChangedEvent: string;
resetRootView: typeof _resetRootView;
resumeEvent: string;
run: typeof run;
setAutoSystemAppearanceChanged: typeof setAutoSystemAppearanceChanged;
setCssFileName: typeof setCssFileName;
setMaxRefreshRate: typeof setMaxRefreshRate;
setResources: typeof setResources;
suspendEvent: string;
suspended: boolean;
systemAppearance: typeof systemAppearance;
systemAppearanceChanged: typeof systemAppearanceChanged;
systemAppearanceChangedEvent: string;
} defined in @nativescript/core/index.d.ts:12:21
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
}Device
Device: IDevice
Dialogs
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: TextAlignmentType;
TextDecoration: TextDecorationType;
TextTransform: TextTransformType;
UpdateTextTrigger: UpdateTextTriggerType;
VerticalAlignment: VerticalAlignmentType;
Visibility: VisibilityType;
}TESTING
defined in index.d.ts:17:13
androidDynamicElevationOffsetProperty
androidDynamicElevationOffsetProperty: CssProperty<Style, number>
androidElevationProperty
androidElevationProperty: CssProperty<Style, number>
autocapitalizationTypeProperty
autocapitalizationTypeProperty: Property<EditableTextBase, AutocapitalizationInputType>
autocorrectProperty
autocorrectProperty: Property<EditableTextBase, boolean>
backgroundColorProperty
backgroundColorProperty: CssAnimationProperty<Style, Color>
backgroundImageProperty
backgroundImageProperty: CssProperty<Style, string>
backgroundInternalProperty
backgroundInternalProperty: CssProperty<Style, Background>
backgroundPositionProperty
backgroundPositionProperty: CssProperty<Style, string>
backgroundProperty
backgroundProperty: ShorthandProperty<Style, string>
backgroundRepeatProperty
backgroundRepeatProperty: CssProperty<Style, BackgroundRepeatType>
backgroundSizeProperty
backgroundSizeProperty: CssProperty<Style, string>
borderBottomColorProperty
borderBottomColorProperty: CssProperty<Style, Color>
borderBottomLeftRadiusProperty
borderBottomLeftRadiusProperty: CssProperty<Style, LengthType>
borderBottomRightRadiusProperty
borderBottomRightRadiusProperty: CssProperty<Style, LengthType>
borderBottomWidthProperty
borderBottomWidthProperty: CssProperty<Style, LengthType>
borderColorProperty
borderColorProperty: ShorthandProperty<Style, string | Color>
borderLeftColorProperty
borderLeftColorProperty: CssProperty<Style, Color>
borderLeftWidthProperty
borderLeftWidthProperty: CssProperty<Style, LengthType>
borderRadiusProperty
borderRadiusProperty: ShorthandProperty<Style, string | LengthType>
borderRightColorProperty
borderRightColorProperty: CssProperty<Style, Color>
borderRightWidthProperty
borderRightWidthProperty: CssProperty<Style, LengthType>
borderTopColorProperty
borderTopColorProperty: CssProperty<Style, Color>
borderTopLeftRadiusProperty
borderTopLeftRadiusProperty: CssProperty<Style, LengthType>
borderTopRightRadiusProperty
borderTopRightRadiusProperty: CssProperty<Style, LengthType>
borderTopWidthProperty
borderTopWidthProperty: CssProperty<Style, LengthType>
borderWidthProperty
borderWidthProperty: ShorthandProperty<Style, string | LengthType>
clipPathProperty
clipPathProperty: CssProperty<Style, string>
colorProperty
colorProperty: InheritedCssProperty<Style, Color>
editableProperty
editableProperty: Property<EditableTextBase, boolean>
fontFamilyProperty
fontFamilyProperty: InheritedCssProperty<Style, string>
fontInternalProperty
fontInternalProperty: InheritedCssProperty<Style, Font>
fontSizeProperty
fontSizeProperty: InheritedCssProperty<Style, number>
fontStyleProperty
fontStyleProperty: InheritedCssProperty<Style, FontStyle>
fontWeightProperty
fontWeightProperty: InheritedCssProperty<Style, FontWeight>
heightProperty
heightProperty: CssAnimationProperty<Style, PercentLengthType>
hintProperty
hintProperty: Property<EditableTextBase, string>
horizontalAlignmentProperty
horizontalAlignmentProperty: CssProperty<Style, HorizontalAlignmentType>
isAndroid
defined in @nativescript/core/platform/index.d.ts:10:13
isIOS
defined in @nativescript/core/platform/index.d.ts:15:13
isUserInteractionEnabledProperty
keyboardTypeProperty
keyboardTypeProperty: Property<EditableTextBase, KeyboardInputType>
letterSpacingProperty
letterSpacingProperty: CssProperty<Style, number>
lineHeightProperty
lineHeightProperty: CssProperty<Style, number>
marginBottomProperty
marginBottomProperty: CssProperty<Style, PercentLengthType>
marginLeftProperty
marginLeftProperty: CssProperty<Style, PercentLengthType>
marginProperty
marginProperty: ShorthandProperty<Style, string | PercentLengthType>
marginRightProperty
marginRightProperty: CssProperty<Style, PercentLengthType>
marginTopProperty
marginTopProperty: CssProperty<Style, PercentLengthType>
maxLengthProperty
maxLengthProperty: Property<EditableTextBase, number>
minHeightProperty
minHeightProperty: CssProperty<Style, dip | LengthDipUnit | LengthPxUnit>
minWidthProperty
minWidthProperty: CssProperty<Style, dip | LengthDipUnit | LengthPxUnit>
opacityProperty
opacityProperty: CssAnimationProperty<Style, number>
paddingBottomProperty
paddingBottomProperty: CssProperty<Style, LengthType>
paddingLeftProperty
paddingLeftProperty: CssProperty<Style, LengthType>
paddingProperty
paddingProperty: ShorthandProperty<Style, string | LengthType>
paddingRightProperty
paddingRightProperty: CssProperty<Style, LengthType>
paddingTopProperty
paddingTopProperty: CssProperty<Style, LengthType>
placeholderColorProperty
placeholderColorProperty: CssProperty<Style, Color>
platformNames
defined in @nativescript/core/platform/index.d.ts:20:13
returnKeyTypeProperty
returnKeyTypeProperty: Property<EditableTextBase, ReturnKeyButtonType>
rotateProperty
rotateProperty: CssAnimationProperty<Style, number>
scaleXProperty
scaleXProperty: CssAnimationProperty<Style, number>
scaleYProperty
scaleYProperty: CssAnimationProperty<Style, number>
textAlignmentProperty
textAlignmentProperty: InheritedCssProperty<Style, TextAlignmentType>
textDecorationProperty
textDecorationProperty: CssProperty<Style, TextDecorationType>
textShadowProperty
textShadowProperty: CssProperty<Style, CSSShadow>
textTransformProperty
textTransformProperty: CssProperty<Style, TextTransformType>
translateXProperty
translateXProperty: CssAnimationProperty<Style, dip>
translateYProperty
translateYProperty: CssAnimationProperty<Style, dip>
unsetValue
updateTextTriggerProperty
updateTextTriggerProperty: Property<EditableTextBase, UpdateTextTriggerType>
verticalAlignmentProperty
verticalAlignmentProperty: CssProperty<Style, VerticalAlignmentType>
visibilityProperty
visibilityProperty: CssProperty<Style, VisibilityType>
whiteSpaceProperty
whiteSpaceProperty: CssProperty<Style, WhiteSpaceType>
widthProperty
widthProperty: CssAnimationProperty<Style, PercentLengthType>
zIndexProperty
zIndexProperty: CssProperty<Style, number>
zeroLength
zeroLength: LengthType
Functions
CSSType
| Parameter | Default | Description |
type | | string |
Returns ClassDecorator
PseudoClassHandler
| Parameter | Default | Description |
pseudoClasses | | string[] |
Returns MethodDecorator
_setResolver
_setResolver(resolver: ModuleNameResolver): any
| Parameter | Default | Description |
resolver | |
Returns any
_updateCharactersInRangeReplacementString
Private
_updateCharactersInRangeReplacementString(formattedText: FormattedString, rangeLocation: number, rangeLength: number, replacementString: string): void
| Parameter | Default | Description |
formattedText | | |
rangeLocation | | number |
rangeLength | | number |
replacementString | | string |
Returns void
action
defined in @nativescript/core/ui/dialogs/index.d.ts:129
| Parameter | Default | Description |
message | | string |
cancelButtonText | | string |
actions | | string[] |
Returns Promise<string>
action(options: ActionOptions): Promise<string>
defined in @nativescript/core/ui/dialogs/index.d.ts:135
| Parameter | Default | Description |
options | |
Returns Promise<string>
addTaggedAdditionalCSS
| Parameter | Default | Description |
cssText | | string |
tag | | string | Number |
Returns boolean
addWeakEventListener
addWeakEventListener(source: Observable, eventName: string, handler: (eventData: EventData) => void, target: any): void
| Parameter | Default | Description |
source | | |
eventName | | string |
handler | | (eventData: EventData) => void |
target | | any |
Returns void
alert
defined in @nativescript/core/ui/dialogs/index.d.ts:66
| Parameter | Default | Description |
message | | string | number | boolean |
Returns Promise<void>
alert(options: AlertOptions): Promise<void>
defined in @nativescript/core/ui/dialogs/index.d.ts:72
| Parameter | Default | Description |
options | |
Returns Promise<void>
animationTimingFunctionConverter
| Parameter | Default | Description |
value | | string |
Returns any
booleanConverter
| Parameter | Default | Description |
v | | string |
Returns boolean
confirm
defined in @nativescript/core/ui/dialogs/index.d.ts:78
| Parameter | Default | Description |
message | | string |
Returns Promise<boolean>
confirm(options: ConfirmOptions): Promise<boolean>
defined in @nativescript/core/ui/dialogs/index.d.ts:84
| Parameter | Default | Description |
options | |
Returns Promise<boolean>
eachDescendant
Returns any
fromObject
fromObject(obj: any): Observable
fromObjectRecursive
fromObjectRecursive(obj: any): Observable
getAncestor
getFileAccess
getRootLayout
getRootLayout(): RootLayout
Returns RootLayout
getTransformedText
getTransformedText(text: string, textTransform: TextTransformType): string
| Parameter | Default | Description |
text | | string |
textTransform | |
Returns string
getViewById
login
login(message: string, userNameHint?: string, passwordHint?: string, userName?: string, password?: string): Promise<LoginResult>
defined in @nativescript/core/ui/dialogs/index.d.ts:107
| Parameter | Default | Description |
message | | string |
userNameHint | | string |
passwordHint | | string |
userName | | string |
password | | string |
Returns Promise<LoginResult>
login(message: string, userNameHint?: string, passwordHint?: string): Promise<LoginResult>
defined in @nativescript/core/ui/dialogs/index.d.ts:115
| Parameter | Default | Description |
message | | string |
userNameHint | | string |
passwordHint | | string |
Returns Promise<LoginResult>
login(options: LoginOptions): Promise<LoginResult>
defined in @nativescript/core/ui/dialogs/index.d.ts:121
| Parameter | Default | Description |
options | |
Returns Promise<LoginResult>
makeParser
| Parameter | Default | Description |
isValid | | (value: any) => boolean |
allowNumbers | | boolean |
Returns (value: any) => T
makeValidator
| Parameter | Default | Description |
values | | T[] |
Returns (value: any) => value is T
parseCSSShadow
| Parameter | Default | Description |
value | | string |
Returns CSSShadow
parseKeyframeDeclarations
parseKeyframeDeclarations(unparsedKeyframeDeclarations: KeyframeDeclaration[]): KeyframeDeclaration[]
| Parameter | Default | Description |
unparsedKeyframeDeclarations | |
Returns KeyframeDeclaration[]
profile
defined in @nativescript/core/profiling/index.d.ts:98
| Parameter | Default | Description |
name | | string |
Returns MethodDecorator
defined in @nativescript/core/profiling/index.d.ts:112
| Parameter | Default | Description |
name | | string |
fn | | F |
Returns F
profile<T>(target: Object, propertyKey: string | symbol, descriptor: TypedPropertyDescriptor<T>): TypedPropertyDescriptor<T> | void
defined in @nativescript/core/profiling/index.d.ts:117
| Parameter | Default | Description |
target | | Object |
propertyKey | | string | symbol |
descriptor | | TypedPropertyDescriptor<T> |
Returns TypedPropertyDescriptor<T> | void
defined in @nativescript/core/profiling/index.d.ts:118
Returns any
profilingDisable
profilingDumpProfiles
profilingEnable
profilingEnable(type?: InstrumentationMode): void
defined in @nativescript/core/profiling/index.d.ts:53
| Parameter | Default | Description |
type | |
Returns void
profilingIsRunning
defined in @nativescript/core/profiling/index.d.ts:91
| Parameter | Default | Description |
name | | string |
Returns boolean
profilingResetProfiles
profilingStart
defined in @nativescript/core/profiling/index.d.ts:70
| Parameter | Default | Description |
name | | string |
Returns void
profilingStartCPU
defined in @nativescript/core/profiling/index.d.ts:134
| Parameter | Default | Description |
name | | string |
Returns void
profilingStop
profilingStop(name: string): TimerInfo
defined in @nativescript/core/profiling/index.d.ts:78
| Parameter | Default | Description |
name | | string |
Returns TimerInfo
profilingStopCPU
defined in @nativescript/core/profiling/index.d.ts:140
| Parameter | Default | Description |
name | | string |
Returns void
profilingTime
profilingUptime
prompt
prompt(message: string, defaultText?: string): Promise<PromptResult>
defined in @nativescript/core/ui/dialogs/index.d.ts:91
| Parameter | Default | Description |
message | | string |
defaultText | | string |
Returns Promise<PromptResult>
prompt(options: PromptOptions): Promise<PromptResult>
defined in @nativescript/core/ui/dialogs/index.d.ts:97
| Parameter | Default | Description |
options | |
Returns Promise<PromptResult>
removeTaggedAdditionalCSS
| Parameter | Default | Description |
tag | | String | Number |
Returns boolean
removeWeakEventListener
removeWeakEventListener(source: Observable, eventName: string, handler: (eventData: EventData) => void, target: any): void
| Parameter | Default | Description |
source | | |
eventName | | string |
handler | | (eventData: EventData) => void |
target | | any |
Returns void
resolveFileNameFromUrl
sanitizeModuleName
| Parameter | Default | Description |
moduleName | | string |
removeExtension | | boolean |
Returns string
setActivityCallbacks
defined in @nativescript/core/ui/frame/index.d.ts:510
| Parameter | Default | Description |
activity | | any |
Returns void
timeConverter
| Parameter | Default | Description |
value | | string |
Returns number
transformConverter
| Parameter | Default | Description |
text | | string |
Returns TransformFunctionsInfo
- Next
- ApplicationSettings