Type: DesignerServerApi

Description: If report id is specified, the corresponding report will be opened in designer when designer application is rendered.

Type: 

{  id?: string  }

designerOptions.reportInfo.id = 'MyReport.rdlx';

Description: If the locale value is not specified explicitly here, the locale corresponding to the browser preferences is used.

Type: 'en' | 'zh' | 'ja'

designerOptions.locale = 'zh';  

Description: If measurement units are not specified explicitly here, they are identified depending on locale.

Type: 'in' | 'cm'

Example:

designerOptions.units = 'cm';

Description: It is possible to limit and/or reorder available report items. Specify comma-separated report items keys from following: TextBox, CheckBox, Container, Line, Shape, TableOfContents, Image, List, Table, Tablix, Chart, Bullet, Barcode, FormattedText, Sparkline, Subreport, and OverflowPlaceholder.

Type: string

designerOptions.reportItems = 'TextBox,CheckBox,Table,Chart,Image';

Description: By default lockLayout is disabled. When lockLayout is enabled, it is only possible to modify properties of existing report items. That is, adding a new report item or deleting an existing one is not possible as well as other operations that modify report layout structure.

Type: boolean

Example:

designerOptions.lockLayout = true;

Description: By default restoreUnsavedReport is enabled. In this case the last unsaved report can be restored if browser tab or browser itself gets accidentally closed. When restoreUnsavedReport is disabled, the aforementioned functionality is not available.

Type: boolean

designerOptions.restoreUnsavedReport = false;

Description: Specifies whether Save button needs to be shown. Save button is not visible by default.

Type:

{ visible: boolean }

Example:

designerOptions.saveButton.visible = true;

Description: Specifies whether Save As button needs to be shown. Save As button is not visible by default.

Type:

{ visible: boolean }

designerOptions.saveAsButton.visible= true;

Description: Specifies whether Report Explorer button needs to be shown. Report Explorer button is visible by default.

Type:

{ visible: boolean }

Example:

designerOptions.reportExplorer.visible= false;

Description: Specifies whether Group Editor button needs to be shown. Group Editor button is visible by default.

Type:

{ visible: boolean }

designerOptions.groupEditor.visible = false;

Description: Specifies whether left-side menu Toolbox needs to be shown. Toolbox is visible by default.

Type:

{ visible: boolean }

designerOptions.toolBox.visible = false;

Description: Specifies whether application bar menu Insert Tab needs to be shown. Insert Tab is not visible by default. Toolbox and Insert Tab are interchangeable.

Type:

{ visible: boolean }

Example:

designerOptions.insertTab.visible = true;

Description:

• visible - Specifies whether Properties Tab needs to be shown. Properties Tab is visible by default.
  
• mode - Specifies available properties modes. The default value is 'Both'.
• dataSets -
  • visible - Specifies whether Data Sets section needs to be shown. 'Data Sets' section is visible by default.
  • canModify - Specifies whether it is possible to modify (including add/remove) data sets. By default this feature is disabled.
                     
• defaultMode - Relevant only when mode is 'Both'. If undefined, the last used properties mode is set.

Type:
{
  visible: boolean,
  mode: 'Both' | 'Advanced' | 'Basic',
  defaultMode?: 'Advanced' | 'Basic',
}

Example:                

designerOptions.propertiesTab.visible = false;

designerOptions.propertiesTab.mode = 'Basic';
designerOptions.propertiesTab.defaultMode = 'Advanced';

Description:

• visible - Specifies whether Data Tab needs to be shown. Data Tab is visible by default.
  
• dataSources -
  • visible - Specifies whether Data Sources section needs to be shown. Data Sources section is visible by default.
• dataSets -
  • visible - Specifies whether Data Sets section needs to be shown. Data Sets section is visible by default.
  • canModify - Specifies whether it is possible to modify (including add/remove) data sets. By default this feature is disabled.
                     
• parameters -
  • visible - Specifies whether Parameters section needs to be shown. Parameters section is visible by default.
    
  • canModify - Specifies whether it is possible to modify (including add/remove) report parameters. By default this feature is enabled.
                     
• commonValues -
  • visible - Specifies whether Common Values section needs to be shown. Common Values section is visible by default.

Type:
{
  visible: boolean,
  dataSources: {
   visible: boolean,
  },
  dataSets: {
   visible: boolean,
   canModify: boolean,
  },
  parameters: {
   visible: boolean,
   canModify: boolean,
  },
  commonValues: {
   visible: boolean,
  },
}

Example:                

designerOptions.dataTab.visible = false;

designerOptions.dataTab.dataSources.visible = false;
designerOptions.dataTab.dataSets.visible = false;

designerOptions.dataTab.dataSets.canModify = true;

designerOptions.dataTab.parameters.visible = false;

designerOptions.dataTab.parameters.canModify = false;

designerOptions.dataTab.dataSources.visible = false;

Description: 

• visible - Specifies whether Grid Size editor in Status Bar needs to be shown. Grid Size editor is visible by default.
• value - If Grid Size editor is not visible, it is possible to specify grid size value in in/cm (inches or centimeters).

Example:

designerOptions.gridSize.visible = false;

designerOptions.gridSize.value = '0.75cm';
/* or */
designerOptions.gridSize.value = '0.5in';

Description:

• visible - Specifies whether Show Grid toggle in Status Bar needs to be shown. Show Grid toggle is visible by default.
• value - If Show Grid toggle is not visible, it is possible to specify show grid value as true or false.

Example:

designerOptions.showGrid.visible = false;

designerOptions.showGrid.value = false;