GraphDef | catavolt-sdk

PaneDef Subtype that describes a Graph Pane

Hierarchy

PaneDef
- GraphDef

Index

Constructors

constructor

Methods

Constructors

Private constructor

new GraphDef(paneId: string, name: string, label: string, title: string, menuDefs: Array<MenuDef>, viewDescs: Array<ViewDesc>, entityRecDef: EntityRecDef, dialogRedirection: DialogRedirection, settings: StringDictionary, _defaultActionId: string, _graphType: string, _displayQuadrantLines: boolean, _identityDataPointDef: GraphDataPointDef, _groupingDataPointDef: GraphDataPointDef, _dataPointDefs: Array<GraphDataPointDef>, _filterDataPointDefs: Array<GraphDataPointDef>, _sampleModel: string, _xAxisLabel: string, _xAxisRangeFrom: number, _xAxisRangeTo: number, _yAxisLabel: string, _yAxisRangeFrom: number, _yAxisRangeTo: number): GraphDef

Overrides PaneDef.constructor
- Defined in catavolt/dialog.ts:2419
Parameters
- paneId: string
- name: string
- label: string
- title: string
- menuDefs: Array<MenuDef>
- viewDescs: Array<ViewDesc>
- entityRecDef: EntityRecDef
- dialogRedirection: DialogRedirection
- settings: StringDictionary
- _defaultActionId: string
- _graphType: string
- _displayQuadrantLines: boolean
- _identityDataPointDef: GraphDataPointDef
- _groupingDataPointDef: GraphDataPointDef
- _dataPointDefs: Array<GraphDataPointDef>
- _filterDataPointDefs: Array<GraphDataPointDef>
- _sampleModel: string
- _xAxisLabel: string
- _xAxisRangeFrom: number
- _xAxisRangeTo: number
- _yAxisLabel: string
- _yAxisRangeFrom: number
- _yAxisRangeTo: number
Returns GraphDef

Properties

Private _dataPointDefs

_dataPointDefs: Array<GraphDataPointDef>

Private _defaultActionId

_defaultActionId: string

Private _displayQuadrantLines

_displayQuadrantLines: boolean

Private _filterDataPointDefs

_filterDataPointDefs: Array<GraphDataPointDef>

Private _graphType

_graphType: string

Private _groupingDataPointDef

_groupingDataPointDef: GraphDataPointDef

Private _identityDataPointDef

_identityDataPointDef: GraphDataPointDef

Private _sampleModel

_sampleModel: string

Private _xAxisLabel

_xAxisLabel: string

Private _xAxisRangeFrom

_xAxisRangeFrom: number

Private _xAxisRangeTo

_xAxisRangeTo: number

Private _yAxisLabel

_yAxisLabel: string

Private _yAxisRangeFrom

_yAxisRangeFrom: number

Private _yAxisRangeTo

_yAxisRangeTo: number

Static GRAPH_TYPE_CARTESIAN

GRAPH_TYPE_CARTESIAN: string = "GRAPH_TYPE_BAR"

Static GRAPH_TYPE_PIE

GRAPH_TYPE_PIE: string = "GRAPH_TYPE_PIE"

Static PLOT_TYPE_BAR

PLOT_TYPE_BAR: string = "BAR"

Static PLOT_TYPE_BUBBLE

PLOT_TYPE_BUBBLE: string = "BUBBLE"

Static PLOT_TYPE_LINE

PLOT_TYPE_LINE: string = "LINE"

Static PLOT_TYPE_SCATTER

PLOT_TYPE_SCATTER: string = "SCATTER"

Static PLOT_TYPE_STACKED

PLOT_TYPE_STACKED: string = "STACKED"

Accessors

dataPointDefs

get dataPointDefs(): Array<GraphDataPointDef>

- Defined in catavolt/dialog.ts:2476
Returns Array<GraphDataPointDef>

defaultActionId

get defaultActionId(): string

- Defined in catavolt/dialog.ts:2480
Returns string

dialogHandle

get dialogHandle(): DialogHandle

Inherited from PaneDef.dialogHandle
- Defined in catavolt/dialog.ts:1895
Get the DialogHandle associated with this PaneDef

Returns DialogHandle

dialogRedirection

get dialogRedirection(): DialogRedirection

Inherited from PaneDef.dialogRedirection
- Defined in catavolt/dialog.ts:1903
Get the DialogRedirection with which this Pane was constructed

Returns DialogRedirection

displayQuadrantLines

get displayQuadrantLines(): boolean

- Defined in catavolt/dialog.ts:2484
Returns boolean

entityRecDef

get entityRecDef(): EntityRecDef
set entityRecDef(entityRecDef: EntityRecDef): void

Inherited from PaneDef.entityRecDef
- Defined in catavolt/dialog.ts:1911
Get the entity record definition

Returns EntityRecDef
Inherited from PaneDef.entityRecDef
- Defined in catavolt/dialog.ts:1915
Get the entity record definition

Parameters
- entityRecDef: EntityRecDef
Returns void

filterDataPointDefs

get filterDataPointDefs(): Array<GraphDataPointDef>

- Defined in catavolt/dialog.ts:2488
Returns Array<GraphDataPointDef>

graphType

get graphType(): string

- Defined in catavolt/dialog.ts:2496
Returns string

groupingDataPointDef

get groupingDataPointDef(): GraphDataPointDef

- Defined in catavolt/dialog.ts:2500
Returns GraphDataPointDef

identityDataPointDef

get identityDataPointDef(): GraphDataPointDef

- Defined in catavolt/dialog.ts:2492
Returns GraphDataPointDef

label

get label(): string

Inherited from PaneDef.label
- Defined in catavolt/dialog.ts:1937
Get the label for this Pane

Returns string

menuDefs

get menuDefs(): Array<MenuDef>
set menuDefs(menuDefs: Array<MenuDef>): void

Inherited from PaneDef.menuDefs
- Defined in catavolt/dialog.ts:1945
Get the all MenuDef's associated with this Pane

Returns Array<MenuDef>
Inherited from PaneDef.menuDefs
- Defined in catavolt/dialog.ts:1949
Get the all MenuDef's associated with this Pane

Parameters
- menuDefs: Array<MenuDef>
Returns void

name

get name(): string

Inherited from PaneDef.name
- Defined in catavolt/dialog.ts:1953
Returns string

paneId

get paneId(): string

Inherited from PaneDef.paneId
- Defined in catavolt/dialog.ts:1957
Returns string

sampleModel

get sampleModel(): string

- Defined in catavolt/dialog.ts:2504
Returns string

settings

get settings(): StringDictionary

Inherited from PaneDef.settings
- Defined in catavolt/dialog.ts:1961
Returns StringDictionary

title

get title(): string

Inherited from PaneDef.title
- Defined in catavolt/dialog.ts:1965
Returns string

viewDescs

get viewDescs(): Array<ViewDesc>

Inherited from PaneDef.viewDescs
- Defined in catavolt/dialog.ts:1969
Returns Array<ViewDesc>

xAxisLabel

get xAxisLabel(): string

- Defined in catavolt/dialog.ts:2508
Returns string

xAxisRangeFrom

get xAxisRangeFrom(): number

- Defined in catavolt/dialog.ts:2512
Returns number

xAxisRangeTo

get xAxisRangeTo(): number

- Defined in catavolt/dialog.ts:2516
Returns number

yAxisLabel

get yAxisLabel(): string

- Defined in catavolt/dialog.ts:2520
Returns string

yAxisRangeFrom

get yAxisRangeFrom(): number

- Defined in catavolt/dialog.ts:2524
Returns number

yAxisRangeTo

get yAxisRangeTo(): number

- Defined in catavolt/dialog.ts:2528
Returns number

Methods

findTitle

findTitle(): string

Inherited from PaneDef.findTitle
- Defined in catavolt/dialog.ts:1923
Find the title for this Pane

Returns string

Static Private fromOpenPaneResult

fromOpenPaneResult(childXOpenResult: XOpenDialogModelResult, childXComp: XFormModelComp, childXPaneDef: XPaneDef, childXActiveColDefs: XGetActiveColumnDefsResult, childMenuDefs: Array<MenuDef>, childViewDesc: XGetAvailableViewDescsResult, printMarkupXML: string): Try<PaneDef>

Inherited from PaneDef.fromOpenPaneResult
- Defined in catavolt/dialog.ts:1782
Parameters
- childXOpenResult: XOpenDialogModelResult
- childXComp: XFormModelComp
- childXPaneDef: XPaneDef
- childXActiveColDefs: XGetActiveColumnDefsResult
- childMenuDefs: Array<MenuDef>
- childViewDesc: XGetAvailableViewDescsResult
- printMarkupXML: string
Returns Try<PaneDef>

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

Private constructor

Parameters

paneId: string

name: string

label: string

title: string

menuDefs: Array<MenuDef>

viewDescs: Array<ViewDesc>

entityRecDef: EntityRecDef

dialogRedirection: DialogRedirection

settings: StringDictionary

_defaultActionId: string

_graphType: string

_displayQuadrantLines: boolean

_identityDataPointDef: GraphDataPointDef

_groupingDataPointDef: GraphDataPointDef

_dataPointDefs: Array<GraphDataPointDef>

_filterDataPointDefs: Array<GraphDataPointDef>

_sampleModel: string

_xAxisLabel: string

_xAxisRangeFrom: number

_xAxisRangeTo: number

_yAxisLabel: string

_yAxisRangeFrom: number

_yAxisRangeTo: number

Returns GraphDef

Properties

Private _dataPointDefs

Private _defaultActionId

Private _displayQuadrantLines

Private _filterDataPointDefs

Private _graphType

Private _groupingDataPointDef

Private _identityDataPointDef

Private _sampleModel

Private _xAxisLabel

Private _xAxisRangeFrom

Private _xAxisRangeTo

Private _yAxisLabel

Private _yAxisRangeFrom

Private _yAxisRangeTo

Static GRAPH_TYPE_CARTESIAN

Static GRAPH_TYPE_PIE

Static PLOT_TYPE_BAR

Static PLOT_TYPE_BUBBLE

Static PLOT_TYPE_LINE

Static PLOT_TYPE_SCATTER

Static PLOT_TYPE_STACKED

Accessors

dataPointDefs

Returns Array<GraphDataPointDef>

defaultActionId

Returns string

dialogHandle

Returns DialogHandle

dialogRedirection

Returns DialogRedirection

displayQuadrantLines

Returns boolean

entityRecDef

Returns EntityRecDef

Parameters

entityRecDef: EntityRecDef

Returns void

filterDataPointDefs

Returns Array<GraphDataPointDef>

graphType

Returns string

groupingDataPointDef

Returns GraphDataPointDef

identityDataPointDef

Returns GraphDataPointDef

label