$k. ApplicationConfiguration

new ApplicationConfiguration()

Configuration of an application

Extends

Methods

(static) from(configurationElement) → {$k.ViewConfiguration}

Returns the application confguration defined by the element

Parameters:
NameTypeDescription
configurationElement$k.SemanticElement | string

The application configuration element (use semantic element, identifier oder element id)

Since
  • 4.4.0
Returns:
Type: 
$k.ViewConfiguration

configElement() → {$k.SemanticElement}

Since
  • 4.1.0
Returns:
Type: 
$k.SemanticElement

latexTemplateData(domainModelopt, customeropt) → {object}

Generates template data for printing viewconfig based documents.

Parameters:
NameTypeAttributesDescription
domainModel$k.SemanticElement<optional>

Initial domain model for the application.

customerstring<optional>

Customer identifier for accessing customized behavior.

Since
  • 5.4.0
Returns:

Template data for printing viewconfig based documents.

Type: 
object

panelContents(elementOrObjectopt, keyFilteropt, detailFilteropt) → {object}

Render the panel contents as a literal object

Parameters:
NameTypeAttributesDescription
elementOrObjectobject<optional>

one of: a) semantic element that should be used as start object b) a PanelActivationContext to be used as start configuration

keyFilterobject<optional>

Alternative 1 (preferred): a $k.JSONRenderContext Alternative 2 (compatibility only): A filter. See $k.JSONRenderContext.prototype.setFilters().

detailFilterobject<optional>

Only used if the key filter is not a $k.JSONRenderContext. See $k.JSONRenderContext.prototype.setLevelsOfDetail()

Since
  • 4.4.0
Deprecated
  • This function is deprecated and might be removed in future releases
Returns:

The panel contents

Type: 
object

render(keyFilteropt, detailFilteropt) → {object}

Render panels as a literal object

Parameters:
NameTypeAttributesDescription
keyFilterobject<optional>

Alternative 1 (preferred): a $k.JSONRenderContext Alternative 2 (compatibility only): A filter. See $k.JSONRenderContext.prototype.setFilters().

detailFilterobject<optional>

Only used if the key filter is not a $k.JSONRenderContext. See $k.JSONRenderContext.prototype.setLevelsOfDetail()

Since
  • 4.4.0
Deprecated
  • This function is deprecated and might be removed in future releases
Returns:

The rendered object

Type: 
object

setRenderContext(renderContextObject)

Set render context

Parameters:
NameTypeDescription
renderContextObjectRenderContext
Since
  • 5.3.0
Deprecated
  • This function is deprecated and might be removed in future releases

toJSON()

Since
  • 5.2.0
Deprecated
  • This function is deprecated and might be removed in future releases