Class: AttributeGroupHandler

Oracle® JavaScript Extension Toolkit (JET)
5.0.0

E90577-01

QuickNav

AttributeGroupHandler

Version:
  • 5.0.0
Since:
  • 1.0
Module:
  • ojdvt-base

Constructor

new AttributeGroupHandler(matchRules)

Creates an attribute group handler that will generate stylistic attribute values such as colors or shapes based on data set categories.
Parameters:
Name Type Argument Description
matchRules Object.<string, *> <optional>
A map of key value pairs for categories and the matching attribute value e.g. {"soda" : "square", "water" : "circle", "iced tea" : "triangleUp"}. Attribute values listed in the matchRules object will be reserved only for the matching categories when getAttributeValue is called.

Methods

addMatchRule(category, attributeValue) → {void}

Reserves an attribute value for the given category. All match rules should be added before any category assignments are done with the getValue API.
Parameters:
Name Type Description
category string Used for checking inputs to getAttributeValue against when assigning an attribute value
attributeValue * The attribute value to assign for inputs matching the given category e.g. "square" or "circle"
Returns:
Type
void

getCategoryAssignments() → {Array.<Object.<string, *>>}

Returns the current list of assigned categories as an array of objects with "category" and "value" keys. Note that match rules are not reflected in category assignments.
Returns:
The current list of category and value pairings
Type
Array.<Object.<string, *>>

getValue(category) → {*}

Assigns the given category an attribute value. Will consistently return the same attribute value for equal categories.
Parameters:
Name Type Description
category string The category to assign
Returns:
The attribute value for the category
Type
*

getValueRamp() → {Array.<*>}

Returns the array of possible attribute values for this attribute group handler.
Returns:
The array of attribute values
Type
Array.<*>