From 5cdd31bb1828923a0853ef9d4c3c420564c0b198 Mon Sep 17 00:00:00 2001 From: amarzavery Date: Fri, 25 May 2018 19:01:12 +0000 Subject: [PATCH] Initialize open publishing repository: https://github.com/Azure/azure-event-hubs-node of branch master --- .openpublishing.publish.config.json | 22 +- client/docs/breadcrumb/toc.yml | 5 + client/docs/docfx.json | 52 ++ client/docs/docs-ref-autogen/BoundingBox.yml | 50 ++ client/docs/docs-ref-autogen/Map.yml | 528 +++++++++++++++++++ client/docs/docs-ref-autogen/index.yml | 16 + client/docs/docs-ref-autogen/toc.yml | 6 + 7 files changed, 678 insertions(+), 1 deletion(-) create mode 100644 client/docs/breadcrumb/toc.yml create mode 100644 client/docs/docfx.json create mode 100644 client/docs/docs-ref-autogen/BoundingBox.yml create mode 100644 client/docs/docs-ref-autogen/Map.yml create mode 100644 client/docs/docs-ref-autogen/index.yml create mode 100644 client/docs/docs-ref-autogen/toc.yml diff --git a/.openpublishing.publish.config.json b/.openpublishing.publish.config.json index 7cc765a..d14f63a 100644 --- a/.openpublishing.publish.config.json +++ b/.openpublishing.publish.config.json @@ -1,5 +1,25 @@ { - "docsets_to_publish": [], + "docsets_to_publish": [ + { + "docset_name": "event-hubs-js", + "build_source_folder": "client/docs", + "build_output_subfolder": "event-hubs-js", + "locale": "en-us", + "monikers": [], + "moniker_ranges": [], + "open_to_public_contributors": true, + "type_mapping": { + "Conceptual": "Content", + "ManagedReference": "Content", + "RestApi": "Content", + "UniversalReference": "Content" + }, + "build_entry_point": "docs", + "template_folder": "_themes", + "base_path": "javascript", + "site_name": "Docs" + } + ], "notification_subscribers": [], "sync_notification_subscribers": [], "branches_to_filter": [], diff --git a/client/docs/breadcrumb/toc.yml b/client/docs/breadcrumb/toc.yml new file mode 100644 index 0000000..1907655 --- /dev/null +++ b/client/docs/breadcrumb/toc.yml @@ -0,0 +1,5 @@ + +- name: Docs + href: / + homepage: / + items: \ No newline at end of file diff --git a/client/docs/docfx.json b/client/docs/docfx.json new file mode 100644 index 0000000..fc9a417 --- /dev/null +++ b/client/docs/docfx.json @@ -0,0 +1,52 @@ +{ + "build": { + "content": [ + { + "files": [ + "**/*.md", + "**/*.yml" + ], + "src": "docs-ref-autogen", + "exclude": [ + "**/obj/**", + "**/includes/**", + "README.md", + "LICENSE", + "LICENSE-CODE", + "ThirdPartyNotices" + ] + }, + { + "files": [ + "**/*.yml" + ], + "src": "breadcrumb", + "dest": "breadcrumb", + "exclude": [ + "**/obj/**", + "**/includes/**" + ] + } + ], + "resource": [ + { + "files": [ + "**/*.png", + "**/*.jpg" + ], + "exclude": [ + "**/obj/**", + "**/includes/**" + ] + } + ], + "overwrite": [], + "externalReference": [], + "globalMetadata": { + "breadcrumb_path": "~/breadcrumb/toc.yml" + }, + "fileMetadata": {}, + "template": [], + "dest": "_site" + } +} \ No newline at end of file diff --git a/client/docs/docs-ref-autogen/BoundingBox.yml b/client/docs/docs-ref-autogen/BoundingBox.yml new file mode 100644 index 0000000..23f29ad --- /dev/null +++ b/client/docs/docs-ref-autogen/BoundingBox.yml @@ -0,0 +1,50 @@ +### YamlMime:UniversalReference +items: + - uid: azure-atlas-javscript-sdk.BoundingBox + name: BoundingBox + fullName: BoundingBox + children: + - azure-atlas-javscript-sdk.BoundingBox.Array + - azure-atlas-javscript-sdk.BoundingBox.constructor + langs: + - typeScript + type: class + summary: >- + The definition of a + GeoJSON bounding box. + extends: + name: Array + - uid: azure-atlas-javscript-sdk.BoundingBox.Array + name: Array + fullName: Array + children: [] + langs: + - typeScript + type: property + summary: '' + syntax: + content: static ArrayConstructor Array + return: + type: + - ArrayConstructor + - uid: azure-atlas-javscript-sdk.BoundingBox.constructor + name: BoundingBox + children: [] + type: constructor + langs: + - typeScript + summary: Constructs a bounding box. + syntax: + content: >- + new BoundingBox(southwestPosition: Position, northeastPosition: + Position) + parameters: + - id: southwestPosition + type: + - '@azure-atlas-javscript-sdk.Position' + description: The southwestern most position of the bounding box. + - id: northeastPosition + type: + - '@azure-atlas-javscript-sdk.Position' + description: | + The northeastern most position of the bounding box. diff --git a/client/docs/docs-ref-autogen/Map.yml b/client/docs/docs-ref-autogen/Map.yml new file mode 100644 index 0000000..c681d0a --- /dev/null +++ b/client/docs/docs-ref-autogen/Map.yml @@ -0,0 +1,528 @@ +### YamlMime:UniversalReference +items: + - uid: azure-atlas-javscript-sdk.Map + name: Map + fullName: Map + children: + - azure-atlas-javscript-sdk.Map.addEventListener + - azure-atlas-javscript-sdk.Map.addEventListener_1 + - azure-atlas-javscript-sdk.Map.addHtml + - azure-atlas-javscript-sdk.Map.addLinestrings + - azure-atlas-javscript-sdk.Map.addPins + - azure-atlas-javscript-sdk.Map.addPolygons + - azure-atlas-javscript-sdk.Map.addRaster + - azure-atlas-javscript-sdk.Map.getCamera + - azure-atlas-javscript-sdk.Map.getCanvas + - azure-atlas-javscript-sdk.Map.getCanvasContainer + - azure-atlas-javscript-sdk.Map.getLayers + - azure-atlas-javscript-sdk.Map.getMapContainer + - azure-atlas-javscript-sdk.Map.getServiceOptions + - azure-atlas-javscript-sdk.Map.getStyle + - azure-atlas-javscript-sdk.Map.getTraffic + - azure-atlas-javscript-sdk.Map.getUserInteraction + - azure-atlas-javscript-sdk.Map.constructor + - azure-atlas-javscript-sdk.Map.removeEventListener + - azure-atlas-javscript-sdk.Map.removeEventListener_1 + - azure-atlas-javscript-sdk.Map.removeHtml + - azure-atlas-javscript-sdk.Map.removeLayers + - azure-atlas-javscript-sdk.Map.setCamera + - azure-atlas-javscript-sdk.Map.setCameraBounds + - azure-atlas-javscript-sdk.Map.setStyle + - azure-atlas-javscript-sdk.Map.setTraffic + - azure-atlas-javscript-sdk.Map.setUserInteraction + langs: + - typeScript + type: class + summary: '' + - uid: azure-atlas-javscript-sdk.Map.addEventListener + name: addEventListener + children: [] + type: method + langs: + - typeScript + summary: >- + Add an event listener to the map. If no layer is specified, the event + listener will be added to the map canvas + + container; otherwise, the event listener will be added to the specified + layer of the map. + syntax: + content: 'function addEventListener(type: string, callback: any)' + parameters: + - id: type + type: + - string + description: The event listener type. @todo Need to specify these. + - id: callback + type: + - any + description: | + The callback to fire when the event occurs. + - uid: azure-atlas-javscript-sdk.Map.addEventListener_1 + name: addEventListener + children: [] + type: method + langs: + - typeScript + summary: >- + Add an event listener to the map. If no layer is specified, the event + listener will be added to the map canvas + + container; otherwise, the event listener will be added to the specified + layer of the map. + syntax: + content: 'function addEventListener(type: string, layer: string, callback: any)' + parameters: + - id: type + type: + - string + description: '' + - id: layer + type: + - string + description: '' + - id: callback + type: + - any + description: '' + - uid: azure-atlas-javscript-sdk.Map.addHtml + name: addHtml + children: [] + type: method + langs: + - typeScript + summary: Adds a custom HTMLElement to the map at a specified position. + syntax: + content: 'function addHtml(element: HTMLElement, position: Position)' + parameters: + - id: element + type: + - HTMLElement + description: The HTMLElement to add. + - id: position + type: + - '@azure-atlas-javscript-sdk.Position' + description: | + The position to place the element. + return: + type: + - string + - uid: azure-atlas-javscript-sdk.Map.addLinestrings + name: addLinestrings + children: [] + type: method + langs: + - typeScript + summary: >- + Add a collection of linestrings to the map. If the layer already exists, + any options previously specified by + + the user will default to the previous values; otherwise, they will default + to the default values of + + [[LinestringLayerOptions]]. + syntax: + content: >- + function addLinestrings(linestrings: Array>, + options?: LinestringLayerOptions) + parameters: + - id: linestrings + type: + - Array<@azure-atlas-javscript-sdk.Feature> + description: The linestrings to add. + - id: options + type: + - '@azure-atlas-javscript-sdk.LinestringLayerOptions' + description: | + The layer options for adding the linestrings to the map. + optional: true + - uid: azure-atlas-javscript-sdk.Map.addPins + name: addPins + children: [] + type: method + langs: + - typeScript + summary: >- + Add a collection of points to the map as pins. If the layer already + exists, any options previously specified by + + the user will default to the previous values; otherwise, they will default + to the default values of + + [[PinLayerOptions]]. + syntax: + content: 'function addPins(pins: Array>, options?: PinLayerOptions)' + parameters: + - id: pins + type: + - >- + Array<@azure-atlas-javscript-sdk.Feature<@azure-atlas-javscript-sdk.Point>> + description: The points to add. + - id: options + type: + - '@azure-atlas-javscript-sdk.PinLayerOptions' + description: | + The layer options for adding the pins to the map. + optional: true + - uid: azure-atlas-javscript-sdk.Map.addPolygons + name: addPolygons + children: [] + type: method + langs: + - typeScript + summary: >- + Add a collection of polygons to the map. If the layer already exists, any + options previously specified by + + the user will default to the previous values; otherwise, they will default + to the default values of + + [[PolygonLayerOptions]]. + syntax: + content: >- + function addPolygons(polygons: Array>, options?: + PolygonLayerOptions) + parameters: + - id: polygons + type: + - Array<@azure-atlas-javscript-sdk.Feature> + description: The polygons to add. + - id: options + type: + - '@azure-atlas-javscript-sdk.PolygonLayerOptions' + description: | + The layer options for adding the polygons to the map. + optional: true + - uid: azure-atlas-javscript-sdk.Map.addRaster + name: addRaster + children: [] + type: method + langs: + - typeScript + summary: >- + Adds a raster layer to the map. If the layer already exists, any options + previously specified by + + the user will default to the previous values; otherwise, they will default + to the default values of + + [[RasterLayerOptions]]. + syntax: + content: 'function addRaster(tileSources: string[], options?: RasterLayerOptions)' + parameters: + - id: tileSources + type: + - 'string[]' + description: >- + A list of endpoints specified as strings from which raster images + can be requested. The + + endpoints can be parameterized with the tags '{z}', '{x}' and '{y}' + to specify the zoom, x-index, and y-index of + + the needed tile respectively. The map control will request and place + the tiles that are contained in the map's + + viewport. + - id: options + type: + - '@azure-atlas-javscript-sdk.RasterLayerOptions' + description: | + The options for defining the raster layer to add. + optional: true + - uid: azure-atlas-javscript-sdk.Map.getCamera + name: getCamera + children: [] + type: method + langs: + - typeScript + summary: Returns the camera's current properties. + syntax: + content: function getCamera() + parameters: [] + - uid: azure-atlas-javscript-sdk.Map.getCanvas + name: getCanvas + children: [] + type: method + langs: + - typeScript + summary: Returns the HTMLCanvasElement that the map is drawn to. + syntax: + content: function getCanvas() + parameters: [] + return: + type: + - HTMLCanvasElement + - uid: azure-atlas-javscript-sdk.Map.getCanvasContainer + name: getCanvasContainer + children: [] + type: method + langs: + - typeScript + summary: >- + Returns the HTMLElement that contains the map's HTMLCanvasElement. The + map's events (e.g. panning and zooming) + + are attached to this element. + syntax: + content: function getCanvasContainer() + parameters: [] + return: + type: + - HTMLElement + - uid: azure-atlas-javscript-sdk.Map.getLayers + name: getLayers + children: [] + type: method + langs: + - typeScript + summary: Returns a list of the map's layers from bottom to top. + syntax: + content: function getLayers() + parameters: [] + - uid: azure-atlas-javscript-sdk.Map.getMapContainer + name: getMapContainer + children: [] + type: method + langs: + - typeScript + summary: Returns the HTMLElement that contains the map. + syntax: + content: function getMapContainer() + parameters: [] + return: + type: + - HTMLElement + - uid: azure-atlas-javscript-sdk.Map.getServiceOptions + name: getServiceOptions + children: [] + type: method + langs: + - typeScript + summary: Returns the service options with which the map control was initialized. + syntax: + content: function getServiceOptions() + parameters: [] + return: + type: + - '@azure-atlas-javscript-sdk.ServiceOptions' + - uid: azure-atlas-javscript-sdk.Map.getStyle + name: getStyle + children: [] + type: method + langs: + - typeScript + summary: Returns the map control's current style settings. + syntax: + content: function getStyle() + parameters: [] + return: + type: + - '@azure-atlas-javscript-sdk.StyleOptions' + - uid: azure-atlas-javscript-sdk.Map.getTraffic + name: getTraffic + children: [] + type: method + langs: + - typeScript + summary: Return the map control's current traffic settings. + syntax: + content: function getTraffic() + parameters: [] + return: + type: + - '@azure-atlas-javscript-sdk.TrafficOptions' + - uid: azure-atlas-javscript-sdk.Map.getUserInteraction + name: getUserInteraction + children: [] + type: method + langs: + - typeScript + summary: Return the map control's current user interaction handler settings. + syntax: + content: function getUserInteraction() + parameters: [] + return: + type: + - '@azure-atlas-javscript-sdk.UserInteractionOptions' + - uid: azure-atlas-javscript-sdk.Map.constructor + name: Map + children: [] + type: constructor + langs: + - typeScript + summary: Displays a map in the specified container. + syntax: + content: 'new Map(container: string, options: function)' + parameters: + - id: container + type: + - string + description: The id of the element where the map should be displayed. + - id: options + type: + - function + description: | + Options for the initial display and interactability with the map. + - uid: azure-atlas-javscript-sdk.Map.removeEventListener + name: removeEventListener + children: [] + type: method + langs: + - typeScript + summary: Remove an event listener from the map for the specified type and callback. + syntax: + content: 'function removeEventListener(type: string, callback: any)' + parameters: + - id: type + type: + - string + description: The type of the event listener. + - id: callback + type: + - any + description: | + The callback of the event listener. + - uid: azure-atlas-javscript-sdk.Map.removeEventListener_1 + name: removeEventListener + children: [] + type: method + langs: + - typeScript + summary: Remove an event listener from the map for the specified type and callback. + syntax: + content: 'function removeEventListener(type: string, layer: string, callback: any)' + parameters: + - id: type + type: + - string + description: '' + - id: layer + type: + - string + description: '' + - id: callback + type: + - any + description: '' + - uid: azure-atlas-javscript-sdk.Map.removeHtml + name: removeHtml + children: [] + type: method + langs: + - typeScript + summary: Removes a custom HTMLElement from the map. + syntax: + content: 'function removeHtml(elementId: string)' + parameters: + - id: elementId + type: + - string + description: | + The id of element to remove. + - uid: azure-atlas-javscript-sdk.Map.removeLayers + name: removeLayers + children: [] + type: method + langs: + - typeScript + summary: Removes a collection of layers from the map. + syntax: + content: 'function removeLayers(layerNames: string[])' + parameters: + - id: layerNames + type: + - 'string[]' + description: | + An array of layer names to remove from the map. + - uid: azure-atlas-javscript-sdk.Map.setCamera + name: setCamera + children: [] + type: method + langs: + - typeScript + summary: >- + Set the camera of the map control with an animated transition. Any options + not specified will default to their + + current values. + syntax: + content: 'function setCamera(options?: function)' + parameters: + - id: options + type: + - function + description: > + The options for setting the map's camera and for the animation of + any view change. + optional: true + - uid: azure-atlas-javscript-sdk.Map.setCameraBounds + name: setCameraBounds + children: [] + type: method + langs: + - typeScript + summary: Set the camera bounds of the map control. + syntax: + content: 'function setCameraBounds(options?: CameraBoundsOptions)' + parameters: + - id: options + type: + - '@azure-atlas-javscript-sdk.CameraBoundsOptions' + description: | + The options for setting the map's camera bounds. + optional: true + - uid: azure-atlas-javscript-sdk.Map.setStyle + name: setStyle + children: [] + type: method + langs: + - typeScript + summary: >- + Set the map control's style options. Any options not specified will + default to their current values. + syntax: + content: 'function setStyle(options?: StyleOptions)' + parameters: + - id: options + type: + - '@azure-atlas-javscript-sdk.StyleOptions' + description: | + The options for setting the style of the map control. + optional: true + - uid: azure-atlas-javscript-sdk.Map.setTraffic + name: setTraffic + children: [] + type: method + langs: + - typeScript + summary: >- + Set the traffic options for the map. Any options not specified will + default to their current values. + syntax: + content: 'function setTraffic(options?: TrafficOptions)' + parameters: + - id: options + type: + - '@azure-atlas-javscript-sdk.TrafficOptions' + description: | + The options for defining the map's traffic display. + optional: true + - uid: azure-atlas-javscript-sdk.Map.setUserInteraction + name: setUserInteraction + children: [] + type: method + langs: + - typeScript + summary: >- + Set the map control's user interaction handlers. Any options not specified + will default to their current values. + syntax: + content: 'function setUserInteraction(options?: UserInteractionOptions)' + parameters: + - id: options + type: + - '@azure-atlas-javscript-sdk.UserInteractionOptions' + description: | + The options for enabling/disabling the user interaction handlers. + optional: true diff --git a/client/docs/docs-ref-autogen/index.yml b/client/docs/docs-ref-autogen/index.yml new file mode 100644 index 0000000..95af95a --- /dev/null +++ b/client/docs/docs-ref-autogen/index.yml @@ -0,0 +1,16 @@ +### YamlMime:UniversalReference +items: + - uid: index + name: index + summary: '' + children: + - azure-atlas-javscript-sdk.BoundingBox + - azure-atlas-javscript-sdk.Map + type: package + langs: + - typeScript +references: + - uid: azure-atlas-javscript-sdk.BoundingBox + name: BoundingBox + - uid: azure-atlas-javscript-sdk.Map + name: Map diff --git a/client/docs/docs-ref-autogen/toc.yml b/client/docs/docs-ref-autogen/toc.yml new file mode 100644 index 0000000..0c8663a --- /dev/null +++ b/client/docs/docs-ref-autogen/toc.yml @@ -0,0 +1,6 @@ +- name: Sample + items: + - uid: azure-atlas-javscript-sdk.BoundingBox + name: BoundingBox + - uid: azure-atlas-javscript-sdk.Map + name: Map