Element: <oj-c-tag-cloud-item>

CORE PACK

Oracle® JavaScript Extension Toolkit (JET)
21.0.0
G39657-01

Since:
  • 15.0.0
Module:
  • tag-cloud-item

QuickNav

Attributes

Other Topics


JET Tag Cloud Item

The oj-c-tag-cloud-item element is used to declare properties for tag cloud items and is only valid as the child of a template element for the itemTemplate slot of oj-c-tag-cloud.

 
 <oj-c-tag-cloud data='[[dataProvider]]'>
  <template slot='itemTemplate' data-oj-as='item'>
    <oj-c-tag-cloud-item  label='[[item.data.id]]' value='[[item.data.total]]'></oj-c-tag-cloud-item>
  </template>
 </oj-c-tag-cloud>

Accessibility

Read the Accessibility Section of the oj-c-tagcloud component for details about making this component accessible.


Usage

Signature:

interface CTagCloudItemElement

Typescript Import Format
//To typecheck the element APIs, import as below.
import { CTagCloudItemElement } from "oj-c/tag-cloud-item";

//For the transpiled javascript to load the element's module, import as below
import "oj-c/tag-cloud-item";

For additional information visit:


Attributes

categories :Array<string>

An array of category strings corresponding to the tag cloud items. This allows highlighting and filtering of items.
Default Value:
  • '[]'

color :string

The color of the text. Will be overridden by any color defined in the style option. The default value comes from the CSS and varies based on theme.

label* :string

The text of the item.

pattern :"diagonalLeftHatch"|"none"

The pattern applied to the item.
Deprecated:
Since Description
21.0.0 Pattern-based differentiation is deprecated for oj-c-tag-cloud-item.
Supported Values:
Value Description
diagonalLeftHatch Diagonal left hatch pattern is applied to the item.
none No pattern is applied to the item.

short-desc :string

The description of the item. This is used for customizing the datatip text.

url :string

The url this item references.

Note: For security, JET validates the URL protocol before navigation and currently supports http: and https: protocols. JET does not validate whether the URL is trusted for the application. Applications are responsible for providing sanitized URLs and enforcing any required origin or host allowlist.

value* :(number|null)

The value of this item is used to scale its font size within the tag cloud.