Create HTML5-Based Mobile-Friendly Interactive Images and Maps
FLDraw Interactive Floor Plan Software  >  Developer Guide  >  Configuration

Configuration

FLDraw uses a configuration file that specifies the initial settings.

The following table describes the parameters included inside the configuration file:

<main>
Parameter Data Type Default Description
units Number (1 to 8) 5 Specifies the unit of measurement.
 
Valid Values:
  • 1: Meters.
  • 2: Centimeters.
  • 3: Millimeters.
  • 4: Feet.
  • 5: Feet and Inches.
  • 6: Inches (Decimal).
  • 7: Inches (Fractional).
  • 8: Pixels.
precision Number (0 to 9) 3 Specifies the number of digits after the decimal point (for displaying dimensions).
width Number (39.37 to 3937) 1200 Specifies the default plan width (in inches).
height Number (39.37 to 3937) 1200 Specifies the default plan height (in inches).
scale Number (10 to 600) 100 Specifies the default plan scale.
back_color Color, in hexadecimal format FFFFFF The background color of the drawing area.
allow_import Boolean (true/false) false Specifies whether or not to allow importing image files.
compress_files Boolean (true/false) false Specifies whether or not to compress the plan files before saving,
it must be set to false if you want to use the plugin in a desktop application.
(true: save as ZIP, false: save as XML)
objects_folder String (Empty string) The relative path of the folder containing the library SWF files (objects and patterns).
 
Example
<objects_folder>objects/</objects_folder>
<objects_folder>../objects/</objects_folder>
library_file String library.xml The relative path of the file containing the structure of the library.
 
Example
<library_file>library.xml</library_file>
<library_file>folder1/library.xml</library_file>
language_file String (Empty string) The relative path of the language file.
 
Example
<language_file></language_file>
<language_file>language.xml</language_file>
<language_file>folder1/language.xml</language_file>
list_script String (Empty string) The relative path of the server-side script file to be used for loading the plan files list.
 
Example
<list_script>file.php?v=[p]</list_script>
<list_script>folder1/file.php?v=[p]</list_script>
new_script String (Empty string) The relative path of the server-side script file to be used for specifying the new plan name.
 
Example
<new_script></new_script>
<new_script>file.php?v=[p]</new_script>
<new_script>folder1/file.php?v=[p]</new_script>

Tip
If you want to allow the user to create an unnamed plan,
use: <new_script></new_script>.
load_script String (Empty string) The relative path of the server-side script file to be used for loading plan files.
 
Example
<load_script></load_script>
<load_script>file.php?v=[p]</load_script>
<load_script>folder1/file.php?v=[p]</load_script>

Tip
To load plan files directly, and without running a server-side script,
use: <load_script></load_script>.
save_script String (Empty string) The relative path of the server-side script file to be used for saving plan files.
 
Example
<save_script>file.php?v=[p]</save_script>
<save_script>folder1/file.php?v=[p]</save_script>
add_on String (Empty string) The relative path of the add-on file.
 
<user_interface>
Parameter Data Type Default Description
menu_bar Boolean (true/false) true Specifies whether or not to display the main menu bar.
toolbar Boolean (true/false) true Specifies whether to show or hide the toolbar.
status_bar Boolean (true/false) true Specifies whether to show or hide the status bar.
library_window Boolean (true/false) true Specifies whether to show or hide the Objects Library window.
allow_full_screen Boolean (true/false) false Specifies whether or not to show the Full Screen Mode button.
snap_position Number (0 to 2) 0 Specifies the default value for Snap=>Position.
 
Valid Values:
  • 0: Disabled
  • 1: 1" (Imperial), 1cm(Metric) or 1px(Pixels)
  • 2: to Grid
snap_length Number (0 to 2) 1 Specifies the default value for Snap=>Length.
 
Valid Values:
  • 0: Disabled
  • 1: 1" (Imperial), 1cm(Metric) or 1px(Pixels)
  • 2: 1' (Imperial), 10cm(Metric) or 10px(Pixels)
snap_angle Number (0 to 3) 2 Specifies the default value for Snap=>Angle.
 
Valid Values:
  • 0: Disabled
  • 1: 1°
  • 2: 5°
  • 3: 45°
editor_file_menu String (comma-delimited) new,open,save,save_as,close,export_image,print Specifies the list of items to be displayed in the File menu (the File Menu button) of the editor.
 
Menu Items:
  • new: New
  • open: Open...
  • save: Save
  • save_as: Save As...
  • close: Close
  • export_image: Export Image...
  • print: Print...
viewer_file_menu String (comma-delimited) export_image,print Specifies the list of items to be displayed in the File menu (the File Menu button) of the viewer.
 
Menu Items:
  • open: Open...
  • close: Close
  • export_image: Export Image...
  • print: Print...
 
<theme>
Parameter Data Type Default Description
toolbar_border_color Color, in hexadecimal format CCD8E0 Specifies the color for the bottom border edge of the toolbar.
window_border_color Color, in hexadecimal format 2E5B90 Specifies the border color of dialog boxes.
window_title_bar_color Color, in hexadecimal format 3973AC Specifies the color for the title bar of dialog boxes.
window_title_text_color Color, in hexadecimal format FFFFFF Specifies the text color for the title bar of dialog boxes.
 
<grid>
Parameter Data Type Default Description
enabled Boolean (true/false) true Specifies the visibility of the grid.
spacing Number (1 to 100) 24 Specifies the distance between grid lines/dots (in inches).
type Number (1 to 2) 1 Specifies the grid type.
 
Valid Values:
  • 1: Lines.
  • 2: Dots.
thickness Number (0.5 to 3) 1 Specifies the thickness of grid lines/dots (in pixels).
color Color, in hexadecimal format EEEEEE Specifies the default grid color.
 
<wall>
Parameter Data Type Default Description
thickness Number (0.3937 to 24) 6 Specifies the default thickness of walls (in inches).
color Color, in hexadecimal format 153045 Specifies the default color.
shadow Number (0/1) 0 Specifies the strength of the shadow effect.
 
<fence>
Parameter Data Type Default Description
thickness Number (0.3937 to 24) 2 Specifies the default thickness of fences (in inches).
color Color, in hexadecimal format C7BBAC Specifies the default color.
shadow Number (0/1) 0 Specifies the strength of the shadow effect.
 
<area>
Parameter Data Type Default Description
color Color, in hexadecimal format F7F7F7 The default fill color.
text_format font: String (comma-delimited)
size: Number (4 to 100)
bold: Boolean (true/false)
italic: Boolean (true/false)
align: Number (1 to 3)
color: Color, in hexadecimal format
font: (Empty string)
size: 14
bold: false
italic: false
align: 2
color: 000000
The default text format (for labels).
 
<shape>
Parameter Data Type Default Description
fill_color Color, in hexadecimal format EEEEEE The default fill color.
stroke_color Color, in hexadecimal format 000000 The default stroke color.
 
<dimension_line>
Parameter Data Type Default Description
type Number (1 to 6) 1 The default value of the Type option.
text_placement Number (1 to 3) 1 The default value of the Text option.
text_format font: String (comma-delimited)
size: Number (4 to 100)
bold: Boolean (true/false)
italic: Boolean (true/false)
color: Color, in hexadecimal format
font: (Empty string)
size: 10
bold: false
italic: false
color: 000000
The default text format.
 
<text>
Parameter Data Type Default Description
text_format font: String (comma-delimited)
size: Number (4 to 100)
bold: Boolean (true/false)
italic: Boolean (true/false)
align: Number (1 to 3)
color: Color, in hexadecimal format
font: (Empty string)
size: 10
bold: false
italic: false
align: 1
color: 000000
The default text format.
 
<tooltip>
Parameter Data Type Default Description
type Number (1 to 4) 2 Specifies the tooltip style.
position Number (0 to 8) 1 Specifies the position of the tooltip relative to the mouse pointer.
default_offsets Boolean (true/false) true Specifies whether or not to use the default horizontal and vertical offset values.
horizontal_offset Number (-100 to 100) 0 The horizontal distance between the mouse pointer and the tooltip alignment point.
vertical_offset Number (-100 to 100) 0 The vertical distance between the mouse pointer and the tooltip alignment point.
corner Number (0 to 200) 0 Specifies the radius of the corners.
shadow Number (0 to 10) 5 Specifies the strength of the shadow effect.
border Number (0 to 10) 1 Specifies the default border thickness.
back_color Color, in hexadecimal format FFFFCC Specifies the default background color.
border_color Color, in hexadecimal format D0B8B8 Specifies the default border color.
horizontal_padding Number (-10 to 100) 1 Specifies the left and right paddings.
vertical_padding Number (-10 to 100) 1 Specifies the top and bottom paddings.
text_format font: String (comma-delimited)
size: Number (4 to 100)
bold: Boolean (true/false)
italic: Boolean (true/false)
color: Color, in hexadecimal format
font: (Empty string)
size: 12
bold: false
italic: false
color: 000000
Specifies the default text format.
 
<text_info_box>
Parameter Data Type Default Description
type Number (1 to 4) 3 Specifies the info box style.
position Number (0 to 8) 1 Specifies the position of the info box relative to the mouse pointer.
default_offsets Boolean (true/false) true Specifies whether or not to use the default horizontal and vertical offset values.
horizontal_offset Number (-100 to 100) 0 The horizontal distance between the mouse pointer and the info box alignment point.
vertical_offset Number (-100 to 100) 0 The vertical distance between the mouse pointer and the info box alignment point.
corner Number (0 to 200) 10 Specifies the radius of the corners.
shadow Number (0 to 10) 5 Specifies the strength of the shadow effect.
border Number (0 to 10) 2 Specifies the default border thickness.
back_color Color, in hexadecimal format FFFFFF Specifies the default background color.
border_color Color, in hexadecimal format 333333 Specifies the default border color.
horizontal_padding Number (-10 to 100) 5 Specifies the left and right paddings.
vertical_padding Number (-10 to 100) 5 Specifies the top and bottom paddings.
text_format font: String (comma-delimited)
size: Number (4 to 100)
bold: Boolean (true/false)
italic: Boolean (true/false)
align: Number (1 to 3)
color: Color, in hexadecimal format
font: (Empty string)
size: 12
bold: false
italic: false
align: 1
color: 000000
Specifies the default text format.
 
<image_info_box>
Parameter Data Type Default Description
type Number (1 to 4) 3 Specifies the info box style.
position Number (0 to 8) 1 Specifies the position of the info box relative to the mouse pointer.
default_offsets Boolean (true/false) true Specifies whether or not to use the default horizontal and vertical offset values.
horizontal_offset Number (-100 to 100) 0 The horizontal distance between the mouse pointer and the info box alignment point.
vertical_offset Number (-100 to 100) 0 The vertical distance between the mouse pointer and the info box alignment point.
corner Number (0 to 200) 10 Specifies the radius of the corners.
shadow Number (0 to 10) 5 Specifies the strength of the shadow effect.
border Number (0 to 10) 2 Specifies the default border thickness.
back_color Color, in hexadecimal format FFFFFF Specifies the default background color.
border_color Color, in hexadecimal format 333333 Specifies the default border color.
horizontal_padding Number (-10 to 100) 5 Specifies the left and right paddings.
vertical_padding Number (-10 to 100) 5 Specifies the top and bottom paddings.
 
<pop_up>
Parameter Data Type Default Description
type Number (1 to 4) 3 Specifies the pop-up style.
position Number (0 to 8) 1 Specifies the position of the pop-up relative to the mouse pointer.
default_offsets Boolean (true/false) true Specifies whether or not to use the default horizontal and vertical offset values.
horizontal_offset Number (-100 to 100) 0 The horizontal distance between the mouse pointer and the pop-up alignment point.
vertical_offset Number (-100 to 100) 0 The vertical distance between the mouse pointer and the pop-up alignment point.
modal Boolean (true/false) false Specifies whether the pop-up box is modal or non-modal.
close_button Boolean (true/false) false Specifies whether the pop-up box has a Close button.
corner Number (0 to 200) 10 Specifies the radius of the corners.
shadow Number (0 to 10) 5 Specifies the strength of the shadow effect.
border Number (0 to 10) 2 Specifies the default border thickness.
back_color Color, in hexadecimal format FFFFFF Specifies the default background color.
border_color Color, in hexadecimal format 333333 Specifies the default border color.
button_color Color, in hexadecimal format 999999 Specifies the default color of the Close button.
text_format font: String (comma-delimited)
size: Number (4 to 100)
bold: Boolean (true/false)
italic: Boolean (true/false)
align: Number (1 to 3)
color: Color, in hexadecimal format
font: (Empty string)
size: 12
bold: false
italic: false
align: 1
color: 000000
Specifies the default text format.

 

[p] Symbol

The [p] symbol is a placeholder for a random number that the Flash object appends to the calling URL, to prevent the browser from caching the server reply,
for example the Flash object converts file.php?v=[p] to something like this: file.php?v=7239472.