px-api-viewer-api.json

{"schema_version":"1.0.0","elements":[{"description":"Element providing API documentation for a requested Polymer component\n\n##### Usage\n\n    <px-api-viewer source=\"demo_component\"></px-api-viewer>\n\n### Styling\nThe following custom properties are available for styling. Use them with the default tooltip-style property (omit it, or use value \"dark\").\n\nCustom property | Description\n----------------|-------------\n`--px-tooltip-text-color` | Text color for the tooltip\n`--px-tooltip-background-color` | Background color for the tooltip","summary":"","path":"../px-api-viewer/px-api-viewer.html","properties":[{"name":"_elementDescriptor","type":"Object","description":"A json object, created by hydrolysis, which contains the actual\ndocumentation for the component","privacy":"protected","sourceRange":{"start":{"line":68,"column":6},"end":{"line":71,"column":7}},"metadata":{"polymer":{"notify":true}}},{"name":"source","type":"string","description":"A string holding the name of the component.\ndo not add `.html` to this attribute.","privacy":"public","sourceRange":{"start":{"line":79,"column":6},"end":{"line":83,"column":7}},"metadata":{"polymer":{"notify":true}},"defaultValue":"\"\""},{"name":"apiSourceFilePath","type":"string","description":"A string holding the path to the api source file e.g. px-tabs/px-tabs-api.json","privacy":"public","sourceRange":{"start":{"line":90,"column":6},"end":{"line":93,"column":7}},"metadata":{"polymer":{}},"defaultValue":"\"\""},{"name":"hide","type":"Array","description":"An array which contains the names of properties/methods/events which will be removed\nfrom the hydrolysis object","privacy":"public","sourceRange":{"start":{"line":99,"column":6},"end":{"line":104,"column":7}},"metadata":{"polymer":{}},"defaultValue":"[]"},{"name":"markPrivate","type":"Array","description":"An array which contains the names of properties which will be marked\nas private","privacy":"public","sourceRange":{"start":{"line":110,"column":6},"end":{"line":115,"column":7}},"metadata":{"polymer":{}},"defaultValue":"[]"},{"name":"markReadOnly","type":"Array","description":"An array which contains the names of properties which will be marked\nas readonly","privacy":"public","sourceRange":{"start":{"line":121,"column":6},"end":{"line":126,"column":7}},"metadata":{"polymer":{}},"defaultValue":"[]"},{"name":"changeDescription","type":"Array","description":"an array which contains the names and new descriptions of\nproperties we want to change the deccription of.","privacy":"public","sourceRange":{"start":{"line":132,"column":6},"end":{"line":137,"column":7}},"metadata":{"polymer":{}},"defaultValue":"[]"},{"name":"disableHashPrefix","type":"boolean","description":"By default it is assumed all page paths are done with a hash symbol\nfor client-side routing. If your server is equipped to handle real\npaths for single page app routing, disable this. See `pagePath`\nfor more details.","privacy":"public","sourceRange":{"start":{"line":145,"column":6},"end":{"line":148,"column":7}},"metadata":{"polymer":{}},"defaultValue":"false"},{"name":"pagePath","type":"string","description":"The path to the page that this demo is hosted on from the root.\nThis path is used to create the anchor links for the API viewer.\nShould begin with a '/' slash. By default it is assumed this will\nbe preceded by a hash for client-side routing. See `disableHashPrefix`\nto disable this behavior.\n\nExample: For a component with a demo/API page hosted at\n'https://www.predix-ui.com/#/elements/px-alert-message', the page\npath should be '/elements/px-alert-message'.","privacy":"public","sourceRange":{"start":{"line":161,"column":6},"end":{"line":164,"column":7}},"metadata":{"polymer":{}},"defaultValue":"\"\""},{"name":"_targetElementDescriptor","type":"Object","description":"The filtered element descriptor pared down to only include the element\nthat is demo'ed. Uses the element name from the `source` property.","privacy":"protected","sourceRange":{"start":{"line":170,"column":6},"end":{"line":173,"column":7}},"metadata":{"polymer":{"readOnly":true}}},{"name":"_anchor","type":"string","description":"The active anchor (the portion of the URL after the ':' symbol), used\nto scroll the page to a specific spot on load.","privacy":"protected","sourceRange":{"start":{"line":179,"column":6},"end":{"line":184,"column":7}},"metadata":{"polymer":{"observer":"\"_tryScrollToAnchor\"","readOnly":true}},"defaultValue":"\"\""},{"name":"_baseHref","type":"string","description":"","privacy":"protected","sourceRange":{"start":{"line":185,"column":6},"end":{"line":188,"column":7}},"metadata":{"polymer":{}}}],"methods":[{"name":"attached","description":"","privacy":"protected","sourceRange":{"start":{"line":190,"column":4},"end":{"line":193,"column":5}},"metadata":{},"params":[]},{"name":"detached","description":"","privacy":"protected","sourceRange":{"start":{"line":194,"column":4},"end":{"line":196,"column":5}},"metadata":{},"params":[]},{"name":"_cleanAPIDocs","description":"find the passed item in either the elements or behaviors arrays in the analyzer obj","privacy":"protected","sourceRange":{"start":{"line":200,"column":4},"end":{"line":219,"column":5}},"metadata":{},"params":[]},{"name":"_hideAPI","description":"This method filters/removes any properties passed into using the hide attribute, by filtering out\nany matches between the","privacy":"protected","sourceRange":{"start":{"line":226,"column":4},"end":{"line":236,"column":5}},"metadata":{},"params":[{"name":"inputSetToFilter"}]},{"name":"_markPrivate","description":"","privacy":"protected","sourceRange":{"start":{"line":237,"column":4},"end":{"line":242,"column":5}},"metadata":{},"params":[{"name":"property"}]},{"name":"_markReadOnly","description":"","privacy":"protected","sourceRange":{"start":{"line":243,"column":4},"end":{"line":247,"column":5}},"metadata":{},"params":[{"name":"property"}]},{"name":"_changeDescription","description":"","privacy":"protected","sourceRange":{"start":{"line":248,"column":4},"end":{"line":258,"column":5}},"metadata":{},"params":[{"name":"inputSetToChange"}]},{"name":"_handleResponse","description":"","privacy":"protected","sourceRange":{"start":{"line":259,"column":4},"end":{"line":265,"column":5}},"metadata":{},"params":[{"name":"val"}]},{"name":"_getAPIUrl","description":"","privacy":"protected","sourceRange":{"start":{"line":266,"column":4},"end":{"line":273,"column":5}},"metadata":{},"params":[]},{"name":"_handlePageLoaded","description":"Relevant methods: _handlePageLoaded and _tryScrollToAnchor","privacy":"protected","sourceRange":{"start":{"line":279,"column":4},"end":{"line":284,"column":5}},"metadata":{},"params":[]},{"name":"_tryScrollToAnchor","description":"","privacy":"protected","sourceRange":{"start":{"line":285,"column":4},"end":{"line":289,"column":5}},"metadata":{},"params":[{"name":"anchor"}]},{"name":"_getAnchorFromHash","description":"","privacy":"protected","sourceRange":{"start":{"line":290,"column":4},"end":{"line":295,"column":5}},"metadata":{},"params":[{"name":"hash"}]},{"name":"_getTargetElementDesc","description":"","privacy":"protected","sourceRange":{"start":{"line":296,"column":4},"end":{"line":300,"column":5}},"metadata":{},"params":[{"name":"name"},{"name":"descriptor"}]},{"name":"_getFragmentPrefix","description":"","privacy":"protected","sourceRange":{"start":{"line":301,"column":4},"end":{"line":311,"column":5}},"metadata":{},"params":[{"name":"name"},{"name":"pagePath"}]},{"name":"_getBaseHref","description":"","privacy":"protected","sourceRange":{"start":{"line":312,"column":4},"end":{"line":317,"column":5}},"metadata":{},"params":[{"name":"disableHashPrefix"}]}],"staticMethods":[],"demos":[{"url":"demo.html","description":""}],"metadata":{},"sourceRange":{"start":{"line":50,"column":10},"end":{"line":318,"column":3}},"privacy":"public","superclass":"HTMLElement","attributes":[{"name":"source","description":"A string holding the name of the component.\ndo not add `.html` to this attribute.","sourceRange":{"start":{"line":79,"column":6},"end":{"line":83,"column":7}},"metadata":{},"type":"string"},{"name":"api-source-file-path","description":"A string holding the path to the api source file e.g. px-tabs/px-tabs-api.json","sourceRange":{"start":{"line":90,"column":6},"end":{"line":93,"column":7}},"metadata":{},"type":"string"},{"name":"hide","description":"An array which contains the names of properties/methods/events which will be removed\nfrom the hydrolysis object","sourceRange":{"start":{"line":99,"column":6},"end":{"line":104,"column":7}},"metadata":{},"type":"Array"},{"name":"mark-private","description":"An array which contains the names of properties which will be marked\nas private","sourceRange":{"start":{"line":110,"column":6},"end":{"line":115,"column":7}},"metadata":{},"type":"Array"},{"name":"mark-read-only","description":"An array which contains the names of properties which will be marked\nas readonly","sourceRange":{"start":{"line":121,"column":6},"end":{"line":126,"column":7}},"metadata":{},"type":"Array"},{"name":"change-description","description":"an array which contains the names and new descriptions of\nproperties we want to change the deccription of.","sourceRange":{"start":{"line":132,"column":6},"end":{"line":137,"column":7}},"metadata":{},"type":"Array"},{"name":"disable-hash-prefix","description":"By default it is assumed all page paths are done with a hash symbol\nfor client-side routing. If your server is equipped to handle real\npaths for single page app routing, disable this. See `pagePath`\nfor more details.","sourceRange":{"start":{"line":145,"column":6},"end":{"line":148,"column":7}},"metadata":{},"type":"boolean"},{"name":"page-path","description":"The path to the page that this demo is hosted on from the root.\nThis path is used to create the anchor links for the API viewer.\nShould begin with a '/' slash. By default it is assumed this will\nbe preceded by a hash for client-side routing. See `disableHashPrefix`\nto disable this behavior.\n\nExample: For a component with a demo/API page hosted at\n'https://www.predix-ui.com/#/elements/px-alert-message', the page\npath should be '/elements/px-alert-message'.","sourceRange":{"start":{"line":161,"column":6},"end":{"line":164,"column":7}},"metadata":{},"type":"string"}],"events":[{"type":"CustomEvent","name":"source-changed","description":"Fired when the `source` property changes.","metadata":{}}],"styling":{"cssVariables":[],"selectors":[]},"slots":[],"tagname":"px-api-viewer"}]}