When true, the selected glass shelf item will snap to the front when released.
var glassShelfComp = uComps.cast.toGlassShelf(comp);
glassShelfComp.allowSnapping = true;
The alpha transparency of the Component. Range from 0 to 100.
The vertical position of the camera. Range -100 to 100. Default is -100.
var glassShelfComp = uComps.cast.toGlassShelf(comp);
glassShelfComp.cameraOffsetY = 0;
When true, clicking a partially obsured card, will bring it to the center and front of the glass shelf.
var glassShelfComp = uComps.cast.toGlassShelf(comp);
glassShelfComp.centreCardOnSelection = true;
Clip the components contents using one of the options in ClippingType.
Access this Component's sub-components.
Index of the current item on display - Read Only.
var glassShelfComp = uComps.cast.toGlassShelf(comp);
var idx = glassShelfComp.currentIndex;
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 friction on items that takes effect when the user removes their finger. Range 0 to 1. Default is 0.03.
var glassShelfComp = uComps.cast.toGlassShelf(comp);
glassShelfComp.friction = 0.12;
The height of the Component.
The angle of the items on the shelf, not currently in focus. Range -80 to 80. Default is 45.
var glassShelfComp = uComps.cast.toGlassShelf(comp);
glassShelfComp.itemAngle = 20;
The position of the items on the shelf. Range -500 to 500. Default is 0.
var glassShelfComp = uComps.cast.toGlassShelf(comp);
glassShelfComp.itemDepth = 20;
Number of items in the glass shelf component - Read Only.
var glassShelfComp = uComps.cast.toGlassShelf(comp);
var count = glassShelfComp.itemsCount;
Shape component to be used as a mask. Can be either a Rectangle or Circle Component.
The maximum opacity of the glass shelf items. Range 0 to 100. Default is 100.
var glassShelfComp = uComps.cast.toGlassShelf(comp);
glassShelfComp.maxOpacity = 90;
Maximum speed the items can spin. Range 0 to 255. Default is 100.
var glassShelfComp = uComps.cast.toGlassShelf(comp);
glassShelfComp.maxSpeed = 130;
The minimum opacity of the glass shelf items. Range 0 to 100. Default is 0.
var glassShelfComp = uComps.cast.toGlassShelf(comp);
glassShelfComp.minOpacity = 20;
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.
Space between an item on the shelf, and its reflection. Range -100 to 100. Default is 0.
var glassShelfComp = uComps.cast.toGlassShelf(comp);
glassShelfComp.reflectionGap = 50;
The maximum opacity of the item's reflection. Range 0 to 100. Default is 50.
var glassShelfComp = uComps.cast.toGlassShelf(comp);
glassShelfComp.reflectionMaxOpacity = 90;
The minimum opacity of the item's reflection. Range 0 to 100. Default is 0.
var glassShelfComp = uComps.cast.toGlassShelf(comp);
glassShelfComp.reflectionMinOpacity = 20;
Size of the reflection. Range 0 to 1. Default is 0.5.
var glassShelfComp = uComps.cast.toGlassShelf(comp);
glassShelfComp.reflectionScale = 0.25;
Scale of items at the front of the shelf. Range 0.01 to 2. Default is 0.7
var glassShelfComp = uComps.cast.toGlassShelf(comp);
glassShelfComp.scaleMax = 0.9;
Scale of items not currently on the shelf. Range 0.01 to 2. Default is 0.42
var glassShelfComp = uComps.cast.toGlassShelf(comp);
glassShelfComp.scaleMin = 0.5;
The amount of friction on items that takes effect when the user removes their finger. Can be set if allowSnapping is true. Range 0 to 1. Default is 0.08.
var glassShelfComp = uComps.cast.toGlassShelf(comp);
glassShelfComp.allowSnapping = true;
glassShelfComp.snapFriction = 0.25;
The gap between items on the shelf. Range -0.5 to 0.5. Default is -0.3.
var glassShelfComp = uComps.cast.toGlassShelf(comp);
glassShelfComp.tileGap = -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.
Add an item to the glass shelf.
path to file from the images directory
var glassShelfComp = uComps.cast.toGlassShelf(comp);
galleryComp.addItem('candidates/nomination_1.jpg');
Call each callback that is registered for the given eventType
, in the order they were registered, passing the supplied data
to each.
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
.
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.
Remove an item to the glass shelf.
index of the item to remove. The first item has an index of 0.
var glassShelfComp = uComps.cast.toGlassShelf(comp);
galleryComp.removeItem(2);
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 Glass Shelf Component has been added to the page from the Component selector, the Glass Shelf Component can be passed as a parameter to actions. Code within the action can set properties and call methods on the Glass Shelf Component.