The alpha transparency of the Component. Range from 0 to 100.
Slider to control size of the button's corners.
var buttonComp = uComps.cast.toButton(comp);
buttonComp.borderScale = 10;
Clip the components contents using one of the options in ClippingType.
Access this Component's sub-components.
Image that will display on the button when in the normal display state.
var buttonComp = uComps.cast.toButton(comp);
buttonComp.defaultFilename = 'presets/light_grey.png';
Image that will display on the button when the button is disabled.
var buttonComp = uComps.cast.toButton(comp);
buttonComp.disabledFilename = 'presets/dark_grey.png';
Image that will display on the button when in the down, or pressed state.
var buttonComp = uComps.cast.toButton(comp);
buttonComp.downFilename = 'presets/dark_blue.png';
Enable or disable the button.
var buttonComp = uComps.cast.toButton(comp);
buttonComp.enabled = false;
The font file to use for the button text.
var buttonComp = uComps.cast.toButton(comp);
buttonComp.font = 'vera.ttf'
Color for button text as a hexadecimal value. The alpha channel will be added, if not included.
var buttonComp = uComps.cast.toButton(comp);
buttonComp.fontColor = '#631B1B';
//buttonComp.fontColor = '#631B1BAA'; //Alpha channel set to be partially transparent
The font size for the button text.
var buttonComp = uComps.cast.toButton(comp);
buttonComp.fontSize = 10;
Whether or not is component is enabled for the parent form. Only relevant when inside a Form Component.
Label used to identify the field this Component belongs to in a form. Only relevant when inside a Form Component.
The height of the Component.
Show or hide the text on the button.
var buttonComp = uComps.cast.toButton(comp);
buttonComp.hideText = true;
Sets the icon from the Image folder, to show as an icon on the button.
var buttonComp = uComps.cast.toButton(comp);
buttonComp.iconFilename = 'star_on.png;
Adjust the size of the icon on the button Range 0.2 to 1 (full size).
var buttonComp = uComps.cast.toButton(comp);
buttonComp.iconScale = 0.5;
Set the horizontal position of the icon on the button. Range 0 to 1.
var buttonComp = uComps.cast.toButton(comp);
buttonComp.iconX = 0.13;
Set the vertical position of the icon on the button. Range 0 to 1.
var buttonComp = uComps.cast.toButton(comp);
buttonComp.iconY = 0.5;
When true, this maintains the aspect ratio of the button during resizing.
var buttonComp = uComps.cast.toButton(comp);
buttonComp.keepAspectRatio = true;
Shape component to be used as a mask. Can be either a Rectangle or Circle Component.
Name of the component.
Access this Component's parent component.
Whether or not the Component has passed form validation. Only relevant when inside a Form Component.
Set border to scale with screen or be fixed.
var buttonComp = uComps.cast.toButton(comp);
buttonComp.scaleBorderWithScreen = true;
Preserve the edges and corners of the image. Editing Nine Slice values will apply to the button default, down and disabled images. Bottom Slice: Stop the bottom of the image from being stretched.
var buttonComp = uComps.cast.toButton(comp);
sliceBottom.sliceBottom = 6;
Preserve the edges and corners of the image. Editing Nine Slice values will apply to the button default, down and disabled images. Left Slice: Stop the left of the image from being stretched.
var buttonComp = uComps.cast.toButton(comp);
buttonComp.sliceLeft = 8;
Preserve the edges and corners of the image. Editing Nine Slice values will apply to the button default, down and disabled images. Right Slice: Stop the right of the image from being stretched.
var buttonComp = uComps.cast.toButton(comp);
buttonComp.sliceRight = 8;
Preserve the edges and corners of the image. Editing Nine Slice values will apply to the button default, down and disabled images. Top Slice: Stop the top of the image from being stretched.
var buttonComp = uComps.cast.toButton(comp);
buttonComp.sliceTop = 6;
Text to appear on the button.
var buttonComp = uComps.cast.toButton(comp);
buttonComp.text = 'Start';
Resize as fixed (font will stay the same size regardless of device) or Scale with Screen..
var buttonComp = uComps.cast.toButton(comp);
buttonComp.textScaling = uComps.TextScaling.SCALE_WITH_SCREEN;
Set the horizontal position of the text on the button. Range 0 to 1.
var buttonComp = uComps.cast.toButton(comp);
buttonComp.textX = 0.5;
Set the vertical position of the text on the button. Range 0 to 1.
var buttonComp = uComps.cast.toButton(comp);
buttonComp.textY = 0.5;
The distance between text characters. Range -5 to 10. Default is 0.
var buttonComp = uComps.cast.toButton(comp);
buttonComp.tracking = 0.2
Type of the component.
Unique ID of the component.
Whether or not the Component is visible.
The width of the Component.
The x position of the Component relative to its parent.
The y position of the Component relative to its parent.
Call each callback that is registered for the given eventType
, in the order they were registered, passing the supplied data
to each.
Also works for 'on_down', 'on_up', and 'on_move'.
new Action('Canvas emit', emit)
.addParameter('Canvas', uActions.ParamType.CANVAS)
.register();
function emit(canvas) {
var ctx = uComps.cast.toCanvas(canvas);
ctx.emit('on_press', 'hello world');
}
The type of the event to emit.
Data object to pass to each callback.
Set the keyboard focus to this component.
new uActions.Action('set focus', setFocus)
.addParameter('text entry',uActions.ParamType.TEXT_ENTRY)
.register();
function setFocus(textEntry) {
textEntry.focus();
}
Get a property by name.
var uActions = require('u-actions');
new uActions.Action('get fontsize',getFontSize).register();
function getFontSize() {
var text1=uPages.current.components.getText('Text 1');
console.log(text1.get('font_size'));
}
The name of the property to get.
Returned value can be of any type, or even null.
Adds the callback
function to the end of the listeners array for eventType
.
new Action('Canvas on', on)
.addParameter('Canvas', uActions.ParamType.CANVAS)
.register();
function on(canvas) {
var ctx = uComps.cast.toCanvas(canvas);
ctx.on('on_press', on_callback);
}
function on_callback() {
print('on_callback!!!!');
}
The type of the event.
The callback function
Refresh this component to force it to be re-rendered, or for its dynamic data to be updated.
Set a properties value by name.
var uActions = require('u-actions');
new uActions.Action('set text color',setTextColor).register();
function setTextColor() {
uPages.get('follow').components.getText('Text 1').set('font_color','0x0000FFFF');
}
The name of the property to set.
The value to set. Can be of any type.
Set a number properties at once.
Data object containing property name and value pairs to set on this component.
Tween a component property over time.
The number of seconds to tween for.
An objects that contains key/value pairs of the properties and values to tween.
(Optional) Tween type can be any type from "Tween.type"
Once a Button Component has been added to the page from the Component selector, the Button Component can be passed as a parameter to actions. Code within the action can set properties on the Button Component.