Class ShapeDiver3dEmbedded

Hierarchy

Cbn.ctrls.Base
- ShapeDiver3dEmbedded

Index

Constructors

constructor

new ShapeDiver3dEmbedded(): ShapeDiver3dEmbedded
Returns ShapeDiver3dEmbedded

Inherited from Base.constructor

Properties

ctrlId

ctrlId: string

This is the actual name of the component

el

rendered

rendered: boolean

self

self: {
TypeStr: string;
}

Type declaration

TypeStr: string

`Static` TypeStr

TypeStr: string

Methods

getCtrlPropValue

getCtrlPropValue(propertyName: string): any
Parameters
- propertyName: string
  
  One of CtrlProperties
Returns any

Inherited from Base.getCtrlPropValue

getHeight

getHeight(): number
Returns number

Inherited from Base.getHeight

getParamInfo

getParamInfo(paramTitle?: string): ShapeDiver3dParamInfo | {
[paramName: string]: ShapeDiver3dParamInfo;
}
Prints some info about the parameter (type, allowed values, key etc.)

Returns
Info about the param
Parameters
- Optional paramTitle: string
  
  If not given, info for all params is returned
Returns ShapeDiver3dParamInfo | {
[paramName: string]: ShapeDiver3dParamInfo;
}

getSize

getSize(): {
height: number;
width: number;
}
Returns {
height: number;
width: number;
}
- height: number
- width: number
Inherited from Base.getSize

getTooltip

getTooltip(): Instance
Returns a tooltip instance of the control based on tippy.js

See
Documentation of tippy.js

Returns Instance

Inherited from Base.getTooltip

hasCls

hasCls(cls: string): boolean
Parameters
- cls: string
Returns boolean

Inherited from Base.hasCls

isCommPluginLoaded

isCommPluginLoaded(): boolean
Indicates if the communication plugin is already loaded

Returns boolean

isSceneVisible

isSceneVisible(): boolean
Indicates if scene is currently visible

Returns boolean

isSettingsRegistered

isSettingsRegistered(): boolean
Indicates if model settings are already registered

Returns boolean

on

on(eventName: string, callback: Function, scope?: any, options?: object): void
This function is actually inherited from ExtJS: https://docs.sencha.com/extjs/6.2.0/modern/Ext.mixin.Observable.html#method-on
Parameters
- eventName: string
- callback: Function
- Optional scope: any
- Optional options: object
Returns void

Inherited from Base.on

setCtrlBckgr

setCtrlBckgr(value: string): void
Parameters
- value: string
  
  A css compliant background string
Returns void

Inherited from Base.setCtrlBckgr

setCtrlHeight

setCtrlHeight(value: string | number): void
Parameters
- value: string | number
  
  CSS size string with or without unit or number which will be interpreted as px
Returns void

Inherited from Base.setCtrlHeight

setCtrlVisibility

setCtrlVisibility(value: boolean | CtrlVisibility, updateCtrlProperty?: boolean): void
Show or hide the control
Parameters
- value: boolean | CtrlVisibility
  
  True: "Show"
  False: "PluggedOut"
- Optional updateCtrlProperty: boolean
Returns void

Inherited from Base.setCtrlVisibility

setCtrlWidth

setCtrlWidth(value: string): void
Parameters
- value: string
  
  CSS size string with or without unit or number which will be interpreted as px
Returns void

Inherited from Base.setCtrlWidth

setDisabled

setDisabled(value: boolean): void
Parameters
- value: boolean
Returns void

Inherited from Base.setDisabled

setTooltipContent

setTooltipContent(content: string): void
Set the content of the tooltip
Parameters
- content: string
  
  Plain text or HTML
Returns void

Inherited from Base.setTooltipContent

setUserCssClass

setUserCssClass(cls: string): void
Parameters
- cls: string
  
  One or more CSS classes which are added to the control. Previously added classes are removed.
Returns void

Inherited from Base.setUserCssClass

un

un(eventName: string, callback: Function, scope?: any): void
This function is actually inherited from ExtJS: https://docs.sencha.com/extjs/6.2.0/modern/Ext.mixin.Observable.html#method-un
Parameters
- eventName: string
- callback: Function
- Optional scope: any
Returns void

Inherited from Base.un

Generated using TypeDoc