@maccesar/titools 3.2.0 → 4.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (102) hide show
  1. package/README.md +27 -61
  2. package/lib/cleanup.js +29 -0
  3. package/lib/commands/agents.js +8 -7
  4. package/lib/commands/skills.js +118 -23
  5. package/lib/config.js +13 -15
  6. package/lib/installer.js +5 -3
  7. package/lib/utils.js +36 -0
  8. package/package.json +1 -1
  9. package/skills/alloy-guides/SKILL.md +188 -0
  10. package/skills/alloy-guides/references/CLI_TASKS.md +233 -0
  11. package/skills/alloy-guides/references/CONCEPTS.md +171 -0
  12. package/skills/alloy-guides/references/CONTROLLERS.md +279 -0
  13. package/skills/alloy-guides/references/MODELS.md +742 -0
  14. package/skills/alloy-guides/references/MODELS_ADVANCED.md +482 -0
  15. package/skills/alloy-guides/references/PURGETSS.md +57 -0
  16. package/skills/alloy-guides/references/VIEWS_DYNAMIC.md +235 -0
  17. package/skills/alloy-guides/references/VIEWS_STYLES.md +375 -0
  18. package/skills/alloy-guides/references/VIEWS_WITHOUT_CONTROLLERS.md +102 -0
  19. package/skills/alloy-guides/references/VIEWS_XML.md +581 -0
  20. package/skills/alloy-guides/references/WIDGETS.md +160 -0
  21. package/skills/alloy-howtos/SKILL.md +179 -0
  22. package/skills/alloy-howtos/references/best_practices.md +121 -0
  23. package/skills/alloy-howtos/references/cli_reference.md +230 -0
  24. package/skills/alloy-howtos/references/config_files.md +158 -0
  25. package/skills/alloy-howtos/references/custom_tags.md +148 -0
  26. package/skills/alloy-howtos/references/debugging_troubleshooting.md +78 -0
  27. package/skills/alloy-howtos/references/samples.md +156 -0
  28. package/skills/purgetss/SKILL.md +184 -181
  29. package/skills/purgetss/references/EXAMPLES.md +8 -6
  30. package/skills/purgetss/references/app-branding.md +5 -0
  31. package/skills/purgetss/references/apply-directive.md +1 -1
  32. package/skills/purgetss/references/class-categories.md +1 -1
  33. package/skills/purgetss/references/class-index-properties.md +618 -0
  34. package/skills/purgetss/references/class-index.md +4 -610
  35. package/skills/purgetss/references/cli-commands.md +41 -410
  36. package/skills/purgetss/references/custom-fonts.md +292 -0
  37. package/skills/purgetss/references/custom-rules.md +1 -1
  38. package/skills/purgetss/references/customization-deep-dive.md +64 -1
  39. package/skills/purgetss/references/icon-fonts.md +208 -118
  40. package/skills/purgetss/references/installation-setup.md +4 -4
  41. package/skills/purgetss/references/migration-guide.md +53 -1
  42. package/skills/purgetss/references/multi-density-images.md +53 -2
  43. package/skills/purgetss/references/svg-pipeline.md +249 -0
  44. package/skills/purgetss/references/tikit-components.md +2 -2
  45. package/skills/purgetss/references/titanium-resets.md +2 -2
  46. package/skills/purgetss/references/ui-ux-design.md +7 -5
  47. package/skills/purgetss/references/version-history.md +71 -82
  48. package/skills/ti-api/SKILL.md +128 -0
  49. package/skills/ti-api/references/api-android.md +675 -0
  50. package/skills/ti-api/references/api-app-platform.md +636 -0
  51. package/skills/ti-api/references/api-core.md +764 -0
  52. package/skills/ti-api/references/api-data-network.md +641 -0
  53. package/skills/ti-api/references/api-media.md +655 -0
  54. package/skills/ti-api/references/api-modules-ble-bluetooth.md +657 -0
  55. package/skills/ti-api/references/api-modules-coremotion-urlsession.md +411 -0
  56. package/skills/ti-api/references/api-modules-map.md +632 -0
  57. package/skills/ti-api/references/api-modules-nfc.md +725 -0
  58. package/skills/ti-api/references/api-modules-social-misc.md +526 -0
  59. package/skills/ti-api/references/api-services.md +700 -0
  60. package/skills/ti-api/references/api-ui-android.md +499 -0
  61. package/skills/ti-api/references/api-ui-extras.md +702 -0
  62. package/skills/ti-api/references/api-ui-ios-animator.md +378 -0
  63. package/skills/ti-api/references/api-ui-ios.md +756 -0
  64. package/skills/ti-api/references/api-ui-lists.md +581 -0
  65. package/skills/ti-api/references/api-ui-text-input.md +607 -0
  66. package/skills/ti-api/references/api-ui-views.md +572 -0
  67. package/skills/ti-api/references/api-ui-windows-navigation.md +676 -0
  68. package/skills/ti-api/references/api-xml-global.md +743 -0
  69. package/skills/ti-guides/SKILL.md +82 -0
  70. package/skills/ti-guides/references/advanced-data-and-images.md +155 -0
  71. package/skills/ti-guides/references/android-manifest.md +97 -0
  72. package/skills/ti-guides/references/app-distribution.md +373 -0
  73. package/skills/ti-guides/references/application-frameworks.md +366 -0
  74. package/skills/ti-guides/references/cli-reference.md +700 -0
  75. package/skills/ti-guides/references/coding-best-practices.md +150 -0
  76. package/skills/ti-guides/references/commonjs-advanced.md +279 -0
  77. package/skills/ti-guides/references/hello-world.md +99 -0
  78. package/skills/ti-guides/references/hyperloop-native-access.md +458 -0
  79. package/skills/ti-guides/references/javascript-primer.md +402 -0
  80. package/skills/ti-guides/references/reserved-words.md +36 -0
  81. package/skills/ti-guides/references/resources.md +172 -0
  82. package/skills/ti-guides/references/style-and-conventions.md +104 -0
  83. package/skills/ti-guides/references/tiapp-config.md +655 -0
  84. package/skills/ti-howtos/SKILL.md +131 -0
  85. package/skills/ti-howtos/references/android-platform-deep-dives.md +609 -0
  86. package/skills/ti-howtos/references/automation-fastlane-appium.md +96 -0
  87. package/skills/ti-howtos/references/buffer-codec-streams.md +162 -0
  88. package/skills/ti-howtos/references/cross-platform-development.md +358 -0
  89. package/skills/ti-howtos/references/debugging-profiling.md +473 -0
  90. package/skills/ti-howtos/references/extending-titanium.md +684 -0
  91. package/skills/ti-howtos/references/google-maps-v2.md +172 -0
  92. package/skills/ti-howtos/references/ios-map-kit.md +149 -0
  93. package/skills/ti-howtos/references/ios-platform-deep-dives.md +595 -0
  94. package/skills/ti-howtos/references/local-data-sources.md +310 -0
  95. package/skills/ti-howtos/references/location-and-maps.md +267 -0
  96. package/skills/ti-howtos/references/media-apis.md +268 -0
  97. package/skills/ti-howtos/references/notification-services.md +539 -0
  98. package/skills/ti-howtos/references/remote-data-sources.md +339 -0
  99. package/skills/ti-howtos/references/tutorials.md +552 -0
  100. package/skills/ti-howtos/references/using-modules.md +182 -0
  101. package/skills/ti-howtos/references/web-content-integration.md +288 -0
  102. package/skills/ti-howtos/references/webpack-build-pipeline.md +125 -0
@@ -0,0 +1,572 @@
1
+ # Ti.UI Core Views API Reference
2
+
3
+ ## Ti.UI.View
4
+ > An empty drawing surface or container
5
+ > Extends Ti.Proxy
6
+ > Platforms: both
7
+
8
+ ### Properties (unique: 69/72)
9
+ | Property | Type | Platform | Description |
10
+ |----------|------|----------|-------------|
11
+ | accessibilityHidden | Boolean | both | Whether the view should be "hidden" from (i.e., i… |
12
+ | accessibilityHint | String | both | Briefly describes what performing an action (such… |
13
+ | accessibilityLabel | String | both | A succinct label identifying the view for the dev… |
14
+ | accessibilityValue | String | both | A string describing the value (if any) of the vie… |
15
+ | accessibilityDisableLongPress | Boolean | android | Boolean value to remove the long press notificati… |
16
+ | anchorPoint | Point | both | Coordinate of the view about which to pivot an an… |
17
+ | animatedCenter | Point | ios | Current position of the view during an animation. |
18
+ | backgroundColor | String \| Ti.UI.Color | both | Background color of the view, as a color name or … |
19
+ | backgroundDisabledColor | String | android | Disabled background color of the view, as a color… |
20
+ | backgroundDisabledImage | String | android | Disabled background image for the view, specified… |
21
+ | backgroundFocusedColor | String | android | Focused background color of the view, as a color … |
22
+ | backgroundFocusedImage | String | android | Focused background image for the view, specified … |
23
+ | backgroundGradient | Gradient | both | A background gradient for the view. |
24
+ | backgroundImage | String | both | Background image for the view, specified as a loc… |
25
+ | backgroundRepeat | Boolean | both | Determines whether to tile a background across a … |
26
+ | backgroundLeftCap | Number | ios | Size of the left end cap. |
27
+ | backgroundSelectedColor | String \| Ti.UI.Color | both | Selected background color of the view, as a color… |
28
+ | backgroundSelectedImage | String | android | Selected background image URL for the view, speci… |
29
+ | backgroundTopCap | Number | ios | Size of the top end cap. |
30
+ | borderColor | String \| Ti.UI.Color | both | Border color of the view, as a color name or hex … |
31
+ | borderRadius | Number \| String \| Array<Number> \| Array<String> | both | Radius for the rounded corners of the view's bord… |
32
+ | borderWidth | Number | both | Border width of the view. |
33
+ | bottom | Number \| String | both | View's bottom position, in platform-specific unit… |
34
+ | center | Point | both | View's center position, in the parent view's coor… |
35
+ | children | Array<Titanium.UI.View> | both | Array of this view's child views. |
36
+ | clipMode | Number | ios | View's clipping behavior. |
37
+ | elevation | Number | android | Base elevation of the view relative to its parent… |
38
+ | filterTouchesWhenObscured | Boolean | android | Discards touch related events if another app's sy… |
39
+ | focusable | Boolean | android | Whether view should be focusable while navigating… |
40
+ | height | Number \| String | both | View height, in platform-specific units. |
41
+ | hiddenBehavior | Number | android | Sets the behavior when hiding an object to releas… |
42
+ | horizontalMotionEffect | MinMaxOptions | ios | Adds a horizontal parallax effect to the view |
43
+ | id | String | both | View's identifier. |
44
+ | left | Number \| String | both | View's left position, in platform-specific units. |
45
+ | keepHardwareMode | Boolean | android | A value indicating the render mode of the View |
46
+ | layout | String | both | Specifies how the view positions its children. On… |
47
+ | opacity | Number | both | Opacity of this view, from 0.0 (transparent) to 1… |
48
+ | overrideCurrentAnimation | Boolean | android | When on, animate call overrides current animation… |
49
+ | pullBackgroundColor | String \| Ti.UI.Color | ios | Background color of the wrapper view when this vi… |
50
+ | previewContext | Ti.UI.iOS.PreviewContext | ios | The preview context used in the 3D-Touch feature … |
51
+ | right | Number \| String | both | View's right position, in platform-specific units. |
52
+ | rect | DimensionWithAbsolutes | both | The bounding box of the view relative to its pare… |
53
+ | rotation | Number | both | Clockwise 2D rotation of the view in degrees. |
54
+ | rotationX | Number | android | Clockwise rotation of the view in degrees (x-axis… |
55
+ | rotationY | Number | android | Clockwise rotation of the view in degrees (y-axis… |
56
+ | scaleX | Number | android | Scaling of the view in x-axis in pixels. |
57
+ | scaleY | Number | android | Scaling of the view in y-axis in pixels. |
58
+ | size | Dimension | both | The size of the view in system units. |
59
+ | softKeyboardOnFocus | Number | android | Determines keyboard behavior when this view is fo… |
60
+ | tintColor | String \| Ti.UI.Color | ios | The view's tintColor |
61
+ | tooltip | String | both | The default text to display in the control's tool… |
62
+ | top | Number \| String | both | The view's top position. |
63
+ | touchEnabled | Boolean | both | Determines whether view should receive touch even… |
64
+ | touchFeedback | Boolean | android | A material design visual construct that provides … |
65
+ | touchFeedbackColor | String | android | Optional touch feedback ripple color. This has no… |
66
+ | transform | Ti.UI.Matrix2D \| Ti.UI.Matrix3D | both | Transformation matrix to apply to the view. |
67
+ | translationX | Number | android | Horizontal location of the view relative to its l… |
68
+ | translationY | Number | android | Vertical location of the view relative to its top… |
69
+ | translationZ | Number | android | Depth of the view relative to its elevation in pi… |
70
+ | transitionName | String | android | A name to identify this view in activity transiti… |
71
+ | verticalMotionEffect | MinMaxOptions | ios | Adds a vertical parallax effect to the view |
72
+ | viewShadowRadius | Number \| String | ios | Determines the blur radius used to create the sha… |
73
+ | viewShadowColor | String \| Ti.UI.Color | both | Determines the color of the shadow. |
74
+ | viewShadowOffset | Point | ios | Determines the offset for the shadow of the view. |
75
+ | visible | Boolean | both | Determines whether the view is visible. |
76
+ | width | Number \| String | both | View's width, in platform-specific units. |
77
+ | horizontalWrap | Boolean | both | Determines whether the layout has wrapping behavi… |
78
+ | zIndex | Number | both | Z-index stack order position, relative to other s… |
79
+ | keepScreenOn | Boolean | android | Determines whether to keep the device screen on. |
80
+
81
+
82
+ ### Methods (13)
83
+ | Method | Returns | Platform | Description |
84
+ |--------|---------|----------|-------------|
85
+ | add(view) | void | both | Adds a child to this view's hierarchy. |
86
+ | animate(animation, callback) | void | both | Animates this view. |
87
+ | clearMotionEffects(—) | void | ios | Removes all previously added motion effects. |
88
+ | hide(options) | void | both | Hides this view. |
89
+ | insertAt(params) | void | both | Inserts a view at the specified position in the [… |
90
+ | remove(view) | void | both | Removes a child view from this view's hierarchy. |
91
+ | removeAllChildren(—) | void | both | Removes all child views from this view's hierarch… |
92
+ | replaceAt(params) | void | both | Replaces a view at the specified position in the … |
93
+ | show(options) | void | both | Makes this view visible. |
94
+ | stopAnimation(—) | void | android | Stops a running animation. |
95
+ | toImage(callback, honorScaleFactor) | Ti.Blob | both | Returns an image of the rendered view, as a Blob. |
96
+ | convertPointToView(point, destinationView) | Point | both | Translates a point from this view's coordinate sy… |
97
+ | getViewById(id) | Ti.UI.View | both | Returns the matching view of a given view ID. |
98
+
99
+ ### Events (17)
100
+ | Event | Platform | Description |
101
+ |-------|----------|-------------|
102
+ | click | both | Fired when the device detects a click against the view. |
103
+ | dblclick | both | Fired when the device detects a double click against the view. |
104
+ | doubletap | both | Fired when the device detects a double tap against the view. |
105
+ | focus | android | Fired when the view element gains focus. |
106
+ | keypressed | both | Fired when a hardware key is pressed in the view. |
107
+ | longclick | android | Fired when the device detects a long click. |
108
+ | longpress | both | Fired when the device detects a long press. |
109
+ | pinch | both | Fired when the device detects a pinch gesture. |
110
+ | postlayout | both | Fired when a layout cycle is finished. |
111
+ | rotate | both | Fired when the device detects a two finger rotation. |
112
+ | singletap | both | Fired when the device detects a single tap against the view. |
113
+ | swipe | both | Fired when the device detects a swipe gesture against the view. |
114
+ | touchcancel | both | Fired when a touch event is interrupted by the device. |
115
+ | touchend | both | Fired when a touch event is completed. |
116
+ | touchmove | both | Fired as soon as the device detects movement of a touch. |
117
+ | touchstart | both | Fired as soon as the device detects a touch gesture. |
118
+ | twofingertap | both | Fired when the device detects a two-finger tap against the view. |
119
+
120
+ ---
121
+
122
+ ## Ti.UI.Label
123
+ > A text label, with an optional background image.
124
+ > Extends Ti.UI.View
125
+ > Platforms: both
126
+
127
+ ### Properties (unique: 31/102)
128
+ | Property | Type | Platform | Description |
129
+ |----------|------|----------|-------------|
130
+ | attributedString | Ti.UI.AttributedString | both | Specify an attributed string for the label. |
131
+ | autoLink | Number | android | Automatically convert certain text items in the l… |
132
+ | autoSize | Boolean | android | Automatically scales the label into its size. |
133
+ | backgroundPaddingBottom | Number | ios | Number of pixels to extend the background image p… |
134
+ | backgroundPaddingLeft | Number | ios | Number of pixels to extend the background image p… |
135
+ | backgroundPaddingRight | Number | ios | Number of pixels to extend the background image p… |
136
+ | backgroundPaddingTop | Number | ios | Number of pixels to extend the background image p… |
137
+ | color | String \| Ti.UI.Color | both | Color of the label text, as a color name or hex t… |
138
+ | ellipsize | Number | both | Causes words in the text that are longer than the… |
139
+ | font | Font | both | Font to use for the label text. |
140
+ | highlightedColor | String \| Ti.UI.Color | both | Color of the label when in the highlighted state,… |
141
+ | html | String | both | Pass a HTML-based string and it will be formatted… |
142
+ | breakStrategy | Number | android | Break strategy (control over paragraph layout). C… |
143
+ | hyphenationFrequency | Number | android | Frequency of automatic hyphenation. Check [Androi… |
144
+ | includeFontPadding | Boolean | android | Includes extra top and bottom padding to make roo… |
145
+ | lines | Number | android | Makes the label be exactly this many lines tall. |
146
+ | lineCount | Number | both | Returns the amount of lines the content is actual… |
147
+ | letterSpacing | Number | android | Letter spacing of the [text](Titanium.UI.Label.te… |
148
+ | lineSpacing | LabelLineSpacing | android | Line spacing of the [text](Titanium.UI.Label.text… |
149
+ | maxLines | Number | both | Makes the label at most this many lines tall. |
150
+ | minimumFontSize | Number | both | Minimum font size when the font is sized based on… |
151
+ | shadowColor | String \| Ti.UI.Color | both | Shadow color of the [text](Titanium.UI.Label.text… |
152
+ | shadowOffset | Point | both | Shadow offset of the [text](Titanium.UI.Label.tex… |
153
+ | shadowRadius | Number | android | Shadow radius of the [text](Titanium.UI.Label.tex… |
154
+ | text | String | both | Label text. |
155
+ | textTransform | String | both | Property that specifies how to capitalize the tex… |
156
+ | textAlign | String \| Number | both | Text alignment. |
157
+ | textid | String | both | Key identifying a string from the locale file to … |
158
+ | visibleText | String | android | Returns the actual text seen on the screen. If th… |
159
+ | wordWrap | Boolean | android | Enable or disable word wrapping in the label. |
160
+ | verticalAlign | Number \| String | both | Vertical text alignment, specified using one of t… |
161
+
162
+
163
+
164
+ ### Events (1)
165
+ | Event | Platform | Description |
166
+ |-------|----------|-------------|
167
+ | link | both | Fired when user interacts with a URL in the Label. |
168
+
169
+ ---
170
+
171
+ ## Ti.UI.Button
172
+ > A button widget that has four states: normal, disabled, focused and selected.
173
+ > Extends Ti.UI.View
174
+ > Platforms: both
175
+
176
+ ### Properties (unique: 25/89)
177
+ | Property | Type | Platform | Description |
178
+ |----------|------|----------|-------------|
179
+ | backgroundDisabledImage | String | both | Background image for the button in its disabled s… |
180
+ | backgroundFocusedImage | String | both | Background image for the button in its focused st… |
181
+ | backgroundImage | String | both | Background image for the button in its normal sta… |
182
+ | backgroundSelectedColor | String \| Ti.UI.Color | both | Selected background color of the view, as a color… |
183
+ | backgroundSelectedImage | String | both | Background image for the button in its selected s… |
184
+ | tintColor | String | both | Color applied to button's image and title. |
185
+ | tooltip | String | both | The default text to display in the control's tool… |
186
+ | attributedString | Ti.UI.AttributedString | both | Specify an attributed string for the label. |
187
+ | color | String \| Ti.UI.Color | both | Default button text color, as a color name or hex… |
188
+ | disabledColor | String \| Ti.UI.Color | ios | Text color of the button in its disabled state, a… |
189
+ | configuration | Ti.UI.iOS.ButtonConfiguration \| Object | ios | Button configuration for modern button styling. |
190
+ | enabled | Boolean | both | Set to `true` to enable the button, `false` to di… |
191
+ | font | Font | both | Font to use for the button text. |
192
+ | image | String \| Number \| Ti.Blob | both | Image to display next to the button title. |
193
+ | imageIsMask | Boolean | both | Set true to tint the button image. Set false to s… |
194
+ | selectedColor | String \| Ti.UI.Color | ios | Button text color used to indicate the selected s… |
195
+ | shadowColor | String \| Ti.UI.Color | both | Shadow color of the [title](Titanium.UI.Button.ti… |
196
+ | shadowOffset | Point | both | Shadow offset of the [title](Titanium.UI.Button.t… |
197
+ | shadowRadius | Number | android | Shadow radius of the [title](Titanium.UI.Button.t… |
198
+ | style | Number | both | The border and fill style the button will use. |
199
+ | systemButton | Number | ios | Specifies an iOS system button appearance, as def… |
200
+ | textAlign | String \| Number | both | Text alignment, specified using one of the <Titan… |
201
+ | title | String | both | Button title. |
202
+ | titleid | String | both | Key identifying a string from the locale file to … |
203
+ | verticalAlign | Number \| String | both | Vertical alignment for the text field, specified … |
204
+
205
+
206
+
207
+ ### Events (1)
208
+ | Event | Platform | Description |
209
+ |-------|----------|-------------|
210
+ | touchfiltered | android | Fired when the device detects a swipe gesture against the view. |
211
+
212
+ ---
213
+
214
+ ## Ti.UI.ImageView
215
+ > A view to display a single image or series of animated images.
216
+ > Extends Ti.UI.View
217
+ > Platforms: both
218
+
219
+ ### Properties (unique: 17/87)
220
+ | Property | Type | Platform | Description |
221
+ |----------|------|----------|-------------|
222
+ | tintColor | String \| Ti.UI.Color | both | The view's tintColor. Android does not support se… |
223
+ | animating | Boolean | both | Indicates whether animation is running. |
224
+ | autorotate | Boolean | both | Indicates whether the image should be rotated bas… |
225
+ | decodeRetries | Number | android | Number of times to retry decoding the bitmap at a… |
226
+ | defaultImage | String | both | Local path to the default image to display while … |
227
+ | duration | Number | both | Amount of time in milliseconds to animate one cyc… |
228
+ | enableZoomControls | Boolean | android | Show zoom controls when the user touches the imag… |
229
+ | hires | Boolean | ios | Set to `true` to prevent scaling of 2x/3x-resolut… |
230
+ | image | String \| Ti.Blob \| Ti.Filesystem.File | both | Image to display. |
231
+ | imageTouchFeedback | Boolean | android | Enables a ripple effect when the foreground image… |
232
+ | imageTouchFeedbackColor | String | android | Optional touch feedback ripple color. This has no… |
233
+ | images | Array<String> \| Array<Titanium.Blob> \| Array<Titanium.Filesystem.File> | both | Array of images to animate, defined using local f… |
234
+ | paused | Boolean | both | Indicates whether the animation is paused. |
235
+ | preventDefaultImage | Boolean | ios | Prevent the default image from being displayed wh… |
236
+ | repeatCount | Number | both | Number of times to repeat the image animation. |
237
+ | reverse | Boolean | both | Run the animation in reverse. |
238
+ | scalingMode | Number | both | Determines how the image is scaled within the vie… |
239
+
240
+
241
+ ### Methods (6)
242
+ | Method | Returns | Platform | Description |
243
+ |--------|---------|----------|-------------|
244
+ | pause(—) | void | both | Pauses a running animation. Use `resume` method t… |
245
+ | resume(—) | void | both | Resumes an animation from a `pause` state. |
246
+ | start(—) | void | both | Starts the image animation. On Android, also rese… |
247
+ | stop(—) | void | both | Stops a running animation. On iOS, also resets `i… |
248
+ | toBlob(—) | Ti.Blob | both | Returns the image as a Blob object. |
249
+ | addSymbolEffect(symbolEffect, options, animated, callback) | void | ios | Adds a symbol effect to the image view with speci… |
250
+
251
+ ### Events (6)
252
+ | Event | Platform | Description |
253
+ |-------|----------|-------------|
254
+ | change | both | Fired for each frame change during an animation. |
255
+ | load | both | Fired when either the initial image and/or all of the images in an animation ar… |
256
+ | start | both | Fired when the animation starts. |
257
+ | stop | both | Fired when the animation stops. |
258
+ | error | both | Fired when an image fails to load. |
259
+ | pause | both | Fired when the animation pauses. |
260
+
261
+ ---
262
+
263
+ ## Ti.UI.ScrollView
264
+ > A view that contains a horizontally and/or vertically-scrollable region of content.
265
+ > Extends Ti.UI.View
266
+ > Platforms: both
267
+
268
+ ### Properties (unique: 21/93)
269
+ | Property | Type | Platform | Description |
270
+ |----------|------|----------|-------------|
271
+ | canCancelEvents | Boolean | both | Determines whether this scroll view can cancel su… |
272
+ | contentHeight | Number \| String | both | Height of the scrollable region. |
273
+ | contentOffset | Point | both | X and Y coordinates to which to reposition the to… |
274
+ | contentWidth | Number \| String | both | Width of the scrollable region. |
275
+ | decelerationRate | Number | ios | The deceleration rate of the ScrollView. |
276
+ | edgeEffect | Dictionary | ios | Configures the edge effects displayed when the sc… |
277
+ | disableBounce | Boolean | ios | Determines whether scroll bounce of the scrollabl… |
278
+ | horizontalBounce | Boolean | ios | Determines whether horizontal scroll bounce of th… |
279
+ | keyboardDismissMode | Number | ios | The manner in which the keyboard is dismissed whe… |
280
+ | maxZoomScale | Number | ios | Maximum scaling factor of the scrollable region a… |
281
+ | minZoomScale | Number | ios | Minimum scaling factor of the scrollable region a… |
282
+ | overScrollMode | Number | android | Determines the behavior when the user overscolls … |
283
+ | refreshControl | Ti.UI.RefreshControl | both | View positioned above the first row that is only … |
284
+ | scrollsToTop | Boolean | ios | Controls whether the scroll-to-top gesture is eff… |
285
+ | scrollIndicatorStyle | Number | ios | Style of the scrollbar. |
286
+ | scrollType | String | android | Limits the direction of the scrollable region, ov… |
287
+ | scrollingEnabled | Boolean | both | Determines whether scrolling is enabled for the v… |
288
+ | showHorizontalScrollIndicator | Boolean | both | Determines whether the horizontal scroll indicato… |
289
+ | showVerticalScrollIndicator | Boolean | both | Determines whether the vertical scroll indicator … |
290
+ | verticalBounce | Boolean | ios | Determines whether vertical scroll bounce of the … |
291
+ | zoomScale | Number | ios | Scaling factor of the scroll view's content. |
292
+
293
+
294
+ ### Methods (5)
295
+ | Method | Returns | Platform | Description |
296
+ |--------|---------|----------|-------------|
297
+ | scrollTo(x, y, options) | void | both | Moves the specified coordinate of the scrollable … |
298
+ | setContentOffset(contentOffsetXY, animated) | void | ios | Sets the value of the [contentOffset](Titanium.UI… |
299
+ | setZoomScale(zoomScale, options) | void | ios | Sets the value of the [zoomScale](Titanium.UI.Scr… |
300
+ | scrollToBottom(—) | void | both | Moves the end of the scrollable region into the v… |
301
+ | scrollToTop(—) | void | both | Moves the top of the scrollable region into the v… |
302
+
303
+ ### Events (6)
304
+ | Event | Platform | Description |
305
+ |-------|----------|-------------|
306
+ | scale | ios | Fired when the zoom scale factor changes. |
307
+ | scroll | both | Fired when the scrollable region is scrolled. |
308
+ | dragStart | ios | Fired when the scrollable region starts being dragged. |
309
+ | dragEnd | ios | Fired when the scrollable region stops being dragged. |
310
+ | dragstart | both | Fired when the scrollable region starts being dragged. |
311
+ | dragend | both | Fired when the scrollable region stops being dragged. |
312
+
313
+ ---
314
+
315
+ ## Ti.UI.ScrollableView
316
+ > A view that encapsulates a horizontally-scrolling set of child views, known as pages, navigable using its built-in horizontal swipe gestures.
317
+ > Extends Ti.UI.View
318
+ > Platforms: both
319
+
320
+ ### Properties (unique: 20/91)
321
+ | Property | Type | Platform | Description |
322
+ |----------|------|----------|-------------|
323
+ | cacheSize | Number | both | Number of pages to cache (pre-render). |
324
+ | currentPage | Number | both | Index of the active page. |
325
+ | currentPageIndicatorColor | String \| Ti.UI.Color | ios | Color for the current page of the paging control,… |
326
+ | disableBounce | Boolean | ios | Determines whether page bouncing effect is disabl… |
327
+ | overScrollMode | Number | android | Determines the behavior when the user overscolls … |
328
+ | pagingControlColor | String \| Ti.UI.Color | ios | Color of the paging control, as a color name or h… |
329
+ | preferredIndicatorImage | String \| Ti.Blob | ios | The preferred image for indicators, defined using… |
330
+ | pagingControlHeight | Number | ios | Height of the paging control, in pixels. |
331
+ | pageIndicatorColor | String \| Ti.UI.Color | ios | Color of the paging control, as a color name or h… |
332
+ | scrollType | String | android | Direction of the ScrollableView (`horizontal` or … |
333
+ | showPagingControl | Boolean | both | Determines whether the paging control is visible. |
334
+ | pagingControlTimeout | Number | android | Number of milliseconds to wait before hiding the … |
335
+ | pagingControlAlpha | Number | ios | Alpha value of the paging control. |
336
+ | pagingControlOnTop | Boolean | ios | Determines whether the paging control is displaye… |
337
+ | overlayEnabled | Boolean | ios | Determines whether the paging control is added as… |
338
+ | scrollingEnabled | Boolean | both | Determines whether scrolling is enabled for the v… |
339
+ | views | Array<Titanium.UI.View> | both | Sets the pages within this Scrollable View. |
340
+ | clipViews | Boolean | both | Determines whether the previous and next pages ar… |
341
+ | hitRect | Dimension | ios | Sets the region where this view responds to gestu… |
342
+ | padding | Padding | android | The padding applied to the scrollable view. |
343
+
344
+
345
+ ### Methods (7)
346
+ | Method | Returns | Platform | Description |
347
+ |--------|---------|----------|-------------|
348
+ | insertViewsAt(position, views) | void | both | Inserts views at the specified position in the [v… |
349
+ | addView(view) | void | both | Adds a new page to this Scrollable View. |
350
+ | moveNext(—) | void | both | Sets the current page to the next consecutive pag… |
351
+ | movePrevious(—) | void | both | Sets the current page to the previous consecutive… |
352
+ | removeView(view) | void | both | Removes an existing page from this Scrollable Vie… |
353
+ | scrollToView(view) | void | both | Scrolls to the specified page in <Titanium.UI.Scr… |
354
+ | setIndicatorImageForPage(image, pageNo) | void | ios | Sets the indicator image for the specified page. |
355
+
356
+ ### Events (10)
357
+ | Event | Platform | Description |
358
+ |-------|----------|-------------|
359
+ | dblclick | ios | Fired when the device detects a double click against the view. |
360
+ | doubletap | ios | Fired when the device detects a double tap against this page. |
361
+ | longpress | ios | Fired when the device detects a long press against this view. |
362
+ | singletap | ios | Fired when the device detects a single tap against this view. |
363
+ | touchcancel | ios | Fired when a touch gesture is interrupted by the device. |
364
+ | touchstart | ios | Fired as soon as the device detects a touch gesture against this view. |
365
+ | twofingertap | ios | Fired when the device detects a two-finger tap against the view. |
366
+ | scroll | both | Fired repeatedly as the view is being scrolled. |
367
+ | scrollend | both | Fired when the view has stopped moving completely. |
368
+ | dragend | android | Fired when the scrolling drag gesture on the view has been completed. |
369
+
370
+ ---
371
+
372
+ ## Ti.UI.ActivityIndicator
373
+ > An activity indicator that lets the user know an action is taking place.
374
+ > Extends Ti.UI.View
375
+ > Platforms: both
376
+
377
+ ### Properties (unique: 12/36)
378
+ | Property | Type | Platform | Description |
379
+ |----------|------|----------|-------------|
380
+ | bottom | Number \| String | both | Bottom position of the view. |
381
+ | height | String | both | Width of the view. Only accepts value of <Titaniu… |
382
+ | left | Number \| String | both | Left position of the view. |
383
+ | right | Number \| String | both | Right position of the view. |
384
+ | top | Number \| String | both | Top position of the view. |
385
+ | width | String | both | Width of the view. Only accepts value of <Titaniu… |
386
+ | color | String \| Ti.UI.Color | both | Color of the message text, as a color name or hex… |
387
+ | font | Font | both | Font used for the message text. |
388
+ | indicatorColor | String \| Ti.UI.Color | both | Color of the animated indicator. |
389
+ | message | String | both | Message text. |
390
+ | messageid | String | both | Key identifying a string in the locale file to us… |
391
+ | style | Number | both | The style for the activity indicator. |
392
+
393
+
394
+ ### Methods (2)
395
+ | Method | Returns | Platform | Description |
396
+ |--------|---------|----------|-------------|
397
+ | hide(options) | void | both | Hides the activity indicator and stops the animat… |
398
+ | show(options) | void | both | Shows the activity indicator and starts the anima… |
399
+
400
+
401
+ ---
402
+
403
+ ## Ti.UI.ActivityIndicatorStyle
404
+ > A set of constants for the styles available for <Titanium.UI.ActivityIndicator> objects.
405
+ > Extends Ti.Module
406
+ > Platforms: both
407
+ > Type: module
408
+
409
+ ### Constants (4)
410
+ - **BIG_\***: BIG_DARK
411
+ - **OTHER_\***: BIG, DARK, PLAIN
412
+
413
+
414
+
415
+
416
+ ---
417
+
418
+ ## Ti.UI.ProgressBar
419
+ > A progress bar.
420
+ > Extends Ti.UI.View
421
+ > Platforms: both
422
+
423
+ ### Properties (unique: 10/80)
424
+ | Property | Type | Platform | Description |
425
+ |----------|------|----------|-------------|
426
+ | tintColor | String \| Ti.UI.Color | both | The color shown for the portion of the progress b… |
427
+ | animated | Boolean | both | Enables smooth progress change animation when cha… |
428
+ | color | String \| Ti.UI.Color | both | Color of the progress bar message, as a color nam… |
429
+ | font | Font | ios | Font for the progress bar text. |
430
+ | max | Number | both | Maximum value of the progress bar. |
431
+ | message | String | both | Progress bar text. |
432
+ | trackTintColor | String \| Ti.UI.Color | both | The color shown for the portion of the progress b… |
433
+ | min | Number | both | Minimum value of the progress bar. |
434
+ | style | Number | ios | Style of the progress bar. |
435
+ | value | Number | both | Current value of the progress bar. |
436
+
437
+
438
+
439
+
440
+ ---
441
+
442
+ ## Ti.UI.Slider
443
+ > A slider component with a draggable thumb.
444
+ > Extends Ti.UI.View
445
+ > Platforms: both
446
+
447
+ ### Properties (unique: 25/94)
448
+ | Property | Type | Platform | Description |
449
+ |----------|------|----------|-------------|
450
+ | tintColor | String \| Ti.UI.Color | both | The color shown for the portion of the progress b… |
451
+ | disabledLeftTrackImage | String | ios | Image URL of the slider left track when in the di… |
452
+ | disabledRightTrackImage | String | ios | Image URL of the slider right track when in the d… |
453
+ | disabledThumbImage | String | ios | Image URL of the slider thumb when in the disable… |
454
+ | enabled | Boolean | both | Boolean to indicate the enabled state of the slid… |
455
+ | highlightedLeftTrackImage | String | ios | Image URL of the slider left track when in the hi… |
456
+ | highlightedRightTrackImage | String | ios | Image URL of the slider right track when in the h… |
457
+ | highlightedThumbImage | String | ios | Image URL of the slider thumb when in the highlig… |
458
+ | leftTrackImage | String | both | Image URL of the slider left track. |
459
+ | leftTrackLeftCap | Number | ios | Size of the left end cap for the leftTrackImage, … |
460
+ | leftTrackTopCap | Number | ios | Size of the top end cap for the leftTrackImage, d… |
461
+ | max | Number | both | Maximum value of the slider. |
462
+ | maxRange | Number | android | Upper limit on the slider value that can be selec… |
463
+ | min | Number | both | Minimum value of the slider. |
464
+ | minRange | Number | android | Lower limit on the slider value that can be selec… |
465
+ | rightTrackImage | String | both | Image URL of the slider right track. |
466
+ | rightTrackLeftCap | Number | ios | Size of the left end cap for the rightTrackImage,… |
467
+ | rightTrackTopCap | Number | ios | Size of the top end cap for the rightTrackImage, … |
468
+ | selectedLeftTrackImage | String | ios | Image URL of the slider left track when in the se… |
469
+ | selectedRightTrackImage | String | ios | Image URL of the slider right track when in the s… |
470
+ | selectedThumbImage | String | ios | Image URL of the slider thumb when in the selecte… |
471
+ | splitTrack | Boolean | android | Separates the thumbImage from the slider track. |
472
+ | thumbImage | String \| Ti.Blob | both | Image for the slider thumb. |
473
+ | trackTintColor | String \| Ti.UI.Color | both | The color shown for the portion of the progress b… |
474
+ | value | Number | both | Current value of the slider. |
475
+
476
+
477
+ ### Methods (1)
478
+ | Method | Returns | Platform | Description |
479
+ |--------|---------|----------|-------------|
480
+ | setValue(value, options) | void | ios | Sets the [value](Titanium.UI.Slider.value) proper… |
481
+
482
+ ### Events (4)
483
+ | Event | Platform | Description |
484
+ |-------|----------|-------------|
485
+ | click | android | Fired when the device detects a click against the view. |
486
+ | change | both | Fired when the value of the slider changes. |
487
+ | start | both | Fired when the user starts tracking the slider. |
488
+ | stop | both | Fired when the user stops tracking the slider. |
489
+
490
+ ---
491
+
492
+ ## Ti.UI.Switch
493
+ > An on/off switch control.
494
+ > Extends Ti.UI.View
495
+ > Platforms: both
496
+
497
+ ### Properties (unique: 16/86)
498
+ | Property | Type | Platform | Description |
499
+ |----------|------|----------|-------------|
500
+ | tintColor | String \| Ti.UI.Color | both | The color used to tint the outline of the switch … |
501
+ | animated | Boolean | ios | Determines if there is animation when the switch … |
502
+ | color | String \| Ti.UI.Color | android | Color to use for switch text, as a color name or … |
503
+ | enabled | Boolean | both | Determines whether the switch is enabled. |
504
+ | font | Font | android | Font to use for the switch text. |
505
+ | style | Number | both | Style of the switch. |
506
+ | textAlign | String \| Number | android | Horizontal text alignment of the switch title. |
507
+ | title | String | android | Text to display next to the switch, when the chec… |
508
+ | titleOff | String | android | Text to display on the switch in its "off" state,… |
509
+ | titleOn | String | android | Text to display on the switch in its "on" state, … |
510
+ | onThumbColor | String \| Ti.UI.Color | android | — |
511
+ | thumbColor | String \| Ti.UI.Color | android | — |
512
+ | onTintColor | String \| Ti.UI.Color | both | The color used to tint the appearance of the swit… |
513
+ | thumbTintColor | String \| Ti.UI.Color | ios | The color used to tint the appearance of the thum… |
514
+ | value | Boolean | both | Indicates whether the switch has been turned on o… |
515
+ | verticalAlign | Number \| String | android | Vertical alignment for the text field. |
516
+
517
+
518
+
519
+ ### Events (2)
520
+ | Event | Platform | Description |
521
+ |-------|----------|-------------|
522
+ | click | android | Fired when the device detects a click against the view. |
523
+ | change | both | Fired when the switch value changes. |
524
+
525
+ ---
526
+
527
+ ## Ti.UI.MaskedImage
528
+ > A control that displays an image composited with a background image or color.
529
+ > Extends Ti.UI.View
530
+ > Platforms: both
531
+
532
+ ### Properties (unique: 4/75)
533
+ | Property | Type | Platform | Description |
534
+ |----------|------|----------|-------------|
535
+ | mask | String | both | Image drawn as the background image. |
536
+ | image | String | both | Image drawn as the Foreground image. |
537
+ | mode | Number | both | Blend mode to use to combine layers. |
538
+ | tint | String \| Ti.UI.Color | both | Color to combine with the image, as a color name … |
539
+
540
+
541
+
542
+
543
+ ---
544
+
545
+ ## Ti.UI.RefreshControl
546
+ > The RefreshControl is a representation of the native iOS [UIRefreshControl](https://developer.apple.com/documentation/uikit/uirefreshcontrol) and Android [SwipeRefreshLayout](https://developer.android.com/reference/android/support/v4/widget/SwipeRefreshLayout.html).
547
+ > Extends Ti.Proxy
548
+ > Platforms: both
549
+
550
+ ### Properties (unique: 4/7)
551
+ | Property | Type | Platform | Description |
552
+ |----------|------|----------|-------------|
553
+ | title | Ti.UI.AttributedString | ios | The attributed title of the control. |
554
+ | tintColor | String \| Ti.UI.Color | both | The tint color for the refresh control, as a colo… |
555
+ | offset | RefreshControlOffset | android | Offset of the refresh control view. |
556
+ | backgroundColor | String \| Ti.UI.Color | ios | The background color for the refresh control, as … |
557
+
558
+
559
+ ### Methods (2)
560
+ | Method | Returns | Platform | Description |
561
+ |--------|---------|----------|-------------|
562
+ | beginRefreshing(—) | void | both | Tells the control that a refresh operation was st… |
563
+ | endRefreshing(—) | void | both | Tells the control that a refresh operation has en… |
564
+
565
+ ### Events (2)
566
+ | Event | Platform | Description |
567
+ |-------|----------|-------------|
568
+ | refreshstart | both | Fired in response to a user initiated an action to refresh the contents of the … |
569
+ | refreshend | both | Fired in response to a user finished action to refresh the contents of the tabl… |
570
+
571
+ ---
572
+