docs: update docs

agrc · Sep 22, 2020 · 86714e8 · 86714e8
1 parent d17d85a
commit 86714e8
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 11 deletions.
diff --git a/...nfo-properties-filter-properties-checkboxes-checkbox-properties-offbydefault.md b/...nfo-properties-filter-properties-checkboxes-checkbox-properties-offbydefault.md
@@ -0,0 +1,3 @@
+## offByDefault Type
+
+`boolean`
diff --git a/...operties-map-infos-map-info-properties-filter-properties-checkboxes-checkbox.md b/...operties-map-infos-map-info-properties-filter-properties-checkboxes-checkbox.md
@@ -9,17 +9,18 @@ one (and only one) of
 
 # Checkbox Properties
 
-| Property                            | Type     | Required | Nullable       | Defined by                                                                                                                                                                                                                                                                                                                      |
-| :---------------------------------- | -------- | -------- | -------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| [label](#label)                     | `string` | Required | cannot be null | [WFRC App](config-properties-map-infos-map-info-properties-filter-properties-checkboxes-checkbox-properties-label.md "https&#x3A;//wfrc.org/wasatch-choice-map/config.schema.json#/properties/mapInfos/additionalProperties/properties/filter/properties/checkboxes/additionalProperties/properties/label")                     |
-| [layerNames](#layerNames)           | `array`  | Optional | cannot be null | [WFRC App](config-properties-map-infos-map-info-properties-filter-properties-checkboxes-checkbox-properties-layernames.md "https&#x3A;//wfrc.org/wasatch-choice-map/config.schema.json#/properties/mapInfos/additionalProperties/properties/filter/properties/checkboxes/additionalProperties/properties/layerNames")           |
-| [phase](#phase)                     | `number` | Optional | cannot be null | [WFRC App](config-properties-map-infos-map-info-properties-filter-properties-checkboxes-checkbox-properties-phase.md "https&#x3A;//wfrc.org/wasatch-choice-map/config.schema.json#/properties/mapInfos/additionalProperties/properties/filter/properties/checkboxes/additionalProperties/properties/phase")                     |
-| [symbol](#symbol)                   | `string` | Optional | cannot be null | [WFRC App](config-properties-map-infos-map-info-properties-filter-properties-checkboxes-checkbox-properties-symbol.md "https&#x3A;//wfrc.org/wasatch-choice-map/config.schema.json#/properties/mapInfos/additionalProperties/properties/filter/properties/checkboxes/additionalProperties/properties/symbol")                   |
-| [symbolImageFile](#symbolImageFile) | `string` | Optional | cannot be null | [WFRC App](config-properties-map-infos-map-info-properties-filter-properties-checkboxes-checkbox-properties-symbolimagefile.md "https&#x3A;//wfrc.org/wasatch-choice-map/config.schema.json#/properties/mapInfos/additionalProperties/properties/filter/properties/checkboxes/additionalProperties/properties/symbolImageFile") |
-| [symbolLayerIds](#symbolLayerIds)   | `array`  | Optional | cannot be null | [WFRC App](config-properties-map-infos-map-info-properties-filter-properties-checkboxes-checkbox-properties-symbollayerids.md "https&#x3A;//wfrc.org/wasatch-choice-map/config.schema.json#/properties/mapInfos/additionalProperties/properties/filter/properties/checkboxes/additionalProperties/properties/symbolLayerIds")   |
-| [symbolLabels](#symbolLabels)       | `array`  | Optional | cannot be null | [WFRC App](config-properties-map-infos-map-info-properties-filter-properties-checkboxes-checkbox-properties-symbollabels.md "https&#x3A;//wfrc.org/wasatch-choice-map/config.schema.json#/properties/mapInfos/additionalProperties/properties/filter/properties/checkboxes/additionalProperties/properties/symbolLabels")       |
-| [staticColors](#staticColors)       | `array`  | Optional | cannot be null | [WFRC App](config-properties-map-infos-map-info-properties-filter-properties-checkboxes-checkbox-properties-staticcolors.md "https&#x3A;//wfrc.org/wasatch-choice-map/config.schema.json#/properties/mapInfos/additionalProperties/properties/filter/properties/checkboxes/additionalProperties/properties/staticColors")       |
-| [color](#color)                     | `string` | Optional | cannot be null | [WFRC App](config-properties-map-infos-map-info-properties-filter-properties-checkboxes-checkbox-properties-color.md "https&#x3A;//wfrc.org/wasatch-choice-map/config.schema.json#/properties/mapInfos/additionalProperties/properties/filter/properties/checkboxes/additionalProperties/properties/color")                     |
+| Property                            | Type      | Required | Nullable       | Defined by                                                                                                                                                                                                                                                                                                                      |
+| :---------------------------------- | --------- | -------- | -------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| [label](#label)                     | `string`  | Required | cannot be null | [WFRC App](config-properties-map-infos-map-info-properties-filter-properties-checkboxes-checkbox-properties-label.md "https&#x3A;//wfrc.org/wasatch-choice-map/config.schema.json#/properties/mapInfos/additionalProperties/properties/filter/properties/checkboxes/additionalProperties/properties/label")                     |
+| [layerNames](#layerNames)           | `array`   | Optional | cannot be null | [WFRC App](config-properties-map-infos-map-info-properties-filter-properties-checkboxes-checkbox-properties-layernames.md "https&#x3A;//wfrc.org/wasatch-choice-map/config.schema.json#/properties/mapInfos/additionalProperties/properties/filter/properties/checkboxes/additionalProperties/properties/layerNames")           |
+| [offByDefault](#offByDefault)       | `boolean` | Optional | cannot be null | [WFRC App](config-properties-map-infos-map-info-properties-filter-properties-checkboxes-checkbox-properties-offbydefault.md "https&#x3A;//wfrc.org/wasatch-choice-map/config.schema.json#/properties/mapInfos/additionalProperties/properties/filter/properties/checkboxes/additionalProperties/properties/offByDefault")       |
+| [phase](#phase)                     | `number`  | Optional | cannot be null | [WFRC App](config-properties-map-infos-map-info-properties-filter-properties-checkboxes-checkbox-properties-phase.md "https&#x3A;//wfrc.org/wasatch-choice-map/config.schema.json#/properties/mapInfos/additionalProperties/properties/filter/properties/checkboxes/additionalProperties/properties/phase")                     |
+| [symbol](#symbol)                   | `string`  | Optional | cannot be null | [WFRC App](config-properties-map-infos-map-info-properties-filter-properties-checkboxes-checkbox-properties-symbol.md "https&#x3A;//wfrc.org/wasatch-choice-map/config.schema.json#/properties/mapInfos/additionalProperties/properties/filter/properties/checkboxes/additionalProperties/properties/symbol")                   |
+| [symbolImageFile](#symbolImageFile) | `string`  | Optional | cannot be null | [WFRC App](config-properties-map-infos-map-info-properties-filter-properties-checkboxes-checkbox-properties-symbolimagefile.md "https&#x3A;//wfrc.org/wasatch-choice-map/config.schema.json#/properties/mapInfos/additionalProperties/properties/filter/properties/checkboxes/additionalProperties/properties/symbolImageFile") |
+| [symbolLayerIds](#symbolLayerIds)   | `array`   | Optional | cannot be null | [WFRC App](config-properties-map-infos-map-info-properties-filter-properties-checkboxes-checkbox-properties-symbollayerids.md "https&#x3A;//wfrc.org/wasatch-choice-map/config.schema.json#/properties/mapInfos/additionalProperties/properties/filter/properties/checkboxes/additionalProperties/properties/symbolLayerIds")   |
+| [symbolLabels](#symbolLabels)       | `array`   | Optional | cannot be null | [WFRC App](config-properties-map-infos-map-info-properties-filter-properties-checkboxes-checkbox-properties-symbollabels.md "https&#x3A;//wfrc.org/wasatch-choice-map/config.schema.json#/properties/mapInfos/additionalProperties/properties/filter/properties/checkboxes/additionalProperties/properties/symbolLabels")       |
+| [staticColors](#staticColors)       | `array`   | Optional | cannot be null | [WFRC App](config-properties-map-infos-map-info-properties-filter-properties-checkboxes-checkbox-properties-staticcolors.md "https&#x3A;//wfrc.org/wasatch-choice-map/config.schema.json#/properties/mapInfos/additionalProperties/properties/filter/properties/checkboxes/additionalProperties/properties/staticColors")       |
+| [color](#color)                     | `string`  | Optional | cannot be null | [WFRC App](config-properties-map-infos-map-info-properties-filter-properties-checkboxes-checkbox-properties-color.md "https&#x3A;//wfrc.org/wasatch-choice-map/config.schema.json#/properties/mapInfos/additionalProperties/properties/filter/properties/checkboxes/additionalProperties/properties/color")                     |
 
 ## label
 
@@ -53,6 +54,22 @@ Defines the layer(s) that you want to toggle. Values must match the property nam
 
 `string[]`
 
+## offByDefault
+
+Set this to true to make the checkbox unchecked on load.
+
+
+`offByDefault`
+
+-   is optional
+-   Type: `boolean`
+-   cannot be null
+-   defined in: [WFRC App](config-properties-map-infos-map-info-properties-filter-properties-checkboxes-checkbox-properties-offbydefault.md "https&#x3A;//wfrc.org/wasatch-choice-map/config.schema.json#/properties/mapInfos/additionalProperties/properties/filter/properties/checkboxes/additionalProperties/properties/offByDefault")
+
+### offByDefault Type
+
+`boolean`
+
 ## phase
 
 Defines the zero-based index of the phase that this checkbox is associated with.