Class Basemap

Helper class for creating and parsing Basemap XML documents

Hierarchy

default<BasemapType>
- Basemap

Index

Constructors

constructor

new Basemap(raw): Basemap
Parameters
- raw: {
      customMapSource: {
          backgroundColor?: {
              _text: string;
          };
          maxZoom: {
              _text: number;
          };
          minZoom: {
              _text: number;
          };
          name: {
              _text: string;
          };
          tileType: {
              _text: string;
          };
          tileUpdate?: {
              _text: string;
          };
          url?: {
              _text: string;
          };
      };
  }
  - customMapSource: {
        backgroundColor?: {
            _text: string;
        };
        maxZoom: {
            _text: number;
        };
        minZoom: {
            _text: number;
        };
        name: {
            _text: string;
        };
        tileType: {
            _text: string;
        };
        tileUpdate?: {
            _text: string;
        };
        url?: {
            _text: string;
        };
    }
    - OptionalbackgroundColor?: {
      _text: string;
      }
      _text: string
    - maxZoom: {
      _text: number;
      }
      _text: number
    - minZoom: {
      _text: number;
      }
      _text: number
    - name: {
      _text: string;
      }
      _text: string
    - tileType: {
      _text: string;
      }
      _text: string
    - OptionaltileUpdate?: {
      _text: string;
      }
      _text: string
    - Optionalurl?: {
      _text: string;
      }
      _text: string
Returns Basemap
Inherited from XMLDocument<BasemapType>.constructor
- Defined in lib/xml-document.ts:12

Properties

raw

raw: {
    customMapSource: {
        backgroundColor?: {
            _text: string;
        };
        maxZoom: {
            _text: number;
        };
        minZoom: {
            _text: number;
        };
        name: {
            _text: string;
        };
        tileType: {
            _text: string;
        };
        tileUpdate?: {
            _text: string;
        };
        url?: {
            _text: string;
        };
    };
}

Methods

to_json

to_json(): {
    backgroundColor: undefined | string;
    maxZoom: undefined | number;
    minZoom: undefined | number;
    name: undefined | string;
    tileType: undefined | string;
    tileUpdate: undefined | string;
    url: string;
}
Returns {
    backgroundColor: undefined | string;
    maxZoom: undefined | number;
    minZoom: undefined | number;
    name: undefined | string;
    tileType: undefined | string;
    tileUpdate: undefined | string;
    url: string;
}
- backgroundColor: undefined | string
- maxZoom: undefined | number
- minZoom: undefined | number
- name: undefined | string
- tileType: undefined | string
- tileUpdate: undefined | string
- url: string
- Defined in lib/xml/basemap.ts:28

to_xml

to_xml(): string
Returns string
Inherited from XMLDocument.to_xml
- Defined in lib/xml-document.ts:25

`Static`check

check<U>(input, check): U
Type Parameters
- U
Parameters
- input: string
- check: ValidateFunction<unknown>
Returns U
Inherited from XMLDocument.check
- Defined in lib/xml-document.ts:16

`Static`parse

parse(input): Basemap
Return a Basemap from a string XML representation
Parameters
- input: string
Returns Basemap
- Defined in lib/xml/basemap.ts:23

Class Basemap

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

customMapSource: { backgroundColor?: { _text: string; }; maxZoom: { _text: number; }; minZoom: { _text: number; }; name: { _text: string; }; tileType: { _text: string; }; tileUpdate?: { _text: string; }; url?: { _text: string; }; }

OptionalbackgroundColor?: { _text: string; }

_text: string

maxZoom: { _text: number; }

_text: number

minZoom: { _text: number; }

_text: number

name: { _text: string; }

_text: string

tileType: { _text: string; }

_text: string

OptionaltileUpdate?: { _text: string; }

_text: string

Optionalurl?: { _text: string; }

_text: string

Returns Basemap

Properties

raw

Methods

to_json

Returns { backgroundColor: undefined | string; maxZoom: undefined | number; minZoom: undefined | number; name: undefined | string; tileType: undefined | string; tileUpdate: undefined | string; url: string; }

backgroundColor: undefined | string

maxZoom: undefined | number

minZoom: undefined | number

name: undefined | string

tileType: undefined | string

tileUpdate: undefined | string

url: string

to_xml

Returns string

Staticcheck

Type Parameters

Parameters

Returns U

Staticparse

Parameters

Returns Basemap

Settings

On This Page

customMapSource: {
backgroundColor?: {
_text: string;
};
maxZoom: {
_text: number;
};
minZoom: {
_text: number;
};
name: {
_text: string;
};
tileType: {
_text: string;
};
tileUpdate?: {
_text: string;
};
url?: {
_text: string;
};
}

`Optional`backgroundColor?: {
_text: string;
}

maxZoom: {
_text: number;
}

minZoom: {
_text: number;
}

name: {
_text: string;
}

tileType: {
_text: string;
}

`Optional`tileUpdate?: {
_text: string;
}

`Optional`url?: {
_text: string;
}

Returns {
backgroundColor: undefined | string;
maxZoom: undefined | number;
minZoom: undefined | number;
name: undefined | string;
tileType: undefined | string;
tileUpdate: undefined | string;
url: string;
}

`Static`check

`Static`parse