FigureTypesScriptService (Figure Macro 15.4 API)

java.lang.Object
- org.xwiki.contrib.figure.FigureTypesScriptService

All Implemented Interfaces:

org.xwiki.script.service.ScriptService
```
@Component
@Singleton
@Named("figureTypes")
public class FigureTypesScriptService
extends Object
implements org.xwiki.script.service.ScriptService
```
Gives access to the figures types, in particular the list of configured figure types as well at the localized label of the figure types.

Since:

15.4

Version:

$Id$

Constructor Summary

Constructors
Constructor Description

FigureTypesScriptService()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Set<FigureType>`	`getFigureTypes()`
`String`	`getLabel(String type)`
`FigureStyle`	`getStyle(String type)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FigureTypesScriptService
```
public FigureTypesScriptService()
```
- Method Detail
  - getFigureTypes
```
public Set<FigureType> getFigureTypes()
```
    Returns:
    
    the set of configured figure types
  - getLabel
```
public String getLabel(String type)
```
    Parameters:
    
    type - the figure type
    
    Returns:
    
    the translated value if key org.xwiki.rendering.macro.figure.FigureType.$type is found, the capitalized type otherwise
  - getStyle
```
public FigureStyle getStyle(String type)
```
    Parameters:
    
    type - the type of the figure
    
    Returns:
    
    the style of the figure