public final class HtmlLegendOptions extends AbstractPluginOptions
HtmlLegend.ID
plugin.Modifier and Type | Field and Description |
---|---|
static CursorType |
DEFAULT_CURSOR_POINTER
Default cursor type when the cursor is over,
CursorType.POINTER . |
static boolean |
DEFAULT_DISPLAY
Default display if legend must be showed.
|
static int |
DEFAULT_MAXIMUM_LEGEND_COLUMNS
Default maximum legends columns to show.
|
Constructor and Description |
---|
HtmlLegendOptions()
Builds the object with new java script object setting the default value of plugin.
The global plugin options is used, if exists, as defaults values. |
HtmlLegendOptions(IsChart chart)
Builds the object with a chart instance in order to get the right defaults.
If the plugin options have not been set by chart type, it will use the global. |
Modifier and Type | Method and Description |
---|---|
default CursorType |
getCursorPointer()
Returns the cursor type when the cursor is over the dataset item.
|
CursorType |
getCursorPointer()
Returns the cursor type when the cursor is over the dataset item.
|
HtmlLegendItemCallback |
getLegendItemCallback()
Returns the callback which can be implemented to change the text of legend for a specific item, as HTML.
|
default HtmlLegendItemCallback |
getLegendTextCallback()
Returns the callback which can be implemented to change the text of legend for a specific item, as HTML.
|
HtmlLegendTitleCallback |
getLegendTitleCallback()
Returns the callback which can be implemented to change the text of legend's title, as HTML.
|
int |
getMaximumLegendColumns()
Returns the maximum amount of columns of legend.
|
boolean |
isDisplay()
Returns if the legend is shown.
|
void |
setCursorPointer(CursorType cursor)
Sets the cursor type when the cursor is over the dataset item.
|
void |
setDisplay(boolean display)
Sets if the legend is shown.
|
void |
setLegendItemCallback(HtmlLegendItemCallback legendTextCallback)
Sets the callback which can be implemented to change the text of legend for a specific item, as HTML.
|
void |
setLegendTitleCallback(HtmlLegendTitleCallback legendTitleCallback)
Sets the callback which can be implemented to change the text of legend's title, as HTML.
|
void |
setMaximumLegendColumns(int maxColumns)
Sets the maximum amount of columns of legend.
|
applyingDefaults, applyingDefaults, getEvents, getId, getPluginId, loadGlobalsPluginOptions, setEvents, setEvents, store, store, store, store
checkAndAddToParent, getChildKey, getParentNode, getRootNode, retrieveRoot, setArrayValueAndAddToParent, setArrayValueAndAddToParent, setArrayValueAndAddToParent, setElementAndAddToParent, setInternalCallbackToModel, setInternalCallbackToModel, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent
checkDefaultValuesArgument, empty, getArrayValue, getElement, getIncrementalId, getNativeChart, getNativeEvent, getNativeObject, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, has, has, isType, keys, loadNativeObject, remove, remove, setArrayValue, setArrayValue, setArrayValue, setElement, setEmptyValue, setNewIncrementalId, setNewIncrementalId, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, toJSON, type
public static final int DEFAULT_MAXIMUM_LEGEND_COLUMNS
public static final boolean DEFAULT_DISPLAY
public static final CursorType DEFAULT_CURSOR_POINTER
CursorType.POINTER
.public HtmlLegendOptions()
public HtmlLegendOptions(IsChart chart)
chart
- chart type to use to get the default values by chartpublic void setDisplay(boolean display)
display
- if the legend is shown.public boolean isDisplay()
true
if the legend is shown.public HtmlLegendItemCallback getLegendItemCallback()
public void setLegendItemCallback(HtmlLegendItemCallback legendTextCallback)
legendTextCallback
- the callback which can be implemented to change the text of legend for a specific item, as HTMLpublic HtmlLegendTitleCallback getLegendTitleCallback()
public void setLegendTitleCallback(HtmlLegendTitleCallback legendTitleCallback)
legendTitleCallback
- the callback which can be implemented to change the text of legend's title, as HTMLpublic void setMaximumLegendColumns(int maxColumns)
maxColumns
- the maximum amount of columns of legendpublic int getMaximumLegendColumns()
public HtmlLegendItemCallback getLegendTextCallback()
public CursorType getCursorPointer()
public final void setCursorPointer(CursorType cursor)
cursor
- cursor type when the cursor is over the dataset itempublic final CursorType getCursorPointer()