Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "api/i18n"

Index

Variables

Functions

Variables

DEFAULT_LOCALE

DEFAULT_LOCALE: "en" = "en"

Functions

fmt

  • fmt(format: string, args?: any): string

  • Formats the specified string and substitutes any placeholders (enclosed in {}) with the specified arguments

    export

    Parameters

    • format: string
    • Optional args: any

    Returns string

registerStringBundle

  • Registers a string bundle for the given locale

    export

    Parameters

    Returns void

tr

  • tr(key: "LAYER_ID_BASE" | "LAYER_ID_MG_BASE" | "LAYER_ID_MG_SEL_OVERLAY" | "NONE" | "ERROR" | "WARNING" | "INIT_WARNINGS_FOUND" | "INIT_WARNING_BING_API_KEY_REQD" | "INIT_WARNING_BING_UNKNOWN_LAYER" | "INIT_WARNING_UNSUPPORTED_GOOGLE_MAPS" | "LAYER_TRANSPARENCY" | "UNKNOWN_WIDGET" | "UNKNOWN_COMMAND_REFERENCE" | "INIT" | "INIT_DESC" | "INIT_ERROR_TITLE" | "INIT_ERROR_UNKNOWN_RESOURCE_TYPE" | "INIT_ERROR_MISSING_RESOURCE_PARAM" | "INIT_ERROR_UNSUPPORTED_COORD_SYS" | "INIT_ERROR_UNREGISTERED_EPSG_CODE" | "INIT_ERROR_EXPIRED_SESSION" | "INIT_ERROR_RESOURCE_NOT_FOUND" | "INIT_ERROR_NO_CONNECTION" | "TPL_SIDEBAR_OPEN_TASKPANE" | "TPL_SIDEBAR_OPEN_LEGEND" | "TPL_SIDEBAR_OPEN_SELECTION_PANEL" | "TPL_TITLE_TASKPANE" | "TPL_TITLE_LEGEND" | "TPL_TITLE_SELECTION_PANEL" | "TT_GO_HOME" | "TT_GO_BACK" | "TT_GO_FORWARD" | "SESSION_EXPIRED" | "SESSION_EXPIRED_DETAILED" | "SESSION_EXPIRED_AVAILABLE_ACTIONS" | "SESSION_EXPIRED_RELOAD_VIEWER" | "ERR_UNREGISTERED_LAYOUT" | "ERR_UNREGISTERED_COMPONENT" | "ERR_NO_COMPONENT_ID" | "LOADING_MSG" | "MENU_TASKS" | "NO_SELECTED_FEATURES" | "FMT_SCALE_DISPLAY" | "FMT_SELECTION_COUNT" | "DIGITIZE_POINT_PROMPT" | "DIGITIZE_LINE_PROMPT" | "DIGITIZE_LINESTRING_PROMPT" | "DIGITIZE_CIRCLE_PROMPT" | "DIGITIZE_RECT_PROMPT" | "DIGITIZE_POLYGON_PROMPT" | "MEASURE" | "MEASURING" | "MEASURING_MESSAGE" | "MEASUREMENT" | "MEASUREMENT_TYPE" | "MEASUREMENT_TYPE_LENGTH" | "MEASUREMENT_TYPE_AREA" | "MEASUREMENT_USE_GEODESIC" | "MEASUREMENT_CLEAR" | "MEASUREMENT_CONTINUE_POLYGON" | "MEASUREMENT_CONTINUE_LINE" | "MEASUREMENT_START_DRAWING" | "MEASUREMENT_START" | "MEASUREMENT_END" | "NAVIGATOR_PAN_EAST" | "NAVIGATOR_PAN_WEST" | "NAVIGATOR_PAN_SOUTH" | "NAVIGATOR_PAN_NORTH" | "NAVIGATOR_ZOOM_OUT" | "NAVIGATOR_ZOOM_IN" | "FMT_NAVIGATOR_ZOOM_TO_SCALE" | "EXTERNAL_BASE_LAYERS" | "SELECTION_PROPERTY" | "SELECTION_VALUE" | "SELECTION_PREV_FEATURE" | "SELECTION_NEXT_FEATURE" | "SELECTION_ZOOMTO_FEATURE" | "VIEWER_OPTIONS" | "ABOUT" | "HELP" | "QUICKPLOT_HEADER" | "QUICKPLOT_TITLE" | "QUICKPLOT_SUBTITLE" | "QUICKPLOT_PAPER_SIZE" | "QUICKPLOT_ORIENTATION" | "QUICKPLOT_ORIENTATION_P" | "QUICKPLOT_ORIENTATION_L" | "QUICKPLOT_SHOWELEMENTS" | "QUICKPLOT_SHOWLEGEND" | "QUICKPLOT_SHOWNORTHARROW" | "QUICKPLOT_SHOWCOORDINTES" | "QUICKPLOT_SHOWSCALEBAR" | "QUICKPLOT_SHOWDISCLAIMER" | "QUICKPLOT_ADVANCED_OPTIONS" | "QUICKPLOT_SCALING" | "QUICKPLOT_DPI" | "QUICKPLOT_BOX_INFO" | "QUICKPLOT_BOX_ROTATION" | "QUICKPLOT_GENERATE" | "QUICKPLOT_COMMERCIAL_LAYER_WARNING" | "FEATURE_TOOLTIPS" | "GEOLOCATION_SUCCESS" | "GEOLOCATION_WARN_OUTSIDE_MAP" | "GEOLOCATION_ERROR" | "TASK_PANE_CONTENT_FOR_INACTIVE_MAP_TITLE" | "TASK_PANE_CONTENT_FOR_INACTIVE_MAP_WARNING" | "COORDTRACKER" | "COORDTRACKER_NO_PROJECTIONS" | "MAP_SIZE_DISPLAY_UNITS" | "OK", locale?: string, args?: any): string

  • Returns the localized string for the given key

    export

    Parameters

    • key: "LAYER_ID_BASE" | "LAYER_ID_MG_BASE" | "LAYER_ID_MG_SEL_OVERLAY" | "NONE" | "ERROR" | "WARNING" | "INIT_WARNINGS_FOUND" | "INIT_WARNING_BING_API_KEY_REQD" | "INIT_WARNING_BING_UNKNOWN_LAYER" | "INIT_WARNING_UNSUPPORTED_GOOGLE_MAPS" | "LAYER_TRANSPARENCY" | "UNKNOWN_WIDGET" | "UNKNOWN_COMMAND_REFERENCE" | "INIT" | "INIT_DESC" | "INIT_ERROR_TITLE" | "INIT_ERROR_UNKNOWN_RESOURCE_TYPE" | "INIT_ERROR_MISSING_RESOURCE_PARAM" | "INIT_ERROR_UNSUPPORTED_COORD_SYS" | "INIT_ERROR_UNREGISTERED_EPSG_CODE" | "INIT_ERROR_EXPIRED_SESSION" | "INIT_ERROR_RESOURCE_NOT_FOUND" | "INIT_ERROR_NO_CONNECTION" | "TPL_SIDEBAR_OPEN_TASKPANE" | "TPL_SIDEBAR_OPEN_LEGEND" | "TPL_SIDEBAR_OPEN_SELECTION_PANEL" | "TPL_TITLE_TASKPANE" | "TPL_TITLE_LEGEND" | "TPL_TITLE_SELECTION_PANEL" | "TT_GO_HOME" | "TT_GO_BACK" | "TT_GO_FORWARD" | "SESSION_EXPIRED" | "SESSION_EXPIRED_DETAILED" | "SESSION_EXPIRED_AVAILABLE_ACTIONS" | "SESSION_EXPIRED_RELOAD_VIEWER" | "ERR_UNREGISTERED_LAYOUT" | "ERR_UNREGISTERED_COMPONENT" | "ERR_NO_COMPONENT_ID" | "LOADING_MSG" | "MENU_TASKS" | "NO_SELECTED_FEATURES" | "FMT_SCALE_DISPLAY" | "FMT_SELECTION_COUNT" | "DIGITIZE_POINT_PROMPT" | "DIGITIZE_LINE_PROMPT" | "DIGITIZE_LINESTRING_PROMPT" | "DIGITIZE_CIRCLE_PROMPT" | "DIGITIZE_RECT_PROMPT" | "DIGITIZE_POLYGON_PROMPT" | "MEASURE" | "MEASURING" | "MEASURING_MESSAGE" | "MEASUREMENT" | "MEASUREMENT_TYPE" | "MEASUREMENT_TYPE_LENGTH" | "MEASUREMENT_TYPE_AREA" | "MEASUREMENT_USE_GEODESIC" | "MEASUREMENT_CLEAR" | "MEASUREMENT_CONTINUE_POLYGON" | "MEASUREMENT_CONTINUE_LINE" | "MEASUREMENT_START_DRAWING" | "MEASUREMENT_START" | "MEASUREMENT_END" | "NAVIGATOR_PAN_EAST" | "NAVIGATOR_PAN_WEST" | "NAVIGATOR_PAN_SOUTH" | "NAVIGATOR_PAN_NORTH" | "NAVIGATOR_ZOOM_OUT" | "NAVIGATOR_ZOOM_IN" | "FMT_NAVIGATOR_ZOOM_TO_SCALE" | "EXTERNAL_BASE_LAYERS" | "SELECTION_PROPERTY" | "SELECTION_VALUE" | "SELECTION_PREV_FEATURE" | "SELECTION_NEXT_FEATURE" | "SELECTION_ZOOMTO_FEATURE" | "VIEWER_OPTIONS" | "ABOUT" | "HELP" | "QUICKPLOT_HEADER" | "QUICKPLOT_TITLE" | "QUICKPLOT_SUBTITLE" | "QUICKPLOT_PAPER_SIZE" | "QUICKPLOT_ORIENTATION" | "QUICKPLOT_ORIENTATION_P" | "QUICKPLOT_ORIENTATION_L" | "QUICKPLOT_SHOWELEMENTS" | "QUICKPLOT_SHOWLEGEND" | "QUICKPLOT_SHOWNORTHARROW" | "QUICKPLOT_SHOWCOORDINTES" | "QUICKPLOT_SHOWSCALEBAR" | "QUICKPLOT_SHOWDISCLAIMER" | "QUICKPLOT_ADVANCED_OPTIONS" | "QUICKPLOT_SCALING" | "QUICKPLOT_DPI" | "QUICKPLOT_BOX_INFO" | "QUICKPLOT_BOX_ROTATION" | "QUICKPLOT_GENERATE" | "QUICKPLOT_COMMERCIAL_LAYER_WARNING" | "FEATURE_TOOLTIPS" | "GEOLOCATION_SUCCESS" | "GEOLOCATION_WARN_OUTSIDE_MAP" | "GEOLOCATION_ERROR" | "TASK_PANE_CONTENT_FOR_INACTIVE_MAP_TITLE" | "TASK_PANE_CONTENT_FOR_INACTIVE_MAP_WARNING" | "COORDTRACKER" | "COORDTRACKER_NO_PROJECTIONS" | "MAP_SIZE_DISPLAY_UNITS" | "OK"
    • Default value locale: string = DEFAULT_LOCALE
    • Optional args: any

    Returns string

Generated using TypeDoc