Element: <oj-legend-section>

Oracle® JavaScript Extension Toolkit (JET)
7.1.0

F18183-01

Signature:

class ojLegendSection

QuickNav

Attributes


PREVIEW: This is a preview API. Preview APIs are production quality, but can be changed on a major version without a deprecation path.

Version:
  • 7.1.0
Since:
  • 6.0.0
Module:
  • ojlegend

Module usage

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

Typescript Import Format
//To typecheck the element APIs, import as below.
import {ojLegendSection} from "ojs/ojlegend";

//For the transpiled javascript to load the element's module, import as below
import "ojs/ojlegend";

JET In Typescript

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

JET Legend Section

The oj-legend-section element is used to declare properties for legend sections and is only valid as the child of a template element for the sectionTemplate slot of oj-legend.


<oj-legend data='[[dataProvider]]'>
 <template slot='sectionTemplate'>
   <oj-legend-section  collapsible='on' expanded='[[$current.index == 0 ? "on" : "off"]]'>
   </oj-legend-section>
 </template>
</oj-legend>

Attributes

collapsible :"on"|"off"

Whether the section is collapsible. Only applies if the legend orientation is vertical.
Supported Values:
Value
"off"
"on"
Default Value:
  • "off"

text :string

The title of the legend section.
Default Value:
  • ""

text-halign :"center"|"end"|"start"

The horizontal alignment of the section title. If the section is collapsible or nested, only start alignment is supported.
Supported Values:
Value
"center"
"end"
"start"
Default Value:
  • "start"

text-style :CSSStyleDeclaration

The CSS style object defining the style of the section title.
Default Value:
  • {}