aps/Gallery

This widget container is used to display the list of media files (images, videos, pdfs) with an ability to open the original file in a modal dialog.

Public Properties

PROPERTY	TYPE	DEFAULT	DESCRIPTION
description	string	“”	Text under the header of the Gallery and over the content of it.
disabled	boolean	false	Specifies if the widget will respond to user input.
gridSize	string	undefined	This specifies the widget width that is relevant only for widgets inside Container, FieldSet, or Tiles.
isBusy	boolean	false	If the widget is busy then this property is true.
label	string	“”	Text that is shown as a label if the widget is placed inside a aps/FieldSet.
oneItemStep	boolean	false	If this property is true you can scroll one item at a time.
store	aps/store	null	An instance of the “aps/Store” model, from which to fetch data.
title	string	“”	Text that is shown in the header of the Gallery.
visible	boolean	true	If this property value is set to true, then the widget is visible.

description string

Text under the header of the Gallery and over the content of it. Default value: “”.

disabled boolean

Specifies if the widget will respond to user input.

Default value: false.

gridSize string

This specifies the widget width that is relevant only for widgets inside Container, FieldSet, or Tiles. In other cases it will be ignored.

gridSize string contains few options with number values (from 1 to 12) separated by spaces, which specify the grid size of the widget in different layouts:

- md - desktop

- xs - phone

For example, gridSize: “md-4 xs-2”.

All values below 1, e.g. “md-0”, will be replaced with the empty string (“”), values above 12, e.g. “md-14”, will be reduced to 12 (“md-12”).

Default value: undefined.

isBusy boolean

If the widget is busy then this property is true.

Default value: false.

label string

Text that is shown as a label if the widget is placed inside a aps/FieldSet.

Default value: “”.

oneItemStep boolean

If this property is true you can scroll one item at a time. If it is false - one page at a time. In mobile mode this propery is alwaes true; Default value: false.

store aps/store

An instance of the “aps/Store” model, from which to fetch data. Default value: null.

title string

Text that is shown in the header of the Gallery. Default value: “”.

visible boolean

If this property value is set to true, then the widget is visible.

Default value: true.

Public Methods

METHOD	RETURN	DESCRIPTION
cancel ()	object	Sets the isBusy property to false
destroy ()	undefined	Destroys this widget
get ()	any	Get a property of the Stateful instance
getParents ()	array	Discover and return all parents of the widget
placeAt ()	dijit/_widgetbase function	Place this widget somewhere in the DOM based on standard dojo/dom-construct::place() conventions
set ()	object function	Set a property of the Stateful instance
startup ()

cancel

Sets the isBusy property to false.

Return: object

destroy

Destroys this widget. Will also destroy any resources (including widgets) registered via this.own(). This method will also destroy internal widgets such as those created from a template.

Return: undefined

get

Get a property of the Stateful instance. Get a named property of the Stateful object. The property may potentially be retrieved via a getter method in subclasses.

In the base class, this just retrieves the object’s property.

Return: any

getParents

Discover and return all parents of the widget.

Return: array

placeAt

Place this widget somewhere in the DOM based on standard dojo/dom-construct::place() conventions. A convenience function providing a simple shorthand mechanism to put an existing (or newly created) widget somewhere in the DOM, and allow chaining.

Return: dijit/_widgetbase function

set

Set a property of the Stateful instance. Sets named properties of the stateful object and notifies the watchers of the property. A programmatic setter may be defined in subclasses.

Return: object function

startup

Public Events

EVENT	RETURN	DESCRIPTION
onClick ()	undefined	The method is called when a user clicks on the widget

onClick

The method is called when a user clicks on the widget.

← aps/FieldSet

aps/Gauge →