Final Class: ColorAttributeGroupHandler

Oracle® JavaScript Extension Toolkit (JET)
8.0.0
F18189-01

QuickNav

Methods


ColorAttributeGroupHandler extends oj.AttributeGroupHandler

Version:
  • 8.0.0
Since:
  • 1.2
Module:
  • ojattributegrouphandler

Module usage

See JET Module Loading for an overview of module usage within JET.

Javascript Import Format
define(['ojs/ojattributegrouphandler'], function(attributegrouphandler) {
 // Application should call API on attributegrouphandler.ColorAttributeGroupHandler 
})
Typescript Import Format
//To import this class, use the format below.
import {ColorAttributeGroupHandler} from "ojs/ojattributegrouphandler";

JET In Typescript

A detailed description of working with JET elements and classes in your typescript project can be found at: JET Typescript Usage.

Final classes in JET

Classes in JET are generally final and do not support subclassing. At the moment, final is not enforced. However, this will likely change in an upcoming JET release.

Constructor

new ColorAttributeGroupHandler(matchRules)

Creates a color attribute group handler that will generate color attribute values.
Parameters:
Name Type Argument Description
matchRules {[propName: string]: any} <optional>
 A map of key value pairs for categories and the matching attribute value e.g. {"soda" : "#336699", "water" : "#CC3300", "iced tea" : "#F7C808"}. Attribute values listed in the matchRules object will be reserved only for the matching categories when getAttributeValue is called. Note that not all colors in the default color ramp will meet minimum contrast requirements for text.

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 any The attribute value to assign for inputs matching the given category e.g. "square" or "circle"
Inherited From:
Returns:
Type
void

getCategoryAssignments() : {Array<{[propName: string]: any}>}

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.
Inherited From:
Returns:
The current list of category and value pairings
Type
Array<{[propName: string]: any}>

getValue(category) : {any}

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
Inherited From:
Returns:
The attribute value for the category
Type
any

getValueRamp() : {Array.<string>}

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