Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move previewed results into flyout. #25

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,3 @@

export { ScriptingDisabledCallOut } from './disabled_call_out';
export { ScriptingWarningCallOut } from './warning_call_out';
export { ScriptingHelpFlyout } from './help_flyout';
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
/*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/

import React from 'react';
import PropTypes from 'prop-types';

import {
EuiFlyout,
EuiFlyoutBody,
EuiTabbedContent,
} from '@elastic/eui';

import { ScriptingSyntax } from './scripting_syntax';
import { TestScript } from './test_script';

export const ScriptingHelpFlyout = ({
isVisible = false,
onClose = () => {},
indexPattern,
lang,
name,
script,
}) => {
const tabs = [{
id: 'syntax',
name: 'Syntax',
content: <ScriptingSyntax />,
}, {
id: 'test',
name: 'Preview results',
content: (
<TestScript
indexPattern={indexPattern}
lang={lang}
name={name}
script={script}
/>
),
}];

return isVisible ? (
<EuiFlyout onClose={onClose}>
<EuiFlyoutBody>
<EuiTabbedContent
tabs={tabs}
initialSelectedTab={tabs[0]}
/>
</EuiFlyoutBody>
</EuiFlyout>
) : null;
};

ScriptingHelpFlyout.displayName = 'ScriptingHelpFlyout';

ScriptingHelpFlyout.propTypes = {
indexPattern: PropTypes.object.isRequired,
lang: PropTypes.string.isRequired,
name: PropTypes.string,
script: PropTypes.string,
};
20 changes: 20 additions & 0 deletions src/ui/public/field_editor/components/scripting_help/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
/*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/

export { ScriptingHelpFlyout } from './help_flyout';
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
/*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/

import React, { Fragment } from 'react';
import { getDocLink } from 'ui/documentation_links';

import {
EuiCode,
EuiIcon,
EuiLink,
EuiText,
EuiSpacer,
} from '@elastic/eui';

export const ScriptingSyntax = () => (
<Fragment>
<EuiSpacer />
<EuiText>
<h3>Syntax</h3>
<p>
By default, Kibana scripted fields use {(
<EuiLink
target="_window"
href={getDocLink('scriptedFields.painless')}
>
Painless <EuiIcon type="link"/>
</EuiLink>
)}, a simple and secure scripting language designed specifically for use with Elasticsearch,
to access values in the document use the following format:
</p>
<p>
<EuiCode>doc[&apos;some_field&apos;].value</EuiCode>
</p>
<p>
Painless is powerful but easy to use. It provides access to many {(
<EuiLink
target="_window"
href={getDocLink('scriptedFields.painlessApi')}
>
native Java APIs <EuiIcon type="link"/>
</EuiLink>
)}. Read up on its {(
<EuiLink
target="_window"
href={getDocLink('scriptedFields.painlessSyntax')}
>
syntax <EuiIcon type="link"/>
</EuiLink>
)} and you&apos;ll be up to speed in no time!
</p>
<p>
Kibana currently imposes one special limitation on the painless scripts you write. They cannot contain named functions.
</p>
<p>
Coming from an older version of Kibana? The {(
<EuiLink
target="_window"
href={getDocLink('scriptedFields.luceneExpressions')}
>
Lucene Expressions <EuiIcon type="link"/>
</EuiLink>
)} you know and love are still available. Lucene expressions are a lot like JavaScript,
but limited to basic arithmetic, bitwise and comparison operations.
</p>
<p>
There are a few limitations when using Lucene Expressions:
</p>
<ul>
<li> Only numeric, boolean, date, and geo_point fields may be accessed</li>
<li> Stored fields are not available</li>
<li> If a field is sparse (only some documents contain a value), documents missing the field will have a value of 0</li>
</ul>
<p>
Here are all the operations available to lucene expressions:
</p>
<ul>
<li> Arithmetic operators: <code>+ - * / %</code></li>
<li> Bitwise operators: <code>| & ^ ~ &#x3C;&#x3C; &#x3E;&#x3E; &#x3E;&#x3E;&#x3E;</code></li>
<li> Boolean operators (including the ternary operator): <code>&& || ! ?:</code></li>
<li> Comparison operators: <code>&#x3C; &#x3C;= == &#x3E;= &#x3E;</code></li>
<li> Common mathematic functions: <code>abs ceil exp floor ln log10 logn max min sqrt pow</code></li>
<li> Trigonometric library functions: <code>acosh acos asinh asin atanh atan atan2 cosh cos sinh sin tanh tan</code></li>
<li> Distance functions: <code>haversin</code></li>
<li> Miscellaneous functions: <code>min, max</code></li>
</ul>
</EuiText>
</Fragment>
);
Loading