• Public
  • Public/Protected
  • All





alpha: number

The alpha transparency of the Component. Range from 0 to 100.

clippingType: ClippingType

Clip the components contents using one of the options in ClippingType.

components: ComponentList

Access this Component's sub-components.

dataUrl: string

Url of feed data from website or Umajin Cloud.

var feedComp = uComps.cast.toAnimatedFeed(comp);
var currentUrl = feedComp.dataUrl;
feedId: string

Id of the Umajin Cloud feed.

var feedComp = uComps.cast.toAnimatedFeed(comp);
feedComp.feedId = 20731;
formEnabled: boolean

Whether or not is component is enabled for the parent form. Only relevant when inside a Form Component.

formFieldName: string

Label used to identify the field this Component belongs to in a form. Only relevant when inside a Form Component.

height: number

The height of the Component.

indexColumnName: string

Define a column to use as the index column when it's not the default 'idx'.

var feedComp = uComps.cast.toAnimatedFeed(comp);
feedComp.indexColumnName = 'uniqueId';
json: string

The data as a JSON object.

var feedComp = uComps.cast.toAnimatedFeed(comp);
var currentData = feedComp.json;
mapping: Mapping

Shape component to be used as a mask. Can be either a Rectangle or Circle Component.

master: string
name: string

Name of the component.

parent: Component

Access this Component's parent component.

passedFormValidation: boolean

Whether or not the Component has passed form validation. Only relevant when inside a Form Component.

scrollAnimateY: number
scrollMax: number

Gets the maximum position of the feed list - Read Only.

var feedComp = uComps.cast.toAnimatedFeed(comp);
var max = feedComp.scrollMax;
scrollPosition: number

Position within the feed. For example, setting to 0, resets the feed to the top.

var feedComp = uComps.cast.toAnimatedFeed(comp);
feedComp.scrollPosition = 0;
type: string

Type of the component.

uniqueId: string

Unique ID of the component.

url: string

Sets the url for the data to be displayed in the Feed Item View

visible: boolean

Whether or not the Component is visible.

width: number

The width of the Component.

x: number

The x position of the Component relative to its parent.

y: number

The y position of the Component relative to its parent.


  • emit(eventType: string, data: Object): void
  • Call each callback that is registered for the given eventType, in the order they were registered, passing the supplied data to each.


    • eventType: string

      The type of the event to emit.

    • data: Object

      Data object to pass to each callback.

    Returns void

  • focus(): void
  • Set the keyboard focus to this component.

    new uActions.Action('set focus', setFocus)
    .addParameter('text entry',uActions.ParamType.TEXT_ENTRY)
    function setFocus(textEntry) {

    Returns void

  • forceFeedUpdate(): void
  • Update the feed item to display updated data.

    var feedComp = uComps.cast.toFeedItemView(comp);

    Returns void

  • get(propertyName: string): any
  • 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');


    • propertyName: string

      The name of the property to get.

    Returns any

    Returned value can be of any type, or even null.

  • on(eventType: string, callback: Function): void
  • Adds the callback function to the end of the listeners array for eventType.


    • eventType: string

      The type of the event.

    • callback: Function

      The callback function

    Returns void

  • refresh(): void
  • Refresh this component to force it to be re-rendered, or for its dynamic data to be updated.

    Returns void

  • set(propertyName: string, value: any): void
  • set(data: Object): void
  • 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');


    • propertyName: string

      The name of the property to set.

    • value: any

      The value to set. Can be of any type.

    Returns void

  • Set a number properties at once.


    • data: Object

      Data object containing property name and value pairs to set on this component.

    Returns void

  • setFeedItem(mode: string, index: number): void
  • Set the feed item that should be displayed.


    • mode: string


    • index: number

      index of item to display

      var feedComp = uComps.cast.toFeedItemView(comp);
      feedComp.setFeedItem(uComps.FeedSetMode.DATA_BOUND_INDEX, 2);

    Returns void

  • tween(seconds: number, params: Object, type?: TweenType): void
  • Tween a component property over time.


    • seconds: number

      The number of seconds to tween for.

    • params: Object

      An objects that contains key/value pairs of the properties and values to tween.

    • Optional type: TweenType

      (Optional) Tween type can be any type from "Tween.type"

    Returns void