components.json layout

JSON metadata describing components for viewer and viewer-admin webapps

Parameters:

className: The component's classname

name: The name as used in the layoutmanager

shortName: A short name which is used by the layoutmanager when adding the component to the topmenu

restrictions: Array with region-ids to which the component can be dragged Possible restrictions are: header,leftmargin_top,leftmargin_bottom,left_menu,top_menu,content,content_bottom, popupwindow,rightmargin_top,rightmargin_bottom,footer

singleton: Boolean whether the component can be added multiple times (false) or just once (true)

notInCombinationWith: Array with the classNames of other components. If a component from that array has already been added to a region, this component cannot be added to that region

showHelp: boolean value to show help configuration tab for component (default false)

group: string, indicates to which group this component belongs: used to indicate in which closable panel it should be rendered. Possible values: Map, Tools, Functionality. Defaults to Rest

extPropertyGridConfigs: Some extra properties can be given here to configure extra things

extPropertyGridConfigs.source: Set the object that must be configurable with defaults For example:

{"name": "a name", "tooltip": "a tool tip", "happy": true}

extPropertyGridConfigs.propertyNames: here you can set the labels for the object configured in extPropertyGridConfigs.source For example:

{"name": "The name", "tooltip": "Tool tip", "happy": "Are you happy"}

validation

You should use a validation tool to (in versions up to 4.7.4 Flamingo tried to do some validation and error handling itself, but this code has been removed) Some online tools you can use:

• http://pro.jsonlint.com/ (will also format the file)
• http://jsonlint.com/