Options
All
  • Public
  • Public/Protected
  • All
Menu

Once a Feed List Component has been added to the page from the Component selector, the name of the feed, created in JavaScript, can be selected as the Feed List Component's Feed ID. Create a Master with components that match the labels used in Mapping(), and assign the Master to the Feed List Component.

Hierarchy

Index

Constructors

Properties

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.

gridMode: boolean

When true, and if space is available, items will be displayed as a grid.

var feedComp = uComps.cast.toFeedList(comp);
feedComp.gridMode = true;
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';
itemSpacingX: number

When in grid mode, horizontal padding between items.

var feedComp = uComps.cast.toFeedList(comp);
feedComp.itemSpacingX = 10;
itemSpacingY: number

Vertical padding between items.

var feedComp = uComps.cast.toFeedList(comp);
feedComp.itemSpacingY = 10;
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.

paddingEnd: number

Padding to apply to the end of the list. Range 0 to 100. Default is 0.

var feedComp = uComps.cast.toFeedList(comp);
feedComp.paddingEnd = 5;
paddingStart: number

Padding to apply to the top of the list. Range 0 to 100. Default is 0.

var feedComp = uComps.cast.toFeedList(comp);
feedComp.paddingStart = 5;
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.

resizeToContent: boolean

When true, all the data will be displayed at once.

var feedComp = uComps.cast.toFeedList(comp);
feedComp.resizeToContent = true;
scrollAnimateY: number
scrollFriction: number

Friction on scroll movement. Range from 0.01 to 1. Default 0.1.

var feedComp = uComps.cast.toFeedList(comp);
feedComp.scrollFriction = 0.2;
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;
scrollVertically: boolean

Items scroll vertically when true, horizontally when false.

var feedComp = uComps.cast.toFeedList(comp);
feedComp.scrollVertically = true;
scrollbarDefaultFilename: string

Scrollbar image.

var feedComp = uComps.cast.toFeedList(comp);
feedComp.scrollbarDefaultFilename = 'scrollbar_v_9.png';
scrollbarDownFilename: string

Scrollbar image when pressed.

var feedComp = uComps.cast.toFeedList(comp);
feedComp.scrollbarDownFilename = 'scrollbar_v_bg_9.png';
scrollbarSize: number

Width of the scrollbar. Range 0.5 to 5. Default 1.5.

var feedComp = uComps.cast.toFeedList(comp);
feedComp.scrollbarSize = 1;
scrollbarSliceBottom: number

Preserve the edges and corners of the scrollbar. Editing Nine Slice values will apply to the scrollbar default, and down images. Bottom Slice: Stop the bottom of the scrollbar from being stretched.

var feedComp = uComps.cast.toFeedList(comp);
feedComp.scrollbarSliceBottom = 6;
scrollbarSliceLeft: number

Preserve the edges and corners of the scrollbar. Editing Nine Slice values will apply to the scrollbar default, and down images. Left Slice: Stop the left of the scrollbar from being stretched.

var feedComp = uComps.cast.toFeedList(comp);
feedComp.scrollbarSliceLeft = 6;
scrollbarSliceRight: number

Preserve the edges and corners of the scrollbar. Editing Nine Slice values will apply to the scrollbar default, and down images. Right Slice: Stop the right of the scrollbar from being stretched.

var feedComp = uComps.cast.toFeedList(comp);
feedComp.scrollbarSliceRight = 6;
scrollbarSliceTop: number

Preserve the edges and corners of the scrollbar. Editing Nine Slice values will apply to the scrollbar default, and down images. Top Slice: Stop the top of the scrollbar from being stretched.

var feedComp = uComps.cast.toFeedList(comp);
feedComp.scrollbarSliceTop = 6;
showScrollbars: boolean

When true, a scrollbar will appear within the Feed List Component.

var feedComp = uComps.cast.toFeedList(comp);
feedComp.showScrollbars = true;
type: string

Type of the component.

uniqueId: string

Unique ID of the component.

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.

Methods

  • Apply a filter to the data in the feedlist from a filter string, or the text from a text entry component

    Parameters

    • filter: string

      string of text to filter the data. Leave blank if using text from a text entry component.

    • columns: string

      pipe separated list of columns to search

    • Optional textField: TextEntryComponent

      (optional) - uses the text property of this Text Entry Component to filter the Feed List.

      var feedComp = uComps.cast.toFeedList(comp);
      var textComp = uComps.cast.toTextEntry(comp2);
      feedComp.applyFilter('', 'Title|Main Ingredient', textComp)

    Returns void

  • clearFilter(): void
  • Clears the filter applied to the Feed List

    var feedComp = uComps.cast.toFeedList(comp);
    feedComp.clearFilter();

    Returns void

  • 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.

    Parameters

    • 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)
    .register();
    function setFocus(textEntry) {
    textEntry.focus();
    }

    Returns void

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

    var feedComp = uComps.cast.toFeedList(comp);
    feedComp.forceFeedUpdate();

    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');
    console.log(text1.get('font_size'));
    }

    Parameters

    • 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.

    Parameters

    • 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

  • reset(): void
  • Resets the Feed List to the original settings.

    var feedComp = uComps.cast.toFeedList(comp);
    feedComp.reset();

    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');
    }

    Parameters

    • 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.

    Parameters

    • data: Object

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

    Returns void

  • setCustomFeed(jsonData: Object[], mapping: Mapping): any
  • Sets the Feed List with data and mapping values.

    Parameters

    Returns any

  • setCustomFeedRow(rowIndex: number, jsonData: Object): any
  • Set a single row of data in the feedlist.

    Parameters

    • rowIndex: number
    • jsonData: Object

    Returns any

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

    Parameters

    • 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