Galigeo API
    Preparing search index...

    Class MapParameters

    MapParameters defines all the properties of the map (name, rights, data, etc..). Only the name is mandatory.

    Index

    Constructors

    constructor

    Properties

    apiKey crossDomain data encodeFields genericAuthentication lang mapId name oauth2Enabled oauth2Popup parent profile redirect skipAutoCreateLayer timeout url user

    Constructors

    Properties

    apiKey: string

    You can get the api key from the licence page of Galigeo. A valid API key is required to get a map instance.

    crossDomain: boolean

    Set crossdomain=true when the map is sandboxed (optional).

    data: any[]

    An array of data that will be loaded dynamically with map (optional). Two types of data are supported:

    • inline json features
    • link to a csv file Please see our sample page for more details how to specify the data
    encodeFields: boolean = true

    When true, the field names are cleaned up from any special characters and set to lower case (optional, default=true). This option can be set to false when field names are used in the API to avoid any case sensitive behavior.

    genericAuthentication: { editMode: boolean } = ...

    Define a default authentication behavior for the map. When used, the user/profile are ignored.

    lang: string

    Optionally specify the language. By default the browser language is used

    mapId: string

    This ID is used to identify the map. When this property is not defined, then the ID is generated based on the name of the map.

    name: string

    Name of the map. If a name is specified but not a mapId, then the mapId is generated from the name.

    oauth2Enabled: boolean

    When true, the oauth2 of the organization is applied (optional, default=true). This option is useful only if oauth2 is enabled on the organization.

    oauth2Popup: boolean

    When true, the oauth2 is opened in a popup (optional, default=false). This option is useful only if oauth2 is enabled on the organization and the parameter oauth2Enabled is set to true.

    parent: string

    Specify the entity using the API (optional).

    profile: string

    Used to force the user profile (optional). Default profiles are Viewer, Explorer, Creator and Designer. It is possible to add custom profiles in the user management of the Galigeo admin page.

    redirect: boolean

    When true, redirect to the map url instead of using an iframe (optional, default=false). This option is useful in some specific sandbox environment where the creation of an iframe is forbidden.

    skipAutoCreateLayer: boolean

    When true, no layer is created by default on an empty maps (defaut false)

    timeout: number

    Define the timeout for the map to be loaded (optional, default=30000).

    url: string

    URL of Galigeo. When not defined, the url is https://showcase.galigeo.com

    user: string

    Used to force the username (optional). If the username is not defined, then currently logged used will be used. This is done by checking the cookie "GaligeoToken". If no active session is detected and the user property is not defined, then the default value is anonymous.

    Settings

    On This Page

    Constructors
    Properties