Class ShapeDiver3d

Hierarchy

ExternalContent
- ShapeDiver3d

Index

Constructors

Properties

ctrlId el rendered self TypeStr

Methods

getCtrlPropValue getHeight getSize getTooltip hasCls on sendMsg setCameraPos setCtrlBckgr setCtrlHeight setCtrlVisibility setCtrlWidth setDisabled setParamValue setTooltipContent setUserCssClass un

Constructors

constructor

new ShapeDiver3d(): ShapeDiver3d
Returns ShapeDiver3d

Inherited from ExternalContent.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 ExternalContent.getCtrlPropValue

getHeight

getHeight(): number
Returns number

Inherited from ExternalContent.getHeight

getSize

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

getTooltip

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

See
Documentation of tippy.js

Returns Instance

Inherited from ExternalContent.getTooltip

hasCls

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

Inherited from ExternalContent.hasCls

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 ExternalContent.on

sendMsg

sendMsg(data: object): void
Send some post window message to the 3d model IFrame
Parameters
- data: object
Returns void

setCameraPos

setCameraPos(pos: string, transitionMS?: number): void
Parameters
- pos: string
  
  A JSON string including an position & target object.
  See https://www.shapediver.com/api#setCamera for further info.
- Optional transitionMS: number
  
  Duration of the transition in MS.
Returns void

setCtrlBckgr

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

Inherited from ExternalContent.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 ExternalContent.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 ExternalContent.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 ExternalContent.setCtrlWidth

setDisabled

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

Inherited from ExternalContent.setDisabled

setParamValue

setParamValue(title: string, value: string | number | boolean): void
Set parameter value of the model.
Changes are not sent immediately to the IFrame but are queued until after the current execution context in order to batch send multiple subsequent changes.
Parameters
- title: string
  
  The title of the parameter to set as received from getParameterDefinitions
- value: string | number | boolean
Returns void

setTooltipContent

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

Inherited from ExternalContent.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 ExternalContent.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 ExternalContent.un

Generated using TypeDoc