Module:US elections imagemap/doc
 | This is a documentation subpage for Module:US elections imagemap. It may contain usage information, categories and other content that is not part of the original module page. |
 | This module is rated as beta. It is considered ready for widespread use, but as it is still relatively new, it should be applied with some caution to ensure results are as expected. |
Usage
[edit]For general usage, use the wrapped template at {{US elections imagemap}}. This page is mainly documentation for Module maintainers.
Functions
[edit]makeMap
[edit]Generates the inner part of an imagemap. Needs to be wrapped with imagemap tags to work, this only generates state shapes and links. This is due to a limitation in Lua modules.
| Parameter | Usage | Example |
|---|---|---|
| link_template | Template for links | 2018 STATE gubernatorial election |
| cycle | Election cycle | Gov2[a] |
| extra_states | Extra states to include[b] | OR;WV[a] |
| extra_lines | Extra raw lines to include[b] | rect 702 391 725 423 [[2020–21 United States Senate special election in Georgia]] |
| state_overrides | Set a custom link for the state, instead of following the template[b] | AZ=2020 United States Senate special election in Arizona |
| excluded_states | States to exclude. Overridden by extra_states[b] | AK;HI |
Submodules
[edit]- Module:US elections imagemap/utils — string utilities
- Module:US elections imagemap/data — shapes and cycle data