-
disableTitle() →
{boolean}
-
If this method returns true, the
visualization will never show its title and disable the
show/hide title option in the gadget dialog. Subclasses can
override this method.
Returns:
- Type
- boolean
-
getVizContextFromRenderingContext(oTransientRenderingContext)
→ {module:obitech-report/vizcontext#VizContext}
-
Returns the viz context from the
rendering context
Parameters:
Name |
Type |
Description |
oTransientRenderingContext |
module:obitech-report/renderingcontext#RenderingContext
|
|
Returns:
the viz context
- Type
- module:obitech-report/vizcontext#VizContext
-
isCanvasObject() →
{boolean}
-
This method returns a boolean that
indicates whether it is a canvas object visualization
Returns:
A boolean that indicates whether this
visualization is a canvas object
- Type
- boolean
-
isDataVisualization() →
{boolean}
-
This method returns a boolean that
indicates whether it is a visualization type that visually
represents a set of data (as opposed to a canvas object or some
other visualization used for markup)
Returns:
A boolean that indicates whether this
visualization represents data
- Type
- boolean
-
isInSummaryMode() →
{boolean}
-
This method indicates whether the
visualization should be rendered in summary mode
Returns:
- Type
- boolean
-
isRendered() →
{boolean}
-
This method returns a boolean indicating
whether the visualization is in a steady rendered state.
Returns:
True if the viz is in a stable rendered
state, false otherwise.
- Type
- boolean
-
openPropertiesDialog(params)
-
This method opens the GadgetDialog for
this visualization
Parameters:
Name |
Type |
Description |
params |
object |
Optional params map used by
OPEN_GADGET_DIALOG event |
-
render(oTransientRenderingContext)
-
Render a visualization using the
provided rc.RenderingContext
Parameters:
Name |
Type |
Description |
oTransientRenderingContext |
|
|
-
<protected>
_doClearComponent()
-
Subclasses should implement this to get
a callback when component is cleared. This will be called before
hosted components are cleared.
- Inherited From:
-
-
<protected>
_doCloseComponent()
-
Subclasses should implement this to get
a callback when component is detached. This will be called
before hosted components are detached.
- Inherited From:
-
-
<protected>
_doDetachComponent()
-
Subclasses should implement this to get
a callback when component is detached. This will be called
before hosted components are detached.
- Inherited From:
-
-
<protected>
_doStartComponent()
-
Subclasses should implement this to get
a callback when component is started. This will be called before
hosted components are started.
- Inherited From:
-
-
<protected>
_doStopComponent()
-
Subclasses should implement this to get
a callback when component is stopped. This will be called before
hosted components are stopped.
- Inherited From:
-
-
setVizContextFromRenderingContext(oTransientRenderingContext,
oTransientVizContext)
-
Sets the viz context on the rendering
context
Parameters:
Name |
Type |
Description |
oTransientRenderingContext |
module:obitech-report/renderingcontext#RenderingContext
|
|
oTransientVizContext |
module:obitech-report/vizcontext#VizContext
|
the viz context |
-
supportsSummaryViz() →
{boolean}
-
This method indicates whether the
visualization supports showing a summary view. Generally this is
used when the container size for a visualization is very
limited, and the UI wishes to show a simplified summary of the
visualization content.
Returns:
- Type
- boolean