Share via


Usage Bars fxUsageBars (fx.usagebars.js)

 

Applies To: Windows Azure Pack

fxUsageBars Displays a percentage with units and scaling. Useful for quotas or throughput.

Windows Azure Pack fxUsageBars

Supported Services

Service

Supported

Undo/Redo

Not Applicable

Validation

Not Applicable

Widgets

$("Selector").fxUsageBars()

Properties

Name

Type

Description

fx.fxUsageBars.options.atCapacityName

String

At capacity message; used when exactly at 100% is showing.

fx.fxUsageBars.options.otherEntityName

String

Other entity name associated with the usage bars; used in the legend.

fx.fxUsageBars.options.overCapacityName

String

Over capacity message; used when over capacity is showing.

fx.fxUsageBars.options.quotas

Array

Quotas displayed in the usage bars. Each quota must have the following keys:

* name: Name associated with that bar

* usedByThis: Value used by this bar

* usedByAll: Value used by all (including this bar)

* totalQuota: Value representing the total available

* unitLabel: Short text for the unit label, used in the callout

* unitLabelLong: Long text for the unit label

* roundingDecimals: Number of digits wanted. if not provided, rounding is by 2

fx.fxUsageBars.options.text

Object

String used for localization.

fx.fxUsageBars.options.thisEntityName

String

This entity name associated with the usage bars; used in the legend.

fx.fxUsageBars.options.totalEntityName

String

Total available entity name associated with the usage bars; used in the legend.

Methods

Name

Description

Returns

Parameters

fx.fxUsageBars.destroy

Destroys the widget

See Also

Windows Azure Pack Extension Common Control Services
Windows Azure Pack Management Portal User Interface Extensions